Add content check

Author: MaximilianSoerenPollak

src/extensions/score_metamodel/__init__.py

@@ -173,6 +173,8 @@ def load_metamodel_data():
         # Store mandatory_options and optional_options directly as a dict
         mandatory_options = directive_data.get("mandatory_options", {})
         one_type["mandatory_options"] = mandatory_options
+        tags = directive_data.get("tags", [])
+        one_type["tags"] = tags
 
         optional_options = directive_data.get("optional_options", {})
         optional_options.update(global_base_options_optional_opts)

src/extensions/score_metamodel/checks/check_options.py

@@ -12,6 +12,8 @@
 # *******************************************************************************
 import re
 from collections.abc import Generator
+from typing import cast
+from pprint import pprint
 
 from score_metamodel import (
     CheckLogger,
@@ -26,7 +28,7 @@
 CheckingDictType = dict[str, list[FieldCheck]]
 
 
-def get_need_type(needs_types: list[NeedType], directive: str):
+def get_need_type(needs_types: list[NeedType], directive: str)-> NeedType:
     for need_type in needs_types:
         assert isinstance(need_type, dict), need_type
         if need_type["directive"] == directive:
@@ -95,6 +97,21 @@ def remove_prefix(word: str, prefixes: list[str]) -> str:
                 )
 
 
+# req-Id: tool_req__docs_common_attr_description
+@local_check
+def check_content(
+    app: Sphinx,
+    need: NeedsInfoType,
+    log: CheckLogger,
+):
+
+    need_options = get_need_type(app.config.needs_types, need["type"])
+    if any(tag in need_options.get("tags", []) for tag in ["architecture_elements", "requirement"]):
+        # HINT: Seems that falsey evaluation of content fails without bool conversion.
+        if not bool(need["content"]):
+            msg = f"Need has no content. Content is mandatory for needs of type {need['type']}"
+            log.warning_for_need(need, msg)
+
 # req-#id: gd_req__req__attr_type
 # req-#id: gd_req__requirements_attr_security
 # req-#id: gd_req__req__attr_safety

src/extensions/score_metamodel/metamodel.yaml

@@ -73,6 +73,8 @@ needs_types:
       status: ^(valid)$
     optional_links:
       links: ^.*$
+    tags:
+      - requirement
 
   std_wp:
     title: Standard Work Product
@@ -111,6 +113,8 @@ needs_types:
       complies: ^std_req__(iso26262|isosae21434|isopas8926|aspice_40)__.*$
       # req-Id: tool_req__docs_req_link_satisfies_allowed
       satisfies: ^wf__.*$
+    tags:
+      - requirement
 
   gd_temp:
     title: Process Template
@@ -229,6 +233,8 @@ needs_types:
       # req-Id: tool_req__docs_req_attr_testcov
       testcovered: ^(YES|NO)$
       hash: ^.*$
+    tags:
+      - requirement
 
   # req-Id: tool_req__docs_req_types
   feat_req:
@@ -253,6 +259,8 @@ needs_types:
       # req-Id: tool_req__docs_req_attr_testcov
       testcovered: ^(YES|NO)$
       hash: ^.*$
+    tags:
+      - requirement
 
   # req-Id: tool_req__docs_req_types
   comp_req:
@@ -276,6 +284,8 @@ needs_types:
       # req-Id: tool_req__docs_req_attr_testcov
       testcovered: ^(YES|NO)$
       hash: ^.*$
+    tags:
+      - requirement
 
   # req-Id: tool_req__docs_req_types
   tool_req:
@@ -303,6 +313,8 @@ needs_types:
       implemented: ^(YES|PARTIAL|NO)$
       parent_covered: ^.*$
       parent_has_problem: ^.*$
+    tags:
+      - requirement
 
   # req-Id: tool_req__docs_req_types
   aou_req:
@@ -325,6 +337,8 @@ needs_types:
       hash: ^.*$
     optional_links:
       mitigates: ^.*$
+    tags:
+      - requirement
 
 
   # Architecture
@@ -342,6 +356,8 @@ needs_types:
       includes: ^logic_arc_int(_op)*__.+$
     optional_links:
       fulfils: ^feat_req__.+$
+    tags:
+      - architecture_element
 
   feat_arc_dyn:
     title: Feature Architecture Dynamic View
@@ -369,6 +385,8 @@ needs_types:
     optional_links:
       includes: ^logic_arc_int_op__.+$
       fulfils: ^comp_req__.+$
+    tags:
+      - architecture_element
 
   logic_arc_int_op:
     title: Logical Architecture Interface Operation
@@ -416,6 +434,8 @@ needs_types:
       includes: ^comp_arc_sta__.+$
       uses: ^real_arc_int(_op)*__.+$
       fulfils: ^comp_req__.+$
+    tags:
+      - architecture_element
 
   comp_arc_dyn:
     title: Component Architecture Dynamic View
@@ -429,6 +449,8 @@ needs_types:
       status: ^(valid|invalid)$
     optional_links:
       fulfils: ^comp_req__.+$
+    tags:
+      - architecture_element
 
   real_arc_int:
     title: Component Architecture Interfaces
@@ -443,6 +465,8 @@ needs_types:
       language: ^(cpp|rust)$
     optional_links:
       fulfils: ^comp_req__.+$
+    tags:
+      - architecture_element
 
   real_arc_int_op:
     title: Component Architecture Interface Operation
@@ -458,6 +482,8 @@ needs_types:
       included_by: ^real_arc_int__.+$
     optional_links:
       implements: ^logic_arc_int_op__.+$
+    tags:
+      - architecture_element
 
   review_header:
     prefix: review__header