ClickHouse/tests/ci/sqlancer_check.py

#!/usr/bin/env python3

import logging
import os
import subprocess
import sys
from pathlib import Path

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
from commit_status_helper import (
    RerunHelper,
    format_description,
    get_commit,
    post_commit_status,
)
from docker_images_helper import DockerImage, pull_image, get_docker_image
from env_helper import (
    GITHUB_RUN_URL,
    REPORT_PATH,
    TEMP_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 tee_popen import TeePopen
from upload_result_helper import upload_results

IMAGE_NAME = "clickhouse/sqlancer-test"


def get_run_command(download_url: str, workspace_path: Path, image: DockerImage) -> str:
    return (
        # For sysctl
        "docker run --privileged --network=host "
        f"--volume={workspace_path}:/workspace "
        "--cap-add syslog --cap-add sys_admin --cap-add=SYS_PTRACE "
        f'-e BINARY_URL_TO_DOWNLOAD="{download_url}" '
        f"{image}"
    )


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

    stopwatch = Stopwatch()

    temp_path = Path(TEMP_PATH)
    temp_path.mkdir(parents=True, exist_ok=True)
    reports_path = Path(REPORT_PATH)

    check_name = sys.argv[1] if len(sys.argv) > 1 else os.getenv("CHECK_NAME")
    assert (
        check_name
    ), "Check name must be provided as an input arg or in CHECK_NAME env"

    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 = pull_image(get_docker_image(IMAGE_NAME))

    build_name = get_build_name_for_check(check_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 binary clickhouse among build results")

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

    workspace_path = temp_path / "workspace"
    workspace_path.mkdir(parents=True, exist_ok=True)

    run_command = get_run_command(build_url, workspace_path, docker_image)
    logging.info("Going to run %s", run_command)

    run_log_path = workspace_path / "run.log"
    with TeePopen(run_command, run_log_path) 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)

    tests = [
        "TLPGroupBy",
        "TLPHaving",
        "TLPWhere",
        "TLPDistinct",
        "TLPAggregate",
        "NoREC",
    ]

    paths = [
        run_log_path,
        workspace_path / "clickhouse-server.log",
        workspace_path / "stderr.log",
        workspace_path / "stdout.log",
    ]
    paths += [workspace_path / f"{t}.err" for t in tests]
    paths += [workspace_path / f"{t}.out" for t in tests]

    s3_helper = S3Helper()
    report_url = GITHUB_RUN_URL

    status = "success"
    test_results = []  # type: TestResults
    # Try to get status message saved by the SQLancer
    try:
        with open(workspace_path / "status.txt", "r", encoding="utf-8") as status_f:
            status = status_f.readline().rstrip("\n")
        if (workspace_path / "server_crashed.log").exists():
            test_results.append(TestResult("Server crashed", "FAIL"))
        with open(workspace_path / "summary.tsv", "r", encoding="utf-8") as summary_f:
            for line in summary_f:
                l = line.rstrip("\n").split("\t")
                test_results.append(TestResult(l[0], l[1]))
        with open(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)

    report_url = upload_results(
        s3_helper,
        pr_info.number,
        pr_info.sha,
        test_results,
        paths,
        check_name,
    )

    post_commit_status(
        commit, status, report_url, description, check_name, pr_info, dump_to_file=True
    )
    print(f"::notice:: {check_name} Report url: {report_url}")

    ch_helper = ClickHouseHelper()
    prepared_events = prepare_tests_results_for_clickhouse(
        pr_info,
        test_results,
        status,
        stopwatch.duration_seconds,
        stopwatch.start_time_str,
        report_url,
        check_name,
    )
    ch_helper.insert_events_into(db="default", table="checks", events=prepared_events)


if __name__ == "__main__":
    main()