cyberark / conjur-inspect

Apache License 2.0
3 stars 0 forks source link

Record raw output from inspections #26

Closed micahlee closed 1 year ago

micahlee commented 1 year ago

Desired Outcome

The desired outcome of this PR is to standardize how we gather and package raw data from the Conjur Inspect tool. This allows for further manual inspection of data that might not be considered important enough for the top level report output now.

Implemented Changes

This PR implements a generic interface for inspection checks to store raw results that are packaged as a standard archive that corresponds with report results.

It additionally updates the disk latency and IOPs tests to save their raw outputs using the new interface.

This PR is best reviewed by commit, as many of the line-level changes are from a module refactor before making the functional changes.

Example output archives are available in the build artifacts: https://jenkins.conjur.net/blue/organizations/jenkins/conjurinc--conjur-preflight/detail/raw-output/15/artifacts

Connected Issue/Story

CyberArk internal issue ID: CNJR-483

Definition of Done

At least 1 todo must be completed in the sections below for the PR to be merged.

Changelog

Test coverage

Documentation

Behavior

Security

micahlee commented 1 year ago

LGTM The only feedback I would have is on the --raw-data-dir command line arg. To me it sounds more like an input to the program than an output. I might rename to --raw-data-out but I will leave that up to you.

Yeah, that's a good point @telday. What do you think about --data-output-dir?

codeclimate[bot] commented 1 year ago

Code Climate has analyzed commit ff00bf52 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 89.2% (50% is the threshold).

This pull request will bring the total coverage in the repository to 94.2% (-1.5% change).

View more on Code Climate.