xref: /qemu/scripts/mtest2make.py (revision d7a84021) 
1#! /usr/bin/env python3
2
3# Create Makefile targets to run tests, from Meson's test introspection data.
4#
5# Author: Paolo Bonzini <pbonzini@redhat.com>
6
7from collections import defaultdict
8import itertools
9import json
10import os
11import shlex
12import sys
13
14class Suite(object):
15    def __init__(self):
16        self.tests = list()
17        self.slow_tests = list()
18        self.executables = set()
19
20print('''
21SPEED = quick
22
23# $1 = environment, $2 = test command, $3 = test name, $4 = dir
24.test-human-tap = $1 $(if $4,(cd $4 && $2),$2) < /dev/null | ./scripts/tap-driver.pl --test-name="$3" $(if $(V),,--show-failures-only)
25.test-human-exitcode = $1 $(PYTHON) scripts/test-driver.py $(if $4,-C$4) $(if $(V),--verbose) -- $2 < /dev/null
26.test-tap-tap = $1 $(if $4,(cd $4 && $2),$2) < /dev/null | sed "s/^[a-z][a-z]* [0-9]*/& $3/" || true
27.test-tap-exitcode = printf "%s\\n" 1..1 "`$1 $(if $4,(cd $4 && $2),$2) < /dev/null > /dev/null || echo "not "`ok 1 $3"
28.test.human-print = echo $(if $(V),'$1 $2','Running test $3') &&
29.test.env = MALLOC_PERTURB_=$${MALLOC_PERTURB_:-$$(( $${RANDOM:-0} % 255 + 1))}
30
31# $1 = test name, $2 = test target (human or tap)
32.test.run = $(call .test.$2-print,$(.test.env.$1),$(.test.cmd.$1),$(.test.name.$1)) $(call .test-$2-$(.test.driver.$1),$(.test.env.$1),$(.test.cmd.$1),$(.test.name.$1),$(.test.dir.$1))
33
34.test.output-format = human
35''')
36
37introspect = json.load(sys.stdin)
38i = 0
39
40def process_tests(test, targets, suites):
41    global i
42    env = ' '.join(('%s=%s' % (shlex.quote(k), shlex.quote(v))
43                    for k, v in test['env'].items()))
44    executable = test['cmd'][0]
45    try:
46        executable = os.path.relpath(executable)
47    except:
48        pass
49    if test['workdir'] is not None:
50        try:
51            test['cmd'][0] = os.path.relpath(executable, test['workdir'])
52        except:
53            test['cmd'][0] = executable
54    else:
55        test['cmd'][0] = executable
56    cmd = ' '.join((shlex.quote(x) for x in test['cmd']))
57    driver = test['protocol'] if 'protocol' in test else 'exitcode'
58
59    i += 1
60    if test['workdir'] is not None:
61        print('.test.dir.%d := %s' % (i, shlex.quote(test['workdir'])))
62
63    if 'depends' in test:
64        deps = (targets.get(x, []) for x in test['depends'])
65        deps = itertools.chain.from_iterable(deps)
66    else:
67        deps = ['all']
68
69    print('.test.name.%d := %s' % (i, test['name']))
70    print('.test.driver.%d := %s' % (i, driver))
71    print('.test.env.%d := $(.test.env) %s' % (i, env))
72    print('.test.cmd.%d := %s' % (i, cmd))
73    print('.test.deps.%d := %s' % (i, ' '.join(deps)))
74    print('.PHONY: run-test-%d' % (i,))
75    print('run-test-%d: $(.test.deps.%d)' % (i,i))
76    print('\t@$(call .test.run,%d,$(.test.output-format))' % (i,))
77
78    test_suites = test['suite'] or ['default']
79    is_slow = any(s.endswith('-slow') for s in test_suites)
80    for s in test_suites:
81        # The suite name in the introspection info is "PROJECT:SUITE"
82        s = s.split(':')[1]
83        if s.endswith('-slow'):
84            s = s[:-5]
85        if is_slow:
86            suites[s].slow_tests.append(i)
87        else:
88            suites[s].tests.append(i)
89        suites[s].executables.add(executable)
90
91def emit_prolog(suites, prefix):
92    all_tap = ' '.join(('%s-report-%s.tap' % (prefix, k) for k in suites.keys()))
93    print('.PHONY: %s %s-report.tap %s' % (prefix, prefix, all_tap))
94    print('%s: run-tests' % (prefix,))
95    print('%s-report.tap %s: %s-report%%.tap: all' % (prefix, all_tap, prefix))
96    print('''\t$(MAKE) .test.output-format=tap --quiet -Otarget V=1 %s$* | ./scripts/tap-merge.pl | tee "$@" \\
97              | ./scripts/tap-driver.pl $(if $(V),, --show-failures-only)''' % (prefix, ))
98
99def emit_suite(name, suite, prefix):
100    executables = ' '.join(suite.executables)
101    slow_test_numbers = ' '.join((str(x) for x in suite.slow_tests))
102    test_numbers = ' '.join((str(x) for x in suite.tests))
103    target = '%s-%s' % (prefix, name)
104    print('.test.quick.%s := %s' % (target, test_numbers))
105    print('.test.slow.%s := $(.test.quick.%s) %s' % (target, target, slow_test_numbers))
106    print('%s-build: %s' % (prefix, executables))
107    print('.PHONY: %s' % (target, ))
108    print('.PHONY: %s-report-%s.tap' % (prefix, name))
109    print('%s: run-tests' % (target, ))
110    print('ifneq ($(filter %s %s, $(MAKECMDGOALS)),)' % (target, prefix))
111    print('.tests += $(.test.$(SPEED).%s)' % (target, ))
112    print('endif')
113    print('all-%s-targets += %s' % (prefix, target))
114
115targets = {t['id']: [os.path.relpath(f) for f in t['filename']]
116           for t in introspect['targets']}
117
118testsuites = defaultdict(Suite)
119for test in introspect['tests']:
120    process_tests(test, targets, testsuites)
121emit_prolog(testsuites, 'check')
122for name, suite in testsuites.items():
123    emit_suite(name, suite, 'check')
124
125benchsuites = defaultdict(Suite)
126for test in introspect['benchmarks']:
127    process_tests(test, targets, benchsuites)
128emit_prolog(benchsuites, 'bench')
129for name, suite in benchsuites.items():
130    emit_suite(name, suite, 'bench')
131
132print('run-tests: $(patsubst %, run-test-%, $(.tests))')
133