mock secondary (hexagonal) ports in behat (PHP's cucumber)

Author: JMLamodiere

.travis.yml

@@ -30,6 +30,7 @@ branches:
     - integration_infra_medium_domain_wiremock
     - integration_infra_medium_domain_no_di
     - integration_infra_sociable
+    - mock_secondary_ports_in_behat
 
 before_install:
   - make preinstall

README.md

@@ -35,7 +35,12 @@ decoupling HTTP tests with the library being used for HTTP calls.
    replaces medium sized tests with [Overlapping Sociable Tests](https://www.jamesshore.com/v2/blog/2018/testing-without-mocks#sociable-tests)
    to allow easily test and evolve individual behaviours (ex : class serialization) while still being able to
    split/merge/refactor classes inside some class clusters by not checking specific calls between them.
-1. (todo...)
+1. [mock_secondary_ports_in_behat](https://github.com/JMLamodiere/tdd-demo-forumphp2020/tree/mock_secondary_ports_in_behat) branch
+   [(see Pull Request)](https://github.com/JMLamodiere/tdd-demo-forumphp2020/pull/18): Mock Secondary Ports
+   (according to [Hexagonal architecture](https://alistair.cockburn.us/hexagonal-architecture/)) in
+   [Behat](https://behat.org). Makes behat tests much faster and
+   easier to write. Pre-requisite : well defined secondary ports and Integration tests on their
+   Infrastructure layer implementation.
 
 ## API documentation
 

behat.yml.dist

@@ -4,9 +4,6 @@ default:
             contexts:
                 - FeatureContext:
                     kernel: '@kernel'
-                    dbal: '@doctrine.dbal.default_connection'
-                    wireMock: '@WireMock\Client\WireMock'
-                    accuweatherApiKey: '%%accuweather.apikey%%'
 
     extensions:
         Behat\Symfony2Extension:

config/packages/test/services.yaml

@@ -1,7 +1,3 @@
-parameters:
-    # See .env.test
-    accuweather.apikey: '%env(ACCUWEATHER_API_KEY)%'
-
 services:
     # default configuration for services in *this* file
     _defaults:

config/services.yaml

@@ -32,6 +32,12 @@ services:
     App\Application\Command\RegisterRunningSessionHandler:
         public: true
 
+    # Mark Secondary Ports (Hexagonal Architecture meaning) public to allow mocking them in behat tests
+    App\Domain\WeatherProvider:
+        public: true
+    App\Domain\RunningSessionRepository:
+        public: true
+
     guzzle.accuweather:
         class: GuzzleHttp\Client
         arguments:

features/bootstrap/BehatProphecyTrait.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+use Prophecy\Prophecy\ObjectProphecy;
+use Prophecy\Prophet;
+
+trait BehatProphecyTrait
+{
+    private ?Prophet $prophet = null;
+
+    protected function prophesize(?string $classOrInterface = null): ObjectProphecy
+    {
+        if (null === $this->prophet) {
+            $this->prophet = new Prophet();
+        }
+
+        return $this->prophet->prophesize($classOrInterface);
+    }
+
+    /**
+     * @AfterScenario
+     */
+    public function verifyProphecyDoubles(): void
+    {
+        if (null === $this->prophet) {
+            return;
+        }
+
+        $this->prophet->checkPredictions();
+    }
+}

features/bootstrap/FeatureContext.php

@@ -1,55 +1,46 @@
 <?php
 
-use App\Infrastructure\Database\PostgresRunningSessionRepository;
-use App\Infrastructure\Database\PostgresRunningSessionRepositoryTest;
-use App\Infrastructure\Http\CurrentConditionDeserializerTest;
+use App\Domain\RunningSessionFactory;
+use App\Domain\RunningSessionRepository;
+use App\Domain\WeatherProvider;
 use App\Infrastructure\Symfony\Serializer\RegisterRunningSessionDeserializerTest;
 use Behat\Behat\Context\Context;
-use Doctrine\DBAL\Connection;
 use PHPUnit\Framework\Assert;
+use Prophecy\Prophecy\ObjectProphecy;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\KernelInterface;
-use WireMock\Client\WireMock;
 
 class FeatureContext implements Context
 {
+    use BehatProphecyTrait;
+
     private KernelInterface $kernel;
-    private Connection $dbal;
-    private WireMock $wireMock;
     private ?Response $response;
-    private string $accuweatherApiKey;
+    /** @var ObjectProphecy|WeatherProvider */
+    private $weatherProvider;
+    /** @var ObjectProphecy|RunningSessionRepository */
+    private $runningSessionRepository;
 
-    public function __construct(KernelInterface $kernel, Connection $dbal, WireMock $wireMock, string $accuweatherApiKey)
+    public function __construct(KernelInterface $kernel)
     {
         $this->kernel = $kernel;
-        $this->wireMock = $wireMock;
-        Assert::assertTrue($this->wireMock->isAlive(), 'Wiremock should be alive');
-        $this->dbal = $dbal;
-        $this->accuweatherApiKey = $accuweatherApiKey;
-    }
 
-    /**
-     * @BeforeScenario
-     */
-    public function resetState()
-    {
-        $this->wireMock->reset();
-        $this->dbal->executeStatement('TRUNCATE TABLE '.PostgresRunningSessionRepository::TABLE_NAME);
+        $this->weatherProvider = $this->prophesize(WeatherProvider::class);
+        $kernel->getContainer()->set(WeatherProvider::class, $this->weatherProvider->reveal());
+
+        $this->runningSessionRepository = $this->prophesize(RunningSessionRepository::class);
+        $kernel->getContainer()->set(RunningSessionRepository::class, $this->runningSessionRepository->reveal());
     }
 
     /**
      * @Given current temperature is :temperature celcius degrees
      */
     public function currentTemperatureIs($temperature)
     {
-        $uri = '/currentconditions/v1/623?apikey='.$this->accuweatherApiKey;
-        $body = CurrentConditionDeserializerTest::createBody($temperature);
-
-        $this->wireMock->stubFor(WireMock::get(WireMock::urlEqualTo($uri))
-            ->willReturn(WireMock::aResponse()
-                ->withHeader('Content-Type', 'application/json')
-                ->withBody($body)));
+        $this->weatherProvider
+            ->getCurrentCelciusTemperature()
+            ->willReturn($temperature);
     }
 
     /**
@@ -69,10 +60,14 @@ public function iRegisterARunningSessionWith($id, $distance, $shoes)
     public function aRunningSessionShouldBeAddedWith($id, $distance, $shoes, $temperature)
     {
         Assert::assertEquals(201, $this->response->getStatusCode());
-        PostgresRunningSessionRepositoryTest::thenRunningSessionTableShouldContain($this->dbal, $id, [
-            'distance' => $distance,
-            'shoes' => $shoes,
-            'temperature_celcius' => $temperature,
-        ]);
+
+        $this->runningSessionRepository
+            ->add(RunningSessionFactory::create(
+                $id,
+                $distance,
+                $shoes,
+                $temperature
+            ))
+            ->shouldHaveBeenCalled();
     }
 }

tests/Infrastructure/Database/PostgresRunningSessionRepositoryTest.php

@@ -43,7 +43,7 @@ public function testRunningSessionIsInserted()
         $this->repository->add($session);
 
         //Then (Assert)
-        self::thenRunningSessionTableShouldContain($this->dbal, 55, [
+        self::thenRunningSessionTableShouldContain(55, [
             'distance' => 122.3,
             'shoes' => 'The shoes!',
             'temperature_celcius' => 34.5,
@@ -54,9 +54,9 @@ public function testRunningSessionIsInserted()
      * @throws \Doctrine\DBAL\Exception
      * @throws ExpectationFailedException
      */
-    public static function thenRunningSessionTableShouldContain(Connection $dbal, int $id, array $expectedArray): void
+    private function thenRunningSessionTableShouldContain(int $id, array $expectedArray): void
     {
-        $row = $dbal->fetchAssociative(
+        $row = $this->dbal->fetchAssociative(
             'SELECT distance, shoes, temperature_celcius '
             .' FROM RUNNING_SESSION'
             .' WHERE ID = :id', [':id' => $id]);