cloudformation-guard icon indicating copy to clipboard operation
cloudformation-guard copied to clipboard

[Enhancement] Output reports in a standard format

Open benbridts opened this issue 2 years ago • 4 comments

Is your feature request related to a problem? Please describe.

When using Guard as part of a CI/CD pipeline, I would like to use my current reporting tool to track rule failures and success over time and use my tools integrations (ie links to files and lines) to easily navigate through source code

Describe the solution you'd like

There are multiple popular report file outputs (CodeBuild supports 6 different ones), picking one or two from that list and adding a --report option would be great.

Additional context

I don't think this should replace the current output formats (I might want single-line output for my build log in addition to the report). A --output none option might be useful, but > /dev/null would work in a lot of environments too.

benbridts avatar Aug 18 '22 09:08 benbridts

Thanks for bringing this up @benbridts

Curious, any votes on which option will support your use case best? JUnit? Cucumber JSON? etc?

razcloud avatar Aug 31 '22 00:08 razcloud

I'm happy to open another issue for this, but I came here with the same ask specifically around getting some kind of output from the test command. For my particular use case, parity with the output formats from the validation command would be a great start (mostly JSON), followed closely by JUnit.

drmmarsunited avatar Sep 14 '22 23:09 drmmarsunited

For my use case any output that is supported by CodeBuild would be great

benbridts avatar Sep 16 '22 09:09 benbridts

Thank you @benbridts Will take this back to the team.

@drmmarsunited Noted.

razcloud avatar Sep 16 '22 14:09 razcloud

+1 on this one. Any test report format supported by CodeBuild would be great. My personal preference is JUnit as it seems to be supported by most tools.

fabiodouek avatar Feb 19 '23 12:02 fabiodouek

Related: Add support for SARIF [Enhancement] #412

andrew-glenn avatar Sep 28 '23 16:09 andrew-glenn

Hi @benbridts, @drmmarsunited and @fabiodouek just wanted to let the 3 of you know that we now have support for JSON/YAML/JUnit reporters for both test and validate command

I am going to go ahead and close out this issue.

Feel free to reopen if necessary

joshfried-aws avatar Feb 06 '24 22:02 joshfried-aws