@testomatio/reporter 1.1.0-beta.mocha-create.9 → 1.1.1-beta-codecept-logger

package/lib/adapter/codecept.js

@@ -4,6 +4,7 @@ const TestomatClient = require('../client');
 const { STATUS, APP_PREFIX, TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
 const upload = require('../fileUploader');
 const { parseTest: getIdFromTestTitle, fileSystem } = require('../utils/utils');
+const { logger } = require('../storages/logger');
 
 if (!global.codeceptjs) {
   // eslint-disable-next-line global-require, import/no-extraneous-dependencies
@@ -58,14 +59,47 @@ function CodeceptReporter(config) {
     // clear tmp dir
     fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
 
-    recorder.add('Creating new run', () => client.createRun());
+    // recorder.add('Creating new run', () => );
+    client.createRun();
     videos = [];
     traces = [];
 
     if (!global.testomatioDataStore) global.testomatioDataStore = {};
   });
 
-  event.dispatcher.on(event.test.before, () => {
+  let hookSteps = [];
+  let suiteHookRunning = false;
+
+  event.dispatcher.on(event.suite.before, suite => {
+    suiteHookRunning = true;
+    hookSteps = [];
+    global.testomatioDataStore.steps = [];
+
+    logger.setContext(suite.fullTitle());
+  });
+
+  event.dispatcher.on(event.suite.after, () => {
+    logger.setContext(null);
+  });
+
+  event.dispatcher.on(event.hook.started, () => {
+    // global.testomatioDataStore.steps = [];
+  });
+
+  event.dispatcher.on(event.hook.passed, () => {
+    if (suiteHookRunning) hookSteps.push(...global.testomatioDataStore.steps);
+    if (suiteHookRunning) logger.setContext(null);
+  });
+
+  event.dispatcher.on(event.hook.failed, () => {
+    if (suiteHookRunning) hookSteps.push(...global.testomatioDataStore.steps);
+    if (suiteHookRunning) logger.setContext(null);
+  });
+
+  event.dispatcher.on(event.test.before, test => {
+    suiteHookRunning = false;
+    global.testomatioDataStore.steps = [];
+
     recorder.add(() => {
       currentMetaStep = [];
       // output.reset();
@@ -76,11 +110,15 @@ function CodeceptReporter(config) {
     if (!global.testomatioDataStore) global.testomatioDataStore = {};
     // reset steps
     global.testomatioDataStore.steps = [];
+
+    logger.setContext(test.fullTitle());
   });
 
   event.dispatcher.on(event.test.started, test => {
+    logger.setContext(test.fullTitle());
     testTimeMap[test.id] = Date.now();
     if (global.testomatioDataStore) global.testomatioDataStore.currentlyRunningTestId = getIdFromTestTitle(test.title);
+    // start logging
   });
 
   event.dispatcher.on(event.all.result, async () => {
@@ -104,6 +142,9 @@ function CodeceptReporter(config) {
     }
     const testId = parseTest(tags);
     const testObj = getTestAndMessage(title);
+
+    const logs = getTestLogs(test);
+
     client.addTestRun(STATUS.PASSED, {
       ...stripExampleFromTitle(title),
       suite_title: test.parent && test.parent.title,
@@ -111,6 +152,7 @@ function CodeceptReporter(config) {
       time: getDuration(test),
       steps: global.testomatioDataStore.steps.join('\n') || null,
       test_id: testId,
+      logs,
     });
     // output.stop();
   });
@@ -152,6 +194,9 @@ function CodeceptReporter(config) {
     if (artifacts.screenshot) files.push({ path: artifacts.screenshot, type: 'image/png' });
     // todo: video must be uploaded later....
 
+    const logs = getTestLogs(test);
+    logger.setContext(null);
+
     const reportTestPromise = client
       .addTestRun(STATUS.FAILED, {
         ...stripExampleFromTitle(title),
@@ -162,6 +207,7 @@ function CodeceptReporter(config) {
         time: getDuration(test),
         files,
         steps: global.testomatioDataStore?.steps?.join('\n') || null,
+        logs,
       })
       .then(pipes => {
         testId = pipes.filter(p => p.pipe.includes('Testomatio'))[0]?.result?.data?.test_id;
@@ -230,7 +276,7 @@ function CodeceptReporter(config) {
     currentMetaStep = metaSteps;
     stepShift = 2 * shift;
 
-    const durationMs = +new Date() - (+stepStart);
+    const durationMs = +new Date() - +stepStart;
     let duration = '';
     if (durationMs) {
       duration = repeat(1) + chalk.grey(`(${durationMs}ms)`);
@@ -255,7 +301,7 @@ async function uploadAttachments(client, attachments, messagePrefix, attachmentT
   if (attachments.length > 0) {
     console.log(APP_PREFIX, `Attachments: ${messagePrefix} ${attachments.length} ${attachmentType}/-s ...`);
 
-    const promises = attachments.map(async (attachment) => {
+    const promises = attachments.map(async attachment => {
       const { testId, title, path, type } = attachment;
       const file = { path, type, title };
       return client.addTestRun(undefined, {
@@ -303,4 +349,21 @@ function repeat(num) {
   return ''.padStart(num, ' ');
 }
 
+// TODO: think about moving to some common utils
+function getTestLogs(test) {
+  const suiteLogsArr = logger.getLogs(test.parent.fullTitle());
+  const suiteLogs = suiteLogsArr ? suiteLogsArr.join('\n').trim() : '';
+  const testLogsArr = logger.getLogs(test.fullTitle());
+  const testLogs = testLogsArr ? testLogsArr.join('\n').trim() : '';
+
+  let logs = '';
+  if (suiteLogs) {
+    logs += `${chalk.bold('\t--- BeforeSuite ---')}\n${suiteLogs}`;
+  }
+  if (testLogs) {
+    logs += `\n${chalk.bold('\t--- Test ---')}\n${testLogs}`;
+  }
+  return logs;
+}
+
 module.exports = CodeceptReporter;

package/lib/adapter/mocha.js

@@ -4,9 +4,19 @@ const chalk = require('chalk');
 const TestomatClient = require('../client');
 const { STATUS, TESTOMAT_TMP_STORAGE_DIR } = require('../constants');
 const { parseTest, fileSystem } = require('../utils/utils');
-
-const { EVENT_RUN_BEGIN, EVENT_RUN_END, EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING } =
-  Mocha.Runner.constants;
+const { logger } = require('../storages/logger');
+
+const {
+  EVENT_RUN_BEGIN,
+  EVENT_RUN_END,
+  EVENT_TEST_FAIL,
+  EVENT_TEST_PASS,
+  EVENT_TEST_PENDING,
+  EVENT_SUITE_BEGIN,
+  EVENT_SUITE_END,
+  EVENT_TEST_BEGIN,
+  EVENT_TEST_END,
+} = Mocha.Runner.constants;
 
 function MochaReporter(runner, opts) {
   Mocha.reporters.Base.call(this, runner);
@@ -25,19 +35,34 @@ function MochaReporter(runner, opts) {
     fileSystem.clearDir(TESTOMAT_TMP_STORAGE_DIR);
   });
 
+  runner.on(EVENT_SUITE_BEGIN, async suite => {
+    logger.setContext(suite.fullTitle());
+  });
+
+  runner.on(EVENT_SUITE_END, async () => {
+    logger.setContext(null);
+  });
+
+  runner.on(EVENT_TEST_BEGIN, async test => {
+    logger.setContext(test.fullTitle());
+  });
+
+  runner.on(EVENT_TEST_END, async () => {
+    logger.setContext(null);
+  });
+
   runner.on(EVENT_TEST_PASS, async test => {
     passes += 1;
-  
     console.log(chalk.bold.green('✔'), test.fullTitle());
     const testId = parseTest(test.title);
 
+    const logs = getTestLogs(test);
+
     client.addTestRun(STATUS.PASSED, {
       test_id: testId,
-      suite_title: getSuiteTitle(test),
-      title: getTestName(test),
-      code: test.body.toString(),
-      file: getFile(test),
+      title: test.title,
       time: test.duration,
+      logs,
     });
   });
 
@@ -46,10 +71,7 @@ function MochaReporter(runner, opts) {
     console.log('skip: %s', test.fullTitle());
     const testId = parseTest(test.title);
     client.addTestRun(STATUS.SKIPPED, {
-      title: getTestName(test),
-      suite_title: getSuiteTitle(test),
-      code: test.body.toString(),
-      file: getFile(test),
+      title: test.title,
       test_id: testId,
       time: test.duration,
     });
@@ -60,14 +82,14 @@ function MochaReporter(runner, opts) {
     console.log(chalk.bold.red('✖'), test.fullTitle(), chalk.gray(err.message));
     const testId = parseTest(test.title);
 
+    const logs = getTestLogs(test);
+
     client.addTestRun(STATUS.FAILED, {
       error: err,
-      suite_title: getSuiteTitle(test),
-      file: getFile(test),
       test_id: testId,
-      title: getTestName(test),
-      code: test.body.toString(),
+      title: test.title,
       time: test.duration,
+      logs,
     });
   });
 
@@ -78,26 +100,23 @@ function MochaReporter(runner, opts) {
   });
 }
 
+function getTestLogs(test) {
+  const suiteLogsArr = logger.getLogs(test.parent.fullTitle());
+  const suiteLogs = suiteLogsArr ? suiteLogsArr.join('\n').trim() : '';
+  const testLogsArr = logger.getLogs(test.fullTitle());
+  const testLogs = testLogsArr ? testLogsArr.join('\n').trim() : '';
+
+  let logs = '';
+  if (suiteLogs) {
+    logs += `${chalk.bold('\t--- BeforeSuite ---')}\n${suiteLogs}`;
+  }
+  if (testLogs) {
+    logs += `\n${chalk.bold('\t--- Test ---')}\n${testLogs}`;
+  }
+  return logs;
+}
+
 // To have this reporter "extend" a built-in reporter uncomment the following line:
 Mocha.utils.inherits(MochaReporter, Mocha.reporters.Spec);
 
 module.exports = MochaReporter;
-
-function getSuiteTitle(test, pathArr = []) {
-  let root = pathArr.length === 0;
-  
-  if (test.parent.parent) getSuiteTitle(test.parent, pathArr);    
-
-  pathArr.push(test.parent.title);
-  
-  return pathArr.filter(t => !!t)[0];
-}
-
-function getFile(test) {
-  return test.parent.file?.replace(process.cwd(), '');
-}
-
-function getTestName(test) {
-  if (process.env.TESTOMATIO_CREATE === 'fulltitle') return test.fullTitle();
-  return test.title;
-}

package/lib/client.js

@@ -1,14 +1,13 @@
 const debug = require('debug')('@testomatio/reporter:client');
 const createCallsiteRecord = require('callsite-record');
 const { sep, join } = require('path');
-const { minimatch } = require('minimatch')
+const { minimatch } = require('minimatch');
 const fs = require('fs');
 const chalk = require('chalk');
 const { randomUUID } = require('crypto');
 const upload = require('./fileUploader');
 const { APP_PREFIX } = require('./constants');
 const pipesFactory = require('./pipe');
-const artifactStorage = require('./storages/artifact-storage');
 
 /**
  * @typedef {import('../types').TestData} TestData
@@ -36,7 +35,7 @@ class Client {
 
   /**
    * Asynchronously prepares the execution list for running tests through various pipes.
-   * Each pipe in the client is checked for enablement, 
+   * Each pipe in the client is checked for enablement,
    * and if all pipes are disabled, the function returns a resolved Promise.
    * Otherwise, it executes the `prepareRun` method for each enabled pipe and collects the results.
    * The results are then filtered to remove any undefined values.
@@ -46,7 +45,7 @@ class Client {
    * @param {Object} params - The options for preparing the test execution list.
    * @param {string} params.pipe - Name of the executed pipe.
    * @param {string} params.pipeOptions - Filter option.
-   * @returns {Promise<any>} - A Promise that resolves to an 
+   * @returns {Promise<any>} - A Promise that resolves to an
    * array containing the prepared execution list,
    * or resolves to undefined if no valid results are found or if all pipes are disabled.
    */
@@ -63,22 +62,22 @@ class Client {
       if (!filterPipe.isEnabled) {
         // TODO:for the future for the another pipes
         console.warn(
-          APP_PREFIX, 
-          `At the moment processing is available only for the "testomatio" key. Example: "testomatio:tag-name=xxx"`
+          APP_PREFIX,
+          `At the moment processing is available only for the "testomatio" key. Example: "testomatio:tag-name=xxx"`,
         );
         return;
       }
 
-      const results = await Promise.all(this.pipes.map(async p => 
-        ({ pipe: p.toString(), result: await p.prepareRun(pipeOptions) })  
-      ));
-    
+      const results = await Promise.all(
+        this.pipes.map(async p => ({ pipe: p.toString(), result: await p.prepareRun(pipeOptions) })),
+      );
+
       const result = results.filter(p => p.pipe.includes('Testomatio'))[0]?.result;
 
       if (!result || result.length === 0) {
         return;
-      } 
-  
+      }
+
       debug('Execution tests list', result);
 
       return result;
@@ -131,42 +130,31 @@ class Client {
       steps,
       code = null,
       title,
-      file,
       suite_title,
       suite_id,
       test_id,
     } = testData;
     let { message = '' } = testData;
 
-    const uploadedFiles = [];
-
-    let stack = '';
 
+    let errorFormatted = '';
     if (error) {
-      stack = this.formatError(error) || '';
+      errorFormatted += this.formatError(error) || '';
       message = error?.message;
     }
-    if (steps) {
-      stack = this.formatSteps(stack, steps);
-    }
 
-    stack += testData.stack || '';
-
-    // ATTACH LOGS from storage
-    // in some cases (e.g. using cucumber) logger instance becomes empty object, if import at the top of the file
-    const logger = require('./storages/logger');
-    const testLogs = logger.getLogs(test_id);
-    // debug(`Test logs for ${test_id}:\n`, testLogs);
-    if (stack) stack += '\n\n';
-    stack += testLogs ? `${chalk.bold('Logs:')}\n${testLogs}` : '';
+    // Attach logs
+    const fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
 
     // GET ARTIFACTS from storage
-    const artifactFiles = artifactStorage.get(test_id);
-    if (artifactFiles) files.push(...artifactFiles);
+    // const artifactFiles = artifactStorage.get(test_id);
+    // if (artifactFiles) files.push(...artifactFiles);
 
-    // GET KEY-VALUEs from storage
-    const keyValueStorage = require('./storages/key-value-storage');
-    const keyValues = keyValueStorage.get(test_id);
+    // // GET KEY-VALUEs from storage
+    // const keyValueStorage = require('./storages/key-value-storage');
+    // const keyValues = keyValueStorage.get(test_id);
+    
+    const uploadedFiles = [];
 
     for (const file of files) {
       uploadedFiles.push(upload.uploadFileByPath(file, this.uuid));
@@ -187,9 +175,8 @@ class Client {
       files,
       steps,
       status,
-      stack,
+      stack: fullLogs,
       example,
-      file,
       code,
       title,
       suite_title,
@@ -198,9 +185,11 @@ class Client {
       message,
       run_time: parseFloat(time),
       artifacts,
-      meta: keyValues,
+      // meta: keyValues,
     };
 
+    debug('Adding test run...', data);
+
     this.queue = this.queue.then(() =>
       Promise.all(
         this.pipes.map(async p => {
@@ -252,15 +241,27 @@ class Client {
     return this.queue;
   }
 
-  formatSteps(stack, steps) {
-    return stack ? `${steps}\n\n${chalk.bold.red('################[ Failure ]################')}\n${stack}` : steps;
+  /**
+   * Returns the formatted stack including the stack trace, steps, and logs.
+   * @returns {string}
+   */
+  formatLogs({ error, steps, logs }) {
+    error = error?.trim();
+    steps = steps?.trim();
+    logs = logs?.trim();
+
+    let testLogs = '';
+    if (steps) testLogs += `${chalk.bold.blue('################[ Steps ]################')}\n${steps}`;
+    if (logs) testLogs += `\n\n${chalk.bold.gray('################[ Logs ]################')}\n${logs}`;
+    if (error) testLogs += `\n\n${chalk.bold.red('################[ Failure ]################')}\n${error}`;
+    return testLogs;
   }
 
   formatError(error, message) {
     if (!message) message = error.message;
     if (error.inspect) message = error.inspect() || '';
 
-    let stack = `\n${chalk.bold(message)}\n`;
+    let stack = `${message}\n`;
 
     // diffs for mocha, cypress, codeceptjs style
     if (error.actual && error.expected) {
@@ -277,11 +278,11 @@ class Client {
       const record = createCallsiteRecord({
         forError: error,
         isCallsiteFrame: frame => {
-          if (customFilter && minimatch(frame.getFileName(), customFilter)) return false;          
+          if (customFilter && minimatch(frame.getFileName(), customFilter)) return false;
           if (hasFrame) return false;
           if (isNotInternalFrame(frame)) hasFrame = true;
           return hasFrame;
-        }
+        },
       });
       if (record && !record.filename.startsWith('http')) {
         stack += record.renderSync({ stackFilter: isNotInternalFrame });
@@ -294,9 +295,11 @@ class Client {
 }
 
 function isNotInternalFrame(frame) {
-  return frame.getFileName().includes(sep) &&
+  return (
+    frame.getFileName().includes(sep) &&
     !frame.getFileName().includes('node_modules') &&
     !frame.getFileName().includes('internal')
+  );
 }
 
 module.exports = Client;

package/lib/pipe/testomatio.js

@@ -175,14 +175,13 @@ class TestomatioPipe {
    * @returns
    */
   addTest(data) {
+    debug('Adding test...');
     if (!this.isEnabled) return;
     if (!this.runId) return;
     data.api_key = this.apiKey;
     data.create = this.createNewTests;
     const json = JsonCycle.stringify(data);
 
-    debug('Adding test', json);
-
     return this.axios.post(`/api/reporter/${this.runId}/testrun`, json, {
       maxContentLength: Infinity,
       maxBodyLength: Infinity,

package/lib/reporter-functions.js

@@ -1,6 +1,6 @@
-const logger = require('./storages/logger');
-const artifactStorage = require('./storages/artifact-storage');
-const keyValueStorage = require('./storages/key-value-storage');
+const { logger } = require('./storages/logger');
+const { artifactStorage } = require('./storages/artifact-storage');
+const { keyValueStorage } = require('./storages/key-value-storage');
 
 /**
  * Stores path to file as artifact and uploads it to the S3 storage
@@ -21,7 +21,7 @@ function logMessage(...args) {
 
 /**
  * Similar to "log" function but marks message in report as a step
- * @param {*} message 
+ * @param {*} message
  */
 function addStep(message) {
   logger.step(message);
@@ -29,15 +29,26 @@ function addStep(message) {
 
 /**
  * Add key-value pair(s) to the test report
- * @param {*} keyValue 
+ * @param {*} keyValue
  */
 function setKeyValue(keyValue) {
   keyValueStorage.put(keyValue);
 }
 
+/**
+ *
+ * @param {string} context – test id or test title or suite title + test title
+ */
+function _setContext(context) {
+  logger.setContext(context);
+  keyValueStorage.setContext(context);
+  artifactStorage.setContext(context);
+}
+
 module.exports = {
   artifact: saveArtifact,
   log: logMessage,
   step: addStep,
   keyValue: setKeyValue,
+  _setContext,
 };

package/lib/reporter.js

@@ -1,4 +1,4 @@
-const logger = require('./storages/logger');
+const { logger } = require('./storages/logger');
 const TestomatClient = require('./client');
 const TRConstants = require('./constants');
 
@@ -20,4 +20,5 @@ module.exports.testomat = {
   log: reporterFunctions.log,
   step: reporterFunctions.step,
   meta: reporterFunctions.keyValue,
+  _setContext: reporterFunctions._setContext,
 };

package/lib/storages/artifact-storage.js

@@ -5,24 +5,36 @@ const DataStorage = require('./data-storage');
  * Artifact storage is supposed to store file paths
  */
 class ArtifactStorage {
+  static #instance;
+
+  #context;
 
   // there is autocompletion for the class methods if implemented singleton this way
   constructor() {
     this.dataStorage = new DataStorage('artifact');
-    
+
     // singleton
-    if (!ArtifactStorage.instance) {
-      ArtifactStorage.instance = this;
+    if (!ArtifactStorage.#instance) {
+      ArtifactStorage.#instance = this;
     }
   }
 
-  // singleton
+  /**
+   * Singleton
+   * @returns {ArtifactStorage}
+   */
   static getInstance() {
-    if (!ArtifactStorage.instance) {
-      ArtifactStorage.instance = new ArtifactStorage();
+    if (!this.#instance) {
+      this.#instance = new ArtifactStorage();
     }
+    return this.#instance;
+  }
 
-    return ArtifactStorage.instance;
+  /**
+   * @param {string} context - suite title + test title
+   */
+  setContext(context) {
+    this.#context = context;
   }
 
   /**
@@ -31,6 +43,7 @@ class ArtifactStorage {
    * @param {*} context testId or test title
    */
   put(data, context = null) {
+    context = context || this.#context;
     if (!data) return;
     debug('Save artifact:', data);
     this.dataStorage.putData(data, context);
@@ -63,8 +76,4 @@ class ArtifactStorage {
   }
 }
 
-ArtifactStorage.instance = null;
-
-// const artifactStorage = ArtifactStorage.getInstance();
-const artifactStorage = new ArtifactStorage();
-module.exports = artifactStorage;
+module.exports.artifactStorage = ArtifactStorage.getInstance();