testbeats 2.0.7 → 2.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testbeats",
-  "version": "2.0.7",
+  "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/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
@@ -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',
@@ -23,6 +25,7 @@ async function run({ result, target }) {
     await setFunctionalPayload({ result, target, payload });
   }
   const message = getRootPayload({ result, target, payload });
+  logger.info(`🔔 Publishing results to Slack...`);
   return request.post({
     url: target.inputs.url,
     body: message
@@ -142,10 +145,10 @@ function getFailureDetails(suite) {
 }
 
 /**
- * 
- * @param {object} param0 
- * @param {PerformanceTestResult | TestResult} param0.result 
- * @returns 
+ *
+ * @param {object} param0
+ * @param {PerformanceTestResult | TestResult} param0.result
+ * @returns
  */
 function getRootPayload({ result, target, payload }) {
   let color = COLORS.GOOD;
@@ -182,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`;
@@ -206,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
@@ -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) {