feat: Add smoke tests for data template and define directives

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sphinx-notes/cookiecutter",
-  "commit": "634c4022e575bd086ea47f3b42feafe24e14a939",
+  "commit": "62cd96195962da3392cdc34125c95e9144a5f5ca",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -20,7 +20,7 @@
       "sphinx_version": "7.0",
       "development_status": "3 - Alpha",
       "_template": "https://github.com/sphinx-notes/cookiecutter",
-      "_commit": "634c4022e575bd086ea47f3b42feafe24e14a939"
+      "_commit": "62cd96195962da3392cdc34125c95e9144a5f5ca"
     }
   },
   "directory": null

.github/workflows/test.yml

@@ -12,5 +12,14 @@ jobs:
     - uses: actions/setup-python@v5
       with:
         python-version-file: 'pyproject.toml'
-    - run: python3 -m pip install .[dev]
+    - run: python3 -m pip install .[test]
     - run: make test
+  doctest:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v5
+      with:
+        python-version-file: 'pyproject.toml'
+    - run: python3 -m pip install .[docs]
+    - run: make doctest

Makefile

@@ -27,7 +27,11 @@ fmt:
 
 .PHONY: test
 test:
-	$(PY) -m unittest discover -s tests -v
+	$(PY) -m pytest tests/ -v
+
+.PHONY: doctest
+doctest:
+	$(MAKE) doctest -C docs/
 
 ################################################################################
 # Distribution Package

docs/conf.py

@@ -23,6 +23,7 @@
 # ones.
 extensions = [
     'sphinx.ext.githubpages',
+    'sphinx.ext.doctest',
     'sphinx_design',
     'sphinx_copybutton',
     'sphinx_last_updated_by_git',

tests/conftest.py

@@ -0,0 +1,8 @@
+from pathlib import Path
+import pytest
+
+pytest_plugins = 'sphinx.testing.fixtures'
+
+@pytest.fixture(scope='session')
+def rootdir() -> Path:
+    return Path(__file__).parent / 'roots'

tests/roots/test-smoke/conf.py

@@ -0,0 +1 @@
+extensions = ['sphinxnotes.data']

tests/roots/test-smoke/index.rst

@@ -0,0 +1,15 @@
+Smoke Test
+==========
+
+.. data:template::
+
+   Name: **{{ name }}**
+   {% for k, v in attrs.items() %}
+   {{ k }}: {{ v }}
+   {% endfor %}
+
+.. data:define:: Test User
+   :homepage: https://example.com/
+   :email: test@example.com
+
+   This is a test user.

tests/test_always_pass.py

@@ -0,0 +1,9 @@
+# This file is generated from sphinx-notes/cookiecutter.
+# DO NOT EDIT.
+
+import unittest
+
+
+class TestAlwaysPass(unittest.TestCase):
+    def test_dummy(self):
+        self.assertTrue(True)

tests/test_smoke.py

@@ -0,0 +1,27 @@
+"""Smoke tests for sphinxnotes.data extension."""
+
+import pytest
+
+PHASES = ['parsing', 'parsed', 'resolving']
+
+
+@pytest.mark.sphinx('html', testroot='smoke')
+@pytest.mark.parametrize('phase', PHASES)
+def test_data_template_and_define(app, status, warning, phase):
+    """Test that data:template and data:define directives work correctly."""
+    index_path = app.srcdir / 'index.rst'
+    content = index_path.read_text(encoding='utf-8')
+    modified_content = content.replace(
+        '.. data:template::',
+        f'.. data:template::\n   :on: {phase}',
+        1,
+    )
+    index_path.write_text(modified_content, encoding='utf-8')
+
+    app.build()
+
+    html = (app.outdir / 'index.html').read_text(encoding='utf-8')
+
+    assert 'Test User' in html
+    assert 'https://example.com/' in html
+    assert 'test%40example.com' in html