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

25 lines
758 B
Markdown
Raw Normal View History

2016-07-19 11:12:28 +02:00
Plugin Atoum
------------
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
=============
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).
- **executable** [string, optional] - Allows you to provide a path to the Atom binary (defaults to PHPCI root, vendor/bin, or a system-provided Atom binary).
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"
```