feat: add inheritance view to ssp-generate and ssp-assemble #1441

jpower432 · 2023-08-28T19:03:04Z

Types of changes

New feature (non-breaking change which adds functionality)
Documentation (change which affects the documentation site)

Quality assurance (all should be covered).

My code follows the code style of this project.
Documentation for my change is up to date?
My PR meets testing requirements.
All new and existing tests passed.
All commits are signed-off.

Summary

Adds an inheritance view to the generated trestle markdown that allows exported provided and responsibility statements to from a leveraged SSP to be used.

Closes #1398
Closes #1393

Filter written controls in inheritance view by profile passed to ssp-generate
Ensure unimplemented statements are present after ssp-assemble

Assumptions/Constraints

This assumes that the control exists within the control implementation of the SSP and edits the existing implemented requirements. It will edit or add by-component assemblies with the information.
The responsibility uuid can only occur once in the satisfied array and the provided uuid can only occur once in the inherited array.
This assumes that if no leveraging components are mapped to a leveraged component that the authorization is not leveraged (i.e. the leveraged authorization section will not be present)

What this does not do

Requesting to iterate in follow on PRs

This does not does remove files in the markdown directory for provided or responsibility exported statements with changed uuids (i.e. does not delete exports no longer referenced)
This does not accept more than one leveraged ssp

Key links:

Sonar coverage

Before you merge

Ensure it is a 'squash commit' if not a release.
Ensure CI is currently passing
Check sonar. If you are working for a fork a maintainer will reach out, if required.

…component Adds ExportInterface and ExportWriter classes Adds Markdown generation to ssp-generate Add MarkdownWriter for leveraged statements Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com> Signed-off-by: Alex Flom <alexander.flom@gmail.com>

…markdown Adds InheritanceMarkdownReader for processing into a leveraging SSP context Adds persistance for components and satisified statements during updates Changes leveraging component from a single dictionary to a list Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

Adds ExportReader class Removes ExportInterface class Adds a single ByComponentInterface class to interact with the model in terms of inheritance Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com> Co-authored-by: Jennifer Power <barnabei.jennifer@gmail.com>

… inheritance Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

…ader Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

…ve regex Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

…aged_ssp Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

…eritance view Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

Adds SSPInheritanceAPI class for interacting with leveraged auth information Adds trestle global tags to markdown to store SSP location info Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com> Co-authored-by: Alex Flom <alexander.flom@gmail.com>

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

jpower432 · 2023-09-28T21:43:13Z

@AleJo2995 @vikas-agarwal76 Added you both as reviewers to get your thoughts on this approach. We added enough here to address the two linked issues and get to the point where we can complete additional testing, so the scope of this feature should not increase. Thanks in advance!

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

degenaro · 2023-10-17T14:25:18Z

Perhaps these pre-existed, but sonar says there are 3 code smells https://sonarcloud.io/project/issues?resolved=false&types=CODE_SMELL&sinceLeakPeriod=true&pullRequest=1441&id=compliance-trestle

Not essential that these get fixed, but it would be nice...

jpower432 · 2023-10-17T14:44:03Z

trestle/core/commands/author/ssp.py

@@ -519,10 +563,18 @@ def _run(self, args: argparse.Namespace) -> int:
                    raise TrestleError('Original ssp has no system component.')
                comp_dict[const.SSP_MAIN_COMP_NAME] = sys_comp

+                ssp_sys_imp_comps = ssp.system_implementation.components


@vikas-agarwal76 Just wanted to call out this logic specifically. This is really the only change to ssp-assemble that was made that could affect the current workflow. Though it would only apply to a leveraging SSP. All other changes are processed conditionally when the leveraged-ssp flag is used (generate) or the inheritance markdown is present (assemble).

vikas-agarwal76

Small changes.

docs/tutorials/ssp_profile_catalog_authoring/ssp_profile_catalog_authoring.md

tests/trestle/core/crm/exports_reader_test.py

tests/trestle/core/crm/exports_writer_test.py

trestle/core/commands/author/ssp.py

trestle/core/crm/bycomp_interface.py

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

jpower432 · 2023-10-27T20:35:18Z

Perhaps these pre-existed, but sonar says there are 3 code smells https://sonarcloud.io/project/issues?resolved=false&types=CODE_SMELL&sinceLeakPeriod=true&pullRequest=1441&id=compliance-trestle

Not essential that these get fixed, but it would be nice...

@degenaro Working through these. I believe only one was pre-existing.

jpower432 · 2023-10-31T14:31:27Z

@vikas-agarwal76 Changes addressing your feedback added on this commit - a10ba54. Please let me know if there are any additional changes or feedback.

vikas-agarwal76

LGTM

jpower432 · 2023-11-07T15:54:56Z

Thanks @vikas-agarwal76. Just wanted to confirm with you, @AleJo2995, and @degenaro, are there any other actions that need to be taken before merge? Thanks in advance!

Alex Flom and others added 22 commits August 28, 2023 14:41

docs: updates documentation with usage and API references updates for…

7c572ff

… inheritance Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

chore: updates AgileAuthoring class for ssp-generate arg changes

2f7f217

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

docs: updates returns section in InheritanceMarkdownReader docstring

e6897af

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

fix: updates line length on return statement in InheritanceMarkdownRe…

db08a0f

…ader Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

refactor: updates markdown heading and comment strip function to remo…

01a5a33

…ve regex Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

test: adds inheritance view testing for ssp-assemble

3e1ce19

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

chore: adds more context to ExportReader class comments

33119d5

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

Merge branch 'develop' into feat/add-inheritance-view

7fd10e8

feat: updates ssp-generate to filter control implementation for lever…

8baa8bb

…aged_ssp Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

refactor: updates ExportWriter to reduce code duplication

59dbaa5

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

fix: updates ExportReader to add new statements if present in the inh…

b1d438e

…eritance view Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

fix: update logging to debug in ExportReader

80b41e7

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

Merge branch 'develop' into feat/add-inheritance-view

7ce56f3

refactor: simplify code in read_exports_from_markdown

27b28e6

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

tests: simplify tests for ExportReader test data generation

d78567e

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

refactor: reduce code duplication in ExportReader methods

648085d

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

fix: allows inheritance info to be removed when component is unmapped

6de26a1

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

docs: add docs updates for SSPInheritanceAPI class

f87e467

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

jpower432 requested review from AleJo2995 and vikas-agarwal76 September 28, 2023 21:32

jpower432 added 2 commits September 28, 2023 19:06

chore: updates warning message for leveraged authorization with comps

807bb28

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

fix: updates ssp-assemble to ensure existing leveraged comps persist

725f698

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

jpower432 commented Oct 17, 2023

View reviewed changes

vikas-agarwal76 requested changes Oct 25, 2023

View reviewed changes

jpower432 added 2 commits October 27, 2023 13:49

fix: adds fixes to address PR feedback

a10ba54

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

refactor: polishes SSPInheritanceAPI class to reduce complexity

b1f601d

Signed-off-by: Jennifer Power <barnabei.jennifer@gmail.com>

jpower432 requested a review from vikas-agarwal76 October 31, 2023 14:25

jpower432 marked this pull request as ready for review November 1, 2023 17:44

jpower432 changed the title ~~feat: add inheritance view to ssp-generate and ssp-assemble [WIP]~~ feat: add inheritance view to ssp-generate and ssp-assemble Nov 1, 2023

Merge branch 'develop' into feat/add-inheritance-view

5319028

vikas-agarwal76 approved these changes Nov 7, 2023

View reviewed changes

jpower432 merged commit 6cf498b into develop Nov 9, 2023
16 checks passed

jpower432 deleted the feat/add-inheritance-view branch November 9, 2023 14:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add inheritance view to ssp-generate and ssp-assemble #1441

feat: add inheritance view to ssp-generate and ssp-assemble #1441

jpower432 commented Aug 28, 2023 •

edited

jpower432 commented Sep 28, 2023

degenaro commented Oct 17, 2023 •

edited

jpower432 Oct 17, 2023 •

edited

vikas-agarwal76 left a comment

jpower432 commented Oct 27, 2023 •

edited

jpower432 commented Oct 31, 2023

vikas-agarwal76 left a comment

jpower432 commented Nov 7, 2023 •

edited

feat: add inheritance view to ssp-generate and ssp-assemble #1441

feat: add inheritance view to ssp-generate and ssp-assemble #1441

Conversation

jpower432 commented Aug 28, 2023 • edited

Types of changes

Quality assurance (all should be covered).

Summary

Assumptions/Constraints

What this does not do

Key links:

Before you merge

jpower432 commented Sep 28, 2023

degenaro commented Oct 17, 2023 • edited

jpower432 Oct 17, 2023 • edited

Choose a reason for hiding this comment

vikas-agarwal76 left a comment

Choose a reason for hiding this comment

jpower432 commented Oct 27, 2023 • edited

jpower432 commented Oct 31, 2023

vikas-agarwal76 left a comment

Choose a reason for hiding this comment

jpower432 commented Nov 7, 2023 • edited

jpower432 commented Aug 28, 2023 •

edited

degenaro commented Oct 17, 2023 •

edited

jpower432 Oct 17, 2023 •

edited

jpower432 commented Oct 27, 2023 •

edited

jpower432 commented Nov 7, 2023 •

edited