vakenbolt / go-test-report

Captures go test output and parses it into a single self-contained HTML file.
Apache License 2.0
162 stars 34 forks source link

Support for HTML report based on Ginkgo Test JSON output #58

Open Dannyb48 opened 1 year ago

Dannyb48 commented 1 year ago

Hello,

I think this is a very cool tool. My team is a Ginkgo BDD Test shop and we are interested in representing the json results as an HTML report. Would you guys be will to accept a feature that could generate a html report based on the JSON output the Ginkgo framework generates? I would be willing to submit it.

Thanks

Dannyb48 commented 1 year ago

@vakenbolt @afbjorklund Looking for your thoughts?

afbjorklund commented 1 year ago

Sounds good to me, but I don't know how different the JSON format is - if it's a whole new parser, or just some tweaks?

i.e. if it would be a similar tool, or if it would be a flag to this tool

EDIT: The output of https://github.com/onsi/ginkgo looks very different

Dannyb48 commented 1 year ago

@afbjorklund thanks for the response!

Yeah the JSON output is very different. Its unique to ginkgo. But the way I'm thinking about it from a design perspective is creating a new parser that can encapsulate transforming ginkgo JSON and return the required templateData, testStatus, testdetailsBypaxkage objects that can then be passed to the generateReport function to generate the report.

The other difference is that I would add add a new flag to parse input from a file. Since ginkgo doesn't stream the JSON to std.out

Then potentially exposing that as a separate subcommands like go-test-report ginkgo

I have a rough POC locally that I can push up to my fork soon for you to get eyes on it

afbjorklund commented 1 year ago

It seems that this project is abandoned, and I would probably rather have it do one thing (go test) well...

But if it can be isolated cleanly, then maybe?