Merge pull request #5 from MacPaw/impruveTest

Impruve test
MacPaw · May 9, 2021 · 5a33d14 · 5a33d14
2 parents 11a33d7 + f4e916e
commit 5a33d14
Show file tree

Hide file tree

Showing 15 changed files with 426 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 .idea
 build
 vendor
+var
 /composer.lock
 /.phpcs-cache
 

diff --git a/composer.json b/composer.json
@@ -33,11 +33,13 @@
         "symfony/framework-bundle": "^3.4 || ^4.1.12 || ^5.0"
     },
     "require-dev": {
+        "ext-json": "*",
         "phpstan/phpstan": "0.12.*",
         "squizlabs/php_codesniffer": "3.5.*",
         "symfony/phpunit-bridge": "^3.4 || ^4.1.12 || ^5.0",
         "phpunit/phpunit": "^8.5 || ^9.0",
-        "symfony/yaml": "^3.4 || ^4.0 || ^5.0"
+        "symfony/yaml": "^3.4 || ^4.0 || ^5.0",
+        "symfony/browser-kit": "^3.4 || ^4.4 || ^5.0"
     },
     "autoload": {
         "psr-4": {

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -17,11 +17,13 @@
   <php>
     <ini name="error_reporting" value="-1"/>
     <ini name="memory_limit" value="-1"/>
-    <server name="APP_ENV" value="test" force="true"/>
+    <server name="APP_ENV" value="testing" force="true"/>
     <server name="APP_DEBUG" value="0" force="true"/>
     <server name="SHELL_VERBOSITY" value="-1"/>
     <server name="SYMFONY_PHPUNIT_REMOVE" value=""/>
     <server name="SYMFONY_PHPUNIT_VERSION" value="9"/>
+    <env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled" />
+    <env name="KERNEL_CLASS" value="SymfonyHealthCheckBundle\Tests\TestKernel" />
   </php>
   <testsuites>
     <testsuite name="Symfony Health Check Bundle Test Suite">

diff --git a/src/Check/DoctrineCheck.php b/src/Check/DoctrineCheck.php
@@ -10,7 +10,7 @@
 
 class DoctrineCheck implements CheckInterface
 {
-    private const CHECK_RESULT_KEY = 'doctrineConnection';
+    private const CHECK_RESULT_KEY = 'connection';
 
     private ContainerInterface $container;
 
@@ -24,6 +24,17 @@ public function __construct(ContainerInterface $container)
      */
     public function check(): array
     {
+        $result = ['name' => 'doctrine'];
+
+        if ($this->container->has('doctrine.orm.entity_manager') === false) {
+            throw new ServiceNotFoundException(
+                'Entity Manager Not Found.',
+                [
+                    'class' => 'doctrine.orm.entity_manager',
+                ]
+            );
+        }
+
         $entityManager = $this->container->get('doctrine.orm.entity_manager');
 
         if ($entityManager === null) {
@@ -33,9 +44,9 @@ public function check(): array
         try {
             $entityManager->getConnection()->ping();
         } catch (Throwable $e) {
-            return [self::CHECK_RESULT_KEY => false];
+            return array_merge($result, [self::CHECK_RESULT_KEY => false]);
         }
 
-        return [self::CHECK_RESULT_KEY => true];
+        return array_merge($result, [self::CHECK_RESULT_KEY => true]);
     }
 }
diff --git a/src/Check/EnvironmentCheck.php b/src/Check/EnvironmentCheck.php
@@ -20,12 +20,14 @@ public function __construct(ContainerInterface $container)
 
     public function check(): array
     {
+        $result = ['name' => self::CHECK_RESULT_KEY];
+
         try {
             $env = $this->container->getParameter('kernel.environment');
         } catch (Throwable $e) {
-            return [self::CHECK_RESULT_KEY => 'Could not determine'];
+            return array_merge($result, [self::CHECK_RESULT_KEY => 'Could not determine']);
         }
 
-        return [self::CHECK_RESULT_KEY => $env];
+        return array_merge($result, [self::CHECK_RESULT_KEY => $env]);
     }
 }
diff --git a/src/Exception/AbstractException.php b/src/Exception/AbstractException.php
@@ -18,7 +18,7 @@ abstract class AbstractException extends Exception implements ParameterException
      * AbstractException constructor.
      *
      * @param string         $message
-     * @param iterable[]     $parameters
+     * @param array<mixed>   $parameters
      * @param int            $code
      * @param Throwable|null $previous
      */

diff --git a/tests/Integration/Controller/HealthControllerTest.php b/tests/Integration/Controller/HealthControllerTest.php
@@ -0,0 +1,110 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SymfonyHealthCheckBundle\Tests\Integration\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use SymfonyHealthCheckBundle\Check\DoctrineCheck;
+use SymfonyHealthCheckBundle\Check\EnvironmentCheck;
+use SymfonyHealthCheckBundle\Check\StatusUpCheck;
+use SymfonyHealthCheckBundle\Controller\HealthController;
+use SymfonyHealthCheckBundle\Exception\ServiceNotFoundException;
+use TypeError;
+
+class HealthControllerTest extends WebTestCase
+{
+    public function testSuccess(): void
+    {
+        $client = static::createClient();
+        $client->request('GET', '/health');
+
+        $response = $client->getResponse();
+        self::assertSame(200, $response->getStatusCode());
+        self::assertSame(json_encode([]), $response->getContent());
+    }
+
+    public function testAddCheckStatusUpSuccess(): void
+    {
+        $healthController = new HealthController();
+        $healthController->addHealthCheck(new StatusUpCheck());
+
+        $response = $healthController->healthCheckAction();
+
+        self::assertSame(200, $response->getStatusCode());
+        self::assertSame(json_encode([['status' => 'up']]), $response->getContent());
+    }
+
+    public function testEnvironmentCheckCouldNotDetermine(): void
+    {
+        $healthController = new HealthController();
+        $healthController->addHealthCheck(new EnvironmentCheck(new ContainerBuilder()));
+
+        $response = $healthController->healthCheckAction();
+
+        self::assertSame(200, $response->getStatusCode());
+        self::assertSame(
+            json_encode([['name' => 'environment', 'environment' => 'Could not determine']]),
+            $response->getContent()
+        );
+    }
+
+    public function testDoctrineCheckServiceNotFoundException(): void
+    {
+        self::expectException(ServiceNotFoundException::class);
+
+        $healthController = new HealthController();
+        $healthController->addHealthCheck(new DoctrineCheck(new ContainerBuilder()));
+
+        $healthController->healthCheckAction();
+    }
+
+    public function testDoctrineCheckGetParameters(): void
+    {
+        $healthController = new HealthController();
+        $healthController->addHealthCheck(new DoctrineCheck(new ContainerBuilder()));
+
+        try {
+            $healthController->healthCheckAction();
+        } catch (ServiceNotFoundException $exception) {
+            self::assertSame(["class" => "doctrine.orm.entity_manager"], $exception->getParameters());
+        }
+    }
+
+    public function testTwoCheckSuccess(): void
+    {
+        $healthController = new HealthController();
+        $healthController->addHealthCheck(new StatusUpCheck());
+        $healthController->addHealthCheck(new EnvironmentCheck(new ContainerBuilder()));
+
+        $response = $healthController->healthCheckAction();
+
+        self::assertSame(200, $response->getStatusCode());
+        self::assertSame(
+            json_encode([['status' => 'up'], ['name' => 'environment', 'environment' => 'Could not determine']]),
+            $response->getContent()
+        );
+    }
+
+    public function testEnvironmentCheckSuccess(): void
+    {
+        $healthController = new HealthController();
+        $healthController->addHealthCheck(new EnvironmentCheck(static::bootKernel()->getContainer()));
+        $response = $healthController->healthCheckAction();
+
+        self::assertSame(200, $response->getStatusCode());
+        self::assertSame(
+            json_encode([['name' => 'environment', 'environment' => 'testing']]),
+            $response->getContent()
+        );
+    }
+
+    public function testAddCheckFailed(): void
+    {
+        self::expectException(TypeError::class);
+
+        $healthController = new HealthController();
+        $healthController->addHealthCheck(new HealthController());
+    }
+}
diff --git a/tests/Integration/DependencyInjection/SymfonyHealthCheckExtensionTest.php b/tests/Integration/DependencyInjection/SymfonyHealthCheckExtensionTest.php
@@ -33,7 +33,7 @@ public function testWithEmptyConfig(): void
     public function testNotExistServiceConfig(): void
     {
         try {
-            $container = $this->createContainerFromFixture('error_bundle_config');
+            $this->createContainerFromFixture('error_bundle_config');
         } catch (Throwable $exception) {
             self::assertInstanceOf(ServiceNotFoundException::class, $exception);
             self::assertSame(

diff --git a/tests/Integration/Mock/ConnectionMock.php b/tests/Integration/Mock/ConnectionMock.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SymfonyHealthCheckBundle\Tests\Integration\Mock;
+
+class ConnectionMock
+{
+    public function ping(): bool
+    {
+        return true;
+    }
+}
diff --git a/tests/Integration/Mock/EntityManagerMock.php b/tests/Integration/Mock/EntityManagerMock.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SymfonyHealthCheckBundle\Tests\Integration\Mock;
+
+class EntityManagerMock
+{
+    public function getConnection(): ConnectionMock
+    {
+        return new ConnectionMock();
+    }
+}
diff --git a/tests/Integration/Unit/Check/DoctrineCheckTest.php b/tests/Integration/Unit/Check/DoctrineCheckTest.php
@@ -0,0 +1,133 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SymfonyHealthCheckBundle\Tests\Integration\Unit\Check;
+
+use Exception;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use SymfonyHealthCheckBundle\Check\DoctrineCheck;
+use SymfonyHealthCheckBundle\Check\StatusUpCheck;
+use SymfonyHealthCheckBundle\Exception\ServiceNotFoundException;
+use SymfonyHealthCheckBundle\Tests\Integration\Mock\ConnectionMock;
+use SymfonyHealthCheckBundle\Tests\Integration\Mock\EntityManagerMock;
+
+class DoctrineCheckTest extends TestCase
+{
+    public function testStatusUpCheckSuccess(): void
+    {
+        $result = (new StatusUpCheck())->check();
+
+        self::assertIsArray($result);
+        self::assertNotEmpty($result);
+        self::assertArrayHasKey('status', $result);
+        self::assertSame('up', $result['status']);
+    }
+
+    public function testDoctrineHasNotFoundException(): void
+    {
+        $container = $this->createMock(ContainerInterface::class);
+
+        $container
+            ->method('has')
+            ->with('doctrine.orm.entity_manager')
+            ->willReturn(false);
+
+        $this->expectException(ServiceNotFoundException::class);
+        $this->expectExceptionMessage('Entity Manager Not Found.');
+
+        $doctrine = new DoctrineCheck($container);
+
+        $doctrine->check();
+    }
+
+    public function testDoctrineGetNotFoundException(): void
+    {
+        $container = $this->createMock(ContainerInterface::class);
+
+        $container
+            ->method('has')
+            ->with('doctrine.orm.entity_manager')
+            ->willReturn(true);
+
+        $container
+            ->method('get')
+            ->with('doctrine.orm.entity_manager')
+            ->willReturn(null);
+
+        $this->expectException(ServiceNotFoundException::class);
+        $this->expectExceptionMessage('Entity Manager Not Found.');
+
+        $doctrine = new DoctrineCheck($container);
+
+        $doctrine->check();
+    }
+
+    public function testDoctrineSuccess(): void
+    {
+        $container = $this->createMock(ContainerInterface::class);
+        $entityManager = $this->createMock(EntityManagerMock::class);
+
+        $container
+            ->method('has')
+            ->with('doctrine.orm.entity_manager')
+            ->willReturn(true);
+
+        $container
+            ->method('get')
+            ->with('doctrine.orm.entity_manager')
+            ->willReturn($entityManager);
+
+        $doctrine = new DoctrineCheck($container);
+
+        $result = $doctrine->check();
+
+        self::assertIsArray($result);
+        self::assertNotEmpty($result);
+        self::assertArrayHasKey('name', $result);
+        self::assertArrayHasKey('connection', $result);
+        self::assertSame('doctrine', $result['name']);
+        self::assertIsBool($result['connection']);
+        self::assertTrue($result['connection']);
+    }
+
+    public function testDoctrineFailPing(): void
+    {
+        $container = $this->createMock(ContainerInterface::class);
+        $entityManager = $this->createMock(EntityManagerMock::class);
+        $connectionMock = $this->createMock(ConnectionMock::class);
+
+        $entityManager
+            ->method('getConnection')
+            ->with()
+            ->willReturn($connectionMock);
+
+        $connectionMock
+            ->method('ping')
+            ->with()
+            ->will(self::throwException(new Exception()));
+
+        $container
+            ->method('has')
+            ->with('doctrine.orm.entity_manager')
+            ->willReturn(true);
+
+        $container
+            ->method('get')
+            ->with('doctrine.orm.entity_manager')
+            ->willReturn($entityManager);
+
+        $doctrine = new DoctrineCheck($container);
+
+        $result = $doctrine->check();
+
+        self::assertIsArray($result);
+        self::assertNotEmpty($result);
+        self::assertArrayHasKey('name', $result);
+        self::assertArrayHasKey('connection', $result);
+        self::assertSame('doctrine', $result['name']);
+        self::assertIsBool($result['connection']);
+        self::assertFalse($result['connection']);
+    }
+}