diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a85179a6..b3405d19 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -14,11 +14,6 @@ Added - Deprecation warning for existing `-i` option for `projects` command. - Binder build cache step -Updated -~~~~~~~ - -- Remove notebooks directory as we break it out into a `separate repository `_ - Fixed ~~~~~ @@ -33,6 +28,8 @@ Updated - Added new option "--names" to `projects` CLI command. This is meant as a better named and more intuitive replacement for the existing `-i` option. - Returned more explicit error statuses for `projects` and `submit` commands. +- Remove notebooks directory as we break it out into a `separate repository `_ +- Plumbed test posargs through to allow local execution of specific test files. v9.0.0 ------ diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index e65ef263..1859fc56 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -78,7 +78,7 @@ For testing purposes, we write tests in the ``test`` folder in the also use `tox `__ for automating tests. -The ``tox`` command is run by Jenkins and is currently configured to run +The ``tox`` command is run by CI and is currently configured to run the main module tests, generate a coverage report and build documentation. @@ -92,7 +92,7 @@ the root folder. If you’re using `pyenv `__ to manage python versions, ensure you have all the tested environments in your -``.python-version`` file. i.e.\ ``pyenv local 3.5.6 3.6.8 3.7.3`` +``.python-version`` file. i.e.\ ``pyenv local 3.6.12 3.7.9 3.8.7`` Running Specific Tests ~~~~~~~~~~~~~~~~~~~~~~ @@ -103,6 +103,9 @@ To run just the main module tests, execute ``python setup.py test`` in the root folder. This is specified by the main ``[testenv]`` flag in ``tox.ini``. +To run a specific test, execute ``python setup.py test -a path/to/test.py``. +Using tox, ``tox -e py36 -- -a path/to/test.py``. + To build the docs locally, execute ``sphinx-build -W -b html -d tmp/doctrees . -d tmp/html`` in the ``docs`` directory. This is specified by the ``[testenv:docs]`` flag in diff --git a/tox.ini b/tox.ini index 82afa6c3..5970daa1 100644 --- a/tox.ini +++ b/tox.ini @@ -2,7 +2,7 @@ envlist = clean, py36, py37, py38, stats, lint, docs [testenv] -commands = python setup.py test +commands = python setup.py test {posargs} deps = .[test, jupyter, analysis] [testenv:clean]