Implement PHPUnit\Runner\Extension\Facade::replaceOutput() and PHPUnit\Runner\Extension\Facade::replacesOutput() to allow extensions to disable event more default output

Author: sebastianbergmann

ChangeLog-10.1.md

@@ -4,9 +4,10 @@ All notable changes of the PHPUnit 10.1 release series are documented in this fi
 
 ## [10.1.2] - 2023-MM-DD
 
-### Fixed
+### Added
 
-* `PHPUnit\Event\Telemetry\Info::garbageCollectorStatus()` is missing
+* `PHPUnit\Runner\Extension\Facade::replaceOutput()` and `PHPUnit\Runner\Extension\Facade::replacesOutput()`
+* `PHPUnit\Event\Telemetry\Info::garbageCollectorStatus()`
 
 ## [10.1.1] - 2023-04-17
 

src/Runner/Extension/Facade.php

@@ -20,6 +20,7 @@
  */
 final class Facade
 {
+    private bool $replacesOutput                 = false;
     private bool $replacesProgressOutput         = false;
     private bool $replacesResultOutput           = false;
     private bool $requiresCodeCoverageCollection = false;
@@ -50,14 +51,24 @@ public function registerTracer(Tracer $tracer): void
         EventFacade::instance()->registerTracer($tracer);
     }
 
+    public function replaceOutput(): void
+    {
+        $this->replacesOutput = true;
+    }
+
+    public function replacesOutput(): bool
+    {
+        return $this->replacesOutput;
+    }
+
     public function replaceProgressOutput(): void
     {
         $this->replacesProgressOutput = true;
     }
 
     public function replacesProgressOutput(): bool
     {
-        return $this->replacesProgressOutput;
+        return $this->replacesOutput || $this->replacesProgressOutput;
     }
 
     public function replaceResultOutput(): void
@@ -67,7 +78,7 @@ public function replaceResultOutput(): void
 
     public function replacesResultOutput(): bool
     {
-        return $this->replacesResultOutput;
+        return $this->replacesOutput || $this->replacesResultOutput;
     }
 
     public function requireCodeCoverageCollection(): void

src/TextUI/Application.php

@@ -106,6 +106,7 @@ public function run(array $argv): int
 
             $pharExtensions                          = null;
             $extensionRequiresCodeCoverageCollection = false;
+            $extensionReplacesOutput                 = false;
             $extensionReplacesProgressOutput         = false;
             $extensionReplacesResultOutput           = false;
 
@@ -118,6 +119,7 @@ public function run(array $argv): int
 
                 $extensionRequirements                   = $this->bootstrapExtensions($configuration);
                 $extensionRequiresCodeCoverageCollection = $extensionRequirements['requiresCodeCoverageCollection'];
+                $extensionReplacesOutput                 = $extensionRequirements['replacesOutput'];
                 $extensionReplacesProgressOutput         = $extensionRequirements['replacesProgressOutput'];
                 $extensionReplacesResultOutput           = $extensionRequirements['replacesResultOutput'];
             }
@@ -136,15 +138,18 @@ public function run(array $argv): int
 
             $printer = OutputFacade::init(
                 $configuration,
+                $extensionReplacesOutput,
                 $extensionReplacesProgressOutput,
                 $extensionReplacesResultOutput
             );
 
-            $this->writeRuntimeInformation($printer, $configuration);
-            $this->writePharExtensionInformation($printer, $pharExtensions);
-            $this->writeRandomSeedInformation($printer, $configuration);
+            if (!$extensionReplacesResultOutput) {
+                $this->writeRuntimeInformation($printer, $configuration);
+                $this->writePharExtensionInformation($printer, $pharExtensions);
+                $this->writeRandomSeedInformation($printer, $configuration);
 
-            $printer->print(PHP_EOL);
+                $printer->print(PHP_EOL);
+            }
 
             $this->registerLogfileWriters($configuration);
 
@@ -191,7 +196,10 @@ public function run(array $argv): int
 
             $result = TestResultFacade::result();
 
-            OutputFacade::printResult($result, $testDoxResult, $duration);
+            if (!$extensionReplacesResultOutput) {
+                OutputFacade::printResult($result, $testDoxResult, $duration);
+            }
+
             CodeCoverage::instance()->generateReports($printer, $configuration);
 
             $shellExitCode = (new ShellExitCodeCalculator)->calculate(
@@ -332,7 +340,7 @@ private function buildTestSuite(Configuration $configuration): TestSuite
     }
 
     /**
-     * @psalm-return array{requiresCodeCoverageCollection: bool, replacesProgressOutput: bool, replacesResultOutput: bool}
+     * @psalm-return array{requiresCodeCoverageCollection: bool, replacesOutput: bool, replacesProgressOutput: bool, replacesResultOutput: bool}
      */
     private function bootstrapExtensions(Configuration $configuration): array
     {
@@ -361,6 +369,7 @@ private function bootstrapExtensions(Configuration $configuration): array
 
         return [
             'requiresCodeCoverageCollection' => $facade->requiresCodeCoverageCollection(),
+            'replacesOutput'                 => $facade->replacesOutput(),
             'replacesProgressOutput'         => $facade->replacesProgressOutput(),
             'replacesResultOutput'           => $facade->replacesResultOutput(),
         ];

src/TextUI/Output/Facade.php

@@ -40,7 +40,7 @@ final class Facade
      * @throws EventFacadeIsSealedException
      * @throws UnknownSubscriberTypeException
      */
-    public static function init(Configuration $configuration, bool $extensionReplacesProgressOutput, bool $extensionReplacesResultOutput): Printer
+    public static function init(Configuration $configuration, bool $extensionReplacesOutput, bool $extensionReplacesProgressOutput, bool $extensionReplacesResultOutput): Printer
     {
         self::createPrinter($configuration);