Added customization support for performance thresholds.

Author: Bilge

.github/workflows/Test.yaml .github/workflows/Tests.yaml.github/workflows/Test.yaml renamed to .github/workflows/Tests.yaml

@@ -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"
 

README.md

@@ -0,0 +1,10 @@
+<?php
+declare(strict_types=1);
+
+namespace ScriptFUSION\Pip;
+
+final class PipConfig
+{
+ public int $perfSlow = 200;
+ public int $perfVslow = 1_000;
+}

src/PipConfig.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();
  }
 }

src/PipExtension.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) {

src/Printer.php

@@ -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>

test/functional/PHPUnit runner.php test/PHPUnit runner.phptest/functional/PHPUnit runner.php renamed to test/PHPUnit runner.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);
+ }
+}

test/config/PerformanceThresholds.xml

@@ -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% . ScriptFUSIONTest\Pip\config\PerformanceThresholdsTest::testSlow (%d ms)
+100% . ScriptFUSIONTest\Pip\config\PerformanceThresholdsTest::testVslow (%d ms)
+
+
+Time: %s
+
+OK (2 tests, 2 assertions)

test/config/PerformanceThresholdsTest.php

@@ -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