Implement TestRunner\ChildProcessStarted and TestRunner\ChildProcessFinished events

Co-authored-by: Sebastian Bergmann <[email protected]>
Co-authored-by: Fabian Blechschmidt <[email protected]>
Co-authored-by: Arne Blankerts <[email protected]>
Co-authored-by: Markus Staab <[email protected]>
Co-authored-by: Nicola Pilcher <[email protected]>
Co-authored-by: Andreas Möller <[email protected]>
Co-authored-by: Sebastian Heuer <[email protected]>

Author: 7 people

ChangeLog-11.5.md

@@ -7,5 +7,6 @@ All notable changes of the PHPUnit 11.5 release series are documented in this fi
 ### Added
 
 * [#5948](https://github.com/sebastianbergmann/phpunit/pull/5948): Support for Property Hooks in Test Doubles
+* `TestRunner\ChildProcessStarted` and `TestRunner\ChildProcessFinished` events
 
 [11.5.0]: https://github.com/sebastianbergmann/phpunit/compare/11.4...11.5

src/Event/Emitter/DispatchingEmitter.php

@@ -262,6 +262,24 @@ public function testRunnerTriggeredGarbageCollection(): void
         );
     }
 
+    public function testRunnerStartedChildProcess(): void
+    {
+        $this->dispatcher->dispatch(
+            new TestRunner\ChildProcessStarted($this->telemetryInfo()),
+        );
+    }
+
+    public function testRunnerFinishedChildProcess(string $stdout, string $stderr): void
+    {
+        $this->dispatcher->dispatch(
+            new TestRunner\ChildProcessFinished(
+                $this->telemetryInfo(),
+                $stdout,
+                $stderr,
+            ),
+        );
+    }
+
     /**
      * @throws InvalidArgumentException
      * @throws UnknownEventTypeException

src/Event/Emitter/Emitter.php

@@ -277,6 +277,10 @@ public function testAfterLastTestMethodFinished(string $testClassName, ClassMeth
 
     public function testSuiteFinished(TestSuite $testSuite): void;
 
+    public function testRunnerStartedChildProcess(): void;
+
+    public function testRunnerFinishedChildProcess(string $stdout, string $stderr): void;
+
     public function testRunnerTriggeredDeprecation(string $message): void;
 
     public function testRunnerTriggeredWarning(string $message): void;

src/Event/Events/TestRunner/ChildProcessFinished.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\TestRunner;
+
+use PHPUnit\Event\Event;
+use PHPUnit\Event\Telemetry;
+
+/**
+ * @immutable
+ *
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+final readonly class ChildProcessFinished implements Event
+{
+    private Telemetry\Info $telemetryInfo;
+    private string $stdout;
+    private string $stderr;
+
+    public function __construct(Telemetry\Info $telemetryInfo, string $stdout, string $stderr)
+    {
+        $this->telemetryInfo = $telemetryInfo;
+        $this->stdout        = $stdout;
+        $this->stderr        = $stderr;
+    }
+
+    public function telemetryInfo(): Telemetry\Info
+    {
+        return $this->telemetryInfo;
+    }
+
+    public function stdout(): string
+    {
+        return $this->stdout;
+    }
+
+    public function stderr(): string
+    {
+        return $this->stderr;
+    }
+
+    public function asString(): string
+    {
+        return 'Child Process Finished';
+    }
+}

src/Event/Events/TestRunner/ChildProcessFinishedSubscriber.php

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

src/Event/Events/TestRunner/ChildProcessStarted.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\TestRunner;
+
+use PHPUnit\Event\Event;
+use PHPUnit\Event\Telemetry;
+
+/**
+ * @immutable
+ *
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+final readonly class ChildProcessStarted implements Event
+{
+    private Telemetry\Info $telemetryInfo;
+
+    public function __construct(Telemetry\Info $telemetryInfo)
+    {
+        $this->telemetryInfo = $telemetryInfo;
+    }
+
+    public function telemetryInfo(): Telemetry\Info
+    {
+        return $this->telemetryInfo;
+    }
+
+    public function asString(): string
+    {
+        return 'Child Process Started';
+    }
+}

src/Event/Events/TestRunner/ChildProcessStartedSubscriber.php

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

src/Event/Facade.php

@@ -236,6 +236,8 @@ private function registerDefaultTypes(TypeMap $typeMap): void
             TestRunner\GarbageCollectionDisabled::class,
             TestRunner\GarbageCollectionTriggered::class,
             TestRunner\GarbageCollectionEnabled::class,
+            TestRunner\ChildProcessFinished::class,
+            TestRunner\ChildProcessStarted::class,
 
             TestSuite\Filtered::class,
             TestSuite\Finished::class,

src/Framework/TestRunner/templates/class.tpl

@@ -78,6 +78,8 @@ function __phpunit_run_isolated_test()
         }
     }
 
+    Facade::emitter()->testRunnerFinishedChildProcess($output, '');
+
     file_put_contents(
         '{processResultFile}',
         serialize(

src/Framework/TestRunner/templates/method.tpl

@@ -78,6 +78,8 @@ function __phpunit_run_isolated_test()
         }
     }
 
+    Facade::emitter()->testRunnerFinishedChildProcess($output, '');
+
     file_put_contents(
         '{processResultFile}',
         serialize(