ClickHouse/tests/ci/compatibility_check.py

262 lines
8.4 KiB
Python
Raw Normal View History

2021-11-10 10:17:19 +00:00
#!/usr/bin/env python3
from distutils.version import StrictVersion
2023-09-22 11:16:46 +00:00
from pathlib import Path
from typing import List, Tuple
import argparse
2021-11-10 10:17:19 +00:00
import logging
import subprocess
2021-12-01 14:23:51 +00:00
import sys
2021-11-10 10:17:19 +00:00
from github import Github
2021-11-12 11:07:54 +00:00
from build_download_helper import download_builds_filter
from clickhouse_helper import (
ClickHouseHelper,
prepare_tests_results_for_clickhouse,
)
from commit_status_helper import RerunHelper, get_commit, post_commit_status
2023-09-22 11:16:46 +00:00
from docker_pull_helper import get_images_with_versions, DockerImage
from env_helper import TEMP_PATH, REPORTS_PATH
from get_robot_token import get_best_robot_token
from pr_info import PRInfo
from report import TestResults, TestResult
from s3_helper import S3Helper
from stopwatch import Stopwatch
from upload_result_helper import upload_results
2021-11-10 10:17:19 +00:00
IMAGE_UBUNTU = "clickhouse/test-old-ubuntu"
IMAGE_CENTOS = "clickhouse/test-old-centos"
DOWNLOAD_RETRIES_COUNT = 5
2023-09-22 11:16:46 +00:00
def process_os_check(log_path: Path) -> TestResult:
name = log_path.name
with open(log_path, "r") as log:
line = log.read().split("\n")[0].strip()
if line != "OK":
return TestResult(name, "FAIL")
2023-09-22 11:16:46 +00:00
return TestResult(name, "OK")
2021-11-10 10:17:19 +00:00
2023-09-22 11:16:46 +00:00
def process_glibc_check(log_path: Path, max_glibc_version: str) -> TestResults:
test_results = [] # type: TestResults
with open(log_path, "r") as log:
2021-11-10 10:17:19 +00:00
for line in log:
if line.strip():
columns = line.strip().split(" ")
2021-11-10 10:17:19 +00:00
symbol_with_glibc = columns[-2] # sysconf@GLIBC_2.2.5
_, version = symbol_with_glibc.split("@GLIBC_")
if version == "PRIVATE":
test_results.append(TestResult(symbol_with_glibc, "FAIL"))
elif StrictVersion(version) > max_glibc_version:
test_results.append(TestResult(symbol_with_glibc, "FAIL"))
if not test_results:
test_results.append(TestResult("glibc check", "OK"))
return test_results
2021-11-10 10:17:19 +00:00
def process_result(
2023-09-22 11:16:46 +00:00
result_directory: Path,
server_log_directory: Path,
2023-03-02 20:54:45 +00:00
check_glibc: bool,
check_distributions: bool,
max_glibc_version: str,
2023-09-22 11:16:46 +00:00
) -> Tuple[str, str, TestResults, List[Path]]:
glibc_log_path = result_directory / "glibc.log"
test_results = process_glibc_check(glibc_log_path, max_glibc_version)
2021-11-10 10:17:19 +00:00
status = "success"
description = "Compatibility check passed"
2023-03-02 20:48:25 +00:00
if check_glibc:
if len(test_results) > 1 or test_results[0].status != "OK":
status = "failure"
description = "glibc check failed"
if status == "success" and check_distributions:
2021-11-10 10:17:19 +00:00
for operating_system in ("ubuntu:12.04", "centos:5"):
2023-09-22 11:16:46 +00:00
test_result = process_os_check(result_directory / operating_system)
if test_result.status != "OK":
2021-11-10 10:17:19 +00:00
status = "failure"
description = f"Old {operating_system} failed"
test_results += [test_result]
2021-11-10 10:17:19 +00:00
break
test_results += [test_result]
2021-11-10 10:17:19 +00:00
2023-09-22 11:16:46 +00:00
result_logs = [
p
for p in [
server_log_directory / name
for name in ("clickhouse-server.log", "stderr.log", "clientstderr.log")
]
+ [glibc_log_path]
if p.exists()
]
2021-11-10 10:17:19 +00:00
return status, description, test_results, result_logs
2021-11-10 10:17:19 +00:00
2023-09-22 11:16:46 +00:00
def get_run_commands_glibc(build_path: Path, result_directory: Path) -> List[str]:
2021-11-10 10:17:19 +00:00
return [
2023-09-22 11:16:46 +00:00
f"readelf -s --wide {build_path}/usr/bin/clickhouse | "
f"grep '@GLIBC_' > {result_directory}/glibc.log",
f"readelf -s --wide {build_path}/usr/bin/clickhouse-odbc-bridge | "
f"grep '@GLIBC_' >> {result_directory}/glibc.log",
f"readelf -s --wide {build_path}/usr/bin/clickhouse-library-bridge | "
f"grep '@GLIBC_' >> {result_directory}/glibc.log",
]
def get_run_commands_distributions(
2023-09-22 11:16:46 +00:00
build_path: Path,
result_directory: Path,
server_log_directory: Path,
image_centos: DockerImage,
image_ubuntu: DockerImage,
) -> List[str]:
return [
f"docker run --network=host --volume={build_path}/usr/bin/clickhouse:/clickhouse "
f"--volume={build_path}/etc/clickhouse-server:/config "
2023-09-22 11:16:46 +00:00
f"--volume={server_log_directory}:/var/log/clickhouse-server {image_ubuntu} > "
f"{result_directory}/ubuntu:12.04",
f"docker run --network=host --volume={build_path}/usr/bin/clickhouse:/clickhouse "
f"--volume={build_path}/etc/clickhouse-server:/config "
2023-09-22 11:16:46 +00:00
f"--volume={server_log_directory}:/var/log/clickhouse-server {image_centos} > "
f"{result_directory}/centos:5",
2021-11-10 10:17:19 +00:00
]
def parse_args():
parser = argparse.ArgumentParser("Check compatibility with old distributions")
parser.add_argument("--check-name", required=True)
parser.add_argument("--check-glibc", action="store_true")
parser.add_argument(
"--check-distributions", action="store_true"
) # currently hardcoded to x86, don't enable for ARM
return parser.parse_args()
def main():
2021-11-10 10:17:19 +00:00
logging.basicConfig(level=logging.INFO)
2021-11-19 14:47:04 +00:00
args = parse_args()
2021-11-19 14:47:04 +00:00
stopwatch = Stopwatch()
2023-09-22 11:16:46 +00:00
temp_path = Path(TEMP_PATH)
temp_path.mkdir(parents=True, exist_ok=True)
reports_path = Path(REPORTS_PATH)
2021-11-10 10:17:19 +00:00
2021-11-26 14:00:09 +00:00
pr_info = PRInfo()
2021-11-10 10:17:19 +00:00
gh = Github(get_best_robot_token(), per_page=100)
commit = get_commit(gh, pr_info.sha)
2021-11-10 10:17:19 +00:00
rerun_helper = RerunHelper(commit, args.check_name)
2021-12-01 14:23:51 +00:00
if rerun_helper.is_already_finished_by_status():
logging.info("Check is already finished according to github status, exiting")
sys.exit(0)
2023-09-22 11:16:46 +00:00
packages_path = temp_path / "packages"
packages_path.mkdir(parents=True, exist_ok=True)
2021-11-10 10:17:19 +00:00
2021-11-12 11:07:54 +00:00
def url_filter(url):
return url.endswith(".deb") and (
"clickhouse-common-static_" in url or "clickhouse-server_" in url
)
2021-11-12 11:07:54 +00:00
download_builds_filter(args.check_name, reports_path, packages_path, url_filter)
2021-11-12 11:07:54 +00:00
2023-09-27 14:27:37 +00:00
for package in packages_path.iterdir():
if package.suffix == ".deb":
subprocess.check_call(
2023-09-27 14:27:37 +00:00
f"dpkg -x {package} {packages_path} && rm {package}", shell=True
)
2021-11-10 10:17:19 +00:00
2023-09-22 11:16:46 +00:00
server_log_path = temp_path / "server_log"
server_log_path.mkdir(parents=True, exist_ok=True)
2021-11-10 10:17:19 +00:00
2023-09-22 11:16:46 +00:00
result_path = temp_path / "result_path"
result_path.mkdir(parents=True, exist_ok=True)
2021-11-10 10:17:19 +00:00
run_commands = []
if args.check_glibc:
check_glibc_commands = get_run_commands_glibc(packages_path, result_path)
run_commands.extend(check_glibc_commands)
if args.check_distributions:
docker_images = get_images_with_versions(
reports_path, [IMAGE_CENTOS, IMAGE_UBUNTU]
)
check_distributions_commands = get_run_commands_distributions(
packages_path,
result_path,
server_log_path,
docker_images[0],
docker_images[1],
)
run_commands.extend(check_distributions_commands)
2021-11-10 10:17:19 +00:00
state = "success"
for run_command in run_commands:
try:
logging.info("Running command %s", run_command)
subprocess.check_call(run_command, shell=True)
except subprocess.CalledProcessError as ex:
logging.info("Exception calling command %s", ex)
state = "failure"
2021-11-10 13:28:12 +00:00
subprocess.check_call(f"sudo chown -R ubuntu:ubuntu {temp_path}", shell=True)
# See https://sourceware.org/glibc/wiki/Glibc%20Timeline
max_glibc_version = ""
2023-03-03 11:19:05 +00:00
if "amd64" in args.check_name:
max_glibc_version = "2.4"
2023-03-02 17:51:43 +00:00
elif "aarch64" in args.check_name:
2023-03-02 11:22:32 +00:00
max_glibc_version = "2.18" # because of build with newer sysroot?
else:
raise Exception("Can't determine max glibc version")
2022-08-11 13:01:32 +00:00
s3_helper = S3Helper()
state, description, test_results, additional_logs = process_result(
2023-03-02 20:54:45 +00:00
result_path,
server_log_path,
args.check_glibc,
args.check_distributions,
max_glibc_version,
)
2021-11-19 14:47:04 +00:00
ch_helper = ClickHouseHelper()
report_url = upload_results(
s3_helper,
pr_info.number,
pr_info.sha,
test_results,
additional_logs,
args.check_name,
)
2021-11-10 10:17:19 +00:00
print(f"::notice ::Report url: {report_url}")
post_commit_status(commit, state, report_url, description, args.check_name, pr_info)
2021-11-19 14:47:04 +00:00
prepared_events = prepare_tests_results_for_clickhouse(
pr_info,
test_results,
state,
stopwatch.duration_seconds,
stopwatch.start_time_str,
report_url,
args.check_name,
)
2022-03-29 19:06:50 +00:00
ch_helper.insert_events_into(db="default", table="checks", events=prepared_events)
2022-03-29 12:41:47 +00:00
if state == "failure":
2022-03-29 12:41:47 +00:00
sys.exit(1)
if __name__ == "__main__":
main()