@testomatio/reporter 1.0.9-beta.2 → 1.0.10

package/lib/bin/startTest.js

@@ -13,11 +13,9 @@ program
   .option('--launch', 'Start a new run and return its ID')
   .option('--finish', 'Finish Run by its ID')
   .option("--env-file <envfile>", "Load environment variables from env file")
-  .option("--filter <filter>", "Additional execution filter")
-  .action(async (opts) => {
-    const { launch, finish, filter } = opts;
-    let { command } = opts;
+  .action(opts => {
 
+    const { command, launch, finish } = opts;
     if (opts.envFile) require('dotenv').config(opts.envFile); // eslint-disable-line
 
     const apiKey = process.env['INPUT_TESTOMATIO-KEY'] || process.env.TESTOMATIO;
@@ -53,27 +51,6 @@ program
 
     let exitCode = 0;
 
-    const client = new TestomatClient({ apiKey, title, parallel: true });
-
-    if(filter) {
-      const [pipe, ...optsArray] = filter.split(":");
-      const opts = optsArray.join(":");
-
-      try { 
-        const tests = await client.prepareRun({pipe, opts});
-
-        if(!tests || tests.length === 0) {
-          return;
-        }
-
-        const grep = ` --grep (${tests.join('|')})`;
-        command += grep;
-      }
-      catch(err) {
-        console.log(APP_PREFIX, err);
-      }
-    }
-
     if (!command.split) {
       process.exitCode = 255;
       console.log(APP_PREFIX, `No command provided. Use -c option to launch a test runner.`);
@@ -96,6 +73,8 @@ program
       return;
     }
 
+    const client = new TestomatClient({ apiKey, title, parallel: true });
+
     client.createRun().then(() => {
       const cmd = spawn(testCmds[0], testCmds.slice(1), { stdio: 'inherit' });
 

package/lib/client.js

@@ -27,60 +27,9 @@ class Client {
     this.queue = Promise.resolve();
     this.totalUploaded = 0;
     this.version = JSON.parse(fs.readFileSync(join(__dirname, '..', 'package.json')).toString()).version;
-    this.executionList = Promise.resolve();
-
     console.log(APP_PREFIX, `Testomatio Reporter v${this.version}`);
   }
 
-  /**
-   * Asynchronously prepares the execution list for running tests through various pipes.
-   * 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.
-   * If no valid results are found, the function returns undefined.
-   * Otherwise, it returns the first non-empty array from the filtered results.
-   *
-   * @param {Object} params - The options for preparing the test execution list.
-   * @param {string} params.pipe - Name of the executed pipe.
-   * @param {string} params.opts - Filter option.
-   * @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.
-   */
-  async prepareRun(params) {
-    const { pipe, opts } = params;
-    // all pipes disabled, skipping
-    if (!this.pipes.some(p => p.isEnabled)) {
-      return Promise.resolve();
-    }
-
-    try {
-      if (pipe.toLowerCase() !== "testomatio") {
-        //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"`)
-        return;
-      }
-
-      const results = await Promise.all(this.pipes.map(async p => {
-        return { pipe: p.toString(), result: await p.prepareRun(opts) };
-      }));
-    
-      const result = results.filter(p => p.pipe.includes('Testomatio'))[0]?.result;
-
-      if (!result || result.length === 0) {
-        return;
-      } 
-  
-      debug('Execution tests list', result);
-
-      return result;
-    } catch (err) {
-      console.error(APP_PREFIX, err);
-      return;
-    }
-  }
-
   /**
    * Used to create a new Test run
    *

package/lib/pipe/csv.js

@@ -40,8 +40,6 @@ class CsvPipe {
     }
   }
 
-  async prepareRun(opts) {}
-  
   async createRun() {
     // empty
   }

package/lib/pipe/github.js

@@ -6,7 +6,6 @@ const merge = require('lodash.merge');
 const { Octokit } = require('@octokit/rest');
 const { APP_PREFIX } = require('../constants');
 const { ansiRegExp, isSameTest } = require('../util');
-const { statusEmoji, fullName } = require('./misc');
 
 /**
  * @typedef {import('../../types').Pipe} Pipe
@@ -38,8 +37,6 @@ class GitHubPipe {
     debug('GitHub Pipe: Enabled');
   }
 
-  async prepareRun(opts) {}
-
   async createRun() {}
 
   addTest(test) {
@@ -185,6 +182,21 @@ class GitHubPipe {
   }
 }
 
+function statusEmoji(status) {
+  if (status === 'passed') return '🟢';
+  if (status === 'failed') return '🔴';
+  if (status === 'skipped') return '🟡';
+  return '';
+}
+
+function fullName(t) {
+  let line = '';
+  if (t.suite_title) line = `${t.suite_title}: `;
+  line += `**${t.title}**`;
+  if (t.example) line += ` \`[${Object.values(t.example)}]\``;
+  return line;
+}
+
 async function deletePreviousReport(octokit, owner, repo, issue, hiddenCommentData) {
   if (process.env.GH_KEEP_OUTDATED_REPORTS) return;
 

package/lib/pipe/gitlab.js

@@ -6,7 +6,6 @@ const merge = require('lodash.merge');
 const path = require('path');
 const { APP_PREFIX } = require('../constants');
 const { ansiRegExp, isSameTest } = require('../util');
-const { statusEmoji, fullName } = require('./misc');
 
 //! GITLAB_PAT environment variable is required for this functionality to work
 //! and your pipeline trigger should be merge_request
@@ -47,8 +46,6 @@ class GitLabPipe {
     debug('GitLab Pipe: Enabled');
   }
 
-  async prepareRun(opts) {}
-
   async createRun() {}
 
   addTest(test) {
@@ -182,6 +179,21 @@ class GitLabPipe {
   updateRun() {}
 }
 
+function statusEmoji(status) {
+  if (status === 'passed') return '🟢';
+  if (status === 'failed') return '🔴';
+  if (status === 'skipped') return '🟡';
+  return '';
+}
+
+function fullName(t) {
+  let line = '';
+  if (t.suite_title) line = `${t.suite_title}: `;
+  line += `**${t.title}**`;
+  if (t.example) line += ` \`[${Object.values(t.example)}]\``;
+  return line;
+}
+
 async function deletePreviousReport(axiosInstance, commentsRequestURL, hiddenCommentData, token) {
   if (process.env.GITLAB_KEEP_OUTDATED_REPORTS) return;
 

package/lib/pipe/testomatio.js

@@ -3,8 +3,8 @@ const chalk = require('chalk');
 const axios = require('axios');
 const JsonCycle = require('json-cycle');
 const { APP_PREFIX, STATUS } = require('../constants');
-const { isValidUrl, foundedTestLog } = require('../util');
-const { parseFilterParams, generateFilterRequestParams, setS3Credentials, } = require('./misc');
+const { isValidUrl } = require('../util');
+const { resetConfig } = require('../fileUploader');
 
 const { TESTOMATIO_RUN } = process.env;
 if (TESTOMATIO_RUN) {
@@ -33,12 +33,7 @@ class TestomatioPipe {
     this.sharedRun = !!process.env.TESTOMATIO_SHARED_RUN;
     this.groupTitle = params.groupTitle || process.env.TESTOMATIO_RUNGROUP_TITLE;
     this.env = process.env.TESTOMATIO_ENV;
-
-    this.axios = axios.create({
-      baseURL: `${this.url.trim()}`,
-      timeout: 20000
-    });
-
+    this.axios = axios.create();
     this.isEnabled = true;
     // do not finish this run (for parallel testing)
     this.proceed = process.env.TESTOMATIO_PROCEED;
@@ -52,50 +47,6 @@ class TestomatioPipe {
     }
   }
 
-  /**
-   * Asynchronously prepares and retrieves the Testomat.io test grepList based on the provided options.
-   * @param {Object} opts - The options for preparing the test grepList.
-   * @returns {Promise<string[]>} - An array containing the retrieved 
-   * test grepList, or an empty array if no tests are found or the request is disabled.
-   * @throws {Error} - Throws an error if there was a problem while making the request.
-   */
-  async prepareRun(opts) {
-    if (!this.isEnabled) return [];
-
-    const { type, id } = parseFilterParams(opts);
-
-    try {
-      const q = generateFilterRequestParams({
-        type,
-        id,
-        apiKey: this.apiKey.trim()
-      });
-
-      if (!q) {
-        return;
-      }
-
-      const resp = await this.axios.get('/api/test_grep', q);
-      const { data } = resp;
-
-      if (Array.isArray(data?.tests) && data?.tests?.length > 0) {
-        foundedTestLog(APP_PREFIX, data.tests);
-        return data.tests;
-      }
-      else {
-        console.log(APP_PREFIX, `⛔  No tests found for your --filter --> ${type}=${id}`);
-        return;
-      }
-    }
-    catch (err) {
-      console.error(
-        APP_PREFIX,
-        `🚩 Error getting Testomat.io test grepList: ${err}`,
-      );
-      return;
-    }
-  }
-
   /**
    * @returns Promise<void>
    */
@@ -120,12 +71,15 @@ class TestomatioPipe {
 
     if (buildUrl && !buildUrl.startsWith('http')) buildUrl = undefined;
 
+    const accessEvent = process.env.TESTOMATIO_PUBLISH ? 'publish' : null;
+
     const runParams = Object.fromEntries(
       Object.entries({
         ci_build_url: buildUrl,
         parallel: this.parallel,
         api_key: this.apiKey.trim(),
         group_title: this.groupTitle,
+        access_event: accessEvent,
         env: this.env,
         title: this.title,
         shared_run: this.sharedRun,
@@ -133,20 +87,22 @@ class TestomatioPipe {
     );
 
     if (this.runId) {
-      const resp = await this.axios.put(`/api/reporter/${this.runId}`, runParams);
+      const resp = await this.axios.put(`${this.url.trim()}/api/reporter/${this.runId}`, runParams);
       if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
       return;
     }
 
     try {
-      const resp = await this.axios.post(`/api/reporter`, runParams, {
+      const resp = await this.axios.post(`${this.url.trim()}/api/reporter`, runParams, {
         maxContentLength: Infinity,
         maxBodyLength: Infinity,
       });
       this.runId = resp.data.uid;
       this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
+      this.runPublicUrl = resp.data.public_url;
       if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
       this.store.runUrl = this.runUrl;
+      this.store.runPublicUrl = this.runPublicUrl;
       this.store.runId = this.runId;
       console.log(APP_PREFIX, '📊 Report created. Report ID:', this.runId);
       process.env.runId = this.runId;
@@ -170,7 +126,7 @@ class TestomatioPipe {
     data.create = this.createNewTests;
     const json = JsonCycle.stringify(data);
 
-    return this.axios.post(`/api/reporter/${this.runId}/testrun`, json, {
+    return this.axios.post(`${this.url}/api/reporter/${this.runId}/testrun`, json, {
       maxContentLength: Infinity,
       maxBodyLength: Infinity,
       headers: {
@@ -218,7 +174,7 @@ class TestomatioPipe {
 
     try {
       if (this.runId && !this.proceed) {
-        await this.axios.put(`/api/reporter/${this.runId}`, {
+        await this.axios.put(`${this.url}/api/reporter/${this.runId}`, {
           api_key: this.apiKey,
           status_event,
           tests: params.tests,
@@ -226,6 +182,10 @@ class TestomatioPipe {
         if (this.runUrl) {
           console.log(APP_PREFIX, '📊 Report Saved. Report URL:', chalk.magenta(this.runUrl));
         }
+        if (this.runPublicUrl) {
+          console.log(APP_PREFIX, '🌟 Public URL:', chalk.magenta(this.runPublicUrl));
+        }
+        
       }
       if (this.runUrl && this.proceed) {
         const notFinishedMessage = chalk.yellow.bold('Run was not finished because of $TESTOMATIO_PROCEED');
@@ -258,3 +218,18 @@ class TestomatioPipe {
 }
 
 module.exports = TestomatioPipe;
+
+
+function setS3Credentials(artifacts) {  
+  if (!Object.keys(artifacts).length) return;
+
+  console.log(APP_PREFIX, 'S3 were credentials obtained from Testomat.io...');
+
+  if (artifacts.ACCESS_KEY_ID) process.env.S3_ACCESS_KEY_ID = artifacts.ACCESS_KEY_ID; 
+  if (artifacts.SECRET_ACCESS_KEY) process.env.S3_SECRET_ACCESS_KEY = artifacts.SECRET_ACCESS_KEY; 
+  if (artifacts.REGION) process.env.S3_REGION = artifacts.REGION; 
+  if (artifacts.BUCKET) process.env.S3_BUCKET = artifacts.BUCKET; 
+  if (artifacts.ENDPOINT) process.env.S3_ENDPOINT = artifacts.ENDPOINT; 
+  if (artifacts.presign) process.env.TESTOMATIO_PRIVATE_ARTIFACTS = '1'; 
+  resetConfig();
+}

package/lib/util.js

@@ -192,15 +192,6 @@ const fileSystem = {
   }
 };
 
-
-const foundedTestLog = (app, tests) => {
-  const n = tests.length;
-
-  return (n === 1)
-    ? console.log(app, `✅ We found only one test!`)
-    : console.log(app, `✅ We found ${n} tests!`);
-}
-
 const humanize = (text) => {  
   text = decamelize(text);
   return text.replace(/_./g, match => ` ${  match.charAt(1).toUpperCase()}`)
@@ -259,5 +250,4 @@ module.exports = {
   parseTest,
   parseSuite,
   humanize,
-  foundedTestLog
-}
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.0.9-beta.2",
+  "version": "1.0.10",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",

package/lib/pipe/misc.js

@@ -1,135 +0,0 @@
-const { resetConfig } = require('../fileUploader');
-const { APP_PREFIX } = require('../constants');
-
-/**
- * Set S3 credentials from the provided artifacts object.
- * @param {Object} artifacts - The artifacts object containing S3 credentials.
- */
-function setS3Credentials(artifacts) {
-    if (!Object.keys(artifacts).length) return;
-
-    console.log(APP_PREFIX, 'S3 were credentials obtained from Testomat.io...');
-
-    if (artifacts.ACCESS_KEY_ID) process.env.S3_ACCESS_KEY_ID = artifacts.ACCESS_KEY_ID;
-    if (artifacts.SECRET_ACCESS_KEY) process.env.S3_SECRET_ACCESS_KEY = artifacts.SECRET_ACCESS_KEY;
-    if (artifacts.REGION) process.env.S3_REGION = artifacts.REGION;
-    if (artifacts.BUCKET) process.env.S3_BUCKET = artifacts.BUCKET;
-    if (artifacts.ENDPOINT) process.env.S3_ENDPOINT = artifacts.ENDPOINT;
-    if (artifacts.presign) process.env.TESTOMATIO_PRIVATE_ARTIFACTS = '1';
-    resetConfig();
-}
-/**
- * Generates mode request parameters based on the input params.
- * @param {Object} params - The input parameters for the request.
- * @param {string} params.type - The type of the request (e.g., "tag").
- * @param {string} params.id - The ID associated with the request.
- * @param {string} params.apiKey - The API key for authentication.
- * @returns {Object|null} - An object containing the generated request parameters, or null if the type is invalid.
- */
-function generateFilterRequestParams(params) {
-    const { type, id, apiKey } = params;
-
-    if (!type) {
-        return;
-    }
-
-    if (!id) {
-        console.error(APP_PREFIX, `Please make sure your settings "${type.toUpperCase()}"= "${id}" is correct!`);
-        return;
-    }
-
-    return {
-        params: {
-            type,
-            id: encodeURIComponent(id),
-            api_key: apiKey
-        },
-        responseType: "json"
-    }
-}
-
-/**
- * Parse filter parameters from a string in the format "type=id".
- * @param {string} opts - The input string containing the filter parameters.
- * @returns {Object} An object containing the parsed filter parameters.
- *                   The object has properties "type" and "id".
- */
-function parseFilterParams(opts) {
-    const [type, id] = opts.split("=");
-    const validType = updateFilterType(type);
-
-    return {
-        type: validType,
-        id
-    };
-}
-
-/**
- * Update and validate the filter type.
- * @param {string} type - The original filter type.
- * @returns {string|undefined} The updated and validated filter type.
- *                            Returns undefined if the type is not valid.
- */
-function updateFilterType(type) {
-    const typeLowerCase = type.toLowerCase();
-
-    const filterTypes = [
-        "tag-name",
-        "plan-id",
-        "label",
-        "jira-ticket",
-    ];
-
-    const filterApi = [
-        "tag",
-        "plan",
-        "label",
-        "jira",
-        // "ims-issue", //TODO: WIP
-    ];
-
-    if (!filterTypes.includes(typeLowerCase)) {
-        console.log(APP_PREFIX, `❗❗❗ Invalid "filter=${type}" start settings! Available option list: ${filterTypes}`);
-        return;
-    }
-
-    const index = filterTypes.indexOf(typeLowerCase);
-
-    return (index !== -1)
-        ? filterApi[index]
-        : undefined
-}
-
-/**
- * Return an emoji based on the provided status.
- * @param {string} status - The status value ('passed', 'failed', or 'skipped').
- * @returns {string} - An emoji corresponding to the provided status.
- */
-function statusEmoji(status) {
-    if (status === 'passed') return '🟢';
-    if (status === 'failed') return '🔴';
-    if (status === 'skipped') return '🟡';
-    return '';
-}
-
-/**
- * Generate a full name string based on the provided test object.
- * @param {object} t - The test object.
- * @returns {string} - A formatted full name string for the test object.
- */
-function fullName(t) {
-    let line = '';
-    if (t.suite_title) line = `${t.suite_title}: `;
-    line += `**${t.title}**`;
-    if (t.example) line += ` \`[${Object.values(t.example)}]\``;
-    return line;
-}
-
-module.exports = {
-    updateFilterType,
-    parseFilterParams,
-    generateFilterRequestParams,
-    setS3Credentials,
-    statusEmoji,
-    fullName
-};