leveraged_statements

trestle.core.crm.leveraged_statements

Handle writing of inherited statements to markdown.

component_mapping_default: List[Dict[str, str]]

logger

Classes

InheritanceInfo dataclass

Class to capture component inheritance information.

Source code in trestle/core/crm/leveraged_statements.py

@dataclass
class InheritanceInfo:
    """Class to capture component inheritance information."""

    leveraging_comp_titles: List[str]
    inherited: Optional[ssp.Inherited]
    satisfied: Optional[ssp.Satisfied]

inherited: Optional[trestle.oscal.ssp.Inherited] dataclass-field

leveraging_comp_titles: List[str] dataclass-field

satisfied: Optional[trestle.oscal.ssp.Satisfied] dataclass-field

__eq__(self, other) special

__init__(self, leveraging_comp_titles, inherited, satisfied) special

__repr__(self) special

InheritanceMarkdownReader

Class to read leveraged statement information from Markdown.

Source code in trestle/core/crm/leveraged_statements.py

class InheritanceMarkdownReader:
    """Class to read leveraged statement information from Markdown."""

    def __init__(self, leveraged_statement_file: pathlib.Path) -> None:
        """Initialize the class."""
        # Save the file name for logging
        self._leveraged_statement_file = leveraged_statement_file

        md_api: MarkdownAPI = MarkdownAPI()

        yaml_header, inheritance_md = md_api.processor.process_markdown(leveraged_statement_file)
        self._yaml_header: Dict[str, Any] = yaml_header
        self._inheritance_md: DocsMarkdownNode = inheritance_md

    def process_leveraged_statement_markdown(self) -> Optional[InheritanceInfo]:
        """
        Read inheritance information from Markdown.

        Returns:
            Optional InheritanceInfo - A list of mapped component titles, an optional satisfied statement and an
            optional inherited statement

        Notes:
            Returns inheritance information in the context of the leveraging SSP. If no leveraging component titles are
            mapped in the yaml header None will be returned. The satisfied and inherited fields are
            generated and returned to added information to by-component assemblies for
            the mapped leveraging components.

        """
        leveraging_comps: List[str] = []
        inherited_statement: Optional[ssp.Inherited] = None
        satisfied_statement: Optional[ssp.Satisfied] = None

        leveraging_comp_header_value: List[Dict[str, str]] = self._yaml_header[const.TRESTLE_LEVERAGING_COMP_TAG]

        # If there are no mapped components, return early
        if not leveraging_comp_header_value or leveraging_comp_header_value == component_mapping_default:
            return None
        else:
            for comp_dicts in leveraging_comp_header_value:
                for comp_title in comp_dicts.values():
                    leveraging_comps.append(comp_title)

        statement_info: Dict[str, str] = self._yaml_header[const.TRESTLE_STATEMENT_TAG]

        if const.PROVIDED_UUID in statement_info:
            # Set inherited

            provided_description = self.get_provided_description()
            if provided_description is None:
                raise TrestleError(f'Provided statement cannot be empty in {self._leveraged_statement_file}')

            inherited_statement = gens.generate_sample_model(ssp.Inherited)

            inherited_statement.description = provided_description
            inherited_statement.provided_uuid = statement_info[const.PROVIDED_UUID]

        if const.RESPONSIBILITY_UUID in statement_info:
            # Set satisfied
            satisfied_description = self.get_satisfied_description()
            if satisfied_description is None:
                raise TrestleError(f'Satisfied statement cannot be empty in {self._leveraged_statement_file}')

            satisfied_statement = gens.generate_sample_model(ssp.Satisfied)

            satisfied_statement.description = satisfied_description
            satisfied_statement.responsibility_uuid = statement_info[const.RESPONSIBILITY_UUID]

        return InheritanceInfo(leveraging_comps, inherited_statement, satisfied_statement)

    def get_leveraged_ssp_reference(self) -> str:
        """Return the leveraged SSP reference in the yaml header."""
        return self._yaml_header[const.TRESTLE_GLOBAL_TAG][const.LEVERAGED_SSP][const.HREF]

    def get_satisfied_description(self) -> Optional[str]:
        """Return the satisfied description in the Markdown."""
        node = self._inheritance_md.get_node_for_key(const.SATISFIED_STATEMENT_DESCRIPTION, False)
        if node is not None:
            return self.strip_heading_and_comments(node.content.raw_text)
        else:
            return None

    def get_provided_description(self) -> Optional[str]:
        """Return the provided description in the Markdown."""
        node = self._inheritance_md.get_node_for_key(const.PROVIDED_STATEMENT_DESCRIPTION, False)
        if node is not None:
            return self.strip_heading_and_comments(node.content.raw_text)
        else:
            return None

    def get_leveraged_component_header_value(self) -> Dict[str, str]:
        """Provide the leveraged component value in the yaml header."""
        return self._yaml_header[const.TRESTLE_LEVERAGING_COMP_TAG]

    @staticmethod
    def strip_heading_and_comments(markdown_text: str) -> str:
        """Remove the heading and comments from lines to get the multi-line paragraph."""
        lines = markdown_text.split('\n')
        non_heading_comment_lines = []
        inside_heading = False
        inside_comment = False

        for line in lines:
            if line.startswith('#'):
                inside_heading = True
            elif line.startswith('<!--'):
                inside_comment = True
                if line.rstrip().endswith('-->'):
                    inside_comment = False
                continue
            elif line.strip() == '':
                inside_heading = False
                inside_comment = False

            if not inside_heading and not inside_comment:
                non_heading_comment_lines.append(line)

        stripped_markdown = '\n'.join(non_heading_comment_lines).strip()
        return stripped_markdown

Methods

__init__(self, leveraged_statement_file) special

Initialize the class.

Source code in trestle/core/crm/leveraged_statements.py

def __init__(self, leveraged_statement_file: pathlib.Path) -> None:
    """Initialize the class."""
    # Save the file name for logging
    self._leveraged_statement_file = leveraged_statement_file

    md_api: MarkdownAPI = MarkdownAPI()

    yaml_header, inheritance_md = md_api.processor.process_markdown(leveraged_statement_file)
    self._yaml_header: Dict[str, Any] = yaml_header
    self._inheritance_md: DocsMarkdownNode = inheritance_md

get_leveraged_component_header_value(self)

Provide the leveraged component value in the yaml header.

Source code in trestle/core/crm/leveraged_statements.py

def get_leveraged_component_header_value(self) -> Dict[str, str]:
    """Provide the leveraged component value in the yaml header."""
    return self._yaml_header[const.TRESTLE_LEVERAGING_COMP_TAG]

get_leveraged_ssp_reference(self)

Return the leveraged SSP reference in the yaml header.

Source code in trestle/core/crm/leveraged_statements.py

def get_leveraged_ssp_reference(self) -> str:
    """Return the leveraged SSP reference in the yaml header."""
    return self._yaml_header[const.TRESTLE_GLOBAL_TAG][const.LEVERAGED_SSP][const.HREF]

get_provided_description(self)

Return the provided description in the Markdown.

Source code in trestle/core/crm/leveraged_statements.py

def get_provided_description(self) -> Optional[str]:
    """Return the provided description in the Markdown."""
    node = self._inheritance_md.get_node_for_key(const.PROVIDED_STATEMENT_DESCRIPTION, False)
    if node is not None:
        return self.strip_heading_and_comments(node.content.raw_text)
    else:
        return None

get_satisfied_description(self)

Return the satisfied description in the Markdown.

Source code in trestle/core/crm/leveraged_statements.py

def get_satisfied_description(self) -> Optional[str]:
    """Return the satisfied description in the Markdown."""
    node = self._inheritance_md.get_node_for_key(const.SATISFIED_STATEMENT_DESCRIPTION, False)
    if node is not None:
        return self.strip_heading_and_comments(node.content.raw_text)
    else:
        return None

process_leveraged_statement_markdown(self)

Read inheritance information from Markdown.

Returns:

Type	Description
Optional[trestle.core.crm.leveraged_statements.InheritanceInfo]	Optional InheritanceInfo - A list of mapped component titles, an optional satisfied statement and an optional inherited statement

Notes

Returns inheritance information in the context of the leveraging SSP. If no leveraging component titles are mapped in the yaml header None will be returned. The satisfied and inherited fields are generated and returned to added information to by-component assemblies for the mapped leveraging components.

Source code in trestle/core/crm/leveraged_statements.py

def process_leveraged_statement_markdown(self) -> Optional[InheritanceInfo]:
    """
    Read inheritance information from Markdown.

    Returns:
        Optional InheritanceInfo - A list of mapped component titles, an optional satisfied statement and an
        optional inherited statement

    Notes:
        Returns inheritance information in the context of the leveraging SSP. If no leveraging component titles are
        mapped in the yaml header None will be returned. The satisfied and inherited fields are
        generated and returned to added information to by-component assemblies for
        the mapped leveraging components.

    """
    leveraging_comps: List[str] = []
    inherited_statement: Optional[ssp.Inherited] = None
    satisfied_statement: Optional[ssp.Satisfied] = None

    leveraging_comp_header_value: List[Dict[str, str]] = self._yaml_header[const.TRESTLE_LEVERAGING_COMP_TAG]

    # If there are no mapped components, return early
    if not leveraging_comp_header_value or leveraging_comp_header_value == component_mapping_default:
        return None
    else:
        for comp_dicts in leveraging_comp_header_value:
            for comp_title in comp_dicts.values():
                leveraging_comps.append(comp_title)

    statement_info: Dict[str, str] = self._yaml_header[const.TRESTLE_STATEMENT_TAG]

    if const.PROVIDED_UUID in statement_info:
        # Set inherited

        provided_description = self.get_provided_description()
        if provided_description is None:
            raise TrestleError(f'Provided statement cannot be empty in {self._leveraged_statement_file}')

        inherited_statement = gens.generate_sample_model(ssp.Inherited)

        inherited_statement.description = provided_description
        inherited_statement.provided_uuid = statement_info[const.PROVIDED_UUID]

    if const.RESPONSIBILITY_UUID in statement_info:
        # Set satisfied
        satisfied_description = self.get_satisfied_description()
        if satisfied_description is None:
            raise TrestleError(f'Satisfied statement cannot be empty in {self._leveraged_statement_file}')

        satisfied_statement = gens.generate_sample_model(ssp.Satisfied)

        satisfied_statement.description = satisfied_description
        satisfied_statement.responsibility_uuid = statement_info[const.RESPONSIBILITY_UUID]

    return InheritanceInfo(leveraging_comps, inherited_statement, satisfied_statement)

strip_heading_and_comments(markdown_text) staticmethod

Remove the heading and comments from lines to get the multi-line paragraph.

Source code in trestle/core/crm/leveraged_statements.py

@staticmethod
def strip_heading_and_comments(markdown_text: str) -> str:
    """Remove the heading and comments from lines to get the multi-line paragraph."""
    lines = markdown_text.split('\n')
    non_heading_comment_lines = []
    inside_heading = False
    inside_comment = False

    for line in lines:
        if line.startswith('#'):
            inside_heading = True
        elif line.startswith('<!--'):
            inside_comment = True
            if line.rstrip().endswith('-->'):
                inside_comment = False
            continue
        elif line.strip() == '':
            inside_heading = False
            inside_comment = False

        if not inside_heading and not inside_comment:
            non_heading_comment_lines.append(line)

    stripped_markdown = '\n'.join(non_heading_comment_lines).strip()
    return stripped_markdown

LeveragedStatements (ABC)

Abstract class for managing leveraged statements.

Source code in trestle/core/crm/leveraged_statements.py

class LeveragedStatements(ABC):
    """Abstract class for managing leveraged statements."""

    def __init__(self, leveraged_ssp_reference: str) -> None:
        """Initialize the class."""
        self._md_file: Optional[MDWriter] = None
        self.header_comment_dict: Dict[str, str] = {
            const.TRESTLE_LEVERAGING_COMP_TAG: const.YAML_LEVERAGING_COMP_COMMENT,
            const.TRESTLE_STATEMENT_TAG: const.YAML_LEVERAGED_COMMENT
        }
        self.merged_header_dict: Dict[str, Any] = {
            const.TRESTLE_STATEMENT_TAG: '',
            const.TRESTLE_LEVERAGING_COMP_TAG: component_mapping_default,
            const.TRESTLE_GLOBAL_TAG: {
                const.LEVERAGED_SSP: {
                    const.HREF: leveraged_ssp_reference
                }
            }
        }

    @abstractmethod
    def write_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
        """Write inheritance information to a single markdown file."""

Methods

__init__(self, leveraged_ssp_reference) special

Initialize the class.

Source code in trestle/core/crm/leveraged_statements.py

def __init__(self, leveraged_ssp_reference: str) -> None:
    """Initialize the class."""
    self._md_file: Optional[MDWriter] = None
    self.header_comment_dict: Dict[str, str] = {
        const.TRESTLE_LEVERAGING_COMP_TAG: const.YAML_LEVERAGING_COMP_COMMENT,
        const.TRESTLE_STATEMENT_TAG: const.YAML_LEVERAGED_COMMENT
    }
    self.merged_header_dict: Dict[str, Any] = {
        const.TRESTLE_STATEMENT_TAG: '',
        const.TRESTLE_LEVERAGING_COMP_TAG: component_mapping_default,
        const.TRESTLE_GLOBAL_TAG: {
            const.LEVERAGED_SSP: {
                const.HREF: leveraged_ssp_reference
            }
        }
    }

write_statement_md(self, leveraged_statement_file)

Write inheritance information to a single markdown file.

Source code in trestle/core/crm/leveraged_statements.py

@abstractmethod
def write_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
    """Write inheritance information to a single markdown file."""

StatementProvided (LeveragedStatements)

Concrete class for managing provided statements.

Source code in trestle/core/crm/leveraged_statements.py

class StatementProvided(LeveragedStatements):
    """Concrete class for managing provided statements."""

    def __init__(
        self,
        provided_uuid: str,
        provided_description: str,
        leveraged_ssp_reference: str,
    ) -> None:
        """Initialize the class."""
        self.provided_uuid = provided_uuid
        self.provided_description = provided_description
        super().__init__(leveraged_ssp_reference)

    def write_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
        """Write provided statements to a markdown file."""
        self._md_file = MDWriter(leveraged_statement_file, self.header_comment_dict)

        if self._md_file.exists():
            return self.update_statement_md(leveraged_statement_file)

        self._add_generated_content()
        self._md_file.write_out()

    def update_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
        """Update provided statements in a markdown file."""
        md_reader = InheritanceMarkdownReader(leveraged_statement_file)

        self.merged_header_dict[const.TRESTLE_LEVERAGING_COMP_TAG] = md_reader.get_leveraged_component_header_value()

        self._add_generated_content()
        self._md_file.write_out()

    def _add_generated_content(self) -> None:
        self.merged_header_dict[const.TRESTLE_STATEMENT_TAG] = {const.PROVIDED_UUID: self.provided_uuid}
        self._md_file.add_yaml_header(self.merged_header_dict)

        self._md_file.new_header(level=1, title=const.PROVIDED_STATEMENT_DESCRIPTION)
        self._md_file.new_line(self.provided_description)

Methods

__init__(self, provided_uuid, provided_description, leveraged_ssp_reference) special

Source code in trestle/core/crm/leveraged_statements.py

def __init__(
    self,
    provided_uuid: str,
    provided_description: str,
    leveraged_ssp_reference: str,
) -> None:
    """Initialize the class."""
    self.provided_uuid = provided_uuid
    self.provided_description = provided_description
    super().__init__(leveraged_ssp_reference)

update_statement_md(self, leveraged_statement_file)

Update provided statements in a markdown file.

Source code in trestle/core/crm/leveraged_statements.py

def update_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
    """Update provided statements in a markdown file."""
    md_reader = InheritanceMarkdownReader(leveraged_statement_file)

    self.merged_header_dict[const.TRESTLE_LEVERAGING_COMP_TAG] = md_reader.get_leveraged_component_header_value()

    self._add_generated_content()
    self._md_file.write_out()

write_statement_md(self, leveraged_statement_file)

Write provided statements to a markdown file.

Source code in trestle/core/crm/leveraged_statements.py

def write_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
    """Write provided statements to a markdown file."""
    self._md_file = MDWriter(leveraged_statement_file, self.header_comment_dict)

    if self._md_file.exists():
        return self.update_statement_md(leveraged_statement_file)

    self._add_generated_content()
    self._md_file.write_out()

StatementResponsibility (LeveragedStatements)

Concrete class for managing responsibility statements.

Source code in trestle/core/crm/leveraged_statements.py

class StatementResponsibility(LeveragedStatements):
    """Concrete class for managing responsibility statements."""

    def __init__(
        self,
        responsibility_uuid: str,
        responsibility_description: str,
        leveraged_ssp_reference: str,
    ) -> None:
        """Initialize the class."""
        self.responsibility_uuid = responsibility_uuid
        self.responsibility_description = responsibility_description
        self.satisfied_description = ''
        super().__init__(leveraged_ssp_reference)

    def write_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
        """Write responsibility statements to a markdown file."""
        self._md_file = MDWriter(leveraged_statement_file, self.header_comment_dict)

        if self._md_file.exists():
            return self.update_statement_md(leveraged_statement_file)

        self._add_generated_content()
        self._md_file.write_out()

    def update_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
        """Update responsibility statements in a markdown file."""
        md_reader = InheritanceMarkdownReader(leveraged_statement_file)

        self.merged_header_dict[const.TRESTLE_LEVERAGING_COMP_TAG] = md_reader.get_leveraged_component_header_value()

        satisfied_description = md_reader.get_satisfied_description()
        if satisfied_description is not None:
            self.satisfied_description = satisfied_description

        self._add_generated_content()
        self._md_file.write_out()

    def _add_generated_content(self) -> None:
        self.merged_header_dict[const.TRESTLE_STATEMENT_TAG] = {const.RESPONSIBILITY_UUID: self.responsibility_uuid}
        self._md_file.add_yaml_header(self.merged_header_dict)

        self._md_file.new_header(level=1, title=const.RESPONSIBILITY_STATEMENT_DESCRIPTION)
        self._md_file.new_line(self.responsibility_description)
        self._md_file.new_header(level=1, title=const.SATISFIED_STATEMENT_DESCRIPTION)
        self._md_file.new_line(const.SATISFIED_STATEMENT_COMMENT)
        self._md_file.new_line(self.satisfied_description)

Methods

__init__(self, responsibility_uuid, responsibility_description, leveraged_ssp_reference) special

Source code in trestle/core/crm/leveraged_statements.py

def __init__(
    self,
    responsibility_uuid: str,
    responsibility_description: str,
    leveraged_ssp_reference: str,
) -> None:
    """Initialize the class."""
    self.responsibility_uuid = responsibility_uuid
    self.responsibility_description = responsibility_description
    self.satisfied_description = ''
    super().__init__(leveraged_ssp_reference)

update_statement_md(self, leveraged_statement_file)

Update responsibility statements in a markdown file.

Source code in trestle/core/crm/leveraged_statements.py

def update_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
    """Update responsibility statements in a markdown file."""
    md_reader = InheritanceMarkdownReader(leveraged_statement_file)

    self.merged_header_dict[const.TRESTLE_LEVERAGING_COMP_TAG] = md_reader.get_leveraged_component_header_value()

    satisfied_description = md_reader.get_satisfied_description()
    if satisfied_description is not None:
        self.satisfied_description = satisfied_description

    self._add_generated_content()
    self._md_file.write_out()

write_statement_md(self, leveraged_statement_file)

Write responsibility statements to a markdown file.

Source code in trestle/core/crm/leveraged_statements.py

def write_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
    """Write responsibility statements to a markdown file."""
    self._md_file = MDWriter(leveraged_statement_file, self.header_comment_dict)

    if self._md_file.exists():
        return self.update_statement_md(leveraged_statement_file)

    self._add_generated_content()
    self._md_file.write_out()

StatementTree (LeveragedStatements)

Concrete class for managing provided and responsibility statements.

Source code in trestle/core/crm/leveraged_statements.py

class StatementTree(LeveragedStatements):
    """Concrete class for managing provided and responsibility statements."""

    def __init__(
        self,
        provided_uuid: str,
        provided_description: str,
        responsibility_uuid: str,
        responsibility_description: str,
        leveraged_ssp_reference: str
    ) -> None:
        """Initialize the class."""
        self.provided_uuid = provided_uuid
        self.provided_description = provided_description
        self.responsibility_uuid = responsibility_uuid
        self.responsibility_description = responsibility_description
        self.satisfied_description = ''
        super().__init__(leveraged_ssp_reference)

    def write_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
        """Write a provided and responsibility statements to a markdown file."""
        self._md_file = MDWriter(leveraged_statement_file, self.header_comment_dict)

        if self._md_file.exists():
            return self.update_statement_md(leveraged_statement_file)

        self._add_generated_content()
        self._md_file.write_out()

    def update_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
        """Update provided and responsibility statements in a markdown file."""
        md_reader = InheritanceMarkdownReader(leveraged_statement_file)

        self.merged_header_dict[const.TRESTLE_LEVERAGING_COMP_TAG] = md_reader.get_leveraged_component_header_value()

        satisfied_description = md_reader.get_satisfied_description()
        if satisfied_description is not None:
            self.satisfied_description = satisfied_description

        self._add_generated_content()
        self._md_file.write_out()

    def _add_generated_content(self) -> None:
        statement_dict: Dict[str, str] = {
            const.PROVIDED_UUID: self.provided_uuid, const.RESPONSIBILITY_UUID: self.responsibility_uuid
        }

        self.merged_header_dict[const.TRESTLE_STATEMENT_TAG] = statement_dict
        self._md_file.add_yaml_header(self.merged_header_dict)

        self._md_file.new_header(level=1, title=const.PROVIDED_STATEMENT_DESCRIPTION)
        self._md_file.new_line(self.provided_description)
        self._md_file.new_header(level=1, title=const.RESPONSIBILITY_STATEMENT_DESCRIPTION)
        self._md_file.new_line(self.responsibility_description)
        self._md_file.new_header(level=1, title=const.SATISFIED_STATEMENT_DESCRIPTION)
        self._md_file.new_line(const.SATISFIED_STATEMENT_COMMENT)
        self._md_file.new_line(self.satisfied_description)

Methods

__init__(self, provided_uuid, provided_description, responsibility_uuid, responsibility_description, leveraged_ssp_reference) special

Source code in trestle/core/crm/leveraged_statements.py

def __init__(
    self,
    provided_uuid: str,
    provided_description: str,
    responsibility_uuid: str,
    responsibility_description: str,
    leveraged_ssp_reference: str
) -> None:
    """Initialize the class."""
    self.provided_uuid = provided_uuid
    self.provided_description = provided_description
    self.responsibility_uuid = responsibility_uuid
    self.responsibility_description = responsibility_description
    self.satisfied_description = ''
    super().__init__(leveraged_ssp_reference)

update_statement_md(self, leveraged_statement_file)

Update provided and responsibility statements in a markdown file.

Source code in trestle/core/crm/leveraged_statements.py

def update_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
    """Update provided and responsibility statements in a markdown file."""
    md_reader = InheritanceMarkdownReader(leveraged_statement_file)

    self.merged_header_dict[const.TRESTLE_LEVERAGING_COMP_TAG] = md_reader.get_leveraged_component_header_value()

    satisfied_description = md_reader.get_satisfied_description()
    if satisfied_description is not None:
        self.satisfied_description = satisfied_description

    self._add_generated_content()
    self._md_file.write_out()

write_statement_md(self, leveraged_statement_file)

Write a provided and responsibility statements to a markdown file.

Source code in trestle/core/crm/leveraged_statements.py

def write_statement_md(self, leveraged_statement_file: pathlib.Path) -> None:
    """Write a provided and responsibility statements to a markdown file."""
    self._md_file = MDWriter(leveraged_statement_file, self.header_comment_dict)

    if self._md_file.exists():
        return self.update_statement_md(leveraged_statement_file)

    self._add_generated_content()
    self._md_file.write_out()

handler: python