Improve mutation tests (#135)

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Enh #132: Add benchmarks, improve performance of `Message::parse()` (@samdark)
 - Bug #130: Updated `Message::parse()` to correctly support multiple placeholders (@technicated)
 - Chg #130, #133: Changed `Message::parse()` to conform to PSR-3 (@technicated, @vjik)
+- Enh #135: Add validation for `$traceLevel` in `SystemContextProvider` to ensure values are greater than or equal to zero (@rekmixa)
 - Enh #137: Explicitly import classes, functions, and constants in "use" section (@mspirkov)
 
 ## 2.2.0 December 13, 2025

infection.json.dist

@@ -11,6 +11,9 @@
         }
     },
     "mutators": {
-        "@default": true
+        "@default": true,
+        "global-ignoreSourceCodeByRegex": [
+            "register_shutdown_function"
+        ]
     }
 }

src/ContextProvider/SystemContextProvider.php

@@ -33,6 +33,7 @@
         private int $traceLevel = 0,
         array $excludedTracePaths = [],
     ) {
+        $this->assertTraceLevelIsValid($this->traceLevel);
         /** @psalm-suppress DeprecatedMethod `setExcludedTracePaths` will be private and not deprecated */
         $this->setExcludedTracePaths($excludedTracePaths);
     }
@@ -61,7 +62,9 @@
      */
     public function setTraceLevel(int $traceLevel): self
     {
+        $this->assertTraceLevelIsValid($traceLevel);
         $this->traceLevel = $traceLevel;
+
         return $this;
     }
 
@@ -114,7 +117,7 @@
                 if (isset($trace['file'], $trace['line'])) {
                     $excludedMatch = array_filter(
                         $this->excludedTracePaths,
-                        static fn($path) => str_contains($trace['file'], $path),
+                        static fn(string $path): bool => str_contains($trace['file'], $path),
                     );
 
                     if (empty($excludedMatch)) {
@@ -129,4 +132,23 @@
 
         return $traces;
     }
+
+    /**
+     * Validates $traceLevel property
+     *
+     * @param int $traceLevel The number of call stack information.
+     *
+     * @see self::$traceLevel
+     */
+    private function assertTraceLevelIsValid(int $traceLevel): void
+    {
+        if ($traceLevel < 0) {
+            throw new InvalidArgumentException(
+                sprintf(
+                    'Trace level must be greater than or equal to zero, %s received.',
+                    $traceLevel,
+                ),
+            );
+        }
+    }
 }

src/Logger.php

@@ -11,8 +11,8 @@
 use RuntimeException;
 use Stringable;
 use Throwable;
-use Yiisoft\Log\ContextProvider\SystemContextProvider;
 use Yiisoft\Log\ContextProvider\ContextProviderInterface;
+use Yiisoft\Log\ContextProvider\SystemContextProvider;
 
 use function count;
 use function implode;
@@ -88,7 +88,7 @@
         $this->setTargets($targets);
         $this->contextProvider = $contextProvider ?? new SystemContextProvider();
 
         register_shutdown_function(function () {
             // make regular flush before other shutdown functions, which allows session data collection and so on
             $this->flush();
             // make sure log entries written by shutdown functions are also flushed
@@ -105,24 +105,13 @@
      * @throws \Psr\Log\InvalidArgumentException for invalid log message level.
      *
      * @return string The text display of the level.
-     * @deprecated since 2.1, to be removed in 3.0. Use {@see LogLevel::assertLevelIsValid()} instead.
+     * @deprecated since 2.1, to be removed in 3.0. Use {@see Logger::assertLevelIsValid()} instead.
+     * @psalm-suppress MixedInferredReturnType
+     * @psalm-suppress MixedReturnStatement
      */
     public static function validateLevel(mixed $level): string
     {
-        if (!is_string($level)) {
-            throw new \Psr\Log\InvalidArgumentException(sprintf(
-                'The log message level must be a string, %s provided.',
-                get_debug_type($level),
-            ));
-        }
-
-        if (!in_array($level, self::LEVELS, true)) {
-            throw new \Psr\Log\InvalidArgumentException(sprintf(
-                'Invalid log message level "%s" provided. The following values are supported: "%s".',
-                $level,
-                implode('", "', self::LEVELS),
-            ));
-        }
+        self::assertLevelIsValid($level);
 
         return $level;
     }
@@ -145,7 +134,7 @@
             array_merge($this->contextProvider->getContext(), $context),
         );
 
         if ($this->flushInterval > 0 && count($this->messages) >= $this->flushInterval) {
             $this->flush();
         }
     }
@@ -242,7 +231,7 @@
      *
      * @psalm-assert string $level
      */
     public static function assertLevelIsString(mixed $level): void
     {
         if (is_string($level)) {
             return;

tests/ContextProvider/SystemContextProviderTest.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Log\Tests\ContextProvider;
+
+use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
+use Yiisoft\Log\ContextProvider\SystemContextProvider;
+
+final class SystemContextProviderTest extends TestCase
+{
+    public function testWrongTraceLevel(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        new SystemContextProvider(-1);
+    }
+
+    public function testContextHasNeededData(): void
+    {
+        $provider = new SystemContextProvider();
+        $context = $provider->getContext();
+
+        $this->assertArrayHasKey('time', $context);
+        $this->assertArrayHasKey('trace', $context);
+        $this->assertArrayHasKey('memory', $context);
+        $this->assertArrayHasKey('category', $context);
+    }
+}

tests/LoggerTest.php

@@ -56,11 +56,24 @@ public function testLog(): void
         $this->assertGreaterThanOrEqual($memory, $messages[1]->context('memory'));
     }
 
+    public function testLogWithWrongLevel(): void
+    {
+        $this->expectException(\Psr\Log\InvalidArgumentException::class);
+        $this->logger->log(123, 'test1');
+    }
+
+    public function testLogWithUnsupportedLevel(): void
+    {
+        $this->expectException(\Psr\Log\InvalidArgumentException::class);
+        $this->logger->log('unsupported-level', 'test1');
+    }
+
     public function testLogWithTraceLevel(): void
     {
         $memory = memory_get_usage();
         $this->logger->setTraceLevel($traceLevel = 3);
 
+        $line = __LINE__;
         $this->logger->log(LogLevel::INFO, 'test3');
         $messages = $this->getInaccessibleMessages($this->logger);
 
@@ -70,7 +83,7 @@ public function testLogWithTraceLevel(): void
         $this->assertSame('application', $messages[0]->context('category'));
         $this->assertSame([
             'file' => __FILE__,
-            'line' => 64,
+            'line' => $line + 1,
             'function' => 'log',
             'class' => Logger::class,
             'type' => '->',
@@ -145,6 +158,7 @@ public function testSetExcludedTracePaths(): void
         $this->logger->info('info message');
         $messages = $this->getInaccessibleMessages($this->logger);
 
+        $this->assertNotEmpty($messages[1]->context('trace'));
         foreach ($messages[1]->context('trace') as $trace) {
             $this->assertNotSame(__FILE__, $trace['file']);
         }