test: cover template discovery metadata

Author: HzaCode

docs/templates.rst

@@ -35,6 +35,18 @@ Built-in templates are located in the ``onecite/templates/`` directory:
 - ``software.yaml``
 - ``dataset.yaml``
 
+Inspecting Templates from the CLI
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Use ``onecite templates`` to list the bundled fallback BibTeX templates and
+their required / optional fields::
+
+    onecite templates
+
+Use JSON output when another tool needs to inspect the same metadata::
+
+    onecite templates --json
+
 What Templates Actually Do
 ---------------------------
 

onecite/core.py

@@ -103,7 +103,7 @@ def load_template(self, template_name: str) -> Dict[str, Any]:
             return self._get_default_template()
 
     def list_templates(self) -> List[Dict[str, Any]]:
-        """Return metadata for the built-in YAML templates.
+        """Return metadata for the configured YAML template directory.
 
         Returns:
             A list of dictionaries sorted by template name. Each item

tests/test_templates.py

@@ -6,9 +6,38 @@
 here; users can add custom ones at runtime.
 """
 
+from onecite.core import TemplateLoader
+
 
 class TestTemplates:
 
+    def test_list_templates_schema(self):
+        templates = TemplateLoader().list_templates()
+        names = [template["name"] for template in templates]
+
+        assert names == sorted(names)
+        assert "journal_article_full" in names
+
+        journal_template = next(
+            template
+            for template in templates
+            if template["name"] == "journal_article_full"
+        )
+        assert set(journal_template) == {
+            "name",
+            "entry_type",
+            "required_fields",
+            "optional_fields",
+        }
+        assert journal_template["entry_type"] == "@article"
+        assert journal_template["required_fields"] == [
+            "author",
+            "title",
+            "journal",
+            "year",
+        ]
+        assert "abstract" in journal_template["optional_fields"]
+
     def test_default_template(self, sample_references, run_onecite_process):
         """journal_article_full is the default when no --template is given."""
         code, out, err, _ = run_onecite_process(sample_references["doi_only"])