Integration tests for Infrastructure, medium unit tests for Domain

Author: JMLamodiere

.travis.yml

@@ -21,10 +21,12 @@ jobs:
   fast_finish: true
 
 branches:
+  # Those branch will not be deleted. We want push to them without a Pull Request, but trigger the CI anyway
   only:
     - main
     - bad_implementation
     - bad_tests
+    - integration_infra_medium_domain
 
 before_install:
   - make preinstall

README.md

@@ -16,6 +16,10 @@ contains :
 1. [bad_tests](https://github.com/JMLamodiere/tdd-demo-forumphp2020/tree/bad_tests) branch
 [(see Pull Request)](https://github.com/JMLamodiere/tdd-demo-forumphp2020/pull/12) only fixes (some) hexagonal mistakes.
 Many obscure changes are required in the tests, proving they do not help much during refactoring
+1. [integration_infra_medium_domain](https://github.com/JMLamodiere/tdd-demo-forumphp2020/tree/integration_infra_medium_domain) branch
+[(see Pull Request)](https://github.com/JMLamodiere/tdd-demo-forumphp2020/pull/13) split tests this way:
+    - Domain logic (Application/Domain folders): medium Unit tests, mocking only infrastructure
+    - Technical logic (Infrastructure folder): integration tests for each specific technology
 1. (todo...)
 
 ## API documentation

config/services.yaml

@@ -27,6 +27,11 @@ services:
 
     # add more service definitions when explicit configuration is needed
     # please note that last definitions always *replace* previous ones
+
+    # Mark Command/Query handlers public to allow mocking them in controller tests
+    App\Application\Command\RegisterRunningSessionHandler:
+        public: true
+
     guzzle.accuweather:
         class: GuzzleHttp\Client
         arguments:

docs/openapi.yml

@@ -60,7 +60,8 @@ components:
       required: [ temperatureCelcius ]
       properties:
         temperatureCelcius:
-          type: integer
+          type: float
+          example: 37.2
 
     RunningSessionId:
       type: integer

tests/Application/Command/RegisterRunningSessionHandlerTest.php

@@ -8,7 +8,6 @@
 use App\Domain\RunningSessionRepository;
 use App\Domain\WeatherProvider;
 use PHPUnit\Framework\TestCase;
-use Prophecy\Argument;
 use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 
@@ -33,28 +32,43 @@ protected function setUp(): void
         );
     }
 
-    public function testHandle()
+    public function testTheRunningSessionIRegisterIsEnrichedWithCurrentWeatherData()
     {
-        $temperature = 15.5;
-        /** @var ObjectProphecy|RegisterRunningSession $command */
-        $command = $this->prophesize(RegisterRunningSession::class);
-        $command->getId()
-            ->shouldBeCalledTimes(1)
-            ->willReturn(12);
-        $command->getDistance()
-            ->shouldBeCalledTimes(1)
-            ->willReturn(25.7);
-        $command->getShoes()
-            ->shouldBeCalledTimes(1)
-            ->willReturn('shoes');
-
-        $this->weatherProvider->getCurrentCelciusTemperature()
-            ->shouldBeCalledTimes(1)
+        //Given (Arrange)
+        $this->givenCrrentTemperatureIs(15.5);
+
+        //When (Act)
+        $this->whenIRegisterARunningSession(new RegisterRunningSession(
+            12,
+            125.7,
+            'shoes'
+        ));
+
+        //Then (Assert)
+        $this->thenARunningSessionShouldBeAdded(new RunningSession(
+            12,
+            125.7,
+            'shoes',
+            15.5
+        ));
+    }
+
+    private function givenCrrentTemperatureIs(float $temperature): void
+    {
+        $this->weatherProvider
+            ->getCurrentCelciusTemperature()
             ->willReturn($temperature);
+    }
 
-        $this->repository->add(Argument::type(RunningSession::class))
-            ->shouldBeCalledTimes(1);
+    private function whenIRegisterARunningSession(RegisterRunningSession $command): void
+    {
+        $this->handler->handle($command);
+    }
 
-        $this->handler->handle($command->reveal());
+    private function thenARunningSessionShouldBeAdded(RunningSession $expectedAddedEntity)
+    {
+        $this->repository
+            ->add($expectedAddedEntity)
+            ->shouldHaveBeenCalled();
     }
 }

tests/Application/Command/RegisterRunningSessionTest.php

@@ -6,75 +6,56 @@
 
 use App\Domain\RunningSession;
 use Doctrine\DBAL\Connection;
-use Doctrine\DBAL\Query\QueryBuilder;
-use PHPUnit\Framework\TestCase;
-use Prophecy\Argument;
-use Prophecy\PhpUnit\ProphecyTrait;
-use Prophecy\Prophecy\ObjectProphecy;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 
-class PostgresRunningSessionRepositoryTest extends TestCase
+/**
+ * @group integration
+ */
+class PostgresRunningSessionRepositoryTest extends KernelTestCase
 {
-    use ProphecyTrait;
-
-    /** @var ObjectProphecy|Connection */
-    private $dbal;
-
+    private Connection $dbal;
     private PostgresRunningSessionRepository $repository;
 
     protected function setUp(): void
     {
-        $this->dbal = $this->prophesize(Connection::class);
-        $this->repository = new PostgresRunningSessionRepository($this->dbal->reveal());
+        self::bootKernel();
+        $this->dbal = self::$container->get('doctrine.dbal.default_connection');
+        $this->repository = self::$container->get(PostgresRunningSessionRepository::class);
+        $this->resetState();
     }
 
-    public function testAdd()
+    private function resetState(): void
     {
-        /** @var ObjectProphecy|QueryBuilder $queryBuilder */
-        $queryBuilder = $this->prophesize(QueryBuilder::class);
-
-        /** @var ObjectProphecy|RunningSession $session */
-        $session = $this->prophesize(RunningSession::class);
-        $session->getId()
-            ->shouldBeCalledTimes(1)
-            ->willReturn($id = 12);
-        $session->getDistance()
-            ->shouldBeCalledTimes(1)
-            ->willReturn($distance = 25.7);
-        $session->getShoes()
-            ->shouldBeCalledTimes(1)
-            ->willReturn($shoes = 'shoes');
-        $session->getMetricTemperature()
-            ->shouldBeCalledTimes(1)
-            ->willReturn($temperature = 25.3);
-
-        $this->dbal->createQueryBuilder()
-            ->shouldBeCalledTimes(1)
-            ->willReturn($queryBuilder);
+        $this->dbal->executeStatement('TRUNCATE TABLE '.PostgresRunningSessionRepository::TABLE_NAME);
+    }
 
-        $queryBuilder->insert(PostgresRunningSessionRepository::TABLE_NAME)
-            ->shouldBeCalledTimes(1)
-            ->willReturn($queryBuilder);
+    public function testRunningSessionIsInserted()
+    {
+        //When (Act)
+        $session = new RunningSession(55, 122.3, 'The shoes!', 34.5);
+        $this->repository->add($session);
+
+        //Then (Assert)
+        $this->thenRunningSessionTableShouldContain(55, [
+            //DB result will be strings
+            'distance' => '122.3',
+            'shoes' => 'The shoes!',
+            'temperature_celcius' => '34.5',
+        ]);
+    }
 
-        $queryBuilder->setValue(Argument::cetera())
-            ->shouldBeCalledTimes(4)
-            ->willReturn($queryBuilder);
+    private function thenRunningSessionTableShouldContain(int $id, array $expectedArray)
+    {
+        $row = $this->dbal->fetchAssociative(
+            'SELECT distance, shoes, temperature_celcius '
+            .' FROM RUNNING_SESSION'
+            .' WHERE ID = :id', [':id' => $id]);
 
-        $queryBuilder->setParameter(':id', $id)
-            ->shouldBeCalledTimes(1)
-            ->willReturn($queryBuilder);
-        $queryBuilder->setParameter(':distance', $distance)
-            ->shouldBeCalledTimes(1)
-            ->willReturn($queryBuilder);
-        $queryBuilder->setParameter(':shoes', $shoes)
-            ->shouldBeCalledTimes(1)
-            ->willReturn($queryBuilder);
-        $queryBuilder->setParameter(':celcius', $temperature)
-            ->shouldBeCalledTimes(1)
-            ->willReturn($queryBuilder);
-        $queryBuilder->execute()
-            ->shouldBeCalledTimes(1)
-            ->willReturn(1);
+        self::assertIsArray($row, 'No session found with this id');
 
-        $this->repository->add($session->reveal());
+        //Avoid failing if key order is different
+        asort($row);
+        asort($expectedArray);
+        self::assertSame($expectedArray, $row);
     }
 }