[refactor] Make DRY by overriding fixture

tests/conftest.py

@@ -2,10 +2,42 @@
 
 import pytest
 
+from .helpers import prepare_files
+
 pytest_plugins = "sphinx.testing.fixtures"
 collect_ignore = ["roots"]
 
 
 @pytest.fixture(scope="session")
 def rootdir() -> Path:
     return Path(__file__).parent / "roots"
+
+
+@pytest.fixture
+def builder() -> str:
+    raise NotImplementedError("Define `builder` fixture in each test module")
+
+
+@pytest.fixture()
+def directory_name() -> str:
+    raise NotImplementedError(
+        "Define `directory_name` fixture in each test module"
+    )
+
+
+@pytest.fixture
+def prepared_srcdir(
+    sphinx_test_tempdir: Path, rootdir: Path, directory_name: str
+) -> Path:
+    srcdir = sphinx_test_tempdir / directory_name
+    prepare_files(rootdir / f"test-{directory_name}", srcdir)
+
+    return srcdir
+
+
+@pytest.fixture
+def built_html_path(make_app, builder: str, prepared_srcdir: Path) -> Path:
+    app = make_app(builder, srcdir=prepared_srcdir)
+    app.build()
+
+    return app.outdir / "index.html"

tests/test_custom_translator.py

@@ -2,11 +2,7 @@
 
 import pytest
 
-from .helpers import (
-    assert_reference_attributes,
-    extract_references,
-    prepare_files,
-)
+from .helpers import assert_reference_attributes, extract_references
 
 
 @pytest.fixture
@@ -19,24 +15,6 @@ def directory_name(request) -> str:
     return request.param
 
 
-@pytest.fixture
-def prepared_srcdir(
-    sphinx_test_tempdir: Path, rootdir: Path, directory_name: str
-) -> Path:
-    srcdir = sphinx_test_tempdir / directory_name
-    prepare_files(rootdir / f"test-{directory_name}", srcdir)
-
-    return srcdir
-
-
-@pytest.fixture
-def built_html_path(make_app, builder: str, prepared_srcdir: Path) -> Path:
-    app = make_app(builder, srcdir=prepared_srcdir)
-    app.build()
-
-    return app.outdir / "index.html"
-
-
 def test_should_open_new_tab(built_html_path: Path) -> None:
     references = extract_references(built_html_path)
 

tests/test_show_external_link_icon.py

@@ -2,11 +2,7 @@
 
 import pytest
 
-from .helpers import (
-    assert_reference_is_external,
-    extract_references,
-    prepare_files,
-)
+from .helpers import assert_reference_is_external, extract_references
 
 
 @pytest.fixture
@@ -19,24 +15,6 @@ def directory_name() -> str:
     return "external-link-icon"
 
 
-@pytest.fixture
-def prepared_srcdir(
-    sphinx_test_tempdir: Path, rootdir: Path, directory_name: str
-) -> Path:
-    srcdir = sphinx_test_tempdir / directory_name
-    prepare_files(rootdir / f"test-{directory_name}", srcdir)
-
-    return srcdir
-
-
-@pytest.fixture
-def built_html_path(make_app, builder: str, prepared_srcdir: Path) -> Path:
-    app = make_app(builder, srcdir=prepared_srcdir)
-    app.build()
-
-    return app.outdir / "index.html"
-
-
 def test_see_external_link_icon(built_html_path: Path) -> None:
     references = extract_references(built_html_path)
 

tests/test_sphinx_new_tab_link.py

@@ -2,11 +2,7 @@
 
 import pytest
 
-from .helpers import (
-    assert_reference_is_external,
-    extract_references,
-    prepare_files,
-)
+from .helpers import assert_reference_is_external, extract_references
 
 
 @pytest.fixture(params=["html", "singlehtml", "dirhtml"])
@@ -19,24 +15,6 @@ def directory_name() -> str:
     return "default"
 
 
-@pytest.fixture
-def prepared_srcdir(
-    sphinx_test_tempdir: Path, rootdir: Path, directory_name: str
-) -> Path:
-    srcdir = sphinx_test_tempdir / directory_name
-    prepare_files(rootdir / f"test-{directory_name}", srcdir)
-
-    return srcdir
-
-
-@pytest.fixture
-def built_html_path(make_app, builder: str, prepared_srcdir: Path) -> Path:
-    app = make_app(builder, srcdir=prepared_srcdir)
-    app.build()
-
-    return app.outdir / "index.html"
-
-
 @pytest.mark.parametrize(
     "index,expected_url",
     [