https://github.com/browserstack/cucumber-js-browserstack
Selenium examples for Cucumber-JS and BrowserStack Automate
https://github.com/browserstack/cucumber-js-browserstack
Last synced: 7 months ago
JSON representation
Selenium examples for Cucumber-JS and BrowserStack Automate
- Host: GitHub
- URL: https://github.com/browserstack/cucumber-js-browserstack
- Owner: browserstack
- Created: 2016-03-02T07:53:45.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2025-07-25T11:18:08.000Z (8 months ago)
- Last Synced: 2025-08-13T08:42:29.661Z (8 months ago)
- Language: JavaScript
- Homepage: https://www.browserstack.com
- Size: 301 KB
- Stars: 29
- Watchers: 18
- Forks: 31
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# cucumber-js-browserstack
[Cucumber-JS](https://github.com/cucumber/cucumber-js) Integration with BrowserStack for E2E functional testing of UI using Selenium and [browserstack-node-sdk](https://www.npmjs.com/package/browserstack-node-sdk).
## Run sample build
---
- Clone the repo
- Install dependencies `npm install`
- Set your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings) in [browserstack.yml](browserstack.yml) `npx setup --username userName --key accessKey`
- To run sample test, run `npm run sample-test` or `yarn run sample-test`
- To run tests on private websites,
- set browserstackLocal: true at [browserstack.yml](browserstack.yml)
- run `npm run sample-local-test` or `yarn run sample-local-test`
Understand how many parallel sessions you need by using our [Parallel Test Calculator](https://www.browserstack.com/automate/parallel-calculator?ref=github)
## Integrate your test suite
---
1. Install browserstack-node-sdk as a dev-dependency
```
npm i -D browserstack-node-sdk
or
yarn add --dev browserstack-node-sdk
```
2. Setup
```
npx setup --username userName --key accessKey
```
* Adds a browserstack.yml file at root of your mocha project with your [BrowserStack Username and Access Key](https://www.browserstack.com/accounts/settings).
* Adds a new command for running tests on browserstack in scripts tag of package.json,
```
"scripts": {
"test": "cucumber-js [args]",
"browserstack-test": "browserstack-node-sdk cucumber-js [args]"
},
```
## Notes
---
- You can view your test results on the [BrowserStack Automate dashboard](https://www.browserstack.com/automate)
- To test on a different set of browsers, check out our [platform configurator](https://www.browserstack.com/automate/node#setting-os-and-browser)
## Additional Resources
---
- [Documentation for writing Automate test scripts in Node](https://www.browserstack.com/automate/node)
- [Customizing your tests on BrowserStack](https://www.browserstack.com/automate/capabilities)
- [Browsers & mobile devices for selenium testing on BrowserStack](https://www.browserstack.com/list-of-browsers-and-platforms?product=automate)
- [Using REST API to access information about your tests via the command-line interface](https://www.browserstack.com/automate/rest-api)