@testomatio/reporter 1.0.15-beta → 1.0.15-beta.2

package/Changelog.md

@@ -0,0 +1,340 @@
+<!-- pending release updates -->
+# 1.0.15
+
+* Attach Run to Jira Issue via `TESTOMATIO_JIRA_ID` env variable:
+
+```
+TESTOMATIO_JIRA_ID=TST-12 <actual run command>
+```
+
+# 1.0.14
+
+* Execute tests by tag names. Use this filter to select tests associated with specific tags.
+  
+  ```bash
+  TESTOMATIO={API_KEY} npx start-test-run -c 'actual run command' --filter 'testomatio:tag-name=smoke'
+  ```
+
+  * more instruction you can find in docs/pipes/testomatio.md
+
+# 1.0.13
+
+* JUnit improvements
+  * Match test from source code by adding Test ID as a comment:
+
+  ```java
+  // @T8acca9eb
+  ```
+  * Match test from output by adding Test ID as output:
+
+  ```java
+  System.out.println("tid://@T8acca9eb");
+  ```
+  * Support for suite before and after output
+  * Improved support for artifacts
+
+# 1.0.12
+
+& Logger refactoring by @olexandr13 in #208
+* fix undefined logs by @olexandr13 in #210
+
+# 1.0.11
+
+* fix steps duplication for codecept report by @olexandr13 in #209
+
+# 1.0.10
+
+* Added `TESTOMATIO_PUBLISH=1` variable to automatically publish run report
+
+# 1.0.9
+
+* Support XUnit format
+* Improved support for parametrized Java tests
+
+# 1.0.8 
+
+* Fixed `Can't read push of undefined` when logging steps
+
+# 1.0.6
+
+* Testomat.io. Auto-detect current build url and report it to Testomat.io. Manually url can be set with `BUILD_URL` variable:
+
+```
+BUILD_URL=https://.... TESTOMATIO=apiKey <actual test command>
+```
+
+# 1.0.5 
+
+* Fix "create tests" params processing for testomatio pipe
+
+# 1.0.4
+
+* Fixed parallel run
+
+# 1.0.3
+
+* Fixed reporting parallel runs
+
+# 1.0.0
+
+
+* Added [`TESTOMATIO_SHARED_RUN` option](https://github.com/testomatio/reporter/blob/master/docs/pipes.md#reporting-parallel-execution-to-to-same-run) to use a shared run for parallel executions
+* Reworked [documentation](https://github.com/testomatio/reporter/tree/master#readme).
+* Added an option to obtain [S3 configuration](https://github.com/testomatio/reporter/blob/master/docs/artifacts.md#configuration) from Testomat.io
+* Introduced [pipes](https://github.com/testomatio/reporter/blob/master/docs/pipes.md):
+  * GitHub
+  * GitLab
+  * CSV Pipe
+
+
+# 0.7.6
+
+* Updated to use AWS S3 3.0 SDK for uploading
+
+# 0.7.5
+
+* Fixed reporting skipped tests in mocha
+
+# 0.7.4
+
+* Fixed parsing source code in JUnit files
+
+# 0.7.3
+
+* CodeceptJS: Upload all traces and videos from artifacts
+* Fixed reporting skipped test in XML
+* added `--timelimit` option to `report-xml` command line
+
+# 0.7.2
+
+* Fixed uploading non-existing file
+
+# 0.7.1
+
+* Support for NUnit XML v3 format
+
+# 0.7.0
+
+* Support for `@cucumber/cucumber` (>= 7.0) added
+* Initial support for C# and NUnit  
+
+# 0.6.10
+
+* Fixed uploading multilpe artifacts in Playwright
+
+# 0.6.9
+
+* Fixed pending tests reports for Cypress
+
+# 0.6.8
+# 0.6.7
+
+* Pytest: fixed creating suites from reports
+
+# 0.6.6
+
+* JUnit reporter: prefer suite title over testcase classname in a report
+
+# 0.6.5
+
+* Fixed test statuses for runs in JUnit reporter
+
+# 0.6.4
+
+* Added `TESTOMATIO_PROCEED=1` param to not close current run
+* Fixed priority of commands from `npx @testomatio/reporter`
+
+# 0.6.3
+
+* Fixed `npx start-test-run` to launch commands
+
+# 0.6.2
+
+* Added `--env-file` option to load env variables from env file
+
+# 0.6.1
+
+* Fixed creating RunGroup with JUnit reporter
+
+# 0.6.0
+
+* JUnit reporter support
+
+# 0.5.10
+
+* Fixed reporting Scenario Outline in Cypress-Cucumber
+* Fixed error reports for Cypress when running in Chrome
+
+# 0.5.9
+
+* Added environment on Cypress report
+
+# 0.5.8
+
+* Fixed Cypress.io reporting
+
+# 0.5.7
+
+* Fixed webdriverio artifacts
+
+# 0.5.6
+
+* Unmark failed CodeceptJS tests as skipped
+
+# 0.5.5
+
+* Fixed `BeforeSuite` failures in CodeceptJS
+
+# 0.5.4
+
+Added `TESTOMATIO_CREATE=1` option to create unmatched tests on report
+
+```
+TESTOMATIO_CREATE=1 TESTOMATIO=apiKey npx codeceptjs run
+```
+
+# 0.5.3
+
+* Fixed parsing suites
+
+# 0.5.2
+
+* Fixed multiple upload of artifacts in Cypress.io
+
+# 0.5.1
+
+* Fixed Cypress.io to report tests inside nested suites
+
+# 0.5.0
+
+* Added Cypress.io plugin
+* Added artifacts upload to webdriverio
+
+# 0.4.6
+
+- Fixed CodeceptJS reporter to report tests failed in hooks
+
+# 0.4.5
+
+- Fixed "Total XX artifacts publicly uploaded to S3 bucket" when no S3 bucket is configured
+- Improved S3 connection error messages
+
+# 0.4.4
+
+- Fixed returning 0 exit code when a process fails when running tests in parallel via `start-test-run`. Previously was using the last exit code returned by a process. Currently prefers the highest exit code that was returned by a process.
+
+# 0.4.3
+
+- Added `TESTOMATIO_DISABLE_ARTIFACTS` env variable to disable publishing artifacts.
+
+# 0.4.2
+
+- print version of reporter
+- print number of uploaded artifacts
+- print access mode for uploaded artifacts
+
+# 0.4.1
+
+Added `global.testomatioArtifacts = []` array which can be used to add arbitrary artifacts to a report.
+
+```js
+// inside a running test:
+global.testomatioArtifacts.push('file/to/upload.png');
+```
+
+# 0.4.0
+
+- Playwright: Introduced playwright/test support with screenshots and video artifacts
+
+> Known issues: reporting using projects configured in Playwright does not work yet
+
+- CodeceptJS: added video uploads
+
+# 0.3.16
+
+- CodeceptJS: fixed reporting tests with empty steps (on retry)
+
+# 0.3.15
+
+- Finish Run via API:
+
+```
+TESTOMATIO={apiKey} TESTOMATIO_RUN={runId} npx @testomatio/reporter@latest --finish
+```
+
+# 0.3.14
+
+- Create an empty Run via API:
+
+```
+TESTOMATIO={apiKey} npx @testomatio/reporter@latest --launch
+```
+
+# 0.3.13
+
+- Checking for a valid report URL
+- Sending unlimited data on test report
+
+# 0.3.12
+
+- Fixed submitting arbitrary data on a test run
+- Jest: fixed sending errors with stack traces
+- Cypress: fixed sending reports
+
+# 0.3.11
+
+- Fixed circular JSON reference when submitting data to Testomatio
+
+# 0.3.10
+
+- Minor fixes
+
+# 0.3.9
+
+- Making all reporters to run without API key
+
+# 0.3.8
+
+- Fixed `npx start-test-run` to work with empty API keys
+
+# 0.3.7
+
+- Fixed release
+
+# 0.3.6
+
+- Update title and rungroup on start for scheduled runs.
+
+# 0.3.5
+
+- Added `TESTOMATIO_RUN` environment variable to pass id of a specific run to report
+
+# 0.3.4
+
+- Minor fixes
+
+# 0.3.3
+
+- [CodeceptJS] Fixed stack trace reporting
+- [CodeceptJS] Fixed displaying of nested steps
+- [CodeceptJS][mocha] Added assertion diff to report
+
+# 0.3.2
+
+- Fixed error message for S3 uploading
+
+# 0.3.1
+
+- [CodeceptJS] Better formatter for nested structures and BDD tests
+
+# 0.3.0
+
+- Added `TESTOMATIO_TITLE` env variable to set a name for Run
+- Added `TESTOMATIO_RUNGROUP_TITLE` env variable to attach Run to RunGroup
+- Added `TESTOMATIO_ENV` env variable to attach additional env values to report
+- [CodeceptJS] **CodeceptJS v3 support**
+- [CodeceptJS] Dropped support for CodeceptJS 2
+- [CodeceptJS] Added support for before hooks
+- [CodeceptJS] Log of steps
+- [CodeceptJS] Upload screenshots of failed tests to S3
+- [CodeceptJS] Updated to use with parallel execution

package/lib/_ArtifactStorageOld.js

@@ -4,7 +4,7 @@ const fs = require('fs');
 const os = require('os');
 const uuid = require('uuid');
 const { TESTOMAT_ARTIFACT_SUFFIX } = require('./constants');
-const { specificTestInfo } = require('./util');
+const { specificTestInfo } = require('./utils/utils');
 
 class ArtifactStorage {
   

package/lib/adapter/codecept.js

@@ -3,7 +3,7 @@ const chalk = require('chalk');
 const TestomatClient = require('../client');
 const { STATUS, APP_PREFIX, TESTOMAT_TMP_STORAGE } = require('../constants');
 const upload = require('../fileUploader');
-const { parseTest: getIdFromTestTitle, fileSystem } = require('../util');
+const { parseTest: getIdFromTestTitle, fileSystem } = require('../utils/utils');
 
 if (!global.codeceptjs) {
   // eslint-disable-next-line global-require, import/no-extraneous-dependencies

package/lib/adapter/cucumber/current.js

@@ -5,7 +5,7 @@ const fs = require('fs');
 const { STATUS, TESTOMAT_TMP_STORAGE } = require('../../constants');
 const TestomatClient = require('../../client');
 const logger = require('../../logger');
-const { parseTest, fileSystem } = require('../../util');
+const { parseTest, fileSystem } = require('../../utils/utils');
 
 const { GherkinDocumentParser, PickleParser } = formatterHelpers;
 const { getGherkinScenarioLocationMap, getGherkinStepMap } = GherkinDocumentParser;

package/lib/adapter/cucumber/legacy.js

@@ -1,7 +1,7 @@
 // eslint-disable-next-line global-require, import/no-extraneous-dependencies, import/no-unresolved
 const { Formatter } = require('cucumber');
 const chalk = require('chalk');
-const { parseTest, fileSystem } = require('../../util');
+const { parseTest, fileSystem } = require('../../utils/utils');
 const { STATUS, TESTOMAT_TMP_STORAGE } = require('../../constants');
 const TestomatClient = require('../../client');
 

package/lib/adapter/cypress-plugin/index.js

@@ -1,5 +1,5 @@
 const { STATUS } = require('../../constants');
-const { parseTest, parseSuite } = require('../../util');
+const { parseTest, parseSuite } = require('../../utils/utils');
 const TestomatClient = require('../../client');
 
 const testomatioReporter = on => {

package/lib/adapter/jasmine.js

@@ -1,5 +1,5 @@
 const TestomatClient = require('../client');
-const { parseTest, ansiRegExp } = require('../util');
+const { parseTest, ansiRegExp } = require('../utils/utils');
 const { STATUS } = require('../constants');
 
 class JasmineReporter {

package/lib/adapter/jest.js

@@ -1,6 +1,6 @@
 const TestomatClient = require('../client');
 const { STATUS, TESTOMAT_TMP_STORAGE } = require('../constants');
-const { parseTest, ansiRegExp, fileSystem } = require('../util');
+const { parseTest, ansiRegExp, fileSystem } = require('../utils/utils');
 
 class JestReporter {
   constructor(globalConfig, options) {

package/lib/adapter/mocha.js

@@ -4,7 +4,7 @@ const debug = require('debug')('@testomatio/reporter:adapter:mocha');
 const chalk = require('chalk');
 const TestomatClient = require('../client');
 const { STATUS, TESTOMAT_TMP_STORAGE } = require('../constants');
-const { parseTest, specificTestInfo, fileSystem } = require('../util');
+const { parseTest, specificTestInfo, fileSystem } = require('../utils/utils');
 const ArtifactStorage = require('../_ArtifactStorageOld');
 
 const { EVENT_RUN_BEGIN, EVENT_RUN_END, EVENT_TEST_FAIL, EVENT_TEST_PASS, EVENT_TEST_PENDING } =

package/lib/adapter/playwright.js

@@ -6,7 +6,7 @@ const fs = require('fs');
 const { APP_PREFIX, STATUS: Status, TESTOMAT_TMP_STORAGE } = require('../constants');
 const TestomatioClient = require('../client');
 const { isArtifactsEnabled } = require('../fileUploader');
-const { parseTest, fileSystem } = require('../util');
+const { parseTest, fileSystem } = require('../utils/utils');
 
 const reportTestPromises = [];
 

package/lib/adapter/webdriver.js

@@ -1,7 +1,7 @@
 // eslint-disable-next-line global-require, import/no-extraneous-dependencies
 const WDIOReporter = require('@wdio/reporter').default;
 const TestomatClient = require('../client');
-const { parseTest } = require('../util');
+const { parseTest } = require('../utils/utils');
 
 class WebdriverReporter extends WDIOReporter {
   constructor(options) {

package/lib/bin/startTest.js

@@ -13,9 +13,11 @@ 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")
-  .action(opts => {
+  .option("--filter <filter>", "Additional execution filter")
+  .action(async (opts) => {
+    const { launch, finish, filter } = opts;
+    let { command } = 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;
@@ -51,6 +53,27 @@ program
 
     let exitCode = 0;
 
+    const client = new TestomatClient({ apiKey, title, parallel: true });
+
+    if(filter) {
+      const [pipe, ...optsArray] = filter.split(":");
+      const pipeOptions = optsArray.join(":");
+
+      try { 
+        const tests = await client.prepareRun({pipe, pipeOptions});
+
+        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.`);
@@ -73,8 +96,6 @@ 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,9 +27,64 @@ 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.pipeOptions - 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, pipeOptions } = params;
+    // all pipes disabled, skipping
+    if (!this.pipes.some(p => p.isEnabled)) {
+      return Promise.resolve();
+    }
+
+    try {
+      const filterPipe = this.pipes.find(p => p.constructor.name.toLowerCase() === `${pipe.toLowerCase()}pipe`);
+
+      if (!filterPipe.isEnabled) {
+        // 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 => 
+        ({ pipe: p.toString(), result: await p.prepareRun(pipeOptions) })  
+      ));
+    
+      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);
+    }
+  }
+
   /**
    * Used to create a new Test run
    *

package/lib/dataStorage.js

@@ -5,8 +5,8 @@ const os = require('os');
 const { join } = require('path');
 const JestReporter = require('./adapter/jest');
 const { TESTOMAT_TMP_STORAGE } = require('./constants');
-const { fileSystem } = require('./util');
-const getTestIdFromTestTitle = require('./util').parseTest;
+const { fileSystem } = require('./utils/utils');
+const getTestIdFromTestTitle = require('./utils/utils').parseTest;
 
 class DataStorage {
   /**

package/lib/pipe/csv.js

@@ -4,7 +4,7 @@ const fs = require('fs');
 const csvWriter = require('csv-writer');
 const chalk = require('chalk');
 const merge = require('lodash.merge');
-const { isSameTest, getCurrentDateTime } = require('../util');
+const { isSameTest, getCurrentDateTime } = require('../utils/utils');
 const { CSV_HEADERS } = require('../constants');
 
 /**
@@ -40,6 +40,9 @@ class CsvPipe {
     }
   }
 
+  // TODO: to using SET opts as argument => prepareRun(opts)
+  async prepareRun() {}
+  
   async createRun() {
     // empty
   }

package/lib/pipe/github.js

@@ -5,7 +5,8 @@ const humanizeDuration = require('humanize-duration');
 const merge = require('lodash.merge');
 const { Octokit } = require('@octokit/rest');
 const { APP_PREFIX } = require('../constants');
-const { ansiRegExp, isSameTest } = require('../util');
+const { ansiRegExp, isSameTest } = require('../utils/utils');
+const { statusEmoji, fullName } = require('../utils/pipe_utils');
 
 /**
  * @typedef {import('../../types').Pipe} Pipe
@@ -37,6 +38,9 @@ class GitHubPipe {
     debug('GitHub Pipe: Enabled');
   }
 
+  // TODO: to using SET opts as argument => prepareRun(opts)
+  async prepareRun() {}
+
   async createRun() {}
 
   addTest(test) {
@@ -182,21 +186,6 @@ 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

@@ -5,7 +5,8 @@ const humanizeDuration = require('humanize-duration');
 const merge = require('lodash.merge');
 const path = require('path');
 const { APP_PREFIX } = require('../constants');
-const { ansiRegExp, isSameTest } = require('../util');
+const { ansiRegExp, isSameTest } = require('../utils/utils');
+const { statusEmoji, fullName } = require('../utils/pipe_utils');
 
 //! GITLAB_PAT environment variable is required for this functionality to work
 //! and your pipeline trigger should be merge_request
@@ -46,6 +47,9 @@ class GitLabPipe {
     debug('GitLab Pipe: Enabled');
   }
 
+  // TODO: to using SET opts as argument => prepareRun(opts)
+  async prepareRun() {}
+
   async createRun() {}
 
   addTest(test) {
@@ -179,21 +183,6 @@ 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 } = require('../util');
-const { resetConfig } = require('../fileUploader');
+const { isValidUrl, foundedTestLog } = require('../utils/utils');
+const { parseFilterParams, generateFilterRequestParams, setS3Credentials, } = require('../utils/pipe_utils');
 
 const { TESTOMATIO_RUN } = process.env;
 if (TESTOMATIO_RUN) {
@@ -33,12 +33,16 @@ 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({
-      timeout: 30000,
+      baseURL: `${this.url.trim()}`,
+      timeout: 30000
     });
+
     this.isEnabled = true;
     // do not finish this run (for parallel testing)
     this.proceed = process.env.TESTOMATIO_PROCEED;
+    this.jiraId = process.env.TESTOMATIO_JIRA_ID;
     this.runId = params.runId || process.env.runId;
     this.createNewTests = params.createNewTests ?? !!process.env.TESTOMATIO_CREATE;
     this.hasUnmatchedTests = false;
@@ -49,6 +53,47 @@ 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;
+      }
+      
+      console.log(APP_PREFIX, `⛔  No tests found for your --filter --> ${type}=${id}`);
+    }
+    catch (err) {
+      console.error(
+        APP_PREFIX,
+        `🚩 Error getting Testomat.io test grepList: ${err}`,
+      );
+    }
+  }
+
   /**
    * @returns Promise<void>
    */
@@ -83,6 +128,7 @@ class TestomatioPipe {
         api_key: this.apiKey.trim(),
         group_title: this.groupTitle,
         access_event: accessEvent,
+        jira_id: this.jiraId,
         env: this.env,
         title: this.title,
         shared_run: this.sharedRun,
@@ -92,13 +138,13 @@ class TestomatioPipe {
 
     if (this.runId) {
       debug(`Run with id ${this.runId} already created, updating...`);
-      const resp = await this.axios.put(`${this.url.trim()}/api/reporter/${this.runId}`, runParams);
+      const resp = await this.axios.put(`/api/reporter/${this.runId}`, runParams);
       if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
       return;
     }
 
     try {
-      const resp = await this.axios.post(`${this.url.trim()}/api/reporter`, runParams, {
+      const resp = await this.axios.post(`/api/reporter`, runParams, {
         maxContentLength: Infinity,
         maxBodyLength: Infinity,
       });
@@ -135,38 +181,37 @@ class TestomatioPipe {
     data.create = this.createNewTests;
     const json = JsonCycle.stringify(data);
 
-    return this.axios
-      .post(`${this.url}/api/reporter/${this.runId}/testrun`, json, {
-        maxContentLength: Infinity,
-        maxBodyLength: Infinity,
-        headers: {
-          // Overwrite Axios's automatically set Content-Type
-          'Content-Type': 'application/json',
-        },
-      })
-      .catch(err => {
-        if (err.response) {
-          if (err.response.status >= 400) {
-            const responseData = err.response.data || { message: '' };
-            console.log(
-              APP_PREFIX,
-              chalk.yellow(`Warning: ${responseData.message} (${err.response.status})`),
-              chalk.grey(data?.title || ''),
-            );
-            if (err.response.data.message.includes('could not be matched')) {
-              this.hasUnmatchedTests = true;
-            }
-            return;
-          }
+    return this.axios.post(`/api/reporter/${this.runId}/testrun`, json, {
+      maxContentLength: Infinity,
+      maxBodyLength: Infinity,
+      headers: {
+        // Overwrite Axios's automatically set Content-Type
+        'Content-Type': 'application/json',
+      },
+    })
+    .catch(err => {
+      if (err.response) {
+        if (err.response.status >= 400) {
+          const responseData = err.response.data || { message: '' };
           console.log(
             APP_PREFIX,
-            chalk.yellow(`Warning: ${data?.title || ''} (${err.response?.status})`),
-            `Report couldn't be processed: ${err?.response?.data?.message}`,
+            chalk.yellow(`Warning: ${responseData.message} (${err.response.status})`),
+            chalk.grey(data?.title || ''),
           );
-        } else {
-          console.log(APP_PREFIX, chalk.blue(data?.title || ''), "Report couldn't be processed", err);
+          if (err.response.data.message.includes('could not be matched')) {
+            this.hasUnmatchedTests = true;
+          }
+          return;
         }
-      });
+        console.log(
+          APP_PREFIX,
+          chalk.yellow(`Warning: ${data?.title || ''} (${err.response?.status})`),
+          `Report couldn't be processed: ${err?.response?.data?.message}`,
+        );
+      } else {
+        console.log(APP_PREFIX, chalk.blue(data?.title || ''), "Report couldn't be processed", err);
+      }
+    });
   }
 
   /**
@@ -188,7 +233,7 @@ class TestomatioPipe {
 
     try {
       if (this.runId && !this.proceed) {
-        await this.axios.put(`${this.url}/api/reporter/${this.runId}`, {
+        await this.axios.put(`/api/reporter/${this.runId}`, {
           api_key: this.apiKey,
           status_event,
           tests: params.tests,
@@ -242,17 +287,3 @@ 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/utils/pipe_utils.js

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

package/lib/{util.js → utils/utils.js}

@@ -227,6 +227,15 @@ const fileSystem = {
   },
 };
 
+
+const foundedTestLog = (app, tests) => {
+  const n = tests.length;
+
+  return (n === 1)
+    ? console.log(app, `✅ We found one test!`)
+    : console.log(app, `✅ We found ${n} tests!`);
+}
+
 const humanize = text => {
   text = decamelize(text);
   return text
@@ -297,4 +306,5 @@ module.exports = {
   parseSuite,
   humanize,
   removeColorCodes,
-};
+  foundedTestLog
+};

package/lib/xmlReader.js

@@ -8,12 +8,12 @@ const { fetchFilesFromStackTrace,
         fetchIdFromOutput, 
         fetchSourceCode, 
         fetchSourceCodeFromStackTrace, 
-        fetchIdFromCode 
-      } = require('./util');
+        fetchIdFromCode,
+        humanize
+      } = require('./utils/utils');
 const upload = require('./fileUploader');
 const pipesFactory = require('./pipe');
 const adapterFactory = require('./junit-adapter');
-const { humanize } = require('./util')
 
 const TESTOMATIO_URL = process.env.TESTOMATIO_URL || "https://app.testomat.io";
 const TESTOMATIO = process.env.TESTOMATIO; // key?

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.0.15-beta",
+  "version": "1.0.15-beta.2",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -55,7 +55,7 @@
     "@redocly/cli": "^1.0.0-beta.125",
     "@wdio/reporter": "^7.16.13",
     "chai": "^4.3.6",
-    "codeceptjs": "^3.2.3",
+    "codeceptjs": "latest",
     "cucumber": "^6.0.7",
     "eslint": "^8.7.0",
     "eslint-config-airbnb-base": "^15.0.0",