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

- Reverted MagentoWebDriver class
- Moved getDefaultWaitTimeout method to ActionObject class
- Changed generateStepsPhp method in TestGenerator class to use timeout from getDefaultWaitTimeout method if not set
- Moved and fixed unit test for the implementation

Author: vasylmalanka

.env.example

@@ -36,5 +36,5 @@ MODULE_WHITELIST=Magento_Framework,Magento_ConfigurableProductWishlist,Magento_C
 #MFTF_DEBUG=
 
 #*** Default timeout for wait actions
-WAIT_TIMEOUT=20
+WAIT_TIMEOUT=10
 #*** End of .env ***#

dev/tests/unit/Magento/FunctionalTestFramework/Module/MagentoWebDriverTest.php

@@ -291,6 +291,19 @@ public function testTooManyArgumentException()
         $actionObject->resolveReferences();
     }
 
+    /**
+     * Method should return either .env file value or constant value
+     */
+    public function testGetDefaultWaitTimeout()
+    {
+        $this->assertEquals(ActionObject::getDefaultWaitTimeout(), ActionObject::DEFAULT_WAIT_TIMEOUT);
+
+        $envFile = new \Dotenv\Dotenv(__DIR__ . '/../../../../../../../', '.env.example');
+        $envFile->load();
+
+        $this->assertEquals(ActionObject::getDefaultWaitTimeout(), getenv('WAIT_TIMEOUT'));
+    }
+
     private function mockSectionHandlerWithElement($elementObject)
     {
         $sectionObject = new SectionObject('SectionObject', ['elementObject' => $elementObject]);

dev/tests/unit/Magento/FunctionalTestFramework/Test/Objects/ActionObjectTest.php

@@ -13,13 +13,11 @@
 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;
@@ -57,8 +55,6 @@ 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.
      *
@@ -119,16 +115,6 @@ public function _resetConfig()
         $this->config = ConfigSanitizerUtil::sanitizeWebDriverConfig($this->config);
     }
 
-    /**
-     * Retrieve default timeout in seconds for 'wait*' actions
-     *
-     * @return int
-     */
-    public static function getDefaultWaitTimeout()
-    {
-        return getenv('WAIT_TIMEOUT') ?: self::DEFAULT_WAIT_TIMEOUT;
-    }
-
     /**
      * Returns URL of a host.
      *
@@ -315,148 +301,14 @@ 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 ?? self::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 ?? self::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 ?? self::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 ?? self::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 ?? self::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 ?? self::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 ?? self::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 ?? self::getDefaultWaitTimeout();
+        $timeout = $timeout ?? $this->_getConfig()['pageload_timeout'];
 
         try {
             $this->waitForJS('return !!window.jQuery && window.jQuery.active == 0;', $timeout);
@@ -475,7 +327,7 @@ public function waitForAjaxLoad($timeout = null)
      */
     public function waitForPageLoad($timeout = null)
     {
-        $timeout = $timeout ?? self::getDefaultWaitTimeout();
+        $timeout = $timeout ?? $this->_getConfig()['pageload_timeout'];
 
         $this->waitForJS('return document.readyState == "complete"', $timeout);
         $this->waitForAjaxLoad($timeout);

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -42,6 +42,7 @@ class ActionObject
     const ACTION_ATTRIBUTE_VARIABLE_REGEX_PARAMETER = '/\(.+\)/';
     const ACTION_ATTRIBUTE_VARIABLE_REGEX_PATTERN = '/{{[\w]+\.[\w\[\]]+}}/';
     const ACTION_ATTRIBUTE_VARIABLE_REGEX_PATTERN_WITH_PARAMS= '/{{[\w]+\.[\w]+\(.+\)}}/';
+    const DEFAULT_WAIT_TIMEOUT = 10;
 
     /**
      * The unique identifier for the action
@@ -128,6 +129,16 @@ public function __construct(
         }
     }
 
+    /**
+     * Retrieve default timeout in seconds for 'wait*' actions
+     *
+     * @return int
+     */
+    public static function getDefaultWaitTimeout()
+    {
+        return getenv('WAIT_TIMEOUT') ?: self::DEFAULT_WAIT_TIMEOUT;
+    }
+
     /**
      * This function returns the string property stepKey.
      *

src/Magento/FunctionalTestingFramework/Test/Objects/ActionObject.php

@@ -492,6 +492,7 @@ private function generateStepsPhp($actionObjects, $hookObject = false)
             if (isset($customActionAttributes['timeout'])) {
                 $time = $customActionAttributes['timeout'];
             }
+            $time = $time ?? ActionObject::getDefaultWaitTimeout();
 
             if (isset($customActionAttributes['parameterArray']) && $actionObject->getType() != 'pressKey') {
                 // validate the param array is in the correct format