Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/funbox/frontend-tests-runner
A library for running Mocha tests in parallel
https://github.com/funbox/frontend-tests-runner
e2e-tests mocha
Last synced: about 1 month ago
JSON representation
A library for running Mocha tests in parallel
- Host: GitHub
- URL: https://github.com/funbox/frontend-tests-runner
- Owner: funbox
- License: mit
- Created: 2020-10-26T10:28:38.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T00:08:28.000Z (over 1 year ago)
- Last Synced: 2024-10-12T17:54:19.742Z (2 months ago)
- Topics: e2e-tests, mocha
- Language: JavaScript
- Homepage:
- Size: 308 KB
- Stars: 6
- Watchers: 11
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @funboxteam/frontend-tests-runner
[](https://www.npmjs.com/package/@funboxteam/frontend-tests-runner)
A library for running Mocha tests in parallel and watching files changes in live mode.
[По-русски](./README.ru.md)
## Installation
```bash
npm install --save-dev @funboxteam/frontend-tests-runner
```
## Usage
Example of usage:
```javascript
const config = {
parallelTestsCount: 2,
testFiles: './src/tests/e2e/*.js',
project: {
build() {
// Build project function. Must return Promise.
},
addListener(event) {
// Even subscription function. There're two possible events
// buildStart — the project building has started;
// buildFinish — the project building has finished;
// Helpful for live testing.
}
}
};
const Runner = require('@funboxteam/frontend-tests-runner');
const runner = new Runner(config);
runner.start();
```
For more check [examples](./examples) directory.
### Configuration
Example of all configuration options and their defaults:
```javascript
module.exports = {
// A number of files with tests running in parallel.
// Optional.
parallelTestsCount: 1,
// Run tests in live mode (enabling watching for files changes).
// Optional.
live: false,
// Write logs for each test file separately.
// Optional.
separatedLogs: false,
// Directory name for `separatedLogs`.
// Optional.
logDir: 'test-logs',
// Glob with tests files, for exampe: `tests/\*.js`.
// Required.
testFiles: undefined,
// Return test files for run. Function can be async.
// Optional.
filterTestsFiles: (files, isFilteredByOnly) => {
// e.g.:
// if (isFilteredByOnly) return files;
// const testsFilesDependencies = getTestsFilesDependencies(files);
// const changedFiles = getChangedFiles();
// return getAffectedTestsFiles(testsFilesDependencies, changedFiles);
},
project: {
build() {
// Build project function. Must return Promise.
},
addListener(event) {
// Event subscription function. There're two possible events:
// buildStart — the project building has started;
// buildFinish — the project building has finished.
// Helpful for live testing.
}
},
// Mocha config https://mochajs.org/#command-line-usage.
// Optional.
mocha: {
// Test timeout threshold (in milliseconds).
// https://mochajs.org/#-timeout-ms-t-ms
// Optional.
timeout: 30000,
// Retry failed tests this many times.
// https://mochajs.org/#-retries-n
// Optional.
retries: 0,
// Disable color output.
// https://mochajs.org/#-color-c-colors
// Optional.
noColors: false,
// Additional args object for Mocha.
// Optional.
args: {
// e.g.:
// '--full-trace': 'true',
// '--require': [
// '@babel/register',
// 'babel-polyfill',
// ],
},
},
}
```
[](https://funbox.ru)