#54: Set a global value for timeouts that's used across all wait related actions

- Added WAIT_TIMEOUT environment variable to .env file
- Implemented getDefaultWaitTimeout method that retrieves WAIT_TIMEOUT environment variable or a constant value
- Edited wait action methods to use default timeout if not set

Author: vasylmalanka

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -13,11 +13,13 @@
 use Facebook\WebDriver\WebDriverSelect;
 use Facebook\WebDriver\WebDriverBy;
 use Facebook\WebDriver\Exception\NoSuchElementException;
+use Facebook\WebDriver\WebDriverExpectedCondition;
 use Codeception\Exception\ElementNotFound;
 use Codeception\Exception\ModuleConfigException;
 use Codeception\Exception\ModuleException;
 use Codeception\Util\Uri;
 use Codeception\Util\ActionSequence;
+use Codeception\Util\Locator;
 use Magento\FunctionalTestingFramework\Util\Protocol\CurlTransport;
 use Magento\FunctionalTestingFramework\Util\Protocol\CurlInterface;
 use Magento\Setup\Exception;
@@ -55,6 +57,8 @@ class MagentoWebDriver extends WebDriver
         '//div[@data-role="spinner"]'
     ];
 
+    const DEFAULT_WAIT_TIMEOUT = 10;
+
     /**
      * The module required fields, to be set in the suite .yml configuration file.
      *
@@ -115,6 +119,11 @@ public function _resetConfig()
         $this->config = ConfigSanitizerUtil::sanitizeWebDriverConfig($this->config);
     }
 
+    public function getDefaultWaitTimeout()
+    {
+        return getenv('WAIT_TIMEOUT') ?: self::DEFAULT_WAIT_TIMEOUT;
+    }
+
     /**
      * Returns URL of a host.
      *
@@ -301,14 +310,148 @@ public function selectMultipleOptions($selectSearchTextField, $selectSearchResul
         }
     }
 
+    /**
+     * Wait for $timeout seconds.
+     *
+     * @param int|float $timeout secs
+     * @throws \Codeception\Exception\TestRuntimeException
+     */
+    public function wait($timeout = null)
+    {
+        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+
+        if ($timeout >= 1000) {
+            throw new TestRuntimeException(
+                "
+                Waiting for more then 1000 seconds: 16.6667 mins\n
+                Please note that wait method accepts number of seconds as parameter."
+            );
+        }
+        usleep($timeout * 1000000);
+    }
+
+    /**
+     * Waits up to $timeout seconds for the given element to change.
+     *
+     * @param $element
+     * @param \Closure $callback
+     * @param int $timeout seconds
+     * @throws \Codeception\Exception\ElementNotFound
+     * @throws \Exception
+     */
+    public function waitForElementChange($element, \Closure $callback, $timeout = null)
+    {
+        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+
+        $el = $this->matchFirstOrFail($this->baseElement, $element);
+        $checker = function () use ($el, $callback) {
+            return $callback($el);
+        };
+        $this->webDriver->wait($timeout)->until($checker);
+    }
+
+    /**
+     * Waits up to $timeout seconds for an element to appear on the page.
+     *
+     * @param $element
+     * @param int $timeout seconds
+     * @throws \Exception
+     */
+    public function waitForElement($element, $timeout = null)
+    {
+        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+
+        $condition = WebDriverExpectedCondition::presenceOfElementLocated($this->getLocator($element));
+        $this->webDriver->wait($timeout)->until($condition);
+    }
+
+    /**
+     * Waits up to $timeout seconds for the given element to be visible on the page.
+     *
+     * @param $element
+     * @param int $timeout seconds
+     * @throws \Exception
+     */
+    public function waitForElementVisible($element, $timeout = null)
+    {
+        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+
+        $condition = WebDriverExpectedCondition::visibilityOfElementLocated($this->getLocator($element));
+        $this->webDriver->wait($timeout)->until($condition);
+    }
+
+    /**
+     * Waits up to $timeout seconds for the given element to become invisible.
+     *
+     * @param $element
+     * @param int $timeout seconds
+     * @throws \Exception
+     */
+    public function waitForElementNotVisible($element, $timeout = null)
+    {
+        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+
+        $condition = WebDriverExpectedCondition::invisibilityOfElementLocated($this->getLocator($element));
+        $this->webDriver->wait($timeout)->until($condition);
+    }
+
+    /**
+     * Waits up to $timeout seconds for the given string to appear on the page.
+     *
+     * @param string $text
+     * @param int $timeout seconds
+     * @param string $selector optional
+     * @throws \Exception
+     */
+    public function waitForText($text, $timeout = null, $selector = null)
+    {
+        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+
+        $message = sprintf(
+            'Waited for %d secs but text %s still not found',
+            $timeout,
+            Locator::humanReadableString($text)
+        );
+        if (!$selector) {
+            $condition = WebDriverExpectedCondition::elementTextContains(WebDriverBy::xpath('//body'), $text);
+            $this->webDriver->wait($timeout)->until($condition, $message);
+            return;
+        }
+
+        $condition = WebDriverExpectedCondition::elementTextContains($this->getLocator($selector), $text);
+        $this->webDriver->wait($timeout)->until($condition, $message);
+    }
+
+    /**
+     * Executes JavaScript and waits up to $timeout seconds for it to return true.
+     *
+     * @param string $script
+     * @param int $timeout seconds
+     * @throws \Exception
+     */
+    public function waitForJS($script, $timeout = null)
+    {
+        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+
+        $condition = function ($wd) use ($script) {
+            return $wd->executeScript($script);
+        };
+        $message = sprintf(
+            'Waited for %d secs but script %s still not executed',
+            $timeout,
+            Locator::humanReadableString($script)
+        );
+        $this->webDriver->wait($timeout)->until($condition, $message);
+    }
+
     /**
      * Wait for all Ajax calls to finish.
      *
      * @param int $timeout
      */
     public function waitForAjaxLoad($timeout = null)
     {
-        $timeout = $timeout ?? $this->_getConfig()['pageload_timeout'];
+        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
 
         try {
             $this->waitForJS('return !!window.jQuery && window.jQuery.active == 0;', $timeout);
@@ -327,7 +470,7 @@ public function waitForAjaxLoad($timeout = null)
      */
     public function waitForPageLoad($timeout = null)
     {
-        $timeout = $timeout ?? $this->_getConfig()['pageload_timeout'];
+        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
 
         $this->waitForJS('return document.readyState == "complete"', $timeout);
         $this->waitForAjaxLoad($timeout);