atoum/ruler-extension

This extension allows you to precisely filter test cases to run with a "natural language".

The extension adds a --filter option to atoum. This line now appears on the atoum help:

--filter: Filters tests to execute. For example 'not("featureA" in tags) and namespace = "foo\bar"'

You can now filter your tests using any Hoa\Ruler filter.

Example

./vendor/bin/atoum -d tests --filter 'not("featureA" in tags) and namespace = "foo\bar"'

This will only launch test that are not tagged with "featureA" and have the foo\bar namespace.

Available filters

Those variables are available in the filter:

method
class
namespace
testedclass
testedclassnamespace
tags (as an array)
extensions (as an array)

Install it

Install extension using composer:

composer require --dev atoum/ruler-extension

The extension will be automatically loaded. If you ever want to unload it, you can add this to your configuration file:

<?php

// .atoum.php

use mageekguy\atoum\ruler;

$runner->removeExtension(ruler\extension::class);

Examples

Filter on tags

Run all tests who have the needsDatabase tag:

./vendor/bin/atoum -d tests --filter 'tags contains "needsDatabase"'

Run all tests except those who have the needsDatabase tag:

./vendor/bin/atoum -d tests --filter 'not (tags contains "needsDatabase")'

You can also use the ruler's default in operator, but in that case that's less readable:

./vendor/bin/atoum -d tests --filter 'not ("needsDatabase" in tags)'

Read more about tags in atoum's documentation.

Filter on the test method name

Run all tests with a method named testMethod1:

./vendor/bin/atoum -d tests --filter 'method = "testMethod1'

Run all tests with a method named testMethod1 (using an array representing a list of methods to filter):

./vendor/bin/atoum -d tests --filter 'method in ["testMethod1"]'

Filter on the test classname

Run the test with the mageekguy\atoum\ruler\tests\units\testClass1 classname:

./vendor/bin/atoum -d tests --filter 'class = "mageekguy\atoum\ruler\tests\units\testClass1'

Filter on the test namespace

Run all tests in the mageekguy\atoum\ruler\tests\units namespace:

./vendor/bin/atoum -d tests --filter 'namespace = "mageekguy\atoum\ruler\tests\units'

Filter on the tested class name

Run the tests that test the mageekguy\atoum\ruler\testClass1 class:

./vendor/bin/atoum -d tests --filter 'testedclass = "mageekguy\atoum\ruler\testClass1'

Filter on the tested class namespace

Run the tests that test the classes in the mageekguy\atoum\ruler namespace:

./vendor/bin/atoum -d tests --filter 'testedclassnamespace = "mageekguy\atoum\ruler'

Filter on the test required extensions

Run all tests that needs the blackfire extension :

./vendor/bin/atoum -d tests --filter 'extensions contains "blackfire"'