testbeats 2.0.9 → 2.1.1

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.9",
+  "version": "2.1.1",
   "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.4"
   },
   "devDependencies": {
     "c8": "^7.12.0",

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

@@ -33,11 +33,9 @@ class ErrorClustersExtension extends BaseExtension {
 
     const clusters = data;
 
-    this.extension.inputs.title = `Top ${clusters.length} Errors`;
-
     const texts = [];
     for (const cluster of clusters) {
-      texts.push(`${this.bold(`(${cluster.count})`)} - ${cluster.failure}`);
+      texts.push(`${cluster.failure} - ${this.bold(`(x${cluster.count})`)}`);
     }
     this.text = this.mergeTexts(texts);
   }

package/src/platforms/base.platform.js

@@ -0,0 +1,118 @@
+const { getPercentage, getPrettyDuration } = require('../helpers/helper')
+
+class BasePlatform {
+
+  /**
+   * @param {string|number} text
+   */
+  bold(text) {
+    throw new Error('Not Implemented');
+  }
+
+  break() {
+    throw new Error('Not Implemented');
+  }
+
+  /**
+   *
+   * @param {import('..').Target} target
+   * @param {import('test-results-parser').ITestSuite} suite
+   */
+  getSuiteSummaryText(target, suite) {
+    const suite_title = this.getSuiteTitle(suite);
+    const suite_results_text = this.#getSuiteResultsText(suite);
+    const duration_text = this.#getSuiteDurationText(target, suite);
+
+    const texts = [
+      this.bold(suite_title),
+      this.break(),
+      this.break(),
+      suite_results_text,
+      this.break(),
+      duration_text,
+    ];
+
+    const metadata_text = this.getSuiteMetaDataText(suite);
+
+    if (metadata_text) {
+      texts.push(this.break());
+      texts.push(this.break());
+      texts.push(metadata_text);
+    }
+
+    return texts.join('');
+  }
+
+  /**
+   *
+   * @param {import('test-results-parser').ITestSuite} suite
+   * @returns {string}
+   */
+  getSuiteTitle(suite) {
+    const emoji = suite.status === 'PASS' ? '✅' : suite.total === suite.skipped ? '⏭️' : '❌';
+    return `${emoji} ${suite.name}`;
+  }
+
+  /**
+   *
+   * @param {import('test-results-parser').ITestSuite} suite
+   * @returns {string}
+   */
+  #getSuiteResultsText(suite) {
+    const suite_results = this.getSuiteResults(suite);
+    return `${this.bold('Results')}: ${suite_results}`;
+  }
+
+  /**
+   *
+   * @param {import('test-results-parser').ITestSuite} suite
+   * @returns {string}
+   */
+  getSuiteResults(suite) {
+    return `${suite.passed} / ${suite.total} Passed (${getPercentage(suite.passed, suite.total)}%)`;
+  }
+
+  /**
+   *
+   * @param {import('..').Target} target
+   * @param {import('test-results-parser').ITestSuite} suite
+   */
+  #getSuiteDurationText(target, suite) {
+    const duration = this.getSuiteDuration(target, suite);
+    return `${this.bold('Duration')}: ${duration}`
+  }
+
+  /**
+   *
+   * @param {import('..').Target} target
+   * @param {import('test-results-parser').ITestSuite} suite
+   */
+  getSuiteDuration(target, suite) {
+    return getPrettyDuration(suite.duration, target.inputs.duration);
+  }
+
+  /**
+   *
+   * @param {import('test-results-parser').ITestSuite} suite
+   * @returns {string}
+   */
+  getSuiteMetaDataText(suite) {
+    if (!suite || !suite.metadata) {
+      return;
+    }
+
+    const texts = [];
+
+    if (suite.metadata.platform && suite.metadata.platform.name && suite.metadata.platform.version) {
+      texts.push(`${suite.metadata.platform.name} ${suite.metadata.platform.version}`)
+    }
+
+    if (suite.metadata.browser && suite.metadata.browser.name && suite.metadata.browser.version) {
+      texts.push(`${suite.metadata.browser.name} ${suite.metadata.browser.version}`)
+    }
+
+    return texts.join(' • ');
+  }
+}
+
+module.exports = { BasePlatform }

package/src/platforms/chat.platform.js

@@ -0,0 +1,18 @@
+const { BasePlatform } = require("./base.platform");
+
+class ChatPlatform extends BasePlatform {
+
+  /**
+   * @param {string|number} text
+   */
+  bold(text) {
+    return `<b>${text}</b>`;
+  }
+
+  break() {
+    return '<br>';
+  }
+
+}
+
+module.exports = { ChatPlatform }

package/src/platforms/index.js

@@ -0,0 +1,25 @@
+const { TARGET } = require("../helpers/constants");
+const { SlackPlatform } = require('./slack.platform');
+const { TeamsPlatform } = require('./teams.platform');
+const { ChatPlatform } = require('./chat.platform');
+
+/**
+ *
+ * @param {string} name
+ */
+function getPlatform(name) {
+  switch (name) {
+    case TARGET.SLACK:
+      return new SlackPlatform();
+    case TARGET.TEAMS:
+      return new TeamsPlatform();
+    case TARGET.CHAT:
+      return new ChatPlatform();
+    default:
+      throw new Error('Invalid Platform');
+  }
+}
+
+module.exports = {
+  getPlatform
+}

package/src/platforms/slack.platform.js

@@ -0,0 +1,17 @@
+const { BasePlatform } = require("./base.platform");
+
+class SlackPlatform extends BasePlatform {
+
+  /**
+   * @param {string|number} text
+   */
+  bold(text) {
+    return `*${text}*`;
+  }
+
+  break() {
+    return '\n';
+  }
+}
+
+module.exports = { SlackPlatform }

package/src/platforms/teams.platform.js

@@ -0,0 +1,16 @@
+const { BasePlatform } = require("./base.platform");
+
+class TeamsPlatform extends BasePlatform {
+  /**
+   * @param {string|number} text
+   */
+  bold(text) {
+    return `**${text}**`;
+  }
+
+  break() {
+    return '\n\n';
+  }
+}
+
+module.exports = { TeamsPlatform }

package/src/targets/chat.js

@@ -1,10 +1,11 @@
 const request = require('phin-retry');
 const { getTitleText, getResultText, truncate, getPrettyDuration } = require('../helpers/helper');
 const extension_manager = require('../extensions');
-const { HOOK, STATUS } = require('../helpers/constants');
+const { HOOK, STATUS, TARGET } = require('../helpers/constants');
 const PerformanceTestResult = require('performance-results-parser/src/models/PerformanceTestResult');
 const { getValidMetrics, getMetricValuesText } = require('../helpers/performance');
 const logger = require('../utils/logger');
+const { getPlatform } = require('../platforms');
 
 async function run({ result, target }) {
   setTargetInputs(target);
@@ -100,11 +101,9 @@ function setSuiteBlock({ result, target, payload }) {
 }
 
 function getSuiteSummary({ target, suite }) {
-  const emoji = suite.status === 'PASS' ? '✅' : '❌';
-  const suite_title = `${emoji} ${suite.name}`;
-  const result_text = getResultText({ result: suite });
-  const duration_text = getPrettyDuration(suite.duration, target.inputs.duration);
-  return `<b>${suite_title}</b><br><br><b>Results</b>: ${result_text}<br><b>Duration</b>: ${duration_text}`;
+  const platform = getPlatform(TARGET.CHAT);
+  const text = platform.getSuiteSummaryText(target, suite);
+  return text;
 }
 
 function getFailureDetails(suite) {
@@ -223,7 +222,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: [

package/src/targets/slack.js

@@ -1,12 +1,13 @@
 const request = require('phin-retry');
 const { getPercentage, truncate, getPrettyDuration } = require('../helpers/helper');
 const extension_manager = require('../extensions');
-const { HOOK, STATUS } = require('../helpers/constants');
+const { HOOK, STATUS, TARGET } = require('../helpers/constants');
 const logger = require('../utils/logger');
 
 const PerformanceTestResult = require('performance-results-parser/src/models/PerformanceTestResult');
 const { getValidMetrics, getMetricValuesText } = require('../helpers/performance');
 const TestResult = require('test-results-parser/src/models/TestResult');
+const { getPlatform } = require('../platforms');
 
 
 
@@ -109,9 +110,8 @@ function setSuiteBlock({ result, target, payload }) {
 }
 
 function getSuiteSummary({ target, suite }) {
-  let text = `*${getSuiteTitle(suite)}*\n`;
-  text += `\n*Results*: ${getResultText(suite)}`;
-  text += `\n*Duration*: ${getPrettyDuration(suite.duration, target.inputs.duration)}`;
+  const platform = getPlatform(TARGET.SLACK);
+  const text = platform.getSuiteSummaryText(target, suite);
   return {
     "type": "section",
     "text": {
@@ -121,11 +121,6 @@ function getSuiteSummary({ target, suite }) {
   };
 }
 
-function getSuiteTitle(suite) {
-  const emoji = suite.status === 'PASS' ? '✅' : suite.total === suite.skipped ? '⏭️' : '❌';
-  return `${emoji} ${suite.name}`;
-}
-
 function getFailureDetails(suite) {
   let text = '';
   const cases = suite.cases;
@@ -249,7 +244,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: [

package/src/targets/teams.js

@@ -2,11 +2,12 @@ const request = require('phin-retry');
 const { getPercentage, truncate, getPrettyDuration } = require('../helpers/helper');
 const { getValidMetrics, getMetricValuesText } = require('../helpers/performance');
 const extension_manager = require('../extensions');
-const { HOOK, STATUS } = require('../helpers/constants');
+const { HOOK, STATUS, TARGET } = require('../helpers/constants');
 const logger = require('../utils/logger');
 
 const TestResult = require('test-results-parser/src/models/TestResult');
 const PerformanceTestResult = require('performance-results-parser/src/models/PerformanceTestResult');
+const { getPlatform } = require('../platforms');
 
 /**
  * @param {object} param0
@@ -144,12 +145,16 @@ function setSuiteBlock({ result, target, payload }) {
 }
 
 function getSuiteSummary({ suite, target }) {
-  const percentage = getPercentage(suite.passed, suite.total);
-  const emoji = suite.status === 'PASS' ? '✅' : '❌';
-  return [
+
+  const platform = getPlatform(TARGET.TEAMS);
+  const suite_title = platform.getSuiteTitle(suite);
+  const suite_results = platform.getSuiteResults(suite);
+  const duration = platform.getSuiteDuration(target, suite);
+
+  const blocks = [
     {
       "type": "TextBlock",
-      "text": `${emoji} ${suite.name}`,
+      "text": suite_title,
       "isSubtle": true,
       "weight": "bolder",
       "wrap": true
@@ -159,15 +164,26 @@ function getSuiteSummary({ suite, target }) {
       "facts": [
         {
           "title": "Results:",
-          "value": `${suite.passed} / ${suite.total} Passed (${percentage}%)`
+          "value": suite_results
         },
         {
           "title": "Duration:",
-          "value": `${getPrettyDuration(suite.duration, target.inputs.duration)}`
+          "value": duration
         }
       ]
     }
-  ]
+  ];
+
+  const suite_metadata_text = platform.getSuiteMetaDataText(suite);
+  if (suite_metadata_text) {
+    blocks.push({
+      "type": "TextBlock",
+      "text": suite_metadata_text,
+      "wrap": true
+    });
+  }
+
+  return blocks;
 }
 
 function getFailureDetailsFactSets(suite) {
@@ -284,7 +300,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: '',