First commit generating the basic structure to work

Author: DEVizzent

.gitignore

@@ -0,0 +1,3 @@
+vendor
+.idea
+composer.lock

Makefile

@@ -0,0 +1,43 @@
+
+SHELL:=/bin/bash
+.DEFAULT_GOAL:=help
+.PHONY: help install up code-sniff code-format code-find-bugs code-find-bugs code-find-smells
+PHP_CONTAINER_NAME=php
+
+help:  ## Display this help
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n\nTargets:\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf "  \033[36m%-25s\033[0m %s\n", $$1, $$2 }' $(MAKEFILE_LIST)
+
+
+install: composer-install up  ## Install required software and initialize your local configuration
+
+up:  ## Start application containers and required services
+	@docker-compose up -d
+
+down:  ## Stop application containers and required services
+	@docker-compose down
+
+console:  ## Execute php container console
+	@docker exec -it ${PHP_CONTAINER_NAME} bash
+
+test:  ## Execute all phpunit test
+	@docker-compose exec ${PHP_CONTAINER_NAME} ./vendor/bin/phpunit
+
+code-sniff cs:  ## Detect coding standard violations in all project files using code sniffer
+	@docker-compose exec ${PHP_CONTAINER_NAME} ./vendor/bin/phpcs
+
+code-format cf:  ## Fix coding standard violations in all project files
+	@docker-compose exec ${PHP_CONTAINER_NAME} ./vendor/bin/phpcbf
+
+code-find-bugs phpstan:  ## Run static analysis tool to find possible bugs using phpstan
+	@docker-compose exec ${PHP_CONTAINER_NAME} ./vendor/bin/phpstan analyse
+
+code-find-smells md:  ## Run static analysis tool to find code smells using mess detector
+	@docker-compose exec ${PHP_CONTAINER_NAME} ./vendor/bin/phpmd src,tests text phpmd.xml --suffixes php --exclude src/Infrastructure/Persistence/Doctrine/Migrations,tests/_support,tests/acceptance
+
+composer-update:  ## Run composer update
+	@docker run --rm --interactive --tty --volume $PWD:/app composer update
+
+composer-install:  ## Run composer update
+	@docker run --rm --interactive --tty --volume $PWD:/app composer install
+
+

composer.json

@@ -0,0 +1,30 @@
+{
+  "name": "devizzent/codeception-mockserver-helper",
+  "description": "Codeception helper to manage and verify MockServer expectations",
+  "type": "dev",
+  "license": "library",
+  "autoload": {
+    "psr-4": {
+      "DEVizzent\\CodeceptionMockServerHelper\\": "src/"
+    }
+  },
+  "authors": [
+    {
+      "name": "Vicent Valls",
+      "email": "vizzent@gmail.com",
+      "role": "creator"
+    }
+  ],
+  "minimum-stability": "stable",
+  "require": {
+    "php": "7.4.*||8.*",
+    "guzzlehttp/guzzle": "^7.0",
+    "codeception/codeception": "4.*||5.*",
+    "phpunit/phpunit": "8.* || 9.*"
+  },
+  "require-dev": {
+    "phpmd/phpmd": "2.*",
+    "phpstan/phpstan": "1.*",
+    "squizlabs/php_codesniffer": "3.*"
+  }
+}

docker-compose.yml

@@ -0,0 +1,12 @@
+version: "3"
+services:
+  php:
+    container_name: php
+    build:
+      dockerfile: docker/php/Dockerfile
+      context: .
+    volumes:
+      - .:/app
+    tty: true
+  mockserver:
+    image: mockserver/mockserver

docker/php/Dockerfile

@@ -0,0 +1,3 @@
+FROM php:8.1
+
+WORKDIR /app

phpunit.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         cacheResultFile="var/phpunit/test-results"
+         executionOrder="depends,defects"
+         forceCoversAnnotation="true"
+         beStrictAboutCoversAnnotation="true"
+         beStrictAboutOutputDuringTests="true"
+         beStrictAboutTodoAnnotatedTests="true"
+         convertDeprecationsToExceptions="true"
+         failOnRisky="true"
+         failOnWarning="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="default">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <coverage cacheDirectory="var/phpunit//code-coverage"
+              processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>

src/MockServerHelper.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace DEVizzent\CodeceptionMockServerHelper;
+
+use Codeception\Module;
+use GuzzleHttp\Client;
+use GuzzleHttp\Psr7\Request;
+use PHPUnit\Framework\Assert;
+
+class MockServerHelper extends Module
+{
+    private Client $mockserverClient;
+
+    public function __construct()
+    {
+        $this->mockserverClient = new Client(['base_uri'  => 'http://mockserver:1080']);
+    }
+
+    public function seeMockRequestWasCalled(string $expectationId, int $times = 1): void
+    {
+        $body = [
+            'expectationId' => ['id' => $expectationId],
+            'times' => ['atLeast' => $times, 'atMost' => $times]
+        ];
+        $request = new Request('PUT', '/mockserver/verify', [], json_encode($body));
+        $response = $this->mockserverClient->sendRequest($request);
+        Assert::assertEquals(
+            202,
+            $response->getStatusCode(),
+            $response->getBody()->getContents()
+        );
+    }
+
+}

tests/Integration/SeeMockRequestWasCalledTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Integration;
+
+use DEVizzent\CodeceptionMockServerHelper\MockServerHelper;
+use PHPUnit\Framework\TestCase;
+
+class SeeMockRequestWasCalledTest extends TestCase
+{
+    private MockServerHelper $sot;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->sot = new MockServerHelper();
+    }
+
+    public function testExpectationNotWasCalledThrowException(): void
+    {
+        $this->sot->seeMockRequestWasCalled('some-expectation');
+    }
+}