Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/direct-adv-interfaces/mocha-headless-chrome
Run client-side mocha tests in the command line through headless Chrome.
https://github.com/direct-adv-interfaces/mocha-headless-chrome
Last synced: 5 days ago
JSON representation
Run client-side mocha tests in the command line through headless Chrome.
- Host: GitHub
- URL: https://github.com/direct-adv-interfaces/mocha-headless-chrome
- Owner: direct-adv-interfaces
- License: mit
- Created: 2017-08-24T17:29:08.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T04:09:58.000Z (6 months ago)
- Last Synced: 2024-11-25T16:54:06.203Z (18 days ago)
- Language: JavaScript
- Homepage:
- Size: 213 KB
- Stars: 95
- Watchers: 6
- Forks: 34
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-puppeteer - mocha-headless-chrome - Run client-side mocha tests in the command line through Puppeteer. (Testing)
- awesome-puppeteer-zh - mocha-headless-chrome - 通过Puppeteer在命令行中运行客户端mocha测试. (测试 / 贡献)
README
# mocha-headless-chrome
[](https://www.npmjs.com/package/mocha-headless-chrome)
[](http://spdx.org/licenses/MIT.html)
This is the tool which runs client-side [mocha](https://github.com/mochajs/mocha) tests in the command line through headless Chrome ([puppeteer](https://github.com/GoogleChrome/puppeteer) is used).
Node 14.0.0+ and Mocha 2.3.0+ are supported.
## Getting Started
First you need to install [mocha-headless-chrome](https://www.npmjs.com/package/mocha-headless-chrome):
```sh
npm i mocha-headless-chrome
```
Then prepare the test page (see [the example](example/example-page.html)).
*Note. It is necessary to add the **<meta charset="utf-8">** tag. Otherwise browser may use another encoding and test results will be shown incorrectly.*
Then run the CLI and specify your test page path using **-f** parameter.
```sh
mocha-headless-chrome -f test-page.html
```
## Options
- **-f, --file** - Path or URL of the page which contains tests (required)
- **-r, --reporter** - Mocha reporter name (defaults to "spec")
- **-o, --out** - Path to the file where test result will be saved
- **-c, --coverage** - Path to the file where coverage info will be saved
- **-e, --executablePath** - Chrome executable path
- **-v, --visible** - Show Chrome window
- **-a, --args** - Chrome arguments ('--' prefix will be added)
- **-w, --width** - Viewport width
- **-H, --height** - Viewport height
- **-t, --timeout** - Timeout in ms (defaults to 60000)
- **-p, --polling** - Puppeteer polling mechanism
- **-h, --help** - Output usage information
## Examples
Run test on the "test.html" page:
```sh
mocha-headless-chrome -f test.html
```
Run tests on the remote page:
```sh
mocha-headless-chrome -f http://localhost:8080
```
Output test results using "nyan" reporter:
```sh
mocha-headless-chrome -f test.html -r nyan
```
Pass the Chrome **--no-sandbox** and **--disable-setuid-sandbox** arguments:
```sh
mocha-headless-chrome -f test.html -a no-sandbox -a disable-setuid-sandbox
```
## Mocha reporters
All mocha reporters are supported. Specify the reporter name through **-r** parameter. All reporter output (include cursor manipulations) will be redirected to stdout as like it works in console.
For usage of third-party reporter just include it's code to the page by **<script>** tag and specify it's name in the **-r** parameter.
Also special reporter named **"none"** is available which does not output anything. This reporter will be useful when you want to process test result without output to console (for example, when saving data to a file).
## Programmatically usage
You can use mocha-headless-chrome programmatically. Just require the *mocha-headless-chrome* node module and pass proper parameters into it. Function result is a Promise.
```js
const {runner} = require('mocha-headless-chrome');
const options = {
file: 'test.html', // test page path
reporter: 'dot', // mocha reporter name
width: 800, // viewport width
height: 600, // viewport height
timeout: 120000, // timeout in ms
polling: 'raf', // polling mechanism
executablePath: '/usr/bin/chrome-unstable', // chrome executable path
visible: true, // show chrome window
args: ['no-sandbox'] // chrome arguments
};
runner(options)
.then(result => {
let json = JSON.stringify(result);
console.log(json);
});
```
See also the [TypeScript example](./example/example.ts).