Merge pull request #4 from MacPaw/feat/rewriteAsBundle

IiiigorGG · web-flow · commit 5a706defaf4d · 2022-01-17T13:06:50.000+02:00
feat: rewrite as bundle
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -16,6 +16,7 @@ jobs:
                     - '8.1'
                 coverage: ['none']
                 symfony-versions:
+                    - '4.4.*'
                     - '5.1.*'
                     - '5.2.*'
                     - '5.3.*'
@@ -60,8 +61,10 @@ jobs:
             - name: Update Symfony version
               if: matrix.symfony-versions != ''
               run: |
-                  composer require symfony/messenger:${{ matrix.symfony-versions }} --no-update --no-scripts
-                  composer require symfony/serializer:${{ matrix.symfony-versions }} --no-update --no-scripts
+                  composer require symfony/http-client:${{ matrix.symfony-versions }} --no-update --no-scripts
+                  composer require symfony/cache:${{ matrix.symfony-versions }} --no-update --no-scripts
+                  composer require symfony/dependency-injection:${{ matrix.symfony-versions }} --no-update --no-scripts
+                  composer require symfony/http-kernel:${{ matrix.symfony-versions }} --no-update --no-scripts
 
             - name: Install dependencies
               run: composer install
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,6 @@
 /composer.lock
 /build/
 /.phpunit.result.cache
-
+/.idea/
 /node_modules/
 /package-lock.json
diff --git a/README.md b/README.md
@@ -8,21 +8,51 @@ Behat HTTP Mock Context
 Installation
 ============
 
-Step 1: Install Context
+Step 1: Download the Bundle
 ----------------------------------
 Open a command console, enter your project directory and execute:
 
+###  Applications that use Symfony Flex [in progress]
 ```console
 $ composer require --dev macpaw/behat-http-mock-context
 ```
 
-Step 2: Update Container config to load Context
-----------------------------------
-In the `config/services_test.yaml` file of your project:
+### Applications that don't use Symfony Flex
 
-```yaml
-    BehatHttpMockContext\:
-        resource: '../vendor/macpaw/behat-http-mock-context/src/*'
+Open a command console, enter your project directory and execute the
+following command to download the latest stable version of this bundle:
+
+```console
+$ composer require --dev macpaw/behat-http-mock-context
+```  
+
+This command requires you to have Composer installed globally, as explained
+in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
+of the Composer documentation.
+
+
+Then, enable the bundle by adding it to the list of registered bundles
+in the `app/AppKernel.php` file of your project:
+
+```php
+<?php
+// app/AppKernel.php
+
+// ...
+class AppKernel extends Kernel
+{
+    public function registerBundles()
+    {
+        $bundles = array(
+            // ...
+            BehatHttpMockContext\BehatHttpMockContextBundle::class => ['test' => true],
+        );
+
+        // ...
+    }
+
+    // ...
+}
 ```
 
 Step 2: Mock http client
@@ -55,7 +85,7 @@ Now we ready add build mock collection
 ...
 ```
 
-Step 4: Configure Behat
+Step 3: Configure Behat
 =============
 Go to `behat.yml`
 
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
     "name": "macpaw/behat-http-mock-context",
-    "type": "library",
+    "type": "symfony-bundle",
     "description": "Behat Context in testing mock HTTP Response other service",
     "keywords": [
         "MacPaw",
@@ -23,9 +23,11 @@
     "require": {
         "php": "^8.0",
         "behat/behat": "^3.0",
-        "symfony/http-client": "^5.0 || ^6.0",
-        "symfony/cache": "^5.0 || ^6.0",
-        "macpaw/extended_mock_http_client": "^1.0 || ^2.0"
+        "symfony/http-client": "^4.4 || ^5.0 || ^6.0",
+        "symfony/cache": "^4.4 || ^5.0 || ^6.0",
+        "macpaw/extended_mock_http_client": "^1.0 || ^2.0",
+        "symfony/dependency-injection": "^4.4 || ^5.4 || ^6.0",
+        "symfony/http-kernel": "^4.4 || ^5.4 || ^6.0"
     },
     "require-dev": {
         "phpstan/phpstan": "^1.2",
diff --git a/src/BehatHttpMockContextBundle.php b/src/BehatHttpMockContextBundle.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BehatHttpMockContext;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+class BehatHttpMockContextBundle extends Bundle
+{
+}
diff --git a/src/Collection/ExtendedHttpMockClientCollection.php b/src/Collection/ExtendedHttpMockClientCollection.php
@@ -6,7 +6,7 @@
 
 use Symfony\Component\Cache\ResettableInterface;
 
-class ExtendedMockHttpClientCollection implements ResettableInterface
+class ExtendedHttpMockClientCollection implements ResettableInterface
 {
     /*** @param iterable $handlers */
     public function __construct(private iterable $handlers)
diff --git a/src/Context/HttpMockContext.php b/src/Context/HttpMockContext.php
@@ -4,7 +4,7 @@
 
 namespace BehatHttpMockContext\Context;
 
-use BehatHttpMockContext\Collection\ExtendedMockHttpClientCollection;
+use BehatHttpMockContext\Collection\ExtendedHttpMockClientCollection;
 use Behat\Behat\Context\Context;
 use Behat\Gherkin\Node\PyStringNode;
 use ExtendedMockHttpClient\Builder\RequestMockBuilder;
@@ -14,11 +14,11 @@
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpClient\Response\MockResponse;
 
-class MockContext implements Context
+class HttpMockContext implements Context
 {
     public function __construct(
         private ContainerInterface $container,
-        private ExtendedMockHttpClientCollection $extendedMockHttpClientCollection
+        private ExtendedHttpMockClientCollection $extendedHttpMockClientCollection
     ) {
     }
 
@@ -29,7 +29,7 @@ public function __construct(
      */
     public function afterScenario(): void
     {
-        foreach ($this->extendedMockHttpClientCollection->getHandlers() as $extendedMockHttpClient) {
+        foreach ($this->extendedHttpMockClientCollection->getHandlers() as $extendedMockHttpClient) {
             if (!($extendedMockHttpClient instanceof ExtendedMockHttpClient)) {
                 throw new RuntimeException('You should replace HTTP client service using ExtendedMockHttpClient');
             }
diff --git a/src/DependencyInjection/BehatHttpMockContextExtension.php b/src/DependencyInjection/BehatHttpMockContextExtension.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BehatHttpMockContext\DependencyInjection;
+
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
+use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
+
+class BehatHttpMockContextExtension extends Extension
+{
+    /**
+     * @param array<array> $configs
+     *
+     * {@inheritdoc}
+     */
+    public function load(array $configs, ContainerBuilder $container): void
+    {
+        $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
+        $loader->load('http_mock_context.xml');
+    }
+}
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BehatHttpMockContext\DependencyInjection;
+
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+
+class Configuration implements ConfigurationInterface
+{
+    public function getConfigTreeBuilder(): TreeBuilder
+    {
+        return new TreeBuilder('behat_http_mock_context');
+    }
+}
diff --git a/src/Resources/config/http_mock_context.xml b/src/Resources/config/http_mock_context.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance"
+    xsd:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service public="true" autowire="true" id="BehatHttpMockContext\Context\HttpMockContext" class="BehatHttpMockContext\Context\HttpMockContext">
+            <argument key="$container" type="service" id="test.service_container"/>
+            <argument key="$extendedHttpMockClientCollection" type="service" id="BehatHttpMockContext\Collection\ExtendedHttpMockClientCollection"/>
+        </service>
+        <service public="true" autowire="true" id="BehatHttpMockContext\Collection\ExtendedHttpMockClientCollection" class="BehatHttpMockContext\Collection\ExtendedHttpMockClientCollection">
+            <argument key="$handlers" type="tagged_iterator" tag="mock.http_client"/>
+        </service>
+    </services>
+</container>
diff --git a/tests/Integration/DependencyInjection/BehatHttpMockContextExtensionTest.php b/tests/Integration/DependencyInjection/BehatHttpMockContextExtensionTest.php
@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BehatHttpMockContext\Tests\Integration\DependencyInjection;
+
+use BehatHttpMockContext\Collection\ExtendedHttpMockClientCollection;
+use BehatHttpMockContext\Context\HttpMockContext;
+use BehatHttpMockContext\DependencyInjection\BehatHttpMockContextExtension;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
+
+class BehatHttpMockContextExtensionTest extends TestCase
+{
+    public function testWithDefaultConfig(): void
+    {
+        $container = $this->createContainerFromFixture('bundle_config');
+
+        $collectionDefinition = $container->getDefinition(ExtendedHttpMockClientCollection::class);
+        self::assertSame(ExtendedHttpMockClientCollection::class, $collectionDefinition->getClass());
+
+        $handlersArgument = $collectionDefinition->getArgument('$handlers');
+        self::assertInstanceOf(TaggedIteratorArgument::class, $handlersArgument);
+        self::assertSame(
+            'mock.http_client',
+            $handlersArgument->getTag()
+        );
+
+        $httpMockContextDefinition = $container->getDefinition(HttpMockContext::class);
+        self::assertSame(HttpMockContext::class, $httpMockContextDefinition->getClass());
+        self::assertSame(
+            'test.service_container',
+            (string) $httpMockContextDefinition->getArgument('$container')
+        );
+        self::assertSame(
+            ExtendedHttpMockClientCollection::class,
+            (string) $httpMockContextDefinition->getArgument('$extendedHttpMockClientCollection')
+        );
+    }
+
+    private function createContainerFromFixture(string $fixtureFile): ContainerBuilder
+    {
+        $container = new ContainerBuilder();
+
+        $container->registerExtension(new BehatHttpMockContextExtension());
+        $container->getCompilerPassConfig()->setOptimizationPasses([]);
+        $container->getCompilerPassConfig()->setRemovingPasses([]);
+        $container->getCompilerPassConfig()->setAfterRemovingPasses([]);
+
+        $this->loadFixture($container, $fixtureFile);
+
+        $container->compile();
+
+        return $container;
+    }
+
+    protected function loadFixture(ContainerBuilder $container, string $fixtureFile): void
+    {
+        $loader = new YamlFileLoader($container, new FileLocator(__DIR__ . '/../Fixtures'));
+        $loader->load($fixtureFile . '.yaml');
+    }
+}
diff --git a/tests/Integration/DependencyInjection/ConfigurationTest.php b/tests/Integration/DependencyInjection/ConfigurationTest.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BehatHttpMockContext\Tests\Integration\DependencyInjection;
+
+use PHPUnit\Framework\TestCase;
+use BehatHttpMockContext\DependencyInjection\Configuration;
+use Symfony\Component\Config\Definition\Processor;
+
+final class ConfigurationTest extends TestCase
+{
+    public function testProcessConfigurationWithDefaultConfiguration(): void
+    {
+        $expectedBundleDefaultConfig = [];
+
+        $this->assertSame($expectedBundleDefaultConfig, $this->processConfiguration([]));
+    }
+
+    private function processConfiguration(array $values): array
+    {
+        $processor = new Processor();
+
+        return $processor->processConfiguration(new Configuration(), ['behat_http_mock_context' => $values]);
+    }
+}
diff --git a/tests/Integration/Fixtures/bundle_config.yaml b/tests/Integration/Fixtures/bundle_config.yaml
@@ -0,0 +1 @@
+behat_http_mock_context:
diff --git a/tests/Unit/Collection/ExtendedMockHttpClientCollectionTest.php b/tests/Unit/Collection/ExtendedMockHttpClientCollectionTest.php
@@ -2,30 +2,30 @@
 
 declare(strict_types=1);
 
-namespace BehatHttpMockContext\Tests\Collection;
+namespace BehatHttpMockContext\Tests\Unit\Collection;
 
-use BehatHttpMockContext\Collection\ExtendedMockHttpClientCollection;
+use BehatHttpMockContext\Collection\ExtendedHttpMockClientCollection;
 use PHPUnit\Framework\TestCase;
 use TypeError;
 
 class ExtendedMockHttpClientCollectionTest extends TestCase
 {
     public function testSuccess(): void
     {
-        $clientCollection = new ExtendedMockHttpClientCollection([]);
+        $clientCollection = new ExtendedHttpMockClientCollection([]);
 
         $this->assertCount(0, $clientCollection->getHandlers());
     }
 
     public function testInitFailed(): void
     {
         $this->expectException(TypeError::class);
-        new ExtendedMockHttpClientCollection('string');
+        new ExtendedHttpMockClientCollection('string');
     }
 
     public function testSetHandlersSuccess(): void
     {
-        $clientCollection = new ExtendedMockHttpClientCollection([]);
+        $clientCollection = new ExtendedHttpMockClientCollection([]);
 
         $this->assertCount(0, $clientCollection->getHandlers());
 
@@ -37,15 +37,15 @@ public function testSetHandlersSuccess(): void
     public function testSetHandlersFailed(): void
     {
         $this->expectException(TypeError::class);
-        $clientCollection = new ExtendedMockHttpClientCollection([]);
+        $clientCollection = new ExtendedHttpMockClientCollection([]);
 
         $this->assertCount(0, $clientCollection->getHandlers());
         $clientCollection->setHandlers('string');
     }
 
     public function testResetSuccess(): void
     {
-        $clientCollection = new ExtendedMockHttpClientCollection([[]]);
+        $clientCollection = new ExtendedHttpMockClientCollection([[]]);
 
         $this->assertCount(1, $clientCollection->getHandlers());
 
diff --git a/tests/Unit/Context/MockContextTest.php b/tests/Unit/Context/MockContextTest.php

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`use Symfony\Component\Cache\ResettableInterface;`
`8`	`8`
`9`		`-class ExtendedMockHttpClientCollection implements ResettableInterface`
	`9`	`+class ExtendedHttpMockClientCollection implements ResettableInterface`
`10`	`10`	`{`
`11`	`11`	`/*** @param iterable $handlers */`
`12`	`12`	`public function __construct(private iterable $handlers)`