包简介

Provides facilities for detecting slow tests in phpunit/phpunit.

README 文档

README

This project provides a composer package and a Phar archive with an extension for detecting slow tests in phpunit/phpunit.

Example

After installing, configuring, and bootstrapping the extension, when running your tests with phpunit/phpunit, the extension will report slow tests:

PHPUnit 10.0.0 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.1.0
Configuration: test/EndToEnd/Default/phpunit.xml
Random Seed:   1676103726

.............                                                                                                                                                                                                                                                                                                   13 / 13 (100%)

Detected 11 tests where the duration exceeded the global maximum duration (0.500).

 # Duration Test
----------------------------------------------------------------------------------------------------------------------------------------------------
 1    1.604 Ergebnis\PHPUnit\SlowTestDetector\Test\EndToEnd\Default\SleeperTest::testSleeperSleepsLongerThanDefaultMaximumDurationWithDataProvider#9
 2    1.505 Ergebnis\PHPUnit\SlowTestDetector\Test\EndToEnd\Default\SleeperTest::testSleeperSleepsLongerThanDefaultMaximumDurationWithDataProvider#8
 3    1.403 Ergebnis\PHPUnit\SlowTestDetector\Test\EndToEnd\Default\SleeperTest::testSleeperSleepsLongerThanDefaultMaximumDurationWithDataProvider#7
 4    1.303 Ergebnis\PHPUnit\SlowTestDetector\Test\EndToEnd\Default\SleeperTest::testSleeperSleepsLongerThanDefaultMaximumDurationWithDataProvider#6
 5    1.205 Ergebnis\PHPUnit\SlowTestDetector\Test\EndToEnd\Default\SleeperTest::testSleeperSleepsLongerThanDefaultMaximumDurationWithDataProvider#5
 6    1.103 Ergebnis\PHPUnit\SlowTestDetector\Test\EndToEnd\Default\SleeperTest::testSleeperSleepsLongerThanDefaultMaximumDurationWithDataProvider#4
 7    1.005 Ergebnis\PHPUnit\SlowTestDetector\Test\EndToEnd\Default\SleeperTest::testSleeperSleepsLongerThanDefaultMaximumDurationWithDataProvider#3
 8    0.905 Ergebnis\PHPUnit\SlowTestDetector\Test\EndToEnd\Default\SleeperTest::testSleeperSleepsLongerThanDefaultMaximumDurationWithDataProvider#2
 9    0.805 Ergebnis\PHPUnit\SlowTestDetector\Test\EndToEnd\Default\SleeperTest::testSleeperSleepsLongerThanDefaultMaximumDurationWithDataProvider#1
10    0.705 Ergebnis\PHPUnit\SlowTestDetector\Test\EndToEnd\Default\SleeperTest::testSleeperSleepsLongerThanDefaultMaximumDurationWithDataProvider#0
----------------------------------------------------------------------------------------------------------------------------------------------------
      0.000
       └─── seconds

There is 1 additional slow test that is not listed here.

Time: 00:12.601, Memory: 8.00 MB

OK (13 tests, 13 assertions)

Compatibility

The extension is compatible with the following versions of phpunit/phpunit:

Installation

Installation with `composer`

Run

composer require --dev ergebnis/phpunit-slow-test-detector

to install ergebnis/phpunit-slow-test-detector as a composer package.

Installation as Phar

Download phpunit-slow-test-detector.phar from the latest release.

Usage

Bootstrapping the extension

Before the extension can detect slow tests in phpunit/phpunit, you need to bootstrap it. The bootstrapping mechanism depends on the version of phpunit/phpunit you are using.

Bootstrapping the extension as a `composer` package

To bootstrap the extension as a composer package when using

phpunit/phpunit:^13.0.0
phpunit/phpunit:^12.0.0
phpunit/phpunit:^11.0.0
phpunit/phpunit:^10.0.0

adjust your phpunit.xml configuration file and configure the

 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     bootstrap="vendor/autoload.php"
 >
+    <extensions>
+        <bootstrap class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
+    </extensions>
     <testsuites>
         <testsuite name="unit">
             <directory>test/Unit/</directory>
         </testsuite>
     </testsuites>
 </phpunit>

To bootstrap the extension as a composer package when using

phpunit/phpunit:^9.0.0
phpunit/phpunit:^8.5.19
phpunit/phpunit:^7.5.0

adjust your phpunit.xml configuration file and configure the

 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     bootstrap="vendor/autoload.php"
 >
+    <extensions>
+        <extension class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
+    </extensions>
     <testsuites>
         <testsuite name="unit">
             <directory>test/Unit/</directory>
         </testsuite>
     </testsuites>
 </phpunit>

To bootstrap the extension as a composer package when using

phpunit/phpunit:^6.5.0

adjust your phpunit.xml configuration file and configure the

listeners element on phpunit/phpunit:^6.5.0

 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     bootstrap="vendor/autoload.php"
 >
+    <listeners>
+        <listener class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
+    </listeners>
     <testsuites>
         <testsuite name="unit">
             <directory>test/Unit/</directory>
         </testsuite>
     </testsuites>
 </phpunit>

Bootstrapping the extension as a PHAR

To bootstrap the extension as a PHAR when using

phpunit/phpunit:^13.0.0
phpunit/phpunit:^12.0.0
phpunit/phpunit:^11.0.0
phpunit/phpunit:^10.0.0

adjust your phpunit.xml configuration file and configure the

extensionsDirectory attribute and the extensions element on phpunit/phpunit:^13.0.0
extensionsDirectory attribute and the extensions element on phpunit/phpunit:^12.0.0
extensionsDirectory attribute and the extensions element on phpunit/phpunit:^11.0.0
extensionsDirectory attribute and the extensions element on phpunit/phpunit:^10.0.0

 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     bootstrap="vendor/autoload.php"
+    extensionsDirectory="directory/where/you/saved/the/extension/phars"
 >
+    <extensions>
+        <extension class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
+    </extensions>
     <testsuites>
         <testsuite name="unit">
             <directory>test/Unit/</directory>
         </testsuite>
     </testsuites>
 </phpunit>

To bootstrap the extension as a PHAR when using

phpunit/phpunit:^9.0.0
phpunit/phpunit:^8.5.19
phpunit/phpunit:^7.5.0

adjust your phpunit.xml configuration file and configure the

extensionsDirectory attribute and the extensions element on phpunit/phpunit:^9.0.0
extensionsDirectory attribute and the extensions element on phpunit/phpunit:^8.5.19
extensionsDirectory attribute and the extensions element on phpunit/phpunit:^7.5.0

 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     bootstrap="vendor/autoload.php"
+    extensionsDirectory="directory/where/you/saved/the/extension/phars"
 >
+    <extensions>
+        <bootstrap class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
+    </extensions>
     <testsuites>
         <testsuite name="unit">
             <directory>test/Unit/</directory>
         </testsuite>
     </testsuites>
 </phpunit>

Configuring the extension

You can configure the extension with the following options in your phpunit.xml configuration file:

maximum-count, an int, the maximum count of slow test that should be reported, defaults to 10
maximum-duration, an int, the maximum duration in milliseconds for a test before the extension considers it as a slow test, defaults to 500
stderr, a bool, directs the slow test report output to stderr, defaults to false, only available on phpunit/phpunit:^6.5.0, phpunit/phpunit:^7.5.0, phpunit/phpunit:^8.5.19, and phpunit/phpunit:^9.0.0 (on phpunit/phpunit:^10.0.0 and later, the extension automatically respects the stderr configuration phpunit/phpunit)

The configuration mechanism depends on the version of phpunit/phpunit you are using.

Configuring the extension

To configure the extension when using

phpunit/phpunit:^13.0.0
phpunit/phpunit:^12.0.0
phpunit/phpunit:^11.0.0
phpunit/phpunit:^10.0.0

adjust your phpunit.xml configuration file and configure one or more

The following example configures the maximum count of slow tests to three, and the maximum duration for all tests to 250 milliseconds:

 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     bootstrap="vendor/autoload.php"
 >
     <extensions>
-        <bootstrap class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
+        <bootstrap class="Ergebnis\PHPUnit\SlowTestDetector\Extension">
+            <parameter name="maximum-count" value="3"/>
+            <parameter name="maximum-duration" value="250"/>
+        </bootstrap>
     </extensions>
     <testsuites>
         <testsuite name="unit">
             <directory>test/Unit/</directory>
        </testsuite>
     </testsuites>
 </phpunit>

To configure the extension when using

phpunit/phpunit:^9.0.0
phpunit/phpunit:^8.5.19
phpunit/phpunit:^7.5.0

adjust your phpunit.xml configuration file and configure the

The following example configures the maximum count of slow tests to three, the maximum duration for all tests to 250 milliseconds, and directs the slow test report output to stderr:

 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     bootstrap="vendor/autoload.php"
 >
     <extensions>
-        <extension class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
+        <extension class="Ergebnis\PHPUnit\SlowTestDetector\Extension">
+            <arguments>
+                <array>
+                    <element key="maximum-count">
+                        <integer>3</integer>
+                    </element>
+                    <element key="maximum-duration">
+                        <integer>250</integer>
+                    </element>
+                    <element key="stderr">
+                        <boolean>true</boolean>
+                    </element>
+                </array>
+            </arguments>
+        </extension>
     </extensions>
     <testsuites>
         <testsuite name="unit">
             <directory>test/Unit/</directory>
        </testsuite>
     </testsuites>
 </phpunit>

To configure the extension when using

phpunit/phpunit:^6.5.0

adjust your phpunit.xml configuration file and configure the

arguments element on phpunit/phpunit:^6.5.0

The following example configures the maximum count of slow tests to three, the maximum duration for all tests to 250 milliseconds, and directs the slow test report output to stderr:

 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     bootstrap="vendor/autoload.php"
 >
     <listeners>
-        <listener class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
+        <listener class="Ergebnis\PHPUnit\SlowTestDetector\Extension">
+            <arguments>
+                <array>
+                    <element key="maximum-count">
+                        <integer>3</integer>
+                    </element>
+                    <element key="maximum-duration">
+                        <integer>250</integer>
+                    </element>
+                    <element key="stderr">
+                        <boolean>true</boolean>
+                    </element>
+                </array>
+            </arguments>
+        </listener>
     </listeners>
     <testsuites>
         <testsuite name="unit">
             <directory>test/Unit/</directory>
        </testsuite>
     </testsuites>
 </phpunit>

Configuring the maximum duration per test case

You can configure the maximum duration for a single test case with

an Attribute\MaximumDuration attribute when using
- phpunit/phpunit:^13.0.0
- phpunit/phpunit:^12.0.0
- phpunit/phpunit:^11.0.0
- phpunit/phpunit:^10.0.0
a @maximumDuration annotation in the DocBlock when using
- phpunit/phpunit:^9.0.0
- phpunit/phpunit:^8.5.19
- phpunit/phpunit:^7.5.0
- phpunit/phpunit:^6.5.0
a @slowThreshold annotation in the DocBlock when using
- phpunit/phpunit:^9.0.0
- phpunit/phpunit:^8.5.19
- phpunit/phpunit:^7.5.0
- phpunit/phpunit:^6.5.0

The following example configures the maximum durations for single test cases to 5,000 ms, 4,000 ms, and 3,000 ms:

<?php

declare(strict_types=1);

use PHPUnit\Framework;
use Ergebnis\PHPUnit\SlowTestDetector;

final class ExtraSlowTest extends Framework\TestCase
{
    #[SlowTestDetector\Attribute\MaximumDuration(5000)]
    public function testExtraExtraSlow(): void
    {
        // ...
    }

    /**
     * @maximumDuration 4000
     */
    public function testAlsoQuiteSlow(): void
    {
        // ...
    }

    /**
     * @slowThreshold 3000
     */
    public function testQuiteSlow(): void
    {
        // ...
    }
}

Note

Support for the @slowThreshold annotation exists only to help you move from johnkary/phpunit-speedtrap. It will be deprecated and removed in the near future.

Understanding measured test durations

Understanding measured test durations when using the new event system

When using

phpunit/phpunit:^13.0.0
phpunit/phpunit:^12.0.0
phpunit/phpunit:^11.0.0
phpunit/phpunit:^10.0.0

the extension uses the new event system of phpunit/phpunit, and measures the duration between the points in time when the PHPUnit\Event\Test\PreparationStarted and PHPUnit\Event\Test\Finished are emitted.

Understanding measured test durations when using the hooks event system

When using

phpunit/phpunit:^9.0.0
phpunit/phpunit:^8.5.19
phpunit/phpunit:^7.5.0
phpunit/phpunit:^6.5.0

the extension uses the hooks event system of phpunit/phpunit, and measures the duration that is passed to the PHPUnit\Runner\AfterTestHook. This is the duration of invoking PHPUnit\Framework\TestCase::runBare() and more.

Note

Because of this behavior, the measured test durations can and will vary depending on the order in which phpunit/phpunit executes tests.

Changelog

The maintainers of this project record notable changes to this project in a changelog.

Contributing

The maintainers of this project suggest following the contribution guide.

Code of Conduct

The maintainers of this project ask contributors to follow the code of conduct.

General Support Policy

The maintainers of this project provide limited support.

You can support the maintenance of this project by sponsoring @ergebnis.

PHP Version Support Policy

This project currently supports the following PHP versions:

PHP 7.0 (has reached its end of life on January 10, 2019)
PHP 7.1 (has reached its end of life on December 1, 2019)
PHP 7.2 (has reached its end of life on November 30, 2020)
PHP 7.3 (has reached its end of life on December 6, 2021)
PHP 7.4 (has reached its end of life on November 28, 2022)
PHP 8.0 (has reached its end of life on November 26, 2023)
PHP 8.1 (has reached its end of life on December 31, 2025)
PHP 8.2
PHP 8.3
PHP 8.4
PHP 8.5

The maintainers of this project add support for a PHP version following its initial release and may drop support for a PHP version when it has reached its end of life.

Security Policy

This project has a security policy.

License

This project uses the MIT license.

Credits

This package is inspired by johnkary/phpunit-speedtrap, originally licensed under MIT by John Kary.

Social

Follow @localheinz and @ergebnis on Twitter.

ergebnis/phpunit-slow-test-detector 适用场景与选型建议

ergebnis/phpunit-slow-test-detector 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 9.51M 次下载、GitHub Stars 达 148，最近一次更新时间为 2021 年 01 月 24 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「phpunit」「test」「extension」「detector」「slow」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 ergebnis/phpunit-slow-test-detector 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 ergebnis/phpunit-slow-test-detector 我们能提供哪些服务？

定制开发 / 二次开发

基于 ergebnis/phpunit-slow-test-detector 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 ergebnis/phpunit-slow-test-detector 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

hiqdev/hidev-phpunit 3

HiDev plugin for PHPUnit

albertcht/lumen-testing 43

Testing Suite For Lumen like Laravel does.

schranz/test-generator 8

A cli tool which generates unit tests.

geertw/yii2-translatable-url-rule 14

A custom URL rule class for Yii 2 which allows to create translated URL rules

slavkovrn/yii2-imagecarousel 5

The Yii2 extension uses jQuery jquery.carousel-1.1.min.js and makes image carousel from php array of structure defined.

t3brightside/gallerycontent 0

TYPO3 CMS extension to create gallery content element with preset crop ratios and pagination

ergebnis/phpunit-slow-test-detector

包简介

关键字：

README 文档

README

Example

Compatibility

Installation

Installation with `composer`

Installation as Phar

Usage

Bootstrapping the extension

Bootstrapping the extension as a `composer` package

Bootstrapping the extension as a PHAR

Configuring the extension

Configuring the extension

Configuring the maximum duration per test case

Understanding measured test durations

Understanding measured test durations when using the new event system

Understanding measured test durations when using the hooks event system

Changelog

Contributing

Code of Conduct

General Support Policy

PHP Version Support Policy

Security Policy

License

Credits

Social

ergebnis/phpunit-slow-test-detector 适用场景与选型建议

与 ergebnis/phpunit-slow-test-detector 相关的其它包

统计信息

GitHub 信息

其他信息

ergebnis/phpunit-slow-test-detector

包简介

关键字：

README 文档

README

Example

Compatibility

Installation

Installation with composer

Installation as Phar

Usage

Bootstrapping the extension

Bootstrapping the extension as a composer package

Bootstrapping the extension as a PHAR

Configuring the extension

Configuring the extension

Configuring the maximum duration per test case

Understanding measured test durations

Understanding measured test durations when using the new event system

Understanding measured test durations when using the hooks event system

Changelog

Contributing

Code of Conduct

General Support Policy

PHP Version Support Policy

Security Policy

License

Credits

Social

ergebnis/phpunit-slow-test-detector 适用场景与选型建议

与 ergebnis/phpunit-slow-test-detector 相关的其它包

统计信息

GitHub 信息

其他信息

Installation with `composer`

Bootstrapping the extension as a `composer` package