atoum/config-extension

atoum extension to use Yaml configuration files

atoum/config-extension

This extension will allow you to configure atoum using a YAML file and/or environnement variables., _(*1)

Example

When using this extension, you can put a .atoum.yml on the root of your repository to configure atoum. Here is an exemple on how to tell atoum to look for unit tests in the tests/units/classes folder., _(*2)

# .atoum.yml

atoum:
    directories:
        - ./tests/units/classes

Install it

Install extension using composer:, _(*3)

composer require --dev atoum/config-extension

Enable the extension using atoum configuration file:, _(*4)

<?php

// .atoum.php

require_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';

use mageekguy\atoum\config;

$runner->addExtension(new config\extension($script));

// Or

new config\extension($script);

Use it

# .atoum.yml

atoum:
    directories:
        - ./tests/units/classes

    fields:
        report.default:
            - field.logo
            - field.logo.result
            - field.coverage

    reports:
        - report.default
        - report.coverage.clover

Configuration reference

atoum.loop

boolean : enable/disable atoum's loop mode. Defaults on ATOUM_LOOP environnement variable., _(*5)

Exemple:, _(*6)

atoum:
  loop: true

atoum.debug

boolean : enable/disable atoum's debug mode. Defaults on ATOUM_DEBUG environnement variable., _(*7)

Exemple:, _(*8)

atoum:
  debug: true

atoum.verbosity

integer : value between 1 and 3 determining atoum's verbosity level'. Defaults on ATOUM_VERBOSITY environnement variable., _(*9)

Exemple:, _(*10)

atoum:
  verbosity: 2

atoum.directories

array : List of directories where atoum will look for unit tests. Defaults on ATOUM_DIRECTORIES environnement variable (a coma separated list of directories)., _(*11)

atoum:
    directories:
        - ./tests/units/classes

atoum.reports

array : List of reports. Defaults on ATOUM_REPORTS environnement variable (a coma separated list of reports)., _(*12)

Example:, _(*13)

atoum:
    reports:
        - report.default
        - report.coverage.clover

Possible values :, _(*14)

report.default

adds atoum's default reporter (when the reports key is defined, atoum's default reporter is no longer used)., _(*15)

report.coverage.clover

Adds a clover coverage reporter., _(*16)

Path to were the report will be written could be configured using the coverage.clover.filename parameter., _(*17)

report.xunit

Adds an xUnit reporter., _(*18)

Path to were the report will be written could be configured using the xunit.filename parameter., _(*19)

report.tap

Adds a TAP reporter., _(*20)

report.vim

Adds a vim reporter., _(*21)

report.nyancat

Adds a reporter that displays a nyancat., _(*22)

report.santa

Adds a santa reporter., _(*23)

atoum.fields

Fields allows you to customize reports. You can add fields for each report., _(*24)

You need to add the report name as key, then add an array of fields., _(*25)

This example adds the logo field to the default report :, _(*26)

atoum:
    reports:
        - report.default

    fields:
        report.default:
            - field.logo

field.logo

Displays atoum's logo at the begining of the report. Only works on cli reports., _(*27)

field.logo.result

Displays atoum's logo at the end of the report. Only works on cli reports., _(*28)

field.coverage.html

Generate an HTML coverage reports. Needs the php extension xdebug to be installed., _(*29)

The project name in generated report and folder where the report will be generated could by configured with the project.name and coverage.html.directory and parameters., _(*30)

parameters

You can customize the way reports or fields are generated using the parameters section on the .atoum.yml file., _(*31)

Here is an example that changes the path where the xunit report is generated:, _(*32)

atoum:
    reports:
        - report.xml
parameters:
    xunit.filename: "mylogs/file.xml"

xunit.filename

Default value : xunit.xml., _(*33)

Path were the xUnit report will be written in the report.xunit report., _(*34)

The directory where the file is generated must exists, it will not be created by atoum., _(*35)

coverage.html.directory

Default value : ./coverage., _(*36)

Path to the folder where the HTML coverage files will be written. See field.coverage.html field., _(*37)

project.name

Default value : atoum., _(*38)

Will be used when generating the field.coverage.html field., _(*39)

coverage.clover.filename

Default value : clover.xml., _(*40)

Path where the clover report will be written in the report.clover report., _(*41)

Links

• atoum
• atoum's documentation

License

config-extension is released under the BSD-3-Clause License. See the bundled LICENSE file for details., _(*42)

, _(*43)