Ask the Community
Test Reporting & Analytics on Newman
Quick start guide to integrate BrowserStack Test Reporting & Analytics with Newman reports.
Prerequisites
- Ensure you have a BrowserStack Username and Access Key. Obtain your userName and accessKey from the Account & Profile section on the dashboard. If you have not yet created an account, sign up for a free trial.
- You must have a Newman test report (You do not need to run your tests on BrowserStack infrastructure to generate or use this report).
- Node version 16 or higher.
Integrate with Test Reporting & Analytics
Install or update to the latest version of the BrowserStack Node SDK
Go to your project’s root directory and run the adjacent commands to update or install the BrowserStack Node SDK and verify the installed version.
Verify that you have browserstack-node-sdk v1.55.0 or later before proceeding.
Set username and access key as environment variables
Run the following command to set your username and accesskey as environment variables:
Modify the browserstack.yml file
Configure the browserstack.yml file as follows:
The projectName and buildName config must be static and not change across different runs of the same build. Restrict the characters in your projectName and buildName to alphanumeric characters (A-Z, a-z, 0-9), underscores (_), colons (:), square brackets ([, ]), and hyphens (-). Any other character will be replaced with an underscore (_).
Run your test suite with Test Reporting & Analytics
Prepend browserstack-node-sdk to the existing command that you use to trigger a run.
After the build run completes, use the hyperlink at the end of the Newman report to view the tests in Test Reporting & Analytics. The report includes a link to the Git repository containing the Newman collections. Alternatively, you can also navigate to your build run using the Build Runs tab in the Test Reporting & Analytics dashboard.
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
We're sorry to hear that. Please share your feedback so we can do better
Contact our Support team for immediate help while we work on improving our docs.
We're continuously improving our docs. We'd love to know what you liked
Thank you for your valuable feedback!