Add helper for Pimcore backend login

Introduce a custom PimcoreKernelBrowser to streamline login/logout in Pimcore backend tests.

Author: jdreesen

composer.json

@@ -30,6 +30,7 @@
     "symfony/event-dispatcher": "^5.4 || ^6.4",
     "symfony/filesystem": "^5.4 || ^6.4",
     "symfony/framework-bundle": "^5.4 || ^6.4",
+    "symfony/http-foundation": "^5.4 || ^6.4",
     "symfony/http-kernel": "^5.4 || ^6.4"
   },
   "require-dev": {
@@ -43,7 +44,8 @@
     "phpstan/phpstan": "^1.10.60",
     "phpstan/phpstan-phpunit": "^1.3.16",
     "phpstan/phpstan-symfony": "^1.3.8",
-    "shipmonk/composer-dependency-analyser": "^1.7"
+    "shipmonk/composer-dependency-analyser": "^1.7",
+    "symfony/security-core": "^5.4 || ^6.4"
   },
   "suggest": {
     "dama/doctrine-test-bundle": "To isolate database tests in transactions and improve test performance",

src/Browser/PimcoreKernelBrowser.php

@@ -0,0 +1,44 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\TestingFramework\Browser;
+
+use Pimcore\Model\User;
+use Pimcore\Security\User\User as SecurityUser;
+use Pimcore\Tool\Session;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
+use Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface;
+
+class PimcoreKernelBrowser extends KernelBrowser
+{
+    public function loginToPimcoreBackend(string $username = 'admin'): void
+    {
+        $user = User::getByName($username);
+
+        $this->setServerParameter('HTTP_X_PIMCORE_CSRF_TOKEN', 'test-csrf-token');
+        $this->loginUser(new SecurityUser($user), 'pimcore_admin');
+        $this->request('GET', '/admin/login');
+
+        Session::useBag(
+            $this->getRequest()->getSession(),
+            function (AttributeBagInterface $adminSession) use ($user) {
+                $adminSession->set('user', $user);
+                // Sign your POST requests with this CSRF token to avoid 403 responses
+                $adminSession->set('csrfToken', 'test-csrf-token');
+            },
+        );
+    }
+
+    public function logoutFromPimcoreBackend(): void
+    {
+        Session::useBag(
+            $this->getRequest()->getSession(),
+            function (AttributeBagInterface $adminSession) {
+                $adminSession->set('user', null);
+                $adminSession->set('csrfToken', null);
+            },
+        );
+
+        $this->getCookieJar()->clear();
+    }
+}

src/Kernel/TestKernel.php

@@ -3,6 +3,7 @@
 
 namespace Neusta\Pimcore\TestingFramework\Kernel;
 
+use Neusta\Pimcore\TestingFramework\Browser\PimcoreKernelBrowser;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -103,6 +104,15 @@ protected function buildContainer(): ContainerBuilder
     {
         $container = parent::buildContainer();
 
+        $container->addCompilerPass(new class implements CompilerPassInterface {
+            public function process(ContainerBuilder $container): void
+            {
+                if ($container->has('test.client')) {
+                    $container->findDefinition('test.client')->setClass(PimcoreKernelBrowser::class);
+                }
+            }
+        });
+
         foreach ($this->testCompilerPasses as $compilerPass) {
             $container->addCompilerPass(...$compilerPass);
         }

src/WebTestCase.php

@@ -0,0 +1,13 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\TestingFramework;
+
+use Neusta\Pimcore\TestingFramework\Browser\PimcoreKernelBrowser;
+
+/**
+ * @method static PimcoreKernelBrowser createClient(array $options = [], array $server = [])
+ */
+class WebTestCase extends \Pimcore\Test\WebTestCase
+{
+}

tests/Functional/PimcoreKernelBrowserTest.php

@@ -0,0 +1,42 @@
+<?php
+declare(strict_types=1);
+
+namespace Neusta\Pimcore\TestingFramework\Tests\Functional;
+
+use Neusta\Pimcore\TestingFramework\Database\ResetDatabase;
+use Neusta\Pimcore\TestingFramework\WebTestCase;
+use Symfony\Component\Security\Core\Exception\AccessDeniedException;
+
+class PimcoreKernelBrowserTest extends WebTestCase
+{
+    use ResetDatabase;
+
+    /**
+     * @test
+     */
+    public function it_allows_logging_in_and_out_from_pimcore_backend(): void
+    {
+        $client = static::createClient();
+        $client->catchExceptions(false);
+
+        // Access should be denied before login
+        try {
+            $client->request('GET', '/admin/user/get-minimal');
+            $this->fail('AccessDeniedException expected.');
+        } catch (AccessDeniedException) {
+        }
+
+        // Access should be granted after login
+        $client->loginToPimcoreBackend();
+        $client->request('GET', '/admin/user/get-minimal');
+        static::assertResponseIsSuccessful();
+
+        // Access should be denied again after logout
+        $client->logoutFromPimcoreBackend();
+        try {
+            $client->request('GET', '/admin/user/get-minimal');
+            $this->fail('AccessDeniedException expected.');
+        } catch (AccessDeniedException) {
+        }
+    }
+}

tests/app/config/routes.yaml

@@ -0,0 +1,4 @@
+# auto loads routes from all bundles in config/pimcore/routing.yaml
+_pimcore_bundle_auto:
+  resource: .
+  type: pimcore_bundle