@testomatio/reporter 2.0.0-beta-esm → 2.0.0-beta.1-xml

package/lib/utils/chalk.js

@@ -1,10 +0,0 @@
-// import chalk from 'chalk';
-// let chalkToUse = chalk;
-// try {
-//   if (typeof require !== 'undefined') {
-//     chalkToUse = require('chalk4');
-//   }
-// } catch (e) {
-//   chalkToUse = chalk;
-// }
-// export default chalkToUse;

package/src/fileUploader.js

@@ -1,307 +0,0 @@
-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/reporter.cjs

@@ -1,22 +0,0 @@
-const _reporter = require('../lib/reporter.js');
-
-/**
- * @typedef {import('../lib/client.js').default} TestomatClient
- * @typedef {import('../lib/constants.js')} TRConstants
- * @typedef {import('../lib/reporter-functions.js')} artifact
- * @typedef {import('../lib/reporter-functions.js')} log
- * @typedef {import('../lib/reporter-functions.js')} logger
- * @typedef {import('../lib/reporter-functions.js')} meta
- * @typedef {import('../lib/reporter-functions.js')} step
- * 
- * "Reporter" type which is object containing all types from the above
- * @typedef {{artifact: artifact, log: log, logger: logger, meta: meta, step: step, TestomatClient: TestomatClient, TRConstants: TRConstants}} Reporter
- */
-
-// const reporter = _reporter;
-
-/**
- * @type {Reporter}
- */
-const reporter = _reporter;
-module.exports = reporter;

package/src/utils/chalk.js

@@ -1,13 +0,0 @@
-// import chalk from 'chalk';
-
-// let chalkToUse = chalk;
-
-// try {
-//   if (typeof require !== 'undefined') {
-//     chalkToUse = require('chalk4');
-//   }
-// } catch (e) {
-//   chalkToUse = chalk;
-// }
-
-// export default chalkToUse;