Merge pull request #9 from JWCook/tests

This contribution greatly improves testing. Thanks to @JWCook for the good work!

.github/workflows/build.yml

@@ -27,9 +27,7 @@ jobs:
           pip install -U pip setuptools
           pip install -e .[dev]
       - name: Run tests
-        run: pytest -v tests || diff tmp/ tests/docs1/expected && exit 1
-        # Remove this line once tests are updated to work in CI:
-        continue-on-error: true
+        run: pytest -vs tests
 
   # For git tags, build and publish package to PyPI
   publish:

README.rst

@@ -106,6 +106,11 @@ Run the test suite::
 
   $ pytest
 
+Generate an HTML test coverage report::
+
+  $ pytest --cov-report=html
+  $ python -m webbrowser test-reports/index.html
+
 Release a new version to PyPI::
 
   $ hatch version micro

pyproject.toml

@@ -48,6 +48,7 @@ dependencies = [
 dev = [
     "hatch",
     "pytest",
+    "pytest-cov",
 ]
 
 [project.urls]
@@ -65,3 +66,15 @@ only-include = ["sphinxfeed.py"]
 
 [tool.hatch.build]
 dev-mode-dirs = ["."]
+
+# Coverage report config: by default, show condensed terminal output
+[tool.coverage.run]
+branch = true
+source = ['.']
+omit = ['tests/*', 'tasks.py']
+
+[tool.coverage.html]
+directory = 'test-reports'
+
+[tool.pytest.ini_options]
+addopts = "--cov --cov-report=term"

tests/conftest.py

@@ -0,0 +1,39 @@
+"""Pytest config for testing with SphinxTestApp
+
+Notes on testing setup:
+* A Sphinx test app is provided via `app` fixture from `sphinx.testing.fixtures`.
+* The `sources` dir contains source files and config to use for tests
+    * Set via the `rootdir` fixture
+* A subdirectory to use for a specific test can be set by a pytest marker:
+    * `@pytest.mark.sphinx("html", testroot="...")
+    * This subdirectory must contain a conf.py and source files
+* The `outputs` dir contains expected output files
+* Test build output is located under `/tmp/pytest*`
+"""
+
+import shutil
+from pathlib import Path
+
+import pytest
+
+collect_ignore = ["sources", "outputs"]
+pytest_plugins = "sphinx.testing.fixtures"
+
+OUTPUT_DIR = Path(__file__).parent.resolve() / "outputs"
+SOURCE_DIR = Path(__file__).parent.resolve() / "sources"
+
+
+@pytest.fixture(scope="session")
+def rootdir():
+    """This fixture overrides the root directory used by SphinxTestApp. Also patches in a
+    Path.copytree() method for compatibility with sphinx.testing.path.path in older Sphinx versions.
+    """
+
+    class PatchedPath(type(Path())):
+        def __new__(cls, *args):
+            return super().__new__(cls, *args)
+
+        def copytree(src, dest):
+            shutil.copytree(src, dest, symlinks=True)
+
+    yield PatchedPath(SOURCE_DIR)