Nightwatch.js is an integrated, easy to use End-to-End testing solution for web applications and websites, written in Node.js. It uses the W3C WebDriver API to drive browsers in order to perform commands and assertions on DOM elements.
This BrowserStack Example repository demonstrates a CucumberJS test framework written in Node.js and Nightwatchjs 2.3 with parallel testing capabilities. The CucmberJS test scripts are written for the open source BrowserStack Demo web application (Github). This BrowserStack Demo App is an e-commerce web application which showcases multiple real-world user scenarios. The app is bundled with offers data, orders data and products data that contains everything you need to start using the app and run tests out-of-the-box.
The CucmberJS tests are run on different platforms like on-prem and BrowserStack using various run configurations and test capabilities.
-
Clone the repository
-
Ensure you have the following dependencies installed on the machine
- Node.js >= 10.17.0
- npm >= 1.22
-
To install repository dependencies run:
npm install
This repository contains the following Cucumber tests:
| Module | Test name | Description | Tag |
|---|---|---|---|
| E2E | End to End Scenario | This test scenario verifies successful product purchase lifecycle end-to-end. It demonstrates the Page Object Model design pattern and is also the default test executed in all the single test run profiles. | e2e |
| Login | Login with given username | This test verifies the login workflow with different types of valid login users. | login |
| Login | Login as Locked User | This test verifies the login workflow error for a locked user. | login |
| Offers | Offers for Mumbai location | This test mocks the GPS location for Mumbai and verifies that the product offers applicable for the Mumbai location are shown. | offers |
| Product | Apply Apple & Samsung Vendor Filter | This test verifies that only Apple and Samsung products shown if the Apple and Samsung vendor filter option is applied. | product |
| Product | Apply Lowest to Highest Order By | This test verifies that the product prices are in ascending order when the product sort "Lowest to Highest" is applied. | product |
| User | Login as User with no image loaded | This test verifies that the product images load for user: "image_not_loading_user" on the e-commerce application. Since the images do not load, the test case assertion fails. | user |
| User | Login as User with existing Orders | This test verifies that existing orders are shown for user: "existing_orders_user" | user |
For all the parallel run configuration profiles, you can configure the maximum parallel test threads by adding the --parallel cli switch followed by the number of parallels.
npm run bstack-parallel --parallel {number}
# for eg: npm run bstack-parallel --parallel 5This infrastructure points to running the tests on your own machine using a browser (e.g. Chrome) using the browser's driver executables (e.g. ChromeDriver for Chrome). Selenium enables this functionality using WebDriver for many popular browsers.
- For this infrastructure configuration (i.e on-premise), ensure that the ChromeDriver is downloaded successfully via node_modules
Note: The ChromeDriver version must match the Chrome browser version on your machine.
-
How to run the test?
To run the default test scenario (e.g. End to End Scenario) on your own machine, use the following command:
npm run on-prem-single
To run a specific senario, use the following command with the additional 'tag-name' argument:
npm run on-prem --tags @<tag-name> # for eg: npm run on-prem --tags @user
where, the argument 'tag-name' can be any senario tag configured in this repository.
E.g. "@user", "@login" or any other tag as outlined in About the tests in this repository section.
-
Output
This run profile executes a specific test scenario on a single browser instance on your own machine.
-
How to run the test?
To run the entire test suite on your own machine, use the following command:
npm run on-prem-suite
-
Output
This run profile executes the entire test suite sequentially on a single browser, on your own machine.
BrowserStack provides instant access to 3,000+ real mobile devices and browsers on a highly reliable cloud infrastructure that effortlessly scales as testing needs grow.
-
Create a new BrowserStack account or use an existing one.
-
Identify your BrowserStack username and access key from the BrowserStack Automate Dashboard and export them as environment variables using the below commands.
- For *nix based and Mac machines:
export BROWSERSTACK_USERNAME=<browserstack-username> && export BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
- For Windows:
set BROWSERSTACK_USERNAME=<browserstack-username> set BROWSERSTACK_ACCESS_KEY=<browserstack-access-key>
Alternatively, you can also hardcode username and access_key objects in the nightwatch-browserstack.conf.js file and nightwatch-browserstack-local.conf.js.
Note:
- We have configured a list of environments with test capabilities in the nightwatch-browserstack.conf.js file. You can certainly update them based on your device / browser test requirements.
- The exact test capability values can be easily identified using the Browserstack Capability Generator
In this section, we will run a single test on Chrome browser on Browserstack.
-
How to run the test?
- To run the default test scenario (e.g. End to End Scenario) on your own machine, use the following command:
npm run bstack-single
To run a specific test file, use the following command with the additional 'tag-name' argument:
npm run bstack --tags @<tag-name> # for eg npm run bstack --tags @user
where, the argument 'tag-name' can be any tag configured in this repository.
E.g. "@user", "@login" or any other tag as outlined in About the tests in this repository section.
-
Output
This run profile executes a single test on a single browser on BrowserStack. Please refer to your BrowserStack dashboard for test results.
In this section, we will run the tests in parallel on a single browser on Browserstack.
-
How to run the test?
To run the entire test suite in parallel on a single BrowserStack browser, use the following command:
npm run bstack-parallel
-
Output
This run profile executes the entire test suite in parallel on a single BrowserStack browser. Please refer to your BrowserStack dashboard for test results.
In this section, we will run the tests in parallel on multiple browsers on Browserstack.
-
How to run the test?
To run the entire test suite in parallel on multiple BrowserStack browsers, use the following command:
npm run bstack-parallel-multiple
[Web application hosted on internal environment] Running your tests on BrowserStack using BrowserStackLocal
-
Clone the BrowserStack demo application repository.
git clone https://github.com/browserstack/browserstack-demo-app
-
Please follow the README.md on the BrowserStack demo application repository to install and start the dev server on localhost.
-
In this section, we will run a single test case to test the BrowserStack Demo app hosted on your local machine i.e. localhost. Refer to the
browserstack.localobject innightwatch-browserstack.conf.jsfile to change test capabilities for this configuration. -
Note: You may need to provide additional BrowserStackLocal arguments to successfully connect your localhost environment with BrowserStack infrastructure. (e.g if you are behind firewalls, proxy or VPN).
-
Further details for successfully creating a BrowserStackLocal connection can be found here:
[Web application hosted on internal environment] Run a specific test on BrowserStack using BrowserStackLocal
-
How to run the test?
- To run the default test scenario (e.g. End to End Scenario) on a single BrowserStack browser using BrowserStackLocal, use the following command:
npm run bstack-local
-
Output
This run profile executes a single test on an internally hosted web application on a single browser on BrowserStack. Please refer to your BrowserStack dashboard(https://automate.browserstack.com/) for test results.
- View your test results on the BrowserStack Automate dashboard
- Documentation for writing Automate test scripts in Nightwatchjs
- Customizing your tests capabilities on BrowserStack using our test capability generator
- List of Browsers & mobile devices for automation testing on BrowserStack
- Using Automate REST API to access information about your tests via the command-line interface
- Understand how many parallel sessions you need by using our Parallel Test Calculator
- For testing public web applications behind IP restriction, Inbound IP Whitelisting can be enabled with the BrowserStack Enterprise offering