testbeats 2.0.6 → 2.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testbeats",
-  "version": "2.0.6",
+  "version": "2.0.8",
   "description": "Publish test results to Microsoft Teams, Google Chat, Slack and InfluxDB",
   "main": "src/index.js",
   "types": "./src/index.d.ts",

package/src/beats/beats.js

@@ -20,10 +20,14 @@ class Beats {
   }
 
   async publish() {
+    this.#setApiKey();
+    if (!this.config.api_key) {
+      logger.warn('😿 No API key provided, skipping publishing results to TestBeats Portal...');
+      return;
+    }
     this.#setCIInfo();
     this.#setProjectName();
     this.#setRunName();
-    this.#setApiKey();
     await this.#publishTestResults();
     await this.#uploadAttachments();
     this.#updateTitleLink();
@@ -45,13 +49,10 @@ class Beats {
 
   #setRunName() {
     this.config.run = this.config.run || process.env.TEST_BEATS_RUN || (this.ci && this.ci.build_name) || 'demo-run';
+    this.result.name = this.config.run;
   }
 
   async #publishTestResults() {
-    if (!this.config.api_key) {
-      logger.warn('😿 No API key provided, skipping publishing results to TestBeats Portal...');
-      return;
-    }
     logger.info("🚀 Publishing results to TestBeats Portal...");
     try {
       const payload = this.#getPayload();
@@ -89,18 +90,6 @@ class Beats {
     }
   }
 
-  #getAllFailedTestCases() {
-    const test_cases = [];
-    for (const suite of this.result.suites) {
-      for (const test of suite.cases) {
-        if (test.status === 'FAIL') {
-          test_cases.push(test);
-        }
-      }
-    }
-    return test_cases;
-  }
-
   #updateTitleLink() {
     if (!this.test_run_id) {
       return;

package/src/extensions/ci-info.extension.js

@@ -3,6 +3,8 @@ const { getCIInformation } = require('../helpers/ci');
 const { getMetaDataText } = require("../helpers/metadata.helper");
 const { STATUS, HOOK } = require("../helpers/constants");
 
+const COMMON_BRANCH_NAMES = ['main', 'master', 'dev', 'develop', 'qa', 'test'];
+
 class CIInfoExtension extends BaseExtension {
 
   constructor(target, extension, result, payload, root_payload) {
@@ -17,23 +19,24 @@ class CIInfoExtension extends BaseExtension {
   }
 
   #setDefaultOptions() {
-    this.default_options.hook = HOOK.AFTER_SUMMARY,
+    this.default_options.hook = HOOK.AFTER_SUMMARY;
     this.default_options.condition = STATUS.PASS_OR_FAIL;
   }
 
   #setDefaultInputs() {
     this.default_inputs.title = '';
     this.default_inputs.title_link = '';
-    this.default_inputs.show_repository = true;
-    this.default_inputs.show_repository_branch = true;
+    this.default_inputs.show_repository_non_common = true;
+    this.default_inputs.show_repository = false;
+    this.default_inputs.show_repository_branch = false;
     this.default_inputs.show_build = true;
   }
 
   async run() {
     this.ci = getCIInformation();
 
-    this.setRepositoryElements();
-    this.setBuildElements();
+    this.#setRepositoryElements();
+    this.#setBuildElements();
 
     const repository_text = await getMetaDataText({ elements: this.repository_elements, target: this.target, extension: this.extension, result: this.result, default_condition: this.default_options.condition });
     const build_text = await getMetaDataText({ elements: this.build_elements, target: this.target, extension: this.extension, result: this.result, default_condition: this.default_options.condition });
@@ -41,28 +44,55 @@ class CIInfoExtension extends BaseExtension {
     this.attach();
   }
 
-  setRepositoryElements() {
+  #setRepositoryElements() {
     if (!this.ci) {
       return;
     }
+    if (!this.ci.repository_url || !this.ci.repository_name || !this.ci.repository_ref) {
+      return;
+    }
 
-    if (this.extension.inputs.show_repository && this.ci.repository_url && this.ci.repository_name) {
-      this.repository_elements.push({ label: 'Repository', key: this.ci.repository_name, value: this.ci.repository_url, type: 'hyperlink' });
+    if (this.extension.inputs.show_repository) {
+      this.#setRepositoryElement();
+    }
+    if (this.extension.inputs.show_repository_branch) {
+      if (this.ci.repository_ref.includes('refs/pull')) {
+        this.#setPullRequestElement();
+      } else {
+        this.#setRepositoryBranchElement();
+      }
     }
-    if (this.extension.inputs.show_repository_branch && this.ci.repository_ref) {
+    if (!this.extension.inputs.show_repository && !this.extension.inputs.show_repository_branch && this.extension.inputs.show_repository_non_common) {
       if (this.ci.repository_ref.includes('refs/pull')) {
-        const pr_url = this.ci.repository_url + this.ci.repository_ref.replace('refs/pull/', '/pull/');
-        const pr_name = this.ci.repository_ref.replace('refs/pull/', '').replace('/merge', '');
-        this.repository_elements.push({ label: 'Pull Request', key: pr_name, value: pr_url, type: 'hyperlink' });
+        this.#setRepositoryElement();
+        this.#setPullRequestElement();
       } else {
-        const branch_url = this.ci.repository_url + this.ci.repository_ref.replace('refs/heads/', '/tree/');
         const branch_name = this.ci.repository_ref.replace('refs/heads/', '');
-        this.repository_elements.push({ label: 'Branch', key: branch_name, value: branch_url, type: 'hyperlink' });
+        if (!COMMON_BRANCH_NAMES.includes(branch_name.toLowerCase())) {
+          this.#setRepositoryElement();
+          this.#setRepositoryBranchElement();
+        }
       }
     }
   }
 
-  setBuildElements() {
+  #setRepositoryElement() {
+    this.repository_elements.push({ label: 'Repository', key: this.ci.repository_name, value: this.ci.repository_url, type: 'hyperlink' });
+  }
+
+  #setPullRequestElement() {
+    const pr_url = this.ci.repository_url + this.ci.repository_ref.replace('refs/pull/', '/pull/');
+    const pr_name = this.ci.repository_ref.replace('refs/pull/', '').replace('/merge', '');
+    this.repository_elements.push({ label: 'Pull Request', key: pr_name, value: pr_url, type: 'hyperlink' });
+  }
+
+  #setRepositoryBranchElement() {
+    const branch_url = this.ci.repository_url + this.ci.repository_ref.replace('refs/heads/', '/tree/');
+    const branch_name = this.ci.repository_ref.replace('refs/heads/', '');
+    this.repository_elements.push({ label: 'Branch', key: branch_name, value: branch_url, type: 'hyperlink' });
+  }
+
+  #setBuildElements() {
     if (!this.ci) {
       return;
     }

package/src/extensions/custom.extension.js

@@ -0,0 +1,47 @@
+const path = require('path');
+const { BaseExtension } = require("./base.extension");
+const { STATUS, HOOK } = require("../helpers/constants");
+
+class CustomExtension extends BaseExtension {
+
+  /**
+   * @param {import('..').CustomExtension} extension
+   */
+  constructor(target, extension, result, payload, root_payload) {
+    super(target, extension, result, payload, root_payload);
+    this.extension = extension;
+    this.#setDefaultOptions();
+    this.updateExtensionInputs();
+  }
+
+  #setDefaultOptions() {
+    this.default_options.hook = HOOK.END,
+    this.default_options.condition = STATUS.PASS_OR_FAIL;
+  }
+
+  async run() {
+    const params = this.#getParams();
+    if (typeof this.extension.inputs.load === 'string') {
+      const cwd = process.cwd();
+      const extension_runner = require(path.join(cwd, this.extension.inputs.load));
+      await extension_runner.run(params);
+    } else if (typeof this.extension.inputs.load === 'function') {
+      await this.extension.inputs.load(params);
+    } else {
+      throw `Invalid 'load' input in custom extension - ${this.extension.inputs.load}`;
+    }
+  }
+
+  #getParams() {
+    return {
+      target: this.target,
+      extension: this.extension,
+      payload: this.payload,
+      root_payload: this.root_payload,
+      result: this.result
+    }
+  }
+
+}
+
+module.exports = { CustomExtension }

package/src/extensions/index.js

@@ -4,11 +4,11 @@ const rp_analysis = require('./report-portal-analysis');
 const rp_history = require('./report-portal-history');
 const qc_test_summary = require('./quick-chart-test-summary');
 const percy_analysis = require('./percy-analysis');
-const custom = require('./custom');
 const metadata = require('./metadata');
 const { AIFailureSummaryExtension } = require('./ai-failure-summary.extension');
 const { SmartAnalysisExtension } = require('./smart-analysis.extension');
 const { CIInfoExtension } = require('./ci-info.extension');
+const { CustomExtension } = require('./custom.extension');
 const { EXTENSION } = require('../helpers/constants');
 const { checkCondition } = require('../helpers/helper');
 const logger = require('../utils/logger');
@@ -51,7 +51,7 @@ function getExtensionRunner(extension, options) {
     case EXTENSION.PERCY_ANALYSIS:
       return percy_analysis;
     case EXTENSION.CUSTOM:
-      return custom;
+      return new CustomExtension(options.target, extension, options.result, options.payload, options.root_payload);
     case EXTENSION.METADATA:
       return metadata;
     case EXTENSION.CI_INFO:

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

@@ -39,19 +39,19 @@ class SmartAnalysisExtension extends BaseExtension {
 
     const smart_analysis = [];
     if (execution_metrics.newly_failed) {
-      smart_analysis.push(`⭕ NF: ${execution_metrics.newly_failed}`);
+      smart_analysis.push(`⭕ Newly Failed: ${execution_metrics.newly_failed}`);
     }
     if (execution_metrics.always_failing) {
-      smart_analysis.push(`🔴 AF: ${execution_metrics.always_failing}`);
+      smart_analysis.push(`🔴 Always Failing: ${execution_metrics.always_failing}`);
     }
-    if (execution_metrics.recurring_failures) {
-      smart_analysis.push(`🟠 RF: ${execution_metrics.recurring_failures}`);
+    if (execution_metrics.recurring_errors) {
+      smart_analysis.push(`🟠 Recurring Errors: ${execution_metrics.recurring_errors}`);
     }
     if (execution_metrics.flaky) {
-      smart_analysis.push(`🟡 FL: ${execution_metrics.flaky}`);
+      smart_analysis.push(`🟡 Flaky: ${execution_metrics.flaky}`);
     }
     if (execution_metrics.recovered) {
-      smart_analysis.push(`🟢 RC: ${execution_metrics.recovered}`);
+      smart_analysis.push(`🟢 Recovered: ${execution_metrics.recovered}`);
     }
 
     this.text = smart_analysis.join(' ｜ ');

package/src/helpers/ci.js

@@ -7,6 +7,9 @@ function getCIInformation() {
   if (ENV.GITHUB_ACTIONS) {
     return getGitHubActionsInformation();
   }
+  if (ENV.GITLAB_CI) {
+    return getGitLabInformation();
+  }
   if (ENV.JENKINS_URL) {
     return getJenkinsInformation();
   }
@@ -26,6 +29,7 @@ function getGitHubActionsInformation() {
     build_url: ENV.GITHUB_SERVER_URL + '/' + ENV.GITHUB_REPOSITORY + '/actions/runs/' + ENV.GITHUB_RUN_ID,
     build_number: ENV.GITHUB_RUN_NUMBER,
     build_name: ENV.GITHUB_WORKFLOW,
+    build_reason: ENV.GITHUB_EVENT_NAME,
     user: ENV.GITHUB_ACTOR,
   }
 }
@@ -41,6 +45,7 @@ function getAzureDevOpsInformation() {
     build_url: ENV.SYSTEM_TEAMFOUNDATIONCOLLECTIONURI + ENV.SYSTEM_TEAMPROJECT + '/_build/results?buildId=' + ENV.BUILD_BUILDID,
     build_number: ENV.BUILD_BUILDNUMBER,
     build_name: ENV.BUILD_DEFINITIONNAME,
+    build_reason: ENV.BUILD_REASON,
     user: ENV.BUILD_REQUESTEDFOR
   }
 }
@@ -56,10 +61,27 @@ function getJenkinsInformation() {
     build_url: ENV.BUILD_URL,
     build_number: ENV.BUILD_NUMBER,
     build_name: ENV.JOB_NAME,
+    build_reason: ENV.BUILD_CAUSE,
     user: ENV.USER || ENV.USERNAME
   }
 }
 
+function getGitLabInformation() {
+  return {
+    ci: 'GITLAB',
+    git: 'GITLAB',
+    repository_url: ENV.CI_PROJECT_URL,
+    repository_name: ENV.CI_PROJECT_NAME,
+    repository_ref: ENV.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME || ENV.CI_COMMIT_REF_NAME,
+    repository_commit_sha:ENV.CI_MERGE_REQUEST_SOURCE_BRANCH_SHA || ENV.CI_COMMIT_SHA,
+    build_url: ENV.CI_JOB_URL,
+    build_number: ENV.CI_JOB_ID,
+    build_name: ENV.CI_JOB_NAME,
+    build_reason: ENV.CI_PIPELINE_SOURCE,
+    user: ENV.GITLAB_USER_LOGIN || ENV.CI_COMMIT_AUTHOR
+  }
+}
+
 module.exports = {
   getCIInformation
 }

package/src/index.d.ts

@@ -56,6 +56,7 @@ export interface MentionInputs extends ExtensionInputs {
 }
 
 export interface CIInfoInputs extends ExtensionInputs {
+  show_repository_non_common?: boolean;
   show_repository?: boolean;
   show_repository_branch?: boolean;
   show_build?: boolean;

package/src/targets/chat.js

@@ -4,6 +4,7 @@ const extension_manager = require('../extensions');
 const { HOOK, STATUS } = require('../helpers/constants');
 const PerformanceTestResult = require('performance-results-parser/src/models/PerformanceTestResult');
 const { getValidMetrics, getMetricValuesText } = require('../helpers/performance');
+const logger = require('../utils/logger');
 
 async function run({ result, target }) {
   setTargetInputs(target);
@@ -14,6 +15,7 @@ async function run({ result, target }) {
   } else {
     await setFunctionalPayload({ result, target, payload, root_payload });
   }
+  logger.info(`🔔 Publishing results to Chat...`);
   return request.post({
     url: target.inputs.url,
     body: root_payload
@@ -111,7 +113,7 @@ function getFailureDetails(suite) {
   for (let i = 0; i < cases.length; i++) {
     const test_case = cases[i];
     if (test_case.status === 'FAIL') {
-      text += `<b>Test</b>: ${test_case.name}<br><b>Error</b>: ${truncate(test_case.failure, 150)}<br><br>`;
+      text += `<b>Test</b>: ${test_case.name}<br><b>Error</b>: ${truncate(test_case.failure ?? 'N/A', 150)}<br><br>`;
     }
   }
   return text;
@@ -144,9 +146,9 @@ async function setPerformancePayload({ result, target, payload, root_payload })
 }
 
 /**
- * 
+ *
  * @param {object} param0
- * @param {PerformanceTestResult} param0.result 
+ * @param {PerformanceTestResult} param0.result
  */
 async function setPerformanceMainBlock({ result, target, payload }) {
   const title_text_with_emoji = getTitleTextWithEmoji({ result, target });
@@ -169,9 +171,9 @@ async function setPerformanceMainBlock({ result, target, payload }) {
 }
 
 /**
- * 
+ *
  * @param {object} param0
- * @param {PerformanceTestResult} param0.result 
+ * @param {PerformanceTestResult} param0.result
  */
 async function setTransactionBlock({ result, target, payload }) {
   if (target.inputs.include_suites) {

package/src/targets/slack.js

@@ -2,12 +2,14 @@ const request = require('phin-retry');
 const { getPercentage, truncate, getPrettyDuration } = require('../helpers/helper');
 const extension_manager = require('../extensions');
 const { HOOK, STATUS } = 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 COLORS = {
   GOOD: '#36A64F',
   WARNING: '#ECB22E',
@@ -22,7 +24,8 @@ async function run({ result, target }) {
   } else {
     await setFunctionalPayload({ result, target, payload });
   }
-  const message = getRootPayload({ result, payload });
+  const message = getRootPayload({ result, target, payload });
+  logger.info(`🔔 Publishing results to Slack...`);
   return request.post({
     url: target.inputs.url,
     body: message
@@ -66,12 +69,12 @@ function setMainBlock({ result, target, payload }) {
   });
 }
 
-function getTitleText(result, target) {
+function getTitleText(result, target, {allowTitleLink = true} = {}) {
   let text = target.inputs.title ? target.inputs.title : result.name;
   if (target.inputs.title_suffix) {
     text = `${text} ${target.inputs.title_suffix}`;
   }
-  if (target.inputs.title_link) {
+  if (allowTitleLink && target.inputs.title_link) {
     text = `<${target.inputs.title_link}|${text}>`;
   }
   return text;
@@ -129,7 +132,7 @@ function getFailureDetails(suite) {
   for (let i = 0; i < cases.length; i++) {
     const test_case = cases[i];
     if (test_case.status === 'FAIL') {
-      text += `*Test*: ${test_case.name}\n*Error*: ${truncate(test_case.failure, 150)}\n\n`;
+      text += `*Test*: ${test_case.name}\n*Error*: ${truncate(test_case.failure ?? 'N/A', 150)}\n\n`;
     }
   }
   return {
@@ -142,12 +145,12 @@ function getFailureDetails(suite) {
 }
 
 /**
- * 
- * @param {object} param0 
- * @param {PerformanceTestResult | TestResult} param0.result 
- * @returns 
+ *
+ * @param {object} param0
+ * @param {PerformanceTestResult | TestResult} param0.result
+ * @returns
  */
-function getRootPayload({ result, payload }) {
+function getRootPayload({ result, target, payload }) {
   let color = COLORS.GOOD;
   if (result.status !== 'PASS') {
     let somePassed = true;
@@ -166,7 +169,8 @@ function getRootPayload({ result, payload }) {
     "attachments": [
       {
         "color": color,
-        "blocks": payload.blocks
+        "blocks": payload.blocks,
+        "fallback": `${getTitleText(result, target, {allowTitleLink: false})}\nResults: ${getResultText(result)}`,
       }
     ]
   };
@@ -181,9 +185,9 @@ async function setPerformancePayload({ result, target, payload }) {
 }
 
 /**
- * 
- * @param {object} param0 
- * @param {PerformanceTestResult} param0.result 
+ *
+ * @param {object} param0
+ * @param {PerformanceTestResult} param0.result
  */
 async function setPerformanceMainBlock({ result, target, payload }) {
   let text = `*${getTitleText(result, target)}*\n`;
@@ -205,9 +209,9 @@ async function setPerformanceMainBlock({ result, target, payload }) {
 }
 
 /**
- * 
- * @param {object} param0 
- * @param {PerformanceTestResult} param0.result 
+ *
+ * @param {object} param0
+ * @param {PerformanceTestResult} param0.result
  */
 async function setTransactionBlock({ result, target, payload }) {
   if (target.inputs.include_suites) {

package/src/targets/teams.js

@@ -3,14 +3,15 @@ const { getPercentage, truncate, getPrettyDuration } = require('../helpers/helpe
 const { getValidMetrics, getMetricValuesText } = require('../helpers/performance');
 const extension_manager = require('../extensions');
 const { HOOK, STATUS } = 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');
 
 /**
- * @param {object} param0 
- * @param {PerformanceTestResult | TestResult} param0.result 
- * @returns 
+ * @param {object} param0
+ * @param {PerformanceTestResult | TestResult} param0.result
+ * @returns
  */
 async function run({ result, target }) {
   setTargetInputs(target);
@@ -22,6 +23,7 @@ async function run({ result, target }) {
     await setFunctionalPayload({ result, target, payload, root_payload });
   }
   setRootPayload(root_payload, payload);
+  logger.info(`🔔 Publishing results to Teams...`);
   return request.post({
     url: target.inputs.url,
     body: root_payload
@@ -183,7 +185,7 @@ function getFailureDetailsFactSets(suite) {
           },
           {
             "title": "Error:",
-            "value": truncate(test_case.failure, 150)
+            "value": truncate(test_case.failure ?? 'N/A', 150)
           }
         ]
       });
@@ -209,8 +211,8 @@ function setRootPayload(root_payload, payload) {
 }
 
 /**
- * @param {object} param0 
- * @param {PerformanceTestResult} param0.result 
+ * @param {object} param0
+ * @param {PerformanceTestResult} param0.result
  */
 async function setMainBlockForPerformance({ result, target, payload }) {
   const total = result.transactions.length;
@@ -245,8 +247,8 @@ async function getFactMetrics({ metrics, target, result }) {
 }
 
 /**
- * @param {object} param0 
- * @param {PerformanceTestResult} param0.result 
+ * @param {object} param0
+ * @param {PerformanceTestResult} param0.result
  */
 async function setTransactionBlock({ result, target, payload }) {
   if (target.inputs.include_suites) {

package/src/extensions/custom.js

@@ -1,29 +0,0 @@
-const path = require('path');
-const { HOOK, STATUS } = require('../helpers/constants');
-
-/**
- * 
- * @param {object} param0 
- * @param {import('../index').CustomExtension} param0.extension 
- */
-async function run({ target, extension, payload, root_payload, result }) {
-  if (typeof extension.inputs.load === 'string') {
-    const cwd = process.cwd();
-    const extension_runner = require(path.join(cwd, extension.inputs.load));
-    await extension_runner.run({ target, extension, payload, root_payload, result });
-  } else if (typeof extension.inputs.load === 'function') {
-    await extension.inputs.load({ target, extension, payload, root_payload, result });
-  } else {
-    throw `Invalid 'load' input in custom extension - ${extension.inputs.load}`;
-  }
-}
-
-const default_options = {
-  hook: HOOK.END,
-  condition: STATUS.PASS_OR_FAIL
-}
-
-module.exports = {
-  run,
-  default_options
-}