MQE-501: JavaScript reporting during test run

- Added ErrorLogger object, called after steps in the ContextListener

Author: KevinBKozan

src/Magento/FunctionalTestingFramework/Extension/ErrorLogger.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\FunctionalTestingFramework\Extension;
+
+/**
+ * Class ErrorLogger
+ * @package Magento\FunctionalTestingFramework\Extension
+ */
+class ErrorLogger
+{
+    /**
+     * Error Logger Instance
+     * @var ErrorLogger
+     */
+    private static $errorLogger;
+
+    /**
+     * Singleton method to return ErrorLogger.
+     * @return ErrorLogger
+     */
+    public static function getInstance()
+    {
+        if (!self::$errorLogger) {
+            self::$errorLogger = new ErrorLogger();
+        }
+
+        return self::$errorLogger;
+    }
+
+    /**
+     * ErrorLogger constructor.
+     */
+    private function __construct()
+    {
+        // private constructor
+    }
+
+    /**
+     * Loops through stepEvent for browser log entries
+     * @param \Facebook\WebDriver\Remote\RemoteWebDriver $webDriver
+     * @param \Codeception\Event\StepEvent $stepEvent
+     * @return void
+     */
+    public function logErrors($webDriver, $stepEvent)
+    {
+        //Types available should be "server", "browser", "driver". Only care about browser at the moment.
+        $browserLogEntries = $webDriver->manage()->getLog("browser");
+        foreach ($browserLogEntries as $entry) {
+            if ($entry["source"] === "javascript") {
+                $this->logError("javascript", $stepEvent, $entry);
+            }
+        }
+    }
+
+    /**
+     * Logs errors to console/report.
+     * @param string $type
+     * @param \Codeception\Event\StepEvent $stepEvent
+     * @param array $entry
+     * @return void
+     */
+    private function logError($type, $stepEvent, $entry)
+    {
+        //TODO Add to overall log
+        $stepEvent->getTest()->getScenario()->comment("{$type} ERROR({$entry["level"]}) - " . $entry["message"]);
+    }
+}

src/Magento/FunctionalTestingFramework/Extension/TestContextExtension.php

@@ -7,6 +7,7 @@
 namespace Magento\FunctionalTestingFramework\Extension;
 
 use \Codeception\Events;
+use Magento\FunctionalTestingFramework\Extension\ErrorLogger;
 
 /**
  * Class TestContextExtension
@@ -22,6 +23,7 @@ class TestContextExtension extends \Codeception\Extension
      */
     public static $events = [
         Events::TEST_FAIL => 'testFail',
+        Events::STEP_AFTER => 'afterStep'
     ];
 
     /**
@@ -68,4 +70,16 @@ public function extractContext($trace, $class)
         }
         return null;
     }
+
+    /**
+     * Codeception event listener function, triggered after step.
+     * Calls ErrorLogger to log JS errors encountered.
+     * @param \Codeception\Event\StepEvent $e
+     * @return void
+     */
+    public function afterStep(\Codeception\Event\StepEvent $e)
+    {
+        $webDriver = $this->getModule("\Magento\FunctionalTestingFramework\Module\MagentoWebDriver")->webDriver;
+        ErrorLogger::getInstance()->logErrors($webDriver, $e);
+    }
 }