Merge pull request #42 from MacPaw/develop

Release

Author: Yozhef

README.md

@@ -1,31 +1,28 @@
-Behat Api Context Bundle
-=================================
+# Behat Api Context Bundle
 
 | Version | Build Status | Code Coverage |
 |:---------:|:-------------:|:-----:|
-| `master`| [![CI][master Build Status Image]][master Build Status] | [![Coverage Status][master Code Coverage Image]][master Code Coverage] |
-| `develop`| [![CI][develop Build Status Image]][develop Build Status] | [![Coverage Status][develop Code Coverage Image]][develop Code Coverage] |
+| `master` | [![CI][master Build Status Image]][master Build Status] | [![Coverage Status][master Code Coverage Image]][master Code Coverage] |
+| `develop` | [![CI][develop Build Status Image]][develop Build Status] | [![Coverage Status][develop Code Coverage Image]][develop Code Coverage] |
 
-Installation
-============
+## Installation
+
+### Step 1: Download the Bundle
 
-Step 1: Download the Bundle
-----------------------------------
 Open a command console, enter your project directory and execute:
 
-###  Applications that use Symfony Flex [in progress](https://github.com/MacPaw/BehatRedisContext/issues/2)
+#### Applications that use Symfony Flex [in progress](https://github.com/MacPaw/BehatRedisContext/issues/2)
 
-```console
-$ composer require --dev macpaw/behat-api-context
+```bash
+composer require --dev macpaw/behat-api-context
 ```
 
-### Applications that don't use Symfony Flex
+#### Applications that don't use Symfony Flex
 
-Open a command console, enter your project directory and execute the
-following command to download the latest stable version of this bundle:
+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-api-context
+```bash
+composer require --dev macpaw/behat-api-context
 ```
 
 This command requires you to have Composer installed globally, as explained
@@ -57,9 +54,11 @@ class AppKernel extends Kernel
 }
 ```
 
-Step 2: Configure Behat
-=============
-Go to `behat.yml`
+---
+
+## Step 2: Configure Behat
+
+Go to `behat.yml`:
 
 ```yaml
 # ...
@@ -68,45 +67,92 @@ Go to `behat.yml`
 # ...
 ```
 
-If you want use orm context add to `behat.yml`
+### Optional: Enable ORMContext
+
+If you want to use `ORMContext`, you need to have `doctrine/orm` installed:
+
+```bash
+composer require --dev doctrine/orm
+```
+
+Then, update your `behat.yml`:
+
 ```yaml
 # ...
   contexts:
     - BehatApiContext\Context\ORMContext 
 # ...
 ```
 
-Usage 
-=============
+---
+
+## Configuration
+
+By default, the bundle has the following configuration:
+
+```yaml
+behat_api_context:
+  kernel_reset_managers: []
+  use_orm_context: true
+```
+
+| ORM Installed | Default `use_orm_context` |
+|:-------------:|:-------------------------:|
+| Yes           | `true`                    |
+| No            | `false`                   |
+
+You can override it manually in your `config/packages/test/behat_api_context.yaml`:
 
-Runnable request parameters
-----------------------------------
-Main use case when tests need to use current date.
-Instead of static data in some `testCaseName.feature`, like this:
-```feature
+```yaml
+behat_api_context:
+  use_orm_context: false
+```
+
+or
+
+```yaml
+behat_api_context:
+  use_orm_context: true
+```
+
+depending on your needs.
+
+---
+
+# Usage
+
+### Runnable request parameters
+
+Main use case when tests need to use the current date.  
+Instead of static data in some `.feature` file like this:
+
+```gherkin
 """
 {
     "dateTo": 1680360081,
-    "dateFrom": 1680532881,
+    "dateFrom": 1680532881
 }
 """
 ```
-Can use, for example:
-```feature
+
+You can use dynamic expressions:
+
+```gherkin
 """
 {
     "dateTo": "<(new DateTimeImmutable())->add(new DateInterval('P6D'))->getTimeStamp()>",
-    "dateFrom": "<(new DateTimeImmutable())->add(new DateInterval('P2D'))->getTimeStamp()>",
+    "dateFrom": "<(new DateTimeImmutable())->add(new DateInterval('P2D'))->getTimeStamp()>"
 }
 """
 ```
 
-#### To accomplish this, several conditions must be met:
-- Runnable code must be a string and placed in `<>`
-- Should not add `return` keyword at the beginning, otherwise will get RuntimeException
-- Should not add `;` keyword at the end, otherwise will get RuntimeException
-- Should not use the code that returns `null`, otherwise will get RuntimeException
+#### To achieve this, several conditions must be met:
+- Runnable code must be a string and placed inside `<>`.
+- Do not add `return` keyword at the beginning, otherwise a `RuntimeException` will be thrown.
+- Do not add `;` at the end of the expression, otherwise a `RuntimeException` will be thrown.
+- Avoid code that returns `null`, otherwise a `RuntimeException` will be thrown.
 
+---
 
 [master Build Status]: https://github.com/macpaw/behat-api-context/actions?query=workflow%3ACI+branch%3Amaster
 [master Build Status Image]: https://github.com/macpaw/behat-api-context/workflows/CI/badge.svg?branch=master

phpstan.neon.dist

@@ -3,7 +3,6 @@ parameters:
     paths:
         - src
     level: max
-    checkMissingIterableValueType: false
     checkExplicitMixed: false
     ignoreErrors:
         -
@@ -34,3 +33,5 @@ parameters:
             message: '#Call to an undefined method object::getConnection().*#'
             count: 1
             path: ./src/Service/ResetManager/DoctrineResetManager
+        -
+            identifier: missingType.iterableValue

src/DependencyInjection/BehatApiContextExtension.php

@@ -4,7 +4,6 @@
 
 namespace BehatApiContext\DependencyInjection;
 
-use BehatApiContext\Context\ApiContext;
 use BehatApiContext\Context\ORMContext;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -26,7 +25,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
 
         $this->loadApiContext($config, $loader, $container);
-        $this->disableOrmContext($config, $container);
+        $this->loadOrmContext($config, $loader, $container);
     }
 
     /**
@@ -37,29 +36,50 @@ private function loadApiContext(
         XmlFileLoader $loader,
         ContainerBuilder $container
     ): void {
-        $loader->load('api_context.xml');
-
-        if (isset($config['kernel_reset_managers'])) {
-            $apiContextDefinition = $container->findDefinition(ApiContext::class);
-            foreach ($config['kernel_reset_managers'] as $resetManager) {
-                $resetManagerDefinition = $container->findDefinition($resetManager);
+        $this->safeLoad($loader, 'api_context.xml');
+    }
 
-                $apiContextDefinition->addMethodCall(
-                    'addKernelResetManager',
-                    [$resetManagerDefinition],
-                );
-            }
+    /**
+     * @param array<array> $config
+     */
+    private function loadOrmContext(
+        array $config,
+        XmlFileLoader $loader,
+        ContainerBuilder $container
+    ): void {
+        if (!($config['use_orm_context'] ?? true)) {
+            return;
         }
-    }
 
-    private function disableOrmContext(array $config, ContainerBuilder $container): void
-    {
-        $config['use_orm_context'] = $config['use_orm_context'] ?? true;
+        $this->safeLoad($loader, 'orm_context.xml');
+
+        $this->configureKernelResetManagers(
+            $config,
+            $container,
+            ORMContext::class
+        );
+    }
 
-        if ($config['use_orm_context']) {
+    private function configureKernelResetManagers(
+        array $config,
+        ContainerBuilder $container,
+        string $contextClass
+    ): void {
+        if (empty($config['kernel_reset_managers'])) {
             return;
         }
 
-        $container->removeDefinition(ORMContext::class);
+        $contextDefinition = $container->findDefinition($contextClass);
+
+        foreach ($config['kernel_reset_managers'] as $resetManager) {
+            $resetManagerDefinition = $container->findDefinition($resetManager);
+
+            $contextDefinition->addMethodCall('addKernelResetManager', [$resetManagerDefinition]);
+        }
+    }
+
+    private function safeLoad(XmlFileLoader $loader, string $file): void
+    {
+        $loader->load($file);
     }
 }

src/DependencyInjection/Configuration.php

@@ -4,6 +4,7 @@
 
 namespace BehatApiContext\DependencyInjection;
 
+use Composer\InstalledVersions;
 use Symfony\Component\Config\Definition\Builder\NodeBuilder;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
@@ -28,8 +29,13 @@ private function addKernelResetManagersSection(NodeBuilder $builder): void
             ->end()
 
             ->booleanNode('use_orm_context')
-                ->defaultValue(true)
+                ->defaultValue($this->checkOrmContextDefValue())
             ->end()
         ->end();
     }
+
+    private function checkOrmContextDefValue(): bool
+    {
+        return InstalledVersions::isInstalled('doctrine/orm');
+    }
 }

src/Resources/config/api_context.xml

@@ -1,12 +1,9 @@
 <?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">
+           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="BehatApiContext\Context\ApiContext" class="BehatApiContext\Context\ApiContext"/>
-        <service public="true" autowire="true" id="BehatApiContext\Context\ORMContext" class="BehatApiContext\Context\ORMContext"/>
-
-        <service public="false" id="BehatApiContext\Service\ResetManager\DoctrineResetManager" class="BehatApiContext\Service\ResetManager\DoctrineResetManager"/>
     </services>
 </container>

src/Resources/config/orm_context.xml

@@ -0,0 +1,10 @@
+<?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="BehatApiContext\Context\ORMContext" class="BehatApiContext\Context\ORMContext"/>
+        <service public="false" id="BehatApiContext\Service\ResetManager\DoctrineResetManager" class="BehatApiContext\Service\ResetManager\DoctrineResetManager"/>
+    </services>
+</container>