testbeats 2.1.2 → 2.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testbeats",
-  "version": "2.1.2",
+  "version": "2.1.4",
   "description": "Publish test results to Microsoft Teams, Google Chat, Slack and InfluxDB",
   "main": "src/index.js",
   "types": "./src/index.d.ts",
@@ -47,7 +47,7 @@
   "homepage": "https://testbeats.com",
   "dependencies": {
     "async-retry": "^1.3.3",
-    "dotenv": "^14.3.2",
+    "dotenv": "^16.4.5",
     "form-data-lite": "^1.0.3",
     "influxdb-lite": "^1.0.0",
     "performance-results-parser": "latest",
@@ -58,12 +58,12 @@
     "test-results-parser": "0.2.5"
   },
   "devDependencies": {
-    "c8": "^7.12.0",
-    "mocha": "^10.1.0",
+    "c8": "^10.1.2",
+    "mocha": "^10.7.3",
     "mocha-junit-reporter": "^2.2.1",
     "mocha-multi-reporters": "^1.5.1",
-    "pactum": "^3.2.3",
-    "pkg": "^5.8.0"
+    "pactum": "^3.7.1",
+    "pkg": "^5.8.1"
   },
   "engines": {
     "node": ">=14.0.0"

package/src/beats/beats.attachments.js

@@ -4,10 +4,11 @@ const FormData = require('form-data-lite');
 const TestResult = require('test-results-parser/src/models/TestResult');
 const { BeatsApi } = require('./beats.api');
 const logger = require('../utils/logger');
+const TestAttachment = require('test-results-parser/src/models/TestAttachment');
 
 const MAX_ATTACHMENTS_PER_REQUEST = 5;
 const MAX_ATTACHMENTS_PER_RUN = 20;
-const MAX_ATTACHMENT_SIZE = 1024 * 1024;
+const MAX_ATTACHMENT_SIZE = 2 * 1024 * 1024;
 
 class BeatsAttachments {
 
@@ -53,8 +54,6 @@ class BeatsAttachments {
       return;
     }
     logger.info(`⏳ Uploading ${this.attachments.length} attachments...`);
-    const result_file = this.config.results[0].files[0];
-    const result_file_dir = path.dirname(result_file);
     try {
       let count = 0;
       const size = MAX_ATTACHMENTS_PER_REQUEST;
@@ -68,7 +67,11 @@ class BeatsAttachments {
         form.append('test_run_id', this.test_run_id);
         const file_images = []
         for (const attachment of attachments_subset) {
-          const attachment_path = path.join(result_file_dir, attachment.path);
+          const attachment_path = this.#getAttachmentFilePath(attachment);
+          if (!attachment_path) {
+            logger.warn(`⚠️ Unable to find attachment ${attachment.path}`);
+            continue;
+          }
           const stats = fs.statSync(attachment_path);
           if (stats.size > MAX_ATTACHMENT_SIZE) {
             logger.warn(`⚠️ Attachment ${attachment.path} is too big (${stats.size} bytes). Allowed size is ${MAX_ATTACHMENT_SIZE} bytes.`);
@@ -93,6 +96,33 @@ class BeatsAttachments {
     }
   }
 
+  /**
+   *
+   * @param {TestAttachment} attachment
+   */
+  #getAttachmentFilePath(attachment) {
+    const result_file = this.config.results[0].files[0];
+    const result_file_dir = path.dirname(result_file);
+    const relative_attachment_path = path.join(result_file_dir, attachment.path);
+    const raw_attachment_path = attachment.path;
+
+    try {
+      fs.statSync(relative_attachment_path);
+      return relative_attachment_path;
+    } catch {
+      // nothing
+    }
+
+    try {
+      fs.statSync(raw_attachment_path);
+      return raw_attachment_path;
+    } catch {
+      // nothing
+    }
+
+    return null;
+  }
+
 
 
 }

package/src/beats/beats.js

@@ -1,7 +1,7 @@
 const { getCIInformation } = require('../helpers/ci');
 const logger = require('../utils/logger');
 const { BeatsApi } = require('./beats.api');
-const { HOOK } = require('../helpers/constants');
+const { HOOK, PROCESS_STATUS } = require('../helpers/constants');
 const TestResult = require('test-results-parser/src/models/TestResult');
 const { BeatsAttachments } = require('./beats.attachments');
 
@@ -31,9 +31,7 @@ class Beats {
     await this.#publishTestResults();
     await this.#uploadAttachments();
     this.#updateTitleLink();
-    await this.#attachFailureSummary();
-    await this.#attachSmartAnalysis();
-    await this.#attachErrorClusters();
+    await this.#attachExtensions();
   }
 
   #setCIInfo() {
@@ -104,13 +102,20 @@ class Beats {
     }
   }
 
-  async #attachFailureSummary() {
+  async #attachExtensions() {
     if (!this.test_run_id) {
       return;
     }
     if (!this.config.targets) {
       return;
     }
+    await this.#attachFailureSummary();
+    await this.#attachFailureAnalysis();
+    await this.#attachSmartAnalysis();
+    await this.#attachErrorClusters();
+  }
+
+  async #attachFailureSummary() {
     if (this.result.status !== 'FAIL') {
       return;
     }
@@ -132,13 +137,29 @@ class Beats {
     }
   }
 
-  async #attachSmartAnalysis() {
-    if (!this.test_run_id) {
+  async #attachFailureAnalysis() {
+    if (this.result.status !== 'FAIL') {
       return;
     }
-    if (!this.config.targets) {
+    if (this.config.show_failure_analysis === false) {
       return;
     }
+    try {
+      logger.info('🪄 Fetching Failure Analysis...');
+      await this.#setTestRun('Failure Analysis Status', 'failure_analysis_status');
+      this.config.extensions.push({
+        name: 'failure-analysis',
+        hook: HOOK.AFTER_SUMMARY,
+        inputs: {
+          data: this.test_run
+        }
+      });
+    } catch (error) {
+      logger.error(`❌ Unable to attach failure analysis: ${error.message}`, error);
+    }
+  }
+
+  async #attachSmartAnalysis() {
     if (this.config.show_smart_analysis === false) {
       return;
     }
@@ -165,7 +186,7 @@ class Beats {
   }
 
   async #setTestRun(text, wait_for = 'smart_analysis_status') {
-    if (this.test_run && this.test_run[wait_for] === 'COMPLETED') {
+    if (this.test_run && this.test_run[wait_for] === PROCESS_STATUS.COMPLETED) {
       return;
     }
     let retry = 3;
@@ -175,13 +196,13 @@ class Beats {
       this.test_run = await this.api.getTestRun(this.test_run_id);
       const status = this.test_run && this.test_run[wait_for];
       switch (status) {
-        case 'COMPLETED':
+        case PROCESS_STATUS.COMPLETED:
           logger.debug(`☑️ ${text} generated successfully`);
           return;
-        case 'FAILED':
+        case PROCESS_STATUS.FAILED:
           logger.error(`❌ Failed to generate ${text}`);
           return;
-        case 'SKIPPED':
+        case PROCESS_STATUS.SKIPPED:
           logger.warn(`❗ Skipped generating ${text}`);
           return;
       }
@@ -191,12 +212,6 @@ class Beats {
   }
 
   async #attachErrorClusters() {
-    if (!this.test_run_id) {
-      return;
-    }
-    if (!this.config.targets) {
-      return;
-    }
     if (this.result.status !== 'FAIL') {
       return;
     }

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

@@ -9,6 +9,12 @@ export type IBeatExecutionMetric = {
   added: number
   removed: number
   flaky: number
+  product_bugs: number
+  environment_issues: number
+  automation_bugs: number
+  not_a_defects: number
+  to_investigate: number
+  auto_analysed: number
   failure_summary: any
   failure_summary_provider: any
   failure_summary_model: any

package/src/cli.js

@@ -6,9 +6,10 @@ const sade = require('sade');
 const prog = sade('testbeats');
 const { PublishCommand } = require('./commands/publish.command');
 const logger = require('./utils/logger');
+const pkg = require('../package.json');
 
 prog
-  .version('2.0.4')
+  .version(pkg.version)
   .option('-c, --config', 'path to config file')
   .option('-l, --logLevel', 'Log Level', "INFO")
   .option('--api-key', 'api key')
@@ -40,4 +41,4 @@ prog.command('publish')
     }
   });
 
-prog.parse(process.argv);
+prog.parse(process.argv);

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

@@ -0,0 +1,58 @@
+const { BaseExtension } = require('./base.extension');
+const { STATUS, HOOK } = require("../helpers/constants");
+
+class FailureAnalysisExtension extends BaseExtension {
+
+  constructor(target, extension, result, payload, root_payload) {
+    super(target, extension, result, payload, root_payload);
+    this.#setDefaultOptions();
+    this.#setDefaultInputs();
+    this.updateExtensionInputs();
+  }
+
+  #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 = '';
+  }
+
+  run() {
+    this.#setText();
+    this.attach();
+  }
+
+  #setText() {
+    const data = this.extension.inputs.data;
+    if (!data) {
+      return;
+    }
+
+    /**
+     * @type {import('../beats/beats.types').IBeatExecutionMetric}
+     */
+    const execution_metrics = data.execution_metrics[0];
+
+    if (!execution_metrics) {
+      logger.warn('⚠️ No execution metrics found. Skipping.');
+      return;
+    }
+
+    const failure_analysis = [];
+
+    if (execution_metrics.to_investigate) {
+      failure_analysis.push(`🔎 To Investigate: ${execution_metrics.to_investigate}`);
+    }
+    if (execution_metrics.auto_analysed) {
+      failure_analysis.push(`🪄 Auto Analysed: ${execution_metrics.auto_analysed}`);
+    }
+
+    this.text = failure_analysis.join('  •  ');
+  }
+
+}
+
+module.exports =  { FailureAnalysisExtension };

package/src/extensions/index.js

@@ -13,6 +13,7 @@ const { EXTENSION } = require('../helpers/constants');
 const { checkCondition } = require('../helpers/helper');
 const logger = require('../utils/logger');
 const { ErrorClustersExtension } = require('./error-clusters.extension');
+const { FailureAnalysisExtension } = require('./failure-analysis.extension');
 
 async function run(options) {
   const { target, result, hook } = options;
@@ -59,6 +60,8 @@ function getExtensionRunner(extension, options) {
       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.FAILURE_ANALYSIS:
+      return new FailureAnalysisExtension(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:

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

@@ -65,13 +65,13 @@ class SmartAnalysisExtension extends BaseExtension {
     for (const item of smart_analysis) {
       rows.push(item);
       if (rows.length === 3) {
-        texts.push(rows.join(' ｜ '));
+        texts.push(rows.join('  •  '));
         rows.length = 0;
       }
     }
 
     if (rows.length > 0) {
-      texts.push(rows.join(' ｜ '));
+      texts.push(rows.join('  •  '));
     }
 
     this.text = this.mergeTexts(texts);

package/src/helpers/ci.js

@@ -1,9 +1,21 @@
+const os = require('os');
+const pkg = require('../../package.json');
+
 const ENV = process.env;
 
 /**
  * @returns {import('../extensions/extensions').ICIInfo}
  */
 function getCIInformation() {
+  const ci_info = getBaseCIInfo();
+  const system_info = getSystemInfo();
+  return {
+    ...ci_info,
+    ...system_info
+  }
+}
+
+function getBaseCIInfo() {
   if (ENV.GITHUB_ACTIONS) {
     return getGitHubActionsInformation();
   }
@@ -16,6 +28,7 @@ function getCIInformation() {
   if (ENV.SYSTEM_TEAMFOUNDATIONCOLLECTIONURI) {
     return getAzureDevOpsInformation();
   }
+  return getDefaultInformation();
 }
 
 function getGitHubActionsInformation() {
@@ -82,6 +95,46 @@ function getGitLabInformation() {
   }
 }
 
+function getDefaultInformation() {
+  return {
+    ci: ENV.TEST_BEATS_CI_NAME,
+    git: ENV.TEST_BEATS_CI_GIT,
+    repository_url: ENV.TEST_BEATS_CI_REPOSITORY_URL,
+    repository_name: ENV.TEST_BEATS_CI_REPOSITORY_NAME,
+    repository_ref: ENV.TEST_BEATS_CI_REPOSITORY_REF,
+    repository_commit_sha: ENV.TEST_BEATS_CI_REPOSITORY_COMMIT_SHA,
+    build_url: ENV.TEST_BEATS_CI_BUILD_URL,
+    build_number: ENV.TEST_BEATS_CI_BUILD_NUMBER,
+    build_name: ENV.TEST_BEATS_CI_BUILD_NAME,
+    build_reason: ENV.TEST_BEATS_CI_BUILD_REASON,
+    user: ENV.TEST_BEATS_CI_USER || os.userInfo().username
+  }
+}
+
+function getSystemInfo() {
+  function getRuntimeInfo() {
+    if (typeof process !== 'undefined' && process.versions && process.versions.node) {
+      return { name: 'node', version: process.versions.node };
+    } else if (typeof Deno !== 'undefined') {
+      return { name: 'deno', version: Deno.version.deno };
+    } else if (typeof Bun !== 'undefined') {
+      return { name: 'bun', version: Bun.version };
+    } else {
+      return { name: 'unknown', version: 'unknown' };
+    }
+  }
+
+  const runtime = getRuntimeInfo();
+
+  return {
+    runtime: runtime.name,
+    runtime_version: runtime.version,
+    os: os.platform(),
+    os_version: os.release(),
+    testbeats_version: pkg.version
+  }
+}
+
 module.exports = {
   getCIInformation
 }

package/src/helpers/constants.js

@@ -21,6 +21,7 @@ const TARGET = Object.freeze({
 
 const EXTENSION = Object.freeze({
   AI_FAILURE_SUMMARY: 'ai-failure-summary',
+  FAILURE_ANALYSIS: 'failure-analysis',
   SMART_ANALYSIS: 'smart-analysis',
   ERROR_CLUSTERS: 'error-clusters',
   HYPERLINKS: 'hyperlinks',
@@ -39,6 +40,13 @@ const URLS = Object.freeze({
   QUICK_CHART: 'https://quickchart.io'
 });
 
+const PROCESS_STATUS = Object.freeze({
+  RUNNING: 'RUNNING',
+  COMPLETED: 'COMPLETED',
+  FAILED: 'FAILED',
+  SKIPPED: 'SKIPPED',
+});
+
 const MIN_NODE_VERSION = 14;
 
 module.exports = Object.freeze({
@@ -47,5 +55,6 @@ module.exports = Object.freeze({
   TARGET,
   EXTENSION,
   URLS,
+  PROCESS_STATUS,
   MIN_NODE_VERSION
 });

package/src/index.d.ts

@@ -229,6 +229,7 @@ export interface PublishReport {
   project?: string;
   run?: string;
   show_failure_summary?: boolean;
+  show_failure_analysis?: boolean;
   show_smart_analysis?: boolean;
   show_error_clusters?: boolean;
   targets?: Target[];