@testomatio/reporter 2.0.1-beta.3 → 2.0.1-beta.5-timestamp

package/src/data-storage.js

@@ -1,204 +0,0 @@
-import createDebugMessages from 'debug';
-import fs from 'fs';
-import path, { join } from 'path';
-import os from 'os';
-import { TESTOMAT_TMP_STORAGE_DIR } from './constants.js';
-import { fileSystem, testRunnerHelper } from './utils/utils.js';
-import crypto from 'crypto';
-
-const debug = createDebugMessages('@testomatio/reporter:storage');
-class DataStorage {
-  static #instance;
-
-  context;
-
-  /**
-   *
-   * @returns {DataStorage}
-   */
-  static getInstance() {
-    if (!this.#instance) {
-      this.#instance = new DataStorage();
-    }
-    return this.#instance;
-  }
-
-  setContext(context) {
-    this.context = context;
-  }
-
-  /**
-   * Creates data storage instance as singleton
-   * Stores data to global variable or to file depending on what is applicable for current test runner (adapter)
-   * Recommend to use composition while using this class (instead of inheritance).
-   * ! Also the class which will use data storage should be singleton (to avoid data loss).
-   */
-  constructor() {
-    // some frameworks use global variable to store data, some use file storage
-    this.isFileStorage = true;
-  }
-
-  /**
-   * Puts any data to storage (file or global variable).
-   * If file: stores data as text, if global variable – stores as array of data.
-   * @param {'log' | 'artifact' | 'keyvalue'} dataType
-   * @param {*} data anything you want to store (string, object, array, etc)
-   * @param {*} context could be testId or any context (test name, suite name, including their IDs etc)
-   * suite name + test name is used by default
-   * @returns
-   */
-  putData(dataType, data, context = null) {
-    if (!dataType || !data) return;
-
-    context = context || this.context || testRunnerHelper.getNameOfCurrentlyRunningTest();
-    if (!context) {
-      // debug(`No context provided for "${dataType}" data:`, data);
-      return;
-    }
-    const contextHash = stringToMD5Hash(context);
-
-    if (this.isFileStorage) {
-      const dataDirPath = path.join(TESTOMAT_TMP_STORAGE_DIR, dataType);
-      fileSystem.createDir(dataDirPath);
-      this.#putDataToFile(dataType, data, contextHash);
-    } else {
-      this.#putDataToGlobalVar(dataType, data, contextHash);
-    }
-  }
-
-  /**
-   * Returns data, stored for specific test/context (or data which was stored without test id specified).
-   * This method will get data from global variable and/or from from file (previosly saved with put method).
-   *
-   * @param {'log' | 'artifact' | 'keyvalue'} dataType
-   * @param {string} context
-   * @returns {any []} array of data (any type), null (if no data found for context) or string (if data type is log)
-   */
-  getData(dataType, context) {
-    // TODO: think if it could be useful
-    // context = context || this.context || testRunnerHelper.getNameOfCurrentlyRunningTest();
-
-    if (!context) {
-      debug(`Trying to get "${dataType}" data without context`);
-      return null;
-    }
-
-    const contextHash = stringToMD5Hash(context);
-
-    let testDataFromFile = [];
-    let testDataFromGlobalVar = [];
-
-    if (global?.testomatioDataStore) {
-      testDataFromGlobalVar = this.#getDataFromGlobalVar(dataType, contextHash);
-      if (testDataFromGlobalVar) {
-        if (testDataFromGlobalVar.length) return testDataFromGlobalVar;
-      }
-      // don't return nothing if no data in global variable
-    }
-
-    testDataFromFile = this.#getDataFromFile(dataType, contextHash);
-
-    if (testDataFromFile.length) {
-      return testDataFromFile;
-    }
-    // debug(`No "${dataType}" data for context "${contextHash}" in both file and global variable`);
-
-    // in case no data found for context
-    return null;
-  }
-
-  /**
-   * @param {'log' | 'artifact' | 'keyvalue'} dataType
-   * @param {string} context
-   * @returns aray of data (any type)
-   */
-  #getDataFromGlobalVar(dataType, context) {
-    try {
-      if (global?.testomatioDataStore[dataType]) {
-        const testData = global.testomatioDataStore[dataType][context];
-        if (testData) debug(`"${dataType}" data for constext "${context}":`, testData.join(', '));
-        return testData || [];
-      }
-      // debug(`No ${this.dataType} data for context ${context} in <global> storage`);
-      return [];
-    } catch (e) {
-      // there could be no data, ignore
-    }
-  }
-
-  /**
-   * @param {'log' | 'artifact' | 'keyvalue'} dataType
-   * @param {*} context
-   * @returns array of data (any type)
-   */
-  #getDataFromFile(dataType, context) {
-    const dataDirPath = path.join(TESTOMAT_TMP_STORAGE_DIR, dataType);
-    try {
-      const filepath = join(dataDirPath, `${dataType}_${context}`);
-      if (fs.existsSync(filepath)) {
-        const testDataAsText = fs.readFileSync(filepath, 'utf-8');
-        if (testDataAsText) debug(`"${dataType}" data for context "${context}":`, testDataAsText);
-        const testDataArr = testDataAsText?.split(os.EOL) || [];
-        return testDataArr;
-      }
-      // debug(`No ${this.dataType} data for ${context} in <file> storage`);
-      return [];
-    } catch (e) {
-      // there could be no data, ignore
-    }
-    return [];
-  }
-
-  /**
-   * Puts data to global variable. Unlike the file storage, stores data in array (file storage just append as string).
-   * @param {'log' | 'artifact' | 'keyvalue'} dataType
-   * @param {*} data
-   * @param {*} context
-   */
-  #putDataToGlobalVar(dataType, data, context) {
-    debug('Saving data to global variable for ', context, ':', data);
-    if (!global.testomatioDataStore) global.testomatioDataStore = {};
-    if (!global.testomatioDataStore?.[dataType]) global.testomatioDataStore[dataType] = {};
-
-    if (!global.testomatioDataStore?.[dataType][context]) global.testomatioDataStore[dataType][context] = [];
-    global.testomatioDataStore[dataType][context].push(data);
-  }
-
-  /**
-   * Puts data to file. Unlike the global variable storage, stores data as string
-   * @param {'log' | 'artifact' | 'keyvalue'} dataType
-   * @param {*} data
-   * @param {string} context
-   * @returns
-   */
-  #putDataToFile(dataType, data, context) {
-    const dataDirPath = path.join(TESTOMAT_TMP_STORAGE_DIR, dataType);
-    if (typeof data !== 'string') data = JSON.stringify(data);
-    const filename = `${dataType}_${context}`;
-    const filepath = join(dataDirPath, filename);
-    if (!fs.existsSync(dataDirPath)) fileSystem.createDir(dataDirPath);
-    debug(`Saving data to file for context "${context}" to ${filepath}. Data: ${JSON.stringify(data)}`);
-
-    // append new line if file already exists (in this case its definitely includes some data)
-    if (fs.existsSync(filepath)) {
-      fs.appendFileSync(filepath, os.EOL + data, 'utf-8');
-    } else {
-      fs.writeFileSync(filepath, data, 'utf-8');
-    }
-  }
-}
-
-function stringToMD5Hash(str) {
-  const md5 = crypto.createHash('md5');
-  md5.update(str);
-  const hash = md5.digest('hex');
-
-  return hash;
-}
-
-export const dataStorage = DataStorage.getInstance();
-
-export { stringToMD5Hash };
-
-// TODO: consider using fs promises instead of writeSync/appendFileSync to
-// prevent blocking and improve performance (probably queue usage will be required)

package/src/junit-adapter/adapter.js

@@ -1,23 +0,0 @@
-class Adapter {
-  constructor(opts) {
-    this.opts = opts;
-  }
-
-  getFilePath(t) {
-    return t.file;
-  }
-
-  formatTest(t) {
-    return t;
-  }
-
-  formatStack(t) {
-    return t.stack || '';
-  }
-
-  formatMessage(t) {
-    return t.message;
-  }
-}
-
-export default Adapter;

package/src/junit-adapter/csharp.js

@@ -1,28 +0,0 @@
-import path from 'path';
-import Adapter from './adapter.js';
-
-class CSharpAdapter extends Adapter {
-  formatTest(t) {
-    const title = t.title.replace(/\(.*?\)/, '').trim();
-    const example = t.title.match(/\((.*?)\)/);
-    if (example) t.example = { ...example[1].split(',') };
-    const suite = t.suite_title.split('.');
-    t.suite_title = suite.pop();
-    t.file = namespaceToFileName(t.file);
-    t.title = title.trim();
-    return t;
-  }
-
-  getFilePath(t) {
-    const fileName = namespaceToFileName(t.file);
-    return fileName;
-  }
-}
-
-export default CSharpAdapter;
-
-function namespaceToFileName(fileName) {
-  const fileParts = fileName.split('.');
-  fileParts[fileParts.length - 1] = fileParts[fileParts.length - 1]?.replace(/\$.*/, '');
-  return `${fileParts.join(path.sep)}.cs`;
-}

package/src/junit-adapter/index.js

@@ -1,28 +0,0 @@
-import Adapter from './adapter.js';
-import JavaScriptAdapter from './javascript.js';
-import JavaAdapter from './java.js';
-import PythonAdapter from './python.js';
-import RubyAdapter from './ruby.js';
-import CSharpAdapter from './csharp.js';
-
-function AdapterFactory(lang, opts) {
-  if (lang === 'java') {
-    return new JavaAdapter(opts);
-  }
-  if (lang === 'js') {
-    return new JavaScriptAdapter(opts);
-  }
-  if (lang === 'python') {
-    return new PythonAdapter(opts);
-  }
-  if (lang === 'ruby') {
-    return new RubyAdapter(opts);
-  }
-  if (lang === 'c#' || lang === 'csharp') {
-    return new CSharpAdapter(opts);
-  }
-
-  return new Adapter(opts);
-}
-
-export default AdapterFactory;

package/src/junit-adapter/java.js

@@ -1,58 +0,0 @@
-import path from 'path';
-import Adapter from './adapter.js';
-
-class JavaAdapter extends Adapter {
-  getFilePath(t) {
-    const fileName = namespaceToFileName(t.suite_title);
-    return this.opts.javaTests + path.sep + fileName;
-  }
-
-  formatTest(t) {
-    const fileParts = t.suite_title.split('.');
-
-    t.file = namespaceToFileName(t.suite_title);
-    t.title = t.title.split('(')[0];
-
-    // detect params
-    const paramMatches = t.title.match(/\[(.*?)\]/g);
-
-    if (paramMatches) {
-      const params = paramMatches.map((_match, index) => `param${index + 1}`);
-      if (params.length === 1) params[0] = 'param';
-      let paramIndex = 0;
-
-      t.title = t.title.replace(/: \[(.*?)\]/g, () => {
-        if (params.length < 2) return `\${param}`;
-        const paramName = params[paramIndex] || `param${paramIndex + 1}`;
-        paramIndex++;
-        return `\${${paramName}}`;
-      });
-      const example = {};
-      paramMatches.forEach((match, index) => {
-        example[params[index]] = match.replace(/[[\]]/g, '');
-      });
-      t.example = example;
-    }
-
-    t.suite_title = fileParts[fileParts.length - 1].replace(/\$/g, ' | ');
-    return t;
-  }
-
-  // formatStack(t) {
-  //   const stack = super.formatStack(t);
-
-  //   const file = t.suite_title.split('.');
-
-  //   const fileLine = `at .*${file[file.length - 1]}\.java:(\\d+)` // eslint-disable-line no-useless-escape
-  //   const regexp = new RegExp(fileLine,"g")
-  //   return stack.replace(regexp, `${this.opts.javaTests}${path.sep}${namespaceToFileName(t.suite_title)}:$1:`);
-  // }
-}
-
-function namespaceToFileName(fileName) {
-  const fileParts = fileName.split('.');
-  fileParts[fileParts.length - 1] = fileParts[fileParts.length - 1]?.replace(/\$.*/, '');
-  return `${fileParts.join(path.sep)}.java`;
-}
-
-export default JavaAdapter;

package/src/junit-adapter/javascript.js

@@ -1,31 +0,0 @@
-import createCallsiteRecord from 'callsite-record';
-import path from 'path';
-import Adapter from './adapter.js';
-
-class JavaScriptAdapter extends Adapter {
-  formatStack(t) {
-    let stack = super.formatStack(t);
-
-    try {
-      const error = new Error(stack.split('\n')[0]);
-      error.stack = stack;
-      const record = createCallsiteRecord({
-        forError: error,
-      });
-      // @ts-ignore
-      if (record && !record.filename.startsWith('http')) {
-        stack += record.renderSync({
-          stackFilter: frame =>
-            frame.fileName?.indexOf(path.sep) > -1 &&
-            frame.fileName?.indexOf('node_modules') < 0 &&
-            frame.fileName?.indexOf('internal') < 0,
-        });
-      }
-      return stack;
-    } catch (err) {
-      return stack;
-    }
-  }
-}
-
-export default JavaScriptAdapter;

package/src/junit-adapter/python.js

@@ -1,42 +0,0 @@
-import path from 'path';
-import fs from 'fs';
-import Adapter from './adapter.js';
-
-class PythonAdapter extends Adapter {
-  getFilePath(t) {
-    let fileName = namespaceToFileName(t.suite_title, { checkFile: true });
-    if (!fileName) fileName = namespaceToFileName(t.suite_title, { checkFile: false });
-    return fileName;
-  }
-
-  formatTest(t) {
-    const fileParts = t.suite_title.split('.');
-    const example = t.title.match(/\[(.*)\]/)?.[1];
-    if (example) t.example = { '#': example };
-
-    t.file = namespaceToFileName(t.suite_title);
-    t.title = t.title.split('[')[0];
-    t.suite_title = fileParts[fileParts.length - 1].replace(/\$/g, ' | ');
-    return t;
-  }
-
-  formatMessage(t) {
-    return t.message.split('
')[0];
-  }
-}
-
-function namespaceToFileName(fileName, opts = {}) {
-  const fileParts = fileName.split('.');
-
-  while (fileParts.length > 0) {
-    const file = `${fileParts.join(path.sep)}.py`;
-    if (!opts.checkFile) return file;
-    if (fs.existsSync(`${fileParts.join(path.sep)}.py`)) {
-      return file;
-    }
-    fileParts.pop();
-  }
-  return null;
-}
-
-export default PythonAdapter;

package/src/junit-adapter/ruby.js

@@ -1,10 +0,0 @@
-import Adapter from './adapter.js';
-
-class RubyAdapter extends Adapter {
-  formatStack(t) {
-    const stack = super.formatStack(t);
-    return stack.replace(/\[(.*?:.\d*)\]/g, '\n$1');
-  }
-}
-
-export default RubyAdapter;

package/src/output.js

@@ -1,57 +0,0 @@
-import { format } from 'util';
-
-const consoleLog = console.log;
-const consoleError = console.error;
-
-const formatArgs = args => format.apply(format, Array.prototype.slice.call(args));
-
-class Output {
-  constructor(opts = {}) {
-    this.filterFn = opts.filterFn || (() => true);
-    this.reset();
-  }
-
-  reset() {
-    this.log = [];
-    this.stop(); // resotre console log if it was overridden
-  }
-
-  start() {
-    const { filterFn } = this;
-    const self = this;
-    console.log = (...args) => {
-      const obj = {};
-      Error.captureStackTrace(obj);
-      const logString = formatArgs(args);
-      if (filterFn(obj.stack)) {
-        self.log.push(logString);
-      }
-      consoleLog(logString);
-    };
-
-    console.error = (...args) => {
-      const obj = {};
-      Error.captureStackTrace(obj);
-      const logString = formatArgs(args);
-      if (filterFn(obj.stack)) {
-        self.log.push(logString);
-      }
-      consoleError(logString);
-    };
-  }
-
-  push(line) {
-    this.log.push(line);
-  }
-
-  text() {
-    return this.log.join('\n');
-  }
-
-  stop() {
-    console.log = consoleLog;
-    console.error = consoleError;
-  }
-}
-
-export default Output;