Merge branch '11.5' into 12.2

Author: sebastianbergmann

ChangeLog-12.2.md

@@ -6,7 +6,8 @@ All notable changes of the PHPUnit 12.2 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-phpunit-notice`, `--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

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

@@ -441,14 +441,6 @@ 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() &&
@@ -469,7 +461,8 @@ public function hasTestsWithIssues(): bool
                $this->errors !== [] ||
                $this->hasNotices() ||
                $this->hasWarnings() ||
-               $this->hasPhpunitNotices();
+               $this->hasPhpunitNotices() ||
+               $this->hasPhpunitWarnings();
     }
 
     /**
@@ -572,6 +565,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) +
@@ -599,9 +603,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

@@ -115,6 +115,7 @@ final class Builder
         'fail-on-deprecation',
         'fail-on-phpunit-deprecation',
         'fail-on-phpunit-notice',
+        'fail-on-phpunit-warning',
         'fail-on-empty-test-suite',
         'fail-on-incomplete',
         'fail-on-notice',
@@ -124,6 +125,7 @@ final class Builder
         'do-not-fail-on-deprecation',
         'do-not-fail-on-phpunit-deprecation',
         'do-not-fail-on-phpunit-notice',
+        'do-not-fail-on-phpunit-warning',
         'do-not-fail-on-empty-test-suite',
         'do-not-fail-on-incomplete',
         'do-not-fail-on-notice',
@@ -230,6 +232,7 @@ public function fromParameters(array $parameters): Configuration
         $failOnDeprecation                 = null;
         $failOnPhpunitDeprecation          = null;
         $failOnPhpunitNotice               = null;
+        $failOnPhpunitWarning              = null;
         $failOnEmptyTestSuite              = null;
         $failOnIncomplete                  = null;
         $failOnNotice                      = null;
@@ -239,6 +242,7 @@ public function fromParameters(array $parameters): Configuration
         $doNotFailOnDeprecation            = null;
         $doNotFailOnPhpunitDeprecation     = null;
         $doNotFailOnPhpunitNotice          = null;
+        $doNotFailOnPhpunitWarning         = null;
         $doNotFailOnEmptyTestSuite         = null;
         $doNotFailOnIncomplete             = null;
         $doNotFailOnNotice                 = null;
@@ -712,6 +716,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,
@@ -811,6 +826,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,
@@ -1236,6 +1262,7 @@ public function fromParameters(array $parameters): Configuration
             $failOnDeprecation,
             $failOnPhpunitDeprecation,
             $failOnPhpunitNotice,
+            $failOnPhpunitWarning,
             $failOnEmptyTestSuite,
             $failOnIncomplete,
             $failOnNotice,
@@ -1245,6 +1272,7 @@ public function fromParameters(array $parameters): Configuration
             $doNotFailOnDeprecation,
             $doNotFailOnPhpunitDeprecation,
             $doNotFailOnPhpunitNotice,
+            $doNotFailOnPhpunitWarning,
             $doNotFailOnEmptyTestSuite,
             $doNotFailOnIncomplete,
             $doNotFailOnNotice,

src/TextUI/Configuration/Cli/Configuration.php

@@ -65,6 +65,7 @@
     private ?bool $failOnDeprecation;
     private ?bool $failOnPhpunitDeprecation;
     private ?bool $failOnPhpunitNotice;
+    private ?bool $failOnPhpunitWarning;
     private ?bool $failOnEmptyTestSuite;
     private ?bool $failOnIncomplete;
     private ?bool $failOnNotice;
@@ -74,6 +75,7 @@
     private ?bool $doNotFailOnDeprecation;
     private ?bool $doNotFailOnPhpunitDeprecation;
     private ?bool $doNotFailOnPhpunitNotice;
+    private ?bool $doNotFailOnPhpunitWarning;
     private ?bool $doNotFailOnEmptyTestSuite;
     private ?bool $doNotFailOnIncomplete;
     private ?bool $doNotFailOnNotice;
@@ -190,7 +192,7 @@
      * @param ?non-empty-list<non-empty-string>                    $coverageFilter
      * @param ?non-empty-list<non-empty-string>                    $extensions
      */
-    public function __construct(array $arguments, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticProperties, ?bool $beStrictAboutChangesToGlobalState, ?string $bootstrap, ?string $cacheDirectory, ?bool $cacheResult, bool $checkVersion, ?string $colors, null|int|string $columns, ?string $configurationFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coverageOpenClover, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $pathCoverage, bool $warmCoverageCache, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?bool $failOnAllIssues, ?bool $failOnDeprecation, ?bool $failOnPhpunitDeprecation, ?bool $failOnPhpunitNotice, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnNotice, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?bool $doNotFailOnDeprecation, ?bool $doNotFailOnPhpunitDeprecation, ?bool $doNotFailOnPhpunitNotice, ?bool $doNotFailOnEmptyTestSuite, ?bool $doNotFailOnIncomplete, ?bool $doNotFailOnNotice, ?bool $doNotFailOnRisky, ?bool $doNotFailOnSkipped, ?bool $doNotFailOnWarning, ?bool $stopOnDefect, ?bool $stopOnDeprecation, ?string $specificDeprecationToStopOn, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnNotice, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $filter, ?string $excludeFilter, ?string $generateBaseline, ?string $useBaseline, bool $ignoreBaseline, bool $generateConfiguration, bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, ?array $testsRequiringPhpExtension, bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, ?string $otrLogfile, bool $listGroups, bool $listSuites, bool $listTestFiles, 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 $displayDetailsOnPhpunitNotices, ?bool $displayDetailsOnTestsThatTriggerErrors, ?bool $displayDetailsOnTestsThatTriggerNotices, ?bool $displayDetailsOnTestsThatTriggerWarnings, bool $version, ?array $coverageFilter, ?string $logEventsText, ?string $logEventsVerboseText, ?bool $printerTeamCity, ?bool $testdoxPrinter, ?bool $testdoxPrinterSummary, bool $debug, bool $withTelemetry, ?array $extensions)
+    public function __construct(array $arguments, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticProperties, ?bool $beStrictAboutChangesToGlobalState, ?string $bootstrap, ?string $cacheDirectory, ?bool $cacheResult, bool $checkVersion, ?string $colors, null|int|string $columns, ?string $configurationFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coverageOpenClover, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $pathCoverage, bool $warmCoverageCache, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?bool $failOnAllIssues, ?bool $failOnDeprecation, ?bool $failOnPhpunitDeprecation, ?bool $failOnPhpunitNotice, ?bool $failOnPhpunitWarning, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnNotice, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?bool $doNotFailOnDeprecation, ?bool $doNotFailOnPhpunitDeprecation, ?bool $doNotFailOnPhpunitNotice, ?bool $doNotFailOnPhpunitWarning, ?bool $doNotFailOnEmptyTestSuite, ?bool $doNotFailOnIncomplete, ?bool $doNotFailOnNotice, ?bool $doNotFailOnRisky, ?bool $doNotFailOnSkipped, ?bool $doNotFailOnWarning, ?bool $stopOnDefect, ?bool $stopOnDeprecation, ?string $specificDeprecationToStopOn, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnNotice, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $filter, ?string $excludeFilter, ?string $generateBaseline, ?string $useBaseline, bool $ignoreBaseline, bool $generateConfiguration, bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, ?array $testsRequiringPhpExtension, bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, ?string $otrLogfile, bool $listGroups, bool $listSuites, bool $listTestFiles, 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 $displayDetailsOnPhpunitNotices, ?bool $displayDetailsOnTestsThatTriggerErrors, ?bool $displayDetailsOnTestsThatTriggerNotices, ?bool $displayDetailsOnTestsThatTriggerWarnings, bool $version, ?array $coverageFilter, ?string $logEventsText, ?string $logEventsVerboseText, ?bool $printerTeamCity, ?bool $testdoxPrinter, ?bool $testdoxPrinterSummary, bool $debug, bool $withTelemetry, ?array $extensions)
     {
         $this->arguments                                    = $arguments;
         $this->atLeastVersion                               = $atLeastVersion;
@@ -228,6 +230,7 @@ public function __construct(array $arguments, ?string $atLeastVersion, ?bool $ba
         $this->failOnDeprecation                            = $failOnDeprecation;
         $this->failOnPhpunitDeprecation                     = $failOnPhpunitDeprecation;
         $this->failOnPhpunitNotice                          = $failOnPhpunitNotice;
+        $this->failOnPhpunitWarning                         = $failOnPhpunitWarning;
         $this->failOnEmptyTestSuite                         = $failOnEmptyTestSuite;
         $this->failOnIncomplete                             = $failOnIncomplete;
         $this->failOnNotice                                 = $failOnNotice;
@@ -237,6 +240,7 @@ public function __construct(array $arguments, ?string $atLeastVersion, ?bool $ba
         $this->doNotFailOnDeprecation                       = $doNotFailOnDeprecation;
         $this->doNotFailOnPhpunitDeprecation                = $doNotFailOnPhpunitDeprecation;
         $this->doNotFailOnPhpunitNotice                     = $doNotFailOnPhpunitNotice;
+        $this->doNotFailOnPhpunitWarning                    = $doNotFailOnPhpunitWarning;
         $this->doNotFailOnEmptyTestSuite                    = $doNotFailOnEmptyTestSuite;
         $this->doNotFailOnIncomplete                        = $doNotFailOnIncomplete;
         $this->doNotFailOnNotice                            = $doNotFailOnNotice;
@@ -996,6 +1000,26 @@ public function failOnPhpunitNotice(): bool
         return $this->failOnPhpunitNotice;
     }
 
+    /**
+     * @phpstan-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;
+    }
+
     /**
      * @phpstan-assert-if-true !null $this->failOnEmptyTestSuite
      */
@@ -1176,6 +1200,26 @@ public function doNotFailOnPhpunitNotice(): bool
         return $this->doNotFailOnPhpunitNotice;
     }
 
+    /**
+     * @phpstan-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;
+    }
+
     /**
      * @phpstan-assert-if-true !null $this->doNotFailOnEmptyTestSuite
      */