Skip to content

Commit

Permalink
sync language from zodb tutorial for test sections
Browse files Browse the repository at this point in the history
  • Loading branch information
mmerickel committed Feb 8, 2024
1 parent b2c8840 commit 222386e
Showing 1 changed file with 8 additions and 17 deletions.
25 changes: 8 additions & 17 deletions docs/tutorials/wiki2/tests.rst
Expand Up @@ -20,30 +20,21 @@ The test module would have the same name with the prefix ``test_``.

The harness consists of the following setup:

- ``[tool.pytest.ini_options]`` in ``pyproject.toml``.
- 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.

Controls basic ``pytest`` config including where to find the tests.
- 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.

- ``[tool.coverage.run]`` in ``pyproject.toml``.

- 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.

- ``testing`` optional dependencies in ``[project.optional-dependencies]`` section of ``pyproject.toml``.

Controls the dependencies installed when testing.
When the list is changed, it's 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 fixtures are explained in more detail below.

- 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.

Session-scoped test fixtures
----------------------------
Expand Down

0 comments on commit 222386e

Please sign in to comment.