-
Notifications
You must be signed in to change notification settings - Fork 55
/
etstool.py
502 lines (416 loc) · 16.3 KB
/
etstool.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
# (C) Copyright 2005-2020 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
"""
Tasks for Test Runs
===================
This file is intended to be used with a python environment with the
click library to automate the process of setting up test environments
and running the test within them. This improves repeatability and
reliability of tests be removing many of the variables around the
developer's particular Python environment. Test environment setup and
package management is performed using `EDM
http://docs.enthought.com/edm/`_
To use this to run you tests, you will need to install EDM and click
into your working environment. You will also need to have git
installed to access required source code from github repositories.
You can then do::
python etstool.py install --runtime=... --toolkit=...
to create a test environment from the current codebase and::
python etstool.py test --runtime=... --toolkit=...
to run tests in that environment. You can remove the environment with::
python etstool.py cleanup --runtime=... --toolkit=...
If you make changes you will either need to remove and re-install the
environment or manually update the environment using ``edm``, as
the install performs a ``python setup.py install`` rather than a ``develop``,
so changes in your code will not be automatically mirrored in the test
environment. You can update with a command like::
edm run --environment ... -- python setup.py install
You can run all three tasks at once with::
python etstool.py test_clean --runtime=... --toolkit=...
which will create, install, run tests, and then clean-up the environment. And
you can run tests in all supported runtimes and toolkits (with cleanup)
using::
python etstool.py test_all
Currently supported runtime values are ``2.7`` and ``3.5``, and currently
supported toolkits are ``null``, ``pyqt``, ``pyside`` and ``wx``. Not all
combinations of toolkits and runtimes will work, but the tasks will fail with
a clear error if that is the case.
Tests can still be run via the usual means in other environments if that suits
a developer's purpose.
Changing This File
------------------
To change the packages installed during a test run, change the dependencies
variable below. To install a package from github, or one which is not yet
available via EDM, add it to the `ci-src-requirements.txt` file (these will be
installed by `pip`).
Other changes to commands should be a straightforward change to the listed
commands for each task. See the EDM documentation for more information about
how to run commands within an EDM enviornment.
"""
import glob
import os
import subprocess
import sys
from shutil import rmtree, copy as copyfile
from tempfile import mkdtemp
from contextlib import contextmanager
import click
supported_combinations = {
"3.5": {"pyqt", "pyqt5"},
"3.6": {"pyqt", "pyqt5", "pyside2", "wx"},
}
dependencies = {"traits", "numpy", "pygments", "coverage", "mock"}
extra_dependencies = {
"pyside": {"pyside"},
# XXX once pyside2 is available in EDM, we will want it here
"pyside2": set(),
"pyqt": {"pyqt<4.12"}, # FIXME: build 1 of.4-12 appears to be bad
"pyqt5": {"pyqt5"},
# XXX once wxPython 4 is available in EDM, we will want it here
"wx": set(),
"null": set(),
}
doc_dependencies = {"sphinx"}
doc_ignore = {
"pyface/wx/*",
"pyface/qt/*",
"pyface/ui/*",
"pyface/dock/*",
"pyface/util/fix_introspect_bug.py",
"pyface/grid/*",
}
environment_vars = {
"pyside": {"ETS_TOOLKIT": "qt4", "QT_API": "pyside"},
"pyside2": {"ETS_TOOLKIT": "qt4", "QT_API": "pyside2"},
"pyqt": {"ETS_TOOLKIT": "qt4", "QT_API": "pyqt"},
"pyqt5": {"ETS_TOOLKIT": "qt4", "QT_API": "pyqt5"},
"wx": {"ETS_TOOLKIT": "wx"},
"null": {"ETS_TOOLKIT": "null"},
}
# Options shared between the various commands.
edm_option = click.option(
"--edm",
help=(
"Path to the EDM executable to use. The default is to use the first "
"EDM found in the path. The EDM executable can also be specified "
"by setting the ETSTOOL_EDM environment variable."
),
envvar="ETSTOOL_EDM",
)
@click.group()
def cli():
pass
@cli.command()
@edm_option
@click.option("--runtime", default="3.6", help="Python version to use")
@click.option("--toolkit", default="pyqt", help="Toolkit and API to use")
@click.option("--environment", default=None, help="EDM environment to use")
def install(edm, runtime, toolkit, environment):
""" Install project and dependencies into a clean EDM environment.
"""
parameters = get_parameters(edm, runtime, toolkit, environment)
packages = " ".join(dependencies | extra_dependencies.get(toolkit, set()))
# edm commands to setup the development environment
commands = [
"{edm} environments create {environment} --force --version={runtime}",
"{edm} install -y -e {environment} " + packages,
"{edm} run -e {environment} -- pip install -r ci-src-requirements.txt --no-dependencies",
"{edm} run -e {environment} -- python setup.py clean --all",
"{edm} run -e {environment} -- python setup.py install",
]
# pip install pyqt5 and pyside2, because we don't have them in EDM yet
if toolkit == "pyside2":
commands.extend(
[
"{edm} run -e {environment} -- pip install shiboken2",
"{edm} run -e {environment} -- pip install pyside2",
]
)
elif toolkit == "wx":
if sys.platform == "darwin":
commands.append(
"{edm} run -e {environment} -- python -m pip install wxPython<4.1"
)
elif sys.platform == "linux":
# XXX this is mainly for TravisCI workers; need a generic solution
commands.append(
"{edm} run -e {environment} -- pip install -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-14.04/ wxPython<4.1"
)
else:
commands.append(
"{edm} run -e {environment} -- python -m pip install wxPython"
)
click.echo("Creating environment '{environment}'".format(**parameters))
execute(commands, parameters)
click.echo("Done install")
@cli.command()
@edm_option
@click.option("--runtime", default="3.6", help="Python version to use")
@click.option("--toolkit", default="pyqt", help="Toolkit and API to use")
@click.option("--environment", default=None, help="EDM environment to use")
@click.option(
"--no-environment-vars",
is_flag=True,
help="Do not set ETS_TOOLKIT and QT_API",
)
def test(edm, runtime, toolkit, environment, no_environment_vars=False):
""" Run the test suite in a given environment with the specified toolkit.
"""
parameters = get_parameters(edm, runtime, toolkit, environment)
if toolkit == "wx":
parameters["exclude"] = "qt"
elif toolkit in {"pyqt", "pyqt5", "pyside", "pyside2"}:
parameters["exclude"] = "wx"
else:
parameters["exclude"] = "(wx|qt)"
if no_environment_vars:
environ = {}
else:
environ = environment_vars.get(toolkit, {}).copy()
environ["PYTHONUNBUFFERED"] = "1"
if toolkit == "wx":
environ["EXCLUDE_TESTS"] = "qt"
elif toolkit in {"pyqt", "pyqt5", "pyside", "pyside2"}:
environ["EXCLUDE_TESTS"] = "wx"
else:
environ["EXCLUDE_TESTS"] = "(wx|qt)"
commands = [
"{edm} run -e {environment} -- coverage run -p -m "
"unittest discover -v pyface",
]
# We run in a tempdir to avoid accidentally picking up wrong pyface
# code from a local dir. We need to ensure a good .coveragerc is in
# that directory, plus coverage has a bug that means a non-local coverage
# file doesn't get populated correctly.
click.echo("Running tests in '{environment}'".format(**parameters))
with do_in_tempdir(
files=[".coveragerc"], capture_files=[os.path.join(".", ".coverage*")]
):
os.environ.update(environ)
execute(commands, parameters)
click.echo("Done test")
@cli.command()
@edm_option
@click.option("--runtime", default="3.6", help="Python version to use")
@click.option("--toolkit", default="pyqt", help="Toolkit and API to use")
@click.option("--environment", default=None, help="EDM environment to use")
def cleanup(edm, runtime, toolkit, environment):
""" Remove a development environment.
"""
parameters = get_parameters(edm, runtime, toolkit, environment)
commands = [
"{edm} run -e {environment} -- python setup.py clean",
"{edm} environments remove {environment} --purge -y",
]
click.echo("Cleaning up environment '{environment}'".format(**parameters))
execute(commands, parameters)
click.echo("Done cleanup")
@cli.command()
@edm_option
@click.option("--runtime", default="3.6", help="Python version to use")
@click.option("--toolkit", default="pyqt", help="Toolkit and API to use")
@click.option(
"--no-environment-vars",
is_flag=True,
help="Do not set ETS_TOOLKIT and QT_API",
)
def test_clean(edm, runtime, toolkit, no_environment_vars=False):
""" Run tests in a clean environment, cleaning up afterwards
"""
args = ["--toolkit={}".format(toolkit), "--runtime={}".format(runtime)]
if edm is not None:
args.append("--edm={}".format(edm))
test_args = args[:]
if no_environment_vars:
test_args.append("--no-environment-vars")
try:
install(args=args, standalone_mode=False)
test(args=test_args, standalone_mode=False)
finally:
cleanup(args=args, standalone_mode=False)
@cli.command()
@edm_option
@click.option("--runtime", default="3.6", help="Python version to use")
@click.option("--toolkit", default="pyqt", help="Toolkit and API to use")
@click.option("--environment", default=None, help="EDM environment to use")
def update(edm, runtime, toolkit, environment):
""" Update/Reinstall package into environment.
"""
parameters = get_parameters(edm, runtime, toolkit, environment)
commands = ["{edm} run -e {environment} -- python setup.py install"]
click.echo("Re-installing in '{environment}'".format(**parameters))
execute(commands, parameters)
click.echo("Done update")
@cli.command()
@edm_option
@click.option("--runtime", default="3.6", help="Python version to use")
@click.option("--toolkit", default="pyqt", help="Toolkit and API to use")
@click.option("--environment", default=None, help="EDM environment to use")
def api_docs(edm, runtime, toolkit, environment):
""" Autogenerate documentation
"""
parameters = get_parameters(edm, runtime, toolkit, environment)
packages = " ".join(doc_dependencies)
ignore = " ".join(doc_ignore)
commands = [
"{edm} install -y -e {environment} " + packages,
"{edm} run -e {environment} -- pip install -r doc-src-requirements.txt --no-dependencies",
]
click.echo(
"Installing documentation tools in '{environment}'".format(
**parameters
)
)
execute(commands, parameters)
click.echo("Done installing documentation tools")
click.echo(
"Regenerating API docs in '{environment}'".format(**parameters)
)
api_path = os.path.join("docs", "source", "api")
if os.path.exists(api_path):
rmtree(api_path)
os.makedirs(api_path)
commands = [
"{edm} run -e {environment} -- sphinx-apidoc -e -M -o "
+ api_path
+ " pyface "
+ ignore
]
execute(commands, parameters)
click.echo("Done regenerating API docs")
os.chdir("docs")
commands = ["{edm} run -e {environment} -- make html"]
click.echo(
"Building documentation in '{environment}'".format(**parameters)
)
try:
execute(commands, parameters)
finally:
os.chdir("..")
click.echo("Done building documentation")
@cli.command()
@edm_option
def test_all(edm):
""" Run test_clean across all supported environment combinations.
"""
error = False
for runtime, toolkits in supported_combinations.items():
for toolkit in toolkits:
args = [
"--toolkit={}".format(toolkit),
"--runtime={}".format(runtime),
]
if edm is not None:
args.append("--edm={}".format(edm))
try:
test_clean(args, standalone_mode=True)
except SystemExit as exc:
if exc.code not in (None, 0):
error = True
click.echo(str(exc))
if error:
sys.exit(1)
# ----------------------------------------------------------------------------
# Utility routines
# ----------------------------------------------------------------------------
def get_parameters(edm, runtime, toolkit, environment):
""" Set up parameters dictionary for format() substitution """
parameters = {
"runtime": runtime,
"toolkit": toolkit,
"environment": environment,
}
if toolkit not in supported_combinations[runtime]:
msg = (
"Python {runtime} and toolkit {toolkit} not supported by "
+ "test environments"
)
raise RuntimeError(msg.format(**parameters))
if environment is None:
parameters["environment"] = "pyface-test-{runtime}-{toolkit}".format(
**parameters
)
if edm is None:
edm = locate_edm()
parameters["edm"] = edm
return parameters
@contextmanager
def do_in_tempdir(files=(), capture_files=()):
""" Create a temporary directory, cleaning up after done.
Creates the temporary directory, and changes into it. On exit returns to
original directory and removes temporary dir.
Parameters
----------
files : sequence of filenames
Files to be copied across to temporary directory.
capture_files : sequence of filenames
Files to be copied back from temporary directory.
"""
path = mkdtemp()
old_path = os.getcwd()
# send across any files we need
for filepath in files:
click.echo("copying file to tempdir: {}".format(filepath))
copyfile(filepath, path)
os.chdir(path)
try:
yield path
# retrieve any result files we want
for pattern in capture_files:
for filepath in glob.iglob(pattern):
click.echo("copying file back: {}".format(filepath))
copyfile(filepath, old_path)
finally:
os.chdir(old_path)
rmtree(path)
def execute(commands, parameters):
for command in commands:
click.echo("[EXECUTING] {}".format(command.format(**parameters)))
try:
subprocess.check_call(
[arg.format(**parameters) for arg in command.split()]
)
except subprocess.CalledProcessError as exc:
print(exc)
sys.exit(1)
def locate_edm():
"""
Locate an EDM executable if it exists, else raise an exception.
Returns the first EDM executable found on the path. On Windows, if that
executable turns out to be the "edm.bat" batch file, replaces it with the
executable that it wraps: the batch file adds another level of command-line
mangling that interferes with things like specifying version restrictions.
Returns
-------
edm : str
Path to the EDM executable to use.
Raises
------
click.ClickException
If no EDM executable is found in the path.
"""
# Once Python 2 no longer needs to be supported, we should use
# shutil.which instead.
which_cmd = "where" if sys.platform == "win32" else "which"
try:
cmd_output = subprocess.check_output([which_cmd, "edm"])
except subprocess.CalledProcessError:
raise click.ClickException(
"This script requires EDM, but no EDM executable was found."
)
# Don't try to be clever; just use the first candidate.
edm_candidates = cmd_output.decode("utf-8").splitlines()
edm = edm_candidates[0]
# Resolve edm.bat on Windows.
if sys.platform == "win32" and os.path.basename(edm) == "edm.bat":
edm = os.path.join(os.path.dirname(edm), "embedded", "edm.exe")
return edm
if __name__ == "__main__":
cli()