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

Add Omitted Rego Evaulation results to the ScubaResults.json #1458

Open
buidav opened this issue Dec 5, 2024 · 0 comments
Open

Add Omitted Rego Evaulation results to the ScubaResults.json #1458

buidav opened this issue Dec 5, 2024 · 0 comments
Assignees
Labels
enhancement This issue or pull request will add new or improve existing functionality
Milestone

Comments

@buidav
Copy link
Collaborator

buidav commented Dec 5, 2024

💡 Summary

When a ScubaGear policy check is omitted via a configuration file the results of the Rego evaluation are not captured within the ScubaResults*.json only within the currently default named TestResults.json.

This enhancement is to add another property to the ScubaResults*.json, called something like
OmittedEvalationResults or OmittedRegoResults to capture this data.

Motivation and context

To capture omission data in our new unified JSON rather having to pivot to either the TestResults.json or recreate the evaluation using the Raw field in ScubaResults.json

Implementation notes

The omitted interception is being done as an if statement in CreateReport.psm1.
Likely will require a bit of refactoring here or perhaps inside the Merge-JSONOuput function in Orchestrator.psm1 where the unified ScubaResults.json is created.

Exercise for the implementer to tinker with where to implement this enhancement.
Image

Acceptance criteria

  • For any policies that are omitted, the Rego eval results are captured somewhere within the ScubaResults*.json
@buidav buidav added the enhancement This issue or pull request will add new or improve existing functionality label Dec 5, 2024
@schrolla schrolla added this to the Lionfish milestone Dec 16, 2024
@adhilto adhilto self-assigned this Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

No branches or pull requests

4 participants
@buidav @adhilto @schrolla and others