Skip to content

Commit

Permalink
fix: adds fixes to address PR feedback
Browse files Browse the repository at this point in the history
Signed-off-by: Jennifer Power <[email protected]>
  • Loading branch information
jpower432 committed Oct 27, 2023
1 parent 725f698 commit a10ba54
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1052,7 +1052,7 @@ If you do not specify component-defintions during assembly, the markdown should

## Inheritance view

The inheritance view is generated by setting the `--leveraged-ssp` flag with `trestle author ssp-generate`. It contains information relating to exported information such as inherited capabilities and consumer responsibilities that can be used to populate the inheritance information in the assembled SSP. When used, a directory named "inheritance" is created within the markdown directory. This directory serves as a designated space for mapping inherited capabilities and responsibilities onto components in the assemble SSP and authoring satisfied statements for responsibilities.
The inheritance view is generated by setting the `--leveraged-ssp` flag with `trestle author ssp-generate`. It contains information relating to exported information such as inherited capabilities and customer responsibilities that can be used to populate the inheritance information in the assembled SSP. When used, a directory named "inheritance" is created within the markdown directory. This directory serves as a designated space for mapping inherited capabilities and responsibilities onto components in the assemble SSP and authoring satisfied statements for responsibilities.

Example usage for creation of the markdown:

Expand Down Expand Up @@ -1105,14 +1105,14 @@ x-trestle-leveraging-comp:

# Provided Statement Description

Consumer_appropriate description of what may be inherited.
Customer_appropriate description of what may be inherited.
```

</details>

<details markdown>

<summary>Example of inheritance consumer responsibility only markdown after ssp-generate</summary>
<summary>Example of inheritance customer responsibility only markdown after ssp-generate</summary>

```markdown
---
Expand Down
6 changes: 3 additions & 3 deletions trestle/core/commands/author/ssp.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,8 @@ def _generate_inheritance_markdown(
Notes:
This will create the inheritance view markdown files in the same directory as the ssp markdown files.
The information will be from the leveraged ssp, but filtered by the chose profile to ensure only relevant
control are present for mapping.
The information will be from the leveraged ssp, but filtered by the chosen profile to ensure only relevant
controls are present for mapping.
"""
# if file not recognized as URI form, assume it represents name of file in trestle directory
ssp_in_trestle_dir = '://' not in leveraged_ssp_name_or_href
Expand Down Expand Up @@ -609,7 +609,7 @@ def _run(self, args: argparse.Namespace) -> int:
# TODO if the ssp already existed then components may need to be removed if not ref'd by imp_reqs
self._generate_roles_in_metadata(ssp)

# If this is a leveraging SSP, update it with the retrieved the exports from the leveraged SSP
# If this is a leveraging SSP, update it with the retrieved exports from the leveraged SSP
inheritance_markdown_path = md_path.joinpath(const.INHERITANCE_VIEW_DIR)
if os.path.exists(inheritance_markdown_path):
SSPInheritanceAPI(inheritance_markdown_path, trestle_root).update_ssp_inheritance(ssp)
Expand Down
4 changes: 2 additions & 2 deletions trestle/core/crm/bycomp_interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class ByComponentInterface:
Interface to query and modify by-component assembly inheritance contents.
The by-component is contained in two separate forms: As an actual OSCAL by-component assembly,
and and multiple dicts providing direct lookup of inheritance statement by uuid.
and multiple dicts providing direct lookup of inheritance statement by uuid.
The dicts are created by the ByComponentInterface constructor, parsed and the responsibility and provided statements
are separated into three catagories:
Expand Down Expand Up @@ -133,7 +133,7 @@ def reconcile_inheritance_by_component(
Reconcile the inherited and satisfied statements in the by-component assembly with changes from the export.
Notes:
A statement is determined as existing if the provided uuid or responsibility uuid is in the existing in the
A statement is determined as existing if the provided uuid or responsibility uuid is in the existing
by-component assembly. If existing, the description will be updated if it has changed.
Any existing inherited or satisfied statements that are not in the incoming export will be removed.
Expand Down

0 comments on commit a10ba54

Please sign in to comment.