Closes #6236

Author: sebastianbergmann

ChangeLog-10.5.md

@@ -6,7 +6,8 @@ All notable changes of the PHPUnit 10.5 release series are documented in this fi
 
 ### Added
 
-* [#6239](https://github.com/sebastianbergmann/phpunit/issues/6239): `--do-not-fail-on-deprecation`, `--do-not-fail-on-phpunit-deprecation`, `--do-not-fail-on-empty-test-suite`, `--do-not-fail-on-incomplete`, `--do-not-fail-on-notice`, `--do-not-fail-on-risky`, `--do-not-fail-on-skipped`, and `--do-not-fail-on-warning` CLI options
+* [#6236](https://github.com/sebastianbergmann/phpunit/issues/6236): `failOnPhpunitWarning` attribute on the `<phpunit>` element of the XML configuration file and `--fail-on-phpunit-warning` CLI option for controlling whether PHPUnit should fail on PHPUnit warnings (default: `true`)
+* [#6239](https://github.com/sebastianbergmann/phpunit/issues/6239): `--do-not-fail-on-deprecation`, `--do-not-fail-on-phpunit-warning`, --do-not-fail-on-phpunit-deprecation`, `--do-not-fail-on-empty-test-suite`, `--do-not-fail-on-incomplete`, `--do-not-fail-on-notice`, `--do-not-fail-on-risky`, `--do-not-fail-on-skipped`, and `--do-not-fail-on-warning` CLI options
 * `--do-not-report-useless-tests` CLI option as a replacement for `--dont-report-useless-tests`
 
 ### Deprecated

phpunit.xsd

@@ -180,6 +180,7 @@
         <xs:attribute name="failOnAllIssues" type="xs:boolean" default="false"/>
         <xs:attribute name="failOnDeprecation" type="xs:boolean" default="false"/>
         <xs:attribute name="failOnPhpunitDeprecation" type="xs:boolean" default="false"/>
+        <xs:attribute name="failOnPhpunitWarning" type="xs:boolean" default="true"/>
         <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"/>

src/Runner/TestResult/TestResult.php

@@ -387,32 +387,32 @@ public function hasTestRunnerTriggeredWarningEvents(): bool
     }
 
     public function wasSuccessful(): bool
-    {
-        return $this->wasSuccessfulIgnoringPhpunitWarnings() &&
-               !$this->hasTestTriggeredPhpunitErrorEvents() &&
-               !$this->hasTestRunnerTriggeredWarningEvents() &&
-               !$this->hasTestTriggeredPhpunitWarningEvents();
-    }
-
-    public function wasSuccessfulIgnoringPhpunitWarnings(): bool
     {
         return !$this->hasTestErroredEvents() &&
-               !$this->hasTestFailedEvents();
+               !$this->hasTestFailedEvents() &&
+               !$this->hasTestTriggeredPhpunitErrorEvents();
     }
 
     public function wasSuccessfulAndNoTestHasIssues(): bool
     {
         return $this->wasSuccessful() && !$this->hasTestsWithIssues();
     }
 
+    public function hasIssues(): bool
+    {
+        return $this->hasTestsWithIssues() ||
+               $this->hasTestRunnerTriggeredWarningEvents();
+    }
+
     public function hasTestsWithIssues(): bool
     {
         return $this->hasRiskyTests() ||
                $this->hasIncompleteTests() ||
                $this->hasDeprecations() ||
                !empty($this->errors) ||
                $this->hasNotices() ||
-               $this->hasWarnings();
+               $this->hasWarnings() ||
+               $this->hasPhpunitWarnings();
     }
 
     /**
@@ -515,6 +515,17 @@ public function numberOfPhpunitDeprecations(): int
                count($this->testRunnerTriggeredDeprecationEvents);
     }
 
+    public function hasPhpunitWarnings(): bool
+    {
+        return $this->numberOfPhpunitWarnings() > 0;
+    }
+
+    public function numberOfPhpunitWarnings(): int
+    {
+        return count($this->testTriggeredPhpunitWarningEvents) +
+               count($this->testRunnerTriggeredWarningEvents);
+    }
+
     public function numberOfDeprecations(): int
     {
         return count($this->deprecations) +
@@ -542,9 +553,7 @@ public function hasWarnings(): bool
     public function numberOfWarnings(): int
     {
         return count($this->warnings) +
-               count($this->phpWarnings) +
-               count($this->testTriggeredPhpunitWarningEvents) +
-               count($this->testRunnerTriggeredWarningEvents);
+               count($this->phpWarnings);
     }
 
     public function hasIncompleteTests(): bool

src/TextUI/Configuration/Cli/Builder.php

@@ -106,6 +106,7 @@ final class Builder
         'fail-on-all-issues',
         'fail-on-deprecation',
         'fail-on-phpunit-deprecation',
+        'fail-on-phpunit-warning',
         'fail-on-empty-test-suite',
         'fail-on-incomplete',
         'fail-on-notice',
@@ -114,6 +115,7 @@ final class Builder
         'fail-on-warning',
         'do-not-fail-on-deprecation',
         'do-not-fail-on-phpunit-deprecation',
+        'do-not-fail-on-phpunit-warning',
         'do-not-fail-on-empty-test-suite',
         'do-not-fail-on-incomplete',
         'do-not-fail-on-notice',
@@ -213,6 +215,7 @@ public function fromParameters(array $parameters): Configuration
         $failOnAllIssues                   = null;
         $failOnDeprecation                 = null;
         $failOnPhpunitDeprecation          = null;
+        $failOnPhpunitWarning              = null;
         $failOnEmptyTestSuite              = null;
         $failOnIncomplete                  = null;
         $failOnNotice                      = null;
@@ -221,6 +224,7 @@ public function fromParameters(array $parameters): Configuration
         $failOnWarning                     = null;
         $doNotFailOnDeprecation            = null;
         $doNotFailOnPhpunitDeprecation     = null;
+        $doNotFailOnPhpunitWarning         = null;
         $doNotFailOnEmptyTestSuite         = null;
         $doNotFailOnIncomplete             = null;
         $doNotFailOnNotice                 = null;
@@ -616,6 +620,17 @@ public function fromParameters(array $parameters): Configuration
 
                     break;
 
+                case '--fail-on-phpunit-warning':
+                    $this->warnWhenOptionsConflict(
+                        $doNotFailOnPhpunitWarning,
+                        '--fail-on-phpunit-warning',
+                        '--do-not-fail-on-phpunit-warning',
+                    );
+
+                    $failOnPhpunitWarning = true;
+
+                    break;
+
                 case '--fail-on-empty-test-suite':
                     $this->warnWhenOptionsConflict(
                         $doNotFailOnEmptyTestSuite,
@@ -704,6 +719,17 @@ public function fromParameters(array $parameters): Configuration
 
                     break;
 
+                case '--do-not-fail-on-phpunit-warning':
+                    $this->warnWhenOptionsConflict(
+                        $failOnPhpunitWarning,
+                        '--do-not-fail-on-phpunit-warning',
+                        '--fail-on-phpunit-warning',
+                    );
+
+                    $doNotFailOnPhpunitWarning = true;
+
+                    break;
+
                 case '--do-not-fail-on-empty-test-suite':
                     $this->warnWhenOptionsConflict(
                         $failOnEmptyTestSuite,
@@ -1095,6 +1121,7 @@ public function fromParameters(array $parameters): Configuration
             $failOnAllIssues,
             $failOnDeprecation,
             $failOnPhpunitDeprecation,
+            $failOnPhpunitWarning,
             $failOnEmptyTestSuite,
             $failOnIncomplete,
             $failOnNotice,
@@ -1103,6 +1130,7 @@ public function fromParameters(array $parameters): Configuration
             $failOnWarning,
             $doNotFailOnDeprecation,
             $doNotFailOnPhpunitDeprecation,
+            $doNotFailOnPhpunitWarning,
             $doNotFailOnEmptyTestSuite,
             $doNotFailOnIncomplete,
             $doNotFailOnNotice,

src/TextUI/Configuration/Cli/Configuration.php

@@ -57,6 +57,7 @@ final class Configuration
     private readonly ?bool $failOnAllIssues;
     private readonly ?bool $failOnDeprecation;
     private readonly ?bool $failOnPhpunitDeprecation;
+    private readonly ?bool $failOnPhpunitWarning;
     private readonly ?bool $failOnEmptyTestSuite;
     private readonly ?bool $failOnIncomplete;
     private readonly ?bool $failOnNotice;
@@ -65,6 +66,7 @@ final class Configuration
     private readonly ?bool $failOnWarning;
     private readonly ?bool $doNotFailOnDeprecation;
     private readonly ?bool $doNotFailOnPhpunitDeprecation;
+    private readonly ?bool $doNotFailOnPhpunitWarning;
     private readonly ?bool $doNotFailOnEmptyTestSuite;
     private readonly ?bool $doNotFailOnIncomplete;
     private readonly ?bool $doNotFailOnNotice;
@@ -140,7 +142,7 @@ final class Configuration
      * @psalm-param list<non-empty-string> $arguments
      * @psalm-param ?non-empty-list<non-empty-string> $testSuffixes
      */
-    public function __construct(array $arguments, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticProperties, ?bool $beStrictAboutChangesToGlobalState, ?string $bootstrap, ?string $cacheDirectory, ?bool $cacheResult, ?string $cacheResultFile, bool $checkVersion, ?string $colors, null|int|string $columns, ?string $configurationFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $pathCoverage, ?string $coverageCacheDirectory, bool $warmCoverageCache, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?bool $failOnAllIssues, ?bool $failOnDeprecation, ?bool $failOnPhpunitDeprecation, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnNotice, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?bool $doNotFailOnDeprecation, ?bool $doNotFailOnPhpunitDeprecation, ?bool $doNotFailOnEmptyTestSuite, ?bool $doNotFailOnIncomplete, ?bool $doNotFailOnNotice, ?bool $doNotFailOnRisky, ?bool $doNotFailOnSkipped, ?bool $doNotFailOnWarning, ?bool $stopOnDefect, ?bool $stopOnDeprecation, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnNotice, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $filter, ?string $generateBaseline, ?string $useBaseline, bool $ignoreBaseline, bool $generateConfiguration, bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, bool $listGroups, bool $listSuites, bool $listTests, ?string $listTestsXml, ?bool $noCoverage, ?bool $noExtensions, ?bool $noOutput, ?bool $noProgress, ?bool $noResults, ?bool $noLogging, ?bool $processIsolation, ?int $randomOrderSeed, ?bool $reportUselessTests, ?bool $resolveDependencies, ?bool $reverseList, ?bool $stderr, ?bool $strictCoverage, ?string $teamcityLogfile, ?string $testdoxHtmlFile, ?string $testdoxTextFile, ?array $testSuffixes, ?string $testSuite, ?string $excludeTestSuite, bool $useDefaultConfiguration, ?bool $displayDetailsOnAllIssues, ?bool $displayDetailsOnIncompleteTests, ?bool $displayDetailsOnSkippedTests, ?bool $displayDetailsOnTestsThatTriggerDeprecations, ?bool $displayDetailsOnPhpunitDeprecations, ?bool $displayDetailsOnTestsThatTriggerErrors, ?bool $displayDetailsOnTestsThatTriggerNotices, ?bool $displayDetailsOnTestsThatTriggerWarnings, bool $version, ?array $coverageFilter, ?string $logEventsText, ?string $logEventsVerboseText, ?bool $printerTeamCity, ?bool $printerTestDox, bool $debug)
+    public function __construct(array $arguments, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticProperties, ?bool $beStrictAboutChangesToGlobalState, ?string $bootstrap, ?string $cacheDirectory, ?bool $cacheResult, ?string $cacheResultFile, bool $checkVersion, ?string $colors, null|int|string $columns, ?string $configurationFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $pathCoverage, ?string $coverageCacheDirectory, bool $warmCoverageCache, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?bool $failOnAllIssues, ?bool $failOnDeprecation, ?bool $failOnPhpunitDeprecation, ?bool $failOnPhpunitWarning, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnNotice, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?bool $doNotFailOnDeprecation, ?bool $doNotFailOnPhpunitDeprecation, ?bool $doNotFailOnPhpunitWarning, ?bool $doNotFailOnEmptyTestSuite, ?bool $doNotFailOnIncomplete, ?bool $doNotFailOnNotice, ?bool $doNotFailOnRisky, ?bool $doNotFailOnSkipped, ?bool $doNotFailOnWarning, ?bool $stopOnDefect, ?bool $stopOnDeprecation, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnNotice, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $filter, ?string $generateBaseline, ?string $useBaseline, bool $ignoreBaseline, bool $generateConfiguration, bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, bool $listGroups, bool $listSuites, bool $listTests, ?string $listTestsXml, ?bool $noCoverage, ?bool $noExtensions, ?bool $noOutput, ?bool $noProgress, ?bool $noResults, ?bool $noLogging, ?bool $processIsolation, ?int $randomOrderSeed, ?bool $reportUselessTests, ?bool $resolveDependencies, ?bool $reverseList, ?bool $stderr, ?bool $strictCoverage, ?string $teamcityLogfile, ?string $testdoxHtmlFile, ?string $testdoxTextFile, ?array $testSuffixes, ?string $testSuite, ?string $excludeTestSuite, bool $useDefaultConfiguration, ?bool $displayDetailsOnAllIssues, ?bool $displayDetailsOnIncompleteTests, ?bool $displayDetailsOnSkippedTests, ?bool $displayDetailsOnTestsThatTriggerDeprecations, ?bool $displayDetailsOnPhpunitDeprecations, ?bool $displayDetailsOnTestsThatTriggerErrors, ?bool $displayDetailsOnTestsThatTriggerNotices, ?bool $displayDetailsOnTestsThatTriggerWarnings, bool $version, ?array $coverageFilter, ?string $logEventsText, ?string $logEventsVerboseText, ?bool $printerTeamCity, ?bool $printerTestDox, bool $debug)
     {
         $this->arguments                                    = $arguments;
         $this->atLeastVersion                               = $atLeastVersion;
@@ -178,6 +180,7 @@ public function __construct(array $arguments, ?string $atLeastVersion, ?bool $ba
         $this->failOnAllIssues                              = $failOnAllIssues;
         $this->failOnDeprecation                            = $failOnDeprecation;
         $this->failOnPhpunitDeprecation                     = $failOnPhpunitDeprecation;
+        $this->failOnPhpunitWarning                         = $failOnPhpunitWarning;
         $this->failOnEmptyTestSuite                         = $failOnEmptyTestSuite;
         $this->failOnIncomplete                             = $failOnIncomplete;
         $this->failOnNotice                                 = $failOnNotice;
@@ -186,6 +189,7 @@ public function __construct(array $arguments, ?string $atLeastVersion, ?bool $ba
         $this->failOnWarning                                = $failOnWarning;
         $this->doNotFailOnDeprecation                       = $doNotFailOnDeprecation;
         $this->doNotFailOnPhpunitDeprecation                = $doNotFailOnPhpunitDeprecation;
+        $this->doNotFailOnPhpunitWarning                    = $doNotFailOnPhpunitWarning;
         $this->doNotFailOnEmptyTestSuite                    = $doNotFailOnEmptyTestSuite;
         $this->doNotFailOnIncomplete                        = $doNotFailOnIncomplete;
         $this->doNotFailOnNotice                            = $doNotFailOnNotice;
@@ -940,6 +944,26 @@ public function failOnPhpunitDeprecation(): bool
         return $this->failOnPhpunitDeprecation;
     }
 
+    /**
+     * @psalm-assert-if-true !null $this->failOnPhpunitWarning
+     */
+    public function hasFailOnPhpunitWarning(): bool
+    {
+        return $this->failOnPhpunitWarning !== null;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function failOnPhpunitWarning(): bool
+    {
+        if (!$this->hasFailOnPhpunitWarning()) {
+            throw new Exception;
+        }
+
+        return $this->failOnPhpunitWarning;
+    }
+
     /**
      * @psalm-assert-if-true !null $this->failOnEmptyTestSuite
      */
@@ -1100,6 +1124,26 @@ public function doNotFailOnPhpunitDeprecation(): bool
         return $this->doNotFailOnPhpunitDeprecation;
     }
 
+    /**
+     * @psalm-assert-if-true !null $this->doNotFailOnPhpunitWarning
+     */
+    public function hasDoNotFailOnPhpunitWarning(): bool
+    {
+        return $this->doNotFailOnPhpunitWarning !== null;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function doNotFailOnPhpunitWarning(): bool
+    {
+        if (!$this->hasDoNotFailOnPhpunitWarning()) {
+            throw new Exception;
+        }
+
+        return $this->doNotFailOnPhpunitWarning;
+    }
+
     /**
      * @psalm-assert-if-true !null $this->doNotFailOnEmptyTestSuite
      */