testbeats 2.0.5 → 2.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testbeats",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "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.types.d.ts

@@ -4,6 +4,7 @@ export type IBeatExecutionMetric = {
   updated_at: string
   newly_failed: number
   always_failing: number
+  recurring_failures: number
   recovered: number
   added: number
   removed: number

package/src/extensions/base.extension.js

@@ -50,7 +50,7 @@ class BaseExtension {
 
   attach() {
     if (!this.text) {
-      logger.warn(`⚠️ Extension '${this.extension.name}' has no text. Skipping.`);
+      logger.debug(`⚠️ Extension '${this.extension.name}' has no text. Skipping.`);
       return;
     }
 
@@ -69,6 +69,23 @@ class BaseExtension {
     }
   }
 
+  /**
+   * @param {string[]} texts
+   */
+  mergeTexts(texts) {
+    const _texts = texts.filter(text => !!text);
+    switch (this.target.name) {
+      case 'teams':
+        return _texts.join('\n\n');
+      case 'slack':
+        return _texts.join('\n');
+      case 'chat':
+        return _texts.join('<br>');
+      default:
+        break;
+    }
+  }
+
 }
 
 module.exports = { BaseExtension }

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

@@ -0,0 +1,81 @@
+const { BaseExtension } = require("./base.extension");
+const { getCIInformation } = require('../helpers/ci');
+const { getMetaDataText } = require("../helpers/metadata.helper");
+const { STATUS, HOOK } = require("../helpers/constants");
+
+class CIInfoExtension extends BaseExtension {
+
+  constructor(target, extension, result, payload, root_payload) {
+    super(target, extension, result, payload, root_payload);
+    this.#setDefaultOptions();
+    this.#setDefaultInputs();
+    this.updateExtensionInputs();
+
+    this.ci = null;
+    this.repository_elements = [];
+    this.build_elements = [];
+  }
+
+  #setDefaultOptions() {
+    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_build = true;
+  }
+
+  async run() {
+    this.ci = getCIInformation();
+
+    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 });
+    this.text = this.mergeTexts([repository_text, build_text]);
+    this.attach();
+  }
+
+  setRepositoryElements() {
+    if (!this.ci) {
+      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_branch && this.ci.repository_ref) {
+      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' });
+      } 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' });
+      }
+    }
+  }
+
+  setBuildElements() {
+    if (!this.ci) {
+      return;
+    }
+
+    if (this.extension.inputs.show_build && this.ci.build_url) {
+      const name = (this.ci.build_name || 'Build') + (this.ci.build_number ? ` #${this.ci.build_number}` : '');
+      this.build_elements.push({ label: 'Build', key: name, value: this.ci.build_url, type: 'hyperlink' });
+    }
+    if (this.extension.inputs.data) {
+      this.build_elements = this.build_elements.concat(this.extension.inputs.data);
+    }
+  }
+
+}
+
+module.exports = { CIInfoExtension };

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/extensions.d.ts

@@ -0,0 +1,12 @@
+export type ICIInfo = {
+  ci: string
+  git: string
+  repository_url: string
+  repository_name: string
+  repository_ref: string
+  repository_commit_sha: string
+  build_url: string
+  build_number: string
+  build_name: string
+  user: string
+}

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 ci_info = require('./ci-info');
 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,11 +51,11 @@ 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:
-      return ci_info;
+      return new CIInfoExtension(options.target, extension, options.result, options.payload, options.root_payload);
     case EXTENSION.AI_FAILURE_SUMMARY:
       return new AIFailureSummaryExtension(options.target, extension, options.result, options.payload, options.root_payload);
     case EXTENSION.SMART_ANALYSIS:

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

@@ -38,17 +38,20 @@ class SmartAnalysisExtension extends BaseExtension {
     const execution_metrics = data.execution_metrics[0];
 
     const smart_analysis = [];
+    if (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.newly_failed) {
-      smart_analysis.push(`⭕ NF: ${execution_metrics.newly_failed}`);
+    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

@@ -1,9 +1,15 @@
 const ENV = process.env;
 
+/**
+ * @returns {import('../extensions/extensions').ICIInfo}
+ */
 function getCIInformation() {
   if (ENV.GITHUB_ACTIONS) {
     return getGitHubActionsInformation();
   }
+  if (ENV.GITLAB_CI) {
+    return getGitLabInformation();
+  }
   if (ENV.JENKINS_URL) {
     return getJenkinsInformation();
   }
@@ -23,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,
   }
 }
@@ -38,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
   }
 }
@@ -53,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/helpers/metadata.helper.js

@@ -1,4 +1,17 @@
-const { checkCondition } = require('./helper')
+const { checkCondition } = require('./helper');
+
+function getMetaDataText(params) {
+  switch (params.target.name) {
+    case 'teams':
+      return getTeamsMetaDataText(params);
+    case 'slack':
+      return getSlackMetaDataText(params);
+    case 'chat':
+      return getChatMetaDataText(params);
+    default:
+      return '';
+  }
+}
 
 /**
  * Asynchronously generates metadata text for slack.
@@ -109,6 +122,7 @@ function get_url({ url, target, extension, result}) {
 }
 
 module.exports = {
+  getMetaDataText,
   getSlackMetaDataText,
   getTeamsMetaDataText,
   getChatMetaDataText

package/src/targets/chat.js

@@ -111,7 +111,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;

package/src/targets/slack.js

@@ -22,7 +22,7 @@ async function run({ result, target }) {
   } else {
     await setFunctionalPayload({ result, target, payload });
   }
-  const message = getRootPayload({ result, payload });
+  const message = getRootPayload({ result, target, payload });
   return request.post({
     url: target.inputs.url,
     body: message
@@ -66,12 +66,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 +129,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 {
@@ -147,7 +147,7 @@ function getFailureDetails(suite) {
  * @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 +166,8 @@ function getRootPayload({ result, payload }) {
     "attachments": [
       {
         "color": color,
-        "blocks": payload.blocks
+        "blocks": payload.blocks,
+        "fallback": `${getTitleText(result, target, {allowTitleLink: false})}\nResults: ${getResultText(result)}`,
       }
     ]
   };

package/src/targets/teams.js

@@ -183,7 +183,7 @@ function getFailureDetailsFactSets(suite) {
           },
           {
             "title": "Error:",
-            "value": truncate(test_case.failure, 150)
+            "value": truncate(test_case.failure ?? 'N/A', 150)
           }
         ]
       });

package/src/extensions/ci-info.js

@@ -1,134 +0,0 @@
-const { STATUS, HOOK } = require("../helpers/constants");
-const { getCIInformation } = require('../helpers/ci');
-const { addTeamsExtension, addSlackExtension, addChatExtension } = require('../helpers/extension.helper');
-const { getTeamsMetaDataText, getSlackMetaDataText, getChatMetaDataText } = require('../helpers/metadata.helper');
-
-/**
- * 
- * @param {object} param0 - the payload object
- * @param {import('..').Extension} param0.extension - The result object
- *  
- */
-async function run({ target, extension, payload, result }) {
-  extension.inputs = Object.assign({}, default_inputs, extension.inputs);
-  if (target.name === 'teams') {
-    extension.inputs = Object.assign({}, default_inputs_teams, extension.inputs);
-    const text = await get_text({ target, extension, result });
-    if (text) {
-      addTeamsExtension({ payload, extension, text });
-    }
-  } else if (target.name === 'slack') {
-    extension.inputs = Object.assign({}, default_inputs_slack, extension.inputs);
-    const text = await get_text({ target, extension, result });
-    if (text) {
-      addSlackExtension({ payload, extension, text });
-    }
-  } else if (target.name === 'chat') {
-    extension.inputs = Object.assign({}, default_inputs_chat, extension.inputs);
-    const text = await get_text({ target, extension, result });
-    if (text) {
-      addChatExtension({ payload, extension, text });
-    }
-  }
-}
-
-/**
- * 
- * @param {import('..').CIInfoInputs} inputs 
- */
-function get_repository_elements(inputs) {
-  const elements = [];
-  const ci = getCIInformation();
-  if (inputs.show_repository && ci && ci.repository_url && ci.repository_name) {
-    elements.push({ label: 'Repository', key: ci.repository_name, value: ci.repository_url, type: 'hyperlink' });
-  }
-  if (inputs.show_repository_branch && ci && ci.repository_ref) {
-    if (ci.repository_ref.includes('refs/pull')) {
-      const pr_url = ci.repository_url + ci.repository_ref.replace('refs/pull/', '/pull/');
-      const pr_name = ci.repository_ref.replace('refs/pull/', '').replace('/merge', '');
-      elements.push({ label: 'Pull Request', key: pr_name, value: pr_url, type: 'hyperlink' });
-    } else {
-      const branch_url = ci.repository_url + ci.repository_ref.replace('refs/heads/', '/tree/');
-      const branch_name = ci.repository_ref.replace('refs/heads/', '');
-      elements.push({ label: 'Branch', key: branch_name, value: branch_url, type: 'hyperlink' });
-    }
-  }
-  return elements;
-}
-
-/**
- * 
- * @param {import('..').CIInfoInputs} inputs 
- */
-function get_build_elements(inputs) {
-  let elements = [];
-  const ci = getCIInformation();
-  if (inputs.show_build && ci && ci.build_url) {
-    const name = (ci.build_name || 'Build') + (ci.build_number ? ` #${ci.build_number}` : '');
-    elements.push({ label: 'Build', key: name, value: ci.build_url, type: 'hyperlink' });
-  }
-  if (inputs.data) {
-    elements = elements.concat(inputs.data);
-  }
-  return elements;
-}
-
-async function get_text({ target, extension, result }) {
-  const repository_elements = get_repository_elements(extension.inputs);
-  const build_elements = get_build_elements(extension.inputs);
-  if (target.name === 'teams') {
-    const repository_text = await getTeamsMetaDataText({ elements: repository_elements, target, extension, result, default_condition: default_options.condition });
-    const build_text = await getTeamsMetaDataText({ elements: build_elements, target, extension, result, default_condition: default_options.condition });
-    if (build_text) {
-      return `${repository_text ? `${repository_text}\n\n` : '' }${build_text}`;
-    } else {
-      return repository_text;
-    }
-  } else if (target.name === 'slack') {
-    const repository_text = await getSlackMetaDataText({ elements: repository_elements, target, extension, result, default_condition: default_options.condition });
-    const build_text = await getSlackMetaDataText({ elements: build_elements, target, extension, result, default_condition: default_options.condition });
-    if (build_text) {
-      return `${repository_text ? `${repository_text}\n` : '' }${build_text}`;
-    } else {
-      return repository_text;
-    }
-  } else if (target.name === 'chat') {
-    const repository_text = await getChatMetaDataText({ elements: repository_elements, target, extension, result, default_condition: default_options.condition });
-    const build_text = await getChatMetaDataText({ elements: build_elements, target, extension, result, default_condition: default_options.condition });
-    if (build_text) {
-      return `${repository_text ? `${repository_text}<br>` : '' }${build_text}`;
-    } else {
-      return repository_text;
-    }
-  }
-}
-
-const default_options = {
-  hook: HOOK.AFTER_SUMMARY,
-  condition: STATUS.PASS_OR_FAIL,
-}
-
-const default_inputs = {
-  title: '',
-  show_repository: true,
-  show_repository_branch: true,
-  show_build: true,
-}
-
-const default_inputs_teams = {
-  
-  separator: true
-}
-
-const default_inputs_slack = {
-  separator: false
-}
-
-const default_inputs_chat = {
-  separator: true
-}
-
-module.exports = {
-  run,
-  default_options
-}

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
-}