ClickHouse/tests/ci/ast_fuzzer_check.py

#!/usr/bin/env python3

import logging
import subprocess
import os
import sys

from github import Github

from build_download_helper import get_build_name_for_check, read_build_urls
from clickhouse_helper import (
    ClickHouseHelper,
    prepare_tests_results_for_clickhouse,
    get_instance_type,
)
from commit_status_helper import (
    RerunHelper,
    format_description,
    get_commit,
    post_commit_status,
)
from docker_pull_helper import get_image_with_version
from env_helper import (
    REPORTS_PATH,
    TEMP_PATH,
)
from get_robot_token import get_best_robot_token
from pr_info import PRInfo
from report import TestResult
from s3_helper import S3Helper
from stopwatch import Stopwatch
from upload_result_helper import upload_results

IMAGE_NAME = "clickhouse/fuzzer"


def get_run_command(
    check_start_time, check_name, pr_number, sha, download_url, workspace_path, image
):
    instance_type = get_instance_type()

    envs = [
        "-e CLICKHOUSE_CI_LOGS_HOST",
        "-e CLICKHOUSE_CI_LOGS_PASSWORD",
        f"-e CHECK_START_TIME='{check_start_time}'",
        f"-e CHECK_NAME='{check_name}'",
        f"-e INSTANCE_TYPE='{instance_type}'",
        f"-e PR_TO_TEST={pr_number}",
        f"-e SHA_TO_TEST={sha}",
        f"-e BINARY_URL_TO_DOWNLOAD='{download_url}'",
    ]

    env_str = " ".join(envs)

    return (
        f"docker run "
        # For sysctl
        "--privileged "
        "--network=host "
        f"--volume={workspace_path}:/workspace "
        f"{env_str} "
        "--cap-add syslog --cap-add sys_admin --cap-add=SYS_PTRACE "
        f"{image}"
    )


def main():
    logging.basicConfig(level=logging.INFO)

    stopwatch = Stopwatch()

    temp_path = TEMP_PATH
    reports_path = REPORTS_PATH

    check_name = sys.argv[1]

    if not os.path.exists(temp_path):
        os.makedirs(temp_path)

    pr_info = PRInfo()

    gh = Github(get_best_robot_token(), per_page=100)
    commit = get_commit(gh, pr_info.sha)

    rerun_helper = RerunHelper(commit, check_name)
    if rerun_helper.is_already_finished_by_status():
        logging.info("Check is already finished according to github status, exiting")
        sys.exit(0)

    docker_image = get_image_with_version(reports_path, IMAGE_NAME)

    build_name = get_build_name_for_check(check_name)
    print(build_name)
    urls = read_build_urls(build_name, reports_path)
    if not urls:
        raise Exception("No build URLs found")

    for url in urls:
        if url.endswith("/clickhouse"):
            build_url = url
            break
    else:
        raise Exception("Cannot find the clickhouse binary among build results")

    logging.info("Got build url %s", build_url)

    workspace_path = os.path.join(temp_path, "workspace")
    if not os.path.exists(workspace_path):
        os.makedirs(workspace_path)

    run_command = get_run_command(
        stopwatch.start_time_str,
        check_name,
        pr_info.number,
        pr_info.sha,
        build_url,
        workspace_path,
        docker_image,
    )
    logging.info("Going to run %s", run_command)

    run_log_path = os.path.join(temp_path, "run.log")
    main_log_path = os.path.join(workspace_path, "main.log")

    with open(run_log_path, "w", encoding="utf-8") as log:
        with subprocess.Popen(
            run_command, shell=True, stderr=log, stdout=log
        ) as process:
            retcode = process.wait()
            if retcode == 0:
                logging.info("Run successfully")
            else:
                logging.info("Run failed")

    subprocess.check_call(f"sudo chown -R ubuntu:ubuntu {temp_path}", shell=True)

    # Cleanup run log from the credentials of CI logs database.
    # Note: a malicious user can still print them by splitting the value into parts.
    # But we will be warned when a malicious user modifies CI script.
    # Although they can also print them from inside tests.
    # Nevertheless, the credentials of the CI logs have limited scope
    # and does not provide access to sensitive info.

    ci_logs_host = os.getenv("CLICKHOUSE_CI_LOGS_HOST", "CLICKHOUSE_CI_LOGS_HOST")
    ci_logs_password = os.getenv(
        "CLICKHOUSE_CI_LOGS_PASSWORD", "CLICKHOUSE_CI_LOGS_PASSWORD"
    )

    if ci_logs_host not in ("CLICKHOUSE_CI_LOGS_HOST", ""):
        subprocess.check_call(
            f"sed -i -r -e 's!{ci_logs_host}!CLICKHOUSE_CI_LOGS_HOST!g; s!{ci_logs_password}!CLICKHOUSE_CI_LOGS_PASSWORD!g;' '{run_log_path}' '{main_log_path}'",
            shell=True,
        )

    check_name_lower = (
        check_name.lower().replace("(", "").replace(")", "").replace(" ", "")
    )
    s3_prefix = f"{pr_info.number}/{pr_info.sha}/fuzzer_{check_name_lower}/"
    paths = {
        "run.log": run_log_path,
        "main.log": main_log_path,
        "fuzzer.log": os.path.join(workspace_path, "fuzzer.log"),
        "report.html": os.path.join(workspace_path, "report.html"),
        "core.zst": os.path.join(workspace_path, "core.zst"),
        "dmesg.log": os.path.join(workspace_path, "dmesg.log"),
    }

    compressed_server_log_path = os.path.join(workspace_path, "server.log.zst")
    if os.path.exists(compressed_server_log_path):
        paths["server.log.zst"] = compressed_server_log_path

    # The script can fail before the invocation of `zstd`, but we are still interested in its log:

    not_compressed_server_log_path = os.path.join(workspace_path, "server.log")
    if os.path.exists(not_compressed_server_log_path):
        paths["server.log"] = not_compressed_server_log_path

    s3_helper = S3Helper()
    for f in paths:
        try:
            paths[f] = s3_helper.upload_test_report_to_s3(paths[f], s3_prefix + f)
        except Exception as ex:
            logging.info("Exception uploading file %s text %s", f, ex)
            paths[f] = ""

    # Try to get status message saved by the fuzzer
    try:
        with open(
            os.path.join(workspace_path, "status.txt"), "r", encoding="utf-8"
        ) as status_f:
            status = status_f.readline().rstrip("\n")

        with open(
            os.path.join(workspace_path, "description.txt"), "r", encoding="utf-8"
        ) as desc_f:
            description = desc_f.readline().rstrip("\n")
    except:
        status = "failure"
        description = "Task failed: $?=" + str(retcode)

    description = format_description(description)

    test_result = TestResult(description, "OK")
    if "fail" in status:
        test_result.status = "FAIL"

    if paths["report.html"]:
        report_url = paths["report.html"]
    else:
        report_url = upload_results(
            s3_helper,
            pr_info.number,
            pr_info.sha,
            [test_result],
            [],
            check_name,
            [url for url in paths.values() if url],
        )

    ch_helper = ClickHouseHelper()

    prepared_events = prepare_tests_results_for_clickhouse(
        pr_info,
        [test_result],
        status,
        stopwatch.duration_seconds,
        stopwatch.start_time_str,
        report_url,
        check_name,
    )

    ch_helper.insert_events_into(db="default", table="checks", events=prepared_events)

    logging.info("Result: '%s', '%s', '%s'", status, description, report_url)
    print(f"::notice ::Report url: {report_url}")
    post_commit_status(commit, status, report_url, description, check_name, pr_info)


if __name__ == "__main__":
    main()