ComplianceAsCode / ComplianceAsCode/auditree-framework

Make check add_* methods more flexible

Open
#50 0 comments 0 reactions 0 assignees View on GitHub
check enhancement
Dominant language
Python
Stars
76
Forks
25
PR merge metrics
No merged PRs in 30d

Description

## 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.