README.md

Nightwatch.js

Homepage | Getting Started | Developer Guide | API Reference | About

Automated end-to-end testing framework powered by Node.js and using W3C Webdriver (formerly Selenium).

Nightwatch is a complete and integrated solution for end-to-end testing of web applications and websites, and also for Node.js unit and integration testing.

Changelog | Mailing List | nightwatch.js tag on StackOverflow

Nightwatch v1.3

We're delighted to announce the release of Nightwatch v1.3. Please see the upgrade guide if you are upgrading from a pre v1.0 version.

1. Install Nightwatch

From NPM:

$ npm install nightwatch

• add -g if you wish to install Nightwatch globally on your system.

From GitHub:

$ git clone https://github.com/nightwatchjs/nightwatch.git
$ cd nightwatch
$ npm install

2. Download WebDriver

Nightwatch uses a WebDriver compatible server to control the browser. WebDriver is a W3C specification and industry standard which provides a platform and HTTP protocol to interact with a browser.

Nightwatch includes support for automatically managing the following services:

ChromeDriver

• for running tests against the Chrome browser;
• download url: https://sites.google.com/a/chromium.org/chromedriver/downloads.

Starting with version 75, Chromedriver has W3C Webdriver protocol enabled by default. If you'd like to stick to the JSONWire for now adjust the chromeOptions:

desiredCapabilities : {
  browserName : 'chrome',
  chromeOptions: {
    w3c: false
  }
}

GeckoDriver

• for running tests against the Mozilla Firefox browser;
• download url: https://github.com/mozilla/geckodriver/releases.

Selenium Standalone Server

• allows managing multiple browser configurations in one place and also to make use of the Selenium Grid service;
• the selenium server jar file selenium-server-standalone-3.x.x.jar can be downloaded from the Selenium releases page: https://selenium-release.storage.googleapis.com/index.html

It's important to note that, while the Selenium Server was required with older Nightwatch versions (v0.9 and prior), starting with version 1.0 Selenium is no longer necessary.

Specific WebDriver setup guides can be found on the Docs website. Legacy Selenium drivers setup guides along with debugging instructions can be found on the Wiki.

Examples

Example tests are included in the examples folder which demonstrate the usage of several Nightwatch features.

You can also check out the nightwatch-website-tests repo for example tests against the nightwatchjs.org website.

A sample nightwatch.json config file can be found in bin folder.

Nightwatch unit tests

The tests for Nightwatch are written using Mocha.

To run the complete test suite:

$ npm test

To check test coverage, run the command:

$ npm run mocha-coverage

and then open the generated coverage/index.html file in your browser.

Support Nightwatch

Nightwatch is built by @pineviewlabs - an independent software consultancy based in Oslo, Norway, with help from our contributors.

Please consider supporting Nightwatch by becoming a backer or sponsor on the OpenCollective platform.