[BehatBridge] Add Shared storage context

.github/workflows/ci.yaml

@@ -94,6 +94,9 @@ jobs:
                 run: |
                     APP_LOCALE=fr vendor/bin/phpunit --testsuite="TranslationsTestSuite"
 
+            -   name: Run Behat
+                run: vendor/bin/behat --format=progress --strict
+
             - name: "Restrict packages' versions (Admin Ui)"
               run: |
                   (cd src/AdminUi/ && composer global config --no-plugins allow-plugins.symfony/flex true)

behat.dist.yaml

@@ -0,0 +1,8 @@
+imports:
+    - config/behat/suites/ui/book/managing_books.yaml
+
+default:
+    extensions:
+        FriendsOfBehat\SymfonyExtension:
+            bootstrap: tests/bootstrap.php
+

composer.json

@@ -42,7 +42,9 @@
         "webmozart/assert": "^1.9"
     },
     "require-dev": {
+        "behat/behat": "^3.16",
         "doctrine/doctrine-fixtures-bundle": "^3.6",
+        "friends-of-behat/symfony-extension": "^2.6",
         "matthiasnoback/symfony-config-test": "^5.1",
         "matthiasnoback/symfony-dependency-injection-test": "^5.1",
         "phpstan/phpstan": "^1.10",

config/behat/suites/ui/book/managing_books.yaml

@@ -0,0 +1,12 @@
+default:
+    suites:
+        ui_managing_books:
+            contexts:
+                - Sylius\BehatBridge\Behat\Context\Transform\SharedStorageContext
+
+                - MainTests\Sylius\Behat\Context\Setup\BookContext
+
+                - MainTests\Sylius\Behat\Context\Ui\ManagingBooksContext
+
+            filters:
+                tags: "@managing_books&&@ui"

config/bundles.php

@@ -26,4 +26,5 @@
     Symfony\UX\Autocomplete\AutocompleteBundle::class => ['all' => true],
     Symfony\Bundle\SecurityBundle\SecurityBundle::class => ['all' => true],
     Symfony\UX\Icons\UXIconsBundle::class => ['all' => true],
+    FriendsOfBehat\SymfonyExtension\Bundle\FriendsOfBehatSymfonyExtensionBundle::class => ['test' => true],
 ];

config/services_test.yaml

@@ -0,0 +1,8 @@
+services:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+
+
+    MainTests\Sylius\Behat\:
+        resource: '../tests/Behat/*'

features/admin/book/managing_books/editing_books.feature

@@ -0,0 +1,12 @@
+@managing_books
+Feature: Editing books
+    In order to change information about a book
+    As an Administrator
+    I want to be able to edit the book
+
+    Background:
+        Given there is a book "Shinning"
+
+    @ui
+    Scenario: Renaming a book
+        When I want to edit this book

src/BehatBridge/config/services/behat/context.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+use Sylius\BehatBridge\Behat\Context\Transform\SharedStorageContext;
+
+return function (ContainerConfigurator $configurator): void {
+    $services = $configurator->services();
+
+    $services->defaults()
+        ->public()
+    ;
+
+    $services
+        ->set('sylius_behat_bridge.behat.context.transform.shared_storage', SharedStorageContext::class)
+        ->args([
+            service('sylius_behat_bridge.storage.shared'),
+        ])
+    ;
+    $services->alias(SharedStorageContext::class, 'sylius_behat_bridge.behat.context.transform.shared_storage');
+};

src/BehatBridge/src/Behat/Context/Transform/SharedStorageContext.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\BehatBridge\Behat\Context\Transform;
+
+use Behat\Behat\Context\Context;
+use Sylius\BehatBridge\Formatter\StringInflector;
+use Sylius\BehatBridge\Storage\SharedStorageInterface;
+
+final class SharedStorageContext implements Context
+{
+    public function __construct(
+        private readonly SharedStorageInterface $sharedStorage,
+    ) {
+    }
+
+    /**
+     * @Transform /^(it|its|theirs|them)$/
+     */
+    public function getLatestResource(): mixed
+    {
+        return $this->sharedStorage->getLatestResource();
+    }
+
+    /**
+     * @Transform /^(?:this|that|the|my|his|her) ([^"]+)$/
+     */
+    public function getResource(mixed $resource): mixed
+    {
+        return $this->sharedStorage->get(StringInflector::nameToCode($resource));
+    }
+}

src/BehatBridge/src/Formatter/StringInflector.php

@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\BehatBridge\Formatter;
+
+final class StringInflector
+{
+    public static function nameToCode(string $value): string
+    {
+        return str_replace([' ', '-'], '_', $value);
+    }
+
+    private function __construct()
+    {
+    }
+}

symfony.lock

@@ -37,6 +37,15 @@
             "src/DataFixtures/AppFixtures.php"
         ]
     },
+    "friends-of-behat/symfony-extension": {
+        "version": "2.6",
+        "recipe": {
+            "repo": "github.com/symfony/recipes-contrib",
+            "branch": "main",
+            "version": "2.0",
+            "ref": "1e012e04f573524ca83795cd19df9ea690adb604"
+        }
+    },
     "knplabs/knp-menu-bundle": {
         "version": "v3.4.2"
     },

tests/Behat/Context/Setup/BookContext.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace MainTests\Sylius\Behat\Context\Setup;
+
+use App\Factory\BookFactory;
+use Behat\Behat\Context\Context;
+use Behat\Step\Given;
+use Sylius\BehatBridge\Storage\SharedStorageInterface;
+
+final class BookContext implements Context
+{
+    public function __construct(
+        private readonly SharedStorageInterface $sharedStorage,
+    ) {
+    }
+
+    #[Given('there is a book :title')]
+    public function thereIsABook(string $title): void
+    {
+        $book = BookFactory::new()
+            ->withTitle($title)->create()
+        ;
+
+        $this->sharedStorage->set('book', $book);
+    }
+}

tests/Behat/Context/Ui/ManagingBooksContext.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MainTests\Sylius\Behat\Context\Ui;
+
+use App\Entity\Book;
+use Behat\Behat\Context\Context;
+use Behat\Step\When;
+use Zenstruck\Foundry\Persistence\Proxy;
+
+final class ManagingBooksContext implements Context
+{
+    /**
+     * @param Proxy<Book> $book
+     */
+    #[When('/^I want to edit (this book)$/')]
+    public function iWantToEditThisBook(Proxy $book): void
+    {
+        // For now, we are just testing the shared context transform
+    }
+}