Skip to content

docs(testing): document passing pytest options during local development #3367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohnVillalovos merged 7 commits into from
Mar 22, 2026
+26 −0
Merged

docs(testing): document passing pytest options during local development #3367

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
88e4841
docs(testing): improve tox test execution and document workflow
amimas Feb 17, 2026
bd6b425
fix(ci): install dependencies for coverage environment
amimas Mar 10, 2026
389f2c9
fix(ci): install test dependencies for functional test envs
amimas Mar 10, 2026
3ebd3ce
Revert "fix(ci): install dependencies for coverage environment"
amimas Mar 22, 2026
741325e
Revert "fix(ci): install test dependencies for functional test envs"
amimas Mar 22, 2026
1d49a9c
revert: remove changes made to tox config
amimas Mar 22, 2026
8bc75e3
docs: add instructions for passing pytest options
amimas Mar 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,32 @@ To cleanup the environment delete the container:
docker rm -f gitlab-test
docker rm -f gitlab-runner-test
Pass options to ``pytest``
--------------------------

Options to ``pytest`` can be passed by adding them after ``--`` when running ``tox``:

.. code-block:: bash
tox -e api_func_v4 -- <pytest options>.
For example, you can use this to run a specific test. Running all tests can be time-consuming,
so this allows you to focus on just the tests relevant to your changes. You can do this by passing
the ``-k`` flag to ``pytest`` and setting a relevant expression to select the tests to run. For example:

.. code-block:: bash
# Run all API functional tests from the ``test_projects.py`` file:
tox -e api_func_v4 -- --keep-containers -k test_projects.py
# Run only the ``test_get_project`` test method from the ``test_projects.py`` file:
tox -e api_func_v4 -- --keep-containers -k "test_projects.py and test_create_project"
# The above will select all test methods start with ``test_create_project`` from the ``test_projects.py`` file.
# To select only the ``test_create_project`` method, you can exclude other methods by using the ``not`` operator:
tox -e api_func_v4 -- --keep-containers -k "test_projects.py and test_create_project and not test_create_project_"
Rerunning failed CI workflows
-----------------------------

Expand Down
Loading