E2E: Added waiting for backend, clearing the user session between scenarios

Author: blackandred

e2e/.rkd/makefile.yaml

@@ -2,12 +2,14 @@ version: org.riotkit.rkd/yaml/v1
 imports: []
 
 environment:
-    BROWSER_BIN: "opera"
+    BROWSER_BIN: "chromium"
 
 tasks:
     :e2e:browser:
         description: Run Chromium browser
-        steps: $BROWSER_BIN --remote-debugging-address=0.0.0.0 --remote-debugging-port=9222
+        steps:
+            - rm -rf .rkd/browser
+            - $BROWSER_BIN --remote-debugging-address=0.0.0.0 --remote-debugging-port=9222 --user-data-dir=.rkd/browser
 
     :e2e:test:
         description: Run End-To-End tests with Behat

e2e/features/UsersManagement.feature

@@ -0,0 +1,6 @@
+Feature: Create users, edit basic fields in existing user profiles, searching the user list
+
+Scenario: Create a example user from web panel
+  Given I am authenticated as administrator
+  And I visit users search page
+  And I press "Add user" button

e2e/features/bootstrap/FeatureContext.php

@@ -1,9 +1,7 @@
 <?php declare(strict_types=1);
 
-use Behat\Behat\Context\Context;
-use Behat\Gherkin\Node\PyStringNode;
-use Behat\Gherkin\Node\TableNode;
-use Behat\MinkExtension\Context\MinkContext;
+use Behat\Behat\Hook\Scope\AfterScenarioScope;
+use Behat\Mink\Exception\ElementNotFoundException;
 use PHPUnit\Framework\Assert as Assertions;
 
 define('SERVER_PATH', __DIR__ . '/../../../server');
@@ -16,14 +14,20 @@
 class FeatureContext extends TechnicalContext
 {
     /**
-     * Initializes context.
+     * After each scenario clear the browser session - logout user
      *
-     * Every scenario gets its own context instance.
-     * You can also pass arbitrary arguments to the
-     * context constructor through behat.yml.
+     * @param AfterScenarioScope $event
+     *
+     * @AfterScenario
      */
-    public function __construct()
+    public function resetCurrentPage(AfterScenarioScope $event)
     {
+        try {
+            $script = 'sessionStorage.clear(); localStorage.clear();';
+            $this->getSession()->executeScript($script);
+        } catch (\Exception $e) {
+            //
+        }
     }
 
 
@@ -64,11 +68,12 @@ public function iCreateAdminAccountAdvanced(string $commandline): void
      *
      * @param string $user
      * @param string $password
+     * @throws ElementNotFoundException
      */
-    public function iLoginAs(string $user, string $password)
+    public function iLoginAs(string $user, string $password): void
     {
         $this->visit('/');
-        $this->getSession()->getPage()->find('css', 'a[to="/admin/login"]')->click();
+        $this->iClickMenuLink('/admin/login');
 
         $this->fillFieldByCSS('input[placeholder="Email*"]', $user);
         $this->fillFieldByCSS('input[placeholder="Enter your password*"]', $password);
@@ -78,6 +83,18 @@ public function iLoginAs(string $user, string $password)
         sleep(1);
     }
 
+    /**
+     * @When I click menu link leading to :path
+     *
+     * @param string $path
+     * @throws ElementNotFoundException
+     */
+    public function iClickMenuLink(string $path): void
+    {
+        $this->findByCSS('a[to="' . $path . '"]')->click();
+        $this->iWait();
+    }
+
     /**
      * @Then I expect to be logged in
      */
@@ -96,4 +113,22 @@ public function expectToSeeApplicationFooter(): void
         Assertions::assertMatchesRegularExpression('/Backup Repository ([0-9\.\-a-z]+) running on ([a-z]+)/', $footer ? $footer->getText() : '');
         Assertions::assertTrue($footer && $footer->isVisible());
     }
+
+    /**
+     * @Given I am authenticated as administrator
+     */
+    public function iAuthAsAdmin(): void
+    {
+        $this->iCreateAdminAccountWithEMail('[email protected]', 'you-cant-break-it');
+        $this->iLoginAs('[email protected]', 'you-cant-break-it');
+    }
+
+    /**
+     * @When I visit users search page
+     * @throws ElementNotFoundException
+     */
+    public function iVisitUsersSearchPage(): void
+    {
+        $this->iClickMenuLink('/admin/users');
+    }
 }

e2e/features/bootstrap/TechnicalContext.php

@@ -1,5 +1,7 @@
 <?php declare(strict_types=1);
 
+use Behat\Mink\Element\NodeElement;
+use Behat\Mink\Exception\ElementNotFoundException;
 use Behat\MinkExtension\Context\MinkContext;
 use PHPUnit\Framework\Assert as Assertions;
 
@@ -46,7 +48,19 @@ public function iAssertShellCommandExitedWith(int $exitCode): void
     // Browser
     //
 
-    protected function fillFieldByCSS(string $selector, string $value)
+    protected function iWait(): void
+    {
+        $this->getSession()->getPage()->waitFor(
+            30,
+            function () {
+                $element = $this->getSession()->getPage()->find('css', 'div[class="loader-overlay"]');
+
+                return !$element || !$element->isVisible();
+            }
+        );
+    }
+
+    protected function fillFieldByCSS(string $selector, string $value): void
     {
         $input = $this->getSession()->getPage()->find('css', $selector);
         $input->click();
@@ -55,4 +69,36 @@ protected function fillFieldByCSS(string $selector, string $value)
         $input->blur();
         $input->click();
     }
+
+    /**
+     * @When I press :buttonTitle button
+     *
+     * @param string $buttonTitle
+     */
+    public function iPressButton(string $buttonTitle): void
+    {
+        $this->pressButton($buttonTitle);
+    }
+
+    protected function findByCSS(string $selector, int $timeout = 10): NodeElement
+    {
+        $callback = function () use ($selector) {
+            return $this->getSession()->getPage()->find('css', $selector);
+        };
+
+        do {
+            $element = $callback();
+
+            if ($element instanceof NodeElement) {
+                return $element;
+            }
+
+            $timeout--;
+            sleep(1);
+
+        } while (!$element instanceof NodeElement && $timeout > 0);
+
+        sleep(5);
+        throw new ElementNotFoundException($this->getSession()->getDriver(), null, 'css', $selector);
+    }
 }