Merge pull request #182 from archfz/develop

#180: Implement support for mochawesome integration.

.gitignore

@@ -7,5 +7,6 @@ test/output/out.txt
 test/output/not/existing/path/out.txt
 test/output/out.cst
 test/output_nested
+test/cypress/reports
 .idea
 .vscode

README.md

@@ -7,7 +7,8 @@
 [Limitations](#limitations-and-notes)
 • [Install](#install)
 • [Options](#options)
-• [Logging after/before all](#logging-after-all-and-before-all-hooks)
+• [Integrations](#integrations)
+• [After/before all](#logging-after-all-and-before-all-hooks)
 • [Logging to files](#logging-to-files)
 • [Development](#development)
 • [Release Notes](#release-notes)
@@ -38,8 +39,6 @@ Try it out by cloning [cypress-terminal-report-demo](https://github.com/archfz/c
 - `console.log` usage was never meant to be used in the cypress test code. Using it will
   not log anything with this plugin. Using it also goes against the queue nature of 
   cypress. Use `cy.log` instead. [See here for more details](https://github.com/archfz/cypress-terminal-report/issues/67).
-- Using `cypress-fail-fast` and logging to files does not work out of the box. To enable support use 
-the [`logToFilesOnAfterRun`](#optionslogtofilesonafterrun) option.
 
 ## Install
 
@@ -200,6 +199,25 @@ tests are timing out.
   // ...
 ```
 
+## Integrations
+
+### `cypress-fail-fast`
+
+Logging to files does not work out of the box. To enable support use the 
+[`logToFilesOnAfterRun`](#optionslogtofilesonafterrun) option.
+
+### `cypress-mochawesome-reporter`
+
+The following example demonstrates adding logs to context for all tests (snippet from `e2e.js`):
+
+```js
+import 'cypress-mochawesome-reporter/register';
+
+afterEach(() => {
+    cy.wait(50, {log: false}).then(() => cy.addTestContext(Cypress.TerminalReport.getLogs('txt')))
+});
+```
+
 ## Logging after all and before all hooks
 
 Commands from before all and after all hooks are not logged by default. A new experimental feature introduces
@@ -332,6 +350,12 @@ directory. You should add `it.only` to the test case you are working on to speed
 
 ## Release Notes
 
+#### 5.1.0
+
+- Add global support side `Cypress.TerminalReport.getLogs()`.
+- Add example on how to integrate with [`mochawesome`](#cypress-mochawesome-reporter). [issue](https://github.com/archfz/cypress-terminal-report/issues/180)
+- Update cypress to 12.9.0 in tests to confirm support.
+
 #### 5.0.2
 
 - Fix existing log message not updating later. [issue](https://github.com/archfz/cypress-terminal-report/issues/173)

src/installLogsCollector.d.ts

@@ -1,6 +1,5 @@
 declare function installLogsCollector(config?: installLogsCollector.SupportOptions): void;
 declare namespace installLogsCollector {
-
   type Severity = '' | 'error' | 'warning';
 
   type LogType = 'cons:log' |
@@ -16,6 +15,8 @@ declare namespace installLogsCollector {
     'cy:command' |
     'ctr:info';
 
+  type Log = [/* type: */ LogType, /* message: */ string, /* severity: */ Severity];
+
   interface SupportOptions {
     /**
      * What types of logs to collect and print.
@@ -33,7 +34,7 @@ declare namespace installLogsCollector {
     filterLog?:
       | null
       | NonNullable<SupportOptions['collectTypes']>[number]
-      | ((args: [/* type: */ LogType, /* message: */ string, /* severity: */ Severity]) => boolean);
+      | ((args: Log) => boolean);
 
     /**
      * Callback to process logs manually. The type is from the same list as for the collectTypes option.
@@ -43,15 +44,15 @@ declare namespace installLogsCollector {
     processLog?:
         | null
         | NonNullable<SupportOptions['collectTypes']>[number]
-        | ((args: [/* type: */ LogType, /* message: */ string, /* severity: */ Severity]) => [LogType, string, Severity]);
+        | ((args: Log) => [LogType, string, Severity]);
 
     /**
      * Callback to collect each test case's logs after its run.
      * @default undefined
      */
     collectTestLogs?: (
       context: {mochaRunnable: any, testState: string, testTitle: string, testLevel: number},
-      messages: [/* type: */ LogType, /* message: */ string, /* severity: */ Severity][]
+      messages: Log[]
     ) => void;
 
     xhr?: {
@@ -89,4 +90,16 @@ declare namespace installLogsCollector {
     debug?: boolean;
   }
 }
+
+declare namespace Cypress {
+  interface TerminalReport {
+    getLogs<T extends 'txt' | 'json' | 'none' = 'none'>(format?: T): {
+      txt: string,
+      json: string,
+      none: installLogsCollector.Log[],
+    }[T];
+  }
+  const TerminalReport: TerminalReport;
+}
+
 export = installLogsCollector;

src/installLogsCollector.js

@@ -17,6 +17,8 @@ const LogCollectorState = require("./collector/LogCollectorState");
 const LogCollectExtendedControl = require("./collector/LogCollectExtendedControl");
 const LogCollectSimpleControl = require("./collector/LogCollectSimpleControl");
 
+const logsTxtFormatter = require("./outputProcessor/logsTxtFormatter");
+
 /**
  * Installs the logs collector for cypress.
  *
@@ -39,6 +41,8 @@ function installLogsCollector(config = {}) {
   } else {
     (new LogCollectSimpleControl(logCollectorState, config)).register();
   }
+
+  registerGlobalApi(logCollectorState);
 }
 
 function registerLogCollectorTypes(logCollectorState, config) {
@@ -64,6 +68,22 @@ function registerLogCollectorTypes(logCollectorState, config) {
   }
 }
 
+function registerGlobalApi(logCollectorState) {
+  Cypress.TerminalReport = {
+    getLogs: (format) => {
+      const logs = logCollectorState.getCurrentLogStack();
+
+      if (format === 'txt') {
+        return logsTxtFormatter(logs);
+      } else if (format === 'json') {
+        return JSON.stringify(logs, null, 2);
+      }
+
+      return logs;
+    },
+  };
+}
+
 function validateConfig(config) {
   const result = tv4.validateMultiple(config, schema);
 

src/outputProcessor/TextOutputProcessor.js

@@ -1,8 +1,7 @@
 const BaseOutputProcessor = require('./BaseOutputProcessor');
+const logsTxtFormatter = require('./logsTxtFormatter');
 
-const CONSTANTS = require('../constants');
 const PADDING = '    ';
-const PADDING_LOGS = `${PADDING}`.repeat(6);
 const {EOL} = require('os');
 
 module.exports = class TextOutputProcessor extends BaseOutputProcessor {
@@ -12,29 +11,13 @@ module.exports = class TextOutputProcessor extends BaseOutputProcessor {
     this.chunkSeparator = EOL + EOL;
   }
 
-  severityToFont(severity) {
-    return {
-      [CONSTANTS.SEVERITY.ERROR]: 'X',
-      [CONSTANTS.SEVERITY.WARNING]: '!',
-      [CONSTANTS.SEVERITY.SUCCESS]: 'K',
-    }[severity];
-  }
-
-  padTypeText(text) {
-    return Array(Math.max(PADDING_LOGS.length - text.length + 1, 0)).join(' ')
-      + text;
-  }
-
   write(allMessages) {
 
     Object.entries(allMessages).forEach(([spec, tests]) => {
       let text = `${spec}:${EOL}`;
       Object.entries(tests).forEach(([test, messages]) => {
         text += `${PADDING}${test}${EOL}`;
-        messages.forEach(([type, message, severity]) => {
-          text += (this.padTypeText(`${type} (${this.severityToFont(severity)}): `) +
-            message.replace(/\n/g, `${EOL}${PADDING_LOGS}`) + EOL).replace(/\s+\n/, '\n');
-        });
+        text += logsTxtFormatter(messages, EOL);
         text += EOL;
       });
 

src/outputProcessor/logsTxtFormatter.js

@@ -0,0 +1,22 @@
+const CONSTANTS = require("../constants");
+
+const PADDING = '    ';
+const PADDING_LOGS = `${PADDING}`.repeat(6);
+
+const padTypeText = (text) => {
+  return Array(Math.max(PADDING_LOGS.length - text.length + 1, 0)).join(' ')
+    + text;
+}
+
+function logsTxtFormatter(logs, EOL = '\n') {
+  return logs.map(([type, message, severity]) => {
+    return (padTypeText(`${type} (${{
+        [CONSTANTS.SEVERITY.ERROR]: 'X',
+        [CONSTANTS.SEVERITY.WARNING]: '!',
+        [CONSTANTS.SEVERITY.SUCCESS]: 'K',
+      }[severity]}): `) +
+      message.replace(/\n/g, `${EOL}${PADDING_LOGS}`) + EOL).replace(/\s+\n/, '\n');
+  }).join('');
+}
+
+module.exports = logsTxtFormatter;

test/cypress.config.js

@@ -8,6 +8,7 @@ module.exports = defineConfig({
     "baseUrl": "https://example.cypress.io",
     "video": false,
     "screenshotOnRunFailure": false,
+    reporter: 'cypress-mochawesome-reporter',
     specPattern: 'cypress/integration/**/*.spec.{js,jsx,ts,tsx}',
     async setupNodeEvents(on, config) {
       let options = {
@@ -134,6 +135,10 @@ module.exports = defineConfig({
         require("cypress-fail-fast/plugin")(on, config);
       }
 
+      if (config.env.mochawesome == '1') {
+        require('cypress-mochawesome-reporter/plugin')(on);
+      }
+
       require('../src/installLogsPrinter')(on, options);
 
       return config;

test/cypress/support/e2e.js

@@ -1,5 +1,6 @@
 import './commands';
 import registerCypressGrep from "cypress-grep";
+import 'cypress-mochawesome-reporter/register';
 
 const env = Cypress.env();
 let config = {};
@@ -91,6 +92,16 @@ if (env.enableContinuousLogging == '1') {
   config.enableContinuousLogging = true;
 }
 
+if (env.mochawesome == '1') {
+  afterEach(() => {
+    cy.wait(50, {log: false}).then(() => {
+      const logs = Cypress.TerminalReport.getLogs('txt');
+      cy.addTestContext(logs);
+      cy.log('Global API logs: ' + logs);
+    })
+  });
+}
+
 require('../../../src/installLogsCollector')(config);
 
 enableFetchWorkaround();