Implement PHPUnit notices

Author: sebastianbergmann

phpunit.xsd

@@ -180,6 +180,7 @@
         <xs:attribute name="processIsolation" type="xs:boolean" default="false"/>
         <xs:attribute name="failOnDeprecation" type="xs:boolean" default="false"/>
         <xs:attribute name="failOnPhpunitDeprecation" type="xs:boolean" default="false"/>
+        <xs:attribute name="failOnPhpunitNotice" type="xs:boolean" default="false"/>
         <xs:attribute name="failOnEmptyTestSuite" type="xs:boolean" default="false"/>
         <xs:attribute name="failOnIncomplete" type="xs:boolean" default="false"/>
         <xs:attribute name="failOnNotice" type="xs:boolean" default="false"/>
@@ -216,6 +217,7 @@
         <xs:attribute name="displayDetailsOnSkippedTests" type="xs:boolean" default="false"/>
         <xs:attribute name="displayDetailsOnTestsThatTriggerDeprecations" type="xs:boolean" default="false"/>
         <xs:attribute name="displayDetailsOnPhpunitDeprecations" type="xs:boolean" default="false"/>
+        <xs:attribute name="displayDetailsOnPhpunitNotices" type="xs:boolean" default="false"/>
         <xs:attribute name="displayDetailsOnTestsThatTriggerErrors" type="xs:boolean" default="false"/>
         <xs:attribute name="displayDetailsOnTestsThatTriggerNotices" type="xs:boolean" default="false"/>
         <xs:attribute name="displayDetailsOnTestsThatTriggerWarnings" type="xs:boolean" default="false"/>

src/Event/Emitter/DispatchingEmitter.php

@@ -717,6 +717,28 @@ public function testTriggeredPhpunitDeprecation(?Code\Test $test, string $messag
         );
     }
 
+    /**
+     * @param non-empty-string $message
+     *
+     * @throws InvalidArgumentException
+     * @throws NoTestCaseObjectOnCallStackException
+     * @throws UnknownEventTypeException
+     */
+    public function testTriggeredPhpunitNotice(?Code\Test $test, string $message): void
+    {
+        if ($test === null) {
+            $test = TestMethodBuilder::fromCallStack();
+        }
+
+        $this->dispatcher->dispatch(
+            new Test\PhpunitNoticeTriggered(
+                $this->telemetryInfo(),
+                $test,
+                $message,
+            ),
+        );
+    }
+
     /**
      * @param non-empty-string $message
      * @param non-empty-string $file
@@ -1155,6 +1177,22 @@ public function testRunnerTriggeredPhpunitDeprecation(string $message): void
         );
     }
 
+    /**
+     * @param non-empty-string $message
+     *
+     * @throws InvalidArgumentException
+     * @throws UnknownEventTypeException
+     */
+    public function testRunnerTriggeredPhpunitNotice(string $message): void
+    {
+        $this->dispatcher->dispatch(
+            new TestRunner\NoticeTriggered(
+                $this->telemetryInfo(),
+                $message,
+            ),
+        );
+    }
+
     /**
      * @param non-empty-string $message
      *

src/Event/Emitter/Emitter.php

@@ -159,6 +159,11 @@ public function testSkipped(Code\Test $test, string $message): void;
      */
     public function testTriggeredPhpunitDeprecation(?Code\Test $test, string $message): void;
 
+    /**
+     * @param non-empty-string $message
+     */
+    public function testTriggeredPhpunitNotice(?Code\Test $test, string $message): void;
+
     /**
      * @param non-empty-string $message
      * @param non-empty-string $file
@@ -275,6 +280,11 @@ public function testRunnerFinishedStaticAnalysisForCodeCoverage(int $cacheHits,
      */
     public function testRunnerTriggeredPhpunitDeprecation(string $message): void;
 
+    /**
+     * @param non-empty-string $message
+     */
+    public function testRunnerTriggeredPhpunitNotice(string $message): void;
+
     /**
      * @param non-empty-string $message
      */

src/Event/Events/Test/Issue/PhpunitNoticeTriggered.php

@@ -0,0 +1,79 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\Test;
+
+use const PHP_EOL;
+use function sprintf;
+use function trim;
+use PHPUnit\Event\Code\Test;
+use PHPUnit\Event\Event;
+use PHPUnit\Event\Telemetry;
+
+/**
+ * @immutable
+ *
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+final readonly class PhpunitNoticeTriggered implements Event
+{
+    private Telemetry\Info $telemetryInfo;
+    private Test $test;
+
+    /**
+     * @var non-empty-string
+     */
+    private string $message;
+
+    /**
+     * @param non-empty-string $message
+     */
+    public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message)
+    {
+        $this->telemetryInfo = $telemetryInfo;
+        $this->test          = $test;
+        $this->message       = $message;
+    }
+
+    public function telemetryInfo(): Telemetry\Info
+    {
+        return $this->telemetryInfo;
+    }
+
+    public function test(): Test
+    {
+        return $this->test;
+    }
+
+    /**
+     * @return non-empty-string
+     */
+    public function message(): string
+    {
+        return $this->message;
+    }
+
+    /**
+     * @return non-empty-string
+     */
+    public function asString(): string
+    {
+        $message = trim($this->message);
+
+        if ($message !== '') {
+            $message = PHP_EOL . $message;
+        }
+
+        return sprintf(
+            'Test Triggered PHPUnit Notice (%s)%s',
+            $this->test->id(),
+            $message,
+        );
+    }
+}

src/Event/Events/Test/Issue/PhpunitNoticeTriggeredSubscriber.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\Test;
+
+use PHPUnit\Event\Subscriber;
+
+/**
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+interface PhpunitNoticeTriggeredSubscriber extends Subscriber
+{
+    public function notify(PhpunitNoticeTriggered $event): void;
+}

src/Event/Events/TestRunner/NoticeTriggered.php

@@ -0,0 +1,52 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\TestRunner;
+
+use function sprintf;
+use PHPUnit\Event\Event;
+use PHPUnit\Event\Telemetry;
+
+/**
+ * @immutable
+ *
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+final readonly class NoticeTriggered implements Event
+{
+    private Telemetry\Info $telemetryInfo;
+    private string $message;
+
+    public function __construct(Telemetry\Info $telemetryInfo, string $message)
+    {
+        $this->telemetryInfo = $telemetryInfo;
+        $this->message       = $message;
+    }
+
+    public function telemetryInfo(): Telemetry\Info
+    {
+        return $this->telemetryInfo;
+    }
+
+    public function message(): string
+    {
+        return $this->message;
+    }
+
+    /**
+     * @return non-empty-string
+     */
+    public function asString(): string
+    {
+        return sprintf(
+            'Test Runner Triggered Notice (%s)',
+            $this->message,
+        );
+    }
+}

src/Event/Events/TestRunner/NoticeTriggeredSubscriber.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Event\TestRunner;
+
+use PHPUnit\Event\Subscriber;
+
+/**
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+interface NoticeTriggeredSubscriber extends Subscriber
+{
+    public function notify(NoticeTriggered $event): void;
+}

src/Event/Facade.php

@@ -197,6 +197,7 @@ private function registerDefaultTypes(TypeMap $typeMap): void
             Test\PhpDeprecationTriggered::class,
             Test\PhpNoticeTriggered::class,
             Test\PhpunitDeprecationTriggered::class,
+            Test\PhpunitNoticeTriggered::class,
             Test\PhpunitErrorTriggered::class,
             Test\PhpunitWarningTriggered::class,
             Test\PhpWarningTriggered::class,
@@ -230,6 +231,7 @@ private function registerDefaultTypes(TypeMap $typeMap): void
             TestRunner\Finished::class,
             TestRunner\Started::class,
             TestRunner\DeprecationTriggered::class,
+            TestRunner\NoticeTriggered::class,
             TestRunner\WarningTriggered::class,
             TestRunner\GarbageCollectionDisabled::class,
             TestRunner\GarbageCollectionTriggered::class,

src/Runner/TestResult/Collector.php

@@ -30,12 +30,14 @@
 use PHPUnit\Event\Test\PhpNoticeTriggered;
 use PHPUnit\Event\Test\PhpunitDeprecationTriggered;
 use PHPUnit\Event\Test\PhpunitErrorTriggered;
+use PHPUnit\Event\Test\PhpunitNoticeTriggered;
 use PHPUnit\Event\Test\PhpunitWarningTriggered;
 use PHPUnit\Event\Test\PhpWarningTriggered;
 use PHPUnit\Event\Test\Skipped as TestSkipped;
 use PHPUnit\Event\Test\WarningTriggered;
 use PHPUnit\Event\TestRunner\DeprecationTriggered as TestRunnerDeprecationTriggered;
 use PHPUnit\Event\TestRunner\ExecutionStarted;
+use PHPUnit\Event\TestRunner\NoticeTriggered as TestRunnerNoticeTriggered;
 use PHPUnit\Event\TestRunner\WarningTriggered as TestRunnerWarningTriggered;
 use PHPUnit\Event\TestSuite\Finished as TestSuiteFinished;
 use PHPUnit\Event\TestSuite\Skipped as TestSuiteSkipped;
@@ -106,20 +108,30 @@ final class Collector
     private array $testTriggeredPhpunitErrorEvents = [];
 
     /**
-     * @var array<string,list<PhpunitWarningTriggered>>
+     * @var array<string,list<PhpunitNoticeTriggered>>
      */
-    private array $testTriggeredPhpunitWarningEvents = [];
+    private array $testTriggeredPhpunitNoticeEvents = [];
 
     /**
-     * @var list<TestRunnerWarningTriggered>
+     * @var array<string,list<PhpunitWarningTriggered>>
      */
-    private array $testRunnerTriggeredWarningEvents = [];
+    private array $testTriggeredPhpunitWarningEvents = [];
 
     /**
      * @var list<TestRunnerDeprecationTriggered>
      */
     private array $testRunnerTriggeredDeprecationEvents = [];
 
+    /**
+     * @var list<TestRunnerNoticeTriggered>
+     */
+    private array $testRunnerTriggeredNoticeEvents = [];
+
+    /**
+     * @var list<TestRunnerWarningTriggered>
+     */
+    private array $testRunnerTriggeredWarningEvents = [];
+
     /**
      * @var array<non-empty-string, Issue>
      */
@@ -182,10 +194,12 @@ public function __construct(Facade $facade, IssueFilter $issueFilter)
             new TestTriggeredPhpNoticeSubscriber($this),
             new TestTriggeredPhpunitDeprecationSubscriber($this),
             new TestTriggeredPhpunitErrorSubscriber($this),
+            new TestTriggeredPhpunitNoticeSubscriber($this),
             new TestTriggeredPhpunitWarningSubscriber($this),
             new TestTriggeredPhpWarningSubscriber($this),
             new TestTriggeredWarningSubscriber($this),
             new TestRunnerTriggeredDeprecationSubscriber($this),
+            new TestRunnerTriggeredNoticeSubscriber($this),
             new TestRunnerTriggeredWarningSubscriber($this),
         );
 
@@ -206,8 +220,10 @@ public function result(): TestResult
             $this->testMarkedIncompleteEvents,
             $this->testTriggeredPhpunitDeprecationEvents,
             $this->testTriggeredPhpunitErrorEvents,
+            $this->testTriggeredPhpunitNoticeEvents,
             $this->testTriggeredPhpunitWarningEvents,
             $this->testRunnerTriggeredDeprecationEvents,
+            $this->testRunnerTriggeredNoticeEvents,
             $this->testRunnerTriggeredWarningEvents,
             array_values($this->errors),
             array_values($this->deprecations),
@@ -416,6 +432,15 @@ public function testTriggeredPhpunitDeprecation(PhpunitDeprecationTriggered $eve
         $this->testTriggeredPhpunitDeprecationEvents[$event->test()->id()][] = $event;
     }
 
+    public function testTriggeredPhpunitNotice(PhpunitNoticeTriggered $event): void
+    {
+        if (!isset($this->testTriggeredPhpunitNoticeEvents[$event->test()->id()])) {
+            $this->testTriggeredPhpunitNoticeEvents[$event->test()->id()] = [];
+        }
+
+        $this->testTriggeredPhpunitNoticeEvents[$event->test()->id()][] = $event;
+    }
+
     public function testTriggeredError(ErrorTriggered $event): void
     {
         if (!$this->issueFilter->shouldBeProcessed($event)) {
@@ -573,6 +598,11 @@ public function testRunnerTriggeredDeprecation(TestRunnerDeprecationTriggered $e
         $this->testRunnerTriggeredDeprecationEvents[] = $event;
     }
 
+    public function testRunnerTriggeredNotice(TestRunnerNoticeTriggered $event): void
+    {
+        $this->testRunnerTriggeredNoticeEvents[] = $event;
+    }
+
     public function testRunnerTriggeredWarning(TestRunnerWarningTriggered $event): void
     {
         $this->testRunnerTriggeredWarningEvents[] = $event;