tools: add ctest-driver.py

1 files changed, 122 insertions, 0 deletions

diff --git a/tools/ctest-driver.py b/tools/ctest-driver.py
new file mode 100755
index 0000000..5900052
--- /dev/null
+++ b/tools/ctest-driver.py
@@ -0,0 +1,122 @@
+#!/usr/bin/env python3
+
+'''Wrap your actual test driver for CTest
+
+CTest suffers from at least two issues, in particular with regard to its
+PASS_REGULAR_EXPRESSION feature:
+
+1. The regular expression syntax is deficient.
+2. The exit code of a test is ignored if one of the regexes matches.
+
+This script tries to fix them.
+'''
+
+import argparse
+import os
+import re
+import subprocess
+import sys
+
+
+SCRIPT_NAME = os.path.basename(__file__)
+
+
+def dump(msg, **kwargs):
+    print(f'{SCRIPT_NAME}: {msg}', **kwargs)
+
+
+def err(msg):
+    dump(msg, file=sys.stderr)
+
+
+def read_file(path):
+    with open(path, mode='r') as fd:
+        return fd.read()
+
+
+def run(cmd_line, **kwargs):
+    try:
+        result = subprocess.run(cmd_line, check=True, universal_newlines=True,
+                                stderr=subprocess.STDOUT,
+                                stdout=subprocess.PIPE, **kwargs)
+        assert result.returncode == 0
+        return result.stdout
+    except subprocess.CalledProcessError as e:
+        sys.stdout.write(e.output)
+        sys.exit(e.returncode)
+
+
+def match_any(s, regexes):
+    if not regexes:
+        return True
+    for regex in regexes:
+        if re.search(regex, s):
+            return True
+    return False
+
+
+def match_pass_regexes(output, regexes):
+    if not match_any(output, regexes):
+        err("Couldn't match test program's output against any of the"\
+            " regular expressions:")
+        for regex in regexes:
+            err(f'\t{regex}')
+            sys.exit(1)
+
+
+def run_actual_test_driver(args):
+    creationflags = 0
+    if args.new_window and hasattr(subprocess, 'CREATE_NEW_CONSOLE'):
+        creationflags = subprocess.CREATE_NEW_CONSOLE
+    output = run([args.exe_path] + args.exe_args, creationflags=creationflags)
+    sys.stdout.write(output)
+    match_pass_regexes(output, args.pass_regexes)
+
+
+def grep_file(args):
+    contents = read_file(args.path)
+    match_pass_regexes(contents, args.pass_regexes)
+
+
+def parse_args(argv=None):
+    if argv is None:
+        argv = sys.argv[1:]
+
+    parser = argparse.ArgumentParser(
+        description=__doc__,
+        formatter_class=argparse.RawDescriptionHelpFormatter)
+
+    subparsers = parser.add_subparsers(dest='command')
+
+    parser_run = subparsers.add_parser('run', help='run an executable and check its output')
+    parser_run.add_argument('-r', '--pass-regex', nargs='*',
+                            dest='pass_regexes', metavar='REGEX',
+                            help='regular expressions to match program output against')
+    parser_run.add_argument('-n', '--new-window', action='store_true',
+                            help='launch child process in a new console window')
+    parser_run.add_argument('exe_path', metavar='PATH',
+                            help='path to the test executable')
+    parser_run.add_argument('exe_args', metavar='ARG', nargs='*',
+                            help='test executable arguments')
+    parser_run.set_defaults(func=run_actual_test_driver)
+
+    parser_grep = subparsers.add_parser('grep', help='check file contents for matching patterns')
+    parser_grep.add_argument('-r', '--pass-regex', nargs='*',
+                             dest='pass_regexes', metavar='REGEX',
+                             help='regular expressions to check file contents against')
+    parser_grep.add_argument('path', metavar='PATH', help='text file path')
+    parser_grep.set_defaults(func=grep_file)
+
+    args = parser.parse_args(argv)
+    if args.command is None:
+        parser.error('please specify a subcommand to run')
+    return args
+
+
+def main(argv=None):
+    args = parse_args(argv)
+    args.func(args)
+
+
+if __name__ == '__main__':
+    main()