ctrf-io / cypress-ctrf-json-reporter Goto Github PK

feat: add filePath to test object

https://www.ctrf.io/docs/schema/test#test-object-properties

Hi,

I've been going through the documentation trying to implement the reporter and I've run into the below issue.

The documentation says we must run:

npm install --save-dev cypress-ctrf-json-reporter

however, in the import/require statement, it asks us to import: 'cypress-ctrf-json-report' - note the 'er' is missing - this is when comparing to the package name.

The initial import asks us to import generateCtrfJsonReport, but this method does not exist in the code as far as I can see. Doing a brief run through, the code has the method GenerateCtrfReport exported instead of generateCtrfJsonReport

When I make the above updates with importing, I run into this error:

Please let me know if I am missing out on anything or using this incorrectly. It will be greatly appreciated.

feat: add tags to test object

https://www.ctrf.io/docs/schema/test#test-object-properties

feat: add flake to test object

https://www.ctrf.io/docs/schema/test#test-object-properties

add suite propertiy to the test object.

suite | String | The suite or group to which the test belongs.

add start and stop properties to test object.

start - Number - The start time of the test as a Unix epoch
stop - Number - The end time of the test as a Unix epoch

feat: add browser to test object

https://www.ctrf.io/docs/schema/test#test-object-properties

feat: add retry to test object

https://www.ctrf.io/docs/schema/test#test-object-properties

When status is failed add message and trace to test object.

message - A descriptive message or note associated with the test result
trace - The stack trace captured if the test failed

Add minimal as a reporter option, if set to true, only the required properties are included in the tool, summary and test object.

add suite propertiy to the test object.

suite | String | The suite or group to which the test belongs.

feat: add type to test object

https://www.ctrf.io/docs/schema/test#test-object-properties

feat: add rawStatus to test object

https://www.ctrf.io/docs/schema/test#test-object-properties

feat: add screenshot to test object

https://www.ctrf.io/docs/schema/test#test-object-properties

First of all, thank for this library, it's exactly what we were after!

However, when starting the test suite with yarn run cypress run --browser chrome --project ./test, we notice that the result file get's overwritten after each test runs; this means that the resulting json has an array tests, but it only contains the last test run.

Also, I think the README is not updated regarding the defaults; the default filename that's being generated is test/after-spec-results, and not ctrf/ctrf-report.json as per the docs.