-
Notifications
You must be signed in to change notification settings - Fork 343
/
setup.py
executable file
·506 lines (440 loc) · 19.3 KB
/
setup.py
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
#!/bin/env python3
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
#
# See LICENSE for more details.
#
# Copyright: Red Hat Inc. 2013-2014
# Author: Lucas Meneghel Rodrigues <[email protected]>
import argparse
import os
import shutil
import sys
from abc import abstractmethod
from distutils.command.clean import clean # pylint: disable=W0402
from pathlib import Path
from subprocess import CalledProcessError, run
import setuptools.command.develop
from setuptools import Command, find_packages, setup
# pylint: disable=E0611
BASE_PATH = os.path.dirname(__file__)
with open(os.path.join(BASE_PATH, "VERSION"), "r", encoding="utf-8") as version_file:
VERSION = version_file.read().strip()
OPTIONAL_PLUGINS_PATH = os.path.join(BASE_PATH, "optional_plugins")
EXAMPLES_PLUGINS_TESTS_PATH = os.path.join(BASE_PATH, "examples", "plugins", "tests")
def get_long_description():
with open(os.path.join(BASE_PATH, "README.rst"), "rt", encoding="utf-8") as readme:
readme_contents = readme.read()
return readme_contents
def walk_plugins_setup_py(action, action_name=None, directory=OPTIONAL_PLUGINS_PATH):
if action_name is None:
action_name = action[0].upper()
for plugin in list(Path(directory).glob("*/setup.py")):
parent_dir = plugin.parent
print(f">> {action_name} {parent_dir}")
run([sys.executable, "setup.py"] + action, cwd=parent_dir, check=True)
class Clean(clean):
"""Our custom command to get rid of junk files after build."""
description = "Get rid of scratch, byte files and build stuff."
def run(self):
super().run()
cleaning_list = [
"PYPI_UPLOAD",
"EGG_UPLOAD",
"./build",
"./dist",
"./man/avocado.1",
"./docs/build",
]
cleaning_list += list(Path("/tmp/").glob(".avocado-*"))
cleaning_list += list(Path("/var/tmp/").glob(".avocado-*"))
cleaning_list += list(Path(".").rglob("*.egg-info"))
cleaning_list += list(Path(".").rglob("*.pyc"))
cleaning_list += list(Path(".").rglob("__pycache__"))
cleaning_list += list(Path("./docs/source/api/").rglob("*.rst"))
for e in cleaning_list:
try:
if not os.path.exists(e):
continue
if os.path.isfile(e):
os.remove(e)
if os.path.isdir(e):
shutil.rmtree(e)
except FileNotFoundError:
print(f"File not found: {e}, unable to delete.")
except PermissionError:
print(f"Permission denied for {e}, unable to delete.")
except Exception as ex:
print(f"An error occurred while deleting {e}: {ex}")
self.clean_optional_plugins()
@staticmethod
def clean_optional_plugins():
walk_plugins_setup_py(["clean", "--all"], directory=OPTIONAL_PLUGINS_PATH)
walk_plugins_setup_py(["clean", "--all"], directory=EXAMPLES_PLUGINS_TESTS_PATH)
class Develop(setuptools.command.develop.develop):
"""Custom develop command."""
user_options = setuptools.command.develop.develop.user_options + [
("external", None, "Install external plugins in development mode"),
(
"skip-optional-plugins",
None,
"Do not include in-tree optional plugins in development mode",
),
(
"skip-examples-plugins-tests",
None,
"Do not include in-tree example plugins for test types in development mode",
),
]
boolean_options = setuptools.command.develop.develop.boolean_options + [
"external",
"skip-optional-plugins",
"skip-examples-plugins-tests",
]
def _walk_develop_plugins(self):
if not self.skip_optional_plugins:
walk_plugins_setup_py(
["develop"] + self.action_options,
self.action_name,
OPTIONAL_PLUGINS_PATH,
)
if not self.skip_examples_plugins_tests:
walk_plugins_setup_py(
["develop"] + self.action_options,
self.action_name,
EXAMPLES_PLUGINS_TESTS_PATH,
)
@property
def action_options(self):
result = []
if self.uninstall:
result.append("--uninstall")
if self.user:
result.append("--user")
return result
@property
def action_name(self):
if self.uninstall:
return "DEVELOP UNLINK"
else:
return "DEVELOP LINK"
@property
def external_plugins_path(self):
try:
d = os.getenv("AVOCADO_EXTERNAL_PLUGINS_PATH")
if not os.path.exists(d):
return None
return os.path.abspath(d)
except TypeError:
return None
def initialize_options(self):
super().initialize_options()
self.external = 0 # pylint: disable=W0201
self.skip_optional_plugins = 0 # pylint: disable=W0201
self.skip_examples_plugins_tests = 0 # pylint: disable=W0201
def handle_uninstall(self):
"""When uninstalling, we remove the plugins before Avocado."""
self._walk_develop_plugins()
super().run()
def handle_install(self):
"""When installing, we install plugins after installing Avocado."""
super().run()
self._walk_develop_plugins()
def handle_external(self):
"""Handles only external plugins.
The current logic means that --external will not install Avocado.
"""
d = self.external_plugins_path
if d is None:
msg = "The variable AVOCADO_EXTERNAL_PLUGINS_PATH isn't properly set"
sys.exit(msg)
walk_plugins_setup_py(
action=["develop"] + self.action_options,
action_name=self.action_name,
directory=d,
)
def run(self):
if self.external:
self.handle_external()
else:
if not self.uninstall:
self.handle_install()
elif self.uninstall:
self.handle_uninstall()
class SimpleCommand(Command):
"""Make Command implementation simpler."""
user_options = []
@abstractmethod
def run(self):
"""Run when command is invoked."""
def initialize_options(self):
"""Set default values for options."""
def finalize_options(self):
"""Post-process options."""
class Linter(SimpleCommand):
"""Lint Python source code. (Deprecated)"""
description = "Run logical, stylistic, analytical and formatter checks."
def run(self):
print(
"This command is deprecated, please use instead: python3 setup.py test --static-checks"
)
sys.exit()
class Test(SimpleCommand):
"""Run selftests"""
description = "Run selftests"
user_options = [
("skip=", None, "Run all tests and skip listed tests, separated by comma"),
(
"select=",
None,
"Do not run any test, only these listed after, separated by comma",
),
(
"disable-plugin-checks=",
None,
"Disable checks for one or more plugins (by directory name), separated by comma",
),
("list-features", None, "Show the features tested by this test"),
]
def initialize_options(self):
self.skip = [] # pylint: disable=W0201
self.select = [] # pylint: disable=W0201
self.disable_plugin_checks = [] # pylint: disable=W0201
self.list_features = False # pylint: disable=W0201
def run(self):
args = argparse.Namespace()
args.skip = self.skip if len(self.skip) == 0 else [self.skip]
args.select = self.select if len(self.select) == 0 else [self.select]
args.disable_plugin_checks = (
self.disable_plugin_checks
if len(self.disable_plugin_checks) == 0
else [self.disable_plugin_checks]
)
args.list_features = self.list_features
# Import here on purpose, otherwise it'll mess with install/develop commands
import selftests.check
sys.exit(selftests.check.main(args))
class Man(SimpleCommand):
"""Build man page"""
description = "Build man page."
def run(self):
if shutil.which("rst2man"):
cmd = "rst2man"
elif shutil.which("rst2man.py"):
cmd = "rst2man.py"
else:
sys.exit("rst2man not found, I can't build the manpage")
try:
run([cmd, "man/avocado.rst", "man/avocado.1"], check=True)
except CalledProcessError as e:
print("Failed manpage build: ", e)
sys.exit(128)
class Plugin(SimpleCommand):
"""Handle plugins"""
description = "Handle plugins"
user_options = [
("list", "l", "List available plugins"),
("install=", "i", "Plugin to install"),
("user", "u", "User install"),
]
def initialize_options(self):
self.list = False # pylint: disable=W0201
self.install = None # pylint: disable=W0201
self.user = False # pylint: disable=W0201
def run(self):
plugins_list = []
directory = os.path.join(BASE_PATH, "optional_plugins")
for plugin in list(Path(directory).glob("*/setup.py")):
plugins_list.append(plugin.parts[-2])
if self.list or (not self.list and not self.install):
print("List of available plugins:\n ", "\n ".join(plugins_list))
return
if self.install in plugins_list:
action = ["install"]
if self.user:
action += ["--user"]
parent_dir = os.path.join(directory, self.install)
run([sys.executable, "setup.py"] + action, cwd=parent_dir, check=True)
else:
print(
self.install,
"is not a known plugin. Please, check the list of available plugins.",
)
return
if __name__ == "__main__":
# Force "make develop" inside the "readthedocs.org" environment
if os.environ.get("READTHEDOCS") and "install" in sys.argv:
run(["/usr/bin/make", "develop"], check=True)
setup(
name="avocado-framework",
version=VERSION,
description="Avocado Test Framework",
long_description=get_long_description(),
long_description_content_type="text/x-rst",
author="Avocado Developers",
author_email="[email protected]",
url="https://avocado-framework.github.io/",
license="GPLv2+",
classifiers=[
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)",
"Natural Language :: English",
"Operating System :: POSIX",
"Topic :: Software Development :: Quality Assurance",
"Topic :: Software Development :: Testing",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
],
packages=find_packages(exclude=("selftests*",)),
include_package_data=True,
entry_points={
"console_scripts": [
"avocado = avocado.core.main:main",
"avocado-runner-noop = avocado.plugins.runners.noop:main",
"avocado-runner-dry-run = avocado.plugins.runners.dry_run:main",
"avocado-runner-exec-test = avocado.plugins.runners.exec_test:main",
"avocado-runner-python-unittest = avocado.plugins.runners.python_unittest:main",
"avocado-runner-avocado-instrumented = avocado.plugins.runners.avocado_instrumented:main",
"avocado-runner-tap = avocado.plugins.runners.tap:main",
"avocado-runner-asset = avocado.plugins.runners.asset:main",
"avocado-runner-package = avocado.plugins.runners.package:main",
"avocado-runner-podman-image = avocado.plugins.runners.podman_image:main",
"avocado-runner-sysinfo = avocado.plugins.runners.sysinfo:main",
"avocado-software-manager = avocado.utils.software_manager.main:main",
"avocado-external-runner = scripts.external_runner:main",
],
"avocado.plugins.init": [
"xunit = avocado.plugins.xunit:XUnitInit",
"jsonresult = avocado.plugins.jsonresult:JSONInit",
"sysinfo = avocado.plugins.sysinfo:SysinfoInit",
"tap = avocado.plugins.tap:TAPInit",
"jobscripts = avocado.plugins.jobscripts:JobScriptsInit",
"dict_variants = avocado.plugins.dict_variants:DictVariantsInit",
"json_variants = avocado.plugins.json_variants:JsonVariantsInit",
"run = avocado.plugins.run:RunInit",
"podman = avocado.plugins.spawners.podman:PodmanSpawnerInit",
"lxc = avocado.plugins.spawners.lxc:LXCSpawnerInit",
"nrunner = avocado.plugins.runner_nrunner:RunnerInit",
"testlogsui = avocado.plugins.testlogs:TestLogsUIInit",
"human = avocado.plugins.human:HumanInit",
"exec-runnables-recipe = avocado.plugins.resolvers:ExecRunnablesRecipeInit",
],
"avocado.plugins.cli": [
"xunit = avocado.plugins.xunit:XUnitCLI",
"json = avocado.plugins.jsonresult:JSONCLI",
"journal = avocado.plugins.journal:Journal",
"tap = avocado.plugins.tap:TAP",
"zip_archive = avocado.plugins.archive:ArchiveCLI",
"json_variants = avocado.plugins.json_variants:JsonVariantsCLI",
"nrunner = avocado.plugins.runner_nrunner:RunnerCLI",
"podman = avocado.plugins.spawners.podman:PodmanCLI",
],
"avocado.plugins.cli.cmd": [
"config = avocado.plugins.config:Config",
"distro = avocado.plugins.distro:Distro",
"exec-path = avocado.plugins.exec_path:ExecPath",
"variants = avocado.plugins.variants:Variants",
"list = avocado.plugins.list:List",
"run = avocado.plugins.run:Run",
"sysinfo = avocado.plugins.sysinfo:SysInfo",
"plugins = avocado.plugins.plugins:Plugins",
"diff = avocado.plugins.diff:Diff",
"vmimage = avocado.plugins.vmimage:VMimage",
"assets = avocado.plugins.assets:Assets",
"jobs = avocado.plugins.jobs:Jobs",
"replay = avocado.plugins.replay:Replay",
"cache = avocado.plugins.cache:Cache",
],
"avocado.plugins.job.prepost": [
"jobscripts = avocado.plugins.jobscripts:JobScripts",
"teststmpdir = avocado.plugins.teststmpdir:TestsTmpDir",
"human = avocado.plugins.human:HumanJob",
"testlogsui = avocado.plugins.testlogs:TestLogsUI",
"suite-dependency = avocado.plugins.dependency:SuiteDependency",
],
"avocado.plugins.test.pre": [
"dependency = avocado.plugins.dependency:DependencyResolver",
"sysinfo = avocado.plugins.sysinfo:SysInfoTest",
],
"avocado.plugins.test.post": [
"sysinfo = avocado.plugins.sysinfo:SysInfoTest",
],
"avocado.plugins.result": [
"xunit = avocado.plugins.xunit:XUnitResult",
"json = avocado.plugins.jsonresult:JSONResult",
"zip_archive = avocado.plugins.archive:Archive",
],
"avocado.plugins.result_events": [
"human = avocado.plugins.human:Human",
"tap = avocado.plugins.tap:TAPResult",
"journal = avocado.plugins.journal:JournalResult",
"fetchasset = avocado.plugins.assets:FetchAssetJob",
"sysinfo = avocado.plugins.sysinfo:SysInfoJob",
"testlogging = avocado.plugins.testlogs:TestLogging",
"bystatus = avocado.plugins.bystatus:ByStatusLink",
"beaker = avocado.plugins.beaker_result:BeakerResult",
],
"avocado.plugins.varianter": [
"json_variants = avocado.plugins.json_variants:JsonVariants",
"dict_variants = avocado.plugins.dict_variants:DictVariants",
],
"avocado.plugins.resolver": [
"exec-test = avocado.plugins.resolvers:ExecTestResolver",
"python-unittest = avocado.plugins.resolvers:PythonUnittestResolver",
"avocado-instrumented = avocado.plugins.resolvers:AvocadoInstrumentedResolver",
"tap = avocado.plugins.resolvers:TapResolver",
"runnable-recipe = avocado.plugins.resolvers:RunnableRecipeResolver",
"runnables-recipe = avocado.plugins.resolvers:RunnablesRecipeResolver",
"exec-runnables-recipe = avocado.plugins.resolvers:ExecRunnablesRecipeResolver",
],
"avocado.plugins.suite.runner": [
"nrunner = avocado.plugins.runner_nrunner:Runner",
],
"avocado.plugins.runnable.runner": [
(
"avocado-instrumented = avocado.plugins."
"runners.avocado_instrumented:AvocadoInstrumentedTestRunner"
),
"tap = avocado.plugins.runners.tap:TAPRunner",
"noop = avocado.plugins.runners.noop:NoOpRunner",
"dry-run = avocado.plugins.runners.dry_run:DryRunRunner",
"exec-test = avocado.plugins.runners.exec_test:ExecTestRunner",
"python-unittest = avocado.plugins.runners.python_unittest:PythonUnittestRunner",
"asset = avocado.plugins.runners.asset:AssetRunner",
"package = avocado.plugins.runners.package:PackageRunner",
"podman-image = avocado.plugins.runners.podman_image:PodmanImageRunner",
"sysinfo = avocado.plugins.runners.sysinfo:SysinfoRunner",
],
"avocado.plugins.spawner": [
"process = avocado.plugins.spawners.process:ProcessSpawner",
"podman = avocado.plugins.spawners.podman:PodmanSpawner",
"lxc = avocado.plugins.spawners.lxc:LXCSpawner",
],
"avocado.plugins.cache": [
"requirement = avocado.plugins.requirement_cache:RequirementCache",
],
},
zip_safe=False,
test_suite="selftests",
python_requires=">=3.8",
cmdclass={
"clean": Clean,
"develop": Develop,
"lint": Linter,
"man": Man,
"plugin": Plugin,
"test": Test,
},
install_requires=["setuptools"],
)