fix(tests): exclude new pytest-gitlab plugin when running tests via tox

ptalbert · ptalbert · commit 5414694fc179 · 2026-01-07T12:45:52.000+01:00
The previous commit adds a new pytest plugin `pytest-gitlab` but does
not (yet) update the existing tests to use it. For now it needs to
explicitly be disabled when running tests so it does not interfere with
the original fixtures.

Since tox now runs the tests with `-p no:gitlab` the
test_gitflab_plugin_is_loaded test will always fail.
Skip it for now and instead ensure the entrypoint is at least there.

Signed-off-by: Patrick Talbert &lt;ptalbert@redhat.com&gt;
diff --git a/requirements-docker.txt b/requirements-docker.txt
@@ -1,3 +1,2 @@
 -r requirements.txt
 -r requirements-test.txt
-pytest-docker==3.2.5
diff --git a/requirements-test.txt b/requirements-test.txt
@@ -6,6 +6,7 @@ pytest-console-scripts==1.4.1
 pytest-cov==7.0.0
 pytest-github-actions-annotate-failures==0.3.0
 pytest==9.0.2
+pytest-docker==3.2.5
 PyYaml==6.0.3
 responses==0.25.8
 respx==0.22.0
diff --git a/tests/unit/test_pytest_plugin.py b/tests/unit/test_pytest_plugin.py
@@ -1,6 +1,17 @@
-"""Tests for the gitlab pytest plugin."""
+"""Tests for the pytest-gitlab plugin."""
 
+from importlib.metadata import entry_points
 
-def test_gitlab_plugin_is_registered(request):
-    """'gitlab' is a registered pytest plugin."""
+import pytest
+
+
+@pytest.mark.skip(reason="pytest-gitlab plugin is disabled in tox")
+def test_gitlab_plugin_is_loaded(request):
+    """'gitlab' is a loaded pytest plugin."""
     assert request.config.pluginmanager.hasplugin("gitlab")
+
+
+def test_gitlab_plugin_is_registered():
+    """'gitlab' is registered as a pytest11 entry point."""
+    pytest11_entry_points = entry_points(group="pytest11")
+    assert any(ep.value == "gitlab.testing.plugin" for ep in pytest11_entry_points)
diff --git a/tox.ini b/tox.ini
@@ -26,7 +26,7 @@ passenv =
   NO_COLOR
   PWD
   PY_COLORS
-setenv = 
+setenv =
   DOCS_SOURCE = docs
   DOCS_BUILD = build/sphinx/html
   VIRTUAL_ENV={envdir}
@@ -38,7 +38,7 @@ isolated_build = True
 deps = -r{toxinidir}/requirements.txt
        -r{toxinidir}/requirements-test.txt
 commands =
-  pytest tests/unit {posargs}
+  pytest -p no:gitlab tests/unit {posargs}
 
 [testenv:black]
 basepython = python3
@@ -102,12 +102,12 @@ per-file-ignores =
     gitlab/v4/objects/__init__.py:F401,F403
 
 [testenv:docs]
-description = Builds the docs site. Generated HTML files will be available in '{env:DOCS_BUILD}'. 
+description = Builds the docs site. Generated HTML files will be available in '{env:DOCS_BUILD}'.
 deps = -r{toxinidir}/requirements-docs.txt
 commands = sphinx-build -n -W --keep-going -b html {env:DOCS_SOURCE} {env:DOCS_BUILD}
 
 [testenv:docs-serve]
-description = 
+description =
     Builds and serves the HTML docs site locally. \
     Use this for verifying updates to docs. \
     Changes to docs files will be automatically rebuilt and served.
@@ -116,7 +116,7 @@ commands = sphinx-autobuild {env:DOCS_SOURCE} {env:DOCS_BUILD} --open-browser --
 
 [testenv:cover]
 commands =
-  pytest --cov --cov-report term --cov-report html \
+  pytest -p no:gitlab --cov --cov-report term --cov-report html \
     --cov-report xml tests/unit {posargs}
 
 [coverage:run]
@@ -133,16 +133,16 @@ exclude_lines =
 [testenv:cli_func_v4]
 deps = -r{toxinidir}/requirements-docker.txt
 commands =
-  pytest --script-launch-mode=subprocess --cov --cov-report xml tests/functional/cli {posargs}
+  pytest -p no:gitlab --script-launch-mode=subprocess --cov --cov-report xml tests/functional/cli {posargs}
 
 [testenv:api_func_v4]
 deps = -r{toxinidir}/requirements-docker.txt
 commands =
-  pytest --cov --cov-report xml tests/functional/api {posargs}
+  pytest -p no:gitlab --cov --cov-report xml tests/functional/api {posargs}
 
 [testenv:smoke]
 deps = -r{toxinidir}/requirements-test.txt
-commands = pytest tests/smoke {posargs}
+commands = pytest -p no:gitlab tests/smoke {posargs}
 
 [testenv:pre-commit]
 skip_install = true
@@ -153,4 +153,4 @@ commands = pre-commit run --all-files --show-diff-on-failure
 skip_install = true
 deps = -r{toxinidir}/requirements.txt
        -r{toxinidir}/requirements-test.txt
-commands = pytest tests/install
+commands = pytest -p no:gitlab tests/install

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`	`1`	`-r requirements.txt`
`2`	`2`	`-r requirements-test.txt`
`3`		`-pytest-docker==3.2.5`