Reports on slow-running tests in your PHPUnit test suite
PHP
Latest commit 6126919 Feb 20, 2017 @johnkary committed on GitHub Merge pull request #26 from johnkary/support60
Add support for PHPUnit 6.0

README.md

phpunit-speedtrap

Build Status

SpeedTrap reports on slow-running tests in your PHPUnit test suite right in your console.

Many factors affect test execution time. A test not properly isolated from variable latency (database, network, etc.) and even basic load on your test machine will cause test times to fluctuate.

SpeedTrap helps you identify slow tests but cannot tell you why those tests are slow. For that you should check out Blackfire.io for easy profiling your test suite, or another PHPUnit listener PHPUnit_Listener_XHProf, to help identify specifically which methods in your call stack are slow.

Screenshot of terminal using SpeedTrap

Installation

SpeedTrap is installable via Composer and should be added as a require-dev dependency:

composer require --dev johnkary/phpunit-speedtrap

Usage

Enable with all defaults by adding the following to your test suite's phpunit.xml file:

<phpunit bootstrap="vendor/autoload.php">
...
    <listeners>
        <listener class="JohnKary\PHPUnit\Listener\SpeedTrapListener" />
    </listeners>
</phpunit>

Now run your test suite as normal. If tests run that exceed the slowness threshold (500ms by default), SpeedTrap will report on them in the console after the suite completes.

Configuration

SpeedTrap has two configurable parameters:

  • slowThreshold - Number of milliseconds a test takes to execute before being considered "slow" (Default: 500ms)
  • reportLength - Number of slow tests included in the report (Default: 10 tests)

These configuration parameters are set in phpunit.xml when adding the listener:

<phpunit bootstrap="vendor/autoload.php">
    <!-- ... other suite configuration here ... -->

    <listeners>
        <listener class="JohnKary\PHPUnit\Listener\SpeedTrapListener">
            <arguments>
                <array>
                    <element key="slowThreshold">
                        <integer>500</integer>
                    </element>
                    <element key="reportLength">
                        <integer>5</integer>
                    </element>
                </array>
            </arguments>
        </listener>
    </listeners>
</phpunit>

This allows you to set your own criteria for "slow" tests, and how many you care to know about.

Custom slow threshold per-test method

You may have a few tests in your suite that take a little bit longer to run, and want to have a higher slow threshold than the rest of your suite.

You can use the annotation @slowThreshold to set a custom slow threshold on a per-test method basis. This number can be higher or lower than the default threshold and will be used in place of the default threshold for that specific test.

class SomeTestCase extends \PHPUnit_Framework_TestCase
{
    /**
     * @slowThreshold 5000
     */
    public function testLongRunningProcess()
    {
        // Code to exercise your long-running SUT
    }
}

Inspiration

This project was inspired by Rspec's -p option that displays feedback about slow tests.

License

phpunit-speedtrap is available under the MIT License.