nightwatch README

The project's README from github.com/nightwatchjs/nightwatch. As one markdown file: README.md.

Nightwatch.js

npm Node.js CI codecov Discord

Nightwatch.js Logo

Homepage • Developer Guide • API Reference • About • Blog

Nightwatch is an integrated testing framework powered by Node.js and using the W3C Webdriver API. It is a complete testing solution developed at BrowserStack and which can be used for:

☑️ end-to-end testing of web applications and websites

☑️ component testing in isolation (React / Vue / Storybook / Angular)

☑️ Node.js unit, visual regression testing, accessibility testing & API testing

☑️ Native mobile app testing on Android & iOS

🚀 Nightwatch v3

What's New | Release Notes | Discussions

Nightwatch v3 is an all new generation that has been built around these three pillars:

The Nightwatch v3 is not just a new version, it’s the result of months of engineering effort to reimagine test automation for the future. Try it out in 60 seconds and see it in action.

⚙️ Get started in 60 seconds

1. Install Nightwatch from NPM

From your existing project's root dir:

npm init nightwatch@latest

or, if you want to initialize a new project:

npm init nightwatch@latest ./path/to/new/project

nightwatch-cli-gif

2. Answer a few questions about your preferred setup:

Nightwatch will do the entire setup for you based on your answers.

3. Run a Demo Test:

Nightwatch comes with a few examples, which are automatically copied to your Nightwatch project during the setup and can also be used as boilerplate to write your own tests on top of them.

You can follow the instructions given at the end of the setup to run your first test with Nightwatch.

image

Nightwatch mobile app testing

Nightwatch enables automation testing of native mobile applications via Appium. It combines the robustness of Appium with the enhanced developer experience provided by Nightwatch. It enables end-to-end functional testing of native mobile apps on Android and iOS devices. Try it now

Go beyond E2E

Component testing

With Nightwatch you can test components in isolation by mounting them in the browser. Nightwatch 2 added support for component testing for popular web frameworks such as

  1. React
  2. VueJS
  3. Angular
  4. Storybook

Nightwatch unit tests

The tests for Nightwatch are written using Mocha.

  1. Clone the project

    git clone https://github.com/nightwatchjs/nightwatch.git

# change directory
cd nightwatch

# install the dependencies
npm install

  2. Run tests

    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.

See Unit testing guide for more details.

Other types of testing

Visual Regression Testing

Nightwatch v3 introduces visual regression testing as an in-house plugin. The plugin takes care of

  1. Capturing screenshots
  2. Comparison with baseline to highlight visual differences
  3. Report to review the differences
  4. Approve the changes

VRT can be done on real desktop & mobile browsers. Also, VRT can be run on components as part of component testing as well.

API Testing

API testing is now available with Nightwatch v3. The following functionality can be achieved with API testing

  1. Request assertions
  2. Response assertions
  3. Viewing API tests in the HTML report
  4. Mock server

Accessibility Testing

Nightwatch v3 packages the aXe-core package developed by Deque Systems as a plugin. It enables 90 different types of accessibility tests for WCAG compliance.

🦉 About Nightwatch

Nightwatch was initially built by @pineviewlabs - an independent software consultancy based in Oslo, Norway, with help from contributors. In mid 2021, Nightwatch has become a part of the @BrowserStack family and it is being developed further at the BrowserStack Open-source Program Office. Read more on our blog.

Contributing

We welcome any and all contributions from the community which can help improve Nightwatch. Please check out CONTRIBUTING.md for more extensive contributing guidelines.

Licence

MIT

nightwatch (nightwatchjs/nightwatch)

Searching Database…

12K ·GitHub
Nightwatch
What is this?Nightwatch.js is an integrated end-to-end testing framework for Node.js built on the W3C Webdriver API, used for testing web apps, components, APIs, and native mobile apps all with one tool.
Is this a testing framework or just a library wrapper around Selenium?It's a complete, standalone testing framework (not just a thin wrapper) that bundles the test runner, assertions, and setup wizard, though it can use Selenium/WebDriver under the hood.
How do I get it running?Install Nightwatch from NPM in an existing project, or use the init command to scaffold a new project; it then asks a few setup questions (language/runner, where to run e2e tests, test location, base URL) and generates everything including demo tests to run.
Do I need Selenium or Appium installed separately?For web testing it drives browsers via the W3C Webdriver API (like ChromeDriver/Selenium Server); for native mobile app testing it requires Appium underneath. Node.js >= 18.20.5 is required.
Is mobile app testing built-in or does it need extra setup?Mobile testing works through Appium integration, so you need Appium configured alongside Nightwatch rather than it working purely out of the box with zero extra tooling.
Who is this for - frontend teams only?It targets anyone needing browser or mobile automation: web app testers, and teams using React, Vue, Angular, or Storybook for component testing.
Does it only test in the browser, or also on real devices?It covers desktop and mobile browsers plus native Android and iOS apps, running on simulators, real devices, or a cloud grid like BrowserStack.
What kinds of testing can Nightwatch handle besides e2e?It supports unit tests, visual regression testing, accessibility testing (via aXe-core, covering 90 WCAG checks), and API testing (request/response assertions plus a mock server), all in one framework.
What is new in Nightwatch v3?v3 focuses on developer experience (faster, more stable, less flaky tests), mobile-first testing, and unifying unit, component, e2e, API, visual, and accessibility testing into a single framework.
How are Nightwatch's own unit tests run?Its test suite is written with Mocha; you clone the repo and run the test command, with coverage reports generated via nyc into coverage/index.html.
What are similar projects?SeleniumBase, undetected-chromedriver, capybara, invisible_selenium, selenium, mocha, playwright, appium
Which topics is it in?automated-testing, webdriver, end-to-end-testing, selenium, accessibility, mobile-app, vue, testing, browser, cloud, hacktoberfest, mobile
Creator
nightwatchjs
Size
53.5 MB
Stars
12K
Updated
CommitMay 25Releasev3.16.0May 25
Age
14y
Commits · 90 Days