@testomatio/reporter 1.6.0-beta-2-artifacts → 2.0.0-beta-esm

package/src/data-storage.js

@@ -0,0 +1,204 @@
+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/fileUploader.js

@@ -0,0 +1,307 @@
+import createDebugMessages from 'debug';
+import { S3 } from '@aws-sdk/client-s3';
+import { Upload } from '@aws-sdk/lib-storage';
+import fs from 'fs';
+import util from 'util';
+import path from 'path';
+import promiseRetry from 'promise-retry';
+import pc from 'picocolors';
+import { randomUUID } from 'crypto';
+import { APP_PREFIX } from './constants.js';
+
+const readFile = util.promisify(fs.readFile);
+const stat = util.promisify(fs.stat);
+const debug = createDebugMessages('@testomatio/reporter:file-uploader');
+const keys = [
+  'S3_ENDPOINT',
+  'S3_REGION',
+  'S3_BUCKET',
+  'S3_ACCESS_KEY_ID',
+  'S3_SECRET_ACCESS_KEY',
+  'S3_SESSION_TOKEN',
+  'TESTOMATIO_DISABLE_ARTIFACTS',
+  'TESTOMATIO_PRIVATE_ARTIFACTS',
+  'S3_FORCE_PATH_STYLE',
+];
+
+let config;
+
+function resetConfig() {
+  config = undefined;
+  isEnabled = undefined;
+}
+
+function getConfig() {
+  if (config) return config;
+  config = keys.reduce((acc, key) => {
+    acc[key] = process.env[key];
+    return acc;
+  }, {});
+  return config;
+}
+
+function getMaskedConfig() {
+  return Object.fromEntries(
+    Object.entries(getConfig()).map(([key, value]) => [
+      key,
+      key === 'S3_SECRET_ACCESS_KEY' || key === 'S3_ACCESS_KEY_ID' ? '***' : value,
+    ]),
+  );
+}
+
+let isEnabled;
+
+const isArtifactsEnabled = () => {
+  if (isEnabled !== undefined) return isEnabled;
+  const { S3_BUCKET, TESTOMATIO_DISABLE_ARTIFACTS } = getConfig();
+  isEnabled = !!(S3_BUCKET && !TESTOMATIO_DISABLE_ARTIFACTS);
+  debug(`Upload is ${isEnabled ? 'enabled' : 'disabled'}`);
+  return isEnabled;
+};
+
+const _getFileExtBase64 = str => {
+  const type = str.charAt(0);
+
+  return (
+    {
+      '/': '.jpg',
+      i: '.png',
+      R: '.gif',
+      U: '.webp',
+    }[type] || ''
+  );
+};
+
+const _getS3Config = () => {
+  const { S3_REGION, S3_SESSION_TOKEN, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_FORCE_PATH_STYLE, S3_ENDPOINT } =
+    getConfig();
+
+  const cfg = {
+    region: S3_REGION,
+    credentials: {
+      accessKeyId: S3_ACCESS_KEY_ID,
+      secretAccessKey: S3_SECRET_ACCESS_KEY,
+      s3ForcePathStyle: S3_FORCE_PATH_STYLE,
+    },
+  };
+
+  if (S3_SESSION_TOKEN) {
+    cfg.credentials.sessionToken = S3_SESSION_TOKEN;
+  }
+
+  if (S3_ENDPOINT) {
+    cfg.endpoint = S3_ENDPOINT;
+  }
+
+  return cfg;
+};
+
+const uploadUsingS3 = async (filePath, runId) => {
+  let ContentType;
+  let Key;
+
+  if (typeof filePath === 'object') {
+    ContentType = filePath?.type;
+    filePath = filePath?.path;
+    Key = filePath?.name;
+  }
+
+  const { TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET } = getConfig();
+
+  try {
+    debug('S3 config', getMaskedConfig());
+    debug('Started upload', filePath, 'to ', S3_BUCKET);
+
+    // Verification that the file was actually created: 20 attempts of 0.5 second => 10sec
+    const isFileExist = await checkFileExists(filePath, 20, 500);
+
+    if (!isFileExist) {
+      console.error(pc.yellow(`Artifacts file ${filePath} does not exist. Skipping...`));
+      return;
+    }
+
+    debug('File: ', filePath, ' exists');
+
+    const fileData = await readFile(filePath);
+
+    Key = `${runId}/${randomUUID()}-${Key || path.basename(filePath)}`;
+
+    const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
+
+    if (!S3_BUCKET || !fileData) {
+      console.log(
+        APP_PREFIX,
+        pc.bold(pc.red(`Failed uploading '${Key}'. Please check S3 credentials`)),
+        getMaskedConfig(),
+      );
+      return;
+    }
+
+    const s3 = new S3(_getS3Config());
+
+    /**
+     * @type {import('@aws-sdk/client-s3').PutObjectCommandInput}
+     */
+    const params = {
+      Bucket: S3_BUCKET,
+      Key,
+      Body: fileData,
+      ContentType,
+      ACL,
+    };
+
+    const out = new Upload({
+      client: s3,
+      params,
+    });
+
+    const link = await getS3LocationLink(out);
+
+    debug(`Succesfully uploaded ${filePath} => ${S3_BUCKET}/${Key} | URL: ${link}`);
+
+    return link;
+  } catch (e) {
+    debug('S3 file uploading error: ', e);
+
+    console.log(APP_PREFIX, `To ${pc.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
+
+    if (!TESTOMATIO_PRIVATE_ARTIFACTS) {
+      console.log(APP_PREFIX, `To enable ${pc.bold('PRIVATE')} uploads set: TESTOMATIO_PRIVATE_ARTIFACTS=1`);
+    } else {
+      console.log(
+        APP_PREFIX,
+        `To enable ${pc.bold('PUBLIC')} uploads remove TESTOMATIO_PRIVATE_ARTIFACTS env variable`,
+      );
+    }
+    console.log(APP_PREFIX, '---------------');
+  }
+};
+
+const uploadUsingS3AsBuffer = async (buffer, fileName, runId) => {
+  const { S3_REGION, S3_ACCESS_KEY_ID, S3_SECRET_ACCESS_KEY, S3_ENDPOINT, TESTOMATIO_PRIVATE_ARTIFACTS, S3_BUCKET } =
+    getConfig();
+
+  const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
+
+  const fileExtension = _getFileExtBase64(buffer.toString('base64'));
+  const Key = `${runId}/${fileName}${fileExtension}`;
+
+  if (!S3_BUCKET || !buffer) {
+    console.log(APP_PREFIX, pc.bold(pc.red(`Failed uploading '${Key}'. Please check S3 credentials`)), {
+      accessKeyId: S3_ACCESS_KEY_ID,
+      secretAccessKey: S3_SECRET_ACCESS_KEY ? '**** (hidden) ***' : '(empty)',
+      region: S3_REGION,
+      bucket: S3_BUCKET,
+      acl: ACL,
+      endpoint: S3_ENDPOINT,
+    });
+    return;
+  }
+
+  const s3 = new S3(_getS3Config());
+
+  try {
+    const out = new Upload({
+      client: s3,
+
+      params: {
+        Bucket: S3_BUCKET,
+        Key,
+        Body: buffer,
+        ACL,
+      },
+    });
+
+    return await getS3LocationLink(out);
+  } catch (e) {
+    debug('S3 buffer uploading error: ', e);
+
+    console.log(APP_PREFIX, `To ${pc.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
+
+    if (!TESTOMATIO_PRIVATE_ARTIFACTS) {
+      console.log(APP_PREFIX, `To enable ${pc.bold('PRIVATE')} uploads set: TESTOMATIO_PRIVATE_ARTIFACTS=1`);
+    } else {
+      console.log(
+        APP_PREFIX,
+        `To enable ${pc.bold('PUBLIC')} uploads remove TESTOMATIO_PRIVATE_ARTIFACTS env variable`,
+      );
+    }
+    console.log(APP_PREFIX, '---------------');
+  }
+};
+
+const uploadFileByPath = async (filePath, runId) => {
+  try {
+    if (isArtifactsEnabled()) {
+      return uploadUsingS3(filePath, runId);
+    }
+  } catch (e) {
+    debug(e);
+
+    console.error(pc.red('Error occurred while uploading artifacts! '), e);
+  }
+};
+
+const uploadFileAsBuffer = async (buffer, fileName, runId) => {
+  try {
+    if (isArtifactsEnabled()) {
+      return uploadUsingS3AsBuffer(buffer, fileName, runId);
+    }
+  } catch (e) {
+    debug(e);
+
+    console.error(pc.red('Error occurred while uploading artifacts! '), e);
+  }
+};
+
+const checkFileExists = async (filePath, attempts = 5, intervalMs = 500) => {
+  const checkFile = async () => {
+    const fileStats = await stat(filePath);
+    if (fileStats.isFile()) {
+      return true;
+    }
+
+    throw new Error('File not found');
+  };
+
+  try {
+    await promiseRetry(
+      {
+        retries: attempts,
+        minTimeout: intervalMs,
+      },
+      checkFile,
+    );
+
+    return true;
+  } catch (err) {
+    console.error(pc.yellow(`File ${filePath} was not found or did not have time to be generated...`));
+
+    return false;
+  }
+};
+
+const getS3LocationLink = async out => {
+  const response = await out.done();
+
+  let s3Location = response?.Location;
+
+  if (!s3Location) {
+    // TODO: out: a fallback case  - remove after deeper testing
+    s3Location = out?.singleUploadResult?.Location;
+    debug('Uploaded singleUploadResult.Location', s3Location);
+
+    if (!s3Location) {
+      throw new Error("Problems getting the S3 artifact's link. Please check S3 permissions!");
+    }
+  }
+
+  return s3Location;
+};
+
+export const upload = {
+  uploadFileByPath,
+  uploadFileAsBuffer,
+  isArtifactsEnabled,
+  resetConfig,
+};

package/src/junit-adapter/adapter.js

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,16 @@
+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 = suite.join('/');
+    t.title = title.trim();
+    return t;
+  }
+}
+
+export default CSharpAdapter;

package/src/junit-adapter/index.js

@@ -0,0 +1,28 @@
+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

@@ -0,0 +1,58 @@
+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

@@ -0,0 +1,31 @@
+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;