Closes #5183

sebastianbergmann · Feb 8, 2023 · c2fcb8f · c2fcb8f
1 parent a9db916
commit c2fcb8f
Show file tree

Hide file tree

Showing 23 changed files with 40 additions and 31 deletions.
diff --git a/ChangeLog-10.0.md b/ChangeLog-10.0.md
@@ -2,6 +2,16 @@
 
 All notable changes of the PHPUnit 10.0 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles.
 
+## [10.0.7] - 2023-MM-DD
+
+### Changed
+
+* The `PHPUnit\Event\Test\AssertionSucceeded::value()` method is now deprecated and always returns `''`
+
+### Fixed
+
+* [#5183](https://github.com/sebastianbergmann/phpunit/issues/5183): Values used in assertions are exported for `Test\AssertionSucceeded` events
+
 ## [10.0.6] - 2023-02-08
 
 ### Fixed
@@ -173,6 +183,7 @@ All notable changes of the PHPUnit 10.0 release series are documented in this fi
 * PHP 7.3, PHP 7.4, and PHP 8.0 are no longer supported
 * `phpunit/php-code-coverage` [no longer supports PHPDBG and Xdebug 2](https://github.com/sebastianbergmann/php-code-coverage/blob/10.0.0/ChangeLog.md#1000---2023-02-03)
 
+[10.0.7]: https://github.com/sebastianbergmann/phpunit/compare/10.0.6...10.0
 [10.0.6]: https://github.com/sebastianbergmann/phpunit/compare/10.0.5...10.0.6
 [10.0.5]: https://github.com/sebastianbergmann/phpunit/compare/10.0.4...10.0.5
 [10.0.4]: https://github.com/sebastianbergmann/phpunit/compare/10.0.3...10.0.4

diff --git a/src/Event/Emitter/DispatchingEmitter.php b/src/Event/Emitter/DispatchingEmitter.php
@@ -403,7 +403,7 @@ public function testAssertionSucceeded(mixed $value, Constraint\Constraint $cons
         $this->dispatcher->dispatch(
             new Test\AssertionSucceeded(
                 $this->telemetryInfo(),
-                (new Exporter)->export($value),
+                '',
                 $constraint->toString(),
                 $constraint->count(),
                 $message,

diff --git a/src/Event/Events/Test/Assertion/AssertionSucceeded.php b/src/Event/Events/Test/Assertion/AssertionSucceeded.php
@@ -19,15 +19,13 @@
 final class AssertionSucceeded implements Event
 {
     private readonly Telemetry\Info $telemetryInfo;
-    private readonly string $value;
     private readonly string $constraint;
     private readonly int $count;
     private readonly string $message;
 
     public function __construct(Telemetry\Info $telemetryInfo, string $value, string $constraint, int $count, string $message)
     {
         $this->telemetryInfo = $telemetryInfo;
-        $this->value         = $value;
         $this->constraint    = $constraint;
         $this->count         = $count;
         $this->message       = $message;
@@ -38,9 +36,12 @@ public function telemetryInfo(): Telemetry\Info
         return $this->telemetryInfo;
     }
 
+    /**
+     * @deprecated https://github.com/sebastianbergmann/phpunit/issues/5183
+     */
     public function value(): string
     {
-        return $this->value;
+        return '';
     }
 
     public function count(): int
@@ -65,9 +66,8 @@ public function asString(): string
         }
 
         return sprintf(
-            'Assertion Succeeded (Constraint: %s, Value: %s%s)',
+            'Assertion Succeeded (Constraint: %s%s)',
             $this->constraint,
-            $this->value,
             $message
         );
     }

diff --git a/tests/end-to-end/event/invalid-coverage-metadata.phpt b/tests/end-to-end/event/invalid-coverage-metadata.phpt
@@ -40,7 +40,7 @@ Test Suite Started (default, 1 test)
 Test Suite Started (PHPUnit\TestFixture\Event\InvalidCoverageMetadata\InvalidCoverageMetadataTest, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\InvalidCoverageMetadata\InvalidCoverageMetadataTest::testOne)
 Test Prepared (PHPUnit\TestFixture\Event\InvalidCoverageMetadata\InvalidCoverageMetadataTest::testOne)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\InvalidCoverageMetadata\InvalidCoverageMetadataTest::testOne)
 Test Triggered PHPUnit Warning (PHPUnit\TestFixture\Event\InvalidCoverageMetadata\InvalidCoverageMetadataTest::testOne)
 Class "PHPUnit\TestFixture\Event\InvalidCoverageMetadata\This\Does\Not\Exist" is not a valid target for code coverage

diff --git a/tests/end-to-end/event/phar-extension.phpt b/tests/end-to-end/event/phar-extension.phpt
@@ -38,7 +38,7 @@ Test Suite Started (default, 1 test)
 Test Suite Started (PHPUnit\TestFixture\Event\MyExtension\Test, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\MyExtension\Test::testOne)
 Test Prepared (PHPUnit\TestFixture\Event\MyExtension\Test::testOne)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\MyExtension\Test::testOne)
 Test Finished (PHPUnit\TestFixture\Event\MyExtension\Test::testOne)
 Test Suite Finished (PHPUnit\TestFixture\Event\MyExtension\Test, 1 test)

diff --git a/tests/end-to-end/event/php-deprecated.phpt b/tests/end-to-end/event/php-deprecated.phpt
@@ -42,7 +42,7 @@ Test Preparation Started (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::te
 Test Prepared (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
 Test Triggered PHP Deprecation (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
 defined(): Passing null to parameter #1 ($constant_name) of type string is deprecated
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
 Test Finished (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
 Test Suite Finished (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest, 1 test)

diff --git a/tests/end-to-end/event/php-notice.phpt b/tests/end-to-end/event/php-notice.phpt
@@ -36,7 +36,7 @@ Test Preparation Started (PHPUnit\TestFixture\Event\PhpNoticeTest::testPhpNotice
 Test Prepared (PHPUnit\TestFixture\Event\PhpNoticeTest::testPhpNotice)
 Test Triggered PHP Notice (PHPUnit\TestFixture\Event\PhpNoticeTest::testPhpNotice)
 Only variables should be assigned by reference
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\PhpNoticeTest::testPhpNotice)
 Test Finished (PHPUnit\TestFixture\Event\PhpNoticeTest::testPhpNotice)
 Test Suite Finished (PHPUnit\TestFixture\Event\PhpNoticeTest, 1 test)

diff --git a/tests/end-to-end/event/php-warning.phpt b/tests/end-to-end/event/php-warning.phpt
@@ -36,7 +36,7 @@ Test Preparation Started (PHPUnit\TestFixture\Event\PhpWarningTest::testPhpWarni
 Test Prepared (PHPUnit\TestFixture\Event\PhpWarningTest::testPhpWarning)
 Test Triggered PHP Warning (PHPUnit\TestFixture\Event\PhpWarningTest::testPhpWarning)
 Undefined variable $b
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\PhpWarningTest::testPhpWarning)
 Test Finished (PHPUnit\TestFixture\Event\PhpWarningTest::testPhpWarning)
 Test Suite Finished (PHPUnit\TestFixture\Event\PhpWarningTest, 1 test)

diff --git a/tests/end-to-end/event/phpunit-deprecated.phpt b/tests/end-to-end/event/phpunit-deprecated.phpt
@@ -36,7 +36,7 @@ Test Preparation Started (PHPUnit\TestFixture\Event\DeprecatedPhpunitFeatureTest
 Test Prepared (PHPUnit\TestFixture\Event\DeprecatedPhpunitFeatureTest::testDeprecatedPhpunitFeature)
 Test Triggered PHPUnit Deprecation (PHPUnit\TestFixture\Event\DeprecatedPhpunitFeatureTest::testDeprecatedPhpunitFeature)
 message
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\DeprecatedPhpunitFeatureTest::testDeprecatedPhpunitFeature)
 Test Finished (PHPUnit\TestFixture\Event\DeprecatedPhpunitFeatureTest::testDeprecatedPhpunitFeature)
 Test Suite Finished (PHPUnit\TestFixture\Event\DeprecatedPhpunitFeatureTest, 1 test)

diff --git a/tests/end-to-end/event/phpunit-warning.phpt b/tests/end-to-end/event/phpunit-warning.phpt
@@ -36,7 +36,7 @@ Test Preparation Started (PHPUnit\TestFixture\Event\PhpunitWarningTest::testPhpu
 Test Prepared (PHPUnit\TestFixture\Event\PhpunitWarningTest::testPhpunitWarning)
 Test Triggered PHPUnit Warning (PHPUnit\TestFixture\Event\PhpunitWarningTest::testPhpunitWarning)
 message
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\PhpunitWarningTest::testPhpunitWarning)
 Test Finished (PHPUnit\TestFixture\Event\PhpunitWarningTest::testPhpunitWarning)
 Test Suite Finished (PHPUnit\TestFixture\Event\PhpunitWarningTest, 1 test)

diff --git a/tests/end-to-end/event/test-custom-comparator.phpt b/tests/end-to-end/event/test-custom-comparator.phpt
@@ -35,7 +35,7 @@ Test Suite Started (PHPUnit\TestFixture\Event\CustomComparatorTest, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\CustomComparatorTest::testWithCustomComparator)
 Test Prepared (PHPUnit\TestFixture\Event\CustomComparatorTest::testWithCustomComparator)
 Comparator Registered (PHPUnit\TestFixture\Event\CustomComparator)
-Assertion Succeeded (Constraint: is equal to true, Value: false)
+Assertion Succeeded (Constraint: is equal to true)
 Test Passed (PHPUnit\TestFixture\Event\CustomComparatorTest::testWithCustomComparator)
 Test Finished (PHPUnit\TestFixture\Event\CustomComparatorTest::testWithCustomComparator)
 Test Suite Finished (PHPUnit\TestFixture\Event\CustomComparatorTest, 1 test)

diff --git a/tests/end-to-end/event/test-mock.phpt b/tests/end-to-end/event/test-mock.phpt
@@ -35,7 +35,7 @@ Test Suite Started (PHPUnit\TestFixture\Event\MockTest, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\MockTest::testSuccess)
 Test Prepared (PHPUnit\TestFixture\Event\MockTest::testSuccess)
 Mock Object Created (PHPUnit\TestFixture\Event\Example)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\MockTest::testSuccess)
 Test Finished (PHPUnit\TestFixture\Event\MockTest::testSuccess)
 Test Suite Finished (PHPUnit\TestFixture\Event\MockTest, 1 test)

diff --git a/tests/end-to-end/event/test-risky-depends-on-larger-test.phpt b/tests/end-to-end/event/test-risky-depends-on-larger-test.phpt
@@ -35,7 +35,7 @@ Test Suite Started (%s/test-risky-depends-on-larger-test, 2 tests)
 Test Suite Started (PHPUnit\TestFixture\Event\RiskyBecauseDependencyOnLargerTest\LargeTest, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\RiskyBecauseDependencyOnLargerTest\LargeTest::testOne)
 Test Prepared (PHPUnit\TestFixture\Event\RiskyBecauseDependencyOnLargerTest\LargeTest::testOne)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\RiskyBecauseDependencyOnLargerTest\LargeTest::testOne)
 Test Finished (PHPUnit\TestFixture\Event\RiskyBecauseDependencyOnLargerTest\LargeTest::testOne)
 Test Suite Finished (PHPUnit\TestFixture\Event\RiskyBecauseDependencyOnLargerTest\LargeTest, 1 test)

diff --git a/tests/end-to-end/event/test-risky-output.phpt b/tests/end-to-end/event/test-risky-output.phpt
@@ -35,7 +35,7 @@ Test Runner Execution Started (1 test)
 Test Suite Started (PHPUnit\TestFixture\Event\RiskyBecauseOutputTest, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\RiskyBecauseOutputTest::testOne)
 Test Prepared (PHPUnit\TestFixture\Event\RiskyBecauseOutputTest::testOne)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\RiskyBecauseOutputTest::testOne)
 Test Considered Risky (PHPUnit\TestFixture\Event\RiskyBecauseOutputTest::testOne)
 This test printed output: *

diff --git a/tests/end-to-end/event/test-risky-time-limit-exceeded.phpt b/tests/end-to-end/event/test-risky-time-limit-exceeded.phpt
@@ -35,7 +35,7 @@ Test Runner Execution Started (1 test)
 Test Suite Started (PHPUnit\TestFixture\Event\RiskyBecauseTimeLimitExceededTest, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\RiskyBecauseTimeLimitExceededTest::testOne)
 Test Prepared (PHPUnit\TestFixture\Event\RiskyBecauseTimeLimitExceededTest::testOne)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Considered Risky (PHPUnit\TestFixture\Event\RiskyBecauseTimeLimitExceededTest::testOne)
 This test was aborted after 1 second
 Test Finished (PHPUnit\TestFixture\Event\RiskyBecauseTimeLimitExceededTest::testOne)

diff --git a/tests/end-to-end/event/test-stub.phpt b/tests/end-to-end/event/test-stub.phpt
@@ -35,7 +35,7 @@ Test Suite Started (PHPUnit\TestFixture\Event\StubTest, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\StubTest::testSuccess)
 Test Prepared (PHPUnit\TestFixture\Event\StubTest::testSuccess)
 Test Stub Created (PHPUnit\TestFixture\Event\Example)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\StubTest::testSuccess)
 Test Finished (PHPUnit\TestFixture\Event\StubTest::testSuccess)
 Test Suite Finished (PHPUnit\TestFixture\Event\StubTest, 1 test)

diff --git a/tests/end-to-end/event/test-success.phpt b/tests/end-to-end/event/test-success.phpt
@@ -34,7 +34,7 @@ Test Runner Execution Started (1 test)
 Test Suite Started (PHPUnit\TestFixture\Event\SuccessTest, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\SuccessTest::testSuccess)
 Test Prepared (PHPUnit\TestFixture\Event\SuccessTest::testSuccess)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\SuccessTest::testSuccess)
 Test Finished (PHPUnit\TestFixture\Event\SuccessTest::testSuccess)
 Test Suite Finished (PHPUnit\TestFixture\Event\SuccessTest, 1 test)

diff --git a/tests/end-to-end/event/test-template-methods.phpt b/tests/end-to-end/event/test-template-methods.phpt
@@ -43,7 +43,7 @@ Pre Condition Method Called (PHPUnit\TestFixture\Event\TemplateMethodsTest::asse
 Pre Condition Method Finished:
 - PHPUnit\TestFixture\Event\TemplateMethodsTest::assertPreConditions
 Test Prepared (PHPUnit\TestFixture\Event\TemplateMethodsTest::testOne)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Post Condition Method Called (PHPUnit\TestFixture\Event\TemplateMethodsTest::assertPostConditions)
 Post Condition Method Finished:
 - PHPUnit\TestFixture\Event\TemplateMethodsTest::assertPostConditions
@@ -60,7 +60,7 @@ Pre Condition Method Called (PHPUnit\TestFixture\Event\TemplateMethodsTest::asse
 Pre Condition Method Finished:
 - PHPUnit\TestFixture\Event\TemplateMethodsTest::assertPreConditions
 Test Prepared (PHPUnit\TestFixture\Event\TemplateMethodsTest::testTwo)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Post Condition Method Called (PHPUnit\TestFixture\Event\TemplateMethodsTest::assertPostConditions)
 Post Condition Method Finished:
 - PHPUnit\TestFixture\Event\TemplateMethodsTest::assertPostConditions

diff --git a/tests/end-to-end/event/test-with-expectation-on-output.phpt b/tests/end-to-end/event/test-with-expectation-on-output.phpt
@@ -35,12 +35,12 @@ Test Runner Execution Started (3 tests)
 Test Suite Started (PHPUnit\TestFixture\Issue445Test, 3 tests)
 Test Preparation Started (PHPUnit\TestFixture\Issue445Test::testOutputWithExpectationBefore)
 Test Prepared (PHPUnit\TestFixture\Issue445Test::testOutputWithExpectationBefore)
-Assertion Succeeded (Constraint: is equal to 'test', Value: 'test')
+Assertion Succeeded (Constraint: is equal to 'test')
 Test Passed (PHPUnit\TestFixture\Issue445Test::testOutputWithExpectationBefore)
 Test Finished (PHPUnit\TestFixture\Issue445Test::testOutputWithExpectationBefore)
 Test Preparation Started (PHPUnit\TestFixture\Issue445Test::testOutputWithExpectationAfter)
 Test Prepared (PHPUnit\TestFixture\Issue445Test::testOutputWithExpectationAfter)
-Assertion Succeeded (Constraint: is equal to 'test', Value: 'test')
+Assertion Succeeded (Constraint: is equal to 'test')
 Test Passed (PHPUnit\TestFixture\Issue445Test::testOutputWithExpectationAfter)
 Test Finished (PHPUnit\TestFixture\Issue445Test::testOutputWithExpectationAfter)
 Test Preparation Started (PHPUnit\TestFixture\Issue445Test::testNotMatchingOutput)

diff --git a/tests/end-to-end/event/too-few-columns.phpt b/tests/end-to-end/event/too-few-columns.phpt
@@ -37,7 +37,7 @@ Test Runner Execution Started (1 test)
 Test Suite Started (PHPUnit\TestFixture\Event\SuccessTest, 1 test)
 Test Preparation Started (PHPUnit\TestFixture\Event\SuccessTest::testSuccess)
 Test Prepared (PHPUnit\TestFixture\Event\SuccessTest::testSuccess)
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\SuccessTest::testSuccess)
 Test Finished (PHPUnit\TestFixture\Event\SuccessTest::testSuccess)
 Test Suite Finished (PHPUnit\TestFixture\Event\SuccessTest, 1 test)

diff --git a/tests/end-to-end/event/user-deprecated.phpt b/tests/end-to-end/event/user-deprecated.phpt
@@ -36,7 +36,7 @@ Test Preparation Started (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testD
 Test Prepared (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 Test Triggered Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 message
-Assertion Succeeded (Constraint: is true, Value: true)
+Assertion Succeeded (Constraint: is true)
 Test Passed (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 Test Finished (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 Test Suite Finished (PHPUnit\TestFixture\Event\DeprecatedFeatureTest, 1 test)

diff --git a/tests/unit/Event/DispatchingEmitterTest.php b/tests/unit/Event/DispatchingEmitterTest.php
@@ -136,7 +136,6 @@ public function notify(Test\AssertionSucceeded $event): void
 
         $this->assertInstanceOf(Test\AssertionSucceeded::class, $event);
 
-        $this->assertSame((new Exporter)->export('value'), $event->value());
         $this->assertSame(1, $event->count());
         $this->assertSame($message, $event->message());
     }

diff --git a/tests/unit/Event/Events/Test/Assertion/AssertionSucceededTest.php b/tests/unit/Event/Events/Test/Assertion/AssertionSucceededTest.php
@@ -18,23 +18,22 @@ final class AssertionSucceededTest extends AbstractEventTestCase
     public function testConstructorSetsValues(): void
     {
         $telemetryInfo = $this->telemetryInfo();
-        $value         = 'value';
         $constraint    = 'constraint';
         $count         = 1;
         $message       = 'message';
 
         $event = new AssertionSucceeded(
             $telemetryInfo,
-            $value,
+            '',
             $constraint,
             $count,
             $message,
         );
 
         $this->assertSame($telemetryInfo, $event->telemetryInfo());
-        $this->assertSame($value, $event->value());
+        $this->assertSame('', $event->value());
         $this->assertSame($count, $event->count());
         $this->assertSame($message, $event->message());
-        $this->assertSame('Assertion Succeeded (Constraint: constraint, Value: value, Message: message)', $event->asString());
+        $this->assertSame('Assertion Succeeded (Constraint: constraint, Message: message)', $event->asString());
     }
 }