testbeats 2.0.8 → 2.1.0

package/README.md

@@ -9,11 +9,9 @@
 
 <br />
 
-![Build](https://github.com/test-results-reporter/testbeats/workflows/Build/badge.svg?branch=main)
-![Downloads](https://img.shields.io/npm/dt/test-results-reporter?logo=npm&label=downloads-old)
-![Downloads](https://img.shields.io/npm/dt/testbeats?logo=npm)
-![Size](https://img.shields.io/bundlephobia/minzip/testbeats)
-![NodeJs](https://img.shields.io/badge/NodeJS-%3E%3D14.0.0-brightgreen?logo=node.js)
+[![Build](https://github.com/test-results-reporter/testbeats/actions/workflows/build.yml/badge.svg)](https://github.com/test-results-reporter/testbeats/actions/workflows/build.yml)
+[![Downloads](https://img.shields.io/npm/dt/test-results-parser?logo=npm&label=downloads)](https://www.npmjs.com/package/test-results-parser)
+[![Size](https://img.shields.io/bundlephobia/minzip/testbeats)](https://bundlephobia.com/result?p=testbeats)
 
 
 [![Stars](https://img.shields.io/github/stars/test-results-reporter/testbeats?style=social)](https://github.com/test-results-reporter/testbeats/stargazers)
@@ -23,9 +21,11 @@
 
 </span>
 
-### Get Started
+<br />
+
+**TestBeats** is a tool designed to streamline the process of publishing test results from various automation testing frameworks to communication platforms like **slack**, **teams** and more for easy access and collaboration. It unifies your test reporting to build quality insights and make faster decisions.
 
-TestBeats is a tool designed to streamline the process of publishing test results from various automation testing frameworks to communication platforms like **slack**, **teams** and more for easy access and collaboration. It unifies your test reporting to build quality insights and make faster decisions.
+It supports all major automation testing frameworks and tools.
 
 Read more about the project at [https://testbeats.com](https://testbeats.com)
 
@@ -47,4 +47,8 @@ We use [Github Discussions](https://github.com/test-results-reporter/testbeats/d
 
 ## Support Us
 
-Like this project! Star it on [Github](https://github.com/test-results-reporter/testbeats) ⭐. Your support means a lot to us.
+Like this project! Star it on [Github](https://github.com/test-results-reporter/testbeats) ⭐. Your support means a lot to us.
+
+<br />
+
+> Read more about the project at [https://testbeats.com](https://testbeats.com)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testbeats",
-  "version": "2.0.8",
+  "version": "2.1.0",
   "description": "Publish test results to Microsoft Teams, Google Chat, Slack and InfluxDB",
   "main": "src/index.js",
   "types": "./src/index.d.ts",
@@ -55,7 +55,7 @@
     "pretty-ms": "^7.0.1",
     "rosters": "0.0.1",
     "sade": "^1.8.1",
-    "test-results-parser": "latest"
+    "test-results-parser": "0.2.3"
   },
   "devDependencies": {
     "c8": "^7.12.0",

package/src/beats/beats.api.js

@@ -25,7 +25,7 @@ class BeatsApi {
   */
   getTestRun(run_id) {
     return request.get({
-      url: `${this.getBaseUrl()}/api/core/v1/test-runs/key?id=${run_id}`,
+      url: `${this.getBaseUrl()}/api/core/v1/test-runs/${run_id}`,
       headers: {
         'x-api-key': this.config.api_key
       }
@@ -46,6 +46,21 @@ class BeatsApi {
   getBaseUrl() {
     return process.env.TEST_BEATS_URL || "https://app.testbeats.com";
   }
+
+  /**
+   *
+   * @param {string} run_id
+   * @param {number} limit
+   * @returns {import('./beats.types').IErrorClustersResponse}
+   */
+  getErrorClusters(run_id, limit = 3) {
+    return request.get({
+      url: `${this.getBaseUrl()}/api/core/v1/test-runs/${run_id}/error-clusters?limit=${limit}`,
+      headers: {
+        'x-api-key': this.config.api_key
+      }
+    });
+  }
 }
 
 module.exports = { BeatsApi }

package/src/beats/beats.js

@@ -33,6 +33,7 @@ class Beats {
     this.#updateTitleLink();
     await this.#attachFailureSummary();
     await this.#attachSmartAnalysis();
+    await this.#attachErrorClusters();
   }
 
   #setCIInfo() {
@@ -189,6 +190,34 @@ class Beats {
     logger.warn(`🙈 ${text} not generated in given time`);
   }
 
+  async #attachErrorClusters() {
+    if (!this.test_run_id) {
+      return;
+    }
+    if (!this.config.targets) {
+      return;
+    }
+    if (this.result.status !== 'FAIL') {
+      return;
+    }
+    if (this.config.show_error_clusters === false) {
+      return;
+    }
+    try {
+      logger.info('🧮 Fetching Error Clusters...');
+      const res = await this.api.getErrorClusters(this.test_run_id, 3);
+      this.config.extensions.push({
+        name: 'error-clusters',
+        hook: HOOK.AFTER_SUMMARY,
+        inputs: {
+          data: res.values
+        }
+      });
+    } catch (error) {
+      logger.error(`❌ Unable to attach error clusters: ${error.message}`, error);
+    }
+  }
+
 }
 
 module.exports = { Beats }

package/src/beats/beats.types.d.ts

@@ -17,3 +17,18 @@ export type IBeatExecutionMetric = {
   test_run_id: string
   org_id: string
 }
+
+export type IPaginatedAPIResponse<T> = {
+  page: number
+  limit: number
+  total: number
+  values: T[]
+}
+
+export type IErrorClustersResponse = {} & IPaginatedAPIResponse<IErrorCluster>;
+
+export type IErrorCluster = {
+  test_failure_id: string
+  failure: string
+  count: number
+}

package/src/commands/publish.command.js

@@ -18,6 +18,7 @@ class PublishCommand {
    */
   constructor(opts) {
     this.opts = opts;
+    this.errors = [];
   }
 
   async publish() {
@@ -31,7 +32,7 @@ class PublishCommand {
     this.#validateConfig();
     this.#processResults();
     await this.#publishResults();
-    logger.info('✅ Results published successfully!');
+    await this.#publishErrors();
   }
 
   #validateEnvDetails() {
@@ -184,13 +185,24 @@ class PublishCommand {
         } else if (result_options.type === 'jmeter') {
           this.results.push(prp.parse(result_options));
         } else {
-          this.results.push(trp.parse(result_options));
+          const { result, errors } = trp.parseV2(result_options);
+          if (result) {
+            this.results.push(result);
+          }
+          if (errors) {
+            this.errors = this.errors.concat(errors);
+          }
         }
       }
     }
   }
 
   async #publishResults() {
+    if (!this.results.length) {
+      logger.warn('⚠️ No results to publish');
+      return;
+    }
+
     for (const config of this.configs) {
       for (let i = 0; i < this.results.length; i++) {
         const result = this.results[i];
@@ -207,6 +219,23 @@ class PublishCommand {
         }
       }
     }
+    logger.info('✅ Results published successfully!');
+  }
+
+  async #publishErrors() {
+    if (!this.errors.length) {
+      logger.debug('⚠️ No errors to publish');
+      return;
+    }
+    logger.info('🛑 Publishing errors...');
+    for (const config of this.configs) {
+      if (config.targets) {
+        for (const target of config.targets) {
+          await target_manager.handleErrors({ target, errors: this.errors });
+        }
+      }
+    }
+    throw new Error(this.errors.join('\n'));
   }
 
 }

package/src/extensions/base.extension.js

@@ -86,6 +86,22 @@ class BaseExtension {
     }
   }
 
+  /**
+   * @param {string|number} text
+   */
+  bold(text) {
+    switch (this.target.name) {
+      case 'teams':
+        return `**${text}**`;
+      case 'slack':
+        return `*${text}*`;
+      case 'chat':
+        return `<b>${text}</b>`;
+      default:
+        break;
+    }
+  }
+
 }
 
 module.exports = { BaseExtension }

package/src/extensions/error-clusters.extension.js

@@ -0,0 +1,44 @@
+const { BaseExtension } = require('./base.extension');
+const { STATUS, HOOK } = require("../helpers/constants");
+
+class ErrorClustersExtension extends BaseExtension {
+
+  constructor(target, extension, result, payload, root_payload) {
+    super(target, extension, result, payload, root_payload);
+    this.#setDefaultOptions();
+    this.#setDefaultInputs();
+    this.updateExtensionInputs();
+  }
+
+  run() {
+    this.#setText();
+    this.attach();
+  }
+
+  #setDefaultOptions() {
+    this.default_options.hook = HOOK.AFTER_SUMMARY,
+    this.default_options.condition = STATUS.PASS_OR_FAIL;
+  }
+
+  #setDefaultInputs() {
+    this.default_inputs.title = 'Top Errors';
+    this.default_inputs.title_link = '';
+  }
+
+  #setText() {
+    const data = this.extension.inputs.data;
+    if (!data || !data.length) {
+      return;
+    }
+
+    const clusters = data;
+
+    const texts = [];
+    for (const cluster of clusters) {
+      texts.push(`${cluster.failure} - ${this.bold(`(x${cluster.count})`)}`);
+    }
+    this.text = this.mergeTexts(texts);
+  }
+}
+
+module.exports =  { ErrorClustersExtension }

package/src/extensions/index.js

@@ -12,6 +12,7 @@ const { CustomExtension } = require('./custom.extension');
 const { EXTENSION } = require('../helpers/constants');
 const { checkCondition } = require('../helpers/helper');
 const logger = require('../utils/logger');
+const { ErrorClustersExtension } = require('./error-clusters.extension');
 
 async function run(options) {
   const { target, result, hook } = options;
@@ -60,6 +61,8 @@ function getExtensionRunner(extension, options) {
       return new AIFailureSummaryExtension(options.target, extension, options.result, options.payload, options.root_payload);
     case EXTENSION.SMART_ANALYSIS:
       return new SmartAnalysisExtension(options.target, extension, options.result, options.payload, options.root_payload);
+    case EXTENSION.ERROR_CLUSTERS:
+      return new ErrorClustersExtension(options.target, extension, options.result, options.payload, options.root_payload);
     default:
       return require(extension.name);
   }

package/src/extensions/smart-analysis.extension.js

@@ -1,5 +1,6 @@
 const { BaseExtension } = require('./base.extension');
 const { STATUS, HOOK } = require("../helpers/constants");
+const logger = require('../utils/logger');
 
 class SmartAnalysisExtension extends BaseExtension {
 
@@ -21,7 +22,7 @@ class SmartAnalysisExtension extends BaseExtension {
   }
 
   #setDefaultInputs() {
-    this.default_inputs.title = 'Smart Analysis';
+    this.default_inputs.title = '';
     this.default_inputs.title_link = '';
   }
 
@@ -37,6 +38,11 @@ class SmartAnalysisExtension extends BaseExtension {
      */
     const execution_metrics = data.execution_metrics[0];
 
+    if (!execution_metrics) {
+      logger.warn('⚠️ No execution metrics found. Skipping.');
+      return;
+    }
+
     const smart_analysis = [];
     if (execution_metrics.newly_failed) {
       smart_analysis.push(`⭕ Newly Failed: ${execution_metrics.newly_failed}`);
@@ -54,7 +60,21 @@ class SmartAnalysisExtension extends BaseExtension {
       smart_analysis.push(`🟢 Recovered: ${execution_metrics.recovered}`);
     }
 
-    this.text = smart_analysis.join(' ｜ ');
+    const texts = [];
+    const rows = [];
+    for (const item of smart_analysis) {
+      rows.push(item);
+      if (rows.length === 3) {
+        texts.push(rows.join(' ｜ '));
+        rows.length = 0;
+      }
+    }
+
+    if (rows.length > 0) {
+      texts.push(rows.join(' ｜ '));
+    }
+
+    this.text = this.mergeTexts(texts);
   }
 
 }

package/src/helpers/constants.js

@@ -22,6 +22,7 @@ const TARGET = Object.freeze({
 const EXTENSION = Object.freeze({
   AI_FAILURE_SUMMARY: 'ai-failure-summary',
   SMART_ANALYSIS: 'smart-analysis',
+  ERROR_CLUSTERS: 'error-clusters',
   HYPERLINKS: 'hyperlinks',
   MENTIONS: 'mentions',
   REPORT_PORTAL_ANALYSIS: 'report-portal-analysis',

package/src/index.d.ts

@@ -230,6 +230,7 @@ export interface PublishReport {
   run?: string;
   show_failure_summary?: boolean;
   show_smart_analysis?: boolean;
+  show_error_clusters?: boolean;
   targets?: Target[];
   extensions?: Extension[];
   results?: ParseOptions[] | PerformanceParseOptions[] | CustomResultOptions[];

package/src/targets/chat.js

@@ -223,7 +223,7 @@ const default_inputs = {
   publish: 'test-summary',
   include_suites: true,
   max_suites: 10,
-  only_failures: false,
+  only_failures: true,
   include_failure_details: false,
   duration: '',
   metrics: [
@@ -238,7 +238,31 @@ const default_inputs = {
   ]
 };
 
+async function handleErrors({ target, errors }) {
+  let title = 'Error: Reporting Test Results';
+  title = target.inputs.title ? title + ' - ' + target.inputs.title : title;
+
+  const root_payload = getRootPayload();
+  const payload = root_payload.cards[0];
+
+  payload.sections.push({
+    "widgets": [
+      {
+        "textParagraph": {
+          text: `<b>${title}</b><br><br><b>Errors</b>: <br>${errors.join('<br>')}`
+        }
+      }
+    ]
+  });
+
+  return request.post({
+    url: target.inputs.url,
+    body: root_payload
+  });
+}
+
 module.exports = {
   run,
+  handleErrors,
   default_options
 }

package/src/targets/index.js

@@ -34,6 +34,14 @@ async function run(target, result) {
   }
 }
 
+async function handleErrors({ target, errors }) {
+  const target_runner = getTargetRunner(target);
+  if (target_runner.handleErrors) {
+    await target_runner.handleErrors({ target, errors });
+  }
+}
+
 module.exports = {
-  run
+  run,
+  handleErrors
 }

package/src/targets/slack.js

@@ -249,7 +249,7 @@ const default_inputs = {
   publish: 'test-summary',
   include_suites: true,
   max_suites: 10,
-  only_failures: false,
+  only_failures: true,
   include_failure_details: false,
   duration: '',
   metrics: [
@@ -264,7 +264,45 @@ const default_inputs = {
   ]
 }
 
+async function handleErrors({ target, errors }) {
+  let title = 'Error: Reporting Test Results';
+  title = target.inputs.title ? title + ' - ' + target.inputs.title : title;
+
+  const blocks = [];
+
+  blocks.push({
+    "type": "section",
+    "text": {
+      "type": "mrkdwn",
+      "text": title
+    }
+  });
+  blocks.push({
+    "type": "section",
+    "text": {
+      "type": "mrkdwn",
+      "text": errors.join('\n\n')
+    }
+  });
+
+  const payload = {
+    "attachments": [
+      {
+        "color": COLORS.DANGER,
+        "blocks": blocks,
+        "fallback": title,
+      }
+    ]
+  };
+
+  return request.post({
+    url: target.inputs.url,
+    body: payload
+  });
+}
+
 module.exports = {
   run,
+  handleErrors,
   default_options
 }

package/src/targets/teams.js

@@ -284,7 +284,7 @@ const default_inputs = {
   publish: 'test-summary',
   include_suites: true,
   max_suites: 10,
-  only_failures: false,
+  only_failures: true,
   include_failure_details: false,
   width: '',
   duration: '',
@@ -300,7 +300,40 @@ const default_inputs = {
   ]
 }
 
+async function handleErrors({ target, errors }) {
+  let title = 'Error: Reporting Test Results';
+  title = target.inputs.title ? title + ' - ' + target.inputs.title : title;
+
+  const root_payload = getRootPayload();
+  const payload = getMainPayload(target);
+
+  payload.body.push({
+    "type": "TextBlock",
+    "text": title,
+    "size": "medium",
+    "weight": "bolder",
+    "wrap": true
+  });
+
+  payload.body.push({
+    "type": "TextBlock",
+    "text": errors.join('\n'),
+    "size": "medium",
+    "weight": "bolder",
+    "wrap": true
+  });
+
+  setRootPayload(root_payload, payload);
+
+
+  return request.post({
+    url: target.inputs.url,
+    body: root_payload
+  });
+}
+
 module.exports = {
   run,
+  handleErrors,
   default_options
 }