All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
-
feat(reporter): be able to set reporter options through environment variables.
- you can now set the
--reporter-json-folder
,--reporter-app-name
and--reporter-app-version
options as variable environments:
process.env['--reporter-json-folder'] = 'my-custom-folder'; process.env['--reporter-app-name'] = 'My App'; process.env['--reporter-app-version'] = 'x.y.z'; // then start tests via the TestCafé Runner
- you can now set the
- fix(screenshot): don't crash when file not found (#31)
-
feat(reporter): be able to set cli options through configuration file
- you can now use the
testcafe-reporter-cucumber-json.json
configuration file to set the--reporter-json-folder
,--reporter-app-name
and--reporter-app-version
cli options: add or edit theargs
section in the json configuration file:
"args": { "appName": false, "appVersion": false, "reportFolder": "my-custom-folder" }
Every property in
args
is optional. If you just want to only setup a custom folder:"args": { "reportFolder": "my-custom-folder" }
Note: The command-line options will take precedence over the configuration file.
- you can now use the
- fix(browserstack): filter errors by testRunId instead of browser name
-
feat(reporter): be able to display the date and time of tests execution in the final HTML report.
To enable this feature you must add
displayReportTime: true
to theoptions
object passed to the HTML generator.
- update dependencies
- fix(reporter): report desktop devices from browserstack
- fix(reporter): process cli options only when defined
- fix(reporter): report devices from browserstack
- fix(user-agent): fix user-agent parsing for Internet Explorer
- fix(reporter): report device on browserstack
- fix(reporter): remove browserstack url from JSON filenames
- fix vulnerabilities
- fix(reporter): handle userAgent on browserstack
- fix(user-agent): fix user-agent parsing for iOS
- fix(user-agent): fix user-agent parsing for Android
- fix(reporter): handle screenshots when there is no error
- fix(reporter): handle multi-browser reporting
- fix(reporter): push an empty report to the TestCafe plugin host
- fix(reporter): remove chalk formatting
- Declaration of this reporter, on the TestCafe CLI has changed:
testcafe chrome ./path-to-tests/*(.js|.testcafe|.ts) --reporter cucumber-json --reporter-app-name='My App' --reporter-app-version='x.y.z'
or if you use the runner.reporter
runner.reporter('cucumber-json');
You do not need to specify a filename in the reporter declaration, because the reporter now creates itself all json files.
JSON files are now automatically created in a folder named
cucumber-json-reports
at the root of your project.JSON files are created for each browser and for each test execution, for example:
cucumber-json-reports
|- Chrome_83_0_4103_116_macOS_10_15_5-2020-07-04T19-44-58-493Z.json
|- Firefox_78_0_macOS_10_15-2020-07-04T19-44-58-493Z.json
|- Microsoft_Edge_83_0_478_58_macOS_10_15_5-2020-07-04T19-38-05-688Z.json
|- Microsoft_Edge_83_0_478_58_macOS_10_15_5-2020-07-04T19-44-58-493Z.json
|- Safari_13_1_1_macOS_10_15_5-2020-07-04T19-44-58-493Z.json
|- ...
If you need to change this folder, add this option on the TestCafé command-line:
--reporter-json-folder='my-custom-folder'
You should update the
report-generator.ts
file:
report.generate({
jsonDir: 'cucumber-json-reports',
reportPath: 'cucumber-json-reports/html',
});
- Fix user-agent parsing for Edge
- Update dependencies
- Linux platform support by NathanYocum
A major version has been published only because prod dependencies have been updated to their latest version.
- Fix user-agent parsing for windows 10 issue #20
- Update dependencies
-
Merge pull request #19 from guiyomh/hotfix/user-agent-osx
- Fix user-agent parsing for macOS
-
chore(vulnerability): update minimist dependency
This version must be used together with multiple-cucumber-html-reporter >= 1.13.1
- update dependencies
- fix vulnerabilities
- fix issue #13
- warn only when the reporter receives a non TestCafe error.
- be able to handle reporting of .testcafe files execution (files generated by TestCafe Studio) (issue 10).
- warn when TestCafe sends to the reporter an error with an unexpected structure.
There are potentially breaking changes, because of breaking changes in dependencies updates.
- update all dependencies
- remove vulnerabilities
- fix browserstack platform issue
- add tags from test description
- remove 'Feature'/'Scenario' prefix in fixture/test description
- embed screenshots as base64 images
- mark scenario as skipped when step is skipped
- Support report with screenshots by including screenshots to report.json (Tareq El-Masri)
- Update all dependencies
- Update documentation
- Remove TestCafe dependency and set it as peer dependency