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
Example:
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 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.
Informations about the package phpunit-slow-test-detector
phpunit-slow-test-detector
This project provides a composer package and a Phar archive with an extension for detecting slow tests in phpunit/phpunit.
The extension is compatible with the following versions of phpunit/phpunit:
phpunit/phpunit:^6.5.0phpunit/phpunit:^7.5.0phpunit/phpunit:^8.5.19phpunit/phpunit:^9.0.0phpunit/phpunit:^10.0.0phpunit/phpunit:^11.0.0
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
phpunit/phpunit:^6.5.0
adjust your phpunit.xml configuration file and configure the
To bootstrap the extension as a composer package when using
phpunit/phpunit:^7.5.0phpunit/phpunit:^8.5.19phpunit/phpunit:^9.0.0
adjust your phpunit.xml configuration file and configure the
extensionselement onphpunit/phpunit:^7.5.0extensionselement onphpunit/phpunit:^8.5.19extensionselement onphpunit/phpunit:^9.0.0
To bootstrap the extension as a composer package when using
phpunit/phpunit:^10.0.0phpunit/phpunit:^11.0.0
adjust your phpunit.xml configuration file and configure the
Bootstrapping the extension as a PHAR
To bootstrap the extension as a PHAR when using
phpunit/phpunit:^7.5.0phpunit/phpunit:^8.5.19phpunit/phpunit:^9.0.0
adjust your phpunit.xml configuration file and configure the
extensionsDirectoryattribute and theextensionselement onphpunit/phpunit:^7.5.0extensionsDirectoryattribute and theextensionselement onphpunit/phpunit:^8.5.19extensionsDirectoryattribute and theextensionselement onphpunit/phpunit:^9.0.0
To bootstrap the extension as a PHAR when using
phpunit/phpunit:^10.0.0phpunit/phpunit:^11.0.0
adjust your phpunit.xml configuration file and configure the
extensionsDirectoryattribute and theextensionselement onphpunit/phpunit:^10.0.0extensionsDirectoryattribute and theextensionselement onphpunit/phpunit:^11.0.0
Configuring the extension
You can configure the extension with the following options in your phpunit.xml configuration file:
maximum-count, anint, the maximum count of slow test that should be reported, defaults to10maximum-duration, anint, the maximum duration in milliseconds for a test before the extension considers it as a slow test, defaults to500
The configuration mechanism depends on the version of phpunit/phpunit you are using.
Configuring the extension
To configure the extension when using
phpunit/phpunit:^6.5.0
adjust your phpunit.xml configuration file and configure the
The following example configures the maximum count of slow tests to three, and the maximum duration for all tests to 250 milliseconds:
To configure the extension when using
phpunit/phpunit:^7.5.0phpunit/phpunit:^8.5.19phpunit/phpunit:^9.0.0
adjust your phpunit.xml configuration file and configure the
argumentselement onphpunit/phpunit:^7.5.0argumentselement onphpunit/phpunit:^8.5.19argumentselement onphpunit/phpunit:^9.0.0
The following example configures the maximum count of slow tests to three, and the maximum duration for all tests to 250 milliseconds:
To configure the extension when using
phpunit/phpunit:^10.0.0phpunit/phpunit:^11.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:
Configuring the maximum duration per test case
You can configure the maximum duration for a single test case with
- an
Attribute\MaximumDurationattribute when usingphpunit/phpunit:^10.0.0phpunit/phpunit:^11.0.0
- a
@maximumDurationannotation in the DocBlock when usingphpunit/phpunit:^6.5.0phpunit/phpunit:^7.5.0phpunit/phpunit:^8.5.19phpunit/phpunit:^9.0.0
- a
@slowThresholdannotation in the DocBlock when usingphpunit/phpunit:^6.5.0phpunit/phpunit:^7.5.0phpunit/phpunit:^8.5.19phpunit/phpunit:^9.0.0
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
@slowThresholdannotation exists only to help you move fromjohnkary/phpunit-speedtrap. It will be deprecated and removed in the near future.
Running tests
When you have bootstrapped the extension, you can run your tests as usually:
When the extension has detected slow tests, it will report them:
Understanding measured test durations
When using
phpunit/phpunit:^6.5.0phpunit/phpunit:^7.5.0phpunit/phpunit:^8.5.19-
phpunit/phpunit:^9.0.0 - the extension uses the hooks event system of
phpunit/phpunit.
The hooks event system supports eleven hook methods that phpunit/phpunit invokes during the execution of tests.
When the extension uses the hooks event system, it uses the PHPUnit\Runner\AfterTestHook, which receives the duration of invoking PHPUnit\Framework\TestCase::runBare() and more.
When phpunit/phpunit invokes PHPUnit\Framework\TestCase::runBare(), it will invoke the following methods before the first test method in the class:
When phpunit/phpunit invokes PHPUnit\Framework\TestCase::runBare(), it will invoke the following methods before every test method in the class:
PHPUnit\Framework\TestCase::setUp()and methods annotated with@beforePHPUnit\Framework\TestCase::assertPreConditions()
When phpunit/phpunit invokes PHPUnit\Framework\TestCase::runBare(), it will invoke the following methods after every test method in the class:
PHPUnit\Framework\TestCase::assertPostConditions()PHPUnit\Framework\TestCase::tearDown()and methods annotated with@after
When phpunit/phpunit invokes PHPUnit\Framework\TestCase::runBare(), it will invoke the following methods after the last test method in the class:
[!NOTE] Because of this behavior, the measured test durations can and will vary depending on the order in which
phpunit/phpunitexecutes tests.
When using
phpunit/phpunit:^10.0.0phpunit/phpunit:^11.0.0
the extension uses the new event system of phpunit/phpunit.
The new event system supports a wide range of events that phpunit/phpunit emits during the execution of tests.
When the extension uses the new event system, it uses and subscribes to the PHPUnit\Event\Test\PreparationStarted and PHPUnit\Event\Test\Finished events and measures the duration between the points in time when phpunit/phpunit emits the former and the latter.
When phpunit/phpunit invokes PHPUnit\Framework\TestCase::runBare(), it will invoke the following methods before the first test method in the class:
When phpunit/phpunit invokes PHPUnit\Framework\TestCase::runBare(), it will invoke the following methods before every test method in the class:
PHPUnit\Framework\TestCase::setUp()and methods annotated with@beforePHPUnit\Framework\TestCase::assertPreConditions()
When phpunit/phpunit invokes PHPUnit\Framework\TestCase::runBare(), it will invoke the following methods after every test method in the class:
PHPUnit\Framework\TestCase::assertPostConditions()PHPUnit\Framework\TestCase::tearDown()and methods annotated with@after
When phpunit/phpunit invokes PHPUnit\Framework\TestCase::runBare(), it will invoke the following methods after the last test method in the class:
[!NOTE] Because of this behavior, the measured test durations can and will vary depending on the order in which
phpunit/phpunitexecutes 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 @localheinz or requesting an invoice for services related to this project.
PHP Version Support Policy
This project supports PHP versions with active and security support.
The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.
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.
All versions of phpunit-slow-test-detector with dependencies
phpunit/phpunit Version ^6.5.0 || ^7.5.0 || ^8.5.19 || ^9.0.0 || ^10.0.0 || ^11.0.0