Deprecate functionality removed in 6fa53c3

sebastianbergmann · Dec 12, 2023 · b8cf243 · b8cf243
1 parent dd0bef1
commit b8cf243
Show file tree

Hide file tree

Showing 11 changed files with 181 additions and 15 deletions.
diff --git a/.psalm/baseline.xml b/.psalm/baseline.xml
@@ -30,13 +30,42 @@
       <code>$message</code>
       <code>$message</code>
     </ArgumentTypeCoercion>
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($constructorArguments, $this->exportObjects)]]></code>
+      <code><![CDATA[Exporter::export($value, $this->exportObjects)]]></code>
+      <code><![CDATA[Exporter::export($value, $this->exportObjects)]]></code>
+      <code><![CDATA[new Test\AssertionFailed(
+                $this->telemetryInfo(),
+                Exporter::export($value, $this->exportObjects),
+                $constraint->toString($this->exportObjects),
+                $constraint->count(),
+                $message,
+            )]]></code>
+      <code><![CDATA[new Test\AssertionSucceeded(
+                $this->telemetryInfo(),
+                Exporter::export($value, $this->exportObjects),
+                $constraint->toString($this->exportObjects),
+                $constraint->count(),
+                $message,
+            )]]></code>
+    </DeprecatedClass>
     <TooManyArguments>
       <code>toString</code>
       <code>toString</code>
       <code>toString</code>
       <code>toString</code>
     </TooManyArguments>
   </file>
+  <file src="src/Event/Events/Test/Assertion/AssertionFailedSubscriber.php">
+    <DeprecatedClass>
+      <code>AssertionFailed</code>
+    </DeprecatedClass>
+  </file>
+  <file src="src/Event/Events/Test/Assertion/AssertionSucceededSubscriber.php">
+    <DeprecatedClass>
+      <code>AssertionSucceeded</code>
+    </DeprecatedClass>
+  </file>
   <file src="src/Event/Events/Test/HookMethod/AfterLastTestMethodFinished.php">
     <PropertyTypeCoercion>
       <code>$calledMethods</code>
@@ -86,6 +115,13 @@
     <ArgumentTypeCoercion>
       <code><![CDATA[$eventClass . 'Subscriber']]></code>
     </ArgumentTypeCoercion>
+    <DeprecatedClass>
+      <code>Test\AssertionFailed::class</code>
+      <code>Test\AssertionSucceeded::class</code>
+    </DeprecatedClass>
+    <DeprecatedMethod>
+      <code>exportObjects</code>
+    </DeprecatedMethod>
     <InvalidArrayOffset>
       <code><![CDATA[gc_status()['running']]]></code>
     </InvalidArrayOffset>
@@ -138,6 +174,16 @@
       <code>hasDataFromDataProvider</code>
     </ImpureMethodCall>
   </file>
+  <file src="src/Event/Value/Test/TestMethodBuilder.php">
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($testCase->dependencyInput(), EventFacade::emitter()->exportsObjects())]]></code>
+      <code><![CDATA[Exporter::export($testCase->providedData(), EventFacade::emitter()->exportsObjects())]]></code>
+    </DeprecatedClass>
+    <DeprecatedMethod>
+      <code>exportsObjects</code>
+      <code>exportsObjects</code>
+    </DeprecatedMethod>
+  </file>
   <file src="src/Event/Value/TestSuite/TestSuiteBuilder.php">
     <ArgumentTypeCoercion>
       <code>$className</code>
@@ -147,6 +193,12 @@
       <code><![CDATA[$testSuite->name()]]></code>
     </ArgumentTypeCoercion>
   </file>
+  <file src="src/Framework/Assert.php">
+    <DeprecatedMethod>
+      <code>testAssertionFailed</code>
+      <code>testAssertionSucceeded</code>
+    </DeprecatedMethod>
+  </file>
   <file src="src/Framework/Assert/Functions.php">
     <DeprecatedMethod>
       <code>Assert::assertStringNotMatchesFormat(...func_get_args())</code>
@@ -183,21 +235,76 @@
       <code><![CDATA[$e->getCode()]]></code>
     </PossiblyInvalidArgument>
   </file>
+  <file src="src/Framework/Constraint/Cardinality/GreaterThan.php">
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
+    </DeprecatedClass>
+  </file>
   <file src="src/Framework/Constraint/Cardinality/IsEmpty.php">
     <TooManyArguments>
       <code>toString</code>
     </TooManyArguments>
   </file>
+  <file src="src/Framework/Constraint/Cardinality/LessThan.php">
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
+    </DeprecatedClass>
+  </file>
   <file src="src/Framework/Constraint/Constraint.php">
+    <DeprecatedClass>
+      <code>Exporter::export($other, true)</code>
+      <code>Exporter::export($other, true)</code>
+    </DeprecatedClass>
     <TooManyArguments>
       <code>toString</code>
       <code>toString</code>
     </TooManyArguments>
   </file>
+  <file src="src/Framework/Constraint/Equality/IsEqual.php">
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
+    </DeprecatedClass>
+  </file>
+  <file src="src/Framework/Constraint/Equality/IsEqualCanonicalizing.php">
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
+    </DeprecatedClass>
+  </file>
+  <file src="src/Framework/Constraint/Equality/IsEqualIgnoringCase.php">
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
+    </DeprecatedClass>
+  </file>
+  <file src="src/Framework/Constraint/Equality/IsEqualWithDelta.php">
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
+    </DeprecatedClass>
+  </file>
+  <file src="src/Framework/Constraint/Exception/ExceptionCode.php">
+    <DeprecatedClass>
+      <code>Exporter::export($other, true)</code>
+      <code><![CDATA[Exporter::export($this->expectedCode, true)]]></code>
+    </DeprecatedClass>
+  </file>
+  <file src="src/Framework/Constraint/Exception/ExceptionMessageIsOrContains.php">
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($this->expectedMessage)]]></code>
+    </DeprecatedClass>
+  </file>
   <file src="src/Framework/Constraint/Exception/ExceptionMessageMatchesRegularExpression.php">
     <ArgumentTypeCoercion>
       <code><![CDATA[$this->regularExpression]]></code>
     </ArgumentTypeCoercion>
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($this->regularExpression)]]></code>
+    </DeprecatedClass>
+  </file>
+  <file src="src/Framework/Constraint/IsIdentical.php">
+    <DeprecatedClass>
+      <code>Exporter::export($other, true)</code>
+      <code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
+      <code><![CDATA[Exporter::export($this->value, true)]]></code>
+    </DeprecatedClass>
   </file>
   <file src="src/Framework/Constraint/Object/ObjectEquals.php">
     <MissingThrowsDocblock>
@@ -235,6 +342,9 @@
     </ArgumentTypeCoercion>
   </file>
   <file src="src/Framework/Constraint/String/StringContains.php">
+    <DeprecatedClass>
+      <code>Exporter::export($other, true)</code>
+    </DeprecatedClass>
     <TooManyArguments>
       <code>toString</code>
     </TooManyArguments>
@@ -248,6 +358,9 @@
     </ArgumentTypeCoercion>
   </file>
   <file src="src/Framework/Constraint/Traversable/ArrayHasKey.php">
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($this->key)]]></code>
+    </DeprecatedClass>
     <TooManyArguments>
       <code>toString</code>
     </TooManyArguments>
@@ -257,6 +370,11 @@
       <code>toString</code>
     </TooManyArguments>
   </file>
+  <file src="src/Framework/Constraint/Traversable/TraversableContains.php">
+    <DeprecatedClass>
+      <code><![CDATA[Exporter::export($this->value, $exportObjects)]]></code>
+    </DeprecatedClass>
+  </file>
   <file src="src/Framework/Constraint/Traversable/TraversableContainsOnly.php">
     <ArgumentTypeCoercion>
       <code>$type</code>
@@ -428,6 +546,7 @@
       <code><![CDATA[$test->output()]]></code>
     </ArgumentTypeCoercion>
     <DeprecatedMethod>
+      <code>exportsObjects</code>
       <code>registerMockObjectsFromTestArgumentsRecursively</code>
       <code>registerMockObjectsFromTestArgumentsRecursively</code>
     </DeprecatedMethod>
@@ -751,6 +870,11 @@
     <ArgumentTypeCoercion>
       <code><![CDATA[$configuration->generateBaseline()]]></code>
     </ArgumentTypeCoercion>
+    <DeprecatedMethod>
+      <code>exportObjects</code>
+      <code>exportObjects</code>
+      <code>requiresExportOfObjects</code>
+    </DeprecatedMethod>
     <InternalMethod>
       <code>nameAndVersion</code>
     </InternalMethod>

diff --git a/ChangeLog-10.5.md b/ChangeLog-10.5.md
@@ -6,6 +6,8 @@ All notable changes of the PHPUnit 10.5 release series are documented in this fi
 
 ### Deprecated
 
+* `Test\AssertionFailed` and `Test\AssertionSucceeded` events
+* `PHPUnit\Runner\Extension\Facade::requireExportOfObjects()` and `PHPUnit\Runner\Extension\Facade::requiresExportOfObjects()`
 * `registerMockObjectsFromTestArgumentsRecursively` attribute on the `<phpunit>` element of the XML configuration file
 * `PHPUnit\TextUI\Configuration\Configuration::registerMockObjectsFromTestArgumentsRecursively()`
 

diff --git a/DEPRECATIONS.md b/DEPRECATIONS.md
@@ -60,21 +60,23 @@ This functionality is currently [soft-deprecated](https://phpunit.de/backward-co
 
 ### Extending PHPUnit
 
-| Issue | Description                                                                                            | Since  | Replacement                                                                    |
-|-------|--------------------------------------------------------------------------------------------------------|--------|--------------------------------------------------------------------------------|
-|       | `PHPUnit\TextUI\Configuration\Configuration::coverageExcludeDirectories()`                             | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->excludeDirectories()`   |
-|       | `PHPUnit\TextUI\Configuration\Configuration::coverageExcludeFiles()`                                   | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->excludeFiles()`         |
-|       | `PHPUnit\TextUI\Configuration\Configuration::coverageIncludeDirectories()`                             | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->includeDirectories()`   |
-|       | `PHPUnit\TextUI\Configuration\Configuration::coverageIncludeFiles()`                                   | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->includeFiles()`         |
-|       | `PHPUnit\TextUI\Configuration\Configuration::loadPharExtensions()`                                     | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::noExtensions()`                   |
-|       | `PHPUnit\TextUI\Configuration\Configuration::hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport()` | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->notEmpty()`             |
-|       | `PHPUnit\TextUI\Configuration\Configuration::restrictDeprecations()`                                   | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictDeprecations()` |
-|       | `PHPUnit\TextUI\Configuration\Configuration::restrictNotices()`                                        | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictNotices()`      |
-|       | `PHPUnit\TextUI\Configuration\Configuration::restrictWarnings()`                                       | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictWarnings()`     |
-|       | `PHPUnit\TextUI\Configuration\Configuration::cliArgument()`                                            | 10.4.0 | `PHPUnit\TextUI\Configuration\Configuration::cliArguments()[0]`                |
-|       | `PHPUnit\TextUI\Configuration\Configuration::hasCliArgument()`                                         | 10.4.0 | `PHPUnit\TextUI\Configuration\Configuration::hasCliArguments()`                |
-|       | `PHPUnit\Framework\Constraint\Constraint::exporter()`                                                  | 10.4.0 |                                                                                |
-|       | `PHPUnit\TextUI\Configuration\Configuration::registerMockObjectsFromTestArgumentsRecursively()`        | 10.5.3 |                                                                                |
+| Issue | Description                                                                                                                  | Since  | Replacement                                                                    |
+|-------|------------------------------------------------------------------------------------------------------------------------------|--------|--------------------------------------------------------------------------------|
+|       | `PHPUnit\TextUI\Configuration\Configuration::coverageExcludeDirectories()`                                                   | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->excludeDirectories()`   |
+|       | `PHPUnit\TextUI\Configuration\Configuration::coverageExcludeFiles()`                                                         | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->excludeFiles()`         |
+|       | `PHPUnit\TextUI\Configuration\Configuration::coverageIncludeDirectories()`                                                   | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->includeDirectories()`   |
+|       | `PHPUnit\TextUI\Configuration\Configuration::coverageIncludeFiles()`                                                         | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->includeFiles()`         |
+|       | `PHPUnit\TextUI\Configuration\Configuration::loadPharExtensions()`                                                           | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::noExtensions()`                   |
+|       | `PHPUnit\TextUI\Configuration\Configuration::hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport()`                       | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->notEmpty()`             |
+|       | `PHPUnit\TextUI\Configuration\Configuration::restrictDeprecations()`                                                         | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictDeprecations()` |
+|       | `PHPUnit\TextUI\Configuration\Configuration::restrictNotices()`                                                              | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictNotices()`      |
+|       | `PHPUnit\TextUI\Configuration\Configuration::restrictWarnings()`                                                             | 10.2.0 | `PHPUnit\TextUI\Configuration\Configuration::source()->restrictWarnings()`     |
+|       | `PHPUnit\TextUI\Configuration\Configuration::cliArgument()`                                                                  | 10.4.0 | `PHPUnit\TextUI\Configuration\Configuration::cliArguments()[0]`                |
+|       | `PHPUnit\TextUI\Configuration\Configuration::hasCliArgument()`                                                               | 10.4.0 | `PHPUnit\TextUI\Configuration\Configuration::hasCliArguments()`                |
+|       | `PHPUnit\Framework\Constraint\Constraint::exporter()`                                                                        | 10.4.0 |                                                                                |
+|       | `PHPUnit\TextUI\Configuration\Configuration::registerMockObjectsFromTestArgumentsRecursively()`                              | 10.5.3 |                                                                                |
+|       | `Test\AssertionFailed` and `Test\AssertionSucceeded` events                                                                  | 10.5.3 |                                                                                |
+|       | `PHPUnit\Runner\Extension\Facade::requireExportOfObjects()` and `PHPUnit\Runner\Extension\Facade::requiresExportOfObjects()` | 10.5.3 |                                                                                |
 
 ## Hard Deprecations
 

diff --git a/src/Event/Emitter/DispatchingEmitter.php b/src/Event/Emitter/DispatchingEmitter.php
@@ -45,11 +45,17 @@ public function __construct(Dispatcher $dispatcher, Telemetry\System $system)
         $this->previousSnapshot = $system->snapshot();
     }
 
+    /**
+     * @deprecated
+     */
     public function exportObjects(): void
     {
         $this->exportObjects = true;
     }
 
+    /**
+     * @deprecated
+     */
     public function exportsObjects(): bool
     {
         return $this->exportObjects;
@@ -477,6 +483,8 @@ public function testRegisteredComparator(string $className): void
     /**
      * @throws InvalidArgumentException
      * @throws UnknownEventTypeException
+     *
+     * @deprecated
      */
     public function testAssertionSucceeded(mixed $value, Constraint\Constraint $constraint, string $message): void
     {
@@ -494,6 +502,8 @@ public function testAssertionSucceeded(mixed $value, Constraint\Constraint $cons
     /**
      * @throws InvalidArgumentException
      * @throws UnknownEventTypeException
+     *
+     * @deprecated
      */
     public function testAssertionFailed(mixed $value, Constraint\Constraint $constraint, string $message): void
     {

diff --git a/src/Event/Emitter/Emitter.php b/src/Event/Emitter/Emitter.php
@@ -21,8 +21,14 @@
  */
 interface Emitter
 {
+    /**
+     * @deprecated
+     */
     public function exportObjects(): void;
 
+    /**
+     * @deprecated
+     */
     public function exportsObjects(): bool;
 
     public function applicationStarted(): void;
@@ -109,8 +115,14 @@ public function testPrepared(Code\Test $test): void;
      */
     public function testRegisteredComparator(string $className): void;
 
+    /**
+     * @deprecated
+     */
     public function testAssertionSucceeded(mixed $value, Constraint\Constraint $constraint, string $message): void;
 
+    /**
+     * @deprecated
+     */
     public function testAssertionFailed(mixed $value, Constraint\Constraint $constraint, string $message): void;
 
     /**

diff --git a/src/Event/Events/Test/Assertion/AssertionFailed.php b/src/Event/Events/Test/Assertion/AssertionFailed.php
@@ -15,6 +15,8 @@
 
 /**
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ *
+ * @deprecated
  */
 final class AssertionFailed implements Event
 {

diff --git a/src/Event/Events/Test/Assertion/AssertionFailedSubscriber.php b/src/Event/Events/Test/Assertion/AssertionFailedSubscriber.php
@@ -13,6 +13,8 @@
 
 /**
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ *
+ * @deprecated
  */
 interface AssertionFailedSubscriber extends Subscriber
 {

diff --git a/src/Event/Events/Test/Assertion/AssertionSucceeded.php b/src/Event/Events/Test/Assertion/AssertionSucceeded.php
@@ -15,6 +15,8 @@
 
 /**
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ *
+ * @deprecated
  */
 final class AssertionSucceeded implements Event
 {

diff --git a/src/Event/Events/Test/Assertion/AssertionSucceededSubscriber.php b/src/Event/Events/Test/Assertion/AssertionSucceededSubscriber.php
@@ -13,6 +13,8 @@
 
 /**
  * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ *
+ * @deprecated
  */
 interface AssertionSucceededSubscriber extends Subscriber
 {

diff --git a/src/Runner/Extension/Facade.php b/src/Runner/Extension/Facade.php
@@ -92,11 +92,17 @@ public function requiresCodeCoverageCollection(): bool
         return $this->requiresCodeCoverageCollection;
     }
 
+    /**
+     * @deprecated
+     */
     public function requireExportOfObjects(): void
     {
         $this->requiresExportOfObjects = true;
     }
 
+    /**
+     * @deprecated
+     */
     public function requiresExportOfObjects(): bool
     {
         return $this->requiresExportOfObjects;

diff --git a/src/Util/Exporter.php b/src/Util/Exporter.php
@@ -15,6 +15,8 @@
 
 /**
  * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ *
+ * @deprecated
  */
 final class Exporter
 {