Merge pull request #2 from GrzegorzDrozd/add-additional-checks-and-parameters-to-js-console-logger

Add additional parameters and checks for js console logger

Author: benr77

doc/js-console-logger.md

@@ -13,6 +13,14 @@ per the installation instructions.
 extensions:
   enabled:
     - Headsnet\CodeceptionExtras\Extensions\JsConsoleLogger\JsConsoleLogger:
+      assert_no_warnings: true # default true
+      assert_no_errors: true   # default true
+      assert_no_console: true  # default true
 ```
+### Options
+
+- assert_no_warnings - assume that there are no warnings in javascript console.
+- assert_no_errors - assume that there are no errors in javascript console.
+- assert_no_console - assume that there are no console.log calls left in javascript.
 
 « [Back to package homepage](../../../)

src/Extensions/JsConsoleLogger/JsConsoleLogger.php

@@ -22,6 +22,7 @@
 
 final class JsConsoleLogger extends AbstractWebDriverExtension
 {
+
     /**
      * @var array<array|string>
      */
@@ -33,35 +34,76 @@ final class JsConsoleLogger extends AbstractWebDriverExtension
         Events::STEP_AFTER => 'afterStep',
     ];
 
+    /**
+     * Handle event
+     */
     public function afterStep(StepEvent $event): void
     {
         $this->checkJsErrors($event);
     }
 
+    /**
+     * Handle js errors if there are any
+     *
+     * @throws \Codeception\Exception\ModuleRequireException
+     */
     private function checkJsErrors(StepEvent $event): void
     {
         $this->webDriverModule->executeInSelenium(function (RemoteWebDriver $webDriver) use ($event): void {
             $log = $webDriver->manage()->getLog('browser');
 
-            $errors = array_values(array_filter($log, function ($entry): bool {
+            $logEntries = array_values(array_filter($log, function ($entry): bool {
                 // Permit the error about insecure passwords on non-https
                 return false === strpos($entry['message'], 'non-secure context') &&
                     false === strpos($entry['message'], '/_wdt/');
             }));
 
-            $errorMsg = count($errors) > 0 ? $errors[0]['message'] : '';
-
-            if (count($errors) > 0) {
-                $this->writeLogFile($event, $log);
+            if (count($logEntries) === 0) {
+                return;
             }
 
-            /** @var Asserts $asserts */
+            // set first entry message as general message
+            $errorMsg = count($logEntries) > 0 ? $logEntries[0]['message'] : '';
+
+            // write all entries into log file
+            $this->writeLogFile($event, $log);
             $asserts = $this->getModule('Asserts');
-            $asserts->assertCount(
-                0,
-                $errors,
-                'Javascript warning: ' . $errorMsg
-            );
+
+            $groupedErrors = [
+                'INFO'      => [],
+                'WARNING'   => [],
+                'SEVERE'    => []
+            ];
+            foreach($logEntries as $entry) {
+                $groupedErrors[$entry['level']][] = $entry;
+            }
+
+            if (!empty($this->config['assert_no_warnings'])) {
+                /** @var Asserts $asserts */
+                $asserts->assertCount(
+                    0,
+                    $groupedErrors['WARNING'],
+                    'Javascript warning: ' . $errorMsg
+                );
+            }
+
+            if (!empty($this->config['assert_no_errors'])) {
+                /** @var Asserts $asserts */
+                $asserts->assertCount(
+                    0,
+                    $groupedErrors['SEVERE'],
+                    'Javascript errors: ' . $errorMsg
+                );
+            }
+
+            if (!empty($this->config['assert_no_console'])) {
+                /** @var Asserts $asserts */
+                $asserts->assertCount(
+                    0,
+                    $groupedErrors['INFO'],
+                    'Javascript console entries: ' . $errorMsg
+                );
+            }
         });
     }
 
@@ -70,19 +112,24 @@ private function checkJsErrors(StepEvent $event): void
      */
     private function writeLogFile(StepEvent $event, array $log): void
     {
-        file_put_contents($this->getLogFileName($event), print_r($log, true));
+        // logs need to be appended when test case uses data provider
+        file_put_contents($this->getLogFileName($event), print_r($log, true), FILE_APPEND);
     }
 
     private function getLogFileName(StepEvent $event): string
     {
         return sprintf(
-            '%s/_output/%s.%s.fail.js-errors.txt',
-            dirname(__DIR__),
+            '%s/%s.%s.fail.js-errors.txt',
+            $this->getLogDir(),
             str_replace(['\\', ':'], '.', $this->getTestName($event)),
             $this->environment
         );
     }
 
+    /**
+     * @param StepEvent $event
+     * @return string
+     */
     private function getTestName(StepEvent $event): string
     {
         /** @var SelfDescribing $test */