Add JUnit report logger

composer-require-checker.json

@@ -7,6 +7,7 @@
     "int",
     "null",
     "PHPUnit\\Event\\Code\\Test",
+    "PHPUnit\\Event\\Code\\TestMethod",
     "PHPUnit\\Event\\Test\\Finished",
     "PHPUnit\\Event\\Test\\FinishedSubscriber",
     "PHPUnit\\Event\\Test\\PreparationStarted",

composer.json

@@ -25,6 +25,7 @@
   },
   "require": {
     "php": "~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0",
+    "ext-dom": "*",
     "phpunit/phpunit": "^7.5.0 || ^8.5.19 || ^9.0.0 || ^10.0.0"
   },
   "require-dev": {

psalm-baseline.xml

@@ -11,6 +11,12 @@
       <code>$options</code>
     </UnusedParam>
   </file>
+  <file src="src/FileWriter/DefaultFileWriter.php">
+    <InvalidArgument>
+      <code>static function (): void {
+        }</code>
+    </InvalidArgument>
+  </file>
   <file src="src/Formatter/DefaultDurationFormatter.php">
     <InvalidOperand>
       <code><![CDATA[$duration->seconds() * 1_000 + $duration->nanoseconds() / 1_000_000]]></code>
@@ -21,6 +27,27 @@
       <code>($durationInMilliseconds - $hoursInMilliseconds - $minutesInMilliseconds) / 1_000</code>
     </InvalidOperand>
   </file>
+  <file src="src/Logger/LoggerFactory.php">
+    <MixedInferredReturnType>
+      <code>Logger</code>
+    </MixedInferredReturnType>
+    <UndefinedClass>
+      <code>Runner\Extension\ParameterCollection</code>
+      <code>TextUI\Configuration\Configuration</code>
+    </UndefinedClass>
+    <UnusedClass>
+      <code>LoggerFactory</code>
+    </UnusedClass>
+    <UnusedParam>
+      <code>$configuration</code>
+      <code>$parameters</code>
+    </UnusedParam>
+  </file>
+  <file src="src/Reporter/NullReporter.php">
+    <UnusedClass>
+      <code>NullReporter</code>
+    </UnusedClass>
+  </file>
   <file src="src/Subscriber/Test/FinishedSubscriber.php">
     <UndefinedClass>
       <code>Event\Test\FinishedSubscriber</code>
@@ -57,6 +84,7 @@
     <UnusedParam>
       <code>$collector</code>
       <code>$event</code>
+      <code>$logger</code>
       <code>$reporter</code>
     </UnusedParam>
   </file>
@@ -183,6 +211,21 @@
       <code>provideMillisecondsGreaterThanMaximumDurationFromXmlConfiguration</code>
     </PossiblyUnusedMethod>
   </file>
+  <file src="test/EndToEnd/Version10/Logger/WithConfigurationAndNoOption/SleeperTest.php">
+    <PossiblyUnusedMethod>
+      <code>provideMillisecondsGreaterThanDefaultMaximumDuration</code>
+    </PossiblyUnusedMethod>
+  </file>
+  <file src="test/EndToEnd/Version10/Logger/WithConfigurationAndOption/SleeperTest.php">
+    <PossiblyUnusedMethod>
+      <code>provideMillisecondsGreaterThanDefaultMaximumDuration</code>
+    </PossiblyUnusedMethod>
+  </file>
+  <file src="test/EndToEnd/Version10/Logger/WithNoConfigurationAndOption/SleeperTest.php">
+    <PossiblyUnusedMethod>
+      <code>provideMillisecondsGreaterThanDefaultMaximumDuration</code>
+    </PossiblyUnusedMethod>
+  </file>
   <file src="test/EndToEnd/Version10/TestCase/Bare/SleeperTest.php">
     <PossiblyUnusedMethod>
       <code>provideMillisecondsGreaterThanMaximumDurationFromXmlConfiguration</code>
@@ -323,6 +366,21 @@
       <code>provideMillisecondsGreaterThanMaximumDurationFromXmlConfiguration</code>
     </PossiblyUnusedMethod>
   </file>
+  <file src="test/EndToEnd/Version11/Logger/WithConfigurationAndNoOption/SleeperTest.php">
+    <PossiblyUnusedMethod>
+      <code>provideMillisecondsGreaterThanDefaultMaximumDuration</code>
+    </PossiblyUnusedMethod>
+  </file>
+  <file src="test/EndToEnd/Version11/Logger/WithConfigurationAndOption/SleeperTest.php">
+    <PossiblyUnusedMethod>
+      <code>provideMillisecondsGreaterThanDefaultMaximumDuration</code>
+    </PossiblyUnusedMethod>
+  </file>
+  <file src="test/EndToEnd/Version11/Logger/WithNoConfigurationAndOption/SleeperTest.php">
+    <PossiblyUnusedMethod>
+      <code>provideMillisecondsGreaterThanDefaultMaximumDuration</code>
+    </PossiblyUnusedMethod>
+  </file>
   <file src="test/EndToEnd/Version11/TestCase/Bare/SleeperTest.php">
     <PossiblyUnusedMethod>
       <code>provideMillisecondsGreaterThanMaximumDurationFromXmlConfiguration</code>
@@ -409,9 +467,24 @@
       <code><![CDATA[$this->milliseconds * 1000]]></code>
     </ArgumentTypeCoercion>
   </file>
+  <file src="test/Unit/Collector/DefaultCollectorTest.php">
+    <MixedArgument>
+      <code><![CDATA[$faker->filePath()]]></code>
+      <code><![CDATA[$faker->filePath()]]></code>
+      <code><![CDATA[$faker->filePath()]]></code>
+      <code><![CDATA[$faker->filePath()]]></code>
+      <code><![CDATA[$faker->filePath()]]></code>
+      <code><![CDATA[$faker->filePath()]]></code>
+    </MixedArgument>
+  </file>
   <file src="test/Unit/Reporter/DefaultReporterTest.php">
     <MixedInferredReturnType>
       <code>iterable</code>
     </MixedInferredReturnType>
   </file>
+  <file src="test/Unit/SlowTestTest.php">
+    <MixedArgument>
+      <code><![CDATA[$faker->filePath()]]></code>
+    </MixedArgument>
+  </file>
 </files>

src/Exception/FailedToCreateDirectory.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021-2024 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;
+
+/**
+ * @internal
+ */
+final class FailedToCreateDirectory extends \RuntimeException
+{
+    public static function forDirectory(string $directory): self
+    {
+        return new self(\sprintf('Directory "%s" was not created.', $directory));
+    }
+}

src/Exception/FailedToWriteFile.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021-2024 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;
+
+/**
+ * @internal
+ */
+final class FailedToWriteFile extends \RuntimeException
+{
+    public static function forFile(string $file): self
+    {
+        return new self(\sprintf('Failed to write to file "%s".', $file));
+    }
+}

src/Exception/InvalidFile.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021-2024 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;
+
+/**
+ * @internal
+ */
+final class InvalidFile extends \InvalidArgumentException
+{
+    public static function blankOrEmpty(): self
+    {
+        return new self('Value cannot be blank or empty.');
+    }
+}

src/Exception/InvalidTestFileLine.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021-2024 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;
+
+/**
+ * @internal
+ */
+final class InvalidTestFileLine extends \InvalidArgumentException
+{
+    public static function lesserThenOne(): self
+    {
+        return new self('Value cannot be lesser than one.');
+    }
+}

src/Exception/InvalidTestFilename.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2021-2024 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;
+
+/**
+ * @internal
+ */
+final class InvalidTestFilename extends \InvalidArgumentException
+{
+    public static function blankOrEmpty(): self
+    {
+        return new self('Value cannot be blank or empty.');
+    }
+}

src/Extension.php

@@ -40,6 +40,7 @@ final class Extension implements
         private Duration $maximumDuration;
         private Collector\Collector $collector;
         private Reporter\Reporter $reporter;
+        private Logger\Logger $logger;
 
         public function __construct(array $options = [])
         {
@@ -57,11 +58,16 @@ public function __construct(array $options = [])
 
             $this->maximumDuration = $maximumDuration;
             $this->collector = new Collector\DefaultCollector();
+            $durationFormatter = new Formatter\DefaultDurationFormatter();
             $this->reporter = new Reporter\DefaultReporter(
-                new Formatter\DefaultDurationFormatter(),
+                $durationFormatter,
                 $maximumDuration,
                 $maximumCount,
             );
+            $loggerFactory = new Logger\LoggerFactory(
+                $durationFormatter,
+            );
+            $this->logger = $loggerFactory->forArguments($_SERVER['argv'], $options);
         }
 
         public function executeBeforeFirstTest(): void
@@ -100,9 +106,11 @@ public function executeAfterTest(
             }
 
             $testIdentifier = TestIdentifier::fromString($test);
+            $testFile = $this->resolveTestFile($test);
 
             $slowTest = SlowTest::create(
                 $testIdentifier,
+                $testFile,
                 $duration,
                 $maximumDuration,
             );
@@ -120,6 +128,8 @@ public function executeAfterLastTest(): void
 
             $slowTests = $this->collector->collected();
 
+            $this->logger->log(...$slowTests);
+
             if ([] === $slowTests) {
                 return;
             }
@@ -178,6 +188,22 @@ private function resolveMaximumDuration(string $test): Duration
 
             return $this->maximumDuration;
         }
+
+        private function resolveTestFile(string $test): TestFile
+        {
+            $test = \explode(' ', $test, 2)[0];
+
+            try {
+                $methodReflection = new \ReflectionMethod($test);
+            } catch (\ReflectionException $e) {
+                return TestFile::fromFilename($test);
+            }
+
+            return TestFile::fromFilenameAndLine(
+                $methodReflection->getFileName(),
+                $methodReflection->getStartLine(),
+            );
+        }
     }
 
     return;
@@ -194,10 +220,6 @@ public function bootstrap(
             Runner\Extension\Facade $facade,
             Runner\Extension\ParameterCollection $parameters
         ): void {
-            if ($configuration->noOutput()) {
-                return;
-            }
-
             $maximumCount = Count::fromInt(10);
 
             if ($parameters->has('maximum-count')) {
@@ -212,10 +234,16 @@ public function bootstrap(
 
             $timeKeeper = new TimeKeeper();
             $collector = new Collector\DefaultCollector();
-            $reporter = new Reporter\DefaultReporter(
-                new Formatter\DefaultDurationFormatter(),
-                $maximumDuration,
-                $maximumCount,
+            $durationFormatter = new Formatter\DefaultDurationFormatter();
+            $reporter = $configuration->noOutput()
+                ? new Reporter\NullReporter()
+                : new Reporter\DefaultReporter(
+                    $durationFormatter,
+                    $maximumDuration,
+                    $maximumCount,
+                );
+            $loggerFactory = new Logger\LoggerFactory(
+                $durationFormatter,
             );
 
             $facade->registerSubscribers(
@@ -228,6 +256,10 @@ public function bootstrap(
                 new Subscriber\TestRunner\ExecutionFinishedSubscriber(
                     $collector,
                     $reporter,
+                    $loggerFactory->forConfiguration(
+                        $configuration,
+                        $parameters,
+                    ),
                 ),
             );
         }