phpunit-tideways-listener

Test Listener for PHPUnit that uses Tideways' profiler extension for PHP 7 to dump profiling information.

Installation

You can add this library as a local, per-project, development-time dependency to your project using Composer:

composer require --dev phpunit/phpunit-tideways-listener

Usage

The example below shows how you activate and configure this test listener in your PHPUnit XML configuration file:

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.4/phpunit.xsd"
         bootstrap="vendor/autoload.php"
         executionOrder="depends,defects"
         forceCoversAnnotation="true"
         beStrictAboutCoversAnnotation="true"
         beStrictAboutOutputDuringTests="true"
         beStrictAboutTodoAnnotatedTests="true"
         verbose="true">
    <testsuites>
        <testsuite name="default">
            <directory>tests</directory>
        </testsuite>
    </testsuites>

    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <directory>src</directory>
        </whitelist>
    </filter>

    <extensions>
        <extension class="PHPUnit\Xhgui\TestListener">
            <arguments>
                <string>/tmp</string>
            </arguments>
        </extension>
    </extensions>
</phpunit>

The following elements are relevant to this test listener and its configuration:

• <extensions> is the configuration section for test runner extensions
• <extension> configures (an instance of) the PHPUnit\Xhgui\TestListener class as a test runner extension
• <arguments> is the configuration for that test runner extension
• The only argument is the path to the directory where the profile information for each test is to be dumped, in this example /tmp

The rest of the phpunit.xml example shown above are best practice configuration defaults that were generated using phpunit --generate-configuration.

For each test that was run there will be a .json file in the specified directory. These file contain the json_encode()d profiling data returned by the profiler extension.