Always emit Test\PhpunitWarningTriggered event

Author: sebastianbergmann

src/Event/Emitter/DispatchingEmitter.php

@@ -10,7 +10,6 @@
 namespace PHPUnit\Event;
 
 use function assert;
-use function class_exists;
 use function memory_reset_peak_usage;
 use PHPUnit\Event\Code\ClassMethod;
 use PHPUnit\Event\Code\ComparisonFailure;
@@ -1011,22 +1010,28 @@ public function testTriggeredPhpunitError(Code\Test $test, string $message): voi
      */
     public function testTriggeredPhpunitWarning(Code\Test $test, string $message): void
     {
-        if (
-            $test->isTestMethod() &&
-            class_exists($test->className()) &&
-            ($metadata = Registry::parser()->forMethod($test->className(), $test->methodName())->isIgnorePhpunitWarnings())->isNotEmpty() &&
-            ($ignoreWarnings = $metadata->asArray()[0] ?? null) !== null &&
-            $ignoreWarnings instanceof IgnorePhpunitWarnings &&
-            $ignoreWarnings->shouldIgnore($message)
-        ) {
-            return;
+        $ignoredByTest = false;
+
+        if ($test->isTestMethod()) {
+            assert($test instanceof TestMethod);
+
+            $metadata = Registry::parser()->forMethod($test->className(), $test->methodName())->isIgnorePhpunitWarnings()->asArray();
+
+            if (isset($metadata[0])) {
+                assert($metadata[0] instanceof IgnorePhpunitWarnings);
+
+                if ($metadata[0]->shouldIgnore($message)) {
+                    $ignoredByTest = true;
+                }
+            }
         }
 
         $this->dispatcher->dispatch(
             new Test\PhpunitWarningTriggered(
                 $this->telemetryInfo(),
                 $test,
                 $message,
+                $ignoredByTest,
             ),
         );
     }

src/Event/Events/Test/Issue/PhpunitWarningTriggered.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;
@@ -29,15 +30,17 @@
      * @var non-empty-string
      */
     private string $message;
+    private bool $ignoredByTest;
 
     /**
      * @param non-empty-string $message
      */
-    public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message)
+    public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, bool $ignoredByTest)
     {
         $this->telemetryInfo = $telemetryInfo;
         $this->test          = $test;
         $this->message       = $message;
+        $this->ignoredByTest = $ignoredByTest;
     }
 
     public function telemetryInfo(): Telemetry\Info
@@ -58,6 +61,11 @@ public function message(): string
         return $this->message;
     }
 
+    public function ignoredByTest(): bool
+    {
+        return $this->ignoredByTest;
+    }
+
     /**
      * @return non-empty-string
      */
@@ -69,9 +77,15 @@ public function asString(): string
             $message = PHP_EOL . $message;
         }
 
+        $details = [$this->test->id()];
+
+        if ($this->ignoredByTest) {
+            $details[] = 'ignored by test';
+        }
+
         return sprintf(
             'Test Triggered PHPUnit Warning (%s)%s',
-            $this->test->id(),
+            implode(', ', $details),
             $message,
         );
     }

src/Logging/TestDox/TestResult/TestResultCollector.php

@@ -308,6 +308,10 @@ public function testTriggeredPhpunitWarning(PhpunitWarningTriggered $event): voi
             return;
         }
 
+        if ($event->ignoredByTest()) {
+            return;
+        }
+
         $this->updateTestStatus(TestStatus::warning());
     }
 

src/Runner/TestResult/Collector.php

@@ -593,6 +593,10 @@ public function testTriggeredPhpunitError(PhpunitErrorTriggered $event): void
 
     public function testTriggeredPhpunitWarning(PhpunitWarningTriggered $event): void
     {
+        if ($event->ignoredByTest()) {
+            return;
+        }
+
         if (!isset($this->testTriggeredPhpunitWarningEvents[$event->test()->id()])) {
             $this->testTriggeredPhpunitWarningEvents[$event->test()->id()] = [];
         }

src/TextUI/Output/Default/ProgressPrinter/ProgressPrinter.php

@@ -20,6 +20,7 @@
 use PHPUnit\Event\Test\NoticeTriggered;
 use PHPUnit\Event\Test\PhpDeprecationTriggered;
 use PHPUnit\Event\Test\PhpNoticeTriggered;
+use PHPUnit\Event\Test\PhpunitWarningTriggered;
 use PHPUnit\Event\Test\PhpWarningTriggered;
 use PHPUnit\Event\Test\WarningTriggered;
 use PHPUnit\Event\TestRunner\ChildProcessErrored;
@@ -228,8 +229,12 @@ public function testTriggeredPhpWarning(PhpWarningTriggered $event): void
         $this->updateTestStatus(TestStatus::warning());
     }
 
-    public function testTriggeredPhpunitWarning(): void
+    public function testTriggeredPhpunitWarning(PhpunitWarningTriggered $event): void
     {
+        if ($event->ignoredByTest()) {
+            return;
+        }
+
         $this->updateTestStatus(TestStatus::warning());
     }
 

src/TextUI/Output/Default/ProgressPrinter/Subscriber/TestTriggeredPhpunitWarningSubscriber.php

@@ -21,6 +21,6 @@
 {
     public function notify(PhpunitWarningTriggered $event): void
     {
-        $this->printer()->testTriggeredPhpunitWarning();
+        $this->printer()->testTriggeredPhpunitWarning($event);
     }
 }

tests/unit/Event/Emitter/DispatchingEmitterTest.php

@@ -15,6 +15,7 @@
 use PHPUnit\Event\Code\TestCollection;
 use PHPUnit\Event\Code\TestDoxBuilder;
 use PHPUnit\Event\Code\TestMethod;
+use PHPUnit\Event\Code\TestMethodBuilder;
 use PHPUnit\Event\Code\ThrowableBuilder;
 use PHPUnit\Event\Telemetry\SystemGarbageCollectorStatusProvider;
 use PHPUnit\Event\TestData\TestDataCollection;
@@ -2508,7 +2509,7 @@ public function notify(Test\PhpunitWarningTriggered $event): void
             $telemetrySystem,
         );
 
-        $test    = $this->testValueObject();
+        $test    = TestMethodBuilder::fromTestCase($this);
         $message = 'message';
 
         $emitter->testTriggeredPhpunitWarning(
@@ -2523,6 +2524,7 @@ public function notify(Test\PhpunitWarningTriggered $event): void
         $this->assertInstanceOf(Test\PhpunitWarningTriggered::class, $event);
         $this->assertSame($test, $event->test());
         $this->assertSame($message, $event->message());
+        $this->assertFalse($event->ignoredByTest());
     }
 
     #[TestDox('testPrintedUnexpectedOutput() emits Test\PrintedUnexpectedOutput event')]

tests/unit/Event/Events/Test/Issue/PhpunitWarningTriggeredTest.php

@@ -23,16 +23,32 @@ public function testConstructorSetsValues(): void
         $telemetryInfo = $this->telemetryInfo();
         $test          = $this->testValueObject();
         $message       = 'message';
+        $ignoredByTest = false;
 
         $event = new PhpunitWarningTriggered(
             $telemetryInfo,
             $test,
             $message,
+            $ignoredByTest,
         );
 
         $this->assertSame($telemetryInfo, $event->telemetryInfo());
         $this->assertSame($test, $event->test());
         $this->assertSame($message, $event->message());
+        $this->assertSame($ignoredByTest, $event->ignoredByTest());
         $this->assertSame('Test Triggered PHPUnit Warning (FooTest::testBar)' . PHP_EOL . 'message', $event->asString());
     }
+
+    public function testCanBeIgnoredByTest(): void
+    {
+        $event = new PhpunitWarningTriggered(
+            $this->telemetryInfo(),
+            $this->testValueObject(),
+            'message',
+            true,
+        );
+
+        $this->assertTrue($event->ignoredByTest());
+        $this->assertSame('Test Triggered PHPUnit Warning (FooTest::testBar, ignored by test)' . PHP_EOL . 'message', $event->asString());
+    }
 }

tests/unit/TextUI/Output/Default/ResultPrinterTest.php

@@ -383,6 +383,7 @@ public static function provider(): array
                                 self::telemetryInfo(),
                                 self::testMethod(),
                                 'message',
+                                false,
                             ),
                         ],
                     ],