Merge pull request #17 from SMI-Lab-Inha/citation-version-guard

Guard CITATION.cff version against drift

Author: SMI-Lab-Inha

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to `pyIECWind` will be documented in this file.
 
 The format is inspired by Keep a Changelog, adapted to the needs of this project.
 
+## [Unreleased]
+
+### Added
+
+- A version-consistency guard: the test suite now fails if `CITATION.cff`'s
+  `version` drifts from the installed package version, and checks that its
+  `date-released` is a valid ISO (`YYYY-MM-DD`) date. The citation metadata is
+  hand-maintained, so this prevents it from silently falling behind a release.
+
 ## [0.2.0] - 2026-05-22
 
 Input-contract and CLI hardening. No changes to the numeric `.wnd` output of any

tests/test_version.py

@@ -1,13 +1,29 @@
 from __future__ import annotations
 
+import re
 import unittest
+from datetime import date
 from importlib.metadata import version
 from pathlib import Path
 
 import pyiecwind
 from pyiecwind import VERSION, models
 
 
+def _cff_field(name: str) -> str:
+    """Return the value of a top-level scalar field in CITATION.cff.
+
+    Parsed with a regex so the test needs no YAML dependency; the file is a flat
+    list of ``key: value`` pairs, so this is sufficient and dependency-free.
+    """
+
+    root = Path(__file__).resolve().parents[1]
+    text = (root / "CITATION.cff").read_text(encoding="utf-8")
+    match = re.search(rf"^{re.escape(name)}:\s*(.+?)\s*$", text, re.MULTILINE)
+    assert match is not None, f"CITATION.cff is missing a '{name}' field"
+    return match.group(1).strip().strip('"').strip("'")
+
+
 class VersionTests(unittest.TestCase):
     """Guard against the historical drift where models.py hardcoded a version
     (1.0.0) different from the one declared in pyproject.toml (0.1.0)."""
@@ -31,6 +47,18 @@ def test_pyproject_version_matches_installed_metadata(self) -> None:
         data = tomllib.loads((root / "pyproject.toml").read_text(encoding="utf-8"))
         self.assertEqual(data["project"]["version"], version("pyiecwind"))
 
+    def test_citation_version_matches_installed_metadata(self) -> None:
+        # CITATION.cff is hand-maintained YAML, not single-sourced like the
+        # package version; this guard fails the build if it drifts behind a release.
+        self.assertEqual(_cff_field("version"), version("pyiecwind"))
+
+    def test_citation_release_date_is_iso(self) -> None:
+        released = _cff_field("date-released")
+        try:
+            date.fromisoformat(released)
+        except ValueError:
+            self.fail(f"CITATION.cff date-released {released!r} is not an ISO YYYY-MM-DD date")
+
 
 if __name__ == "__main__":
     unittest.main()