Skip to content

catalog_interface

trestle.core.catalog_interface ¤

Provide interface to catalog allowing queries and operations at control level.

logger ¤

Classes¤

CatalogInterface ¤

Interface to query and modify catalog contents.

The catalog is contained in two separate forms: As an actual OSCAL catalog, and as a separate dict providing direct lookup of a control by id.

The two representations should be converted as needed using provided routines: dict -> cat: update_catalog_controls cat -> dict: _create_control_dict

In normal use the dict is created by the CatalogInterface constructor, changes are then made to controls in the dict, then the catalog controls are updated by pulling from the dict back into the catalog.

This class does no direct file i/o. i/o is performed via ControlIO.

Source code in trestle/core/catalog_interface.py
class CatalogInterface():
    """
    Interface to query and modify catalog contents.

    The catalog is contained in two separate forms:  As an actual OSCAL catalog,
    and as a separate dict providing direct lookup of a control by id.

    The two representations should be converted as needed using provided routines:
    dict -> cat: update_catalog_controls
    cat -> dict: _create_control_dict

    In normal use the dict is created by the CatalogInterface constructor,
    changes are then made to controls in the dict,
    then the catalog controls are updated by pulling from the dict back into the catalog.

    This class does no direct file i/o.  i/o is performed via ControlIO.
    """

    @dataclass
    class ControlHandle:
        """Convenience class for handling controls as members of a group.

        group_id: id of parent group or '' if not in a group
        group_title: title of the group
        group_class: class of the group
        path: path of parent groups leading to this control - without the final control_id, or [''] if in cat list
        control: the control itself
        """

        group_id: str
        group_title: Optional[str]
        group_class: Optional[str]
        group_path: List[str]
        control_path: List[str]
        control: cat.Control

    def __init__(self, catalog: Optional[cat.Catalog] = None) -> None:
        """Initialize the interface with the catalog."""
        self._catalog = catalog
        self._param_control_map: Dict[str, str] = {}
        self._generate_group_index: int = 0
        self._control_dict = self._create_control_dict() if catalog else None
        self.loose_param_dict: Dict[str, common.Parameter] = {param.id: param
                                                              for param in as_list(catalog.params)} if catalog else {}

    def _generate_group_id(self, group: cat.Group) -> str:
        """Generate sequential group ids."""
        group_id = f'trestle_group_{self._generate_group_index:04d}'
        self._generate_group_index += 1
        logger.warning(f'Group titled "{group.title}" has no id and has been assigned id: {group_id}')
        return group_id

    def _add_params_to_map(self, control: cat.Control) -> None:
        # this does not need to recurse because it is called for each control in the catalog
        for param in as_list(control.params):
            if param.id in self._param_control_map:
                logger.warning(
                    f'Duplicate param id {param.id} in control {control.id} and {self._param_control_map[param.id]}.'
                )
            self._param_control_map[param.id] = control.id

    def _add_sub_controls(
        self, control_handle: ControlHandle, control_dict: Dict[str, ControlHandle], path: List[str]
    ) -> None:
        """
        Get all controls contained in this control and add it to the growing control dict.

        Add all its sub-controls to the dict recursively.
        The path does not change because only groups are in the path, and controls cannot contain groups.
        """
        if control_handle.control.controls:
            group_id = control_handle.group_id
            group_title = control_handle.group_title
            group_class = control_handle.group_class
            group_path = control_handle.group_path
            control_path = path[:]
            control_path.append(control_handle.control.id)
            for sub_control in control_handle.control.controls:
                control_handle = CatalogInterface.ControlHandle(
                    group_id=group_id,
                    group_title=group_title,
                    group_class=group_class,
                    group_path=group_path,
                    control_path=control_path,
                    control=sub_control
                )
                control_dict[sub_control.id] = control_handle
                self._add_sub_controls(control_handle, control_dict, control_path)

    def _add_group_controls(self, group: cat.Group, control_dict: Dict[str, ControlHandle], path: List[str]) -> None:
        """Add all controls in the group recursively, including sub groups and sub controls."""
        group.id = self._generate_group_id(group) if group.id is None else group.id
        if group.controls is not None:
            group_path = path[:]
            if not group_path or group_path[-1] != group.id:
                group_path.append(group.id)
            for control in group.controls:
                control_handle = CatalogInterface.ControlHandle(
                    group_id=group.id,
                    group_title=group.title,
                    group_class=group.class_,
                    control=control,
                    group_path=group_path,
                    control_path=group_path
                )
                control_dict[control.id] = control_handle
                self._add_sub_controls(control_handle, control_dict, group_path)
        if group.groups is not None:
            group_path = path[:]
            group_path.append(group.id)
            for sub_group in group.groups:
                new_path = group_path[:]
                sub_group.id = self._generate_group_id(sub_group) if sub_group.id is None else sub_group.id
                new_path.append(sub_group.id)
                self._add_group_controls(sub_group, control_dict, new_path)

    def _create_control_dict(self) -> Dict[str, ControlHandle]:
        control_dict: Dict[str, CatalogInterface.ControlHandle] = {}
        # add controls by group
        if self._catalog.groups is not None:
            for group in self._catalog.groups:
                self._add_group_controls(group, control_dict, [])
        # now add controls not in a group, if any
        if self._catalog.controls is not None:
            group_path = ['']
            for control in self._catalog.controls:
                control_handle = CatalogInterface.ControlHandle(
                    group_id='',
                    group_title='',
                    group_class=const.MODEL_TYPE_CATALOG,
                    control=control,
                    group_path=group_path,
                    control_path=group_path
                )
                control_dict[control.id] = control_handle
                self._add_sub_controls(control_handle, control_dict, group_path)
        for handle in control_dict.values():
            self._add_params_to_map(handle.control)
        return control_dict

    @staticmethod
    def _get_all_controls_in_list(controls: List[cat.Control], recurse: bool) -> List[cat.Control]:
        """Get all controls in a list with optional recursion for sub controls."""
        new_list: List[cat.Control] = []
        for control in controls:
            new_list.append(control)
            if recurse and control.controls:
                new_list.extend(CatalogInterface._get_all_controls_in_list(control.controls, recurse))
        return new_list

    @staticmethod
    def _get_all_controls_in_group(group: cat.Group, recurse: bool) -> List[cat.Control]:
        """
        Create a list of all controls in this group.

        recurse specifies to recurse within controls, but groups are always recursed
        """
        controls: List[cat.Control] = []
        if group.controls:
            controls.extend(CatalogInterface._get_all_controls_in_list(group.controls, recurse))
        for sub_group in as_list(group.groups):
            if sub_group.controls:
                controls.extend(CatalogInterface._get_all_controls_in_group(sub_group, recurse))
        return controls

    def get_sorted_controls_in_group(self, group_id: str) -> List[cat.Control]:
        """Get the list of controls in a group sorted by the control sort-id."""
        controls: List[cat.Control] = []
        for control in self.get_all_controls_from_dict():
            grp_id, _, _ = self.get_group_info_by_control(control.id)
            if grp_id == group_id:
                controls.append(control)
        return sorted(controls, key=lambda control: ControlInterface.get_sort_id(control))

    def get_dependent_control_ids(self, control_id: str) -> List[str]:
        """Find all child ids of this control from the dict with recursion."""
        children: List[str] = []
        control = self.get_control(control_id)
        if control:
            new_controls = self._get_all_controls_in_list(as_list(control.controls), True)
            children.extend([con.id for con in new_controls])
        return children

    def get_control_ids(self) -> List[str]:
        """Get all control ids from the control dict."""
        return self._control_dict.keys()

    def get_control(self, control_id: str) -> Optional[cat.Control]:
        """Get control from the control dict with this id."""
        return None if control_id not in self._control_dict else self._control_dict[control_id].control

    @staticmethod
    def get_control_ids_from_catalog(catalog: cat.Catalog) -> List[str]:
        """
        Get all control ids from a catalog.

        This is intended to provide a quick list of all controls in a catalog without the expense of building the
        control dict.  So, if repeated queries are made into a catalog, it is worth instantiating a CatalogInterface
        and associated control dict.  Otherwise just use this to get a list of all controls.

        This function is needed within the CatalogInterface in order to determine if new controls have been added
        to the dict and need to be inserted in the actual catalog during update.
        """
        controls = CatalogInterface._get_all_controls_in_list(as_list(catalog.controls), True)
        id_list = [control.id for control in controls]
        for group in as_list(catalog.groups):
            controls = CatalogInterface._get_all_controls_in_group(group, True)
            id_list.extend([control.id for control in as_list(controls)])
        return id_list

    def get_control_by_param_id(self, param_id: str) -> Optional[cat.Control]:
        """Get control from catalog that has this param id using the dict."""
        if param_id in self._param_control_map:
            return self.get_control(self._param_control_map[param_id])
        return None

    def get_control_id_and_status(self, control_name: str) -> Tuple[str, str]:
        """
        Get the control id and status using the control name.

        Returns empty string if status not found.
        """
        for control in self.get_all_controls_from_dict():
            if ControlInterface.get_label(control).strip().lower() == control_name.strip().lower():
                status = ControlInterface.get_prop(control, 'status')
                return control.id, status
        return '', ''

    def get_catalog_title(self) -> str:
        """Get the title of the catalog."""
        return self._catalog.metadata.title

    def get_statement_part_id_map(self, label_as_key: bool) -> Dict[str, Dict[str, str]]:
        """Create mapping of label to part_id for top level parts in statement of all controls."""
        id_map = {}
        for control in self.get_all_controls_from_catalog(True):
            statement_part = get_item_from_list(control.parts, const.STATEMENT, lambda p: p.name)
            if statement_part:
                id_dict: Dict[str, str] = {}
                for sub_part in as_list(statement_part.parts):
                    label = ControlInterface.get_label(sub_part)
                    if label_as_key:
                        id_dict[label] = sub_part.id
                    else:
                        id_dict[sub_part.id] = label
                if id_dict:
                    id_map[control.id] = id_dict
        return id_map

    @staticmethod
    def _get_statement_sub_parts(part: common.Part, indent: int) -> List[Dict[str, str]]:
        items = []
        # this may be '' if no label
        label = ControlInterface.get_label(part)
        prose = '' if part.prose is None else part.prose
        items.append({'indent': indent, 'label': label, 'prose': prose})
        for prt in as_filtered_list(part.parts, lambda p: p.name == 'item'):
            items.extend(CatalogInterface._get_statement_sub_parts(prt, indent + 1))
        return items

    def get_statement_parts(self, control_id: str) -> List[Dict[str, str]]:
        """Get list of statement parts as dicts with indentation, label and prose."""
        items = []
        control = self.get_control(control_id)

        # control may have no statement or parts
        # but if statement present it is first part
        if control is None:
            logger.warning(f'No control found for id {control_id}')
        elif control.parts:
            part = control.parts[0]
            if part.name == 'statement':
                items.extend(CatalogInterface._get_statement_sub_parts(part, 0))
            else:
                logger.warning(f'Control {control_id} has parts but first part name is {part.name} - not statement')
        return items

    def get_control_part_prose(self, control_id: str, part_name: str) -> str:
        """
        Get the prose for a named part in the control.

        Args:
            control_id: id of the control
            part_name: name of the part

        Returns:
            Single string concatenating prose from all parts and sub-parts in control with that name.
        """
        control = self.get_control(control_id)
        return ControlInterface.get_part_prose(control, part_name)

    def get_all_controls_from_catalog(self, recurse: bool) -> Iterator[cat.Control]:
        """
        Yield all controls from the actual catalog by group including optional sub controls.

        Args:
            recurse: Whether to recurse within controls, but groups are always recursed

        Returns:
            iterator of the controls in the catalog

        Notes:
            This follows the actual structure of the catalog and groups
        """
        if self._catalog.groups:
            for group in self._catalog.groups:
                controls = self._get_all_controls_in_group(group, recurse)
                for control in controls:
                    yield control
        if self._catalog.controls:
            cat_controls = self._get_all_controls_in_list(self._catalog.controls, recurse)
            for control in cat_controls:
                yield control

    def get_all_controls_from_dict(self) -> Iterator[cat.Control]:
        """Yield individual controls from the dict."""
        return [handle.control for handle in self._control_dict.values()]

    def get_count_of_controls_in_dict(self) -> int:
        """Find number of controls in the dict."""
        return len(self._control_dict.keys())

    def get_count_of_controls_in_catalog(self, recurse: bool) -> int:
        """Get count of controls from the actual catalog including optional sub controls."""
        return len(list(self.get_all_controls_from_catalog(recurse)))

    def get_group_ids(self) -> List[str]:
        """Get all the group id's as a list of sorted strings."""
        return sorted(filter(lambda id: id, list({control.group_id for control in self._control_dict.values()})))

    def get_all_groups_from_catalog(self) -> List[cat.Group]:
        """
        Retrieve all groups in the catalog sorted by group_id.

        This ignores controls that are direct children of the catalog.
        """
        groups: List[cat.Group] = []
        if self._catalog.groups:
            for my_group in self._catalog.groups:
                for res in CatalogInterface._get_groups_from_group(my_group):
                    groups.append(res)
        return sorted(groups, key=lambda group: group.id)

    def get_statement_label_if_exists(self, control_id: str,
                                      statement_id: str) -> Tuple[Optional[str], Optional[common.Part]]:
        """Get statement label if available."""

        def does_part_exists(part: common.Part) -> bool:
            does_match = False
            if part.name and part.name in {const.STATEMENT, 'item'} and part.id == statement_id:
                does_match = True
            return does_match

        control = self.get_control(control_id)
        if not control:
            return '', None
        label = None
        found_part = None
        if control.parts:
            for part in as_list(control.parts):
                # Performance OSCAL assumption, ids are nested so recurse only if prefix
                if part.id and statement_id.startswith(part.id):
                    part = self.find_part_with_condition(part, does_part_exists)
                    if part:
                        label = ControlInterface.get_label(part)
                        found_part = part
                        break

        return label, found_part

    def find_part_with_condition(self, part: common.Part, condition: Callable) -> Optional[common.Part]:
        """Traverse part and find subpart that satisfies given condition."""
        if condition(part):
            # Part that satisfies the condition is found.
            return part
        else:
            if part.parts:
                for subpart in part.parts:
                    found_part = self.find_part_with_condition(subpart, condition)
                    if found_part:
                        return found_part

        return None

    def delete_withdrawn_controls(self) -> None:
        """Delete all withdrawn controls from the catalog."""
        delete_list = []
        for control in self.get_all_controls_from_dict():
            if ControlInterface.is_withdrawn(control):
                delete_list.append(control.id)
        for id_ in delete_list:
            self.delete_control(id_)

    @staticmethod
    def _get_groups_from_group(group: cat.Group) -> Iterator[cat.Group]:
        yield group
        if group.groups:
            for new_group in group.groups:
                for res in CatalogInterface._get_groups_from_group(new_group):
                    yield res

    def get_group_info_by_control(self, control_id: str) -> Tuple[str, str, str]:
        """Get the group_id, title, class for this control from the dict."""
        return (
            self._control_dict[control_id].group_id,
            self._control_dict[control_id].group_title,
            self._control_dict[control_id].group_class
        )

    def get_control_path(self, control_id: str) -> List[str]:
        """Return the path into the markdown directory for this control based only on the groups."""
        return self._control_dict[control_id].group_path

    def get_full_control_path(self, control_id: str) -> List[str]:
        """Return the path to the control including groups and sub-controls."""
        return self._control_dict[control_id].control_path

    def replace_control(self, control: cat.Control) -> None:
        """
        Replace the control in the control_dict.

        This only replaces the parent control and not its children.
        """
        self._control_dict[control.id].control = control

    def delete_control(self, control_id: str) -> None:
        """
        Delete the control from the control_dict based on id.

        Delete all its dependent children also.
        """
        control = self.get_control(control_id)
        if control:
            for sub_control_id in self.get_dependent_control_ids(control.id):
                self._control_dict.pop(sub_control_id, None)
            self._control_dict.pop(control_id, None)

    def get_catalog(self, update=True) -> cat.Catalog:
        """Safe method to get catalog after forced update from catalog dict."""
        if update:
            self.update_catalog_controls()
        return self._catalog

    def _update_all_controls_in_list(self, controls: List[cat.Control]) -> List[cat.Control]:
        """
        Given a list of controls, create fresh list pulled from the control dict.

        Args:
            controls: a list of controls in the original catalog

        Returns:
            The new list of updated controls, possibly with some missing if they have been removed from the dict.
            Children are inserted as needed into parent controls.
        """
        new_list: List[cat.Control] = []
        for control in controls:
            # first update the control itself by getting it from the dict
            new_control = self.get_control(control.id)
            if new_control:
                # this overrides any sub controls in the control itself
                # any added sub-controls should add to the skipped list
                new_control.controls = self._update_all_controls_in_list(as_list(control.controls))
                new_control.controls = none_if_empty(new_control.controls)
                new_list.append(new_control)
        return new_list

    def _update_all_controls_in_group(self, group: cat.Group) -> None:
        """Given a group of controls, create fresh version pulled from the control dict."""
        group.controls = self._update_all_controls_in_list(as_list(group.controls))
        group.controls = none_if_empty(group.controls)
        new_groups: List[cat.Group] = []
        for sub_group in as_list(group.groups):
            self._update_all_controls_in_group(sub_group)
            new_groups.append(sub_group)
        group.groups = none_if_empty(new_groups)

    def _insert_control_in_catalog(self, control_handle: ControlHandle) -> None:
        """Insert the control into the catalog based on its path."""
        path = control_handle.group_path
        node = self._catalog
        if path[0] != '':
            for group_id in path:
                found_group = None
                for group in as_list(node.groups):
                    if group.id == group_id:
                        found_group = group
                        break
                if found_group:
                    node = found_group
                else:
                    raise TrestleError(f'No controls found in catalog for group {group.id}')
            node.title = control_handle.group_title
            node.class_ = control_handle.group_class
        node.controls = delete_item_from_list(
            as_list(node.controls), control_handle.control.id, lambda control: control.id
        )
        node.controls.append(control_handle.control)
        node.controls = none_if_empty(sorted(node.controls, key=lambda control: ControlInterface.get_sort_id(control)))

    def update_catalog_controls(self) -> None:
        """
        Update the actual catalog by pulling fresh controls from the dict.

        During assembly, controls may be added, but not children of controls.
        New groups may not be added.
        A control containing controls cannot be added.  Controls containing controls are only available if
        the parent catalog was loaded from json.
        """
        # first go through the catalog and pull existing controls from the dict
        for group in as_list(self._catalog.groups):
            self._update_all_controls_in_group(group)

        new_list = []
        for control in as_list(self._catalog.controls):
            new_control = self.get_control(control.id)
            new_control.controls = self._update_all_controls_in_list(as_list(control.controls))
            new_control.controls = none_if_empty(new_control.controls)
            new_list.append(new_control)
        self._catalog.controls = none_if_empty(new_list)

        # now add any new controls that are discovered in the dict
        ids_in_catalog = CatalogInterface.get_control_ids_from_catalog(self._catalog)
        for control_handle in self._control_dict.values():
            if control_handle.control.id not in ids_in_catalog:
                self._insert_control_in_catalog(control_handle)

        self._catalog.params = none_if_empty(list(self.loose_param_dict.values()))

    def _find_string_in_part(self, control_id: str, part: common.Part, seek_str: str) -> List[str]:
        hits: List[str] = []
        if part.prose:
            if part.prose.find(seek_str) >= 0:
                hits.append((control_id, part.prose))
        if part.parts:
            for sub_part in part.parts:
                hits.extend(self._find_string_in_part(control_id, sub_part, seek_str))
        return hits

    def find_string_in_control(self, control: cat.Control, seek_str: str) -> List[Tuple[str, str]]:
        """Find all instances of this string in prose of control."""
        hits: List[Tuple[str, str]] = []
        if control.parts:
            for part in control.parts:
                hits.extend(self._find_string_in_part(control.id, part, seek_str))
        return hits

    @staticmethod
    def _get_full_profile_param_dict(profile: Optional[prof.Profile]) -> Dict[str, common.Parameter]:
        """Get the full mapping of param_id to modified value for this profiles set_params."""
        set_param_dict: Dict[str, common.Parameter] = {}
        if profile and profile.modify:
            for set_param in as_list(profile.modify.set_parameters):
                param = ControlInterface.setparam_to_param(set_param.param_id, set_param)
                set_param_dict[set_param.param_id] = param
        return set_param_dict

    @staticmethod
    def _get_profile_param_dict(
        control: cat.Control, profile_param_dict: Dict[str, common.Parameter], values_only: bool
    ) -> Dict[str, common.Parameter]:
        """
        Get the dict of params for this control including possible overrides made by the profile modifications.

        Args:
            control: The control being queried
            profile_param_dict: The full dict of params and modified values made by the profile

        Returns:
            mapping of param ids to their final parameter states after possible modify by the profile setparameters
        """
        # get the mapping of param_id's to params for this control, excluding those with no value set
        param_dict = ControlInterface.get_control_param_dict(control, values_only)
        for key in param_dict.keys():
            if key in profile_param_dict:
                param_dict[key] = profile_param_dict[key]
        return param_dict

    def _get_full_param_dict(self) -> Dict[str, common.Parameter]:
        param_dict: Dict[str, common.Parameter] = {}
        # build the full mapping of params to values from the catalog interface
        for control in self.get_all_controls_from_dict():
            param_dict.update(ControlInterface.get_control_param_dict(control, False))
        return param_dict

    def _change_prose_with_param_values(self, param_format, param_rep, show_value_warnings: bool) -> None:
        """Go through all controls and change prose based on param values."""
        param_dict = self._get_full_param_dict()
        # insert param values into prose of all controls
        for control in self.get_all_controls_from_dict():
            ControlInterface.replace_control_prose(control, param_dict, param_format, param_rep, show_value_warnings)

    @staticmethod
    def _get_display_name_and_ns(param: common.Parameter) -> Tuple[Optional[str], Optional[str]]:
        for prop in as_list(param.props):
            if prop.name == const.DISPLAY_NAME:
                ns = str(prop.ns) if prop.ns else None
                return prop.value, ns
        return None, None

    def _write_control_into_dir(
        self,
        context: ControlContext,
        control: cat.Control,
        part_id_map: Dict[str, Dict[str, str]],
        found_control_alters: List[prof.Alter]
    ):
        # we need to create the dir structure on demand because we don't know a priori what groups are included
        _, group_title, _ = self.get_group_info_by_control(control.id)
        group_dir = context.md_root
        control_path = self.get_control_path(control.id)
        for sub_dir in control_path:
            group_dir = group_dir / sub_dir
            if not group_dir.exists():
                group_dir.mkdir(parents=True, exist_ok=True)

        writer = ControlWriter()
        writer.write_control_for_editing(context, control, group_dir, group_title, part_id_map, found_control_alters)

    @staticmethod
    def _get_all_rules_params_and_vals(context: ControlContext) -> None:
        """Get rules, params, vals from the control implementation and defined component."""
        # rules are defined in the control_imp itself
        # but they are linked to controls via the imp_reqs
        # param values may be set both by the control_imp and the imp_req
        context.rules_dict = {}
        context.rules_params_dict = {}
        context.rules_param_vals = {}
        current_component = ControlInterface.get_component_by_name(context.comp_def, context.comp_name)
        for item in [current_component, context.control_implementation]:
            context.rules_dict.update(ControlInterface.get_rules_dict_from_item(item))
            context.rules_params_dict.update(ControlInterface.get_params_dict_from_item(item))
        # only the control_imp has set_params
        context.rules_param_vals.update(
            ControlInterface.get_param_vals_from_control_imp(context.control_implementation)
        )
        new_dict = {}
        for key, val in context.rules_params_dict.items():
            rule = context.rules_dict.get(key, None)
            rule_name = rule['name'] if rule else 'Unknown'
            # rebuild the dict so it has desired order in yaml header
            new_dict[key] = {
                'name': val['name'], 'description': val['description'], 'rule-id': rule_name, 'options': val['options']
            }
        context.rules_params_dict = new_dict

    def write_catalog_as_profile_markdown(
        self, context: ControlContext, part_id_map: Dict[str, Dict[str, str]]
    ) -> None:
        """Write out the catalog as profile markdown."""
        required_section_list = context.required_sections.split(',') if context.required_sections else []
        allowed_section_list = context.allowed_sections.split(',') if context.allowed_sections else []

        # Get the list of params for this profile from its set_params
        # this is just from the set_params
        full_param_dict = CatalogInterface._get_full_profile_param_dict(context.profile)

        label_map = self.get_statement_part_id_map(True)
        found_alters, _, _ = CatalogInterface.read_additional_content(
            context.md_root, required_section_list, label_map, context.sections_dict, context.to_markdown
        )

        # write out the controls
        for control in self.get_all_controls_from_catalog(True):
            # here we do special handling of how set-parameters merge with the yaml header
            new_context = ControlContext.clone(context)
            if new_context.inherited_props:
                inherited_props = new_context.inherited_props.get(control.id, None)
                if inherited_props:
                    # build set in order of list so that duplicates will have final value stick, then convert to list
                    unique_props = list({prop['name']: prop for prop in inherited_props}.values())
                    new_context.yaml_header[const.TRESTLE_INHERITED_PROPS_TAG] = unique_props
            # get all params and vals for this control from the resolved profile catalog with block adds in effect
            control_param_dict = ControlInterface.get_control_param_dict(control, False)
            set_param_dict: Dict[str, str] = {}
            for param_id, param_dict in control_param_dict.items():
                # if the param is in the full_param_dict, load its contents first and mark as profile-values
                display_name = ''
                if param_id in full_param_dict:
                    # get the param from the profile set_param
                    param = full_param_dict[param_id]
                    display_name, _ = CatalogInterface._get_display_name_and_ns(param)
                    # assign its contents to the dict
                    new_dict = ModelUtils.parameter_to_dict(param, True)
                    if const.VALUES in new_dict:
                        new_dict[const.PROFILE_VALUES] = new_dict[const.VALUES]
                        new_dict.pop(const.VALUES)
                    # then insert the original, incoming values as values
                    if param_id in control_param_dict:
                        orig_param = control_param_dict[param_id]
                        orig_dict = ModelUtils.parameter_to_dict(orig_param, True)
                        # pull only the values from the actual control dict
                        # all the other elements are from the profile set_param
                        new_dict[const.VALUES] = orig_dict.get(const.VALUES, None)
                else:
                    # if the profile doesnt change this param at all, show it in the header with values
                    tmp_dict = ModelUtils.parameter_to_dict(param_dict, True)
                    values = tmp_dict.get('values', None)
                    new_dict = {'id': param_id, 'values': values}
                new_dict.pop('id', None)
                if display_name:
                    new_dict[const.DISPLAY_NAME] = display_name
                set_param_dict[param_id] = new_dict
            if set_param_dict:
                if const.SET_PARAMS_TAG not in new_context.yaml_header:
                    new_context.yaml_header[const.SET_PARAMS_TAG] = {}
                if new_context.overwrite_header_values:
                    # update the control params with new values
                    for key, value in new_context.yaml_header[const.SET_PARAMS_TAG].items():
                        if key in control_param_dict:
                            set_param_dict[key] = value
                else:
                    # update the control params with any values in yaml header not set in control
                    # need to maintain order in the set_param_dict
                    for key, value in new_context.yaml_header[const.SET_PARAMS_TAG].items():
                        if key in control_param_dict and key not in set_param_dict:
                            set_param_dict[key] = value
                new_context.yaml_header[const.SET_PARAMS_TAG] = set_param_dict
            elif const.SET_PARAMS_TAG in new_context.yaml_header:
                # need to cull any params that are not in control
                pop_list: List[str] = []
                for key in new_context.yaml_header[const.SET_PARAMS_TAG].keys():
                    if key not in control_param_dict:
                        pop_list.append(key)
                for pop in pop_list:
                    new_context.yaml_header[const.SET_PARAMS_TAG].pop(pop)

            new_context.required_sections = required_section_list
            new_context.allowed_sections = allowed_section_list
            found_control_alters = [alter for alter in found_alters if alter.control_id == control.id]

            self._write_control_into_dir(new_context, control, part_id_map, found_control_alters)

    def write_catalog_as_ssp_markdown(self, context: ControlContext, part_id_map: Dict[str, Dict[str, str]]) -> None:
        """Write out the catalog as component markdown."""
        # in component mode get rules, params, and param values from the current control_implementation
        # the catalog is written out in pieces per control_imp
        allowed_section_list = context.allowed_sections.split(',') if context.allowed_sections else []

        # write out the controls
        for control in self.get_all_controls_from_catalog(True):
            # here we do special handling of how set-parameters merge with the yaml header
            new_context = ControlContext.clone(context)
            new_context.allowed_sections = allowed_section_list

            self._write_control_into_dir(new_context, control, part_id_map, [])

    def write_catalog_as_component_markdown(
        self, context: ControlContext, part_id_map: Dict[str, Dict[str, str]]
    ) -> None:
        """Write out the catalog as component markdown."""

        def _update_values(set_param: comp.SetParameter) -> None:
            if set_param.param_id in control_param_dict:
                control_param_dict[set_param.param_id].values = set_param.values
            if set_param.param_id in new_context.rules_param_vals:
                values = ', '.join([v.__root__ for v in as_list(set_param.values)])
                new_context.rules_param_vals[set_param.param_id] = values

        # get the rule information for the current control implementation being written out in this context
        CatalogInterface._get_all_rules_params_and_vals(context)

        control_ids_in_comp_imp = [
            imp_req.control_id for imp_req in as_list(context.control_implementation.implemented_requirements)
        ]

        for control in self.get_all_controls_from_catalog(True):
            if control.id in control_ids_in_comp_imp:
                new_context = ControlContext.clone(context)
                control_param_dict = ControlInterface.get_control_param_dict(control, False)
                for set_param in as_list(new_context.control_implementation.set_parameters):
                    _update_values(set_param)
                for imp_req in as_list(new_context.control_implementation.implemented_requirements):
                    if imp_req.control_id == control.id:
                        for set_param in as_list(imp_req.set_parameters):
                            _update_values(set_param)

                if control_param_dict:
                    new_context.yaml_header[const.PARAM_VALUES_TAG] = {}
                    for key, param in control_param_dict.items():
                        new_context.yaml_header[const.PARAM_VALUES_TAG][key] = none_if_empty(
                            ControlInterface.param_to_str(param, ParameterRep.VALUE_OR_EMPTY_STRING)
                        )

                self._write_control_into_dir(new_context, control, part_id_map, [])

    def write_catalog_as_catalog(self, context: ControlContext, part_id_map: Dict[str, Dict[str, str]]) -> None:
        """Write the catalog as a simple catalog."""
        required_section_list = context.required_sections.split(',') if context.required_sections else []
        allowed_section_list = context.allowed_sections.split(',') if context.allowed_sections else []

        # write out the controls
        for control in self.get_all_controls_from_catalog(True):
            # here we do special handling of how set-parameters merge with the yaml header
            new_context = ControlContext.clone(context)

            control_param_dict = ControlInterface.get_control_param_dict(control, False)
            set_param_dict: Dict[str, str] = {}
            for param_id, param_dict in control_param_dict.items():
                tmp_dict = ModelUtils.parameter_to_dict(param_dict, True)
                values = tmp_dict.get('values', None)
                new_dict = {'values': values}
                set_param_dict[param_id] = new_dict
            if set_param_dict:
                if const.SET_PARAMS_TAG not in new_context.yaml_header:
                    new_context.yaml_header[const.SET_PARAMS_TAG] = {}
                if new_context.overwrite_header_values:
                    # update the control params with new values
                    for key, value in new_context.yaml_header[const.SET_PARAMS_TAG].items():
                        if key in control_param_dict:
                            set_param_dict[key] = value
                else:
                    # update the control params with any values in yaml header not set in control
                    # need to maintain order in the set_param_dict
                    for key, value in new_context.yaml_header[const.SET_PARAMS_TAG].items():
                        if key in control_param_dict and key not in set_param_dict:
                            set_param_dict[key] = value
                new_context.yaml_header[const.SET_PARAMS_TAG] = set_param_dict
            elif const.SET_PARAMS_TAG in new_context.yaml_header:
                # need to cull any params that are not in control
                pop_list: List[str] = []
                for key in new_context.yaml_header[const.SET_PARAMS_TAG].keys():
                    if key not in control_param_dict:
                        pop_list.append(key)
                for pop in pop_list:
                    new_context.yaml_header[const.SET_PARAMS_TAG].pop(pop)

            new_context.required_sections = required_section_list
            new_context.allowed_sections = allowed_section_list
            self._write_control_into_dir(new_context, control, part_id_map, [])

    def write_catalog_as_markdown(self, context: ControlContext, part_id_map: Dict[str, Dict[str, str]]) -> None:
        """
        Write out the catalog controls from dict as markdown files to the specified directory.

        Args:
            context: The context of the catalog markdown creation.
            part_id_map: Mapping of part_id to label for all controls

        Returns:
            None
        """
        # create the directory in which to write the control markdown files
        context.md_root.mkdir(exist_ok=True, parents=True)

        if context.purpose == ContextPurpose.PROFILE:
            self.write_catalog_as_profile_markdown(context, part_id_map)
        elif context.purpose == ContextPurpose.COMPONENT:
            self.write_catalog_as_component_markdown(context, part_id_map)
        elif context.purpose == ContextPurpose.SSP:
            self.write_catalog_as_ssp_markdown(context, part_id_map)
        else:
            self.write_catalog_as_catalog(context, part_id_map)

        # prune any directories that have no markdown files
        prune_empty_dirs(context.md_root, '*.md')

    @staticmethod
    def _get_group_ids_and_dirs(md_path: pathlib.Path) -> Dict[str, pathlib.Path]:
        """
        Create a sorted map of group id to group dir that is ordered by group id.

        This includes '' as the root group id.
        """
        # manually insert the top dir as group ''
        id_map: Dict[str, pathlib.Path] = {'': md_path}
        for gdir in md_path.rglob('*'):
            if gdir.is_dir():
                id_map[gdir.stem] = gdir
        # rebuild the dict by inserting items in manner sorted by key
        sorted_id_map: Dict[str, pathlib.Path] = {}
        for key in sorted(id_map):
            sorted_id_map[key] = id_map[key]
        return sorted_id_map

    def read_catalog_from_markdown(self, md_path: pathlib.Path, set_parameters_flag: bool) -> cat.Catalog:
        """
        Read the groups and catalog controls from the given directory.

        This will overwrite the existing groups and controls in the catalog.
        """
        if not self._catalog:
            self._catalog = gens.generate_sample_model(cat.Catalog)
        id_map = CatalogInterface._get_group_ids_and_dirs(md_path)
        groups: List[cat.Group] = []
        # read each group dir
        for group_id, group_dir in id_map.items():
            control_list_raw = []
            group_title = ''
            # Need to get group title from at least one control in this directory
            # All controls in dir should have same group title
            # Set group title to the first one found and warn if different non-empty title appears
            # Controls with empty group titles are tolerated but at least one title must be present or warning given
            # The special group with no name that has the catalog as parent is just a list and has no title
            for control_path in group_dir.glob('*.md'):
                control, control_group_title = ControlReader.read_control(control_path, set_parameters_flag)
                if control_group_title:
                    if group_title:
                        if control_group_title != group_title:
                            logger.warning(
                                f'Control {control.id} group title {control_group_title} differs from {group_title}'
                            )
                    else:
                        group_title = control_group_title
                control_list_raw.append(control)
            control_list = sorted(control_list_raw, key=lambda control: ControlInterface.get_sort_id(control))
            if group_id:
                if not group_title:
                    logger.warning(f'No group title found in controls for group {group_id}')
                new_group = cat.Group(id=group_id, title=group_title)
                new_group.controls = none_if_empty(control_list)
                groups.append(new_group)
            else:
                # if the list of controls has no group id it also has no title and is just the controls of the catalog
                self._catalog.controls = none_if_empty(control_list)
        self._catalog.groups = none_if_empty(groups)
        self._create_control_dict()
        self._catalog.params = none_if_empty(self._catalog.params)
        return self._catalog

    @staticmethod
    def read_catalog_imp_reqs(
        md_path: pathlib.Path, avail_comps: Dict[str, generic.GenericComponent], context: ControlContext
    ) -> List[generic.GenericImplementedRequirement]:
        """Read the full set of control implemented requirements from markdown.

        Args:
            md_path: Path to the markdown control files, with directories for each group
            avail_comps: Dict mapping component names to known components

        Returns:
            List of implemented requirements gathered from each control

        Notes:
            As the controls are read into the catalog the needed components are added if not already available.
            avail_comps provides the mapping of component name to the actual component.
            This is only used for ssp via catalog_interface
        """
        imp_req_map: Dict[str, generic.GenericImplementedRequirement] = {}
        for group_path in CatalogInterface._get_group_ids_and_dirs(md_path).values():
            for control_file in group_path.glob('*.md'):
                sort_id, imp_req = ControlReader.read_implemented_requirement(control_file, avail_comps, context)
                imp_req_map[sort_id] = imp_req
        return [imp_req_map[key] for key in sorted(imp_req_map.keys())]

    @staticmethod
    def read_additional_content(
        md_path: pathlib.Path,
        required_sections_list: List[str],
        label_map: Dict[str, Dict[str, str]],
        sections_dict: Dict[str, str],
        write_mode: bool
    ) -> Tuple[List[prof.Alter], Dict[str, Any], Dict[str, str]]:
        """Read all markdown controls and return list of alters plus control param dict and param sort map."""
        alters_map: Dict[str, prof.Alter] = {}
        final_param_dict: Dict[str, Any] = {}
        param_sort_map: Dict[str, str] = {}
        for group_path in CatalogInterface._get_group_ids_and_dirs(md_path).values():
            for control_file in group_path.glob('*.md'):
                sort_id, control_alters, control_param_dict = ControlReader.read_editable_content(
                    control_file,
                    required_sections_list,
                    label_map,
                    sections_dict,
                    write_mode
                )
                alters_map[sort_id] = control_alters
                for param_id, param_dict in control_param_dict.items():
                    # if profile_values are present, overwrite values with them
                    if const.PROFILE_VALUES in param_dict:
                        param_dict[const.VALUES] = param_dict.pop(const.PROFILE_VALUES)
                        final_param_dict[param_id] = param_dict
                        param_sort_map[param_id] = sort_id
        new_alters: List[prof.Alter] = []
        # fill the alters according to the control sorting order
        for key in sorted(alters_map.keys()):
            new_alters.extend(alters_map[key])
        return new_alters, final_param_dict, param_sort_map

    def get_sections(self) -> List[str]:
        """Get the available sections by a full index of all controls."""
        return list(
            {
                part.name
                for control_handle in self._control_dict.values()
                for part in as_list(control_handle.control.parts)
                if part.name != const.STATEMENT
            }
        )

    @staticmethod
    def merge_controls(dest: cat.Control, src: cat.Control, replace_params: bool) -> None:
        """
        Merge the src control into dest.

        Args:
            dest: destination control into which content will be added
            src: source control with new content
            replace_params: replace the control params with the new ones
        """
        ControlInterface.merge_parts(dest, src)
        if replace_params:
            dest.params = src.params

    def _find_control_in_group(self, group_id: str) -> Tuple[str, ControlHandle]:
        """
        Find a representative control for this group and its control handle.

        This is a simple way to get group info (title etc.) given only group id.
        It is not intended for high performance loops.  Use only as needed.
        """
        for control_id, control_handle in self._control_dict.items():
            if control_handle.group_id == group_id:
                return control_id, control_handle
        raise TrestleError(f'No controls found for group {group_id}')

    def merge_catalog(self, catalog: cat.Catalog, replace_params: bool) -> None:
        """
        Merge the provided new catalog controls into the original catalog in this catalog interface.

        Args:
            catalog: catalog containing controls that are merged into the current catalog of the interface
            replace_params: replace all params in the control with the new ones

        Notes:
            This is mainly to support the reading of a catalog from markdown.  It allows retention of content such as
            metadata and backmatter, along with labels and other parameter attributes that aren't in markdown.
            The list of controls and group structure is specified by the markdown structure - but this doesn't allow
            controls to contain controls.  Group lists are specified per directory.

            Reading the markdown tells you groups and controls in them - and groups in groups.
            Controls cannot change groups.  If the control was in the original json, its parts are replaced,
            including its parameters.  Only values may be specified.  If no value specified, the value is unset in json.
        """
        cat_interface = CatalogInterface(catalog)
        for src in cat_interface.get_all_controls_from_dict():
            group_id, _, _ = cat_interface.get_group_info_by_control(src.id)
            dest = self.get_control(src.id)
            if dest:
                dest_group, _, _ = self.get_group_info_by_control(dest.id)
                if dest_group != group_id:
                    raise TrestleError(f'Markdown for control {src.id} has different group id.')
                CatalogInterface.merge_controls(dest, src, replace_params)
                self.replace_control(dest)
            else:
                # this is a new control that isn't already in the merge destination
                # need to add the control knowing its group must already exist
                # get group info from an arbitrary control already present in group
                _, control_handle = self._find_control_in_group(group_id)
                new_control_handle = copy.deepcopy(control_handle)
                new_control_handle.control = src
                # add the control and its handle to the param_dict
                self._control_dict[src.id] = new_control_handle

        # now need to cull any controls that are not in the src catalog
        handled_ids = set(cat_interface._control_dict.keys())
        orig_ids = set(self._control_dict.keys())
        extra_ids = orig_ids.difference(handled_ids)
        for extra_id in extra_ids:
            self._control_dict.pop(extra_id)

        self.update_catalog_controls()
Classes¤
ControlHandle dataclass ¤

Convenience class for handling controls as members of a group.

group_id: id of parent group or '' if not in a group group_title: title of the group group_class: class of the group path: path of parent groups leading to this control - without the final control_id, or [''] if in cat list control: the control itself

Source code in trestle/core/catalog_interface.py
@dataclass
class ControlHandle:
    """Convenience class for handling controls as members of a group.

    group_id: id of parent group or '' if not in a group
    group_title: title of the group
    group_class: class of the group
    path: path of parent groups leading to this control - without the final control_id, or [''] if in cat list
    control: the control itself
    """

    group_id: str
    group_title: Optional[str]
    group_class: Optional[str]
    group_path: List[str]
    control_path: List[str]
    control: cat.Control
control: Control dataclass-field ¤
control_path: List[str] dataclass-field ¤
group_class: Optional[str] dataclass-field ¤
group_id: str dataclass-field ¤
group_path: List[str] dataclass-field ¤
group_title: Optional[str] dataclass-field ¤
__eq__(self, other) special ¤
__init__(self, group_id, group_title, group_class, group_path, control_path, control) special ¤
__repr__(self) special ¤
Methods¤
__init__(self, catalog=None) special ¤

Initialize the interface with the catalog.

Source code in trestle/core/catalog_interface.py
def __init__(self, catalog: Optional[cat.Catalog] = None) -> None:
    """Initialize the interface with the catalog."""
    self._catalog = catalog
    self._param_control_map: Dict[str, str] = {}
    self._generate_group_index: int = 0
    self._control_dict = self._create_control_dict() if catalog else None
    self.loose_param_dict: Dict[str, common.Parameter] = {param.id: param
                                                          for param in as_list(catalog.params)} if catalog else {}
delete_control(self, control_id) ¤

Delete the control from the control_dict based on id.

Delete all its dependent children also.

Source code in trestle/core/catalog_interface.py
def delete_control(self, control_id: str) -> None:
    """
    Delete the control from the control_dict based on id.

    Delete all its dependent children also.
    """
    control = self.get_control(control_id)
    if control:
        for sub_control_id in self.get_dependent_control_ids(control.id):
            self._control_dict.pop(sub_control_id, None)
        self._control_dict.pop(control_id, None)
delete_withdrawn_controls(self) ¤

Delete all withdrawn controls from the catalog.

Source code in trestle/core/catalog_interface.py
def delete_withdrawn_controls(self) -> None:
    """Delete all withdrawn controls from the catalog."""
    delete_list = []
    for control in self.get_all_controls_from_dict():
        if ControlInterface.is_withdrawn(control):
            delete_list.append(control.id)
    for id_ in delete_list:
        self.delete_control(id_)
find_part_with_condition(self, part, condition) ¤

Traverse part and find subpart that satisfies given condition.

Source code in trestle/core/catalog_interface.py
def find_part_with_condition(self, part: common.Part, condition: Callable) -> Optional[common.Part]:
    """Traverse part and find subpart that satisfies given condition."""
    if condition(part):
        # Part that satisfies the condition is found.
        return part
    else:
        if part.parts:
            for subpart in part.parts:
                found_part = self.find_part_with_condition(subpart, condition)
                if found_part:
                    return found_part

    return None
find_string_in_control(self, control, seek_str) ¤

Find all instances of this string in prose of control.

Source code in trestle/core/catalog_interface.py
def find_string_in_control(self, control: cat.Control, seek_str: str) -> List[Tuple[str, str]]:
    """Find all instances of this string in prose of control."""
    hits: List[Tuple[str, str]] = []
    if control.parts:
        for part in control.parts:
            hits.extend(self._find_string_in_part(control.id, part, seek_str))
    return hits
get_all_controls_from_catalog(self, recurse) ¤

Yield all controls from the actual catalog by group including optional sub controls.

Parameters:

Name Type Description Default
recurse bool

Whether to recurse within controls, but groups are always recursed

required

Returns:

Type Description
Iterator[trestle.oscal.catalog.Control]

iterator of the controls in the catalog

Notes

This follows the actual structure of the catalog and groups

Source code in trestle/core/catalog_interface.py
def get_all_controls_from_catalog(self, recurse: bool) -> Iterator[cat.Control]:
    """
    Yield all controls from the actual catalog by group including optional sub controls.

    Args:
        recurse: Whether to recurse within controls, but groups are always recursed

    Returns:
        iterator of the controls in the catalog

    Notes:
        This follows the actual structure of the catalog and groups
    """
    if self._catalog.groups:
        for group in self._catalog.groups:
            controls = self._get_all_controls_in_group(group, recurse)
            for control in controls:
                yield control
    if self._catalog.controls:
        cat_controls = self._get_all_controls_in_list(self._catalog.controls, recurse)
        for control in cat_controls:
            yield control
get_all_controls_from_dict(self) ¤

Yield individual controls from the dict.

Source code in trestle/core/catalog_interface.py
def get_all_controls_from_dict(self) -> Iterator[cat.Control]:
    """Yield individual controls from the dict."""
    return [handle.control for handle in self._control_dict.values()]
get_all_groups_from_catalog(self) ¤

Retrieve all groups in the catalog sorted by group_id.

This ignores controls that are direct children of the catalog.

Source code in trestle/core/catalog_interface.py
def get_all_groups_from_catalog(self) -> List[cat.Group]:
    """
    Retrieve all groups in the catalog sorted by group_id.

    This ignores controls that are direct children of the catalog.
    """
    groups: List[cat.Group] = []
    if self._catalog.groups:
        for my_group in self._catalog.groups:
            for res in CatalogInterface._get_groups_from_group(my_group):
                groups.append(res)
    return sorted(groups, key=lambda group: group.id)
get_catalog(self, update=True) ¤

Safe method to get catalog after forced update from catalog dict.

Source code in trestle/core/catalog_interface.py
def get_catalog(self, update=True) -> cat.Catalog:
    """Safe method to get catalog after forced update from catalog dict."""
    if update:
        self.update_catalog_controls()
    return self._catalog
get_catalog_title(self) ¤

Get the title of the catalog.

Source code in trestle/core/catalog_interface.py
def get_catalog_title(self) -> str:
    """Get the title of the catalog."""
    return self._catalog.metadata.title
get_control(self, control_id) ¤

Get control from the control dict with this id.

Source code in trestle/core/catalog_interface.py
def get_control(self, control_id: str) -> Optional[cat.Control]:
    """Get control from the control dict with this id."""
    return None if control_id not in self._control_dict else self._control_dict[control_id].control
get_control_by_param_id(self, param_id) ¤

Get control from catalog that has this param id using the dict.

Source code in trestle/core/catalog_interface.py
def get_control_by_param_id(self, param_id: str) -> Optional[cat.Control]:
    """Get control from catalog that has this param id using the dict."""
    if param_id in self._param_control_map:
        return self.get_control(self._param_control_map[param_id])
    return None
get_control_id_and_status(self, control_name) ¤

Get the control id and status using the control name.

Returns empty string if status not found.

Source code in trestle/core/catalog_interface.py
def get_control_id_and_status(self, control_name: str) -> Tuple[str, str]:
    """
    Get the control id and status using the control name.

    Returns empty string if status not found.
    """
    for control in self.get_all_controls_from_dict():
        if ControlInterface.get_label(control).strip().lower() == control_name.strip().lower():
            status = ControlInterface.get_prop(control, 'status')
            return control.id, status
    return '', ''
get_control_ids(self) ¤

Get all control ids from the control dict.

Source code in trestle/core/catalog_interface.py
def get_control_ids(self) -> List[str]:
    """Get all control ids from the control dict."""
    return self._control_dict.keys()
get_control_ids_from_catalog(catalog) staticmethod ¤

Get all control ids from a catalog.

This is intended to provide a quick list of all controls in a catalog without the expense of building the control dict. So, if repeated queries are made into a catalog, it is worth instantiating a CatalogInterface and associated control dict. Otherwise just use this to get a list of all controls.

This function is needed within the CatalogInterface in order to determine if new controls have been added to the dict and need to be inserted in the actual catalog during update.

Source code in trestle/core/catalog_interface.py
@staticmethod
def get_control_ids_from_catalog(catalog: cat.Catalog) -> List[str]:
    """
    Get all control ids from a catalog.

    This is intended to provide a quick list of all controls in a catalog without the expense of building the
    control dict.  So, if repeated queries are made into a catalog, it is worth instantiating a CatalogInterface
    and associated control dict.  Otherwise just use this to get a list of all controls.

    This function is needed within the CatalogInterface in order to determine if new controls have been added
    to the dict and need to be inserted in the actual catalog during update.
    """
    controls = CatalogInterface._get_all_controls_in_list(as_list(catalog.controls), True)
    id_list = [control.id for control in controls]
    for group in as_list(catalog.groups):
        controls = CatalogInterface._get_all_controls_in_group(group, True)
        id_list.extend([control.id for control in as_list(controls)])
    return id_list
get_control_part_prose(self, control_id, part_name) ¤

Get the prose for a named part in the control.

Parameters:

Name Type Description Default
control_id str

id of the control

required
part_name str

name of the part

required

Returns:

Type Description
str

Single string concatenating prose from all parts and sub-parts in control with that name.

Source code in trestle/core/catalog_interface.py
def get_control_part_prose(self, control_id: str, part_name: str) -> str:
    """
    Get the prose for a named part in the control.

    Args:
        control_id: id of the control
        part_name: name of the part

    Returns:
        Single string concatenating prose from all parts and sub-parts in control with that name.
    """
    control = self.get_control(control_id)
    return ControlInterface.get_part_prose(control, part_name)
get_control_path(self, control_id) ¤

Return the path into the markdown directory for this control based only on the groups.

Source code in trestle/core/catalog_interface.py
def get_control_path(self, control_id: str) -> List[str]:
    """Return the path into the markdown directory for this control based only on the groups."""
    return self._control_dict[control_id].group_path
get_count_of_controls_in_catalog(self, recurse) ¤

Get count of controls from the actual catalog including optional sub controls.

Source code in trestle/core/catalog_interface.py
def get_count_of_controls_in_catalog(self, recurse: bool) -> int:
    """Get count of controls from the actual catalog including optional sub controls."""
    return len(list(self.get_all_controls_from_catalog(recurse)))
get_count_of_controls_in_dict(self) ¤

Find number of controls in the dict.

Source code in trestle/core/catalog_interface.py
def get_count_of_controls_in_dict(self) -> int:
    """Find number of controls in the dict."""
    return len(self._control_dict.keys())
get_dependent_control_ids(self, control_id) ¤

Find all child ids of this control from the dict with recursion.

Source code in trestle/core/catalog_interface.py
def get_dependent_control_ids(self, control_id: str) -> List[str]:
    """Find all child ids of this control from the dict with recursion."""
    children: List[str] = []
    control = self.get_control(control_id)
    if control:
        new_controls = self._get_all_controls_in_list(as_list(control.controls), True)
        children.extend([con.id for con in new_controls])
    return children
get_full_control_path(self, control_id) ¤

Return the path to the control including groups and sub-controls.

Source code in trestle/core/catalog_interface.py
def get_full_control_path(self, control_id: str) -> List[str]:
    """Return the path to the control including groups and sub-controls."""
    return self._control_dict[control_id].control_path
get_group_ids(self) ¤

Get all the group id's as a list of sorted strings.

Source code in trestle/core/catalog_interface.py
def get_group_ids(self) -> List[str]:
    """Get all the group id's as a list of sorted strings."""
    return sorted(filter(lambda id: id, list({control.group_id for control in self._control_dict.values()})))
get_group_info_by_control(self, control_id) ¤

Get the group_id, title, class for this control from the dict.

Source code in trestle/core/catalog_interface.py
def get_group_info_by_control(self, control_id: str) -> Tuple[str, str, str]:
    """Get the group_id, title, class for this control from the dict."""
    return (
        self._control_dict[control_id].group_id,
        self._control_dict[control_id].group_title,
        self._control_dict[control_id].group_class
    )
get_sections(self) ¤

Get the available sections by a full index of all controls.

Source code in trestle/core/catalog_interface.py
def get_sections(self) -> List[str]:
    """Get the available sections by a full index of all controls."""
    return list(
        {
            part.name
            for control_handle in self._control_dict.values()
            for part in as_list(control_handle.control.parts)
            if part.name != const.STATEMENT
        }
    )
get_sorted_controls_in_group(self, group_id) ¤

Get the list of controls in a group sorted by the control sort-id.

Source code in trestle/core/catalog_interface.py
def get_sorted_controls_in_group(self, group_id: str) -> List[cat.Control]:
    """Get the list of controls in a group sorted by the control sort-id."""
    controls: List[cat.Control] = []
    for control in self.get_all_controls_from_dict():
        grp_id, _, _ = self.get_group_info_by_control(control.id)
        if grp_id == group_id:
            controls.append(control)
    return sorted(controls, key=lambda control: ControlInterface.get_sort_id(control))
get_statement_label_if_exists(self, control_id, statement_id) ¤

Get statement label if available.

Source code in trestle/core/catalog_interface.py
def get_statement_label_if_exists(self, control_id: str,
                                  statement_id: str) -> Tuple[Optional[str], Optional[common.Part]]:
    """Get statement label if available."""

    def does_part_exists(part: common.Part) -> bool:
        does_match = False
        if part.name and part.name in {const.STATEMENT, 'item'} and part.id == statement_id:
            does_match = True
        return does_match

    control = self.get_control(control_id)
    if not control:
        return '', None
    label = None
    found_part = None
    if control.parts:
        for part in as_list(control.parts):
            # Performance OSCAL assumption, ids are nested so recurse only if prefix
            if part.id and statement_id.startswith(part.id):
                part = self.find_part_with_condition(part, does_part_exists)
                if part:
                    label = ControlInterface.get_label(part)
                    found_part = part
                    break

    return label, found_part
get_statement_part_id_map(self, label_as_key) ¤

Create mapping of label to part_id for top level parts in statement of all controls.

Source code in trestle/core/catalog_interface.py
def get_statement_part_id_map(self, label_as_key: bool) -> Dict[str, Dict[str, str]]:
    """Create mapping of label to part_id for top level parts in statement of all controls."""
    id_map = {}
    for control in self.get_all_controls_from_catalog(True):
        statement_part = get_item_from_list(control.parts, const.STATEMENT, lambda p: p.name)
        if statement_part:
            id_dict: Dict[str, str] = {}
            for sub_part in as_list(statement_part.parts):
                label = ControlInterface.get_label(sub_part)
                if label_as_key:
                    id_dict[label] = sub_part.id
                else:
                    id_dict[sub_part.id] = label
            if id_dict:
                id_map[control.id] = id_dict
    return id_map
get_statement_parts(self, control_id) ¤

Get list of statement parts as dicts with indentation, label and prose.

Source code in trestle/core/catalog_interface.py
def get_statement_parts(self, control_id: str) -> List[Dict[str, str]]:
    """Get list of statement parts as dicts with indentation, label and prose."""
    items = []
    control = self.get_control(control_id)

    # control may have no statement or parts
    # but if statement present it is first part
    if control is None:
        logger.warning(f'No control found for id {control_id}')
    elif control.parts:
        part = control.parts[0]
        if part.name == 'statement':
            items.extend(CatalogInterface._get_statement_sub_parts(part, 0))
        else:
            logger.warning(f'Control {control_id} has parts but first part name is {part.name} - not statement')
    return items
merge_catalog(self, catalog, replace_params) ¤

Merge the provided new catalog controls into the original catalog in this catalog interface.

Parameters:

Name Type Description Default
catalog Catalog

catalog containing controls that are merged into the current catalog of the interface

required
replace_params bool

replace all params in the control with the new ones

required

Notes

This is mainly to support the reading of a catalog from markdown. It allows retention of content such as metadata and backmatter, along with labels and other parameter attributes that aren't in markdown. The list of controls and group structure is specified by the markdown structure - but this doesn't allow controls to contain controls. Group lists are specified per directory.

Reading the markdown tells you groups and controls in them - and groups in groups. Controls cannot change groups. If the control was in the original json, its parts are replaced, including its parameters. Only values may be specified. If no value specified, the value is unset in json.

Source code in trestle/core/catalog_interface.py
def merge_catalog(self, catalog: cat.Catalog, replace_params: bool) -> None:
    """
    Merge the provided new catalog controls into the original catalog in this catalog interface.

    Args:
        catalog: catalog containing controls that are merged into the current catalog of the interface
        replace_params: replace all params in the control with the new ones

    Notes:
        This is mainly to support the reading of a catalog from markdown.  It allows retention of content such as
        metadata and backmatter, along with labels and other parameter attributes that aren't in markdown.
        The list of controls and group structure is specified by the markdown structure - but this doesn't allow
        controls to contain controls.  Group lists are specified per directory.

        Reading the markdown tells you groups and controls in them - and groups in groups.
        Controls cannot change groups.  If the control was in the original json, its parts are replaced,
        including its parameters.  Only values may be specified.  If no value specified, the value is unset in json.
    """
    cat_interface = CatalogInterface(catalog)
    for src in cat_interface.get_all_controls_from_dict():
        group_id, _, _ = cat_interface.get_group_info_by_control(src.id)
        dest = self.get_control(src.id)
        if dest:
            dest_group, _, _ = self.get_group_info_by_control(dest.id)
            if dest_group != group_id:
                raise TrestleError(f'Markdown for control {src.id} has different group id.')
            CatalogInterface.merge_controls(dest, src, replace_params)
            self.replace_control(dest)
        else:
            # this is a new control that isn't already in the merge destination
            # need to add the control knowing its group must already exist
            # get group info from an arbitrary control already present in group
            _, control_handle = self._find_control_in_group(group_id)
            new_control_handle = copy.deepcopy(control_handle)
            new_control_handle.control = src
            # add the control and its handle to the param_dict
            self._control_dict[src.id] = new_control_handle

    # now need to cull any controls that are not in the src catalog
    handled_ids = set(cat_interface._control_dict.keys())
    orig_ids = set(self._control_dict.keys())
    extra_ids = orig_ids.difference(handled_ids)
    for extra_id in extra_ids:
        self._control_dict.pop(extra_id)

    self.update_catalog_controls()
merge_controls(dest, src, replace_params) staticmethod ¤

Merge the src control into dest.

Parameters:

Name Type Description Default
dest Control

destination control into which content will be added

required
src Control

source control with new content

required
replace_params bool

replace the control params with the new ones

required
Source code in trestle/core/catalog_interface.py
@staticmethod
def merge_controls(dest: cat.Control, src: cat.Control, replace_params: bool) -> None:
    """
    Merge the src control into dest.

    Args:
        dest: destination control into which content will be added
        src: source control with new content
        replace_params: replace the control params with the new ones
    """
    ControlInterface.merge_parts(dest, src)
    if replace_params:
        dest.params = src.params
read_additional_content(md_path, required_sections_list, label_map, sections_dict, write_mode) staticmethod ¤

Read all markdown controls and return list of alters plus control param dict and param sort map.

Source code in trestle/core/catalog_interface.py
@staticmethod
def read_additional_content(
    md_path: pathlib.Path,
    required_sections_list: List[str],
    label_map: Dict[str, Dict[str, str]],
    sections_dict: Dict[str, str],
    write_mode: bool
) -> Tuple[List[prof.Alter], Dict[str, Any], Dict[str, str]]:
    """Read all markdown controls and return list of alters plus control param dict and param sort map."""
    alters_map: Dict[str, prof.Alter] = {}
    final_param_dict: Dict[str, Any] = {}
    param_sort_map: Dict[str, str] = {}
    for group_path in CatalogInterface._get_group_ids_and_dirs(md_path).values():
        for control_file in group_path.glob('*.md'):
            sort_id, control_alters, control_param_dict = ControlReader.read_editable_content(
                control_file,
                required_sections_list,
                label_map,
                sections_dict,
                write_mode
            )
            alters_map[sort_id] = control_alters
            for param_id, param_dict in control_param_dict.items():
                # if profile_values are present, overwrite values with them
                if const.PROFILE_VALUES in param_dict:
                    param_dict[const.VALUES] = param_dict.pop(const.PROFILE_VALUES)
                    final_param_dict[param_id] = param_dict
                    param_sort_map[param_id] = sort_id
    new_alters: List[prof.Alter] = []
    # fill the alters according to the control sorting order
    for key in sorted(alters_map.keys()):
        new_alters.extend(alters_map[key])
    return new_alters, final_param_dict, param_sort_map
read_catalog_from_markdown(self, md_path, set_parameters_flag) ¤

Read the groups and catalog controls from the given directory.

This will overwrite the existing groups and controls in the catalog.

Source code in trestle/core/catalog_interface.py
def read_catalog_from_markdown(self, md_path: pathlib.Path, set_parameters_flag: bool) -> cat.Catalog:
    """
    Read the groups and catalog controls from the given directory.

    This will overwrite the existing groups and controls in the catalog.
    """
    if not self._catalog:
        self._catalog = gens.generate_sample_model(cat.Catalog)
    id_map = CatalogInterface._get_group_ids_and_dirs(md_path)
    groups: List[cat.Group] = []
    # read each group dir
    for group_id, group_dir in id_map.items():
        control_list_raw = []
        group_title = ''
        # Need to get group title from at least one control in this directory
        # All controls in dir should have same group title
        # Set group title to the first one found and warn if different non-empty title appears
        # Controls with empty group titles are tolerated but at least one title must be present or warning given
        # The special group with no name that has the catalog as parent is just a list and has no title
        for control_path in group_dir.glob('*.md'):
            control, control_group_title = ControlReader.read_control(control_path, set_parameters_flag)
            if control_group_title:
                if group_title:
                    if control_group_title != group_title:
                        logger.warning(
                            f'Control {control.id} group title {control_group_title} differs from {group_title}'
                        )
                else:
                    group_title = control_group_title
            control_list_raw.append(control)
        control_list = sorted(control_list_raw, key=lambda control: ControlInterface.get_sort_id(control))
        if group_id:
            if not group_title:
                logger.warning(f'No group title found in controls for group {group_id}')
            new_group = cat.Group(id=group_id, title=group_title)
            new_group.controls = none_if_empty(control_list)
            groups.append(new_group)
        else:
            # if the list of controls has no group id it also has no title and is just the controls of the catalog
            self._catalog.controls = none_if_empty(control_list)
    self._catalog.groups = none_if_empty(groups)
    self._create_control_dict()
    self._catalog.params = none_if_empty(self._catalog.params)
    return self._catalog
read_catalog_imp_reqs(md_path, avail_comps, context) staticmethod ¤

Read the full set of control implemented requirements from markdown.

Parameters:

Name Type Description Default
md_path Path

Path to the markdown control files, with directories for each group

required
avail_comps Dict[str, trestle.core.generic_oscal.GenericComponent]

Dict mapping component names to known components

required

Returns:

Type Description
List[trestle.core.generic_oscal.GenericImplementedRequirement]

List of implemented requirements gathered from each control

Notes

As the controls are read into the catalog the needed components are added if not already available. avail_comps provides the mapping of component name to the actual component. This is only used for ssp via catalog_interface

Source code in trestle/core/catalog_interface.py
@staticmethod
def read_catalog_imp_reqs(
    md_path: pathlib.Path, avail_comps: Dict[str, generic.GenericComponent], context: ControlContext
) -> List[generic.GenericImplementedRequirement]:
    """Read the full set of control implemented requirements from markdown.

    Args:
        md_path: Path to the markdown control files, with directories for each group
        avail_comps: Dict mapping component names to known components

    Returns:
        List of implemented requirements gathered from each control

    Notes:
        As the controls are read into the catalog the needed components are added if not already available.
        avail_comps provides the mapping of component name to the actual component.
        This is only used for ssp via catalog_interface
    """
    imp_req_map: Dict[str, generic.GenericImplementedRequirement] = {}
    for group_path in CatalogInterface._get_group_ids_and_dirs(md_path).values():
        for control_file in group_path.glob('*.md'):
            sort_id, imp_req = ControlReader.read_implemented_requirement(control_file, avail_comps, context)
            imp_req_map[sort_id] = imp_req
    return [imp_req_map[key] for key in sorted(imp_req_map.keys())]
replace_control(self, control) ¤

Replace the control in the control_dict.

This only replaces the parent control and not its children.

Source code in trestle/core/catalog_interface.py
def replace_control(self, control: cat.Control) -> None:
    """
    Replace the control in the control_dict.

    This only replaces the parent control and not its children.
    """
    self._control_dict[control.id].control = control
update_catalog_controls(self) ¤

Update the actual catalog by pulling fresh controls from the dict.

During assembly, controls may be added, but not children of controls. New groups may not be added. A control containing controls cannot be added. Controls containing controls are only available if the parent catalog was loaded from json.

Source code in trestle/core/catalog_interface.py
def update_catalog_controls(self) -> None:
    """
    Update the actual catalog by pulling fresh controls from the dict.

    During assembly, controls may be added, but not children of controls.
    New groups may not be added.
    A control containing controls cannot be added.  Controls containing controls are only available if
    the parent catalog was loaded from json.
    """
    # first go through the catalog and pull existing controls from the dict
    for group in as_list(self._catalog.groups):
        self._update_all_controls_in_group(group)

    new_list = []
    for control in as_list(self._catalog.controls):
        new_control = self.get_control(control.id)
        new_control.controls = self._update_all_controls_in_list(as_list(control.controls))
        new_control.controls = none_if_empty(new_control.controls)
        new_list.append(new_control)
    self._catalog.controls = none_if_empty(new_list)

    # now add any new controls that are discovered in the dict
    ids_in_catalog = CatalogInterface.get_control_ids_from_catalog(self._catalog)
    for control_handle in self._control_dict.values():
        if control_handle.control.id not in ids_in_catalog:
            self._insert_control_in_catalog(control_handle)

    self._catalog.params = none_if_empty(list(self.loose_param_dict.values()))
write_catalog_as_catalog(self, context, part_id_map) ¤

Write the catalog as a simple catalog.

Source code in trestle/core/catalog_interface.py
def write_catalog_as_catalog(self, context: ControlContext, part_id_map: Dict[str, Dict[str, str]]) -> None:
    """Write the catalog as a simple catalog."""
    required_section_list = context.required_sections.split(',') if context.required_sections else []
    allowed_section_list = context.allowed_sections.split(',') if context.allowed_sections else []

    # write out the controls
    for control in self.get_all_controls_from_catalog(True):
        # here we do special handling of how set-parameters merge with the yaml header
        new_context = ControlContext.clone(context)

        control_param_dict = ControlInterface.get_control_param_dict(control, False)
        set_param_dict: Dict[str, str] = {}
        for param_id, param_dict in control_param_dict.items():
            tmp_dict = ModelUtils.parameter_to_dict(param_dict, True)
            values = tmp_dict.get('values', None)
            new_dict = {'values': values}
            set_param_dict[param_id] = new_dict
        if set_param_dict:
            if const.SET_PARAMS_TAG not in new_context.yaml_header:
                new_context.yaml_header[const.SET_PARAMS_TAG] = {}
            if new_context.overwrite_header_values:
                # update the control params with new values
                for key, value in new_context.yaml_header[const.SET_PARAMS_TAG].items():
                    if key in control_param_dict:
                        set_param_dict[key] = value
            else:
                # update the control params with any values in yaml header not set in control
                # need to maintain order in the set_param_dict
                for key, value in new_context.yaml_header[const.SET_PARAMS_TAG].items():
                    if key in control_param_dict and key not in set_param_dict:
                        set_param_dict[key] = value
            new_context.yaml_header[const.SET_PARAMS_TAG] = set_param_dict
        elif const.SET_PARAMS_TAG in new_context.yaml_header:
            # need to cull any params that are not in control
            pop_list: List[str] = []
            for key in new_context.yaml_header[const.SET_PARAMS_TAG].keys():
                if key not in control_param_dict:
                    pop_list.append(key)
            for pop in pop_list:
                new_context.yaml_header[const.SET_PARAMS_TAG].pop(pop)

        new_context.required_sections = required_section_list
        new_context.allowed_sections = allowed_section_list
        self._write_control_into_dir(new_context, control, part_id_map, [])
write_catalog_as_component_markdown(self, context, part_id_map) ¤

Write out the catalog as component markdown.

Source code in trestle/core/catalog_interface.py
def write_catalog_as_component_markdown(
    self, context: ControlContext, part_id_map: Dict[str, Dict[str, str]]
) -> None:
    """Write out the catalog as component markdown."""

    def _update_values(set_param: comp.SetParameter) -> None:
        if set_param.param_id in control_param_dict:
            control_param_dict[set_param.param_id].values = set_param.values
        if set_param.param_id in new_context.rules_param_vals:
            values = ', '.join([v.__root__ for v in as_list(set_param.values)])
            new_context.rules_param_vals[set_param.param_id] = values

    # get the rule information for the current control implementation being written out in this context
    CatalogInterface._get_all_rules_params_and_vals(context)

    control_ids_in_comp_imp = [
        imp_req.control_id for imp_req in as_list(context.control_implementation.implemented_requirements)
    ]

    for control in self.get_all_controls_from_catalog(True):
        if control.id in control_ids_in_comp_imp:
            new_context = ControlContext.clone(context)
            control_param_dict = ControlInterface.get_control_param_dict(control, False)
            for set_param in as_list(new_context.control_implementation.set_parameters):
                _update_values(set_param)
            for imp_req in as_list(new_context.control_implementation.implemented_requirements):
                if imp_req.control_id == control.id:
                    for set_param in as_list(imp_req.set_parameters):
                        _update_values(set_param)

            if control_param_dict:
                new_context.yaml_header[const.PARAM_VALUES_TAG] = {}
                for key, param in control_param_dict.items():
                    new_context.yaml_header[const.PARAM_VALUES_TAG][key] = none_if_empty(
                        ControlInterface.param_to_str(param, ParameterRep.VALUE_OR_EMPTY_STRING)
                    )

            self._write_control_into_dir(new_context, control, part_id_map, [])
write_catalog_as_markdown(self, context, part_id_map) ¤

Write out the catalog controls from dict as markdown files to the specified directory.

Parameters:

Name Type Description Default
context ControlContext

The context of the catalog markdown creation.

required
part_id_map Dict[str, Dict[str, str]]

Mapping of part_id to label for all controls

required

Returns:

Type Description
None

None

Source code in trestle/core/catalog_interface.py
def write_catalog_as_markdown(self, context: ControlContext, part_id_map: Dict[str, Dict[str, str]]) -> None:
    """
    Write out the catalog controls from dict as markdown files to the specified directory.

    Args:
        context: The context of the catalog markdown creation.
        part_id_map: Mapping of part_id to label for all controls

    Returns:
        None
    """
    # create the directory in which to write the control markdown files
    context.md_root.mkdir(exist_ok=True, parents=True)

    if context.purpose == ContextPurpose.PROFILE:
        self.write_catalog_as_profile_markdown(context, part_id_map)
    elif context.purpose == ContextPurpose.COMPONENT:
        self.write_catalog_as_component_markdown(context, part_id_map)
    elif context.purpose == ContextPurpose.SSP:
        self.write_catalog_as_ssp_markdown(context, part_id_map)
    else:
        self.write_catalog_as_catalog(context, part_id_map)

    # prune any directories that have no markdown files
    prune_empty_dirs(context.md_root, '*.md')
write_catalog_as_profile_markdown(self, context, part_id_map) ¤

Write out the catalog as profile markdown.

Source code in trestle/core/catalog_interface.py
def write_catalog_as_profile_markdown(
    self, context: ControlContext, part_id_map: Dict[str, Dict[str, str]]
) -> None:
    """Write out the catalog as profile markdown."""
    required_section_list = context.required_sections.split(',') if context.required_sections else []
    allowed_section_list = context.allowed_sections.split(',') if context.allowed_sections else []

    # Get the list of params for this profile from its set_params
    # this is just from the set_params
    full_param_dict = CatalogInterface._get_full_profile_param_dict(context.profile)

    label_map = self.get_statement_part_id_map(True)
    found_alters, _, _ = CatalogInterface.read_additional_content(
        context.md_root, required_section_list, label_map, context.sections_dict, context.to_markdown
    )

    # write out the controls
    for control in self.get_all_controls_from_catalog(True):
        # here we do special handling of how set-parameters merge with the yaml header
        new_context = ControlContext.clone(context)
        if new_context.inherited_props:
            inherited_props = new_context.inherited_props.get(control.id, None)
            if inherited_props:
                # build set in order of list so that duplicates will have final value stick, then convert to list
                unique_props = list({prop['name']: prop for prop in inherited_props}.values())
                new_context.yaml_header[const.TRESTLE_INHERITED_PROPS_TAG] = unique_props
        # get all params and vals for this control from the resolved profile catalog with block adds in effect
        control_param_dict = ControlInterface.get_control_param_dict(control, False)
        set_param_dict: Dict[str, str] = {}
        for param_id, param_dict in control_param_dict.items():
            # if the param is in the full_param_dict, load its contents first and mark as profile-values
            display_name = ''
            if param_id in full_param_dict:
                # get the param from the profile set_param
                param = full_param_dict[param_id]
                display_name, _ = CatalogInterface._get_display_name_and_ns(param)
                # assign its contents to the dict
                new_dict = ModelUtils.parameter_to_dict(param, True)
                if const.VALUES in new_dict:
                    new_dict[const.PROFILE_VALUES] = new_dict[const.VALUES]
                    new_dict.pop(const.VALUES)
                # then insert the original, incoming values as values
                if param_id in control_param_dict:
                    orig_param = control_param_dict[param_id]
                    orig_dict = ModelUtils.parameter_to_dict(orig_param, True)
                    # pull only the values from the actual control dict
                    # all the other elements are from the profile set_param
                    new_dict[const.VALUES] = orig_dict.get(const.VALUES, None)
            else:
                # if the profile doesnt change this param at all, show it in the header with values
                tmp_dict = ModelUtils.parameter_to_dict(param_dict, True)
                values = tmp_dict.get('values', None)
                new_dict = {'id': param_id, 'values': values}
            new_dict.pop('id', None)
            if display_name:
                new_dict[const.DISPLAY_NAME] = display_name
            set_param_dict[param_id] = new_dict
        if set_param_dict:
            if const.SET_PARAMS_TAG not in new_context.yaml_header:
                new_context.yaml_header[const.SET_PARAMS_TAG] = {}
            if new_context.overwrite_header_values:
                # update the control params with new values
                for key, value in new_context.yaml_header[const.SET_PARAMS_TAG].items():
                    if key in control_param_dict:
                        set_param_dict[key] = value
            else:
                # update the control params with any values in yaml header not set in control
                # need to maintain order in the set_param_dict
                for key, value in new_context.yaml_header[const.SET_PARAMS_TAG].items():
                    if key in control_param_dict and key not in set_param_dict:
                        set_param_dict[key] = value
            new_context.yaml_header[const.SET_PARAMS_TAG] = set_param_dict
        elif const.SET_PARAMS_TAG in new_context.yaml_header:
            # need to cull any params that are not in control
            pop_list: List[str] = []
            for key in new_context.yaml_header[const.SET_PARAMS_TAG].keys():
                if key not in control_param_dict:
                    pop_list.append(key)
            for pop in pop_list:
                new_context.yaml_header[const.SET_PARAMS_TAG].pop(pop)

        new_context.required_sections = required_section_list
        new_context.allowed_sections = allowed_section_list
        found_control_alters = [alter for alter in found_alters if alter.control_id == control.id]

        self._write_control_into_dir(new_context, control, part_id_map, found_control_alters)
write_catalog_as_ssp_markdown(self, context, part_id_map) ¤

Write out the catalog as component markdown.

Source code in trestle/core/catalog_interface.py
def write_catalog_as_ssp_markdown(self, context: ControlContext, part_id_map: Dict[str, Dict[str, str]]) -> None:
    """Write out the catalog as component markdown."""
    # in component mode get rules, params, and param values from the current control_implementation
    # the catalog is written out in pieces per control_imp
    allowed_section_list = context.allowed_sections.split(',') if context.allowed_sections else []

    # write out the controls
    for control in self.get_all_controls_from_catalog(True):
        # here we do special handling of how set-parameters merge with the yaml header
        new_context = ControlContext.clone(context)
        new_context.allowed_sections = allowed_section_list

        self._write_control_into_dir(new_context, control, part_id_map, [])

handler: python