testbeats 2.1.4 → 2.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testbeats",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "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.api.js

@@ -61,6 +61,20 @@ class BeatsApi {
       }
     });
   }
+
+  /**
+   *
+   * @param {string} run_id
+   * @returns {import('./beats.types').IFailureAnalysisMetric[]}
+   */
+  getFailureAnalysis(run_id) {
+    return request.get({
+      url: `${this.getBaseUrl()}/api/core/v1/test-runs/${run_id}/failure-analysis`,
+      headers: {
+        'x-api-key': this.config.api_key
+      }
+    });
+  }
 }
 
 module.exports = { BeatsApi }

package/src/beats/beats.js

@@ -147,11 +147,12 @@ class Beats {
     try {
       logger.info('🪄 Fetching Failure Analysis...');
       await this.#setTestRun('Failure Analysis Status', 'failure_analysis_status');
+      const metrics = await this.api.getFailureAnalysis(this.test_run_id);
       this.config.extensions.push({
         name: 'failure-analysis',
         hook: HOOK.AFTER_SUMMARY,
         inputs: {
-          data: this.test_run
+          data: metrics
         }
       });
     } catch (error) {

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

@@ -9,12 +9,6 @@ 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
@@ -38,3 +32,9 @@ export type IErrorCluster = {
   failure: string
   count: number
 }
+
+export type IFailureAnalysisMetric = {
+  id: string
+  name: string
+  count: number
+}

package/src/commands/publish.command.js

@@ -14,7 +14,7 @@ const { MIN_NODE_VERSION } = require('../helpers/constants');
 class PublishCommand {
 
   /**
-   * @param {import('../index').PublishOptions} opts
+   * @param {import('../index').CommandLineOptions} opts
    */
   constructor(opts) {
     this.opts = opts;
@@ -28,6 +28,7 @@ class PublishCommand {
     this.#buildConfig();
     this.#validateOptions();
     this.#setConfigFromFile();
+    this.#mergeConfigOptions();
     this.#processConfig();
     this.#validateConfig();
     this.#processResults();
@@ -76,6 +77,14 @@ class PublishCommand {
     }
   }
 
+  #mergeConfigOptions() {
+    if (this.opts.config && typeof this.opts.config === 'object') {
+      this.opts.config.project = this.opts.project || this.opts.config.project;
+      this.opts.config.run = this.opts.run || this.opts.config.run;
+      this.opts.config.api_key = this.opts['api-key'] || this.opts.config.api_key;
+    }
+  }
+
   #processConfig() {
     const processed_config = processData(this.opts.config);
     /**@type {import('../index').PublishConfig[]} */
@@ -149,6 +158,9 @@ class PublishCommand {
       throw new Error('targets must be an array');
     }
     for (const target of config.targets) {
+      if (target.enable === false || target.enable === 'false') {
+        continue;
+      }
       if (!target.name) {
         throw new Error(`'config.targets[*].name' is missing`);
       }
@@ -210,6 +222,9 @@ class PublishCommand {
         await beats.run(config, result);
         if (config.targets) {
           for (const target of config.targets) {
+            if (target.enable === false || target.enable === 'false') {
+              continue;
+            }
             target.extensions = target.extensions || [];
             target.extensions = config.extensions.concat(target.extensions);
             await target_manager.run(target, result);

package/src/extensions/base.extension.js

@@ -5,8 +5,8 @@ class BaseExtension {
 
   /**
    *
-   * @param {import('..').Target} target
-   * @param {import('..').Extension} extension
+   * @param {import('..').ITarget} target
+   * @param {import('..').IExtension} extension
    * @param {import('..').TestResult} result
    * @param {any} payload
    * @param {any} root_payload

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

@@ -26,31 +26,32 @@ class FailureAnalysisExtension extends BaseExtension {
   }
 
   #setText() {
-    const data = this.extension.inputs.data;
-    if (!data) {
-      return;
-    }
-
     /**
-     * @type {import('../beats/beats.types').IBeatExecutionMetric}
+     * @type {import('../beats/beats.types').IFailureAnalysisMetric[]}
      */
-    const execution_metrics = data.execution_metrics[0];
-
-    if (!execution_metrics) {
-      logger.warn('⚠️ No execution metrics found. Skipping.');
+    const metrics = this.extension.inputs.data;
+    if (!metrics || metrics.length === 0) {
+      logger.warn('⚠️ No failure analysis metrics found. Skipping.');
       return;
     }
 
+    const to_investigate = metrics.find(metric => metric.name === 'To Investigate');
+    const auto_analysed = metrics.find(metric => metric.name === 'Auto Analysed');
+
     const failure_analysis = [];
 
-    if (execution_metrics.to_investigate) {
-      failure_analysis.push(`🔎 To Investigate: ${execution_metrics.to_investigate}`);
+    if (to_investigate && to_investigate.count > 0) {
+      failure_analysis.push(`🔎 To Investigate: ${to_investigate.count}`);
+    }
+    if (auto_analysed && auto_analysed.count > 0) {
+      failure_analysis.push(`🪄 Auto Analysed: ${auto_analysed.count}`);
     }
-    if (execution_metrics.auto_analysed) {
-      failure_analysis.push(`🪄 Auto Analysed: ${execution_metrics.auto_analysed}`);
+
+    if (failure_analysis.length === 0) {
+      return;
     }
 
-    this.text = failure_analysis.join('  •  ');
+    this.text = failure_analysis.join('    ');
   }
 
 }

package/src/extensions/index.js

@@ -17,9 +17,15 @@ const { FailureAnalysisExtension } = require('./failure-analysis.extension');
 
 async function run(options) {
   const { target, result, hook } = options;
+  /**
+   * @type {import("..").IExtension[]}
+   */
   const extensions = target.extensions || [];
   for (let i = 0; i < extensions.length; i++) {
     const extension = extensions[i];
+    if (extension.enable === false || extension.enable === 'false') {
+      continue;
+    }
     const extension_runner = getExtensionRunner(extension, options);
     const extension_options = Object.assign({}, extension_runner.default_options, extension);
     if (extension_options.hook === hook) {

package/src/extensions/metadata.js

@@ -4,7 +4,7 @@ const { getTeamsMetaDataText, getSlackMetaDataText, getChatMetaDataText } = requ
 
 /**
  * @param {object} param0
- * @param {import('..').Target} param0.target
+ * @param {import('..').ITarget} param0.target
  * @param {import('..').MetadataExtension} param0.extension
  */
 async function run({ target, extension, result, payload, root_payload }) {

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/extension.helper.js

@@ -3,9 +3,9 @@
  *
  * @param {object} param0 - the payload object
  * @param {object} param0.payload - the payload object
- * @param {import("..").Extension} param0.extension - the extension to add
+ * @param {import("..").IExtension} param0.extension - the extension to add
  * @param {string} param0.text - the text to include
- * @return {void} 
+ * @return {void}
  */
 function addSlackExtension({ payload, extension, text }) {
   if (extension.inputs.separator) {
@@ -44,9 +44,9 @@ function addSlackExtension({ payload, extension, text }) {
  *
  * @param {object} param0 - the payload object
  * @param {object} param0.payload - the payload object
- * @param {import("..").Extension} param0.extension - the extension to add
+ * @param {import("..").IExtension} param0.extension - the extension to add
  * @param {string} param0.text - the text to include
- * @return {void} 
+ * @return {void}
  */
 function addTeamsExtension({ payload, extension, text }) {
   if (extension.inputs.title) {
@@ -79,9 +79,9 @@ function addTeamsExtension({ payload, extension, text }) {
  *
  * @param {object} param0 - the payload object
  * @param {object} param0.payload - the payload object
- * @param {import("..").Extension} param0.extension - the extension to add
+ * @param {import("..").IExtension} param0.extension - the extension to add
  * @param {string} param0.text - the text to include
- * @return {void} 
+ * @return {void}
  */
 function addChatExtension({ payload, extension, text }) {
   let updated_text = text;

package/src/helpers/metadata.helper.js

@@ -18,8 +18,8 @@ function getMetaDataText(params) {
  *
  * @param {object} param0 - the payload object
  * @param {Object} param0.elements - The elements to generate metadata text from
- * @param {import('..').Target} param0.target - The result object
- * @param {import('..').Extension} param0.extension - The result object
+ * @param {import('..').ITarget} param0.target - The result object
+ * @param {import('..').IExtension} param0.extension - The result object
  * @param {Object} param0.result - The result object
  * @param {string} param0.default_condition - The default condition object
  * @return {string} The generated metadata text
@@ -50,8 +50,8 @@ async function getSlackMetaDataText({ elements, target, extension, result, defau
  *
  * @param {object} param0 - the payload object
  * @param {Object} param0.elements - The elements to generate metadata text from
- * @param {import('..').Target} param0.target - The result object
- * @param {import('..').Extension} param0.extension - The result object
+ * @param {import('..').ITarget} param0.target - The result object
+ * @param {import('..').IExtension} param0.extension - The result object
  * @param {Object} param0.result - The result object
  * @param {string} param0.default_condition - The default condition object
  * @return {string} The generated metadata text
@@ -82,8 +82,8 @@ async function getTeamsMetaDataText({ elements, target, extension, result, defau
  *
  * @param {object} param0 - the payload object
  * @param {Object} param0.elements - The elements to generate metadata text from
- * @param {import('..').Target} param0.target - The result object
- * @param {import('..').Extension} param0.extension - The result object
+ * @param {import('..').ITarget} param0.target - The result object
+ * @param {import('..').IExtension} param0.extension - The result object
  * @param {Object} param0.result - The result object
  * @param {string} param0.default_condition - The default condition object
  * @return {string} The generated metadata text

package/src/index.d.ts

@@ -4,14 +4,30 @@ import { Schedule, User } from 'rosters';
 import { ParseOptions } from 'test-results-parser';
 import TestResult from 'test-results-parser/src/models/TestResult';
 
+export interface ITarget {
+  name: TargetName;
+  enable?: string | boolean;
+  condition?: Condition;
+  inputs?: SlackInputs | TeamsInputs | ChatInputs | CustomTargetInputs | InfluxDBTargetInputs;
+  extensions?: IExtension[];
+}
+
+export interface IExtension {
+  name: ExtensionName;
+  enable?: string | boolean;
+  condition?: Condition;
+  hook?: Hook;
+  inputs?: ReportPortalAnalysisInputs | ReportPortalHistoryInputs | HyperlinkInputs | MentionInputs | QuickChartTestSummaryInputs | PercyAnalysisInputs | CustomExtensionInputs | MetadataInputs | CIInfoInputs | AIFailureSummaryInputs;
+}
+
 export type ExtensionName = 'report-portal-analysis' | 'hyperlinks' | 'mentions' | 'report-portal-history' | 'quick-chart-test-summary' | 'metadata' | 'ci-info' | 'custom' | 'ai-failure-summary';
 export type Hook = 'start' | 'end' | 'after-summary';
 export type TargetName = 'slack' | 'teams' | 'chat' | 'custom' | 'delay';
 export type PublishReportType = 'test-summary' | 'test-summary-slim' | 'failure-details';
 
 export interface ConditionFunctionContext {
-  target: Target;
-  extension?: Extension,
+  target: ITarget;
+  extension?: IExtension,
   result: TestResult;
 }
 export type ConditionFunction = (ctx: ConditionFunctionContext) => boolean | Promise<boolean>;
@@ -67,12 +83,7 @@ export interface AIFailureSummaryInputs extends ExtensionInputs {
   failure_summary: string;
 }
 
-export interface Extension {
-  name: ExtensionName;
-  condition?: Condition;
-  hook?: Hook;
-  inputs?: ReportPortalAnalysisInputs | ReportPortalHistoryInputs | HyperlinkInputs | MentionInputs | QuickChartTestSummaryInputs | PercyAnalysisInputs | CustomExtensionInputs | MetadataInputs | CIInfoInputs | AIFailureSummaryInputs;
-}
+
 
 export interface PercyAnalysisInputs extends ExtensionInputs {
   url?: string;
@@ -90,14 +101,14 @@ export interface PercyAnalysisOutputs {
   project?: object;
 }
 
-export interface PercyAnalysisExtension extends Extension {
+export interface PercyAnalysisExtension extends IExtension {
   inputs?: PercyAnalysisInputs;
   outputs?: PercyAnalysisOutputs;
 }
 
 export interface CustomExtensionFunctionContext {
-  target: Target;
-  extension: Extension,
+  target: ITarget;
+  extension: IExtension,
   result: TestResult;
   payload: any;
   root_payload: any;
@@ -109,13 +120,13 @@ export interface CustomExtensionInputs extends ExtensionInputs {
   load: string | CustomExtensionFunction;
 }
 
-export interface CustomExtension extends Extension {
+export interface CustomExtension extends IExtension {
   inputs?: CustomExtensionInputs;
   outputs?: any;
 }
 
 export interface LinkUrlFunctionContext {
-  target: Target;
+  target: ITarget;
   extension: HyperlinksExtension,
   result: TestResult;
 }
@@ -132,7 +143,7 @@ export interface HyperlinkInputs extends ExtensionInputs {
   links: Link[];
 }
 
-export interface HyperlinksExtension extends Extension {
+export interface HyperlinksExtension extends IExtension {
   inputs?: HyperlinkInputs;
 }
 
@@ -148,7 +159,7 @@ export interface MetadataInputs extends ExtensionInputs {
   data?: Metadata[];
 }
 
-export interface MetadataExtension extends Extension {
+export interface MetadataExtension extends IExtension {
   inputs?: MetadataInputs;
 }
 
@@ -202,7 +213,7 @@ export interface InfluxDBTargetInputs {
 }
 
 export interface CustomTargetFunctionContext {
-  target: Target;
+  target: ITarget;
   result: TestResult;
 }
 
@@ -212,12 +223,7 @@ export interface CustomTargetInputs {
   load: string | CustomTargetFunction;
 }
 
-export interface Target {
-  name: TargetName;
-  condition?: Condition;
-  inputs?: SlackInputs | TeamsInputs | ChatInputs | CustomTargetInputs | InfluxDBTargetInputs;
-  extensions?: Extension[];
-}
+
 
 export interface CustomResultOptions {
   type: string;
@@ -232,8 +238,8 @@ export interface PublishReport {
   show_failure_analysis?: boolean;
   show_smart_analysis?: boolean;
   show_error_clusters?: boolean;
-  targets?: Target[];
-  extensions?: Extension[];
+  targets?: ITarget[];
+  extensions?: IExtension[];
   results?: ParseOptions[] | PerformanceParseOptions[] | CustomResultOptions[];
 }
 
@@ -241,8 +247,8 @@ export interface PublishConfig {
   api_key?: string;
   project?: string;
   run?: string;
-  targets?: Target[];
-  extensions?: Extension[];
+  targets?: ITarget[];
+  extensions?: IExtension[];
   results?: ParseOptions[] | PerformanceParseOptions[] | CustomResultOptions[];
 }
 
@@ -251,7 +257,7 @@ export interface PublishOptions {
 }
 
 export interface CommandLineOptions {
-  config?: string;
+  config?: string | PublishConfig;
   project?: string;
   run?: string;
   'api-key'?: string;

package/src/platforms/base.platform.js

@@ -15,7 +15,7 @@ class BasePlatform {
 
   /**
    *
-   * @param {import('..').Target} target
+   * @param {import('..').ITarget} target
    * @param {import('test-results-parser').ITestSuite} suite
    */
   getSuiteSummaryText(target, suite) {
@@ -74,7 +74,7 @@ class BasePlatform {
 
   /**
    *
-   * @param {import('..').Target} target
+   * @param {import('..').ITarget} target
    * @param {import('test-results-parser').ITestSuite} suite
    */
   #getSuiteDurationText(target, suite) {
@@ -84,7 +84,7 @@ class BasePlatform {
 
   /**
    *
-   * @param {import('..').Target} target
+   * @param {import('..').ITarget} target
    * @param {import('test-results-parser').ITestSuite} suite
    */
   getSuiteDuration(target, suite) {

package/src/targets/custom.js

@@ -2,9 +2,9 @@ const path = require('path');
 const { STATUS } = require('../helpers/constants');
 
 /**
- * 
- * @param {object} param0 
- * @param {import('../index').Target} param0.target 
+ *
+ * @param {object} param0
+ * @param {import('../index').ITarget} param0.target
  */
 async function run({result, target}) {
   if (typeof target.inputs.load === 'string') {

package/src/targets/influx.js

@@ -10,10 +10,10 @@ const TestSuite = require('test-results-parser/src/models/TestSuite');
 const { STATUS } = require('../helpers/constants');
 
 /**
- * 
- * @param {object} param0 
+ *
+ * @param {object} param0
  * @param {PerformanceTestResult | TestResult} param0.result
- * @param {import('..').Target} param0.target
+ * @param {import('..').ITarget} param0.target
  */
 async function run({ result, target }) {
   target.inputs = Object.assign({}, default_inputs, target.inputs);
@@ -34,10 +34,10 @@ async function run({ result, target }) {
 }
 
 /**
- * 
- * @param {object} param0 
+ *
+ * @param {object} param0
  * @param {PerformanceTestResult | TestResult} param0.result
- * @param {import('..').Target} param0.target
+ * @param {import('..').ITarget} param0.target
  */
 function getMetrics({ result, target }) {
   const influx_metrics = [];
@@ -60,10 +60,10 @@ function getMetrics({ result, target }) {
 }
 
 /**
- * @param {object} param0 
+ * @param {object} param0
  * @param {PerformanceTestResult} param0.result
- * @param {import('..').Target} param0.target
- * @returns 
+ * @param {import('..').ITarget} param0.target
+ * @returns
  */
 function getPerfRunInfluxMetric({ result, target }) {
   const tags = Object.assign({}, target.inputs.tags);
@@ -88,8 +88,8 @@ function getPerfRunInfluxMetric({ result, target }) {
 }
 
 /**
- * 
- * @param {Metric} metric 
+ *
+ * @param {Metric} metric
  */
 function setPerfInfluxMetricFields(metric, fields) {
   let name = metric.name;
@@ -110,8 +110,8 @@ function setPerfInfluxMetricFields(metric, fields) {
 }
 
 /**
- * 
- * @param {Transaction} transaction 
+ *
+ * @param {Transaction} transaction
  */
 function getTransactionInfluxMetric(transaction, target) {
   const tags = Object.assign({}, target.inputs.tags);
@@ -133,10 +133,10 @@ function getTransactionInfluxMetric(transaction, target) {
 }
 
 /**
- * @param {object} param0 
+ * @param {object} param0
  * @param {TestResult | TestSuite} param0.result
- * @param {import('..').Target} param0.target
- * @returns 
+ * @param {import('..').ITarget} param0.target
+ * @returns
  */
 function getTestInfluxMetric({ result, target }, measurement) {
   const tags = Object.assign({}, target.inputs.tags);
@@ -158,10 +158,10 @@ function getTestInfluxMetric({ result, target }, measurement) {
 }
 
 /**
- * @param {object} param0 
+ * @param {object} param0
  * @param {TestCase} param0.result
- * @param {import('..').Target} param0.target
- * @returns 
+ * @param {import('..').ITarget} param0.target
+ * @returns
  */
 function getTestCaseInfluxMetric({ result, target }) {
   const tags = Object.assign({}, target.inputs.tags);