Change how the DeprecationTriggered, ErrorTriggered, NoticeTriggered, PhpDeprecationTriggered, PhpNoticeTriggered, PhpWarningTriggered, and WarningTriggered events are represented as text

sebastianbergmann · sebastianbergmann · commit d1558975e0c7 · 2024-03-16T10:32:05.000+01:00
diff --git a/ChangeLog-11.1.md b/ChangeLog-11.1.md
@@ -16,6 +16,7 @@ All notable changes of the PHPUnit 11.1 release series are documented in this fi
 ### Changed
 
 * [#5708](https://github.com/sebastianbergmann/phpunit/issues/5708): Allow the `--group`, `--exclude-group`, `--covers`, `--uses`, and `--test-suffix` CLI options to be used multiple times
+* Changed how the `DeprecationTriggered`, `ErrorTriggered`, `NoticeTriggered`, `PhpDeprecationTriggered`, `PhpNoticeTriggered`, `PhpWarningTriggered`, and `WarningTriggered` events are represented as text
 
 ### Deprecated
 
diff --git a/src/Event/Events/Test/Issue/DeprecationTriggered.php b/src/Event/Events/Test/Issue/DeprecationTriggered.php
@@ -10,6 +10,7 @@
 namespace PHPUnit\Event\Test;
 
 use const PHP_EOL;
+use function implode;
 use function sprintf;
 use PHPUnit\Event\Code\Test;
 use PHPUnit\Event\Event;
@@ -117,20 +118,23 @@ public function asString(): string
             $message = PHP_EOL . $message;
         }
 
-        $status = '';
+        $details = [$this->test->id()];
+
+        if ($this->suppressed) {
+            $details[] = 'suppressed using operator';
+        }
 
         if ($this->ignoredByTest) {
-            $status = 'Test-Ignored ';
-        } elseif ($this->ignoredByBaseline) {
-            $status = 'Baseline-Ignored ';
-        } elseif ($this->suppressed) {
-            $status = 'Suppressed ';
+            $details[] = 'ignored by test';
+        }
+
+        if ($this->ignoredByBaseline) {
+            $details[] = 'ignored by baseline';
         }
 
         return sprintf(
-            'Test Triggered %sDeprecation (%s)%s',
-            $status,
-            $this->test->id(),
+            'Test Triggered Deprecation (%s)%s',
+            implode(', ', $details),
             $message,
         );
     }
diff --git a/src/Event/Events/Test/Issue/ErrorTriggered.php b/src/Event/Events/Test/Issue/ErrorTriggered.php
@@ -10,6 +10,7 @@
 namespace PHPUnit\Event\Test;
 
 use const PHP_EOL;
+use function implode;
 use function sprintf;
 use PHPUnit\Event\Code\Test;
 use PHPUnit\Event\Event;
@@ -103,10 +104,15 @@ public function asString(): string
             $message = PHP_EOL . $message;
         }
 
+        $details = [$this->test->id()];
+
+        if ($this->suppressed) {
+            $details[] = 'suppressed using operator';
+        }
+
         return sprintf(
-            'Test Triggered %sError (%s)%s',
-            $this->wasSuppressed() ? 'Suppressed ' : '',
-            $this->test->id(),
+            'Test Triggered Error (%s)%s',
+            implode(', ', $details),
             $message,
         );
     }
diff --git a/src/Event/Events/Test/Issue/NoticeTriggered.php b/src/Event/Events/Test/Issue/NoticeTriggered.php
@@ -10,6 +10,7 @@
 namespace PHPUnit\Event\Test;
 
 use const PHP_EOL;
+use function implode;
 use function sprintf;
 use PHPUnit\Event\Code\Test;
 use PHPUnit\Event\Event;
@@ -110,18 +111,19 @@ public function asString(): string
             $message = PHP_EOL . $message;
         }
 
-        $status = '';
+        $details = [$this->test->id()];
+
+        if ($this->suppressed) {
+            $details[] = 'suppressed using operator';
+        }
 
         if ($this->ignoredByBaseline) {
-            $status = 'Baseline-Ignored ';
-        } elseif ($this->suppressed) {
-            $status = 'Suppressed ';
+            $details[] = 'ignored by baseline';
         }
 
         return sprintf(
-            'Test Triggered %sNotice (%s)%s',
-            $status,
-            $this->test->id(),
+            'Test Triggered Notice (%s)%s',
+            implode(', ', $details),
             $message,
         );
     }
diff --git a/src/Event/Events/Test/Issue/PhpDeprecationTriggered.php b/src/Event/Events/Test/Issue/PhpDeprecationTriggered.php
@@ -10,6 +10,7 @@
 namespace PHPUnit\Event\Test;
 
 use const PHP_EOL;
+use function implode;
 use function sprintf;
 use PHPUnit\Event\Code\Test;
 use PHPUnit\Event\Event;
@@ -117,20 +118,23 @@ public function asString(): string
             $message = PHP_EOL . $message;
         }
 
-        $status = '';
+        $details = [$this->test->id()];
+
+        if ($this->suppressed) {
+            $details[] = 'suppressed using operator';
+        }
 
         if ($this->ignoredByTest) {
-            $status = 'Test-Ignored ';
-        } elseif ($this->ignoredByBaseline) {
-            $status = 'Baseline-Ignored ';
-        } elseif ($this->suppressed) {
-            $status = 'Suppressed ';
+            $details[] = 'ignored by test';
+        }
+
+        if ($this->ignoredByBaseline) {
+            $details[] = 'ignored by baseline';
         }
 
         return sprintf(
-            'Test Triggered %sPHP Deprecation (%s)%s',
-            $status,
-            $this->test->id(),
+            'Test Triggered PHP Deprecation (%s)%s',
+            implode(', ', $details),
             $message,
         );
     }
diff --git a/src/Event/Events/Test/Issue/PhpNoticeTriggered.php b/src/Event/Events/Test/Issue/PhpNoticeTriggered.php
@@ -10,6 +10,7 @@
 namespace PHPUnit\Event\Test;
 
 use const PHP_EOL;
+use function implode;
 use function sprintf;
 use PHPUnit\Event\Code\Test;
 use PHPUnit\Event\Event;
@@ -110,18 +111,19 @@ public function asString(): string
             $message = PHP_EOL . $message;
         }
 
-        $status = '';
+        $details = [$this->test->id()];
+
+        if ($this->suppressed) {
+            $details[] = 'suppressed using operator';
+        }
 
         if ($this->ignoredByBaseline) {
-            $status = 'Baseline-Ignored ';
-        } elseif ($this->suppressed) {
-            $status = 'Suppressed ';
+            $details[] = 'ignored by baseline';
         }
 
         return sprintf(
-            'Test Triggered %sPHP Notice (%s)%s',
-            $status,
-            $this->test->id(),
+            'Test Triggered PHP Notice (%s)%s',
+            implode(', ', $details),
             $message,
         );
     }
diff --git a/src/Event/Events/Test/Issue/PhpWarningTriggered.php b/src/Event/Events/Test/Issue/PhpWarningTriggered.php
@@ -10,6 +10,7 @@
 namespace PHPUnit\Event\Test;
 
 use const PHP_EOL;
+use function implode;
 use function sprintf;
 use PHPUnit\Event\Code\Test;
 use PHPUnit\Event\Event;
@@ -110,18 +111,19 @@ public function asString(): string
             $message = PHP_EOL . $message;
         }
 
-        $status = '';
+        $details = [$this->test->id()];
+
+        if ($this->suppressed) {
+            $details[] = 'suppressed using operator';
+        }
 
         if ($this->ignoredByBaseline) {
-            $status = 'Baseline-Ignored ';
-        } elseif ($this->suppressed) {
-            $status = 'Suppressed ';
+            $details[] = 'ignored by baseline';
         }
 
         return sprintf(
-            'Test Triggered %sPHP Warning (%s)%s',
-            $status,
-            $this->test->id(),
+            'Test Triggered PHP Warning (%s)%s',
+            implode(', ', $details),
             $message,
         );
     }
diff --git a/src/Event/Events/Test/Issue/WarningTriggered.php b/src/Event/Events/Test/Issue/WarningTriggered.php
@@ -10,6 +10,7 @@
 namespace PHPUnit\Event\Test;
 
 use const PHP_EOL;
+use function implode;
 use function sprintf;
 use PHPUnit\Event\Code\Test;
 use PHPUnit\Event\Event;
@@ -110,18 +111,19 @@ public function asString(): string
             $message = PHP_EOL . $message;
         }
 
-        $status = '';
+        $details = [$this->test->id()];
+
+        if ($this->suppressed) {
+            $details[] = 'suppressed using operator';
+        }
 
         if ($this->ignoredByBaseline) {
-            $status = 'Baseline-Ignored ';
-        } elseif ($this->suppressed) {
-            $status = 'Suppressed ';
+            $details[] = 'ignored by baseline';
         }
 
         return sprintf(
-            'Test Triggered %sWarning (%s)%s',
-            $status,
-            $this->test->id(),
+            'Test Triggered Warning (%s)%s',
+            implode(', ', $details),
             $message,
         );
     }
diff --git a/tests/end-to-end/event/deprecations-can-be-ignored-using-attribute.phpt b/tests/end-to-end/event/deprecations-can-be-ignored-using-attribute.phpt
@@ -29,7 +29,7 @@ Test Runner Execution Started (4 tests)
 Test Suite Started (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest, 4 tests)
 Test Preparation Started (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne)
 Test Prepared (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne)
-Test Triggered Test-Ignored Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne, ignored by test)
 message
 Test Passed (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne)
 Test Finished (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOne)
@@ -41,7 +41,7 @@ Test Passed (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwo)
 Test Finished (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testTwo)
 Test Preparation Started (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast)
 Test Prepared (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast)
-Test Triggered Test-Ignored Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast, ignored by test)
 message
 Test Passed (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast)
 Test Finished (PHPUnit\TestFixture\Event\IgnoreDeprecationsTest::testOneErrorGetLast)
diff --git a/tests/end-to-end/event/php-deprecated.phpt b/tests/end-to-end/event/php-deprecated.phpt
@@ -34,7 +34,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)
 strlen(): Passing null to parameter #1 ($string) of type string is deprecated
-Test Triggered Suppressed PHP Deprecation (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
+Test Triggered PHP Deprecation (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature, suppressed using operator)
 strlen(): Passing null to parameter #1 ($string) of type string is deprecated
 Test Passed (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
 Test Finished (PHPUnit\TestFixture\Event\DeprecatedPhpFeatureTest::testDeprecatedPhpFeature)
diff --git a/tests/end-to-end/event/php-notice.phpt b/tests/end-to-end/event/php-notice.phpt
@@ -32,7 +32,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
-Test Triggered Suppressed PHP Notice (PHPUnit\TestFixture\Event\PhpNoticeTest::testPhpNotice)
+Test Triggered PHP Notice (PHPUnit\TestFixture\Event\PhpNoticeTest::testPhpNotice, suppressed using operator)
 Only variables should be assigned by reference
 Test Passed (PHPUnit\TestFixture\Event\PhpNoticeTest::testPhpNotice)
 Test Finished (PHPUnit\TestFixture\Event\PhpNoticeTest::testPhpNotice)
diff --git a/tests/end-to-end/event/php-warning.phpt b/tests/end-to-end/event/php-warning.phpt
@@ -32,7 +32,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
-Test Triggered Suppressed PHP Warning (PHPUnit\TestFixture\Event\PhpWarningTest::testPhpWarning)
+Test Triggered PHP Warning (PHPUnit\TestFixture\Event\PhpWarningTest::testPhpWarning, suppressed using operator)
 Undefined variable $b
 Test Passed (PHPUnit\TestFixture\Event\PhpWarningTest::testPhpWarning)
 Test Finished (PHPUnit\TestFixture\Event\PhpWarningTest::testPhpWarning)
diff --git a/tests/end-to-end/event/suppressed-user-notice.phpt b/tests/end-to-end/event/suppressed-user-notice.phpt
@@ -29,13 +29,13 @@ Test Runner Execution Started (2 tests)
 Test Suite Started (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest, 2 tests)
 Test Preparation Started (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNotice)
 Test Prepared (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNotice)
-Test Triggered Suppressed Notice (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNotice)
+Test Triggered Notice (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNotice, suppressed using operator)
 message
 Test Passed (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNotice)
 Test Finished (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNotice)
 Test Preparation Started (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNoticeErrorGetLast)
 Test Prepared (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNoticeErrorGetLast)
-Test Triggered Suppressed Notice (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNoticeErrorGetLast)
+Test Triggered Notice (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNoticeErrorGetLast, suppressed using operator)
 message
 Test Passed (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNoticeErrorGetLast)
 Test Finished (PHPUnit\TestFixture\Event\SuppressedUserNoticeTest::testSuppressedUserNoticeErrorGetLast)
diff --git a/tests/end-to-end/event/suppressed-user-warning.phpt b/tests/end-to-end/event/suppressed-user-warning.phpt
@@ -29,13 +29,13 @@ Test Runner Execution Started (2 tests)
 Test Suite Started (PHPUnit\TestFixture\Event\SuppressedUserWarningTest, 2 tests)
 Test Preparation Started (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarning)
 Test Prepared (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarning)
-Test Triggered Suppressed Warning (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarning)
+Test Triggered Warning (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarning, suppressed using operator)
 message
 Test Passed (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarning)
 Test Finished (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarning)
 Test Preparation Started (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarningErrorGetLast)
 Test Prepared (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarningErrorGetLast)
-Test Triggered Suppressed Warning (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarningErrorGetLast)
+Test Triggered Warning (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarningErrorGetLast, suppressed using operator)
 message
 Test Passed (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarningErrorGetLast)
 Test Finished (PHPUnit\TestFixture\Event\SuppressedUserWarningTest::testSuppressedUserWarningErrorGetLast)
diff --git a/tests/end-to-end/event/user-deprecated.phpt b/tests/end-to-end/event/user-deprecated.phpt
@@ -31,13 +31,13 @@ Test Preparation Started (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testD
 Test Prepared (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 Test Triggered Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 message
-Test Triggered Suppressed Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature, suppressed using operator)
 message
 Test Passed (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 Test Finished (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedFeature)
 Test Preparation Started (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast)
 Test Prepared (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast)
-Test Triggered Suppressed Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast)
+Test Triggered Deprecation (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast, suppressed using operator)
 message
 Test Passed (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast)
 Test Finished (PHPUnit\TestFixture\Event\DeprecatedFeatureTest::testDeprecatedSuppressedErrorGetLast)
diff --git a/tests/unit/Event/Events/Test/Issue/DeprecationTriggeredTest.php b/tests/unit/Event/Events/Test/Issue/DeprecationTriggeredTest.php
@@ -65,7 +65,7 @@ public function testCanBeIgnoredByBaseline(): void
         );
 
         $this->assertTrue($event->ignoredByBaseline());
-        $this->assertSame('Test Triggered Baseline-Ignored Deprecation (FooTest::testBar)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, ignored by baseline)' . PHP_EOL . 'message', $event->asString());
     }
 
     public function testCanBeIgnoredByTest(): void
@@ -82,7 +82,7 @@ public function testCanBeIgnoredByTest(): void
         );
 
         $this->assertTrue($event->ignoredByTest());
-        $this->assertSame('Test Triggered Test-Ignored Deprecation (FooTest::testBar)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, ignored by test)' . PHP_EOL . 'message', $event->asString());
     }
 
     public function testCanBeSuppressed(): void
@@ -99,6 +99,6 @@ public function testCanBeSuppressed(): void
         );
 
         $this->assertTrue($event->wasSuppressed());
-        $this->assertSame('Test Triggered Suppressed Deprecation (FooTest::testBar)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered Deprecation (FooTest::testBar, suppressed using operator)' . PHP_EOL . 'message', $event->asString());
     }
 }
diff --git a/tests/unit/Event/Events/Test/Issue/NoticeTriggeredTest.php b/tests/unit/Event/Events/Test/Issue/NoticeTriggeredTest.php
@@ -61,7 +61,7 @@ public function testCanBeIgnoredByBaseline(): void
         );
 
         $this->assertTrue($event->ignoredByBaseline());
-        $this->assertSame('Test Triggered Baseline-Ignored Notice (FooTest::testBar)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered Notice (FooTest::testBar, ignored by baseline)' . PHP_EOL . 'message', $event->asString());
     }
 
     public function testCanBeSuppressed(): void
@@ -77,6 +77,6 @@ public function testCanBeSuppressed(): void
         );
 
         $this->assertTrue($event->wasSuppressed());
-        $this->assertSame('Test Triggered Suppressed Notice (FooTest::testBar)' . PHP_EOL . 'message', $event->asString());
+        $this->assertSame('Test Triggered Notice (FooTest::testBar, suppressed using operator)' . PHP_EOL . 'message', $event->asString());
     }
 }
diff --git a/tests/unit/Event/Events/Test/Issue/PhpDeprecationTriggeredTest.php b/tests/unit/Event/Events/Test/Issue/PhpDeprecationTriggeredTest.php
diff --git a/tests/unit/Event/Events/Test/Issue/PhpNoticeTriggeredTest.php b/tests/unit/Event/Events/Test/Issue/PhpNoticeTriggeredTest.php
diff --git a/tests/unit/Event/Events/Test/Issue/PhpWarningTriggeredTest.php b/tests/unit/Event/Events/Test/Issue/PhpWarningTriggeredTest.php
diff --git a/tests/unit/Event/Events/Test/Issue/WarningTriggeredTest.php b/tests/unit/Event/Events/Test/Issue/WarningTriggeredTest.php
