diff options
| author | Tres Seaver <tseaver@palladion.com> | 2024-02-07 20:58:53 -0500 |
|---|---|---|
| committer | Tres Seaver <tseaver@palladion.com> | 2024-02-07 20:58:53 -0500 |
| commit | 48d224cd63b4497d4b798c3a2583f2611dfaa54e (patch) | |
| tree | 2ab4ef49f3a8df3e0c02bfc80610e6eaf8e5979c | |
| parent | 60b4dc9e3c072dc01e5a11dedeae225f331a2980 (diff) | |
| download | pyramid-48d224cd63b4497d4b798c3a2583f2611dfaa54e.tar.gz pyramid-48d224cd63b4497d4b798c3a2583f2611dfaa54e.tar.bz2 pyramid-48d224cd63b4497d4b798c3a2583f2611dfaa54e.zip | |
fix: document test harness config via 'pyproject.toml'
| -rw-r--r-- | docs/tutorials/wiki/tests.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/tutorials/wiki/tests.rst b/docs/tutorials/wiki/tests.rst index f9359dd38..70eb3c1da 100644 --- a/docs/tutorials/wiki/tests.rst +++ b/docs/tutorials/wiki/tests.rst @@ -19,19 +19,19 @@ The test module would have the same name with the prefix ``test_``. The harness consists of the following setup: -- ``pytest.ini`` - controls basic ``pytest`` configuration, including where to find the tests. +- The ``project.optional-dependencies`` stanza of ``pyproject.toml`` - controls the dependencies installed when testing. + When the list is changed, it is necessary to re-run ``$VENV/bin/pip install -e ".[testing]"`` to ensure the new dependencies are installed. + +- The ``tool.pytest.ini_options`` stanza of ``pyproject.toml`` controls basic ``pytest`` configuration, including where to find the tests. We have configured ``pytest`` to search for tests in the application package and in the ``tests`` package. -- ``.coveragerc`` - controls coverage config. +- The ``tool.coverage.run`` stanza of ``pyproject.toml`` controls coverage config. In our setup, it works with the ``pytest-cov`` plugin that we use via the ``--cov`` options to the ``pytest`` command. -- ``testing.ini`` - a mirror of ``development.ini`` and ``production.ini`` that contains settings used for executing the test suite. +- The ``testing.ini`` file is a mirror of ``development.ini`` and ``production.ini`` that contains settings used for executing the test suite. Most importantly, it contains the database connection information used by tests that require the database. -- ``project.optional-dependencies`` in ``pyproject.toml`` - controls the dependencies installed when testing. - When the list is changed, it is necessary to re-run ``$VENV/bin/pip install -e ".[testing]"`` to ensure the new dependencies are installed. - -- ``tests/conftest.py`` - the core fixtures available throughout our tests. +- The ``tests/conftest.py`` file defines the core fixtures available throughout our tests. The fixtures are explained in more detail in the following sections. Open ``tests/conftest.py`` and follow along. |