Added customization support for performance thresholds.

ScriptFUSION · Jul 21, 2024 · 6f5a87e · 6f5a87e
1 parent d9a3951
commit 6f5a87e
Show file tree

Hide file tree

Showing 27 changed files with 113 additions and 31 deletions.
diff --git a/.github/workflows/Test.yaml → .github/workflows/Tests.yaml b/.github/workflows/Test.yaml → .github/workflows/Tests.yaml
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ The following preview is somewhat atypical but shows all supported output cases
 
 ![Preview image][]
 
-This printer makes no attempt to modify the test summary; only runtime output is changed.
+Pip makes no attempt to modify the test summary; only runtime output is changed.
 
 ## Usage
 
@@ -51,13 +51,22 @@ This printer makes no attempt to modify the test summary; only runtime output is
 
 4. Enjoy immediate test execution feedback.
 
+### Configuration
+
+Pip's behaviour can be customized by adding `<parameter>` nodes as children of the `<bootstrap>` node in `phpunit.xml`, with `name` and `value` attributes corresponding to the table below.
+
+| Parameter name | Default value | Comments                                         |
+|----------------|---------------|--------------------------------------------------|
+| perf.slow      | 200 (ms)      | _Slow_ performance threshold (shown in yellow)   |
+| perf.vslow     | 1000 (ms)     | _Very slow_ performance threshold (shown in red) |
+
 ## Requirements
 
-| Pip version | PHPUnit versions | Minimum PHP |
-|:-----------:|:----------------:|:-----------:|
-|      3      |     10 / 11      |  8.1 / 8.2  |
-|      2      |     *yanked*     |      -      |
-|      1      |      5 / 6       |  5.6 / 7.0  |
+| Pip version | PHPUnit versions | Minimum PHP version |
+|:-----------:|:----------------:|:-------------------:|
+|      3      |     10 / 11      |      8.1 / 8.2      |
+|      2      |     *yanked*     |          -          |
+|      1      |      5 / 6       |      5.6 / 7.0      |
 
 ## Testing
 
@@ -94,8 +103,8 @@ Thanks to the following open source projects that inspired this project. Keep be
   [Version image]: https://poser.pugx.org/scriptfusion/pip/version "Latest version"
   [Downloads]: https://packagist.org/packages/scriptfusion/pip
   [Downloads image]: https://poser.pugx.org/scriptfusion/pip/downloads "Total downloads"
-  [Build]: https://github.com/ScriptFUSION/PHPUnit-Immediate-Printer/actions/workflows/Test.yaml
-  [Build image]: https://github.com/ScriptFUSION/PHPUnit-Immediate-Printer/actions/workflows/Test.yaml/badge.svg "Build status"
+  [Build]: https://github.com/ScriptFUSION/PHPUnit-Immediate-Printer/actions/workflows/Tests.yaml
+  [Build image]: https://github.com/ScriptFUSION/PHPUnit-Immediate-Printer/actions/workflows/Tests.yaml/badge.svg "Build status"
   [Coverage]: https://codecov.io/gh/ScriptFUSION/PHPUnit-Immediate-Printer
   [Coverage image]: https://codecov.io/github/ScriptFUSION/PHPUnit-Immediate-Printer/graph/badge.svg "Test coverage"
 

diff --git a/src/PipConfig.php b/src/PipConfig.php
@@ -0,0 +1,10 @@
+<?php
+declare(strict_types=1);
+
+namespace ScriptFUSION\Pip;
+
+final class PipConfig
+{
+      public int $perfSlow = 200;
+      public int $perfVslow = 1_000;
+}
diff --git a/src/PipExtension.php b/src/PipExtension.php
@@ -12,7 +12,11 @@ final class PipExtension implements Extension
 {
     public function bootstrap(Configuration $configuration, Facade $facade, ParameterCollection $parameters): void
     {
-        $facade->registerTracer(new Printer());
+        $config = new PipConfig();
+        $parameters->has('perf.slow') && $config->perfSlow = +$parameters->get('perf.slow');
+        $parameters->has('perf.vslow') && $config->perfVslow = +$parameters->get('perf.vslow');
+
+        $facade->registerTracer(new Printer($config));
         $facade->replaceProgressOutput();
     }
 }
diff --git a/src/Printer.php b/src/Printer.php
@@ -23,11 +23,7 @@
 
 final class Printer implements Tracer
 {
-    private array $performanceThresholds = [
-        'red' => 1000,
-        'yellow' => 200,
-        'green' => 0,
-    ];
+    private readonly array $performanceThresholds;
 
     private int $totalTests;
 
@@ -41,6 +37,15 @@ final class Printer implements Tracer
 
     private bool $flawless = true;
 
+    public function __construct(private readonly PipConfig $config)
+    {
+        $this->performanceThresholds = [
+            'red' => $config->perfVslow,
+            'yellow' => $config->perfSlow,
+            'green' => 0,
+        ];
+    }
+
     public function trace(Event $event): void
     {
         if ($event instanceof ExecutionStarted) {

diff --git a/test/functional/PHPUnit runner.php → test/PHPUnit runner.php b/test/functional/PHPUnit runner.php → test/PHPUnit runner.php
diff --git a/test/config/PerformanceThresholds.xml b/test/config/PerformanceThresholds.xml
@@ -0,0 +1,8 @@
+<phpunit>
+  <extensions>
+    <bootstrap class="ScriptFUSION\Pip\PipExtension">
+      <parameter name="perf.slow" value="300"/>
+      <parameter name="perf.vslow" value="600"/>
+    </bootstrap>
+  </extensions>
+</phpunit>
diff --git a/test/config/PerformanceThresholdsTest.php b/test/config/PerformanceThresholdsTest.php
@@ -0,0 +1,23 @@
+<?php
+declare(strict_types=1);
+
+namespace ScriptFUSIONTest\Pip\config;
+
+use PHPUnit\Framework\TestCase;
+
+final class PerformanceThresholdsTest extends TestCase
+{
+    public function testSlow(): void
+    {
+        usleep(300_000);
+
+        self::assertTrue(true);
+    }
+
+    public function testVslow(): void
+    {
+        usleep(600_000);
+
+        self::assertTrue(true);
+    }
+}
diff --git a/test/config/performance thresholds.phpt b/test/config/performance thresholds.phpt
@@ -0,0 +1,22 @@
+--TEST--
+Tests that when custom performance thresholds are specified, they overrides the defaults.
+
+--ARGS--
+-c test/config/PerformanceThresholds.xml --colors=always test/config/PerformanceThresholdsTest.php
+
+--FILE_EXTERNAL--
+../PHPUnit runner.php
+
+--EXPECTF--
+PHPUnit %s
+
+Runtime: %s
+Configuration: %s
+
+ 50% . [32;1mScriptFUSIONTest\Pip\config\PerformanceThresholdsTest::testSlow[0m [33m(%d ms)[0m
+100% . [32;1mScriptFUSIONTest\Pip\config\PerformanceThresholdsTest::testVslow[0m [31m(%d ms)[0m
+
+
+Time: %s
+
+[30;42mOK (2 tests, 2 assertions)[0m
diff --git a/test/functional/data provider.phpt b/test/functional/data provider.phpt
@@ -5,7 +5,7 @@ A successful test is fed two cases by a data provider.
 -c test --colors=always test/CapabilitiesTest.php --filter '::testDataProvider\h'
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/deprecation.phpt b/test/functional/deprecation.phpt
@@ -5,7 +5,7 @@ A test is marked "deprecated".
 -c test --colors=always test/CapabilitiesTest.php --filter ::testDeprecation$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/diff failure.phpt b/test/functional/diff failure.phpt
@@ -5,7 +5,7 @@ An assertion fails and produces a diff.
 -c test --colors=always test/CapabilitiesTest.php --filter ::testDiffFailure$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/exception.phpt b/test/functional/exception.phpt
@@ -5,7 +5,7 @@ An exception is thrown in the test case.
 -c test --colors=always test/CapabilitiesTest.php --filter ::testException$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/failure.phpt b/test/functional/failure.phpt
@@ -5,7 +5,7 @@ An assertion fails.
 -c test --colors=always test/CapabilitiesTest.php --filter ::testFailure$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/incomplete.phpt b/test/functional/incomplete.phpt
@@ -5,7 +5,7 @@ A test is marked "incomplete".
 -c test --colors=always test/CapabilitiesTest.php --filter ::testIncomplete$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/multiple files.phpt b/test/functional/multiple files.phpt
@@ -5,7 +5,7 @@ Tests that multiple files tested together are counted correctly.
 -c test --colors=always test/multi
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/nested exception.phpt b/test/functional/nested exception.phpt
@@ -5,7 +5,7 @@ An exception containing another exception is thrown by another class.
 -c test --colors=always test/CapabilitiesTest.php --filter ::testNestedException$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/notice.phpt b/test/functional/notice.phpt
@@ -5,7 +5,7 @@ A test is marked "notice".
 -c test --colors=always test/CapabilitiesTest.php --filter ::testNotice$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/repeat.phpt b/test/functional/repeat.phpt
@@ -8,7 +8,7 @@ An successful test is repeated 80 times.
 -c test --colors=always test/CapabilitiesTest.php --filter ::testSuccess$ --repeat 80
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/risky.phpt b/test/functional/risky.phpt
@@ -5,7 +5,7 @@ A test is marked "risky".
 -c test --colors=always test/CapabilitiesTest.php --filter ::testRisky$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/skipped.phpt b/test/functional/skipped.phpt
@@ -5,7 +5,7 @@ A test is skipped.
 -c test --colors=always test/CapabilitiesTest.php --filter ::testSkipped$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/slow.phpt b/test/functional/slow.phpt
@@ -5,7 +5,7 @@ Tests that when a test takes more than 200ms to complete, its timer output is sh
 -c test --colors=always test/CapabilitiesTest.php --filter ::testSlow$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/success after failure.phpt b/test/functional/success after failure.phpt
@@ -5,7 +5,7 @@ Successful tests following a failure have coloured progress marker.
 -c test --colors=always test/CapabilitiesTest.php --filter '::testSuccessAfterFailure\h'
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/success.phpt b/test/functional/success.phpt
@@ -5,7 +5,7 @@ An assertion succeeds.
 -c test --colors=always test/CapabilitiesTest.php --filter ::testSuccess$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/vslow.phpt b/test/functional/vslow.phpt
@@ -5,7 +5,7 @@ Tests that when a test takes more than 1s to complete, its timer output is shown
 -c test --colors=always test/CapabilitiesTest.php --filter ::testGigaSlow$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/functional/warning.phpt b/test/functional/warning.phpt
@@ -5,7 +5,7 @@ A test is marked "warning".
 -c test --colors=always test/CapabilitiesTest.php --filter ::testWarning$
 
 --FILE_EXTERNAL--
-PHPUnit runner.php
+../PHPUnit runner.php
 
 --EXPECTF--
 PHPUnit %s

diff --git a/test/phpunit.xml b/test/phpunit.xml
@@ -7,6 +7,7 @@
   <testsuites>
     <testsuite name="Default">
       <directory suffix=".phpt">functional</directory>
+      <directory suffix=".phpt">config</directory>
     </testsuite>
   </testsuites>