feat: remove outdated options (#590)

* feat: remove outdated options

* check more overlaps

Author: AlexanderLanin

src/extensions/score_metamodel/metamodel.yaml

@@ -262,8 +262,6 @@ needs_types:
       # req-Id: tool_req__docs_common_attr_security
       security: ^(YES|NO)$
     optional_options:
-      codelink: ^.*$
-      testlink: ^.*$
       # req-Id: tool_req__docs_req_attr_reqcov
       reqcovered: ^(YES|NO)$
       # req-Id: tool_req__docs_req_attr_testcov
@@ -296,8 +294,6 @@ needs_types:
       # req-Id: tool_req__docs_req_link_satisfies_allowed
       satisfies: stkh_req
     optional_options:
-      codelink: ^.*$
-      testlink: ^.*$
       # req-Id: tool_req__docs_req_attr_reqcov
       reqcovered: ^(YES|NO)$
       # req-Id: tool_req__docs_req_attr_testcov
@@ -334,8 +330,6 @@ needs_types:
       satisfies: feat_req
       belongs_to: comp
     optional_options:
-      codelink: ^.*$
-      testlink: ^.*$
       # req-Id: tool_req__docs_req_attr_reqcov
       reqcovered: ^(YES|NO)$
       # req-Id: tool_req__docs_req_attr_testcov
@@ -360,7 +354,6 @@ needs_types:
       # TODO: make it mandatory
       satisfies: gd_req, stkh_req, feat_req, comp_req
     optional_options:
-      codelink: ^.*$
       tags: ^.*$
       # req-Id: tool_req__docs_req_attr_reqcov
       reqcovered: ^(YES|NO)$
@@ -392,8 +385,6 @@ needs_types:
       # req-Id: tool_req__docs_common_attr_description
       content: ^[\s\S]+$
     optional_options:
-      codelink: ^.*$
-      testlink: ^.*$
       # req-Id: tool_req__docs_req_attr_reqcov
       reqcovered: ^(YES|NO)$
       # req-Id: tool_req__docs_req_attr_testcov

src/extensions/score_metamodel/yaml_parser.py

@@ -104,16 +104,43 @@ def _parse_need_type(
     global_base_opts: dict[str, Any],
 ):
     """Build a single ScoreNeedType dict from the metamodel entry, incl defaults."""
+
+    # Check for overlapping option names between mandatory / optional options / links
+    # and global_base_opts, as this would cause issues for usability.
+    mandatory_options = yaml_data.get("mandatory_options", {})
+    optional_options = yaml_data.get("optional_options", {})
+    mandatory_links = yaml_data.get("mandatory_links", {})
+    optional_links = yaml_data.get("optional_links", {})
+
+    overlap_checks: list[tuple[str, dict[str, Any], str, dict[str, Any]]] = [
+        ("mandatory_options", mandatory_options, "optional_options", optional_options),
+        ("mandatory_options", mandatory_options, "global_base_opts", global_base_opts),
+        ("optional_options", optional_options, "global_base_opts", global_base_opts),
+        ("mandatory_links", mandatory_links, "optional_links", optional_links),
+        ("mandatory_links", mandatory_links, "global_base_opts", global_base_opts),
+        ("optional_links", optional_links, "global_base_opts", global_base_opts),
+    ]
+    errors: list[str] = []
+    for a_name, a, b_name, b in overlap_checks:
+        if overlap := set(a.keys()) & set(b.keys()):
+            # FIXME: remove once "version" is clarified with process team
+            if overlap == {"version"}:
+                continue
+
+            errors.append(
+                f"Directive '{directive_name}': {a_name} and {b_name} overlap: {overlap}."
+            )
+
     t: ScoreNeedType = {
         "directive": directive_name,
         "title": yaml_data["title"],
         "prefix": yaml_data.get("prefix", f"{directive_name}__"),
         "tags": yaml_data.get("tags", []),
         "parts": yaml_data.get("parts", 3),
-        "mandatory_options": yaml_data.get("mandatory_options", {}),
-        "optional_options": yaml_data.get("optional_options", {}) | global_base_opts,
-        "mandatory_links": yaml_data.get("mandatory_links", {}),
-        "optional_links": yaml_data.get("optional_links", {}),
+        "mandatory_options": mandatory_options,
+        "optional_options": optional_options | global_base_opts,
+        "mandatory_links": mandatory_links,
+        "optional_links": optional_links,
     }
 
     # Ensure ID regex is set
@@ -126,7 +153,7 @@ def _parse_need_type(
     if "style" in yaml_data:
         t["style"] = yaml_data["style"]
 
-    return t
+    return t, errors
 
 
 def _parse_needs_types(
@@ -136,14 +163,21 @@ def _parse_needs_types(
     """Parse the 'needs_types' section of the metamodel.yaml."""
 
     needs_types: dict[str, ScoreNeedType] = {}
+    all_errors: list[str] = []
     for directive_name, directive_data in types_dict.items():
         assert isinstance(directive_name, str)
         assert isinstance(directive_data, dict)
 
-        needs_types[directive_name] = _parse_need_type(
+        needs_types[directive_name], parsing_errors = _parse_need_type(
             directive_name, directive_data, global_base_options_optional_opts
         )
+        all_errors.extend(parsing_errors)
 
+    if all_errors:
+        raise SystemExit(
+            "ERROR: Please resolve these overlaps in the metamodel.yaml to ensure proper functionality:\n"
+            + "\n".join(all_errors)
+        )
     return needs_types
 
 
@@ -207,7 +241,6 @@ def load_metamodel_data(yaml_path: Path | None = None) -> MetaModelData:
     )
 
     # Convert "types" from {directive_name: {...}, ...} to a list of dicts
-
     needs_types = _parse_needs_types(
         data.get("needs_types", {}), global_base_options_optional_opts
     )