Replace Guzzle MockHandler with Wiremock in HTTP tests

Author: JMLamodiere

.travis.yml

@@ -27,6 +27,7 @@ branches:
     - bad_implementation
     - bad_tests
     - integration_infra_medium_domain
+    - integration_infra_medium_domain_wiremock
 
 before_install:
   - make preinstall

README.md

@@ -20,6 +20,10 @@ Many obscure changes are required in the tests, proving they do not help much du
 [(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. [integration_infra_medium_domain_wiremock](https://github.com/JMLamodiere/tdd-demo-forumphp2020/tree/integration_infra_medium_domain_wiremock) branch
+[(see Pull Request)](https://github.com/JMLamodiere/tdd-demo-forumphp2020/pull/14)
+only replaces [Guzzle MockHandler](https://docs.guzzlephp.org/en/stable/testing.html) with [Wiremock](#wiremock),
+decoupling HTTP tests with the library being used for HTTP calls.
 1. (todo...)
 
 ## API documentation

behat.yml.dist

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

config/packages/test/services.yaml

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

features/bootstrap/FeatureContext.php

@@ -11,20 +11,19 @@
 
 class FeatureContext implements Context
 {
-    // See .env.test
-    private const ACCUWEATHER_API_KEY = 'accuweatherTestKey';
-
     private KernelInterface $kernel;
     private Connection $dbal;
     private WireMock $wireMock;
     private ?Response $response;
+    private string $accuweatherApiKey;
 
-    public function __construct(KernelInterface $kernel, Connection $dbal, WireMock $wireMock)
+    public function __construct(KernelInterface $kernel, Connection $dbal, WireMock $wireMock, string $accuweatherApiKey)
     {
         $this->kernel = $kernel;
         $this->wireMock = $wireMock;
         Assert::assertTrue($this->wireMock->isAlive(), 'Wiremock should be alive');
         $this->dbal = $dbal;
+        $this->accuweatherApiKey = $accuweatherApiKey;
     }
 
     /**
@@ -41,7 +40,7 @@ public function resetState()
      */
     public function currentTemperatureIs($temperature)
     {
-        $uri = '/currentconditions/v1/623?apikey='.self::ACCUWEATHER_API_KEY;
+        $uri = '/currentconditions/v1/623?apikey='.$this->accuweatherApiKey;
         $body = <<<EOD
 [{
 	"LocalObservationDateTime": "2020-10-17T17:50:00+02:00",

tests/Infrastructure/Http/RestWeatherProviderTest.php

@@ -5,43 +5,35 @@
 namespace App\Infrastructure\Http;
 
 use App\Domain\CannotGetCurrentTemperature;
-use GuzzleHttp\Client;
-use GuzzleHttp\Exception\RequestException;
-use GuzzleHttp\Handler\MockHandler;
-use GuzzleHttp\HandlerStack;
-use GuzzleHttp\Promise\PromiseInterface;
-use GuzzleHttp\Psr7\Request;
-use GuzzleHttp\Psr7\Response;
-use PHPUnit\Framework\TestCase;
-use Prophecy\PhpUnit\ProphecyTrait;
-use Psr\Http\Message\ResponseInterface;
-use Throwable;
-
-class RestWeatherProviderTest extends TestCase
-{
-    use ProphecyTrait;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use WireMock\Client\WireMock;
 
-    private MockHandler $guzzleMockHandler;
-    private string $apiKey;
+class RestWeatherProviderTest extends KernelTestCase
+{
     private RestWeatherProvider $provider;
+    private WireMock $wireMock;
+    private string $currentConditionUri;
 
     protected function setUp(): void
     {
-        $this->guzzleMockHandler = new MockHandler();
-        $guzzleClient = new Client(['handler' => new HandlerStack($this->guzzleMockHandler)]);
-
-        $this->apiKey = 'key';
-        $this->provider = new RestWeatherProvider(
-            $guzzleClient,
-            $this->apiKey,
-            new CurrentConditionDeserializer()
-        );
+        self::bootKernel();
+
+        $this->provider = self::$container->get(RestWeatherProvider::class);
+
+        $this->wireMock = self::$container->get(WireMock::class);
+        self::assertTrue($this->wireMock->isAlive(), 'Wiremock should be alive');
+
+        $accuweatherApiKey = self::$container->getParameter('accuweather.apikey');
+        $this->currentConditionUri = '/currentconditions/v1/623?apikey='.$accuweatherApiKey;
     }
 
     public function testTemperatureIsExtractedFrom200Response()
     {
         // Given (Arrange)
-        $this->givenAccuWeatherResponseIs(new Response(200, ['Content-Type' => 'application/json'], <<<EOD
+        $this->wireMock->stubFor(WireMock::get(WireMock::urlEqualTo($this->currentConditionUri))
+            ->willReturn(WireMock::aResponse()
+                ->withHeader('Content-Type', 'application/json')
+                ->withBody(<<<EOD
 [{
 	"LocalObservationDateTime": "2020-10-17T17:50:00+02:00",
 	"EpochTime": 1602949800,
@@ -65,23 +57,21 @@ public function testTemperatureIsExtractedFrom200Response()
 	"MobileLink": "http://m.accuweather.com/en/fr/paris/623/current-weather/623?lang=en-us",
 	"Link": "http://www.accuweather.com/en/fr/paris/623/current-weather/623?lang=en-us"
 }]
-EOD));
+EOD)));
 
         // When (Act)
         $result = $this->provider->getCurrentCelciusTemperature();
 
         // Then (Assert)
         self::assertSame(37.2, $result);
-
-        $this->thenRequestSentShouldHaveBeen('GET', 'currentconditions/v1/623?apikey='.$this->apiKey);
     }
 
     public function test404ResponseIsConvertedToDomainException()
     {
         // Given (Arrange)
-        $this->givenAccuWeatherResponseIs(RequestException::create(
-            new Request('GET', 'uri'),
-            new Response(404)
+        $this->wireMock->stubFor(WireMock::get(WireMock::urlEqualTo($this->currentConditionUri))
+            ->willReturn(WireMock::aResponse()
+                ->withStatus(404)
         ));
 
         // Then (Assert)
@@ -94,29 +84,15 @@ public function test404ResponseIsConvertedToDomainException()
     public function testInvalidBodyIsConvertedToDomainException()
     {
         // Given (Arrange)
-        $this->givenAccuWeatherResponseIs(
-            new Response(200, ['Content-Type' => 'application/json'], 'invalid body')
-        );
+        $this->wireMock->stubFor(WireMock::get(WireMock::urlEqualTo($this->currentConditionUri))
+            ->willReturn(WireMock::aResponse()
+                ->withHeader('Content-Type', 'application/json')
+                ->withBody('invalid body')));
 
         // Then (Assert)
         $this->expectException(CannotGetCurrentTemperature::class);
 
         // When (Act)
         $this->provider->getCurrentCelciusTemperature();
     }
-
-    /**
-     * @param ResponseInterface|Throwable|PromiseInterface|callable $response
-     */
-    private function givenAccuWeatherResponseIs($response)
-    {
-        $this->guzzleMockHandler->append($response);
-    }
-
-    private function thenRequestSentShouldHaveBeen(string $method, string $uri)
-    {
-        $requestSent = $this->guzzleMockHandler->getLastRequest();
-        self::assertSame($method, $requestSent->getMethod());
-        self::assertSame($uri, (string) $requestSent->getUri());
-    }
 }