File: test_runner.py

package info (click to toggle)
pygame 2.6.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 42,624 kB
  • sloc: ansic: 66,926; python: 48,742; javascript: 1,153; objc: 224; sh: 121; makefile: 59; cpp: 25
file content (324 lines) | stat: -rw-r--r-- 9,328 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
import sys
import os

if __name__ == "__main__":
    pkg_dir = os.path.split(os.path.split(os.path.abspath(__file__))[0])[0]
    parent_dir, pkg_name = os.path.split(pkg_dir)
    is_pygame_pkg = pkg_name == "tests" and os.path.split(parent_dir)[1] == "pygame"
    if not is_pygame_pkg:
        sys.path.insert(0, parent_dir)
else:
    is_pygame_pkg = __name__.startswith("pygame.tests.")

import io
import optparse
import re
import unittest
from pprint import pformat

from .test_machinery import PygameTestLoader


def prepare_test_env():
    test_subdir = os.path.split(os.path.split(os.path.abspath(__file__))[0])[0]
    main_dir = os.path.split(test_subdir)[0]
    sys.path.insert(0, test_subdir)
    fake_test_subdir = os.path.join(test_subdir, "run_tests__tests")
    return main_dir, test_subdir, fake_test_subdir


main_dir, test_subdir, fake_test_subdir = prepare_test_env()

################################################################################
# Set the command line options
#
# options are shared with run_tests.py so make sure not to conflict
# in time more will be added here

TAG_PAT = r"-?[a-zA-Z0-9_]+"
TAG_RE = re.compile(TAG_PAT)
EXCLUDE_RE = re.compile(rf"({TAG_PAT},?\s*)+$")


def exclude_callback(option, opt, value, parser):
    if EXCLUDE_RE.match(value) is None:
        raise optparse.OptionValueError(f"{opt} argument has invalid value")
    parser.values.exclude = TAG_RE.findall(value)


opt_parser = optparse.OptionParser()

opt_parser.add_option(
    "-i", "--incomplete", action="store_true", help="fail incomplete tests"
)

opt_parser.add_option(
    "-s",
    "--usesubprocess",
    action="store_true",
    help="run everything in a single process " " (default: use no subprocesses)",
)

opt_parser.add_option(
    "-e",
    "--exclude",
    action="callback",
    type="string",
    help="exclude tests containing any of TAGS",
    callback=exclude_callback,
)

opt_parser.add_option(
    "-u",
    "--unbuffered",
    action="store_true",
    help="Show stdout/stderr as tests run, rather than storing it and showing on failures",
)

opt_parser.add_option(
    "-v",
    "--verbose",
    dest="verbosity",
    action="store_const",
    const=2,
    help="Verbose output",
)
opt_parser.add_option(
    "-q",
    "--quiet",
    dest="verbosity",
    action="store_const",
    const=0,
    help="Quiet output",
)

opt_parser.add_option(
    "-r", "--randomize", action="store_true", help="randomize order of tests"
)

################################################################################
# If an xxxx_test.py takes longer than TIME_OUT seconds it will be killed
# This is only the default, can be over-ridden on command line

TIME_OUT = 30

# DEFAULTS

################################################################################
# Human readable output
#

COMPLETE_FAILURE_TEMPLATE = """
======================================================================
ERROR: all_tests_for (%(module)s.AllTestCases)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "test/%(module)s.py", line 1, in all_tests_for
subprocess completely failed with return code of %(return_code)s
cmd:          %(cmd)s
test_env:     %(test_env)s
working_dir:  %(working_dir)s
return (first 10 and last 10 lines):
%(raw_return)s

"""  # Leave that last empty line else build page regex won't match
# Text also needs to be vertically compressed


RAN_TESTS_DIV = (70 * "-") + "\nRan"

DOTS = re.compile("^([FE.sux]*)$", re.MULTILINE)


def extract_tracebacks(output):
    """from test runner output return the tracebacks."""
    verbose_mode = " ..." in output

    if verbose_mode:
        if "ERROR" in output or "FAILURE" in output:
            return "\n\n==".join(output.split("\n\n==")[1:])
    else:
        dots = DOTS.search(output).group(1)
        if "E" in dots or "F" in dots:
            return output[len(dots) + 1 :].split(RAN_TESTS_DIV)[0]
    return ""


def output_into_dots(output):
    """convert the test runner output into dots."""
    # verbose_mode = ") ..." in output
    verbose_mode = " ..." in output

    if verbose_mode:
        # a map from the verbose output to the dots output.
        reasons = {
            "... ERROR": "E",
            "... unexpected success": "u",
            "... skipped": "s",
            "... expected failure": "x",
            "... ok": ".",
            "... FAIL": "F",
        }
        results = output.split("\n\n==")[0]
        lines = [l for l in results.split("\n") if l and "..." in l]
        dotlist = []
        for l in lines:
            found = False
            for reason in reasons:
                if reason in l:
                    dotlist.append(reasons[reason])
                    found = True
                    break
            if not found:
                raise ValueError(f"Not sure what this is. Add to reasons. :{l}")

        return "".join(dotlist)
    dots = DOTS.search(output).group(1)
    return dots


def combine_results(all_results, t):
    """

    Return pieced together results in a form fit for human consumption. Don't
    rely on results if  piecing together subprocessed  results (single process
    mode is fine). Was originally meant for that  purpose but was found to be
    unreliable.  See the dump option for reliable results.

    """

    all_dots = ""
    failures = []

    for module, results in sorted(all_results.items()):
        output, return_code, raw_return = map(
            results.get, ("output", "return_code", "raw_return")
        )

        if not output or (return_code and RAN_TESTS_DIV not in output):
            # would this effect the original dict? TODO
            output_lines = raw_return.splitlines()
            if len(output_lines) > 20:
                results["raw_return"] = "\n".join(
                    output_lines[:10] + ["..."] + output_lines[-10:]
                )
            failures.append(COMPLETE_FAILURE_TEMPLATE % results)
            all_dots += "E"
            continue

        dots = output_into_dots(output)
        all_dots += dots
        tracebacks = extract_tracebacks(output)
        if tracebacks:
            failures.append(tracebacks)

    total_fails, total_errors = map(all_dots.count, "FE")
    total_tests = len(all_dots)

    combined = [all_dots]
    if failures:
        combined += ["".join(failures).lstrip("\n")[:-1]]
    combined += [f"{RAN_TESTS_DIV} {total_tests} tests in {t:.3f}s\n"]

    if failures:
        infos = ([f"failures={total_fails}"] if total_fails else []) + (
            [f"errors={total_errors}"] if total_errors else []
        )
        combined += [f"FAILED ({', '.join(infos)})\n"]
    else:
        combined += ["OK\n"]

    return total_tests, "\n".join(combined)


################################################################################

TEST_RESULTS_START = "<--!! TEST RESULTS START HERE !!-->"
TEST_RESULTS_END = "<--!! TEST RESULTS END HERE !!-->"
_test_re_str = f"{TEST_RESULTS_START}\n(.*){TEST_RESULTS_END}"
TEST_RESULTS_RE = re.compile(_test_re_str, re.DOTALL | re.M)


def get_test_results(raw_return):
    test_results = TEST_RESULTS_RE.search(raw_return)
    if test_results:
        try:
            return eval(test_results.group(1))
        except:
            print(f"BUGGY TEST RESULTS EVAL:\n {test_results.group(1)}")
            raise


################################################################################


def run_test(
    module,
    incomplete=False,
    usesubprocess=True,
    randomize=False,
    exclude=("interactive",),
    buffer=True,
    unbuffered=None,
    verbosity=1,
):
    """Run a unit test module"""
    suite = unittest.TestSuite()

    if verbosity is None:
        verbosity = 1

    if verbosity:
        print(f"loading {module}")

    loader = PygameTestLoader(
        randomize_tests=randomize, include_incomplete=incomplete, exclude=exclude
    )
    suite.addTest(loader.loadTestsFromName(module))

    output = io.StringIO()
    runner = unittest.TextTestRunner(stream=output, buffer=buffer, verbosity=verbosity)
    results = runner.run(suite)

    if verbosity == 2:
        output.seek(0)
        print(output.read())
        output.seek(0)

    results = {
        module: {
            "output": output.getvalue(),
            "num_tests": results.testsRun,
            "num_errors": len(results.errors),
            "num_failures": len(results.failures),
        }
    }

    if usesubprocess:
        print(TEST_RESULTS_START)
        print(pformat(results))
        print(TEST_RESULTS_END)
    else:
        return results


################################################################################

if __name__ == "__main__":
    options, args = opt_parser.parse_args()
    if not args:
        if is_pygame_pkg:
            run_from = "pygame.tests.go"
        else:
            run_from = os.path.join(main_dir, "run_tests.py")
        sys.exit(f"No test module provided; consider using {run_from} instead")
    run_test(
        args[0],
        incomplete=options.incomplete,
        usesubprocess=options.usesubprocess,
        randomize=options.randomize,
        exclude=options.exclude,
        buffer=(not options.unbuffered),
    )

################################################################################