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

Ensure Each Control Is Included in the Reports #157

Closed
12 of 13 tasks
adhilto opened this issue Jan 23, 2024 · 0 comments · Fixed by #163
Closed
12 of 13 tasks

Ensure Each Control Is Included in the Reports #157

adhilto opened this issue Jan 23, 2024 · 0 comments · Fixed by #163
Assignees
Labels
bug This issue or pull request addresses broken functionality enhancement Gmail
Milestone

Comments

@adhilto
Copy link
Collaborator

adhilto commented Jan 23, 2024

💡 Summary

One basic form of error handling is to ensure that each control is included in the report.

Motivation and context

Rego bugs can sometimes be silent and cause a check to be omitted entirely. Unless we include an explicit check for this, it's very hard to even realize something went wrong in those cases.

Implementation notes

First, we need to ensure that each control has a Rego check. The following are missing:

  • GWS.GMAIL.3.2v0.1
  • GWS.GMAIL.10.2v0.1
  • GWS.GMAIL.15.2v0.1
  • GWS.GMAIL.16.2v0.1
  • GWS.GMAIL.18.2v0.1
  • GWS.GMAIL.18.3v0.1
  • GWS.GMAIL.19.2v0.1
  • GWS.GMAIL.19.3v0.1
  • GWS.GMAIL.19.4v0.1

It just so happens that Gmail is the only baseline with this problem right now, but this issue could show up for any of the products.

Second, we need to modify the reporter to warn the user of missing output. There are two pieces to this:

  • A warning printed to the terminal
  • A warning included in the report

This is what that looks like on ScubaGear.
image
image

The rego_json_to_html function is the probably the most natural place to add this check.

Acceptance criteria

  • Each control has a Rego check
  • The check for missing output has been added to the Reporter
@adhilto adhilto added bug This issue or pull request addresses broken functionality Gmail enhancement labels Jan 23, 2024
@adhilto adhilto self-assigned this Jan 23, 2024
@adhilto adhilto linked a pull request Jan 24, 2024 that will close this issue
14 tasks
@buidav buidav added this to the Backlog milestone Jan 24, 2024
@adhilto adhilto mentioned this issue Jan 25, 2024
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue or pull request addresses broken functionality enhancement Gmail
Projects
None yet
2 participants