Fix validity check to avoid breaking consumer requirements

Author: antonkri

src/extensions/score_metamodel/checks/check_options.py

@@ -291,12 +291,19 @@ def check_validity_consistency(
     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_values = _get_normalized(need, "valid_from")
+    valid_until_values = _get_normalized(need, "valid_until")
 
-    if not valid_from or not valid_until:
+    if valid_until_values and not valid_from_values:
+        log.warning_for_need(need, "is missing required attribute: `valid_from`.")
         return
 
+    if not valid_from_values or not valid_until_values:
+        return
+
+    valid_from = valid_from_values[0]
+    valid_until = valid_until_values[0]
+
     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,16 +263,14 @@ 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,47 @@ 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_requires_valid_from_if_valid_until_present():
+    logger = fake_check_logger()
+    app = Mock(spec=Sphinx)
+    need_1 = need(
+        id="stkh_req__001",
+        type="stkh_req",
+        valid_until="v1.0",
+    )
+
+    check_validity_consistency(app, need_1, cast(CheckLogger, logger))
+
+    logger.assert_warning("is missing required attribute: `valid_from`.")
+
+
+def test_validity_consistency_allows_missing_validity_pair():
+    logger = fake_check_logger()
+    app = Mock(spec=Sphinx)
+    need_1 = need(
+        id="stkh_req__001",
+        type="stkh_req",
+    )
+
+    check_validity_consistency(app, need_1, cast(CheckLogger, logger))
+
+    logger.assert_no_warnings()
+
+
+def test_validity_consistency_warns_on_invalid_range():
+    logger = fake_check_logger()
+    app = Mock(spec=Sphinx)
+    need_1 = need(
+        id="feat_req__001",
+        type="feat_req",
+        valid_from="v2.0",
+        valid_until="v1.0",
+    )
+
+    check_validity_consistency(app, need_1, cast(CheckLogger, logger))
+
+    logger.assert_warning(
+        "inconsistent validity: valid_from (v2.0) >= valid_until (v1.0)."
+    )