php-censor/docs/en/plugins/atoum.md

26 lines
764 B
Markdown
Raw Permalink Normal View History

2016-07-19 11:12:28 +02:00
Plugin Atoum
2017-01-04 13:22:20 +01:00
============
2016-07-19 11:12:28 +02:00
2016-07-17 16:20:35 +02:00
Allows you to run [Atoum](https://github.com/atoum/atoum) unit tests.
2016-07-19 11:12:28 +02:00
Configuration
2017-01-04 13:22:20 +01:00
-------------
2016-07-19 11:12:28 +02:00
2016-07-17 16:20:35 +02:00
### Options
- **args** [string, optional] - Allows you to pass command line arguments to Atoum.
- **config** [string, optional] - Path to an Atoum configuration file.
- **directory** [string, optional] - Path in which to run Atom (defaults to the build root).
2017-07-18 15:54:24 +02:00
- **executable** [string, optional] - Allows you to provide a path to the Atom binary (defaults to PHP Censor root,
vendor/bin, or a system-provided Atom binary).
2016-07-17 16:20:35 +02:00
2016-07-19 11:12:28 +02:00
### Examples
2016-07-17 16:20:35 +02:00
```yml
test:
atoum:
args: "command line arguments go here"
config: "path to config file"
directory: "directory to run tests"
executable: "path to atoum executable"
```