Skip to content

include omitted evaluation detail to reports #684

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

Merged
merged 9 commits into from
May 15, 2025
Merged

Conversation

isabella-mont
Copy link
Collaborator

@isabella-mont isabella-mont commented Apr 22, 2025

🗣 Description

Updates the rego_json_to_ind_reports method to include two new fields in the JSON reports: OmittedEvaluationResults and OmittedEvaluationDetails

💭 Motivation and context

Closes #520

🧪 Testing

Ran ScubaGoggles using omitted sample policy using the following command:
python scuba.py gws --subjectemail="email" --config scubagoggles\sample-config-files\omit_policies.yaml

Then checked the generated ScubaResults.json file to verify that the OmittedEvaluationResults and OmittedEvaluationDetails fields appear correctly

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • If applicable, All future TODOs are captured in issues, which are referenced in the PR description.
  • The relevant issues PR resolves are linked preferably via closing keywords.
  • All relevant type-of-change labels have been added.
  • I have read and agree to the CONTRIBUTING.md document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • All new and existing tests pass.

✅ Pre-merge Checklist

  • This PR has been smoke tested to ensure main is in a functional state when this PR is merged.
  • Squash all commits into one PR level commit using the Squash and merge button.

✅ Post-merge Checklist

  • Delete the branch to clean up.
  • Close issues resolved by this PR if the closing keywords did not activate.

@isabella-mont isabella-mont requested review from adhilto and snarve April 22, 2025 21:41
@adhilto adhilto added this to the Eel milestone Apr 23, 2025
@buidav buidav mentioned this pull request Apr 24, 2025
14 tasks
@buidav
Copy link
Collaborator

buidav commented Apr 24, 2025

For this PR or perhaps a follow up

OmittedEvaluationResult
OmittedEvaluationDetails

will need to the added to the actionplan.csv output.

#649 (review)

Copy link
Collaborator

@adhilto adhilto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Copy link
Collaborator

@snarve snarve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@adhilto adhilto merged commit 73b0dfa into main May 15, 2025
11 checks passed
@adhilto adhilto deleted the 520-omitted-rego branch May 15, 2025 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Omitted Rego Evaulation results to the ScubaResults.json
4 participants