Skip to content

Commit b8cf243

Browse files
sebastianbergmannsebastianbergmann
committed
Deprecate functionality removed in 6fa53c3 
1 parent dd0bef1 commit b8cf243

11 files changed

+181
-15
lines changed

‎.psalm/baseline.xml

+124
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,42 @@
3030
<code>$message</code>
3131
<code>$message</code>
3232
</ArgumentTypeCoercion>
33+
<DeprecatedClass>
34+
<code><![CDATA[Exporter::export($constructorArguments, $this->exportObjects)]]></code>
35+
<code><![CDATA[Exporter::export($value, $this->exportObjects)]]></code>
36+
<code><![CDATA[Exporter::export($value, $this->exportObjects)]]></code>
37+
<code><![CDATA[new Test\AssertionFailed(
38+
$this->telemetryInfo(),
39+
Exporter::export($value, $this->exportObjects),
40+
$constraint->toString($this->exportObjects),
41+
$constraint->count(),
42+
$message,
43+
)]]></code>
44+
<code><![CDATA[new Test\AssertionSucceeded(
45+
$this->telemetryInfo(),
46+
Exporter::export($value, $this->exportObjects),
47+
$constraint->toString($this->exportObjects),
48+
$constraint->count(),
49+
$message,
50+
)]]></code>
51+
</DeprecatedClass>
3352
<TooManyArguments>
3453
<code>toString</code>
3554
<code>toString</code>
3655
<code>toString</code>
3756
<code>toString</code>
3857
</TooManyArguments>
3958
</file>
59+
<file src="src/Event/Events/Test/Assertion/AssertionFailedSubscriber.php">
60+
<DeprecatedClass>
61+
<code>AssertionFailed</code>
62+
</DeprecatedClass>
63+
</file>
64+
<file src="src/Event/Events/Test/Assertion/AssertionSucceededSubscriber.php">
65+
<DeprecatedClass>
66+
<code>AssertionSucceeded</code>
67+
</DeprecatedClass>
68+
</file>
4069
<file src="src/Event/Events/Test/HookMethod/AfterLastTestMethodFinished.php">
4170
<PropertyTypeCoercion>
4271
<code>$calledMethods</code>
@@ -86,6 +115,13 @@
86115
<ArgumentTypeCoercion>
87116
<code><![CDATA[$eventClass . 'Subscriber']]></code>
88117
</ArgumentTypeCoercion>
118+
<DeprecatedClass>
119+
<code>Test\AssertionFailed::class</code>
120+
<code>Test\AssertionSucceeded::class</code>
121+
</DeprecatedClass>
122+
<DeprecatedMethod>
123+
<code>exportObjects</code>
124+
</DeprecatedMethod>
89125
<InvalidArrayOffset>
90126
<code><![CDATA[gc_status()['running']]]></code>
91127
</InvalidArrayOffset>
@@ -138,6 +174,16 @@
138174
<code>hasDataFromDataProvider</code>
139175
</ImpureMethodCall>
140176
</file>
177+
<file src="src/Event/Value/Test/TestMethodBuilder.php">
178+
<DeprecatedClass>
179+
<code><![CDATA[Exporter::export($testCase->dependencyInput(), EventFacade::emitter()->exportsObjects())]]></code>
180+
<code><![CDATA[Exporter::export($testCase->providedData(), EventFacade::emitter()->exportsObjects())]]></code>
181+
</DeprecatedClass>
182+
<DeprecatedMethod>
183+
<code>exportsObjects</code>
184+
<code>exportsObjects</code>
185+
</DeprecatedMethod>
186+
</file>
141187
<file src="src/Event/Value/TestSuite/TestSuiteBuilder.php">
142188
<ArgumentTypeCoercion>
143189
<code>$className</code>
@@ -147,6 +193,12 @@
147193
<code><![CDATA[$testSuite->name()]]></code>
148194
</ArgumentTypeCoercion>
149195
</file>
196+
<file src="src/Framework/Assert.php">
197+
<DeprecatedMethod>
198+
<code>testAssertionFailed</code>
199+
<code>testAssertionSucceeded</code>
200+
</DeprecatedMethod>
201+
</file>
150202
<file src="src/Framework/Assert/Functions.php">
151203
<DeprecatedMethod>
152204
<code>Assert::assertStringNotMatchesFormat(...func_get_args())</code>
@@ -183,21 +235,76 @@
183235
<code><![CDATA[$e->getCode()]]></code>
184236
</PossiblyInvalidArgument>
185237
</file>
238+
<file src="src/Framework/Constraint/Cardinality/GreaterThan.php">
239+
<DeprecatedClass>
240+
<code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
241+
</DeprecatedClass>
242+
</file>
186243
<file src="src/Framework/Constraint/Cardinality/IsEmpty.php">
187244
<TooManyArguments>
188245
<code>toString</code>
189246
</TooManyArguments>
190247
</file>
248+
<file src="src/Framework/Constraint/Cardinality/LessThan.php">
249+
<DeprecatedClass>
250+
<code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
251+
</DeprecatedClass>
252+
</file>
191253
<file src="src/Framework/Constraint/Constraint.php">
254+
<DeprecatedClass>
255+
<code>Exporter::export($other, true)</code>
256+
<code>Exporter::export($other, true)</code>
257+
</DeprecatedClass>
192258
<TooManyArguments>
193259
<code>toString</code>
194260
<code>toString</code>
195261
</TooManyArguments>
196262
</file>
263+
<file src="src/Framework/Constraint/Equality/IsEqual.php">
264+
<DeprecatedClass>
265+
<code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
266+
</DeprecatedClass>
267+
</file>
268+
<file src="src/Framework/Constraint/Equality/IsEqualCanonicalizing.php">
269+
<DeprecatedClass>
270+
<code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
271+
</DeprecatedClass>
272+
</file>
273+
<file src="src/Framework/Constraint/Equality/IsEqualIgnoringCase.php">
274+
<DeprecatedClass>
275+
<code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
276+
</DeprecatedClass>
277+
</file>
278+
<file src="src/Framework/Constraint/Equality/IsEqualWithDelta.php">
279+
<DeprecatedClass>
280+
<code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
281+
</DeprecatedClass>
282+
</file>
283+
<file src="src/Framework/Constraint/Exception/ExceptionCode.php">
284+
<DeprecatedClass>
285+
<code>Exporter::export($other, true)</code>
286+
<code><![CDATA[Exporter::export($this->expectedCode, true)]]></code>
287+
</DeprecatedClass>
288+
</file>
289+
<file src="src/Framework/Constraint/Exception/ExceptionMessageIsOrContains.php">
290+
<DeprecatedClass>
291+
<code><![CDATA[Exporter::export($this->expectedMessage)]]></code>
292+
</DeprecatedClass>
293+
</file>
197294
<file src="src/Framework/Constraint/Exception/ExceptionMessageMatchesRegularExpression.php">
198295
<ArgumentTypeCoercion>
199296
<code><![CDATA[$this->regularExpression]]></code>
200297
</ArgumentTypeCoercion>
298+
<DeprecatedClass>
299+
<code><![CDATA[Exporter::export($this->regularExpression)]]></code>
300+
</DeprecatedClass>
301+
</file>
302+
<file src="src/Framework/Constraint/IsIdentical.php">
303+
<DeprecatedClass>
304+
<code>Exporter::export($other, true)</code>
305+
<code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
306+
<code><![CDATA[Exporter::export($this->value, true)]]></code>
307+
</DeprecatedClass>
201308
</file>
202309
<file src="src/Framework/Constraint/Object/ObjectEquals.php">
203310
<MissingThrowsDocblock>
@@ -235,6 +342,9 @@
235342
</ArgumentTypeCoercion>
236343
</file>
237344
<file src="src/Framework/Constraint/String/StringContains.php">
345+
<DeprecatedClass>
346+
<code>Exporter::export($other, true)</code>
347+
</DeprecatedClass>
238348
<TooManyArguments>
239349
<code>toString</code>
240350
</TooManyArguments>
@@ -248,6 +358,9 @@
248358
</ArgumentTypeCoercion>
249359
</file>
250360
<file src="src/Framework/Constraint/Traversable/ArrayHasKey.php">
361+
<DeprecatedClass>
362+
<code><![CDATA[Exporter::export($this->key)]]></code>
363+
</DeprecatedClass>
251364
<TooManyArguments>
252365
<code>toString</code>
253366
</TooManyArguments>
@@ -257,6 +370,11 @@
257370
<code>toString</code>
258371
</TooManyArguments>
259372
</file>
373+
<file src="src/Framework/Constraint/Traversable/TraversableContains.php">
374+
<DeprecatedClass>
375+
<code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
376+
</DeprecatedClass>
377+
</file>
260378
<file src="src/Framework/Constraint/Traversable/TraversableContainsOnly.php">
261379
<ArgumentTypeCoercion>
262380
<code>$type</code>
@@ -428,6 +546,7 @@
428546
<code><![CDATA[$test->output()]]></code>
429547
</ArgumentTypeCoercion>
430548
<DeprecatedMethod>
549+
<code>exportsObjects</code>
431550
<code>registerMockObjectsFromTestArgumentsRecursively</code>
432551
<code>registerMockObjectsFromTestArgumentsRecursively</code>
433552
</DeprecatedMethod>
@@ -751,6 +870,11 @@
751870
<ArgumentTypeCoercion>
752871
<code><![CDATA[$configuration->generateBaseline()]]></code>
753872
</ArgumentTypeCoercion>
873+
<DeprecatedMethod>
874+
<code>exportObjects</code>
875+
<code>exportObjects</code>
876+
<code>requiresExportOfObjects</code>
877+
</DeprecatedMethod>
754878
<InternalMethod>
755879
<code>nameAndVersion</code>
756880
</InternalMethod>

‎ChangeLog-10.5.md

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ All notable changes of the PHPUnit 10.5 release series are documented in this fi
66

77
### Deprecated
88

9+
* `Test\AssertionFailed` and `Test\AssertionSucceeded` events
10+
* `PHPUnit\Runner\Extension\Facade::requireExportOfObjects()` and `PHPUnit\Runner\Extension\Facade::requiresExportOfObjects()`
911
* `registerMockObjectsFromTestArgumentsRecursively` attribute on the `<phpunit>` element of the XML configuration file
1012
* `PHPUnit\TextUI\Configuration\Configuration::registerMockObjectsFromTestArgumentsRecursively()`
1113

‎DEPRECATIONS.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -60,21 +60,23 @@ This functionality is currently [soft-deprecated](https://phpunit.de/backward-co
6060

6161
### Extending PHPUnit
6262

63-
| Issue | Description | Since | Replacement |
64-
|-------|--------------------------------------------------------------------------------------------------------|--------|--------------------------------------------------------------------------------|
65-
| | `PHPUnit\TextUI\Configuration\Configuration::coverageExcludeDirectories()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->excludeDirectories()` |
66-
| | `PHPUnit\TextUI\Configuration\Configuration::coverageExcludeFiles()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->excludeFiles()` |
67-
| | `PHPUnit\TextUI\Configuration\Configuration::coverageIncludeDirectories()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->includeDirectories()` |
68-
| | `PHPUnit\TextUI\Configuration\Configuration::coverageIncludeFiles()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->includeFiles()` |
69-
| | `PHPUnit\TextUI\Configuration\Configuration::loadPharExtensions()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::noExtensions()` |
70-
| | `PHPUnit\TextUI\Configuration\Configuration::hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->notEmpty()` |
71-
| | `PHPUnit\TextUI\Configuration\Configuration::restrictDeprecations()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictDeprecations()` |
72-
| | `PHPUnit\TextUI\Configuration\Configuration::restrictNotices()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictNotices()` |
73-
| | `PHPUnit\TextUI\Configuration\Configuration::restrictWarnings()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictWarnings()` |
74-
| | `PHPUnit\TextUI\Configuration\Configuration::cliArgument()` | 10.4.0 | `PHPUnit\TextUI\Configuration\Configuration::cliArguments()[0]` |
75-
| | `PHPUnit\TextUI\Configuration\Configuration::hasCliArgument()` | 10.4.0 | `PHPUnit\TextUI\Configuration\Configuration::hasCliArguments()` |
76-
| | `PHPUnit\Framework\Constraint\Constraint::exporter()` | 10.4.0 | |
77-
| | `PHPUnit\TextUI\Configuration\Configuration::registerMockObjectsFromTestArgumentsRecursively()` | 10.5.3 | |
63+
| Issue | Description | Since | Replacement |
64+
|-------|------------------------------------------------------------------------------------------------------------------------------|--------|--------------------------------------------------------------------------------|
65+
| | `PHPUnit\TextUI\Configuration\Configuration::coverageExcludeDirectories()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->excludeDirectories()` |
66+
| | `PHPUnit\TextUI\Configuration\Configuration::coverageExcludeFiles()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->excludeFiles()` |
67+
| | `PHPUnit\TextUI\Configuration\Configuration::coverageIncludeDirectories()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->includeDirectories()` |
68+
| | `PHPUnit\TextUI\Configuration\Configuration::coverageIncludeFiles()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->includeFiles()` |
69+
| | `PHPUnit\TextUI\Configuration\Configuration::loadPharExtensions()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::noExtensions()` |
70+
| | `PHPUnit\TextUI\Configuration\Configuration::hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->notEmpty()` |
71+
| | `PHPUnit\TextUI\Configuration\Configuration::restrictDeprecations()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictDeprecations()` |
72+
| | `PHPUnit\TextUI\Configuration\Configuration::restrictNotices()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictNotices()` |
73+
| | `PHPUnit\TextUI\Configuration\Configuration::restrictWarnings()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictWarnings()` |
74+
| | `PHPUnit\TextUI\Configuration\Configuration::cliArgument()` | 10.4.0 | `PHPUnit\TextUI\Configuration\Configuration::cliArguments()[0]` |
75+
| | `PHPUnit\TextUI\Configuration\Configuration::hasCliArgument()` | 10.4.0 | `PHPUnit\TextUI\Configuration\Configuration::hasCliArguments()` |
76+
| | `PHPUnit\Framework\Constraint\Constraint::exporter()` | 10.4.0 | |
77+
| | `PHPUnit\TextUI\Configuration\Configuration::registerMockObjectsFromTestArgumentsRecursively()` | 10.5.3 | |
78+
| | `Test\AssertionFailed` and `Test\AssertionSucceeded` events | 10.5.3 | |
79+
| | `PHPUnit\Runner\Extension\Facade::requireExportOfObjects()` and `PHPUnit\Runner\Extension\Facade::requiresExportOfObjects()` | 10.5.3 | |
7880

7981
## Hard Deprecations
8082

‎src/Event/Emitter/DispatchingEmitter.php

+10
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,17 @@ public function __construct(Dispatcher $dispatcher, Telemetry\System $system)
4545
$this->previousSnapshot = $system->snapshot();
4646
}
4747

48+
/**
49+
* @deprecated
50+
*/
4851
public function exportObjects(): void
4952
{
5053
$this->exportObjects = true;
5154
}
5255

56+
/**
57+
* @deprecated
58+
*/
5359
public function exportsObjects(): bool
5460
{
5561
return $this->exportObjects;
@@ -477,6 +483,8 @@ public function testRegisteredComparator(string $className): void
477483
/**
478484
* @throws InvalidArgumentException
479485
* @throws UnknownEventTypeException
486+
*
487+
* @deprecated
480488
*/
481489
public function testAssertionSucceeded(mixed $value, Constraint\Constraint $constraint, string $message): void
482490
{
@@ -494,6 +502,8 @@ public function testAssertionSucceeded(mixed $value, Constraint\Constraint $cons
494502
/**
495503
* @throws InvalidArgumentException
496504
* @throws UnknownEventTypeException
505+
*
506+
* @deprecated
497507
*/
498508
public function testAssertionFailed(mixed $value, Constraint\Constraint $constraint, string $message): void
499509
{

‎src/Event/Emitter/Emitter.php

+12
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,14 @@
2121
*/
2222
interface Emitter
2323
{
24+
/**
25+
* @deprecated
26+
*/
2427
public function exportObjects(): void;
2528

29+
/**
30+
* @deprecated
31+
*/
2632
public function exportsObjects(): bool;
2733

2834
public function applicationStarted(): void;
@@ -109,8 +115,14 @@ public function testPrepared(Code\Test $test): void;
109115
*/
110116
public function testRegisteredComparator(string $className): void;
111117

118+
/**
119+
* @deprecated
120+
*/
112121
public function testAssertionSucceeded(mixed $value, Constraint\Constraint $constraint, string $message): void;
113122

123+
/**
124+
* @deprecated
125+
*/
114126
public function testAssertionFailed(mixed $value, Constraint\Constraint $constraint, string $message): void;
115127

116128
/**

‎src/Event/Events/Test/Assertion/AssertionFailed.php

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515

1616
/**
1717
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
18+
*
19+
* @deprecated
1820
*/
1921
final class AssertionFailed implements Event
2022
{

‎src/Event/Events/Test/Assertion/AssertionFailedSubscriber.php

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
/**
1515
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
16+
*
17+
* @deprecated
1618
*/
1719
interface AssertionFailedSubscriber extends Subscriber
1820
{

‎src/Event/Events/Test/Assertion/AssertionSucceeded.php

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515

1616
/**
1717
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
18+
*
19+
* @deprecated
1820
*/
1921
final class AssertionSucceeded implements Event
2022
{

‎src/Event/Events/Test/Assertion/AssertionSucceededSubscriber.php

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
/**
1515
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
16+
*
17+
* @deprecated
1618
*/
1719
interface AssertionSucceededSubscriber extends Subscriber
1820
{

‎src/Runner/Extension/Facade.php

+6
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,17 @@ public function requiresCodeCoverageCollection(): bool
9292
return $this->requiresCodeCoverageCollection;
9393
}
9494

95+
/**
96+
* @deprecated
97+
*/
9598
public function requireExportOfObjects(): void
9699
{
97100
$this->requiresExportOfObjects = true;
98101
}
99102

103+
/**
104+
* @deprecated
105+
*/
100106
public function requiresExportOfObjects(): bool
101107
{
102108
return $this->requiresExportOfObjects;

‎src/Util/Exporter.php

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515

1616
/**
1717
* @internal This class is not covered by the backward compatibility promise for PHPUnit
18+
*
19+
* @deprecated
1820
*/
1921
final class Exporter
2022
{

0 commit comments

Comments
 (0)