Require and normalize valid_from in validity consistency check

Author: antonkri

src/extensions/score_metamodel/checks/check_options.py

@@ -278,6 +278,16 @@ def parse_milestone(value: str) -> tuple[int, int, int]:
     return (major, minor, patch)
 
 
+def _normalize_validity_attr(value: object | None) -> str | None:
+    """Normalize validity attributes and treat whitespace-only values as missing."""
+    if value is None:
+        return None
+    if isinstance(value, str):
+        normalized = value.strip()
+        return normalized if normalized else None
+    return str(value)
+
+
 # req-Id: tool_req__docs_req_attr_validity_consistency
 @local_check
 def check_validity_consistency(
@@ -286,17 +296,24 @@ def check_validity_consistency(
     log: CheckLogger,
 ):
     """
-    Check if the attributes valid_from < valid_until.
+    Check if the attributes valid_from and valid_until are set and valid_from < valid_until.
     """
     if need["type"] not in ("stkh_req", "feat_req"):
         return
 
-    valid_from = need.get("valid_from", None)
-    valid_until = need.get("valid_until", None)
+    valid_from = _normalize_validity_attr(need.get("valid_from", None))
+    valid_until = _normalize_validity_attr(need.get("valid_until", None))
+
+    # Temporary grace period: only enforce presence of valid_from as non-fatal info.
+    if not valid_from:
+        msg = "missing validity attribute: valid_from must be set."
+        log.warning_for_need(need, msg, is_new_check=True)
+        return
 
-    if not valid_from or not valid_until:
+    if not valid_until:
         return
 
+    # Both attributes are present, check consistency
     valid_from_version = parse_milestone(valid_from)
     valid_until_version = parse_milestone(valid_until)
     if valid_from_version >= valid_until_version:

src/extensions/score_metamodel/metamodel.yaml

@@ -263,14 +263,16 @@ needs_types:
       rationale: ^.+$
       # req-Id: tool_req__docs_common_attr_security
       security: ^(YES|NO)$
+      # req-Id: tool_req__docs_req_attr_validity_correctness
+      valid_from: ^v(0|[1-9]\d*)\.(0|[1-9]\d*)(\.(0|[1-9]\d*))?$
     optional_options:
       # req-Id: tool_req__docs_req_attr_reqcov
       reqcovered: ^(YES|NO)$
       # req-Id: tool_req__docs_req_attr_testcov
       testcovered: ^(YES|NO)$
       hash: ^.*$
       # req-Id: tool_req__docs_req_attr_validity_correctness
-      valid_from: ^v(0|[1-9]\d*)\.(0|[1-9]\d*)(\.(0|[1-9]\d*))?$
+      # valid_from: ^v(0|[1-9]\d*)\.(0|[1-9]\d*)(\.(0|[1-9]\d*))?$
       valid_until: ^v(0|[1-9]\d*)\.(0|[1-9]\d*)(\.(0|[1-9]\d*))?$
     tags:
       - requirement

src/extensions/score_metamodel/tests/test_check_options.py

@@ -20,6 +20,7 @@
 from score_metamodel.checks.check_options import (
     check_extra_options,
     check_options,
+    check_validity_consistency,
     parse_milestone,
 )
 from score_metamodel.tests import fake_check_logger, need
@@ -128,3 +129,43 @@ def test_milestone_parsing():
     assert parse_milestone("v0.5") == (0, 5, 0)
     assert parse_milestone("v1.0") == (1, 0, 0)
     assert parse_milestone("v1.0.1") == (1, 0, 1)
+
+
+def test_validity_consistency_infos_for_empty_valid_from() -> None:
+    test_need = need(
+        id="feat_req__id_1",
+        type="feat_req",
+        valid_from="",
+        valid_until="v1.0",
+    )
+    logger = fake_check_logger()
+    app = Mock(spec=Sphinx)
+
+    check_validity_consistency(app, test_need, cast(CheckLogger, logger))
+
+    assert logger.warnings == 0
+    logger.flush_new_checks()
+    logger.assert_info(
+        "missing validity attribute: valid_from must be set.",
+        expect_location=False,
+    )
+
+
+def test_validity_consistency_infos_for_whitespace_valid_from() -> None:
+    test_need = need(
+        id="feat_req__id_2",
+        type="feat_req",
+        valid_from="   ",
+        valid_until="v1.0",
+    )
+    logger = fake_check_logger()
+    app = Mock(spec=Sphinx)
+
+    check_validity_consistency(app, test_need, cast(CheckLogger, logger))
+
+    assert logger.warnings == 0
+    logger.flush_new_checks()
+    logger.assert_info(
+        "missing validity attribute: valid_from must be set.",
+        expect_location=False,
+    )