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
|
# debian/tests/smoke_test.py
#
# This is free software, and you are welcome to redistribute it under
# certain conditions; see the end of this file for copyright
# information, grant of license, and disclaimer of warranty.
""" Post-install Python smoke test for use in Debian autopkgtest.
Written to test all installed versions of a package.
Smoke test the distribution::
--distribution=DISTRIBUTION
Smoke test one or more modules::
--module=MODULE_FOO --module=MODULE_BAR --module=MODULE_BAZ
"""
import argparse
import importlib
import importlib.metadata
import sys
import textwrap
import pkg_resources
def emit_implementation():
""" Emit the details of the current Python implementation.
:return: ``None``.
"""
sys.stdout.write(textwrap.dedent("""\
Interpreter: {command}
\t{version}
""").format(command=sys.executable, version=sys.version))
def emit_distribution_metadata(name):
""" Get the distribution `name` and emit some metadata.
:param name: Name of the distribution to retrieve.
:return: ``None``.
"""
metadata = importlib.metadata.metadata(name)
sys.stdout.write(textwrap.dedent("""\
Distribution ‘{name}’:
\t{metadata[Name]} {metadata[Version]}
""").format(name=name, metadata=metadata))
def emit_module(name):
""" Import the module `name` and emit the module representation.
:param name: Full name of the module to import.
:return: ``None``.
"""
module = importlib.import_module(name)
sys.stdout.write(textwrap.dedent("""\
Package ‘{name}’:
\t{module!r}
""").format(name=name, module=module))
def suite(args):
""" Run the full suite of tests.
:param args: Namespace of arguments parsed from `ArgumentParser`.
:return: ``None``.
"""
emit_implementation()
if args.distribution_name:
emit_distribution_metadata(args.distribution_name)
if args.module_names:
for module_name in args.module_names:
emit_module(module_name)
class SmokeTestArgumentParser(argparse.ArgumentParser):
""" Command-line argument parser for this program. """
def __init__(self, *args, **kwargs):
super(SmokeTestArgumentParser, self).__init__(*args, **kwargs)
self.add_argument(
'--distribution',
dest='distribution_name', type=str,
metavar="DISTRIBUTION", help=(
"Test the Python distribution named DISTRIBUTION."))
self.add_argument(
'--module',
dest='module_names', type=str, nargs='+',
metavar="MODULE", help=(
"Test the Python module named MODULE."))
def parse_args(self, *args, **kwargs):
args = super().parse_args(*args, **kwargs)
if (not any([args.distribution_name, args.module_names])):
self.error("one of DISTRIBUTION or MODULE is required")
return args
def main(argv=None):
""" Mainline code for this module.
:param argv: Sequence of all command line arguments.
(Default: `sys.argv`)
:return: The exit status (integer) for exit from the process.
"""
exit_status = 0
if argv is None:
argv = sys.argv
try:
program_name = argv[0]
parser = SmokeTestArgumentParser(prog=program_name)
args = parser.parse_args(argv[1:])
suite(args)
except SystemExit as exc:
exit_status = exc.code
return exit_status
if __name__ == "__main__":
exit_status = main(sys.argv)
sys.exit(exit_status)
# Copyright © 2016–2022 Ben Finney <bignose@debian.org>
# This is free software: you may copy, modify, and/or distribute this work
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; version 3 of that license or any later version.
# No warranty expressed or implied.
# Local variables:
# coding: utf-8
# mode: python
# End:
# vim: fileencoding=utf-8 filetype=python :
|
