Commit 75ebe7d8 authored by René Fritze's avatar René Fritze Committed by René Fritze

improve test execution documentation in readme+makefile

also remove fasttest target, this hasn't been supported for a while now
parent 86ad2265
#!/usr/bin/env make
# customization points via makefile key-value arguments
# 3.{6,7,8} supported currently
#
# interpreter in images: 3.{6,7,8} currently available
# DOCKER_BASE_PYTHON=3.7
# one of mpi, notebooks_dir, oldest, vanilla, mpi, numpy_git, pip_installed
# test script executed with `docker_test`: mpi, notebooks_dir, oldest, vanilla, mpi, numpy_git, pip_installed
# PYMOR_TEST_SCRIPT=vanilla
# stable or oldest
# version pinned mirror to be used: stable or oldest
# PYPI_MIRROR=stable
# debian_buster centos_8 debian_testing
# wheel check OS: debian_buster centos_8 debian_testing
# PYMOR_TEST_OS=debian_buster
# end: customization points via makefile key-value arguments
# hypothesis profiles: dev, debug, ci, ci-pr, ci-large
# PYMOR_HYPOTHESIS_PROFILE=dev
#
MKFILE_PATH :=
THIS_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
DOCKER_RUN=docker run -v $(THIS_DIR):/pymor --env-file $(THIS_DIR)/.env
DOCKER_COMPOSE=CI_COMMIT_SHA=$(shell git log -1 --pretty=format:"%H") \
......@@ -43,7 +46,7 @@ flake8:
flake8 ./src
test:
python setup.py test
python setup.py pytest
jupyter:
jupyter notebook --notebook-dir=$(NB_DIR) --NotebookApp.disable_check_xsrf=True
......@@ -51,9 +54,6 @@ jupyter:
tutorials: NB_DIR="docs/_build/html"
tutorials: docs jupyter
fasttest:
PYMOR_PYTEST_MARKER="not slow" python setup.py test
full-test:
@echo
@echo "Ensuring that all required pytest plugins are installed ..."
......
......@@ -233,9 +233,13 @@ Tests
-----
pyMOR uses [pytest](https://pytest.org/) for unit testing. To run the test suite,
simply execute `make test` in the base directory of the pyMOR repository. This
will also create a test coverage report which can be found in the `htmlcov`
directory. Alternatively, you can run `make full-test` which will also enable
simply execute `make test` in the base directory of the pyMOR repository. This will
run the pytest suite with the default hypothesis profile "dev". For available profiles
see `src/pymortests/conftest.py`. A profile is selected by running `make PYMOR_HYPOTHESIS_PROFILE=PROFILE_NAME test`.
If docker is available, use `make PYMOR_HYPOTHESIS_PROFILE=PROFILE_NAME docker_test` to execute the test suite
in the same environment as on pyMOR's CI infrastructure. Additional customization points are listed at the top of the
`Makefile`.
Run `make full-test` which will also enable
[pyflakes](https://pypi.python.org/pypi/pyflakes) and
[pep8](https://www.python.org/dev/peps/pep-0008/) checks.
......
[aliases]
test = pytest
[pycodestyle]
max-line-length = 120
max-doc-length = 100
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment