Create Unit tests

Author: Asisyas

composer.json

@@ -26,6 +26,11 @@
             "Micro\\Plugin\\Http\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Micro\\Plugin\\Http\\Test\\": "tests/"
+        }
+    },
     "config": {
         "allow-plugins": {
             "ergebnis/composer-normalize": true
@@ -34,8 +39,8 @@
     },
     "scripts": {
         "coverage": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-text",
-        "php-cs-fix": "./vendor/bin/php-cs-fixer fix --verbose --using-cache=no",
-        "php-cs-try": "./vendor/bin/php-cs-fixer fix --verbose --dry-run --using-cache=no",
+        "php-cs-fix": "PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer fix --verbose --using-cache=no",
+        "php-cs-try": "PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer fix --verbose --dry-run --using-cache=no",
         "phpstan": "./vendor/bin/phpstan analyze --no-progress",
         "phpunit": "./vendor/bin/phpunit",
         "psalm": "./vendor/bin/psalm --no-progress --show-info=true",

psalm.xml

@@ -18,19 +18,19 @@
 
         <UnnecessaryVarAnnotation>
             <errorLevel type="suppress">
-                <file name="src/PluginHttpLogger.php"/>
+                <file name="src/HttpLoggerPlugin.php"/>
             </errorLevel>
         </UnnecessaryVarAnnotation>
 
         <MissingConstructor>
             <errorLevel type="suppress">
-                <file name="src/PluginHttpLogger.php"/>
+                <file name="src/HttpLoggerPlugin.php"/>
             </errorLevel>
         </MissingConstructor>
 
         <ImplementedReturnTypeMismatch>
             <errorLevel type="suppress">
-                <file name="src/PluginHttpLogger.php"/>
+                <file name="src/HttpLoggerPlugin.php"/>
             </errorLevel>
         </ImplementedReturnTypeMismatch>
     </issueHandlers>

src/Business/Executor/HttpExecutorLoggerAwareDecoratorFactory.php

@@ -14,7 +14,7 @@
 namespace Micro\Plugin\Http\Business\Executor;
 
 use Micro\Plugin\Http\Business\Logger\Formatter\LogFormatterFactoryInterface;
-use Micro\Plugin\Http\PluginHttpLoggerConfigurationInterface;
+use Micro\Plugin\Http\HttpLoggerPluginConfigurationInterface;
 use Micro\Plugin\Logger\LoggerFacadeInterface;
 
 /**
@@ -26,7 +26,7 @@ public function __construct(
         private RouteExecutorInterface $decorated,
         private LoggerFacadeInterface $loggerFacade,
         private LogFormatterFactoryInterface $logFormatterFactory,
-        private PluginHttpLoggerConfigurationInterface $configuration
+        private HttpLoggerPluginConfigurationInterface $configuration
     ) {
     }
 

src/Decorator/HttpFacadeLoggerDecorator.php

@@ -55,6 +55,6 @@ public function generateUrlByRouteName(string $routeName, ?array $parameters = [
 
     public function match(Request $request): RouteInterface
     {
-        return $this->match($request);
+        return $this->decorated->match($request);
     }
 }

src/PluginHttpLogger.php src/HttpLoggerPlugin.phpsrc/PluginHttpLogger.php renamed to src/HttpLoggerPlugin.php

@@ -30,9 +30,9 @@
 /**
  * @author Stanislau Komar <kost@micro-php.net>
  *
- * @method PluginHttpLoggerConfigurationInterface configuration()
+ * @method HttpLoggerPluginConfigurationInterface configuration()
  */
-class PluginHttpLogger implements DependencyProviderInterface, PluginDependedInterface, ConfigurableInterface
+class HttpLoggerPlugin implements DependencyProviderInterface, PluginDependedInterface, ConfigurableInterface
 {
     use PluginConfigurationTrait;
     private HttpFacadeInterface $httpFacade;

src/PluginHttpLoggerConfiguration.php src/HttpLoggerPluginConfiguration.phpsrc/PluginHttpLoggerConfiguration.php renamed to src/HttpLoggerPluginConfiguration.php

@@ -18,7 +18,7 @@
 /**
  * @author Stanislau Komar <kost@micro-php.net>
  */
-class PluginHttpLoggerConfiguration extends PluginConfiguration implements PluginHttpLoggerConfigurationInterface
+class HttpLoggerPluginConfiguration extends PluginConfiguration implements HttpLoggerPluginConfigurationInterface
 {
     public const CFG_LOGGER_ACCESS = 'MICRO_HTTP_LOGGER_ACCESS';
     public const CFG_LOGGER_ERROR = 'MICRO_HTTP_LOGGER_ERROR';

…uginHttpLoggerConfigurationInterface.php …tpLoggerPluginConfigurationInterface.phpsrc/PluginHttpLoggerConfigurationInterface.php renamed to src/HttpLoggerPluginConfigurationInterface.php src/PluginHttpLoggerConfigurationInterface.php renamed to src/HttpLoggerPluginConfigurationInterface.php

@@ -16,7 +16,7 @@
 /**
  * @author Stanislau Komar <kost@micro-php.net>
  */
-interface PluginHttpLoggerConfigurationInterface
+interface HttpLoggerPluginConfigurationInterface
 {
     public function getAccessLoggerName(): string|null;
 

tests/Unit/Micro/Plugin/Http/Business/Executor/HttpExecutorLoggerAwareDecoratorFactoryTest.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <kost@micro-php.net>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Business\Executor;
+
+use Micro\Plugin\Http\Business\Logger\Formatter\LogFormatterFactoryInterface;
+use Micro\Plugin\Http\Facade\HttpFacadeInterface;
+use Micro\Plugin\Http\HttpLoggerPluginConfigurationInterface;
+use Micro\Plugin\Logger\LoggerFacadeInterface;
+use PHPUnit\Framework\TestCase;
+
+class HttpExecutorLoggerAwareDecoratorFactoryTest extends TestCase
+{
+    public function testCreate()
+    {
+        $factory = new HttpExecutorLoggerAwareDecoratorFactory(
+            $this->createMock(HttpFacadeInterface::class),
+            $this->createMock(LoggerFacadeInterface::class),
+            $this->createMock(LogFormatterFactoryInterface::class),
+            $this->createMock(HttpLoggerPluginConfigurationInterface::class),
+        );
+
+        $this->assertInstanceOf(RouteExecutorInterface::class, $factory->create());
+    }
+}

tests/Unit/Micro/Plugin/Http/Business/Executor/HttpExecutorLoggerAwareDecoratorTest.php

@@ -0,0 +1,96 @@
+<?php
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <kost@micro-php.net>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Business\Executor;
+
+use Micro\Plugin\Http\Business\Logger\Formatter\LogFormatterInterface;
+use Micro\Plugin\Http\Exception\HttpException;
+use Micro\Plugin\Http\Facade\HttpFacadeInterface;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class HttpExecutorLoggerAwareDecoratorTest extends TestCase
+{
+    /**
+     * @dataProvider dataProvider
+     */
+    public function testExecute(bool $isFlush, bool $exceptException)
+    {
+        $decorator = new HttpExecutorLoggerAwareDecorator(
+            $this->createDecorated($exceptException),
+            $this->createLogger(),
+            $this->createLogger(),
+            $this->createFormatter(),
+            $this->createFormatter()
+        );
+
+        if ($exceptException) {
+            $this->expectException(HttpException::class);
+            $this->expectExceptionCode(404);
+        }
+
+        $this->assertInstanceOf(
+            Response::class,
+            $decorator->execute(
+                $this->createMock(Request::class),
+                $isFlush
+            )
+        );
+    }
+
+    public function dataProvider()
+    {
+        return [
+            [
+                true, true,
+            ],
+            [
+                false, true,
+            ],
+            [
+                true, false,
+            ],
+            [
+                false, false,
+            ],
+        ];
+    }
+
+    protected function createDecorated(bool $throwException)
+    {
+        $decorated = $this->createMock(HttpFacadeInterface::class);
+        $methodMock = $decorated
+            ->expects($this->once())
+            ->method('execute')
+        ;
+        if ($throwException) {
+            $methodMock->willThrowException(new HttpException('test', 404));
+        } else {
+            $methodMock->willReturn(
+                $this->createMock(Response::class)
+            );
+        }
+
+        return $decorated;
+    }
+
+    protected function createLogger()
+    {
+        return $this->createMock(LoggerInterface::class);
+    }
+
+    protected function createFormatter()
+    {
+        return $this->createMock(LogFormatterInterface::class);
+    }
+}

tests/Unit/Micro/Plugin/Http/Business/Logger/Formatter/Format/AbstractFormatTest.php

@@ -0,0 +1,89 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ *  This file is part of the Micro framework package.
+ *
+ *  (c) Stanislau Komar <kost@micro-php.net>
+ *
+ *  For the full copyright and license information, please view the LICENSE
+ *  file that was distributed with this source code.
+ */
+
+namespace Micro\Plugin\Http\Business\Logger\Formatter\Format;
+
+use Micro\Plugin\Http\Business\Logger\Formatter\LogFormatterInterface;
+use Micro\Plugin\Http\Exception\HttpException;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @author Stanislau Komar <kost@micro-php.net>
+ */
+abstract class AbstractFormatTest extends TestCase
+{
+    /**
+     * @dataProvider dataProvider
+     */
+    public function testFormat(bool $hasResponse, \Throwable|null $throwable)
+    {
+        $object = $this->createTestObject();
+
+        $this->assertIsString(
+            $object->format(
+                $this->createRequest(),
+                $this->createResponse($hasResponse),
+                $this->createThrowable($throwable)
+            )
+        );
+    }
+
+    public function dataProvider()
+    {
+        return [
+            [false, null],
+            [true, null],
+            [true, new HttpException()],
+            [false, new HttpException()],
+            [true, new \Exception()],
+            [false, new \Exception()],
+        ];
+    }
+
+    public function createThrowable(\Throwable|null $throwable): \Throwable|null
+    {
+        return $throwable;
+    }
+
+    protected function createResponse(bool $hasResponse): Response|null
+    {
+        if (!$hasResponse) {
+            return null;
+        }
+
+        return $this->createMock(Response::class);
+    }
+
+    protected function createRequest(): Request
+    {
+        return Request::create('/test');
+    }
+
+    abstract protected function getTestClass(): string;
+
+    protected function createTestObject(): LogFormatterInterface
+    {
+        $testClass = $this->getTestClass();
+
+        return new $testClass($this->getFormattedVariable());
+    }
+
+    protected function getFormattedVariable()
+    {
+        return '{{'.$this->getVariable().'}}';
+    }
+
+    abstract public function getVariable(): string;
+}