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

Make check add_* methods more flexible #50

Open
alfinkel opened this issue Aug 26, 2020 · 0 comments
Open

Make check add_* methods more flexible #50

alfinkel opened this issue Aug 26, 2020 · 0 comments
Labels
check Check related issue enhancement New feature or request

Comments

@alfinkel
Copy link
Contributor

alfinkel commented Aug 26, 2020

Overview

The ComplianceCheck add_* functions are pretty simplistic & free form - a key/label for the failure and things that failed/warned/succeeded in that way. This has been fine while the compliance tool was a "self contained thing", but as we integrate into other components it becomes a bit too simple.

It would be nice to allow failures/warnings/successes to be recorded with richer information, for example a CRN, the account or instance that had the problem etc. I think making the add_* functions take an optional kwargs which propagate to the internal data structures & then out into check_results.json would give us more fidelity in the data & more flexibility.

  • add_warnings
  • add_failures
  • add_successes

Requirements

TBD

Approach

TBD

Security and Privacy

N/A

Test Plan

TBD

@alfinkel alfinkel added enhancement New feature or request check Check related issue labels Aug 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
check Check related issue enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant