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.

Sign up for GitHub

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

Jump to bottom

Add XML output format to support CI test summary #21

Open

simonwilbert opened this issue Jan 27, 2017 · 1 comment

Labels

feature

simonwilbert commented Jan 27, 2017

allow swagger-diff to output a file which CI systems can parse to get test summary

Circle - https://circleci.com/docs/test-metadata/

Like "Your build ran 832 tests with 4 breaking API changes and 3 Warnings listed below"

Owner

zallek commented Jan 31, 2017

yeh that could be interesting.
Currently, there are 2 output modes either "raw" or "json". We could add a "junit-xml"

https://github.com/windyroad/JUnit-Schema/blob/master/JUnit.xsd

So that's means that it needs to both output to stdout warnings/errors and also write to a file the junit test results.

that should be possible quite easily:

update https://github.com/zallek/swagger-diff/blob/master/bin/swagger-diff.js#L30 and introduce a "junit-xml" outformat
add a new reporter for junit next to https://github.com/zallek/swagger-diff/blob/master/src/reporter.js. the input of the report contains everything needed: lists of errors, warnings, info, etc. (cf current existing reporter).

Do you think you could create a PR for that it would be great :)

zallek added the feature label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment