Download the PHP package ergebnis/phpunit-slow-test-detector without Composer

On this page you can find all versions of the php package ergebnis/phpunit-slow-test-detector. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of ergebnis/phpunit-slow-test-detector

Informations about the package phpunit-slow-test-detector

phpunit-slow-test-detector

Integrate Merge Nightly Release Renew

Code Coverage

Latest Stable Version Total Downloads Monthly Downloads

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:

Compatibility

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

Installation

Installation with composer

Run

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

adjust your phpunit.xml configuration file and configure the

To bootstrap the extension as a composer package when using

adjust your phpunit.xml configuration file and configure the

To bootstrap the extension as a composer package when using

adjust your phpunit.xml configuration file and configure the

Bootstrapping the extension as a PHAR

To bootstrap the extension as a PHAR when using

adjust your phpunit.xml configuration file and configure the

To bootstrap the extension as a PHAR when using

adjust your phpunit.xml configuration file and configure the

Configuring the extension

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

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

Configuring the extension

To configure the extension when using

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

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

To configure the extension when using

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, the maximum width of the slow test report to the width of the terminal, and directs the slow test report output to stderr:

To configure the extension when using

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, the maximum width of the slow test report to the width of the terminal, and directs the slow test report output to stderr:

Emitting GitHub Actions annotations

When the extension detects slow tests, it can additionally emit them as GitHub Actions annotations, so that they show up in the summary of a workflow run.

The extension prints one warning workflow command per reported slow test, to the same stream as the slow test report, for example:

This is disabled by default. You can enable it with the github-actions-annotations parameter:

The following example enables GitHub Actions annotations when running on GitHub Actions and using phpunit/phpunit:^10.0.0 and later:

When using phpunit/phpunit:^6.5.0, phpunit/phpunit:^7.5.0, phpunit/phpunit:^8.5.19, or phpunit/phpunit:^9.0.0, configure the github-actions-annotations element in the arguments element:

The number of annotations follows the maximum-count parameter. Note that GitHub Actions shows at most 10 warning annotations per step (a single run of phpunit) and 50 per job (across all of its steps), so annotations beyond that do not appear in the summary of a workflow run.

Configuring the maximum duration per test case

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

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

[!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

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

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.

PHP Version Support Policy

This project currently supports the following PHP versions:

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 X.

All versions of phpunit-slow-test-detector with dependencies

PHP Build Version
Package Version
Requires php Version ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0 || ~8.6.0
ext-mbstring Version *
phpunit/phpunit Version ^6.5.0 || ^7.5.0 || ^8.5.19 || ^9.0.0 || ^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ergebnis/phpunit-slow-test-detector contains the following files

Loading the files please wait ...