Gathering detailed insights and metrics for nightwatch
Gathering detailed insights and metrics for nightwatch
Integrated end-to-end testing framework written in Node.js and using W3C Webdriver API. Developed at @browserstack
Installations
npm install nightwatchDeveloper
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
>= 16
Typescript Support
Yes
Node Version
23.1.0
NPM Version
10.9.0
Statistics
11,847 Stars
2,869 Commits
1,339 Forks
254 Watching
24 Branches
132 Contributors
Updated on 27 Nov 2024
Languages
JavaScript (95.88%)
TypeScript (3.74%)
EJS (0.3%)
Gherkin (0.05%)
Vue (0.03%)
Total Downloads
Cumulative downloads
Total Downloads
66,624,846
Last day
12%
34,353
Compared to previous day
Last week
19.2%
176,033
Compared to previous week
Last month
15.6%
700,717
Compared to previous month
Last year
-21.8%
7,632,032
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
34
@nightwatch/chai@nightwatch/html-reporter-template@nightwatch/nightwatch-inspector@types/chai@types/selenium-webdriveransi-to-htmlaria-queryassertion-errorboxenchai-nightwatchchalkci-infocli-table3devtools-protocoldidyoumeandotenvejsenvinfoglobjsdomlodashminimatchminimistmochanightwatch-axe-verboseopenorapiscinaselenium-webdriversemverstacktrace-parserstrip-ansiuntildifyuuid
Peer Dependencies
1
Versions
Nightwatch.js
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:
-
Developer Experience : The entire experience from getting started, to writing and debugging tests, has been redesigned for speed, stability, and consistent non-flaky results.
-
Mobile first: Test your web or native, iOS and Android, mobile applications on simulators, real mobile devices or a cloud grid like BrowserStack.
-
One test automation framework: Run all types of tests from unit, component, and E2E to API, visual, and accessibility with a single framework.
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:
1npm init nightwatch@latest
or, if you want to initialize a new project:
1npm init nightwatch@latest ./path/to/new/project
2. Answer a few questions about your preferred setup:
- What is your Language - Test Runner setup?
- Where do you want to run your e2e tests?
- Where you'll be testing on?
- Where do you plan to keep your end-to-end tests?
- What is the base_url of your project?
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.
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
Nightwatch unit tests
The tests for Nightwatch are written using Mocha.
-
Clone the project
1git clone https://github.com/nightwatchjs/nightwatch.git 2 3# change directory 4cd nightwatch 5 6# install the dependencies 7npm install -
Run tests
To run the complete test suite:
1npm testTo check test coverage, run the command:
1npm run mocha-coverageand 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
- Capturing screenshots
- Comparison with baseline to highlight visual differences
- Report to review the differences
- 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
- Request assertions
- Response assertions
- Viewing API tests in the HTML report
- 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
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
30 commit(s) and 13 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
4 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-gmwp-3pwc-3j3g
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Reason
Found 7/30 approved changesets -- score normalized to 2
Reason
dependency not pinned by hash detected -- score normalized to 2
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-node.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/build-node.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-node.yaml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/build-node.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-node.yaml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/build-node.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-node.yaml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/build-node.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/component-tests.yaml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/component-tests.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/component-tests.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/component-tests.yaml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/coverage.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/coverage.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/coverage.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/coverage.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/coverage.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/coverage.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/label-commenter.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/label-commenter.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/label-commenter.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/label-commenter.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/missing-types-comment.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/missing-types-comment.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/missing-types-comment.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/missing-types-comment.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/missing-types-comment.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/missing-types-comment.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/missing-types.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/missing-types.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/missing-types.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/missing-types.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nightly.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/nightly.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nightly.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/nightly.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/nightly.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/nightly.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/publish.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/publish.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/type-declaration-tests.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/type-declaration-tests.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/type-declaration-tests.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/nightwatchjs/nightwatch/type-declaration-tests.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/nightly.yml:31
- Warn: npmCommand not pinned by hash: .github/workflows/publish.yml:19
- Warn: npmCommand not pinned by hash: .github/workflows/type-declaration-tests.yml:25
- Info: 0 out of 20 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
- Info: 4 out of 7 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/build-node.yaml:1
- Warn: no topLevel permission defined: .github/workflows/component-tests.yaml:1
- Warn: no topLevel permission defined: .github/workflows/coverage.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/label-commenter.yml:9
- Warn: no topLevel permission defined: .github/workflows/missing-types-comment.yml:1
- Warn: no topLevel permission defined: .github/workflows/missing-types.yml:1
- Warn: no topLevel permission defined: .github/workflows/nightly.yml:1
- Warn: no topLevel permission defined: .github/workflows/publish.yml:1
- Warn: no topLevel permission defined: .github/workflows/type-declaration-tests.yml:1
- Info: no jobLevel write permissions found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 20 are checked with a SAST tool
Score
4.8
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More