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
|
#! /usr/bin/env python3
# $Id: package_unittest.py 9035 2022-03-05 23:29:48Z milde $
# Author: Garth Kidd <garth@deadlybloodyserious.com>
# Copyright: This module has been placed in the public domain.
"""
This module extends unittest.py with `loadTestModules()`, by loading multiple
test modules from a directory. Optionally, test packages are also loaded,
recursively.
"""
import sys
import os
import getopt
import types
import unittest
# So that individual test modules can share a bit of state,
# `package_unittest` acts as an intermediary for the following
# variables:
debug = False
verbosity = 1
USAGE = """\
Usage: test_whatever [options]
Options:
-h, --help Show this message
-v, --verbose Verbose output
-q, --quiet Minimal output
-d, --debug Debug mode
"""
def usageExit(msg=None):
"""Print usage and exit."""
if msg:
print(msg)
print(USAGE)
sys.exit(2)
def parseArgs(argv=sys.argv):
"""Parse command line arguments and set TestFramework state.
State is to be acquired by test_* modules by a grotty hack:
``from TestFramework import *``. For this stylistic
transgression, I expect to be first up against the wall
when the revolution comes. --Garth"""
global verbosity, debug
try:
options, args = getopt.getopt(argv[1:], 'hHvqd',
['help', 'verbose', 'quiet', 'debug'])
for opt, value in options:
if opt in ('-h', '-H', '--help'):
usageExit()
if opt in ('-q', '--quiet'):
verbosity = 0
if opt in ('-v', '--verbose'):
verbosity = 2
if opt in ('-d', '--debug'):
debug = 1
if len(args) != 0:
usageExit("No command-line arguments supported yet.")
except getopt.error as msg:
usageExit(msg)
def loadTestModules(path, name='', packages=None):
"""
Return a test suite composed of all the tests from modules in a directory.
Search for modules in directory `path`, beginning with `name`. If
`packages` is true, search subdirectories (also beginning with `name`)
recursively. Subdirectories must be Python packages; they must contain an
'__init__.py' module.
"""
testLoader = unittest.defaultTestLoader
testSuite = unittest.TestSuite()
testModules = []
path = os.path.abspath(path) # current working dir if `path` empty
paths = [path]
while paths:
p = paths.pop(0)
files = os.listdir(p)
for filename in files:
if not filename.startswith(name):
continue
fullpath = os.path.join(p, filename)
if filename.endswith('.py'):
fullpath = fullpath[len(path)+1:]
testModules.append(path2mod(fullpath))
elif (packages and os.path.isdir(fullpath)
and os.path.isfile(os.path.join(fullpath, '__init__.py'))):
paths.append(fullpath)
# Import modules and add their tests to the suite.
sys.path.insert(0, path)
for mod in testModules:
if debug:
print("importing %s" % mod, file=sys.stderr)
try:
module = import_module(mod)
except ImportError:
print(f"ERROR: Can't import {mod}, skipping its tests:",
file=sys.stderr)
sys.excepthook(*sys.exc_info())
else:
# if there's a suite defined, incorporate its contents
try:
suite = getattr(module, 'suite')
except AttributeError:
# Look for individual tests
moduleTests = testLoader.loadTestsFromModule(module)
# unittest.TestSuite.addTests() doesn't work as advertised,
# as it can't load tests from another TestSuite, so we have
# to cheat:
testSuite.addTest(moduleTests)
continue
if isinstance(suite, types.FunctionType):
testSuite.addTest(suite())
elif isinstance(suite, unittest.TestSuite):
testSuite.addTest(suite)
else:
raise AssertionError("don't understand suite (%s)" % mod)
sys.path.pop(0)
return testSuite
def path2mod(path):
"""Convert a file path to a dotted module name."""
return path[:-3].replace(os.sep, '.')
def import_module(name):
"""Import a dotted-path module name, and return the final component."""
mod = __import__(name)
components = name.split('.')
for comp in components[1:]:
mod = getattr(mod, comp)
return mod
def main(suite=None):
"""
Shared `main` for any individual test_* file.
suite -- TestSuite to run. If not specified, look for any globally defined
tests and run them.
"""
parseArgs()
if suite is None:
# Load any globally defined tests.
suite = unittest.defaultTestLoader.loadTestsFromModule(
__import__('__main__'))
if debug:
print("Debug: Suite=%s" % suite, file=sys.stderr)
testRunner = unittest.TextTestRunner(verbosity=verbosity)
# run suites (if we were called from test_all) or suite...
if isinstance(suite, type([])):
for s in suite:
testRunner.run(s)
else:
return testRunner.run(suite)
|
