MQE-1644: Add ability to see JS log in Allure

- Addec blacklist
- Renamed variables

Author: KevinBKozan

etc/config/.env.example

@@ -54,4 +54,9 @@ MODULE_WHITELIST=Magento_Framework,ConfigurableProductWishlist,ConfigurableProdu
 
 #*** Default timeout for wait actions
 #WAIT_TIMEOUT=10
+
+#*** Uncomment and set to enable browser log entries on actions in Allure. Blacklist is used to filter logs of a specific "source"
+#ENABLE_BROWSER_LOG=true
+#BROWSER_LOG_BLACKLIST=other
+
 #*** End of .env ***#

src/Magento/FunctionalTestingFramework/Extension/ErrorLogger.php

@@ -64,7 +64,7 @@ public function logErrors($module, $stepEvent)
     }
 
     /**
-     * Loops through given logs and returns entries of the given type.
+     * Loops through given log and returns entries of the given type.
      *
      * @param array $log
      * @param string $type
@@ -81,6 +81,24 @@ public function getLogsOfType($log, $type)
         return $errors;
     }
 
+    /**
+     * Loops through given log and filters entries of the given type.
+     *
+     * @param array $log
+     * @param string $type
+     * @return array
+     */
+    public function filterLogsOfType($log, $type)
+    {
+        $errors = [];
+        foreach ($log as $entry) {
+            if (array_key_exists("source", $entry) && $entry["source"] !== $type) {
+                $errors[] = $entry;
+            }
+        }
+        return $errors;
+    }
+
     /**
      * Logs errors to console/report.
      * @param string                       $type

src/Magento/FunctionalTestingFramework/Extension/TestContextExtension.php

@@ -174,11 +174,14 @@ public function beforeStep(\Codeception\Event\StepEvent $e)
      */
     public function afterStep(\Codeception\Event\StepEvent $e)
     {
-        if (getenv('ENABLE_JS_LOG')) {
-            $browserLogEntries = $this->getDriver()->webDriver->manage()->getLog("browser");
-            $jsErrors = ErrorLogger::getInstance()->getLogsOfType($browserLogEntries, ErrorLogger::ERROR_TYPE_JAVASCRIPT);
-            if (!empty($jsErrors)) {
-                AllureHelper::addAttachmentToCurrentStep($jsErrors);
+        if (getenv('ENABLE_BROWSER_LOG')) {
+            $browserLog = $this->getDriver()->webDriver->manage()->getLog("browser");
+            foreach (explode(',', getenv('BROWSER_LOG_BLACKLIST')) as $source) {
+                $browserLog = ErrorLogger::getInstance()->filterLogsOfType($browserLog, $source);
+            }
+
+            if (!empty($browserLog)) {
+                AllureHelper::addAttachmentToCurrentStep(json_encode($browserLog, JSON_PRETTY_PRINT), "Browser Log");
             }
         }
         ErrorLogger::getInstance()->logErrors($this->getDriver(), $e);