Closes #5196

Author: sebastianbergmann

ChangeLog-10.1.md

@@ -7,6 +7,7 @@ All notable changes of the PHPUnit 10.1 release series are documented in this fi
 ### Added
 
 * [#5168](https://github.com/sebastianbergmann/phpunit/issues/5168): Allow test runner extensions to disable default progress and result printing
+* [#5196](https://github.com/sebastianbergmann/phpunit/issues/5196): Optionally (fail|stop) on (notice|deprecation) events
 * [#5201](https://github.com/sebastianbergmann/phpunit/issues/5201): Add `TestCase::registerFailureType()` to register interface that marks exceptions to be treated as failures, not errors
 * [#5231](https://github.com/sebastianbergmann/phpunit/pull/5231): `assertObjectHasProperty()` and `assertObjectNotHasProperty()`
 * [#5237](https://github.com/sebastianbergmann/phpunit/issues/5237): Implement `IgnoreClassForCodeCoverage`, `IgnoreMethodForCodeCoverage`, and `IgnoreFunctionForCodeCoverage` attributes

phpunit.xsd

@@ -172,18 +172,22 @@
         <xs:attribute name="columns" type="columnsType" default="80"/>
         <xs:attribute name="requireCoverageMetadata" type="xs:boolean" default="false"/>
         <xs:attribute name="processIsolation" type="xs:boolean" default="false"/>
+        <xs:attribute name="failOnDeprecation" type="xs:boolean" default="false"/>
+        <xs:attribute name="failOnEmptyTestSuite" type="xs:boolean" default="false"/>
+        <xs:attribute name="failOnIncomplete" type="xs:boolean" default="false"/>
+        <xs:attribute name="failOnNotice" type="xs:boolean" default="false"/>
+        <xs:attribute name="failOnRisky" type="xs:boolean" default="false"/>
+        <xs:attribute name="failOnSkipped" type="xs:boolean" default="false"/>
+        <xs:attribute name="failOnWarning" type="xs:boolean" default="false"/>
         <xs:attribute name="stopOnDefect" type="xs:boolean" default="false"/>
+        <xs:attribute name="stopOnDeprecation" type="xs:boolean" default="false"/>
         <xs:attribute name="stopOnError" type="xs:boolean" default="false"/>
         <xs:attribute name="stopOnFailure" type="xs:boolean" default="false"/>
-        <xs:attribute name="stopOnWarning" type="xs:boolean" default="false"/>
         <xs:attribute name="stopOnIncomplete" type="xs:boolean" default="false"/>
+        <xs:attribute name="stopOnNotice" type="xs:boolean" default="false"/>
         <xs:attribute name="stopOnRisky" type="xs:boolean" default="false"/>
         <xs:attribute name="stopOnSkipped" type="xs:boolean" default="false"/>
-        <xs:attribute name="failOnEmptyTestSuite" type="xs:boolean" default="false"/>
-        <xs:attribute name="failOnIncomplete" type="xs:boolean" default="false"/>
-        <xs:attribute name="failOnRisky" type="xs:boolean" default="false"/>
-        <xs:attribute name="failOnSkipped" type="xs:boolean" default="false"/>
-        <xs:attribute name="failOnWarning" type="xs:boolean" default="false"/>
+        <xs:attribute name="stopOnWarning" type="xs:boolean" default="false"/>
         <xs:attribute name="beStrictAboutChangesToGlobalState" type="xs:boolean" default="false"/>
         <xs:attribute name="beStrictAboutOutputDuringTests" type="xs:boolean" default="false"/>
         <xs:attribute name="beStrictAboutTestsThatDoNotTestAnything" type="xs:boolean" default="true"/>

src/Framework/TestSuite.php

@@ -38,7 +38,7 @@
 use PHPUnit\Runner\Filter\Factory;
 use PHPUnit\Runner\PhptTestCase;
 use PHPUnit\Runner\TestSuiteLoader;
-use PHPUnit\TestRunner\TestResult\Facade;
+use PHPUnit\TestRunner\TestResult\Facade as TestResultFacade;
 use PHPUnit\TextUI\Configuration\Registry;
 use PHPUnit\Util\Filter;
 use PHPUnit\Util\Reflection;
@@ -69,13 +69,15 @@ class TestSuite implements IteratorAggregate, Reorderable, SelfDescribing, Test
     private array $tests             = [];
     private ?array $providedTests    = null;
     private ?Factory $iteratorFilter = null;
+    private readonly bool $stopOnDefect;
+    private readonly bool $stopOnDeprecation;
     private readonly bool $stopOnError;
     private readonly bool $stopOnFailure;
-    private readonly bool $stopOnWarning;
-    private readonly bool $stopOnRisky;
     private readonly bool $stopOnIncomplete;
+    private readonly bool $stopOnNotice;
+    private readonly bool $stopOnRisky;
     private readonly bool $stopOnSkipped;
-    private readonly bool $stopOnDefect;
+    private readonly bool $stopOnWarning;
 
     public static function empty(string $name = null): static
     {
@@ -149,13 +151,15 @@ final private function __construct(string $name)
 
         $configuration = Registry::get();
 
-        $this->stopOnError      = $configuration->stopOnError();
-        $this->stopOnFailure    = $configuration->stopOnFailure();
-        $this->stopOnWarning    = $configuration->stopOnWarning();
-        $this->stopOnRisky      = $configuration->stopOnRisky();
-        $this->stopOnIncomplete = $configuration->stopOnIncomplete();
-        $this->stopOnSkipped    = $configuration->stopOnSkipped();
-        $this->stopOnDefect     = $configuration->stopOnDefect();
+        $this->stopOnDeprecation = $configuration->stopOnDeprecation();
+        $this->stopOnDefect      = $configuration->stopOnDefect();
+        $this->stopOnError       = $configuration->stopOnError();
+        $this->stopOnFailure     = $configuration->stopOnFailure();
+        $this->stopOnIncomplete  = $configuration->stopOnIncomplete();
+        $this->stopOnNotice      = $configuration->stopOnNotice();
+        $this->stopOnRisky       = $configuration->stopOnRisky();
+        $this->stopOnSkipped     = $configuration->stopOnSkipped();
+        $this->stopOnWarning     = $configuration->stopOnWarning();
     }
 
     /**
@@ -344,7 +348,7 @@ public function run(): void
         }
 
         foreach ($this as $test) {
-            if ($this->shouldStop()) {
+            if (TestResultFacade::shouldStop()) {
                 break;
             }
 
@@ -550,35 +554,6 @@ private function methodDoesNotExistOrIsDeclaredInTestCase(string $methodName): b
                $reflector->getMethod($methodName)->getDeclaringClass()->getName() === TestCase::class;
     }
 
-    private function shouldStop(): bool
-    {
-        if (($this->stopOnDefect || $this->stopOnError) && Facade::hasTestErroredEvents()) {
-            return true;
-        }
-
-        if (($this->stopOnDefect || $this->stopOnFailure) && Facade::hasTestFailedEvents()) {
-            return true;
-        }
-
-        if (($this->stopOnDefect || $this->stopOnWarning) && Facade::hasWarningEvents()) {
-            return true;
-        }
-
-        if (($this->stopOnDefect || $this->stopOnRisky) && Facade::hasTestConsideredRiskyEvents()) {
-            return true;
-        }
-
-        if ($this->stopOnSkipped && Facade::hasTestSkippedEvents()) {
-            return true;
-        }
-
-        if ($this->stopOnIncomplete && Facade::hasTestMarkedIncompleteEvents()) {
-            return true;
-        }
-
-        return false;
-    }
-
     /**
      * @throws Exception
      */

src/Runner/TestResult/Collector.php

@@ -229,19 +229,6 @@ public function hasTestMarkedIncompleteEvents(): bool
         return !empty($this->testMarkedIncompleteEvents);
     }
 
-    public function hasTestRunnerTriggeredWarningEvents(): bool
-    {
-        return !empty($this->testRunnerTriggeredWarningEvents);
-    }
-
-    /**
-     * @psalm-return list<TestRunnerWarningTriggered>
-     */
-    public function testRunnerTriggeredWarningEvents(): array
-    {
-        return $this->testRunnerTriggeredWarningEvents;
-    }
-
     public function executionStarted(ExecutionStarted $event): void
     {
         $this->numberOfTests = $event->testSuite()->count();
@@ -470,6 +457,20 @@ public function testRunnerTriggeredWarning(TestRunnerWarningTriggered $event): v
         $this->testRunnerTriggeredWarningEvents[] = $event;
     }
 
+    public function hasDeprecationEvents(): bool
+    {
+        return !empty($this->testTriggeredDeprecationEvents) ||
+               !empty($this->testTriggeredPhpDeprecationEvents) ||
+               !empty($this->testTriggeredPhpunitDeprecationEvents) ||
+               !empty($this->testRunnerTriggeredDeprecationEvents);
+    }
+
+    public function hasNoticeEvents(): bool
+    {
+        return !empty($this->testTriggeredNoticeEvents) ||
+               !empty($this->testTriggeredPhpNoticeEvents);
+    }
+
     public function hasWarningEvents(): bool
     {
         return !empty($this->testTriggeredWarningEvents) ||

src/Runner/TestResult/Facade.php

@@ -12,6 +12,7 @@
 use PHPUnit\Event\EventFacadeIsSealedException;
 use PHPUnit\Event\Facade as EventFacade;
 use PHPUnit\Event\UnknownSubscriberTypeException;
+use PHPUnit\TextUI\Configuration\Registry as ConfigurationRegistry;
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
@@ -42,54 +43,44 @@ public static function result(): TestResult
      * @throws EventFacadeIsSealedException
      * @throws UnknownSubscriberTypeException
      */
-    public static function hasTestErroredEvents(): bool
+    public static function shouldStop(): bool
     {
-        return self::collector()->hasTestErroredEvents();
-    }
+        $configuration = ConfigurationRegistry::get();
+        $collector     = self::collector();
 
-    /**
-     * @throws EventFacadeIsSealedException
-     * @throws UnknownSubscriberTypeException
-     */
-    public static function hasTestFailedEvents(): bool
-    {
-        return self::collector()->hasTestFailedEvents();
-    }
+        if (($configuration->stopOnDefect() || $configuration->stopOnError()) && $collector->hasTestErroredEvents()) {
+            return true;
+        }
 
-    /**
-     * @throws EventFacadeIsSealedException
-     * @throws UnknownSubscriberTypeException
-     */
-    public static function hasWarningEvents(): bool
-    {
-        return self::collector()->hasWarningEvents();
-    }
+        if (($configuration->stopOnDefect() || $configuration->stopOnFailure()) && $collector->hasTestFailedEvents()) {
+            return true;
+        }
 
-    /**
-     * @throws EventFacadeIsSealedException
-     * @throws UnknownSubscriberTypeException
-     */
-    public static function hasTestConsideredRiskyEvents(): bool
-    {
-        return self::collector()->hasTestConsideredRiskyEvents();
-    }
+        if (($configuration->stopOnDefect() || $configuration->stopOnWarning()) && $collector->hasWarningEvents()) {
+            return true;
+        }
 
-    /**
-     * @throws EventFacadeIsSealedException
-     * @throws UnknownSubscriberTypeException
-     */
-    public static function hasTestSkippedEvents(): bool
-    {
-        return self::collector()->hasTestSkippedEvents();
-    }
+        if (($configuration->stopOnDefect() || $configuration->stopOnRisky()) && $collector->hasTestConsideredRiskyEvents()) {
+            return true;
+        }
 
-    /**
-     * @throws EventFacadeIsSealedException
-     * @throws UnknownSubscriberTypeException
-     */
-    public static function hasTestMarkedIncompleteEvents(): bool
-    {
-        return self::collector()->hasTestMarkedIncompleteEvents();
+        if ($configuration->stopOnDeprecation() && $collector->hasDeprecationEvents()) {
+            return true;
+        }
+
+        if ($configuration->stopOnNotice() && $collector->hasNoticeEvents()) {
+            return true;
+        }
+
+        if ($configuration->stopOnIncomplete() && $collector->hasTestMarkedIncompleteEvents()) {
+            return true;
+        }
+
+        if ($configuration->stopOnSkipped() && $collector->hasTestSkippedEvents()) {
+            return true;
+        }
+
+        return false;
     }
 
     /**

src/TextUI/Application.php

@@ -195,11 +195,13 @@ public function run(array $argv): int
             CodeCoverage::instance()->generateReports($printer, $configuration);
 
             $shellExitCode = (new ShellExitCodeCalculator)->calculate(
+                $configuration->failOnDeprecation(),
                 $configuration->failOnEmptyTestSuite(),
-                $configuration->failOnRisky(),
-                $configuration->failOnWarning(),
                 $configuration->failOnIncomplete(),
+                $configuration->failOnNotice(),
+                $configuration->failOnRisky(),
                 $configuration->failOnSkipped(),
+                $configuration->failOnWarning(),
                 $result
             );