Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CPLYTM-224 OSCAL Profiles organized by level task and command (WIP) #410

Draft
wants to merge 39 commits into
base: main
Choose a base branch
from

Conversation

hbraswelrh
Copy link
Contributor

Description

The sync_cac_content_profile sub-command will provide users with the ability to indicate the control file for use when authoring OSCAL profiles within trestle-bot. This PR will include a task that interacts directly with the CLI to sort the contents of the control files by level. The level indicated is included in the authored OSCAL profile title and is tailored to the baseline. If there is no level associated with the control file, the task will create a single profile with all controls.

Fixes # (issue)

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How has this been tested?

  • Test A
  • Test B

Test Configuration:

  • Firmware version:
  • Hardware:
  • Toolchain:
  • SDK:

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

hbraswelrh and others added 30 commits December 23, 2024 08:16
docs: update README.md emoji placement
@marcusburghardt
Copy link
Contributor

marcusburghardt commented Jan 15, 2025

I saw that many commits are minor incremental updates on the same lines. Considering the number of commits already in this PR, it would be good to squash all these similar minor changes in a single commit to make it easier to review. What do you think?

@hbraswelrh
Copy link
Contributor Author

@marcusburghardt You're absolutely right. I plan on rebasing once the PR is no longer in draft mode.

…n with CLI

feat: updating sync cac content profile task logic

feat: updating CLI options for oscal_profile_cmd

fix: sync profile task execution update

# Conflicts:
#	trestlebot/cli/commands/sync_cac_content.py
#	trestlebot/tasks/sync_cac_content_profile_task.py
 The initial setup for the interaction of the subcommand interacting with the task. The unit tests included testing for invalid subcommand for the `sync_cac_content_cmd`, and missing required click options from the CLI.
docs: updating docstrings for SyncCacContentProfileTask

docs: updating docstrings for SyncCacContentProfileTask
docstrings

The updated docstrings will explain the arguments and return types
associated with the SyncCacContentProfileTask and the `oscal-profile`
sub-command of the `sync-cac-content-cmd`. The unit tests included test for invalid sub-command provided to the `sync_cac_content_cmd`, and missing required click options from the CLI.
@qduanmu
Copy link
Contributor

qduanmu commented Jan 17, 2025

@hbraswelrh I see another PR #419 for CPLYTM-224, is this one deprecated?

@hbraswelrh
Copy link
Contributor Author

@qduanmu Yes, this draft PR is deprecated. The updates for CPLYTM-224 are in the Draft PR #419.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants