Fail Lover <3

In two words

• You have tests that failed?
• You want to run them without running the tons of (selenium?) tests that take hours to execute?
• You don't want to add a special debug @group annotation for all of them?

No problem! This plugin allows you to rerun only tests that just failed!

Installation

Composer

Simply add this to your composer.json file:

"require": {
    "nikoms/phpunit-fail-lover": "dev-master"
}

Then run php composer.phar install

Quick configuration

Just add the listener to your phpunit.xml(.dist) file:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
    ...
    <listeners>
        <listener class="Nikoms\FailLover\Listener\FailLoverListener" />
    </listeners>
</phpunit>

Usage

Main usage

To use this plugin, simply run the phpunit command phpunit.

What does it do?

• The first time that the command is called, it will store the tests that failed into a csv file (output/fail-lover.csv by default. See the customize section to use another file).
• The second time that the command is called, it will only run the tests placed in this file. Then, the file will be replaced by a new one that contains only tests that failed in the second execution. So your file may lose weight if you have corrected some tests.
• Continue to call the command until the very last test passes. It will delete the file and the entire suite again will be launched again.

Customize

Temporary disable listener

You can temporary disable the log or replay plugin by simply add argument to the phpunit command:

• To disable log, use -d fail-lover=log:disabled
• To disable replay, use -d fail-lover=replay:disabled

Of course you can disable both: phpunit -d fail-lover=log:disabled -d fail-lover=replay:disabled

**Important note about "replay" mode: ** When the replay mode is used, filter options like --exclude-group, --group and --filter will be removed.

Input/Output

By default, the listener use output/fail-lover.csv to read and write the tests that failed. You can customize it by changing the listener this way:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
    ...
    <listeners>
        <listener class="Nikoms\FailLover\Listener\FailLoverListener">
            <arguments>
                <string>any/folder/myFile.whatever</string>
            </arguments>
        </listener>
    </listeners>
</phpunit>

If the specified file and folder don't exist, they will be created. A good practice is to give a path where you already create files, like "code coverage" for example.

File name helper

Sometimes, you may want to generate an alternative/dynamic file name. These are 3 patterns that you can use:

datetime

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
    ...
    <listeners>
        <listener class="Nikoms\FailLover\Listener\FailLoverListener">
            <arguments>
                <string>path/to/ouput/folder:datetime</string>
            </arguments>
        </listener>
    </listeners>
</phpunit>

Log: It will log tests that failed in the file name by the current time. Ex: path/to/ouput/folder/2014-09-16-225536. Replay: All tests will be launch.

uniqId

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
    ...
    <listeners>
        <listener class="Nikoms\FailLover\Listener\FailLoverListener">
            <arguments>
                <string>path/to/ouput/folder:uniqId</string>
            </arguments>
        </listener>
    </listeners>
</phpunit>

Log: It will log test that failed in a unique file name like path/to/ouput/folder/54177f8845685. Replay: All tests will be launch.

last

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
    ...
    <listeners>
        <listener class="Nikoms\FailLover\Listener\FailLoverListener">
            <arguments>
                <string>path/to/ouput/folder:last</string>
            </arguments>
        </listener>
    </listeners>
</phpunit>

Log: It will write tests that failed in the last modified file of the folder path/to/ouput/folder. If the folder is empty and at least one test fails, it creates the file fail-lover.txt. Replay: It will only launch tests from the last modified file in the folder path/to/ouput/folder. If the folder is empty, all tests will be executed.

Separate logger and replay

You can use a different file for the log and the replay by using separated listeners. In fact, the FailLoverListener seen above is just a shortcut of these two listeners.

Log only

If you just want to activate the log plugin because you just want to keep an history of failing tests. Add the listener to your phpunit.xml(.dist) file:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
    ...
    <listeners>
        <listener class="Nikoms\FailLover\Listener\LoggerListener">
            <arguments>
                <object class="Nikoms\FailLover\Storage\FileSystem\Csv\CsvRecorder">
                    <arguments>
                        <string>tests-that-failed.csv</string>
                    </arguments>
                </object>
            </arguments>
        </listener>
    </listeners>
</phpunit>

You can specify a dynamic file instead of a static one by changing the parameter of the Nikoms\FailLover\Storage\FileSystem\Csv\CsvRecorder. Indeed, it accepts a string or an object implementing Nikoms\FailLover\Storage\FileSystem\FileNameGeneration\FileNameGeneratorInterface.

Here is a example that will log tests that failed in a new file named with the datetime:

<listener class="Nikoms\FailLover\Listener\LoggerListener">
    <arguments>
        <object class="Nikoms\FailLover\Storage\FileSystem\Csv\CsvRecorder">
            <arguments>
                <object class="Nikoms\FailLover\Storage\FileSystem\FileNameGeneration\FileNameGenerator">
                    <arguments>
                        <string>output:datetime</string>
                    </arguments>
                </object>
            </arguments>
        </object>
    </arguments>
</listener>

Replay only

If you just want to activate the replay plugin because you only want to launch some broken tests. Add the listener to your phpunit.xml(.dist) file:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit>
    ...
    <listeners>
        <listener class="Nikoms\FailLover\Listener\ReplayListener">
            <arguments>
                <object class="Nikoms\FailLover\Storage\FileSystem\Csv\CsvReader">
                    <arguments>
                        <string>tests-that-failed-before.csv</string>
                    </arguments>
                </object>
            </arguments>
        </listener>
    </listeners>
</phpunit>

You can also specify a dynamic path because the class Nikoms\FailLover\Storage\FileSystem\Csv\CsvReader also accepts a string or an object implementing Nikoms\FailLover\Storage\FileSystem\FileNameGeneration\FileNameGeneratorInterface.

Here is a example that will replay tests from the last modified file:

<listener class="Nikoms\FailLover\Listener\ReplayListener">
    <arguments>
        <object class="Nikoms\FailLover\Storage\FileSystem\Csv\CsvReader">
            <arguments>
                <object class="Nikoms\FailLover\Storage\FileSystem\FileNameGeneration\FileNameGenerator">
                    <arguments>
                        <string>output:last</string>
                    </arguments>
                </object>
            </arguments>
        </object>
    </arguments>
</listener>