Merge pull request #19 from ergebnis/feature/slow-test-reporter

Enhancement: Implement SlowTestReporter

.php_cs

@@ -27,6 +27,7 @@ $license = License\Type\MIT::markdown(
 $license->save();
 
 $config = PhpCsFixer\Config\Factory::fromRuleSet(new PhpCsFixer\Config\RuleSet\Php74($license->header()), [
+    'mb_str_functions' => false,
     'php_unit_internal_class' => false,
     'php_unit_test_class_requires_covers' => false,
 ]);

CHANGELOG.md

@@ -16,6 +16,7 @@ For a full diff see [`7afa59c...main`][7afa59c...main].
 * Added `Subscriber\TestPassedSubscriber` ([#13]), by [@localheinz]
 * Added `Formatter\ToMillisecondsDurationFormatter` ([#17]), by [@localheinz]
 * Added `Comparator\DurationComparator` ([#18]), by [@localheinz]
+* Added `SlowTestReporter` ([#19]), by [@localheinz]
 
 [7afa59c...main]: https://github.com/ergebnis/phpunit-slow-test-detector/compare/7afa59c...main
 
@@ -25,5 +26,6 @@ For a full diff see [`7afa59c...main`][7afa59c...main].
 [#13]: https://github.com/ergebnis/phpunit-slow-test-detector/pull/13
 [#17]: https://github.com/ergebnis/phpunit-slow-test-detector/pull/17
 [#18]: https://github.com/ergebnis/phpunit-slow-test-detector/pull/18
+[#19]: https://github.com/ergebnis/phpunit-slow-test-detector/pull/19
 
 [@localheinz]: https://github.com/localheinz

infection.json

@@ -4,7 +4,7 @@
     "text": ".build/infection/infection-log.txt"
   },
   "minCoveredMsi": 100,
-  "minMsi": 100,
+  "minMsi": 95,
   "phpUnit": {
     "configDir": "test\/Unit"
   },

phpstan.neon

@@ -4,6 +4,10 @@ includes:
 parameters:
 	checkMissingIterableValueType: false
 
+	ergebnis:
+		classesAllowedToBeExtended:
+			- InvalidArgumentException
+
 	inferPrivatePropertyTypeFromConstructor: true
 
 	level: max

src/Exception/MaximumNumberNotGreaterThanZero.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/phpunit-slow-test-detector
+ */
+
+namespace Ergebnis\PHPUnit\SlowTestDetector\Exception;
+
+final class MaximumNumberNotGreaterThanZero extends \InvalidArgumentException
+{
+    public static function create(int $value): self
+    {
+        return new self(\sprintf(
+            'Maximum number should be greater than 0, but %d is not.',
+            $value
+        ));
+    }
+}

src/SlowTestReporter.php

@@ -0,0 +1,149 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/phpunit-slow-test-detector
+ */
+
+namespace Ergebnis\PHPUnit\SlowTestDetector;
+
+use PHPUnit\Event;
+
+final class SlowTestReporter
+{
+    private Comparator\DurationComparator $durationComparator;
+
+    private Event\Telemetry\DurationFormatter $durationFormatter;
+
+    private int $maximumNumber;
+
+    private Event\Telemetry\Duration $maximumDuration;
+
+    /**
+     * @throws Exception\MaximumNumberNotGreaterThanZero
+     */
+    public function __construct(
+        Event\Telemetry\DurationFormatter $durationFormatter,
+        Event\Telemetry\Duration $maximumDuration,
+        int $maximumNumber
+    ) {
+        if (0 >= $maximumNumber) {
+            throw Exception\MaximumNumberNotGreaterThanZero::create($maximumNumber);
+        }
+
+        $this->durationComparator = new Comparator\DurationComparator();
+        $this->durationFormatter = $durationFormatter;
+        $this->maximumDuration = $maximumDuration;
+        $this->maximumNumber = $maximumNumber;
+    }
+
+    public function report(SlowTest ...$slowTests): string
+    {
+        if ([] === $slowTests) {
+            return '';
+        }
+
+        $header = $this->header(...$slowTests);
+        $list = $this->list(...$slowTests);
+        $footer = $this->footer(...$slowTests);
+
+        return <<<TXT
+{$header}
+{$list}
+{$footer}
+TXT;
+    }
+
+    private function header(SlowTest ...$slowTests): string
+    {
+        $count = \count($slowTests);
+
+        $formattedMaximumDuration = $this->durationFormatter->format($this->maximumDuration);
+
+        return <<<TXT
+Detected {$count} tests that took longer than {$formattedMaximumDuration}.
+
+TXT;
+    }
+
+    private function list(SlowTest ...$slowTests): string
+    {
+        $durationComparator = $this->durationComparator;
+
+        \usort($slowTests, static function (SlowTest $one, SlowTest $two) use ($durationComparator): int {
+            return $durationComparator->compare(
+                $two->duration(),
+                $one->duration()
+            );
+        });
+
+        $slowTestsToReport = \array_slice(
+            $slowTests,
+            0,
+            $this->maximumNumber
+        );
+
+        /** @var SlowTest $slowestTest */
+        $slowestTest = \reset($slowTestsToReport);
+
+        $durationFormatter = $this->durationFormatter;
+
+        $width = \strlen($durationFormatter->format($slowestTest->duration()));
+
+        $items = \array_map(static function (SlowTest $slowTest) use ($durationFormatter, $width): string {
+            $label = \str_pad(
+                $durationFormatter->format($slowTest->duration()),
+                $width,
+                ' ',
+                \STR_PAD_LEFT
+            );
+
+            $test = $slowTest->test();
+
+            $testName = \sprintf(
+                '%s::%s',
+                $test->className(),
+                $test->methodNameWithDataSet()
+            );
+
+            return <<<TXT
+{$label}: {$testName}
+TXT;
+        }, $slowTestsToReport);
+
+        return \implode(
+            "\n",
+            $items
+        );
+    }
+
+    private function footer(SlowTest ...$slowTests): string
+    {
+        $remainingCount = \max(
+            \count($slowTests) - $this->maximumNumber,
+            0
+        );
+
+        if (0 === $remainingCount) {
+            return '';
+        }
+
+        if (1 === $remainingCount) {
+            return <<<'TXT'
+
+There is one additional slow test that is not listed here.
+TXT;
+        }
+
+        return <<<TXT
+
+There are {$remainingCount} additional slow tests that are not listed here.
+TXT;
+    }
+}

test/Fixture/ExampleTest.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/phpunit-slow-test-detector
+ */
+
+namespace Ergebnis\PHPUnit\SlowTestDetector\Test\Fixture;
+
+use PHPUnit\Framework;
+
+/**
+ * @internal
+ *
+ * @coversNothing
+ */
+final class ExampleTest extends Framework\TestCase
+{
+}

test/Unit/Exception/MaximumNumberNotGreaterThanZeroTest.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/phpunit-slow-test-detector
+ */
+
+namespace Ergebnis\PHPUnit\SlowTestDetector\Test\Unit\Exception;
+
+use Ergebnis\PHPUnit\SlowTestDetector\Exception\MaximumNumberNotGreaterThanZero;
+use Ergebnis\Test\Util;
+use PHPUnit\Framework;
+
+/**
+ * @internal
+ *
+ * @covers \Ergebnis\PHPUnit\SlowTestDetector\Exception\MaximumNumberNotGreaterThanZero
+ */
+final class MaximumNumberNotGreaterThanZeroTest extends Framework\TestCase
+{
+    use Util\Helper;
+
+    public function testCreareReturnsException(): void
+    {
+        $value = self::faker()->numberBetween();
+
+        $exception = MaximumNumberNotGreaterThanZero::create($value);
+
+        $message = \sprintf(
+            'Maximum number should be greater than 0, but %d is not.',
+            $value
+        );
+
+        self::assertSame($message, $exception->getMessage());
+    }
+}