https://github.com/browserstack/jest-js-browserstack
https://github.com/browserstack/jest-js-browserstack
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/browserstack/jest-js-browserstack
- Owner: browserstack
- Created: 2022-02-11T04:47:56.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T17:28:04.000Z (over 1 year ago)
- Last Synced: 2025-04-22T21:06:08.947Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 854 KB
- Stars: 3
- Watchers: 12
- Forks: 28
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# JestJS BrowserStack 
JestJS 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 repository
- Install dependencies using, npm install or yarn 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`
## 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": "jest ...args",
"browserstack-test": "browserstack-node-sdk jest ...args"
},
```
## Notes
---
- You can view your test results on the [BrowserStack Automate Dashboard](https://automate.browserstack.com)
- To test on a different set of browsers, check out our [platform configurator](https://browserstack.com/automate/capabilities)
## Additional Resources
---
- [Documentation for writing Automate test scripts in JestJS](https://browserstack.com/docs/automate/selenium/getting-started/nodejs/jest-js)
- [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)