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

- Added PHPDoc block to getDefaultWaitTimeout method
- Changed usage of getDefaultWaitTimeout static method in other methods

Author: vasylmalanka

src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php

@@ -119,6 +119,11 @@ 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;
@@ -318,7 +323,7 @@ public function selectMultipleOptions($selectSearchTextField, $selectSearchResul
      */
     public function wait($timeout = null)
     {
-        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+        $timeout = $timeout ?? self::getDefaultWaitTimeout();
 
         if ($timeout >= 1000) {
             throw new TestRuntimeException(
@@ -341,7 +346,7 @@ public function wait($timeout = null)
      */
     public function waitForElementChange($element, \Closure $callback, $timeout = null)
     {
-        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+        $timeout = $timeout ?? self::getDefaultWaitTimeout();
 
         $el = $this->matchFirstOrFail($this->baseElement, $element);
         $checker = function () use ($el, $callback) {
@@ -359,7 +364,7 @@ public function waitForElementChange($element, \Closure $callback, $timeout = nu
      */
     public function waitForElement($element, $timeout = null)
     {
-        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+        $timeout = $timeout ?? self::getDefaultWaitTimeout();
 
         $condition = WebDriverExpectedCondition::presenceOfElementLocated($this->getLocator($element));
         $this->webDriver->wait($timeout)->until($condition);
@@ -374,7 +379,7 @@ public function waitForElement($element, $timeout = null)
      */
     public function waitForElementVisible($element, $timeout = null)
     {
-        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+        $timeout = $timeout ?? self::getDefaultWaitTimeout();
 
         $condition = WebDriverExpectedCondition::visibilityOfElementLocated($this->getLocator($element));
         $this->webDriver->wait($timeout)->until($condition);
@@ -389,7 +394,7 @@ public function waitForElementVisible($element, $timeout = null)
      */
     public function waitForElementNotVisible($element, $timeout = null)
     {
-        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+        $timeout = $timeout ?? self::getDefaultWaitTimeout();
 
         $condition = WebDriverExpectedCondition::invisibilityOfElementLocated($this->getLocator($element));
         $this->webDriver->wait($timeout)->until($condition);
@@ -405,7 +410,7 @@ public function waitForElementNotVisible($element, $timeout = null)
      */
     public function waitForText($text, $timeout = null, $selector = null)
     {
-        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+        $timeout = $timeout ?? self::getDefaultWaitTimeout();
 
         $message = sprintf(
             'Waited for %d secs but text %s still not found',
@@ -431,7 +436,7 @@ public function waitForText($text, $timeout = null, $selector = null)
      */
     public function waitForJS($script, $timeout = null)
     {
-        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+        $timeout = $timeout ?? self::getDefaultWaitTimeout();
 
         $condition = function ($wd) use ($script) {
             return $wd->executeScript($script);
@@ -451,7 +456,7 @@ public function waitForJS($script, $timeout = null)
      */
     public function waitForAjaxLoad($timeout = null)
     {
-        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+        $timeout = $timeout ?? self::getDefaultWaitTimeout();
 
         try {
             $this->waitForJS('return !!window.jQuery && window.jQuery.active == 0;', $timeout);
@@ -470,7 +475,7 @@ public function waitForAjaxLoad($timeout = null)
      */
     public function waitForPageLoad($timeout = null)
     {
-        $timeout = $timeout ?? $this->getDefaultWaitTimeout();
+        $timeout = $timeout ?? self::getDefaultWaitTimeout();
 
         $this->waitForJS('return document.readyState == "complete"', $timeout);
         $this->waitForAjaxLoad($timeout);