feat: add a framework property to capture the CaC profile id

pyproject.toml

@@ -24,7 +24,7 @@ trestlebot = "trestlebot.cli.root:root_cmd"
 [tool.poetry.dependencies]
 python = '^3.8.1'
 gitpython = "^3.1.41"
-compliance-trestle = "^3.5.0"
+compliance-trestle = "^3.7.0"
 github3-py = "^4.0.1"
 python-gitlab = "^4.2.0"
 ruamel-yaml = "^0.18.5"

tests/trestlebot/cli/test_create_cmd.py

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright (c) 2024 Red Hat, Inc.
 
-""" Unit test for create commands ssp and cd"""
+"""Unit test for create commands ssp and cd"""
 import pathlib
 from typing import Tuple
 

tests/trestlebot/cli/test_sync_cac_content_cmd.py

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright (c) 2024 Red Hat, Inc.
 
-""" Unit test for sync-cac-content command"""
+"""Unit test for sync-cac-content command"""
 import pathlib
 from typing import Any, Generator, Tuple
 
@@ -306,6 +306,11 @@ def test_sync_product(tmp_repo: Tuple[str, Repo]) -> None:
     # Check control_implementations are attached
     ci = component.control_implementations[0]
     assert ci.source == "trestle://profiles/simplified_nist_profile/profile.json"
+
+    assert len(ci.props) == 1
+    assert ci.props[0].name == "Framework_Short_Name"
+    assert ci.props[0].value == "example"
+
     set_parameters = ci.set_parameters
     assert len(set_parameters) == 2
     set_params_ids = []

trestlebot/cli/commands/autosync.py

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright (c) 2024 Red Hat, Inc.
 
-""" Autosync command"""
+"""Autosync command"""
 
 import logging
 import sys

trestlebot/cli/commands/init.py

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright (c) 2024 Red Hat, Inc.
 
-""""
+"""
 Module for Trestle-bot init command
 """
 import argparse

trestlebot/cli/commands/version.py

@@ -1,4 +1,4 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright (c) 2024 Red Hat, Inc.
 
-""" Version command """
+"""Version command"""

trestlebot/const.py

@@ -56,3 +56,10 @@
 # Trestlebot init constants
 TRESTLEBOT_CONFIG_DIR = ".trestlebot"
 TRESTLEBOT_KEEP_FILE = ".keep"
+
+# Props
+
+# TODO(jpower432): Propose upstream as to be populated
+# by the profile or catalog "name" based on trestle workspace
+# conventions.
+FRAMEWORK_SHORT_NAME = "Framework_Short_Name"

trestlebot/tasks/sync_cac_content_profile_task.py

@@ -145,7 +145,7 @@ def create_oscal_profile(
             self.oscal_catalog, name_update, resolved_controls
         )
         if not written:
-            logger.info(f"No updated for profile {name_update}")
+            logger.info(f"No update for profile {name_update}")
 
     def execute(self) -> int:
         # calling to get_control_ids _by_level and checking for valid control file name

trestlebot/tasks/sync_cac_content_task.py

@@ -14,7 +14,12 @@
 from ssg.products import load_product_yaml, product_yaml_path
 from ssg.profiles import _load_yaml_profile_file, get_profiles_from_products
 from trestle.common.common_types import TypeWithProps
-from trestle.common.const import IMPLEMENTATION_STATUS, REPLACE_ME, TRESTLE_HREF_HEADING
+from trestle.common.const import (
+    IMPLEMENTATION_STATUS,
+    REPLACE_ME,
+    TRESTLE_GENERIC_NS,
+    TRESTLE_HREF_HEADING,
+)
 from trestle.common.list_utils import as_list, none_if_empty
 from trestle.common.model_utils import ModelUtils
 from trestle.core.generators import generate_sample_model
@@ -107,6 +112,8 @@ def __init__(
         self.controls: List[Control] = list()
         self.rules_by_id: Dict[str, RuleInfo] = dict()
 
+        self.cac_profile_id = os.path.basename(cac_profile).split(".profile")[0]
+
         self.profile_href: str = ""
         self.profile_path: str = ""
         self.catalog_helper = CatalogControlResolver()
@@ -116,9 +123,8 @@ def __init__(
     def _collect_rules(self) -> None:
         """Collect all rules from the product profile."""
         profiles = get_profiles_from_products(self.cac_content_root, [self.product])
-        cac_profile_id = os.path.basename(self.cac_profile).split(".profile")[0]
         for profile in profiles:
-            if profile.profile_id == cac_profile_id:
+            if profile.profile_id == self.cac_profile_id:
                 self.rules = profile.rules
                 break
 
@@ -376,6 +382,16 @@ def _create_control_implementation(self) -> ControlImplementation:
                 all_implement_reqs.append(implemented_req)
         ci.implemented_requirements = all_implement_reqs
         self._add_set_parameters(ci)
+
+        # Add framework prop for complytime consumption. This should be the
+        # orginating CaC profile name.
+        ci.props = as_list(ci.props)
+        frameworkProp = generate_sample_model(Property)
+        frameworkProp.name = const.FRAMEWORK_SHORT_NAME
+        frameworkProp.value = self.cac_profile_id
+        frameworkProp.ns = TRESTLE_GENERIC_NS
+        ci.props.append(frameworkProp)
+
         return ci
 
     def _add_control_implementations(

trestlebot/transformers/trestle_rule.py

@@ -130,7 +130,7 @@ def get_default_rule() -> TrestleRule:
 
 # Adapted from https://docs.pydantic.dev/latest/errors/errors/
 def location_to_dot_separation(
-    location: Tuple[Union[str, int], ...]
+    location: Tuple[Union[str, int], ...],
 ) -> str:  # pragma: no cover
     """Convert a tuple of strings and integers to a dot separated string."""
     path: str = ""