tests(doctest_docutils): Stub out tests

Author: tony

tests/test_doctest_docutils.py

@@ -0,0 +1,195 @@
+import doctest
+import pathlib
+import textwrap
+import typing as t
+
+import pytest
+
+import doctest_docutils
+
+FixtureFileDict = t.Dict[str, str]
+
+
+class DocTestFinderFixture(t.NamedTuple):
+    # pytest
+    test_id: str
+
+    # Content
+    files: FixtureFileDict
+    tests_found: int
+
+
+FIXTURES = [
+    #
+    # Docutils
+    #
+    DocTestFinderFixture(
+        test_id="reST-doctest_block",
+        files={
+            "example.rst": textwrap.dedent(
+                """
+>>> 4 + 4
+8
+        """
+            )
+        },
+        tests_found=1,
+    ),
+    DocTestFinderFixture(
+        test_id="reST-doctest_directive",
+        files={
+            "example.rst": textwrap.dedent(
+                """
+.. doctest::
+
+   >>> 4 + 4
+   8
+        """
+            )
+        },
+        tests_found=1,
+    ),
+    #
+    # Markdown / myst-parser
+    #
+    DocTestFinderFixture(
+        test_id="MyST-doctest_block",
+        files={
+            "example.md": textwrap.dedent(
+                """
+```
+>>> 4 + 4
+8
+```
+        """
+            )
+        },
+        tests_found=1,
+    ),
+    DocTestFinderFixture(
+        test_id="MyST-doctest_block-indented",
+        files={
+            "example.md": textwrap.dedent(
+                """
+Here's a test:
+
+    >>> 4 + 4
+    8
+        """
+            )
+        },
+        tests_found=1,
+    ),
+    DocTestFinderFixture(
+        test_id="MyST-doctest_directive-colons",
+        files={
+            "example.md": textwrap.dedent(
+                """
+:::{doctest}
+
+    >>> 4 + 4
+    8
+:::
+        """
+            )
+        },
+        tests_found=1,
+    ),
+    DocTestFinderFixture(
+        test_id="MyST-doctest_directive-backticks",
+        files={
+            "example.md": textwrap.dedent(
+                """
+```{doctest}
+
+    >>> 4 + 4
+    8
+```
+        """
+            )
+        },
+        tests_found=1,
+    ),
+    DocTestFinderFixture(
+        test_id="MyST-doctest_directive-eval-rst-colons",
+        files={
+            "example.md": textwrap.dedent(
+                """
+:::{eval-rst}
+
+   .. doctest::
+
+      >>> 4 + 4
+      8
+:::
+        """
+            )
+        },
+        tests_found=1,
+    ),
+    DocTestFinderFixture(
+        test_id="MyST-doctest_directive-eval-rst-backticks",
+        files={
+            "example.md": textwrap.dedent(
+                """
+```{eval-rst}
+
+   .. doctest::
+
+      >>> 4 + 4
+      8
+```
+        """
+            )
+        },
+        tests_found=1,
+    ),
+]
+
+
+@pytest.mark.parametrize(
+    DocTestFinderFixture._fields, FIXTURES, ids=[f.test_id for f in FIXTURES]
+)
+@pytest.mark.parametrize("file_path_mode", ["relative", "absolute"])
+def test_DocutilsDocTestFinder(
+    tmp_path: pathlib.Path,
+    monkeypatch: pytest.MonkeyPatch,
+    test_id: str,
+    files: FixtureFileDict,
+    tests_found: int,
+    file_path_mode: str,
+) -> None:
+    # Initialize variables
+    tests_path = tmp_path / "tests"
+    first_test_key = list(files.keys())[0]
+    first_test_filename = first_test_key
+    if file_path_mode == "absolute":
+        first_test_filename = str(tests_path / first_test_filename)
+    elif file_path_mode != "relative":
+        raise NotImplementedError(f"No file_path_mode supported for {file_path_mode}")
+
+    # Setup: Files
+    tests_path.mkdir()
+    for file_name, text in files.items():
+        rst_file = tests_path / file_name
+        rst_file.write_text(
+            text,
+            encoding="utf-8",
+        )
+
+    # Setup: Environment
+    if file_path_mode == "relative":
+        monkeypatch.chdir(tests_path)
+
+    # Test
+    finder = doctest_docutils.DocutilsDocTestFinder()
+    text, _ = doctest._load_testfile(  # type: ignore
+        str(first_test_filename), package=None, module_relative=False, encoding="utf-8"
+    )
+    tests = finder.find(text, str(first_test_filename))
+    tests.sort(key=lambda test: test.name)
+
+    assert len(tests) == tests_found
+
+    for test in tests:
+        doctest.DebugRunner(verbose=False).run(test)