Feat/orc 816 add orm context

.github/workflows/ci.yaml

@@ -82,6 +82,9 @@ jobs:
             - name: Install dependencies
               run: composer install
 
+            - name: Add doctrine/orm
+              run: composer require --no-progress --no-interaction --prefer-dist doctrine/orm:^2.0
+
             - name: Run PHPUnit tests
               run: composer phpunit
               if: matrix.coverage == 'none'

.github/workflows/static-analysis.yaml

@@ -19,6 +19,9 @@ jobs:
             - name: Install dependencies
               run: composer install --no-progress --no-interaction --prefer-dist
 
+            - name: Add doctrine/orm
+              run: composer require --no-progress --no-interaction --prefer-dist doctrine/orm:^2.0
+
             - name: Run script
               run: composer code-style
 
@@ -35,6 +38,9 @@ jobs:
             - name: Install dependencies
               run: composer install --no-progress --no-interaction --prefer-dist
 
+            - name: Add doctrine/orm
+              run: composer require --no-progress --no-interaction --prefer-dist doctrine/orm:^2.0
+
             - name: Run script
               run: composer phpstan
 

README.md

@@ -68,6 +68,14 @@ Go to `behat.yml`
 # ...
 ```
 
+If you want use orm context add to `behat.yml`
+```yaml
+# ...
+  contexts:
+    - BehatApiContext\Context\ORMContext 
+# ...
+```
+
 Usage 
 =============
 

composer.json

@@ -42,6 +42,9 @@
         "slevomat/coding-standard": "^7.0",
         "squizlabs/php_codesniffer": "^3.6"
     },
+    "suggest": {
+        "doctrine/orm": "^2.0"
+    },
     "autoload": {
         "psr-4": {
             "BehatApiContext\\": "src"

src/Context/ORMContext.php

@@ -0,0 +1,82 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BehatApiContext\Context;
+
+use Behat\Behat\Context\Context;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\NonUniqueResultException;
+use Doctrine\ORM\NoResultException;
+use RuntimeException;
+
+final class ORMContext implements Context
+{
+    private EntityManagerInterface $manager;
+
+    public function __construct(EntityManagerInterface $manager)
+    {
+        $this->manager = $manager;
+    }
+
+    /**
+     * @And I see :count entities :entityClass
+     */
+    public function andISeeInRepository(int $count, string $entityClass): void
+    {
+        $this->seeInRepository($count, $entityClass);
+    }
+
+    /**
+     * @Then I see :count entities :entityClass
+     */
+    public function thenISeeInRepository(int $count, string $entityClass): void
+    {
+        $this->seeInRepository($count, $entityClass);
+    }
+
+    /**
+     * @And I see entity :entity with id :id
+     */
+    public function andISeeEntityInRepositoryWithId(string $entityClass, string $id): void
+    {
+        $this->seeInRepository(1, $entityClass, ['id' => $id]);
+    }
+
+    /**
+     * @Then I see entity :entity with id :id
+     */
+    public function thenISeeEntityInRepositoryWithId(string $entityClass, string $id): void
+    {
+        $this->seeInRepository(1, $entityClass, ['id' => $id]);
+    }
+
+    /**
+     * @param array<string, mixed> $params
+     *
+     * @throws NonUniqueResultException
+     * @throws NoResultException
+     */
+    private function seeInRepository(int $count, string $entityClass, ?array $params = null): void
+    {
+        $query = $this->manager->createQueryBuilder()
+            ->from($entityClass, 'e')
+            ->select('count(e)');
+
+        if (null !== $params) {
+            foreach ($params as $columnName => $columnValue) {
+                $query->where("e.$columnName = :value$columnName")
+                    ->setParameter("value$columnName", $columnValue);
+            }
+        }
+
+        $realCount = $query->getQuery()
+            ->getSingleScalarResult();
+
+        if ($count !== $realCount) {
+            throw new RuntimeException(
+                sprintf('Real count is %d, not %d', $realCount, $count),
+            );
+        }
+    }
+}

src/DependencyInjection/BehatApiContextExtension.php

@@ -5,8 +5,13 @@
 namespace BehatApiContext\DependencyInjection;
 
 use BehatApiContext\Context\ApiContext;
+use BehatApiContext\Context\ORMContext;
+use Doctrine\ORM\EntityManagerInterface;
+use Psr\Container\ContainerInterface;
+use RuntimeException;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
@@ -25,6 +30,7 @@
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
 
         $this->loadApiContext($config, $loader, $container);
+        $this->enableOrmContext($config, $container);
     }
 
     /**
@@ -49,4 +55,23 @@
             }
         }
     }
+
+    private function enableOrmContext(array $config, ContainerBuilder $container): void
+    {
+        $config['use_orm_context'] = $config['use_orm_context'] ?? true;
+
+        if (!$config['use_orm_context']) {
+            return;
+        }
+
+        if (!$container->has(EntityManagerInterface::class)) {
+            throw new RuntimeException('Entity manager does not exists');
+        }
+
+        $entityManagerDef = $container->get(EntityManagerInterface::class);
+
+        $ormContextDef = new Definition(ORMContext::class);
+        $ormContextDef->setArgument('$manager', $entityManagerDef);
+        $container->setDefinition(ORMContext::class, $ormContextDef);
+    }
 }

src/DependencyInjection/Configuration.php

@@ -25,7 +25,11 @@ private function addKernelResetManagersSection(NodeBuilder $builder): void
         $builder
             ->arrayNode('kernel_reset_managers')
                 ->scalarPrototype()->end()
-                ->end()
-            ->end();
+            ->end()
+
+            ->booleanNode('use_orm_context')
+                ->defaultValue(true)
+            ->end()
+        ->end();
     }
 }

tests/DependencyInjection/ConfigurationTest.php

@@ -14,7 +14,8 @@ final class ConfigurationTest extends TestCase
     public function testProcessConfigurationWithEmptyConfiguration(): void
     {
         $expectedBundleDefaultConfig = [
-            'kernel_reset_managers' => []
+            'kernel_reset_managers' => [],
+            'use_orm_context' => true,
         ];
 
         $this->assertSame($expectedBundleDefaultConfig, $this->processConfiguration([]));
@@ -24,12 +25,14 @@ public function testProcessConfigurationWithDefaultConfiguration(): void
     {
         $config = [
             'behat_api_context' => [
-                'kernel_reset_managers' => []
+                'kernel_reset_managers' => [],
+                'use_orm_context' => true,
             ]
         ];
 
         $expectedBundleDefaultConfig = [
-            'kernel_reset_managers' => []
+            'kernel_reset_managers' => [],
+            'use_orm_context' => true,
         ];
 
         $this->assertSame($expectedBundleDefaultConfig, $this->processConfiguration($config));
@@ -41,14 +44,16 @@ public function testProcessConfigurationWithFilledConfiguration(): void
             'behat_api_context' => [
                 'kernel_reset_managers' => [
                     DoctrineResetManager::class
-                ]
+                ],
+                'use_orm_context' => true,
             ]
         ];
 
         $expectedBundleDefaultConfig = [
             'kernel_reset_managers' => [
                 DoctrineResetManager::class
-            ]
+            ],
+            'use_orm_context' => true,
         ];
 
         $this->assertSame($expectedBundleDefaultConfig, $this->processConfiguration($config));

tests/DependencyInjection/Fixtures/empty_bundle_config.yaml

@@ -1 +1,2 @@
 behat_api_context:
+  use_orm_context: false

tests/DependencyInjection/Fixtures/filled_bundle_config.yaml

@@ -1,3 +1,4 @@
 behat_api_context:
+  use_orm_context: false
   kernel_reset_managers:
-    - BehatApiContext\Service\ResetManager\DoctrineResetManager
+    - BehatApiContext\Service\ResetManager\DoctrineResetManager

tests/Unit/Context/AbstractApiContextTest.php → tests/Unit/Context/Api/AbstractApiContextTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace BehatApiContext\Tests\Unit\Context;
+namespace BehatApiContext\Tests\Unit\Context\Api;
 
 use BehatApiContext\Context\ApiContext;
 use PHPUnit\Framework\TestCase;

tests/Unit/Context/ApiContextTest.php → tests/Unit/Context/Api/ApiContextTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace BehatApiContext\Tests\Unit\Context;
+namespace BehatApiContext\Tests\Unit\Context\Api;
 
 use Behat\Gherkin\Node\PyStringNode;
 use RuntimeException;

tests/Unit/Context/GivenApiContextsTest.php → tests/Unit/Context/Api/GivenApiContextsTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace BehatApiContext\Tests\Unit\Context;
+namespace BehatApiContext\Tests\Unit\Context\Api;
 
 use Behat\Gherkin\Node\PyStringNode;
 use ReflectionClass;

tests/Unit/Context/InitApiContextsTest.php → tests/Unit/Context/Api/InitApiContextsTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace BehatApiContext\Tests\Unit\Context;
+namespace BehatApiContext\Tests\Unit\Context\Api;
 
 use BehatApiContext\Service\ResetManager\ResetManagerInterface;
 use ReflectionClass;

tests/Unit/Context/ResponseHasHeaderTest.php → tests/Unit/Context/Api/ResponseHasHeaderTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace BehatApiContext\Tests\Unit\Context;
+namespace BehatApiContext\Tests\Unit\Context\Api;
 
 use RuntimeException;
 use Symfony\Component\HttpFoundation\Response;

tests/Unit/Context/ThenApiContextTest.php → tests/Unit/Context/Api/ThenApiContextTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace BehatApiContext\Tests\Unit\Context;
+namespace BehatApiContext\Tests\Unit\Context\Api;
 
 use Behat\Gherkin\Node\PyStringNode;
 use JsonException;

tests/Unit/Context/WhenApiContextsTest.php → tests/Unit/Context/Api/WhenApiContextsTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace BehatApiContext\Tests\Unit\Context;
+namespace BehatApiContext\Tests\Unit\Context\Api;
 
 use PHPUnit\Framework\MockObject\MockObject;
 use Symfony\Component\HttpFoundation\Request;

tests/Unit/Context/WhenSendRequestToRouteApiContextsTest.php → tests/Unit/Context/Api/WhenSendRequestToRouteApiContextsTest.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace BehatApiContext\Tests\Unit\Context;
+namespace BehatApiContext\Tests\Unit\Context\Api;
 
 use JsonException;
 use ReflectionException;