# Copyright (C) 2022 The Qt Company Ltd. # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only from __future__ import annotations import inspect import os import re import subprocess import sys from subprocess import TimeoutExpired from textwrap import dedent # Get the dir path to the utils module try: this_file = __file__ except NameError: this_file = sys.argv[0] this_file = os.path.abspath(this_file) this_dir = os.path.dirname(this_file) build_scripts_dir = os.path.abspath(os.path.join(this_dir, "..")) sys.path.append(build_scripts_dir) from build_scripts.utils import detect_clang # noqa: E402 class TestRunner: def __init__(self, log_entry, project, index): self.log_entry = log_entry built_path = log_entry.build_dir self.test_dir = os.path.join(built_path, project) log_dir = log_entry.log_dir if index is not None: self.logfile = os.path.join(log_dir, f"{project}.{index}.log") else: self.logfile = os.path.join(log_dir, f"{project}.log") os.environ["CTEST_OUTPUT_ON_FAILURE"] = "1" self._setup_clang() self._setup() def get_python_version(self): """ Finding the exact Python version. --------------------------------- This is done by asking the interpreter, because it cannot reliably be found from any file name parsing as a triple. Note: We need to look into the CMakeCache.txt file to find out what CMake has found as the Python interpreter to use. This is *not* necessarily the same Python that runs this script, otherwise we could use the version info directly. """ look_python = os.path.join(self.test_dir, "CMakeCache.txt") look_for = "PYTHON_EXECUTABLE:FILEPATH=" with open(look_python) as f: for line in f: if line.startswith(look_for): python_exec = line.split("=")[-1].strip() res = subprocess.run([python_exec, "-c", "import sys;print(sys.version_info[:3])"], capture_output=True) return eval(res.stdout.decode("utf-8")) return None def _setup_clang(self): if sys.platform != "win32": return clang_dir = detect_clang() if clang_dir[0]: clang_bin_dir = os.path.join(clang_dir[0], "bin") path = os.environ.get("PATH") if clang_bin_dir not in path: os.environ["PATH"] = clang_bin_dir + os.pathsep + path print(f"Adding {clang_bin_dir} as detected by {clang_dir[1]} to PATH") def _find_ctest_in_file(self, file_name): """ Helper for _find_ctest() that finds the ctest binary in a build system file (ninja, Makefile). """ # Looking for a command ending this way: look_for = "\\ctest.exe" if "win32" in sys.platform else "/ctest" line = None with open(file_name) as makefile: for line in makefile: if look_for in line and line.lstrip().startswith("COMMAND"): break else: # We have probably forgotten to build the tests. # Give a nice error message with a shortened but exact path. rel_path = os.path.relpath(file_name) msg = dedent( f"""\n {'*' * 79} ** ctest is not in '{rel_path}'. * Did you forget to build the tests with '--build-tests' in setup.py? """ ) raise RuntimeError(msg) # the ctest program is on the left to look_for assert line, f"Did not find {look_for}" look = re.escape(look_for) ctest = re.search(fr'(\S+{look}|"([^"]+{look})")', line).groups() return ctest[1] or ctest[0] def _find_ctest(self): """ Find ctest in a build system file (ninja, Makefile) We no longer use make, but the ctest command directly. It is convenient to look for the ctest program using the Makefile. This serves us two purposes: - there is no dependency of the PATH variable, - each project is checked whether ctest was configured. """ candidate_files = ["Makefile", "build.ninja"] for candidate in candidate_files: path = os.path.join(self.test_dir, candidate) if os.path.exists(path): return self._find_ctest_in_file(path) raise RuntimeError( "Cannot find any of the build system files " f"{', '.join(candidate_files)}." ) def _setup(self): self.ctestCommand = self._find_ctest() def _run(self, cmd_tuple, label, timeout): """ Perform a test run in a given build The build can be stopped by a keyboard interrupt for testing this script. Also, a timeout can be used. After the change to directly using ctest, we no longer use "--force-new-ctest-process". Until now this has no drawbacks but was a little faster. """ self.cmd = cmd_tuple # We no longer use the shell option. It introduces wrong handling # of certain characters which are not yet correctly escaped: # Especially the "^" caret char is treated as an escape, and pipe symbols # without a caret are interpreted as such which leads to weirdness. # Since we have all commands with explicit paths and don't use shell # commands, this should work fine. print( dedent( f"""\ running {self.cmd} in {self.test_dir} """ ) ) ctest_process = subprocess.Popen( self.cmd, cwd=self.test_dir, stdout=subprocess.PIPE, stderr=subprocess.STDOUT ) def py_tee(input, output, label): """ A simple (incomplete) tee command in Python This script simply logs everything from input to output while the output gets some decoration. The specific reason to have this script at all is: - it is necessary to have some decoration as prefix, since we run commands several times - collecting all output and then decorating is not nice if you have to wait for a long time The special escape is for the case of an embedded file in the output. """ def xprint(*args, **kw): print(*args, file=output, **kw) # 'for line in input:' would read into too large chunks labelled = True # make sure that this text is not found in a traceback of the runner! text_a = "BEGIN" "_FILE" text_z = "END" "_FILE" while True: line = input.readline() if not line: break if line.startswith(text_a): labelled = False txt = line.rstrip() xprint(label, txt) if label and labelled else xprint(txt) if line.startswith(text_z): labelled = True tee_src = dedent(inspect.getsource(py_tee)) tee_src = f"import sys\n{tee_src}\npy_tee(sys.stdin, sys.stdout, '{label}')" tee_cmd = (sys.executable, "-E", "-u", "-c", tee_src) tee_process = subprocess.Popen(tee_cmd, cwd=self.test_dir, stdin=ctest_process.stdout) try: comm = tee_process.communicate _ = comm(timeout=timeout)[0] except (TimeoutExpired, KeyboardInterrupt): print() print("aborted, partial result") ctest_process.kill() _ = ctest_process.communicate() # ctest lists to a temp file. Move it to the log tmp_name = f"{self.logfile}.tmp" if os.path.exists(tmp_name): if os.path.exists(self.logfile): os.unlink(self.logfile) os.rename(tmp_name, self.logfile) self.partial = True else: _ = ctest_process.communicate() self.partial = False finally: print("End of the test run") print() tee_process.wait() ctest_process.wait() def run(self, label, rerun, timeout): cmd = self.ctestCommand, "--output-log", self.logfile if rerun is not None: # cmd += ("--rerun-failed",) # For some reason, this worked never in the script file. # We pass instead the test names as a regex: words = "^(" + "|".join(rerun) + ")$" cmd += ("--tests-regex", words) self._run(cmd, label, timeout)