Implement Test\PreparationFailed event

Author: sebastianbergmann

ChangeLog-10.4.md

@@ -10,6 +10,7 @@ All notable changes of the PHPUnit 10.4 release series are documented in this fi
 * [#5462](https://github.com/sebastianbergmann/phpunit/pull/5462): Support for multiple arguments
 * [#5471](https://github.com/sebastianbergmann/phpunit/issues/5471): `assertFileMatchesFormat()` and `assertFileMatchesFormatFile()`
 * [#5515](https://github.com/sebastianbergmann/phpunit/issues/5515): `PHPUnit\Runner\Extension\Facade::requireExportOfObjects()` so that test runner extensions can indicate that they require the export of objects for events such as `Test\AssertionSucceeded` and `Test\AssertionFailed`
+* `Test\PreparationFailed` event
 * Attribute `id` attribute for `testCaseMethod` elements in the XML document generated by `--list-tests-xml`
 
 ### Changed

src/Event/Emitter/DispatchingEmitter.php

@@ -307,6 +307,20 @@ public function testPreparationStarted(Code\Test $test): void
         );
     }
 
+    /**
+     * @throws InvalidArgumentException
+     * @throws UnknownEventTypeException
+     */
+    public function testPreparationFailed(Code\Test $test): void
+    {
+        $this->dispatcher->dispatch(
+            new Test\PreparationFailed(
+                $this->telemetryInfo(),
+                $test,
+            ),
+        );
+    }
+
     /**
      * @psalm-param class-string $testClassName
      *

src/Event/Emitter/Emitter.php

@@ -63,6 +63,8 @@ public function testSuiteStarted(TestSuite $testSuite): void;
 
     public function testPreparationStarted(Code\Test $test): void;
 
+    public function testPreparationFailed(Code\Test $test): void;
+
     /**
      * @psalm-param class-string $testClassName
      */

src/Event/Events/Test/Lifecycle/PreparationFailed.php

@@ -0,0 +1,50 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\Test;
+
+use function sprintf;
+use PHPUnit\Event\Code;
+use PHPUnit\Event\Event;
+use PHPUnit\Event\Telemetry;
+
+/**
+ * @psalm-immutable
+ *
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+final class PreparationFailed implements Event
+{
+    private readonly Telemetry\Info $telemetryInfo;
+    private readonly Code\Test $test;
+
+    public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test)
+    {
+        $this->telemetryInfo = $telemetryInfo;
+        $this->test          = $test;
+    }
+
+    public function telemetryInfo(): Telemetry\Info
+    {
+        return $this->telemetryInfo;
+    }
+
+    public function test(): Code\Test
+    {
+        return $this->test;
+    }
+
+    public function asString(): string
+    {
+        return sprintf(
+            'Test Preparation Failed (%s)',
+            $this->test->id(),
+        );
+    }
+}

src/Event/Events/Test/Lifecycle/PreparationFailedSubscriber.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\Test;
+
+use PHPUnit\Event\Subscriber;
+
+/**
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+interface PreparationFailedSubscriber extends Subscriber
+{
+    public function notify(PreparationFailed $event): void;
+}

src/Event/Facade.php

@@ -204,6 +204,7 @@ private function registerDefaultTypes(TypeMap $typeMap): void
             Test\PreConditionFinished::class,
             Test\PreparationStarted::class,
             Test\Prepared::class,
+            Test\PreparationFailed::class,
             Test\PrintedUnexpectedOutput::class,
             Test\Skipped::class,
             Test\WarningTriggered::class,

src/Framework/TestCase.php

@@ -673,6 +673,10 @@ final public function runBare(): void
         } catch (AssertionError|AssertionFailedError $e) {
             if (!$this->wasPrepared) {
                 $this->wasPrepared = true;
+
+                $emitter->testPreparationFailed(
+                    $this->valueObjectForEvents(),
+                );
             }
 
             $this->status = TestStatus::failure($e->getMessage());

tests/unit/Event/Events/Test/Lifecycle/PreparationFailedTest.php

@@ -0,0 +1,43 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\Test;
+
+use PHPUnit\Event\AbstractEventTestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\Small;
+
+#[CoversClass(PreparationFailed::class)]
+#[Small]
+final class PreparationFailedTest extends AbstractEventTestCase
+{
+    public function testConstructorSetsValues(): void
+    {
+        $telemetryInfo = $this->telemetryInfo();
+        $test          = $this->testValueObject();
+
+        $event = new PreparationFailed(
+            $telemetryInfo,
+            $test,
+        );
+
+        $this->assertSame($telemetryInfo, $event->telemetryInfo());
+        $this->assertSame($test, $event->test());
+    }
+
+    public function testCanBeRepresentedAsString(): void
+    {
+        $event = new PreparationFailed(
+            $this->telemetryInfo(),
+            $this->testValueObject(),
+        );
+
+        $this->assertSame('Test Preparation Failed (FooTest::testBar)', $event->asString());
+    }
+}