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 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
|
# (C) Copyright 2005-2023 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 in a Python environment equipped with the
click library, to automate the process of setting up test environments
and running the tests 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 your 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=...
to create a test environment from the current codebase and::
python etstool.py test --runtime=...
to run tests in that environment. You can remove the environment with::
python etstool.py clean --runtime=...
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 ``pip install .`` rather than a ``pip install -e .``,
so changes in your code will not be automatically mirrored in the test
environment. You can update with::
python etstool.py update --runtime=...
You can run install, test and clean all at once with::
python etstool.py test-clean --runtime=...
which will create, install, run tests, and then clean up the environment. And
you can run tests in all supported runtimes::
python etstool.py test-all
The only currently supported runtime values is ``3.8``. Not all
combinations of 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
``common_dependencies`` variable below.
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 environment.
"""
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
# Ensure that "-h" is supported for getting help.
CONTEXT_SETTINGS = dict(
help_option_names=["-h", "--help"],
)
# Dependencies common to all configurations.
common_dependencies = {
"configobj",
"coverage",
"cython",
"enthought_sphinx_theme",
"flake8",
"flake8_ets",
"numpy",
"Sphinx",
"sphinx_copybutton",
"traitsui",
}
# Dependencies on the Python runtime.
runtime_dependencies = {
"3.8": {"pyside6"},
}
# Dependencies that need to be installed from PyPI
pypi_dependencies = {
"3.8": {"lark-parser", "mypy"}
}
# Dependencies we install from source for testing
source_dependencies = {"traitsui"}
# Unix-specific dependencies.
unix_dependencies = {
"gnureadline",
}
supported_runtimes = ["3.8"]
default_runtime = "3.8"
github_url_fmt = "git+http://github.com/enthought/{0}.git#egg={0}"
# Click options shared by multiple 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",
)
runtime_option = click.option(
"--runtime",
default=default_runtime,
type=click.Choice(supported_runtimes),
show_default=True,
help="Python runtime version for the development environment",
)
editable_option = click.option(
"--editable/--not-editable",
default=False,
help="Install main package in 'editable' mode? [default: --not-editable]",
)
verbose_option = click.option(
"--verbose/--quiet",
default=True,
help="Run tests in verbose mode? [default: --verbose]",
)
@click.group(context_settings=CONTEXT_SETTINGS)
def cli():
"""
Developer and CI support commands for Traits.
"""
pass
@cli.command()
@edm_option
@runtime_option
@click.option(
"--environment",
default=None,
help="Name of the EDM environment to install",
)
@editable_option
@click.option("--source/--no-source", default=False)
def install(edm, runtime, environment, editable, source):
""" Install project and dependencies into a clean EDM environment and
optionally install further dependencies required for building
documentation and mini-language parser.
"""
parameters = get_parameters(edm, runtime, environment)
dependencies = common_dependencies.copy()
dependencies.update(runtime_dependencies.get(runtime, set()))
if sys.platform != "win32":
dependencies.update(unix_dependencies)
packages = " ".join(dependencies)
# EDM commands to set up the development environment. The installation
# of TraitsUI from EDM installs Traits as a dependency, so we need
# to explicitly uninstall it before re-installing from source.
install_traits = _get_install_command_string(".", editable=editable)
install_stubs = _get_install_command_string(
"./traits-stubs/", editable=editable
)
commands = [
"{edm} environments create {environment} --force --version={runtime}",
"{edm} --config edm.yaml install -y -e {environment} " + packages,
"{edm} plumbing remove-package -e {environment} traits",
install_traits,
install_stubs,
]
if pypi_dependencies:
commands += [
"{edm} run -e {environment} -- python -m pip install " + dep
for dep in pypi_dependencies.get(runtime, set())
]
click.echo("Creating environment '{environment}'".format(**parameters))
execute(commands, parameters)
if source:
commands = [
"{edm} plumbing remove-package "
"--environment {environment} --force "
+ " ".join(source_dependencies)
]
execute(commands, parameters)
source_pkgs = [
github_url_fmt.format(pkg) for pkg in source_dependencies
]
commands = [
"python -m pip install {pkg} --no-deps".format(pkg=pkg)
for pkg in source_pkgs
]
commands = [
"{edm} run -e {environment} -- " + command for command in commands
]
execute(commands, parameters)
click.echo("Done install")
@cli.command()
@edm_option
@runtime_option
@click.option(
"--environment",
default=None,
help="Name of the EDM environment to install",
)
def shell(edm, runtime, environment):
""" Create a shell into the EDM development environment
(aka 'activate' it).
"""
parameters = get_parameters(edm, runtime, environment)
commands = [
"{edm} shell -e {environment}",
]
execute(commands, parameters)
@cli.command()
@edm_option
@runtime_option
@click.option(
"--environment", default=None, help="Name of EDM environment to check."
)
def flake8(edm, runtime, environment):
""" Run a flake8 check in a given environment.
"""
parameters = get_parameters(edm, runtime, environment)
commands = ["{edm} run -e {environment} -- python -m flake8"]
execute(commands, parameters)
@cli.command()
@edm_option
@runtime_option
@verbose_option
@click.option(
"--environment", default=None, help="Name of EDM environment to test."
)
def test(edm, runtime, verbose, environment):
""" Run the test suite in a given environment.
"""
parameters = get_parameters(edm, runtime, environment)
environ = {}
environ["PYTHONUNBUFFERED"] = "1"
options = "--verbose " if verbose else ""
commands = [
"{edm} run -e {environment} -- coverage run -p -m "
"unittest discover " + options + "traits",
]
commands += [
"{edm} run -e {environment} -- coverage run -p -m "
"unittest discover " + options + "traits_stubs_tests",
]
# We run in a tempdir to avoid accidentally picking up wrong traits
# 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
@runtime_option
@click.option(
"--environment",
default=None,
help="Name of EDM environment to build docs for.",
)
@click.option(
"--error-on-warn/--no-error-on-warn",
default=True,
help="Turn warnings into errors? [default: --error-on-warn] ",
)
def docs(edm, runtime, environment, error_on_warn):
""" Build the html documentation.
"""
parameters = get_parameters(edm, runtime, environment)
build_docs = (
"{edm} run -e {environment} -- sphinx-build -b html "
+ ("-W " if error_on_warn else "")
+ "-d build/doctrees source build/html"
)
commands = [build_docs]
with do_in_existingdir(os.path.join(os.getcwd(), "docs")):
execute(commands, parameters)
@cli.command()
@edm_option
@runtime_option
@click.option(
"--environment", default=None, help="Name of EDM environment to remove."
)
def clean(edm, runtime, environment):
""" Remove a development environment.
"""
parameters = get_parameters(edm, runtime, environment)
commands = [
"{edm} environments remove {environment} --purge -y",
]
click.echo("Removing environment '{environment}'".format(**parameters))
execute(commands, parameters)
click.echo("Environment removed.")
@cli.command(name="test-clean")
@edm_option
@runtime_option
def test_clean(edm, runtime):
""" Run tests and build documentation in a clean environment.
A clean EDM environment is created for the test run, and removed
again afterwards.
"""
args = ["--runtime={}".format(runtime)]
if edm is not None:
args.append("--edm={}".format(edm))
try:
install(args=args, standalone_mode=False)
test(args=args, standalone_mode=False)
docs(args=args, standalone_mode=False)
finally:
clean(args=args, standalone_mode=False)
@cli.command()
@edm_option
@runtime_option
@click.option(
"--environment", default=None, help="Name of EDM environment to update."
)
@editable_option
def update(edm, runtime, environment, editable):
""" Update/Reinstall package into environment.
"""
parameters = get_parameters(edm, runtime, environment)
if editable:
install_cmd = (
"{edm} run -e {environment} -- "
"python -m pip install --editable . --no-dependencies"
)
else:
install_cmd = (
"{edm} run -e {environment} -- "
"python -m pip install . --no-dependencies"
)
commands = [install_cmd]
click.echo("Re-installing in '{environment}'".format(**parameters))
execute(commands, parameters)
click.echo("Done update")
@cli.command(name="test-all")
@edm_option
def test_all(edm):
""" Run test-clean across all supported environment combinations.
"""
error = False
for runtime in supported_runtimes:
args = ["--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)
@cli.command(name="generate-parser")
@edm_option
@runtime_option
@click.option(
"--environment", default=None, help="Name of EDM environment to use."
)
def generate_parser(edm, runtime, environment):
""" Regenerate the mini-language parser for the observe framework.
"""
parameters = get_parameters(edm, runtime, environment)
root_dir = os.path.dirname(__file__)
observers_dir = os.path.join(root_dir, "traits", "observation")
# parser file to be generated.
out_path = os.path.join(observers_dir, "_generated_parser.py")
# grammar file.
parameters["grammar_path"] = os.path.join(
observers_dir, "_dsl_grammar.lark")
command = (
"{edm} run -e {environment} -- "
"python -m lark.tools.standalone "
"{grammar_path}"
)
with open(out_path, "w", encoding="utf-8") as out_file:
execute([command], parameters, stdout=out_file)
click.echo("Written to {out_path!r}".format(out_path=out_path))
# Utility routines
def get_parameters(edm, runtime, environment):
""" Set up parameters dictionary for format() substitution. """
if edm is None:
edm = locate_edm()
if environment is None:
environment = "traits-test-{runtime}".format(runtime=runtime)
return {
"edm": edm,
"runtime": runtime,
"environment": environment,
}
@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)
@contextmanager
def do_in_existingdir(path):
""" Changes into an existing directory given by path.
On exit, changes back to the original directory.
Parameters
----------
path : str
Path of the directory to be changed into.
"""
old_path = os.getcwd()
os.chdir(path)
try:
yield path
finally:
os.chdir(old_path)
def execute(commands, parameters, stdout=None):
for command in commands:
click.echo("[EXECUTING] {}".format(command.format(**parameters)))
try:
subprocess.check_call(
[arg.format(**parameters) for arg in command.split()],
stdout=stdout,
)
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
def _get_install_command_string(pkg_or_location, editable, no_deps=True):
""" Create and return a command string configured by the provided
parameters.
Parameters
----------
pkg_or_location : str
Either a location in the filesystem containing setup.py or the
name of a package.
editable : bool
Whether to add --editable flag
no_deps : bool
Whether to add --no-dependencies flag
Returns
-------
cmd : str
A command string, which if executed will install the package or run
the setup script at the provided location.
"""
cmd = "{edm} run -e {environment} -- python -m pip install"
if editable:
cmd += " --editable"
cmd += " {}".format(pkg_or_location)
if no_deps:
cmd += " --no-dependencies"
return cmd
if __name__ == "__main__":
cli(prog_name="python etstool.py")
|