Skip to content

Commit 1a5d2b8

Browse files
sebastianbergmannsebastianbergmann
committed
Closes #5937 
1 parent 43e7c3e commit 1a5d2b8

24 files changed

+191
-13
lines changed

‎ChangeLog-10.5.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
All notable changes of the PHPUnit 10.5 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
44

5+
## [10.5.32] - 2024-MM-DD
6+
7+
### Added
8+
9+
* [#5937](https://github.com/sebastianbergmann/phpunit/issues/5937): Optionally ignore PHPUnit deprecations when determining the test runner's shell exit code
10+
511
## [10.5.31] - 2024-09-03
612

713
### Changed
@@ -282,6 +288,7 @@ All notable changes of the PHPUnit 10.5 release series are documented in this fi
282288

283289
* [#5563](https://github.com/sebastianbergmann/phpunit/issues/5563): `createMockForIntersectionOfInterfaces()` does not automatically register mock object for expectation verification
284290

291+
[10.5.32]: https://github.com/sebastianbergmann/phpunit/compare/10.5.31...10.5
285292
[10.5.31]: https://github.com/sebastianbergmann/phpunit/compare/10.5.30...10.5.31
286293
[10.5.30]: https://github.com/sebastianbergmann/phpunit/compare/10.5.29...10.5.30
287294
[10.5.29]: https://github.com/sebastianbergmann/phpunit/compare/10.5.28...10.5.29

‎phpunit.xsd‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,7 @@
178178
<xs:attribute name="requireCoverageMetadata" type="xs:boolean" default="false"/>
179179
<xs:attribute name="processIsolation" type="xs:boolean" default="false"/>
180180
<xs:attribute name="failOnDeprecation" type="xs:boolean" default="false"/>
181+
<xs:attribute name="failOnPhpunitDeprecation" type="xs:boolean" default="false"/>
181182
<xs:attribute name="failOnEmptyTestSuite" type="xs:boolean" default="false"/>
182183
<xs:attribute name="failOnIncomplete" type="xs:boolean" default="false"/>
183184
<xs:attribute name="failOnNotice" type="xs:boolean" default="false"/>

‎src/Runner/TestResult/TestResult.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,16 @@ public function hasDeprecations(): bool
492492
return $this->numberOfDeprecations() > 0;
493493
}
494494

495+
public function hasPhpOrUserDeprecations(): bool
496+
{
497+
return count($this->phpDeprecations) > 0 || count($this->deprecations) > 0;
498+
}
499+
500+
public function hasPhpunitDeprecations(): bool
501+
{
502+
return count($this->testTriggeredPhpunitDeprecationEvents) > 0 || count($this->testRunnerTriggeredDeprecationEvents) > 0;
503+
}
504+
495505
public function numberOfDeprecations(): int
496506
{
497507
return count($this->deprecations) +

‎src/TextUI/Application.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@ public function run(array $argv): int
271271

272272
$shellExitCode = (new ShellExitCodeCalculator)->calculate(
273273
$configuration->failOnDeprecation(),
274+
$configuration->failOnPhpunitDeprecation(),
274275
$configuration->failOnEmptyTestSuite(),
275276
$configuration->failOnIncomplete(),
276277
$configuration->failOnNotice(),

‎src/TextUI/Configuration/Cli/Builder.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ final class Builder
101101
'static-backup',
102102
'stderr',
103103
'fail-on-deprecation',
104+
'fail-on-phpunit-deprecation',
104105
'fail-on-empty-test-suite',
105106
'fail-on-incomplete',
106107
'fail-on-notice',
@@ -196,6 +197,7 @@ public function fromParameters(array $parameters): Configuration
196197
$executionOrder = null;
197198
$executionOrderDefects = null;
198199
$failOnDeprecation = null;
200+
$failOnPhpunitDeprecation = null;
199201
$failOnEmptyTestSuite = null;
200202
$failOnIncomplete = null;
201203
$failOnNotice = null;
@@ -569,6 +571,11 @@ public function fromParameters(array $parameters): Configuration
569571

570572
break;
571573

574+
case '--fail-on-phpunit-deprecation':
575+
$failOnPhpunitDeprecation = true;
576+
577+
break;
578+
572579
case '--fail-on-empty-test-suite':
573580
$failOnEmptyTestSuite = true;
574581

@@ -911,6 +918,7 @@ public function fromParameters(array $parameters): Configuration
911918
$executionOrder,
912919
$executionOrderDefects,
913920
$failOnDeprecation,
921+
$failOnPhpunitDeprecation,
914922
$failOnEmptyTestSuite,
915923
$failOnIncomplete,
916924
$failOnNotice,

‎src/TextUI/Configuration/Cli/Configuration.php‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ final class Configuration
5555
private readonly ?int $executionOrder;
5656
private readonly ?int $executionOrderDefects;
5757
private readonly ?bool $failOnDeprecation;
58+
private readonly ?bool $failOnPhpunitDeprecation;
5859
private readonly ?bool $failOnEmptyTestSuite;
5960
private readonly ?bool $failOnIncomplete;
6061
private readonly ?bool $failOnNotice;
@@ -128,7 +129,7 @@ final class Configuration
128129
* @psalm-param list<non-empty-string> $arguments
129130
* @psalm-param ?non-empty-list<non-empty-string> $testSuffixes
130131
*/
131-
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 $failOnDeprecation, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnNotice, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?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 $displayDetailsOnIncompleteTests, ?bool $displayDetailsOnSkippedTests, ?bool $displayDetailsOnTestsThatTriggerDeprecations, ?bool $displayDetailsOnTestsThatTriggerErrors, ?bool $displayDetailsOnTestsThatTriggerNotices, ?bool $displayDetailsOnTestsThatTriggerWarnings, bool $version, ?array $coverageFilter, ?string $logEventsText, ?string $logEventsVerboseText, ?bool $printerTeamCity, ?bool $printerTestDox, bool $debug)
132+
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 $failOnDeprecation, ?bool $failOnPhpunitDeprecation, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnNotice, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?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 $displayDetailsOnIncompleteTests, ?bool $displayDetailsOnSkippedTests, ?bool $displayDetailsOnTestsThatTriggerDeprecations, ?bool $displayDetailsOnTestsThatTriggerErrors, ?bool $displayDetailsOnTestsThatTriggerNotices, ?bool $displayDetailsOnTestsThatTriggerWarnings, bool $version, ?array $coverageFilter, ?string $logEventsText, ?string $logEventsVerboseText, ?bool $printerTeamCity, ?bool $printerTestDox, bool $debug)
132133
{
133134
$this->arguments = $arguments;
134135
$this->atLeastVersion = $atLeastVersion;
@@ -164,6 +165,7 @@ public function __construct(array $arguments, ?string $atLeastVersion, ?bool $ba
164165
$this->executionOrder = $executionOrder;
165166
$this->executionOrderDefects = $executionOrderDefects;
166167
$this->failOnDeprecation = $failOnDeprecation;
168+
$this->failOnPhpunitDeprecation = $failOnPhpunitDeprecation;
167169
$this->failOnEmptyTestSuite = $failOnEmptyTestSuite;
168170
$this->failOnIncomplete = $failOnIncomplete;
169171
$this->failOnNotice = $failOnNotice;
@@ -876,6 +878,26 @@ public function failOnDeprecation(): bool
876878
return $this->failOnDeprecation;
877879
}
878880

881+
/**
882+
* @psalm-assert-if-true !null $this->failOnPhpunitDeprecation
883+
*/
884+
public function hasFailOnPhpunitDeprecation(): bool
885+
{
886+
return $this->failOnPhpunitDeprecation !== null;
887+
}
888+
889+
/**
890+
* @throws Exception
891+
*/
892+
public function failOnPhpunitDeprecation(): bool
893+
{
894+
if (!$this->hasFailOnPhpunitDeprecation()) {
895+
throw new Exception;
896+
}
897+
898+
return $this->failOnPhpunitDeprecation;
899+
}
900+
879901
/**
880902
* @psalm-assert-if-true !null $this->failOnEmptyTestSuite
881903
*/

‎src/TextUI/Configuration/Configuration.php‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ final class Configuration
5454
private readonly bool $ignoreDeprecatedCodeUnitsFromCodeCoverage;
5555
private readonly bool $disableCodeCoverageIgnore;
5656
private readonly bool $failOnDeprecation;
57+
private readonly bool $failOnPhpunitDeprecation;
5758
private readonly bool $failOnEmptyTestSuite;
5859
private readonly bool $failOnIncomplete;
5960
private readonly bool $failOnNotice;
@@ -146,7 +147,7 @@ final class Configuration
146147
* @psalm-param non-empty-list<non-empty-string> $testSuffixes
147148
* @psalm-param list<array{className: class-string, parameters: array<string, string>}> $extensionBootstrappers
148149
*/
149-
public function __construct(array $cliArguments, ?string $configurationFile, ?string $bootstrap, bool $cacheResult, ?string $cacheDirectory, ?string $coverageCacheDirectory, Source $source, string $testResultCacheFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4j, int $coverageCrap4jThreshold, ?string $coverageHtml, int $coverageHtmlLowUpperBound, int $coverageHtmlHighLowerBound, string $coverageHtmlColorSuccessLow, string $coverageHtmlColorSuccessMedium, string $coverageHtmlColorSuccessHigh, string $coverageHtmlColorWarning, string $coverageHtmlColorDanger, ?string $coverageHtmlCustomCssFile, ?string $coveragePhp, ?string $coverageText, bool $coverageTextShowUncoveredFiles, bool $coverageTextShowOnlySummary, ?string $coverageXml, bool $pathCoverage, bool $ignoreDeprecatedCodeUnitsFromCodeCoverage, bool $disableCodeCoverageIgnore, bool $failOnDeprecation, bool $failOnEmptyTestSuite, bool $failOnIncomplete, bool $failOnNotice, bool $failOnRisky, bool $failOnSkipped, bool $failOnWarning, bool $stopOnDefect, bool $stopOnDeprecation, bool $stopOnError, bool $stopOnFailure, bool $stopOnIncomplete, bool $stopOnNotice, bool $stopOnRisky, bool $stopOnSkipped, bool $stopOnWarning, bool $outputToStandardErrorStream, int|string $columns, bool $noExtensions, ?string $pharExtensionDirectory, array $extensionBootstrappers, bool $backupGlobals, bool $backupStaticProperties, bool $beStrictAboutChangesToGlobalState, bool $colors, bool $processIsolation, bool $enforceTimeLimit, int $defaultTimeLimit, int $timeoutForSmallTests, int $timeoutForMediumTests, int $timeoutForLargeTests, bool $reportUselessTests, bool $strictCoverage, bool $disallowTestOutput, bool $displayDetailsOnIncompleteTests, bool $displayDetailsOnSkippedTests, bool $displayDetailsOnTestsThatTriggerDeprecations, bool $displayDetailsOnTestsThatTriggerErrors, bool $displayDetailsOnTestsThatTriggerNotices, bool $displayDetailsOnTestsThatTriggerWarnings, bool $reverseDefectList, bool $requireCoverageMetadata, bool $registerMockObjectsFromTestArgumentsRecursively, bool $noProgress, bool $noResults, bool $noOutput, int $executionOrder, int $executionOrderDefects, bool $resolveDependencies, ?string $logfileTeamcity, ?string $logfileJunit, ?string $logfileTestdoxHtml, ?string $logfileTestdoxText, ?string $logEventsText, ?string $logEventsVerboseText, bool $teamCityOutput, bool $testDoxOutput, ?array $testsCovering, ?array $testsUsing, ?string $filter, ?array $groups, ?array $excludeGroups, int $randomOrderSeed, bool $includeUncoveredFiles, TestSuiteCollection $testSuite, string $includeTestSuite, string $excludeTestSuite, ?string $defaultTestSuite, array $testSuffixes, Php $php, bool $controlGarbageCollector, int $numberOfTestsBeforeGarbageCollection, ?string $generateBaseline, bool $debug)
150+
public function __construct(array $cliArguments, ?string $configurationFile, ?string $bootstrap, bool $cacheResult, ?string $cacheDirectory, ?string $coverageCacheDirectory, Source $source, string $testResultCacheFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4j, int $coverageCrap4jThreshold, ?string $coverageHtml, int $coverageHtmlLowUpperBound, int $coverageHtmlHighLowerBound, string $coverageHtmlColorSuccessLow, string $coverageHtmlColorSuccessMedium, string $coverageHtmlColorSuccessHigh, string $coverageHtmlColorWarning, string $coverageHtmlColorDanger, ?string $coverageHtmlCustomCssFile, ?string $coveragePhp, ?string $coverageText, bool $coverageTextShowUncoveredFiles, bool $coverageTextShowOnlySummary, ?string $coverageXml, bool $pathCoverage, bool $ignoreDeprecatedCodeUnitsFromCodeCoverage, bool $disableCodeCoverageIgnore, bool $failOnDeprecation, bool $failOnPhpunitDeprecation, bool $failOnEmptyTestSuite, bool $failOnIncomplete, bool $failOnNotice, bool $failOnRisky, bool $failOnSkipped, bool $failOnWarning, bool $stopOnDefect, bool $stopOnDeprecation, bool $stopOnError, bool $stopOnFailure, bool $stopOnIncomplete, bool $stopOnNotice, bool $stopOnRisky, bool $stopOnSkipped, bool $stopOnWarning, bool $outputToStandardErrorStream, int|string $columns, bool $noExtensions, ?string $pharExtensionDirectory, array $extensionBootstrappers, bool $backupGlobals, bool $backupStaticProperties, bool $beStrictAboutChangesToGlobalState, bool $colors, bool $processIsolation, bool $enforceTimeLimit, int $defaultTimeLimit, int $timeoutForSmallTests, int $timeoutForMediumTests, int $timeoutForLargeTests, bool $reportUselessTests, bool $strictCoverage, bool $disallowTestOutput, bool $displayDetailsOnIncompleteTests, bool $displayDetailsOnSkippedTests, bool $displayDetailsOnTestsThatTriggerDeprecations, bool $displayDetailsOnTestsThatTriggerErrors, bool $displayDetailsOnTestsThatTriggerNotices, bool $displayDetailsOnTestsThatTriggerWarnings, bool $reverseDefectList, bool $requireCoverageMetadata, bool $registerMockObjectsFromTestArgumentsRecursively, bool $noProgress, bool $noResults, bool $noOutput, int $executionOrder, int $executionOrderDefects, bool $resolveDependencies, ?string $logfileTeamcity, ?string $logfileJunit, ?string $logfileTestdoxHtml, ?string $logfileTestdoxText, ?string $logEventsText, ?string $logEventsVerboseText, bool $teamCityOutput, bool $testDoxOutput, ?array $testsCovering, ?array $testsUsing, ?string $filter, ?array $groups, ?array $excludeGroups, int $randomOrderSeed, bool $includeUncoveredFiles, TestSuiteCollection $testSuite, string $includeTestSuite, string $excludeTestSuite, ?string $defaultTestSuite, array $testSuffixes, Php $php, bool $controlGarbageCollector, int $numberOfTestsBeforeGarbageCollection, ?string $generateBaseline, bool $debug)
150151
{
151152
$this->cliArguments = $cliArguments;
152153
$this->configurationFile = $configurationFile;
@@ -178,6 +179,7 @@ public function __construct(array $cliArguments, ?string $configurationFile, ?st
178179
$this->ignoreDeprecatedCodeUnitsFromCodeCoverage = $ignoreDeprecatedCodeUnitsFromCodeCoverage;
179180
$this->disableCodeCoverageIgnore = $disableCodeCoverageIgnore;
180181
$this->failOnDeprecation = $failOnDeprecation;
182+
$this->failOnPhpunitDeprecation = $failOnPhpunitDeprecation;
181183
$this->failOnEmptyTestSuite = $failOnEmptyTestSuite;
182184
$this->failOnIncomplete = $failOnIncomplete;
183185
$this->failOnNotice = $failOnNotice;
@@ -695,6 +697,11 @@ public function failOnDeprecation(): bool
695697
return $this->failOnDeprecation;
696698
}
697699

700+
public function failOnPhpunitDeprecation(): bool
701+
{
702+
return $this->failOnPhpunitDeprecation;
703+
}
704+
698705
public function failOnEmptyTestSuite(): bool
699706
{
700707
return $this->failOnEmptyTestSuite;

‎src/TextUI/Configuration/Merger.php‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,12 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC
119119
$failOnDeprecation = $xmlConfiguration->phpunit()->failOnDeprecation();
120120
}
121121

122+
if ($cliConfiguration->hasFailOnPhpunitDeprecation()) {
123+
$failOnPhpunitDeprecation = $cliConfiguration->failOnPhpunitDeprecation();
124+
} else {
125+
$failOnPhpunitDeprecation = $xmlConfiguration->phpunit()->failOnPhpunitDeprecation();
126+
}
127+
122128
if ($cliConfiguration->hasFailOnEmptyTestSuite()) {
123129
$failOnEmptyTestSuite = $cliConfiguration->failOnEmptyTestSuite();
124130
} else {
@@ -775,6 +781,7 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC
775781
$xmlConfiguration->codeCoverage()->ignoreDeprecatedCodeUnits(),
776782
$disableCodeCoverageIgnore,
777783
$failOnDeprecation,
784+
$failOnPhpunitDeprecation,
778785
$failOnEmptyTestSuite,
779786
$failOnIncomplete,
780787
$failOnNotice,

‎src/TextUI/Configuration/Xml/DefaultConfiguration.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ public static function create(): self
129129
false,
130130
false,
131131
false,
132+
false,
132133
null,
133134
false,
134135
false,

‎src/TextUI/Configuration/Xml/Generator.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ final class Generator
3131
requireCoverageMetadata="true"
3232
beStrictAboutCoverageMetadata="true"
3333
beStrictAboutOutputDuringTests="true"
34+
failOnPhpunitDeprecation="true"
3435
failOnRisky="true"
3536
failOnWarning="true">
3637
<testsuites>

0 commit comments

Comments
 (0)