https://github.com/ldgit/argus
Watches your files and executes unit tests for them
https://github.com/ldgit/argus
argus javascript node php phpunit test-runner watch-files
Last synced: about 2 months ago
JSON representation
Watches your files and executes unit tests for them
- Host: GitHub
- URL: https://github.com/ldgit/argus
- Owner: ldgit
- License: mit
- Created: 2017-07-22T18:15:50.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T04:55:16.000Z (over 2 years ago)
- Last Synced: 2024-04-15T08:10:49.837Z (about 1 year ago)
- Topics: argus, javascript, node, php, phpunit, test-runner, watch-files
- Language: JavaScript
- Homepage:
- Size: 852 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Argus test runner
[](https://www.npmjs.com/package/argus-test-runner)
[](https://travis-ci.org/ldgit/argus)
[](https://coveralls.io/github/ldgit/argus)
Watches your files and executes automated tests for them when they change.
## Note
These are the docs for **3.0.0** version.
For version **2.0** documentation see [here](../v2.0/README.md).
For version **1.4** documentation see [here](../v1.4/README.md).
## Requirements
- [Node.js](https://nodejs.org/en/) v12 or greater
- npm v6 or greater
## Installation
### Global installation
1. `npm install -g argus-test-runner`
2. Navigate to your project root
3. Create a configuration file named `argus.config.js` (see [configuration examples](#configuration-file-examples))
4. Type `argus` to start watching tests and corresponding production files
5. Type `argus -h` for usage information
### Local installation
1. If you already have a package.json in your project, you can also install argus-test-runner locally
2. Navigate to your project root and type `npm install --save-dev argus-test-runner`
3. Create a configuration file named `argus.config.js` (see [configuration examples](#configuration-file-examples))
4. Start Argus with `./node_modules/.bin/argus`
5. You can also add an npm script for convenience in your package.json:
```json
"devDependencies": {
"argus-test-runner": "^3.0.0"
},
"scripts": {
"test:watch": "argus"
}
```
and run `npm run test:watch`
To stop watching files just press `Ctrl + C`.
## Configuration
You must configure argus-test-runner by creating a configuration file. By default, `argus` looks for the configuration file named `argus.config.js` in the directory in which it is run, but you can specify a different location via `-c` console parameter, for example `argus -c ../my.custom.argus.config.js`.
Configuration files are written in _Javascript_.
### Configuration file examples
#### PHPUnit unit tests
```javascript
module.exports = {
environments: [
{
// File extension, in this case we are watching PHP files
extension: 'php',
// Suffix by which test files are identified
testNameSuffix: 'Test',
// Test directory mirrors your source directory structure
testDir: 'tests',
sourceDir: 'src',
testRunnerCommand: { command: 'vendor/bin/phpunit', arguments: [] },
},
],
};
```
#### PHPUnit unit and integration tests
```javascript
module.exports = {
environments: [
// Unit test environment
{
extension: 'php',
testNameSuffix: 'Test',
testDir: 'tests/unit',
sourceDir: 'src',
testRunnerCommand: { command: 'vendor/bin/phpunit', arguments: [] },
},
// Integration environment
{
extension: 'php',
testNameSuffix: 'Test',
testDir: 'tests/integration',
sourceDir: 'src',
// If you are using a different configuration file for your integration tests, you can specify it in the
// arguments list
testRunnerCommand: {
command: 'vendor/bin/phpunit',
arguments: ['-c', 'phpunit-integration.xml'],
},
},
],
};
```
#### PHPUnit unit tests and Javascript unit tests
```javascript
module.exports = {
environments: [
// PHPUnit test environment
{
extension: 'php',
testNameSuffix: 'Test',
testDir: 'tests/unit',
sourceDir: 'src',
testRunnerCommand: { command: 'vendor/bin/phpunit', arguments: [] },
},
// Javascript unit test environment
{
extension: 'js',
testNameSuffix: '.test',
testDir: 'tests/unit',
sourceDir: 'src',
// If you are using mocha for your Javascript tests
testRunnerCommand: { command: 'node_modules/.bin/mocha', arguments: [] },
// You can define a custom command to run all tests (runs when you press "a" when Argus is running).
// Otherwise Argus will use testRunnerCommand and its arguments to run all tests.
runAllTestsCommand: { command: 'npm', arguments: ['t'] },
},
],
};
```