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

package/lib/fileUploader.js

@@ -0,0 +1,245 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upload = void 0;
+const debug_1 = __importDefault(require("debug"));
+const client_s3_1 = require("@aws-sdk/client-s3");
+const lib_storage_1 = require("@aws-sdk/lib-storage");
+const fs_1 = __importDefault(require("fs"));
+const util_1 = __importDefault(require("util"));
+const path_1 = __importDefault(require("path"));
+const promise_retry_1 = __importDefault(require("promise-retry"));
+const picocolors_1 = __importDefault(require("picocolors"));
+const crypto_1 = require("crypto");
+const constants_js_1 = require("./constants.js");
+const readFile = util_1.default.promisify(fs_1.default.readFile);
+const stat = util_1.default.promisify(fs_1.default.stat);
+const debug = (0, debug_1.default)('@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(picocolors_1.default.yellow(`Artifacts file ${filePath} does not exist. Skipping...`));
+            return;
+        }
+        debug('File: ', filePath, ' exists');
+        const fileData = await readFile(filePath);
+        Key = `${runId}/${(0, crypto_1.randomUUID)()}-${Key || path_1.default.basename(filePath)}`;
+        const ACL = TESTOMATIO_PRIVATE_ARTIFACTS ? 'private' : 'public-read';
+        if (!S3_BUCKET || !fileData) {
+            console.log(constants_js_1.APP_PREFIX, picocolors_1.default.bold(picocolors_1.default.red(`Failed uploading '${Key}'. Please check S3 credentials`)), getMaskedConfig());
+            return;
+        }
+        const s3 = new client_s3_1.S3(_getS3Config());
+        /**
+         * @type {import('@aws-sdk/client-s3').PutObjectCommandInput}
+         */
+        const params = {
+            Bucket: S3_BUCKET,
+            Key,
+            Body: fileData,
+            ContentType,
+            ACL,
+        };
+        const out = new lib_storage_1.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(constants_js_1.APP_PREFIX, `To ${picocolors_1.default.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
+        if (!TESTOMATIO_PRIVATE_ARTIFACTS) {
+            console.log(constants_js_1.APP_PREFIX, `To enable ${picocolors_1.default.bold('PRIVATE')} uploads set: TESTOMATIO_PRIVATE_ARTIFACTS=1`);
+        }
+        else {
+            console.log(constants_js_1.APP_PREFIX, `To enable ${picocolors_1.default.bold('PUBLIC')} uploads remove TESTOMATIO_PRIVATE_ARTIFACTS env variable`);
+        }
+        console.log(constants_js_1.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(constants_js_1.APP_PREFIX, picocolors_1.default.bold(picocolors_1.default.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 client_s3_1.S3(_getS3Config());
+    try {
+        const out = new lib_storage_1.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(constants_js_1.APP_PREFIX, `To ${picocolors_1.default.bold('disable')} artifact uploads set: TESTOMATIO_DISABLE_ARTIFACTS=1`);
+        if (!TESTOMATIO_PRIVATE_ARTIFACTS) {
+            console.log(constants_js_1.APP_PREFIX, `To enable ${picocolors_1.default.bold('PRIVATE')} uploads set: TESTOMATIO_PRIVATE_ARTIFACTS=1`);
+        }
+        else {
+            console.log(constants_js_1.APP_PREFIX, `To enable ${picocolors_1.default.bold('PUBLIC')} uploads remove TESTOMATIO_PRIVATE_ARTIFACTS env variable`);
+        }
+        console.log(constants_js_1.APP_PREFIX, '---------------');
+    }
+};
+const uploadFileByPath = async (filePath, runId) => {
+    try {
+        if (isArtifactsEnabled()) {
+            return uploadUsingS3(filePath, runId);
+        }
+    }
+    catch (e) {
+        debug(e);
+        console.error(picocolors_1.default.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(picocolors_1.default.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 (0, promise_retry_1.default)({
+            retries: attempts,
+            minTimeout: intervalMs,
+        }, checkFile);
+        return true;
+    }
+    catch (err) {
+        console.error(picocolors_1.default.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;
+};
+exports.upload = {
+    uploadFileByPath,
+    uploadFileAsBuffer,
+    isArtifactsEnabled,
+    resetConfig,
+};

package/lib/junit-adapter/adapter.js

@@ -1,23 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 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;
-  }
+    constructor(opts) {
+        this.opts = opts;
+    }
+    getFilePath(t) {
+        return t.file;
+    }
+    formatTest(t) {
+        return t;
+    }
+    formatStack(t) {
+        return t.stack || '';
+    }
+    formatMessage(t) {
+        return t.message;
+    }
 }
-
 module.exports = Adapter;

package/lib/junit-adapter/csharp.js

@@ -1,16 +1,20 @@
-const Adapter = require('./adapter');
-
-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;
-  }
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const adapter_js_1 = __importDefault(require("./adapter.js"));
+class CSharpAdapter extends adapter_js_1.default {
+    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;
+    }
 }
-
 module.exports = CSharpAdapter;

package/lib/junit-adapter/index.js

@@ -1,28 +1,30 @@
-const Adapter = require('./adapter');
-const JavaScriptAdapter = require('./javascript');
-const JavaAdapter = require('./java');
-const PythonAdapter = require('./python');
-const RubyAdapter = require('./ruby');
-const CSharpAdapter = require('./csharp');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const adapter_js_1 = __importDefault(require("./adapter.js"));
+const javascript_js_1 = __importDefault(require("./javascript.js"));
+const java_js_1 = __importDefault(require("./java.js"));
+const python_js_1 = __importDefault(require("./python.js"));
+const ruby_js_1 = __importDefault(require("./ruby.js"));
+const csharp_js_1 = __importDefault(require("./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);
+    if (lang === 'java') {
+        return new java_js_1.default(opts);
+    }
+    if (lang === 'js') {
+        return new javascript_js_1.default(opts);
+    }
+    if (lang === 'python') {
+        return new python_js_1.default(opts);
+    }
+    if (lang === 'ruby') {
+        return new ruby_js_1.default(opts);
+    }
+    if (lang === 'c#' || lang === 'csharp') {
+        return new csharp_js_1.default(opts);
+    }
+    return new adapter_js_1.default(opts);
 }
-
 module.exports = AdapterFactory;

package/lib/junit-adapter/java.js

@@ -1,58 +1,46 @@
-const path = require('path');
-const Adapter = require('./adapter');
-
-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;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const adapter_js_1 = __importDefault(require("./adapter.js"));
+class JavaAdapter extends adapter_js_1.default {
+    getFilePath(t) {
+        const fileName = namespaceToFileName(t.suite_title);
+        return this.opts.javaTests + path_1.default.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;
     }
-
-    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`;
+    const fileParts = fileName.split('.');
+    fileParts[fileParts.length - 1] = fileParts[fileParts.length - 1]?.replace(/\$.*/, '');
+    return `${fileParts.join(path_1.default.sep)}.java`;
 }
-
 module.exports = JavaAdapter;

package/lib/junit-adapter/javascript.js

@@ -1,30 +1,33 @@
-const createCallsiteRecord = require('callsite-record');
-const path = require('path');
-const Adapter = require('./adapter');
-
-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,
-      });
-      if (record && !record.filename.startsWith('http')) {
-        stack += record.renderSync({
-          stackFilter: frame =>
-            frame.getFileName().indexOf(path.sep) > -1 &&
-            frame.getFileName().indexOf('node_modules') < 0 &&
-            frame.getFileName().indexOf('internal') < 0,
-        });
-      }
-      return stack;
-    } catch (err) {
-      return stack;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const callsite_record_1 = __importDefault(require("callsite-record"));
+const path_1 = __importDefault(require("path"));
+const adapter_js_1 = __importDefault(require("./adapter.js"));
+class JavaScriptAdapter extends adapter_js_1.default {
+    formatStack(t) {
+        let stack = super.formatStack(t);
+        try {
+            const error = new Error(stack.split('\n')[0]);
+            error.stack = stack;
+            const record = (0, callsite_record_1.default)({
+                forError: error,
+            });
+            // @ts-ignore
+            if (record && !record.filename.startsWith('http')) {
+                stack += record.renderSync({
+                    stackFilter: frame => frame.fileName?.indexOf(path_1.default.sep) > -1 &&
+                        frame.fileName?.indexOf('node_modules') < 0 &&
+                        frame.fileName?.indexOf('internal') < 0,
+                });
+            }
+            return stack;
+        }
+        catch (err) {
+            return stack;
+        }
     }
-  }
 }
-
 module.exports = JavaScriptAdapter;

package/lib/junit-adapter/python.js

@@ -1,42 +1,43 @@
-const path = require('path');
-const fs = require('fs');
-const Adapter = require('./adapter');
-
-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];
-  }
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const adapter_js_1 = __importDefault(require("./adapter.js"));
+class PythonAdapter extends adapter_js_1.default {
+    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;
+    const fileParts = fileName.split('.');
+    while (fileParts.length > 0) {
+        const file = `${fileParts.join(path_1.default.sep)}.py`;
+        if (!opts.checkFile)
+            return file;
+        if (fs_1.default.existsSync(`${fileParts.join(path_1.default.sep)}.py`)) {
+            return file;
+        }
+        fileParts.pop();
     }
-    fileParts.pop();
-  }
-  return null;
+    return null;
 }
-
 module.exports = PythonAdapter;

package/lib/junit-adapter/ruby.js

@@ -1,10 +1,13 @@
-const Adapter = require('./adapter');
-
-class RubyAdapter extends Adapter {
-  formatStack(t) {
-    const stack = super.formatStack(t);
-    return stack.replace(/\[(.*?:.\d*)\]/g, '\n$1');
-  }
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const adapter_js_1 = __importDefault(require("./adapter.js"));
+class RubyAdapter extends adapter_js_1.default {
+    formatStack(t) {
+        const stack = super.formatStack(t);
+        return stack.replace(/\[(.*?:.\d*)\]/g, '\n$1');
+    }
 }
-
 module.exports = RubyAdapter;