diff --git a/doc/source/developer-overview.rst b/doc/source/developer-overview.rst index 1e69df9d..c4c2671d 100644 --- a/doc/source/developer-overview.rst +++ b/doc/source/developer-overview.rst @@ -124,6 +124,17 @@ All Pegleg tests are nested under ``tests``. Pegleg comes equipped with a number of `tox`_ targets for running unit tests, as well as `pep8`_ and `Bandit`_ checks. +Unit Tests +---------- + +To run all unit tests, execute:: + + $ tox -epy35 + +To run unit tests using a regex, execute:: + + $ tox -epy35 -- + .. _Airship: https://airshipit.readthedocs.io .. _Deckhand: https://airship-deckhand.readthedocs.io/ .. _Airship coding conventions: https://airshipit.readthedocs.io/en/latest/conventions.html diff --git a/tools/gate/run-unit-tests.sh b/tools/gate/run-unit-tests.sh new file mode 100755 index 00000000..15042fe8 --- /dev/null +++ b/tools/gate/run-unit-tests.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env bash + +set -e +posargs=$@ +if [ ${#posargs} -ge 1 ]; then + pytest -k ${posargs} +else + pytest +fi +set +e diff --git a/tox.ini b/tox.ini index da840ed2..c4db8da4 100644 --- a/tox.ini +++ b/tox.ini @@ -18,8 +18,7 @@ whitelist_externals = find commands = find . -type f -name "*.pyc" -delete - pytest \ - {posargs} + {toxinidir}/tools/gate/run-unit-tests.sh '{posargs}' [testenv:fmt] basepython=python3