teqneers / phpunit-stopwatch
Extension to measure and analyse any part of your code in order to detect performance issues using phpunit/phpunit.
Requires
- php: >=8.1.0
- phpunit/phpunit: ^10.1.0 || ^11.0.0
- psr/clock: ^1.0.0
- symfony/clock: ^6.4.0 || ^7.0.0
Requires (Dev)
- ergebnis/composer-normalize: ^2.42.0
- ergebnis/license: ^2.0.0
- ergebnis/php-cs-fixer-config: ^6.23.0
- fakerphp/faker: ^1.23.1
- psalm/plugin-phpunit: ~0.18.4
- rector/rector: ^1.0.2
- roave/security-advisories: dev-master
- scrutinizer/ocular: dev-master
- vimeo/psalm: ^5.23.1
This package is auto-updated.
Last update: 2024-10-19 15:05:59 UTC
README
Stopwatch is an essential phpunit/phpunit
extension for performance
analysis!
Gain invaluable insights into your code's execution time and call frequency during test runs. The extension is designed to elevate your code performance analysis. Track the execution time and frequency of any marked code segments to address performance bottlenecks with precision. You can identify performance bottlenecks (e.g., database cleanups or setup) or just monitor them over time. The extension will generate stopwatch reports for each test as well as a summary report at the end of the test run.
This project provides a composer
package and
a Phar archive.
The extension is compatible with the following versions of phpunit/phpunit
:
Once you've added some measurement points to your code, the extension will stop watch and count them. The results are displayed for each test and as a total report at the end of the test run.
Here is an example of how the output of a single test class might look:
Stopwatch for TQ\Tests\Example\SingleTest::testDataCalculation: - TQ\Testing\Database::deleteData 0.117secs ( 3x, Ø 0.04) TOTAL 327.026secs ( 184x, Ø 1.78) - ...onment\Testing::cleanupInstance 0.259secs ( 1x, Ø 0.26) TOTAL 6.159secs ( 60x, Ø 0.10) - TQ\Testing\Database::import 7.889secs ( 11x, Ø 0.72) TOTAL 250.958secs ( 352x, Ø 0.71) - Test 1.428secs ( 1x, Ø 1.43) TOTAL 1041.228secs ( 70x, Ø 14.87) . Stopwatch for TQ\Tests\Example\SingleTest::testDataTransfer: - TQ\Testing\Database::deleteData 0.116secs ( 3x, Ø 0.04) TOTAL 327.142secs ( 187x, Ø 1.75) - ...onment\Testing::cleanupInstance 0.256secs ( 1x, Ø 0.26) TOTAL 6.415secs ( 61x, Ø 0.11) - TQ\Testing\Database::import 7.573secs ( 11x, Ø 0.69) TOTAL 258.531secs ( 363x, Ø 0.71) - Test 5.998secs ( 1x, Ø 6.00) TOTAL 1047.226secs ( 71x, Ø 14.75) . Stopwatch for TQ\Tests\Example\SingleTest TearDown: - TQ\Testing\Database::deleteData 38.486secs ( 6x, Ø 6.41) TOTAL 365.511secs ( 190x, Ø 1.92) - ...onment\Testing::cleanupInstance 0.256secs ( 1x, Ø 0.26) TOTAL 6.415secs ( 61x, Ø 0.11) - TQ\Testing\Database::import 7.573secs ( 11x, Ø 0.69) TOTAL 258.531secs ( 363x, Ø 0.71) - Test 5.998secs ( 1x, Ø 6.00) TOTAL 1047.226secs ( 71x, Ø 14.75)
And at the end of the test run, you will get a summary of all stopwatches used, and it is going to look like this:
Stopwatch TOTALS: - Test TOTAL 1047.246secs ( 78x, Ø 13.43) - TQ\Testing\Database::deleteData TOTAL 365.511secs ( 190x, Ø 1.92) - TQ\Testing\Database::import TOTAL 258.531secs ( 363x, Ø 0.71) - ...onment\Testing::cleanupInstance TOTAL 6.416secs ( 62x, Ø 0.10) - TQ\Production\Monitoring::ping TOTAL 17.967secs ( 7x, Ø 2.57)
Usage
Stopwatch is very easy to use. A single line of code wrapped around the code you want to measure is all it takes.
For instance, let's say your tests are pretty slow, but you don't know who's the culprit? You suspect that it might be the database setup that has to be done for each and every test. Simply wrap the suspected code block as follows:
Stopwatch::start(__METHOD__); self::initializeDatabase( $db->getConnection(), ...static::createData() ); Stopwatch::stop(__METHOD__);
Should the test, setup, teardown, or other relevant methods execute this code, Stopwatch will seamlessly measure its execution time and count, and will present the results within the test output.
Installation
Installation with composer
Run
composer require --dev teqneers/phpunit-stopwatch
to install teqneers/phpunit-stopwatch
as a composer
package.
Installation as Phar
Download phpunit-stopwatch.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:^10.0.0
phpunit/phpunit:^11.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="TQ\Testing\Extension\Stopwatch\Extension"/> + </extensions> <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:^10.1.0
phpunit/phpunit:^11.0.0
adjust your phpunit.xml
configuration file and configure the
extensionsDirectory
attribute and theextensions
element onphpunit/phpunit:^10.0.0
extensionsDirectory
attribute and theextensions
element onphpunit/phpunit:^11.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="TQ\Testing\Extension\Stopwatch\Extension"/> + </extensions> <testsuites> <testsuite name="unit"> <directory>test/Unit/</directory> </testsuite> </testsuites> </phpunit>
Configuring the extension
So far, there are no configuration settings for this extension.
Running tests
When you have bootstrapped the extension, you can run your tests as usually. E.g.:
vendor/bin/phpunit
When the extension is used somewhere in your code, it will give you a report:
License
This project uses the MIT license.
Credits
This package is inspired by ergebnis/phpunit-slow-test-detector
.