MQE-1117: dontSeeJsError does not catch JS errors

jilu1 · jilu1 · commit 8b2fa37b88e5 · 2018-09-24T10:27:43.000-05:00
- changed to only check js errors in current page
diff --git a/etc/config/codeception.dist.yml b/etc/config/codeception.dist.yml
@@ -23,5 +23,7 @@ extensions:
                 - env
                 - zephyrId
                 - useCaseId
+        Magento\FunctionalTestingFramework\Extension\TestContextExtension:
+            driver: \Magento\FunctionalTestingFramework\Module\MagentoWebDriver
 params:
     - .env
diff --git a/src/Magento/FunctionalTestingFramework/Extension/BaseExtension.php b/src/Magento/FunctionalTestingFramework/Extension/BaseExtension.php
@@ -0,0 +1,101 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\FunctionalTestingFramework\Extension;
+
+use Codeception\Events;
+use Codeception\Exception\ModuleRequireException;
+use Codeception\Extension;
+use Codeception\Module\WebDriver;
+use Codeception\Step;
+
+/**
+ * Class BaseExtension
+ */
+class BaseExtension extends Extension
+{
+    /**
+     * Codeception Events Mapping to methods
+     *
+     * @var array
+     */
+    public static $events = [
+        Events::TEST_BEFORE => 'beforeTest',
+        Events::STEP_BEFORE => 'beforeStep'
+    ];
+
+    /**
+     * The current URI of the active page
+     *
+     * @var string
+     */
+    private $uri;
+
+    /**
+     * Codeception event listener function - initialize uri before test
+     *
+     * @param \Codeception\Event\TestEvent $e
+     * @return void
+     * @throws \Exception
+     */
+    public function beforeTest(\Codeception\Event\TestEvent $e)
+    {
+        $this->uri = null;
+    }
+
+    /**
+     * Codeception event listener function - check for page uri change before step
+     *
+     * @param \Codeception\Event\StepEvent $e
+     * @return void
+     * @throws \Exception
+     */
+    public function beforeStep(\Codeception\Event\StepEvent $e)
+    {
+        $this->pageChanged();
+    }
+
+    /**
+     * WebDriver instance for execution
+     *
+     * @return WebDriver
+     * @throws ModuleRequireException
+     */
+    public function getDriver()
+    {
+        return $this->getModule($this->config['driver']);
+    }
+
+    /**
+     * Gets the active page URI from the start of the most recent step
+     *
+     * @return string
+     */
+    public function getUri()
+    {
+        return $this->uri;
+    }
+
+    /**
+     * Check if page uri has changed
+     *
+     * @return boolean
+     */
+    protected function pageChanged()
+    {
+        try {
+            $currentUri = $this->getDriver()->_getCurrentUri();
+
+            if ($this->uri !== $currentUri) {
+                $this->uri = $currentUri;
+                return true;
+            }
+        } catch (\Exception $e) {
+            // just fall through and return false
+        }
+        return false;
+    }
+}
diff --git a/src/Magento/FunctionalTestingFramework/Extension/PageReadinessExtension.php b/src/Magento/FunctionalTestingFramework/Extension/PageReadinessExtension.php
@@ -8,10 +8,6 @@
 
 use Codeception\Event\StepEvent;
 use Codeception\Event\TestEvent;
-use Codeception\Events;
-use Codeception\Exception\ModuleRequireException;
-use Codeception\Extension;
-use Codeception\Module\WebDriver;
 use Codeception\Step;
 use Facebook\WebDriver\Exception\UnexpectedAlertOpenException;
 use Magento\FunctionalTestingFramework\Extension\ReadinessMetrics\AbstractMetricCheck;
@@ -23,18 +19,8 @@
 /**
  * Class PageReadinessExtension
  */
-class PageReadinessExtension extends Extension
+class PageReadinessExtension extends BaseExtension
 {
-    /**
-     * Codeception Events Mapping to methods
-     *
-     * @var array
-     */
-    public static $events = [
-        Events::TEST_BEFORE => 'beforeTest',
-        Events::STEP_BEFORE => 'beforeStep'
-    ];
-
     /**
      * List of action types that should bypass metric checks
      * shouldSkipCheck() also checks for the 'Comment' step type, which doesn't follow the $step->getAction() pattern
@@ -73,13 +59,6 @@ class PageReadinessExtension extends Extension
      */
     private $testName;
 
-    /**
-     * The current URI of the active page
-     *
-     * @var string
-     */
-    private $uri;
-
     /**
      * Initialize local vars
      *
@@ -90,35 +69,26 @@ public function _initialize()
     {
         $this->logger = LoggingUtil::getInstance()->getLogger(get_class($this));
         $this->verbose = MftfApplicationConfig::getConfig()->verboseEnabled();
-    }
-
-    /**
-     * WebDriver instance to use to execute readiness metric checks
-     *
-     * @return WebDriver
-     * @throws ModuleRequireException
-     */
-    public function getDriver()
-    {
-        return $this->getModule($this->config['driver']);
+        parent::_initialize();
     }
 
     /**
      * Initialize the readiness metrics for the test
      *
-     * @param \Codeception\Event\TestEvent $e
+     * @param TestEvent $e
      * @return void
+     * @throws \Exception
      */
     public function beforeTest(TestEvent $e)
     {
+        parent::beforeTest($e);
         if (isset($this->config['resetFailureThreshold'])) {
             $failThreshold = intval($this->config['resetFailureThreshold']);
         } else {
             $failThreshold = 3;
         }
 
         $this->testName = $e->getTest()->getMetadata()->getName();
-        $this->uri = null;
 
         $this->getDriver()->_setConfig(['skipReadiness' => false]);
 
@@ -145,7 +115,20 @@ public function beforeStep(StepEvent $e)
             return;
         }
 
-        $this->checkForNewPage($step);
+        // Check if page has changed and reset metric tracking if so
+        if ($this->pageChanged($step)) {
+            $this->logDebug(
+                'Page URI changed; resetting readiness metric failure tracking',
+                [
+                    'step' => $step->__toString(),
+                    'newUri' => $this->getUri()
+                ]
+            );
+            /** @var AbstractMetricCheck $metric */
+            foreach ($this->readinessMetrics as $metric) {
+                $metric->resetTracker();
+            }
+        }
 
         // todo: Implement step parameter to override global timeout configuration
         if (isset($this->config['timeout'])) {
@@ -182,48 +165,6 @@ function () use ($metrics) {
         }
     }
 
-    /**
-     * Check if the URI has changed and reset metric tracking if so
-     *
-     * @param Step $step
-     * @return void
-     */
-    private function checkForNewPage($step)
-    {
-        try {
-            $currentUri = $this->getDriver()->_getCurrentUri();
-
-            if ($this->uri !== $currentUri) {
-                $this->logDebug(
-                    'Page URI changed; resetting readiness metric failure tracking',
-                    [
-                        'step' => $step->__toString(),
-                        'newUri' => $currentUri
-                    ]
-                );
-
-                /** @var AbstractMetricCheck $metric */
-                foreach ($this->readinessMetrics as $metric) {
-                    $metric->resetTracker();
-                }
-
-                $this->uri = $currentUri;
-            }
-        } catch (\Exception $e) {
-            $this->logDebug('Could not retrieve current URI', ['step' => $step->__toString()]);
-        }
-    }
-
-    /**
-     * Gets the active page URI from the start of the most recent step
-     *
-     * @return string
-     */
-    public function getUri()
-    {
-        return $this->uri;
-    }
-
     /**
      * Gets the name of the active test
      *
@@ -263,7 +204,7 @@ private function logDebug($message, $context = [])
         if ($this->verbose) {
             $logContext = [
                 'test' => $this->testName,
-                'uri' => $this->uri
+                'uri' => $this->getUri()
             ];
             foreach ($this->readinessMetrics as $metric) {
                 $logContext[$metric->getName()] = $metric->getStoredValue();
diff --git a/src/Magento/FunctionalTestingFramework/Extension/ReadinessMetrics/AbstractMetricCheck.php b/src/Magento/FunctionalTestingFramework/Extension/ReadinessMetrics/AbstractMetricCheck.php
@@ -214,7 +214,6 @@ protected function getDriver()
      * @param string $script
      * @param array  $arguments
      * @return mixed
-     * @throws UnexpectedAlertOpenException
      * @throws ModuleRequireException
      */
     protected function executeJs($script, $arguments = [])
diff --git a/src/Magento/FunctionalTestingFramework/Extension/TestContextExtension.php b/src/Magento/FunctionalTestingFramework/Extension/TestContextExtension.php
@@ -6,32 +6,40 @@
 
 namespace Magento\FunctionalTestingFramework\Extension;
 
-use \Codeception\Events;
+use Codeception\Events;
 use Magento\FunctionalTestingFramework\DataGenerator\Handlers\PersistedObjectHandler;
-use Magento\FunctionalTestingFramework\Extension\ErrorLogger;
-use Magento\FunctionalTestingFramework\Module\MagentoWebDriver;
 
 /**
  * Class TestContextExtension
  * @SuppressWarnings(PHPMD.UnusedPrivateField)
  */
-class TestContextExtension extends \Codeception\Extension
+class TestContextExtension extends BaseExtension
 {
     const TEST_PHASE_AFTER = "_after";
-    // @codingStandardsIgnoreStart
-    const MAGENTO_WEB_DRIVER_CLASS = "\Magento\FunctionalTestingFramework\Module\MagentoWebDriver";
-    // @codingStandardsIgnoreEnd
 
     /**
      * Codeception Events Mapping to methods
      * @var array
      */
-    public static $events = [
-        Events::TEST_START => 'testStart',
-        Events::TEST_FAIL => 'testFail',
-        Events::STEP_AFTER => 'afterStep',
-        Events::TEST_END => 'testEnd'
-    ];
+    public static $events;
+
+    /**
+     * Initialize local vars
+     *
+     * @return void
+     * @throws \Exception
+     */
+    public function _initialize()
+    {
+        $events = [
+            Events::TEST_START => 'testStart',
+            Events::TEST_FAIL => 'testFail',
+            Events::STEP_AFTER => 'afterStep',
+            Events::TEST_END => 'testEnd'
+        ];
+        self::$events = array_merge(parent::$events, $events);
+        parent::_initialize();
+    }
 
     /**
      * Codeception event listener function, triggered on test start.
@@ -64,6 +72,7 @@ public function testFail(\Codeception\Event\FailEvent $e)
      * Codeception event listener function, triggered on test ending (naturally or by error).
      * @param \Codeception\Event\TestEvent $e
      * @return void
+     * @throws \Exception
      */
     public function testEnd(\Codeception\Event\TestEvent $e)
     {
@@ -92,12 +101,12 @@ function () use ($cest) {
             }
         }
         // Reset Session and Cookies after all Test Runs, workaround due to functional.suite.yml restart: true
-        $this->getModule(self::MAGENTO_WEB_DRIVER_CLASS)->_runAfter($e->getTest());
+        $this->getDriver()->_runAfter($e->getTest());
     }
 
     /**
      * Runs cest's after block, if necessary.
-     * @param Symfony\Component\EventDispatcher\Event $e
+     * @param \Symfony\Component\EventDispatcher\Event $e
      * @param \Codeception\TestInterface              $cest
      * @return void
      */
@@ -135,16 +144,30 @@ public function extractContext($trace, $class)
         return null;
     }
 
+    /**
+     * Codeception event listener function, triggered before step.
+     * Check if it's a new page.
+     *
+     * @param \Codeception\Event\StepEvent $e
+     * @return void
+     * @throws \Exception
+     */
+    public function beforeStep(\Codeception\Event\StepEvent $e)
+    {
+        if ($this->pageChanged($e->getStep())) {
+            $this->getDriver()->cleanJsError();
+        }
+    }
+
     /**
      * Codeception event listener function, triggered after step.
      * Calls ErrorLogger to log JS errors encountered.
      * @param \Codeception\Event\StepEvent $e
      * @return void
+     * @throws \Exception
      */
     public function afterStep(\Codeception\Event\StepEvent $e)
     {
-        // @codingStandardsIgnoreStart
-        ErrorLogger::getInstance()->logErrors($this->getModule(self::MAGENTO_WEB_DRIVER_CLASS), $e);
-        // @codingStandardsIgnoreEnd
+        ErrorLogger::getInstance()->logErrors($this->getDriver(), $e);
     }
 }
diff --git a/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php b/src/Magento/FunctionalTestingFramework/Module/MagentoWebDriver.php
