Improve code style

Author: Naktibalda

.github/workflows/static-analysis.yml

@@ -0,0 +1,28 @@
+name: Static analysis
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  phpcs:
+    name: Code style
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          ini-values: memory_limit=-1, date.timezone='UTC'
+          tools: phpcs
+
+      - name: Check production code style
+        run: phpcs src/
+
+      - name: Check test code style
+        run: phpcs tests/ --standard=tests/phpcs.xml

composer.json

@@ -33,6 +33,12 @@
     "autoload":{
         "classmap": ["src/"]
     },
+    "autoload-dev": {
+        "classmap": [
+            "tests/data/app/data.php",
+            "tests/unit/Codeception/Constraints/TestedWebElement.php"
+        ]
+    },
     "config": {
         "classmap-authoritative": true
     }

phpcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<ruleset name="Codeception">
+    <description>Codeception code standard</description>
+    <rule ref="PSR12">
+        <exclude name="PSR2.Methods.MethodDeclaration.Underscore"/>
+    </rule>
+</ruleset>

src/Codeception/Constraint/WebDriver.php

@@ -54,7 +54,7 @@ protected function fail($nodes, $selector, ComparisonFailure $comparisonFailure
         }
 
         $output = "Failed asserting that any element by " . Locator::humanReadableString($selector);
-        $output .= $this->uriMessage('on page');
+        $output .= ' ' . $this->uriMessage('on page');
 
         if (count($nodes) < 5) {
             $output .= "\nElements: ";

src/Codeception/Constraint/WebDriverNot.php

@@ -38,7 +38,7 @@ protected function fail($nodes, $selector, ComparisonFailure $comparisonFailure
         }
 
         $output = "There was {$selector} element";
-        $output .= $this->uriMessage("on page");
+        $output .= ' ' . $this->uriMessage('on page');
         $output .= $this->nodesList($nodes, $this->string);
         $output .= "\ncontaining '{$this->string}'";
 

src/Codeception/Module/WebDriver.php

@@ -1,5 +1,6 @@
 <?php
 
+//phpcs:disable Generic.Files.LineLength.TooLong
 declare(strict_types=1);
 
 namespace Codeception\Module;
@@ -65,11 +66,11 @@
  *
  * * Java is required
  * * NodeJS is required
- * 
+ *
  * The fastest way to get started is to [Install and launch Selenium using selenium-standalone NodeJS package](https://www.npmjs.com/package/selenium-standalone).
- * 
+ *
  * Launch selenium standalone in separate console window:
- * 
+ *
  * ```
  * selenium-standalone start
  * ```
@@ -83,11 +84,11 @@
  *          url: 'http://localhost/'
  *          browser: chrome # 'chrome' or 'firefox'
  * ```
- * 
+ *
  * ## Headless Chrome Browser
- * 
+ *
  * To enable headless mode (launch tests without showing a window) for Chrome browser using Selenium use this config in `acceptance.suite.yml`:
- * 
+ *
  * ```yaml
  * modules:
  *    enabled:
@@ -98,7 +99,7 @@
  *             chromeOptions:
  *                args: ["--headless", "--disable-gpu"]
  * ```
- * 
+ *
  * ## Headless Selenium in Docker
  *
  * Docker can ship Selenium Server with all its dependencies and browsers inside a single container.
@@ -113,12 +114,12 @@
  * ## Local Chrome and/or Firefox
  *
  * Tests can be executed directly through ChromeDriver or GeckoDriver (for Firefox). Consider using this option if you don't plan to use Selenium.
- * 
+ *
  * ### ChromeDriver
- * 
+ *
  * * Download and install [ChromeDriver](https://sites.google.com/chromium.org/driver/downloads?authuser=0)
  * * Launch ChromeDriver in a separate console window: `chromedriver --url-base=/wd/hub`.
- * 
+ *
  * Configuration in `acceptance.suite.yml`:
  *
  * ```yaml
@@ -139,10 +140,10 @@
  *
  *
  * ### GeckoDriver
- * 
+ *
  * * [GeckoDriver](https://github.com/mozilla/geckodriver/releases) must be installed
  * * Start GeckoDriver in a separate console window: `geckodriver`.
- *  
+ *
  * Configuration in `acceptance.suite.yml`:
  *
  * ```yaml
@@ -160,7 +161,7 @@
  *                      intl.accept_languages: "de-AT" # Set HTTP-Header `Accept-Language: de-AT` for requests
  * ```
  * See here for [Firefox capabilities](https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities#List_of_capabilities)
- * 
+ *
  * ## Cloud Testing
  *
  * Cloud Testing services can run your WebDriver tests in the cloud.
@@ -460,15 +461,24 @@ public function _requires(): array
     protected function getBaseElement(): WebDriverSearchContext
     {
         if (!$this->baseElement) {
-            throw new ModuleException($this, "Page not loaded. Use `\$I->amOnPage` (or hidden API methods `_request` and `_loadPage`) to open it");
+            throw new ModuleException(
+                $this,
+                "Page not loaded. Use `\$I->amOnPage` (or hidden API methods `_request` and `_loadPage`) to open it"
+            );
         }
 
         return $this->baseElement;
     }
 
     public function _initialize()
     {
-        $this->wdHost = sprintf('%s://%s:%s%s', $this->config['protocol'], $this->config['host'], $this->config['port'], $this->config['path']);
+        $this->wdHost = sprintf(
+            '%s://%s:%s%s',
+            $this->config['protocol'],
+            $this->config['host'],
+            $this->config['port'],
+            $this->config['path']
+        );
         $this->capabilities = $this->config['capabilities'];
         $this->capabilities[WebDriverCapabilityType::BROWSER_NAME] = $this->config['browser'];
         if ($proxy = $this->getProxy()) {
@@ -674,7 +684,8 @@ public function debugWebDriverLogs(TestInterface $test = null): void
 
                 $this->debugSection("Selenium {$logType} Logs", "\n" . $this->formatLogEntries($logEntries));
 
-                if ($logType === 'browser' && $this->config['log_js_errors']
+                if (
+                    $logType === 'browser' && $this->config['log_js_errors']
                     && ($test instanceof ScenarioDriven)
                 ) {
                     $this->logJSErrors($test, $logEntries);
@@ -711,7 +722,8 @@ protected function formatLogEntries(array $logEntries): string
     protected function logJSErrors(ScenarioDriven $test, array $browserLogEntries): void
     {
         foreach ($browserLogEntries as $logEntry) {
-            if (isset($logEntry['level'])
+            if (
+                isset($logEntry['level'])
                 && isset($logEntry['message'])
                 && $this->isJSError($logEntry['level'], $logEntry['message'])
             ) {
@@ -1167,7 +1179,10 @@ public function click($link, $context = null): void
             try {
                 $els = $this->match($page, $link);
             } catch (MalformedLocatorException $exception) {
-                throw new ElementNotFound("name={$link}", "'{$link}' is invalid CSS and XPath selector and Link or Button");
+                throw new ElementNotFound(
+                    "name={$link}",
+                    "'{$link}' is invalid CSS and XPath selector and Link or Button"
+                );
             }
 
             $el = reset($els);
@@ -1237,7 +1252,6 @@ public function _findClickable(WebDriverSearchContext $page, $link): ?WebDriverE
             ".//input[./@type = 'submit' or ./@type = 'image' or ./@type = 'button'][./@name = {$locator} or ./@title = {$locator}]",
             ".//button[./@name = {$locator} or ./@title = {$locator}]"
         );
-
         $els = $page->findElements(WebDriverBy::xpath($xpath));
         if (count($els) > 0) {
             return reset($els);
@@ -1270,10 +1284,8 @@ protected function findFields($selector): array
         $locator = static::xPathLiteral(trim((string) $selector));
         // by text or label
         $xpath = Locator::combine(
-        // @codingStandardsIgnoreStart
             ".//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')][(((./@name = {$locator}) or ./@id = //label[contains(normalize-space(string(.)), {$locator})]/@for) or ./@placeholder = {$locator})]",
             ".//label[contains(normalize-space(string(.)), {$locator})]//.//*[self::input | self::textarea | self::select][not(./@type = 'submit' or ./@type = 'image' or ./@type = 'hidden')]"
-        // @codingStandardsIgnoreEnd
         );
         $fields = $this->getBaseElement()->findElements(WebDriverBy::xpath($xpath));
         if (!empty($fields)) {
@@ -1321,7 +1333,10 @@ public function seeLink(string $text, string $url = null): void
             $nodes = $this->filterNodesByHref($url, $nodes);
         }
 
-        $this->assertNotEmpty($nodes, "No links containing text '{$text}' and URL '{$url}' were found in page {$currentUri}");
+        $this->assertNotEmpty(
+            $nodes,
+            "No links containing text '{$text}' and URL '{$url}' were found in page {$currentUri}"
+        );
     }
 
     public function dontSeeLink(string $text, string $url = ''): void
@@ -1332,7 +1347,10 @@ public function dontSeeLink(string $text, string $url = ''): void
             $this->assertEmpty($nodes, "Link containing text '{$text}' was found in page {$currentUri}");
         } else {
             $nodes = $this->filterNodesByHref($url, $nodes);
-            $this->assertEmpty($nodes, "Link containing text '{$text}' and URL '{$url}' was found in page {$currentUri}");
+            $this->assertEmpty(
+                $nodes,
+                "Link containing text '{$text}' and URL '{$url}' was found in page {$currentUri}"
+            );
         }
     }
 
@@ -1529,15 +1547,15 @@ protected function proceedSeeInField(array $elements, $value): array
 
                     break;
                 case 'option':
-                    // no break we need the trim text and the value also
                     if (!$el->isSelected()) {
                         break;
                     }
 
                     $currentValues[] = $el->getText();
+                    // no break we need the trim text and the value also
                 case 'textarea':
-                    // we include trimmed and real value of textarea for check
                     $currentValues[] = trim($el->getText());
+                    // we include trimmed and real value of textarea for check
                 default:
                     $currentValues[] = $el->getAttribute('value'); // raw value
                     break;
@@ -1629,7 +1647,10 @@ public function selectOption($select, $option): void
             return;
         }
 
-        throw new ElementNotFound(json_encode($option, JSON_THROW_ON_ERROR), "Option inside {$select} matched by name or value");
+        throw new ElementNotFound(
+            json_encode($option, JSON_THROW_ON_ERROR),
+            "Option inside {$select} matched by name or value"
+        );
     }
 
     /**
@@ -1662,7 +1683,10 @@ public function _initializeSession(): void
             $this->initialWindowSize();
         } catch (WebDriverCurlException $exception) {
             codecept_debug('Curl error: ' . $exception->getMessage());
-            throw new ConnectionException("Can't connect to WebDriver at {$this->wdHost}. Make sure that ChromeDriver, GeckoDriver or Selenium Server is running.");
+            throw new ConnectionException(
+                "Can't connect to WebDriver at {$this->wdHost}.'"
+                . ' Make sure that ChromeDriver, GeckoDriver or Selenium Server is running.'
+            );
         }
     }
 
@@ -1765,8 +1789,11 @@ public function unselectOption($select, $option): void
     /**
      * @param string|array|WebDriverBy|WebDriverElement $radioOrCheckbox
      */
-    protected function findCheckable(WebDriverSearchContext $context, $radioOrCheckbox, bool $byValue = false): ?WebDriverElement
-    {
+    protected function findCheckable(
+        WebDriverSearchContext $context,
+        $radioOrCheckbox,
+        bool $byValue = false
+    ): ?WebDriverElement {
         if ($radioOrCheckbox instanceof WebDriverElement) {
             return $radioOrCheckbox;
         }
@@ -1786,23 +1813,22 @@ protected function findCheckable(WebDriverSearchContext $context, $radioOrCheckb
             $typeLiteral = static::xPathLiteral($contextType);
             $inputLocatorFragment = "input[@type = {$typeLiteral}][@name = {$nameLiteral}]";
             $xpath = Locator::combine(
-            // @codingStandardsIgnoreStart
                 "ancestor::form//{$inputLocatorFragment}[(@id = ancestor::form//label[contains(normalize-space(string(.)), {$locator})]/@for) or @placeholder = {$locator}]",
-                // @codingStandardsIgnoreEnd
                 "ancestor::form//label[contains(normalize-space(string(.)), {$locator})]//{$inputLocatorFragment}"
             );
             if ($byValue) {
                 $xpath = Locator::combine($xpath, "ancestor::form//{$inputLocatorFragment}[@value = {$locator}]");
             }
         } else {
             $xpath = Locator::combine(
-            // @codingStandardsIgnoreStart
                 "//input[@type = 'checkbox' or @type = 'radio'][(@id = //label[contains(normalize-space(string(.)), {$locator})]/@for) or @placeholder = {$locator} or @name = {$locator}]",
-                // @codingStandardsIgnoreEnd
                 "//label[contains(normalize-space(string(.)), {$locator})]//input[@type = 'radio' or @type = 'checkbox']"
             );
             if ($byValue) {
-                $xpath = Locator::combine($xpath, sprintf("//input[@type = 'checkbox' or @type = 'radio'][@value = %s]", $locator));
+                $xpath = Locator::combine(
+                    $xpath,
+                    sprintf("//input[@type = 'checkbox' or @type = 'radio'][@value = %s]", $locator)
+                );
             }
         }
 
@@ -2446,7 +2472,9 @@ public function submitForm($selector, array $params, $button = null): void
         $form = $this->matchFirstOrFail($this->getBaseElement(), $selector);
 
         $fields = $form->findElements(
-            WebDriverBy::cssSelector('input:enabled[name],textarea:enabled[name],select:enabled[name],input[type=hidden][name]')
+            WebDriverBy::cssSelector(
+                'input:enabled[name],textarea:enabled[name],select:enabled[name],input[type=hidden][name]'
+            )
         );
         foreach ($fields as $field) {
             $fieldName = $this->getSubmissionFormFieldName($field->getAttribute('name') ?? '');
@@ -3278,7 +3306,10 @@ public function appendField($field, string $value): void
                     return;
                 }
 
-                throw new ElementNotFound(json_encode($value, JSON_THROW_ON_ERROR), "Option inside {$field} matched by name or value");
+                throw new ElementNotFound(
+                    json_encode($value, JSON_THROW_ON_ERROR),
+                    "Option inside {$field} matched by name or value"
+                );
             case "textarea":
                 $el->sendKeys($value);
                 return;
@@ -3491,7 +3522,7 @@ public function openNewTab(): void
     public function seeNumberOfTabs($number): void
     {
         $this->assertSame(count($this->webDriver->getWindowHandles()), $number);
-    }    
+    }
 
     /**
      * Closes current browser tab and switches to previous active tab.
@@ -3697,5 +3728,4 @@ private static function xPathLiteral($s): string
 
         return sprintf('concat(%s)', implode(', ', $parts));
     }
-
 }