Merge pull request #14 from VadymHrechukha/AHN-131_extended_hascontext_trait_to_include_method_for_fetch_context

HP-2824: extended HasContext trait to include method for fetch context by key

Author: SilverFire

.github/workflows/phpunit-tests.yml

@@ -0,0 +1,46 @@
+name: phpunit-tests
+
+on:
+  push:
+  pull_request:
+  schedule:
+   - cron: "0 9 * * 1"
+
+jobs:
+  PHPUnit:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php: ['8.3']
+        coverage-driver: [pcov]
+    name: PHP ${{ matrix.php }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: gmp
+          coverage: pcov
+          tools: composer:v2, infection
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v4
+        with:
+          path: vendor
+          key: ${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+
+      - name: Update composer
+        run: composer self-update
+
+      - name: Composer install
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        run: composer install -n
+
+      - name: PHPUnit
+        run: vendor/bin/phpunit
+        env:
+          XDEBUG_MODE: coverage

composer.json

@@ -55,6 +55,7 @@
         "yiisoft/yii2": "dev-master",
         "yiisoft/arrays": "*@dev",
         "yiisoft/strings": "*@dev",
+        "phpunit/phpunit": "^12.0",
         "yiisoft/composer-config-plugin": "dev-master",
         "opis/closure": "3.x-dev as 3.6.x-dev"
     },
@@ -78,5 +79,11 @@
             "type": "composer",
             "url": "https://asset-packagist.org"
         }
-    ]
+    ],
+    "config": {
+        "allow-plugins": {
+            "yiisoft/yii2-composer": true,
+            "yiisoft/composer-config-plugin": true
+        }
+    }
 }

phpunit.xml.dist

@@ -1,18 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit backupGlobals="false" backupStaticAttributes="false" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="false" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" bootstrap="tests/_bootstrap.php">
     <testsuites>
-        <testsuite name="Unit Test Suite">
+        <testsuite name="unit">
             <directory>./tests/unit/</directory>
         </testsuite>
         <testsuite name="Functional Test Suite">
             <directory>./tests/functional/</directory>
         </testsuite>
+    <!--
         <testsuite name="Readme Unit Test Suite">
             <directory>.hidev/vendor/hiqdev/hidev-readme/tests/unit/</directory>
         </testsuite>
         <testsuite name="License Unit Test Suite">
             <directory>.hidev/vendor/hiqdev/hidev-license/tests/unit/</directory>
         </testsuite>
+    -->
     <!--
         <testsuite name="Readme Functional Test Suite">
             <directory>.hidev/vendor/hiqdev/hidev-readme/tests/functional/</directory>

src/exception/HasContext.php

@@ -1,8 +1,11 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 namespace hidev\exception;
 
 use Throwable;
+use yii\helpers\ArrayHelper;
 
 trait HasContext
 {
@@ -13,6 +16,7 @@ abstract public function getPrevious(): ?Throwable;
     public function addContext(array $data): self
     {
         $this->context = array_merge($this->context, $data);
+
         return $this;
     }
 
@@ -28,4 +32,9 @@ public static function make(string $message, array $context): self
 
         return $exception;
     }
+
+    public function getContextValue(string $fieldName)
+    {
+        return ArrayHelper::getValue($this->context, $fieldName, '');
+    }
 }

src/handlers/YamlHandler.php

@@ -32,8 +32,12 @@ public function __construct(Interpolator $interpolator, $options = [])
      */
     public function renderType($data)
     {
-        /// XXX TODO fix getItems crutch
-        return Yaml::dump(ArrayHelper::toArray(method_exists($data, 'getItems') ? $data->getItems() : $data), 5);
+        if (!is_array($data)) {
+            /// XXX TODO fix getItems crutch
+            $data = ArrayHelper::toArray(method_exists($data, 'getItems') ? $data->getItems() : $data);
+        }
+
+        return Yaml::dump($data, 5);
     }
 
     /**

tests/_bootstrap.php

@@ -11,4 +11,4 @@
 error_reporting(E_ALL & ~E_NOTICE);
 
 require_once __DIR__ . '/../config/bootstrap.php';
-require_once __DIR__ . '/../.hidev/vendor/autoload.php';
+require_once __DIR__ . '/../vendor/autoload.php';

tests/functional/InitTest.php

@@ -17,13 +17,25 @@ class InitTest extends \PHPUnit\Framework\TestCase
      */
     protected $tester;
 
-    protected function setUp()
+    protected function setUp(): void
     {
+        parent::setUp();
+
+        $this->previousExceptionHandler = set_exception_handler(function() {});
+        restore_exception_handler();
+
         $this->tester = new Tester($this);
     }
 
-    protected function tearDown()
+    protected function tearDown(): void
     {
+        // Restore handlers altered during hidev execution
+        if ($this->previousExceptionHandler !== null) {
+            set_exception_handler($this->previousExceptionHandler);
+        } else {
+            restore_exception_handler();
+        }
+
         $this->tester = null;
     }
 

tests/functional/Tester.php

@@ -11,6 +11,7 @@
 namespace hidev\tests\functional;
 
 use Yii;
+use yii\base\InvalidConfigException;
 use yii\console\Application;
 use yii\console\Request;
 
@@ -74,7 +75,8 @@ public function __destruct()
 
     /**
      * Run hidev.
-     * @param string $query
+     * @param string|string[] $query
+     * @throws InvalidConfigException
      */
     public function hidev($query)
     {

tests/unit/console/CommonControllerTest.php

@@ -14,27 +14,31 @@
 
 class CommonControllerTest extends \PHPUnit\Framework\TestCase
 {
-    /**
-     * @var CommonController
-     */
-    protected $object;
+    protected CommonController $object;
 
     protected $before = 'asd';
 
     /**
      * Sets up the fixture, for example, opens a network connection.
      * This method is called before a test is executed.
      */
-    protected function setUp()
+    protected function setUp(): void
     {
-        $this->object = new CommonController('test', null);
+        $this->object = new CommonController('test', null, [
+            'request' => [
+                'class' => \yii\console\Request::class,
+            ],
+            'response' => [
+                'class' => \yii\console\Response::class,
+            ],
+        ]);
     }
 
     /**
      * Tears down the fixture, for example, closes a network connection.
      * This method is called after a test is executed.
      */
-    protected function tearDown()
+    protected function tearDown(): void
     {
     }
 

tests/unit/exception/HasContextTest.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace hidev\tests\unit\exception;
+
+use hidev\tests\unit\exception\stub\TestException;
+use PHPUnit\Framework\TestCase;
+
+class HasContextTest extends TestCase
+{
+    public function testAddContext(): void
+    {
+        $e = new TestException('Error');
+
+        $e->addContext(['a' => 1]);
+        $e->addContext(['b' => 2]);
+
+        $this->assertSame(['a' => 1, 'b' => 2], $e->getContext());
+    }
+
+    public function testGetContext(): void
+    {
+        $e = new TestException('Error');
+        $e->addContext(['foo' => 'bar']);
+
+        $this->assertSame(['foo' => 'bar'], $e->getContext());
+    }
+
+    public function testMakeCreatesInstanceWithContext(): void
+    {
+        $e = TestException::make('Something happened', ['key' => 'value']);
+
+        $this->assertInstanceOf(TestException::class, $e);
+        $this->assertSame('Something happened', $e->getMessage());
+        $this->assertSame(['key' => 'value'], $e->getContext());
+    }
+
+    public function testGetContextValueReturnsNestedValue(): void
+    {
+        $e = new TestException('Error');
+        $e->addContext([
+            'user' => [
+                'id' => 15,
+                'profile' => [
+                    'email' => 'test@example.com',
+                ],
+            ],
+        ]);
+
+        $this->assertSame(15, $e->getContextValue('user.id'));
+        $this->assertSame('test@example.com', $e->getContextValue('user.profile.email'));
+    }
+
+    public function testGetContextValueReturnsDefaultWhenMissing(): void
+    {
+        $e = new TestException('Error');
+        $e->addContext(['foo' => 'bar']);
+
+        $this->assertSame('', $e->getContextValue('missing.key'));
+    }
+}