testbeats 2.1.6 → 2.2.1

package/src/helpers/browserstack.helper.js

@@ -0,0 +1,45 @@
+const request = require('phin-retry');
+const { URLS } = require('./constants');
+
+
+/**
+ *
+ * @param {import('../index').BrowserstackInputs} inputs
+ */
+function getBaseUrl(inputs) {
+  return inputs.url || URLS.BROWSERSTACK;
+}
+
+/**
+ *
+ * @param {import('../index').BrowserstackInputs} inputs
+ */
+async function getAutomationBuilds(inputs) {
+  return request.get({
+    url: `${getBaseUrl(inputs)}/automate/builds.json?limit=100`,
+    auth: {
+      username: inputs.username,
+      password: inputs.password
+    },
+  });
+}
+
+/**
+ *
+ * @param {import('../index').BrowserstackInputs} inputs
+ * @param {string} build_id
+ */
+async function getAutomationBuildSessions(inputs, build_id) {
+  return request.get({
+    url: `${getBaseUrl(inputs)}/automate/builds/${build_id}/sessions.json`,
+    auth: {
+      username: inputs.username,
+      password: inputs.password
+    },
+  });
+}
+
+module.exports = {
+  getAutomationBuilds,
+  getAutomationBuildSessions
+}

package/src/helpers/ci/azure-devops.js

@@ -0,0 +1,37 @@
+const { BaseCI } = require('./base.ci');
+
+const ENV = process.env;
+
+class AzureDevOpsCI extends BaseCI {
+  constructor() {
+    super();
+    this.init();
+  }
+
+  init() {
+    this.setInfo(this.targets.ci, 'AZURE_DEVOPS_PIPELINES');
+    this.setInfo(this.targets.git, 'AZURE_DEVOPS_REPOS');
+    this.setInfo(this.targets.repository_url, ENV.BUILD_REPOSITORY_URI);
+    this.setInfo(this.targets.repository_name, ENV.BUILD_REPOSITORY_NAME);
+    this.setInfo(this.targets.repository_ref, ENV.BUILD_SOURCEBRANCH);
+    this.setInfo(this.targets.repository_commit_sha, ENV.BUILD_SOURCEVERSION);
+    this.setInfo(this.targets.build_url, ENV.SYSTEM_TEAMFOUNDATIONCOLLECTIONURI + ENV.SYSTEM_TEAMPROJECT + '/_build/results?buildId=' + ENV.BUILD_BUILDID);
+    this.setInfo(this.targets.build_number, ENV.BUILD_BUILDNUMBER);
+    this.setInfo(this.targets.build_name, ENV.BUILD_DEFINITIONNAME);
+    this.setInfo(this.targets.build_reason, ENV.BUILD_REASON);
+
+    this.setInfo(this.targets.branch_url, this.repository_url + this.repository_ref.replace('refs/heads/', '/tree/'));
+    this.setInfo(this.targets.branch_name, this.repository_ref.replace('refs/heads/', ''));
+
+    if (this.repository_ref.includes('refs/pull')) {
+      this.setInfo(this.targets.pull_request_url, this.repository_url + this.repository_ref.replace('refs/pull/', '/pull/'));
+      this.setInfo(this.targets.pull_request_name, this.repository_ref.replace('refs/pull/', '').replace('/merge', ''));
+    }
+
+    this.setInfo(this.targets.user, ENV.BUILD_REQUESTEDFOR, true);
+  }
+}
+
+module.exports = {
+  AzureDevOpsCI
+}

package/src/helpers/ci/base.ci.js

@@ -0,0 +1,134 @@
+const os = require('os');
+const pkg = require('../../../package.json');
+
+const ENV = process.env;
+
+class BaseCI {
+  ci = '';
+  git = '';
+  repository_url = '';
+  repository_name = '';
+  repository_ref = '';
+  repository_commit_sha = '';
+  branch_url = '';
+  branch_name = '';
+  pull_request_url = '';
+  pull_request_name = '';
+  build_url = '';
+  build_number = '';
+  build_name = '';
+  build_reason = '';
+  user = '';
+  runtime = '';
+  runtime_version = '';
+  os = '';
+  os_version = '';
+  testbeats_version = '';
+
+  targets = {
+    ci: 'ci',
+    git: 'git',
+    repository_url: 'repository_url',
+    repository_name: 'repository_name',
+    repository_ref: 'repository_ref',
+    repository_commit_sha: 'repository_commit_sha',
+    branch_url: 'branch_url',
+    branch_name: 'branch_name',
+    pull_request_url: 'pull_request_url',
+    pull_request_name: 'pull_request_name',
+    build_url: 'build_url',
+    build_number: 'build_number',
+    build_name: 'build_name',
+    build_reason: 'build_reason',
+    user: 'user',
+    runtime: 'runtime',
+    runtime_version: 'runtime_version',
+    os: 'os',
+    os_version: 'os_version',
+    testbeats_version: 'testbeats_version'
+  }
+
+  constructor() {
+    this.setDefaultInformation();
+  }
+
+  setDefaultInformation() {
+    this.ci = ENV.TEST_BEATS_CI_NAME;
+    this.git = ENV.TEST_BEATS_CI_GIT;
+    this.repository_url = ENV.TEST_BEATS_CI_REPOSITORY_URL;
+    this.repository_name = ENV.TEST_BEATS_CI_REPOSITORY_NAME;
+    this.repository_ref = ENV.TEST_BEATS_CI_REPOSITORY_REF;
+    this.repository_commit_sha = ENV.TEST_BEATS_CI_REPOSITORY_COMMIT_SHA;
+    this.branch_url = ENV.TEST_BEATS_BRANCH_URL;
+    this.branch_name = ENV.TEST_BEATS_BRANCH_NAME;
+    this.pull_request_url = ENV.TEST_BEATS_PULL_REQUEST_URL;
+    this.pull_request_name = ENV.TEST_BEATS_PULL_REQUEST_NAME;
+    this.build_url = ENV.TEST_BEATS_CI_BUILD_URL;
+    this.build_number = ENV.TEST_BEATS_CI_BUILD_NUMBER;
+    this.build_name = ENV.TEST_BEATS_CI_BUILD_NAME;
+    this.build_reason = ENV.TEST_BEATS_CI_BUILD_REASON;
+    this.user = ENV.TEST_BEATS_CI_USER || os.userInfo().username;
+
+    const runtime = this.#getRuntimeInfo();
+    this.runtime = runtime.name;
+    this.runtime_version = runtime.version;
+    this.os = os.platform();
+    this.os_version = os.release();
+    this.testbeats_version = pkg.version;
+
+  }
+
+  #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' };
+    }
+  }
+
+  setInfo(target, value, force = false) {
+    if (force && value) {
+      this[target] = value;
+      return;
+    }
+    if (!this[target]) {
+      this[target] = value;
+    }
+  }
+
+ /**
+  *
+  * @returns {import('../../extensions/extensions').ICIInfo}
+  */
+  info() {
+    return {
+      ci: this.ci,
+      git: this.git,
+      repository_url: this.repository_url,
+      repository_name: this.repository_name,
+      repository_ref: this.repository_ref,
+      repository_commit_sha: this.repository_commit_sha,
+      branch_url: this.branch_url,
+      branch_name: this.branch_name,
+      pull_request_url: this.pull_request_url,
+      pull_request_name: this.pull_request_name,
+      build_url: this.build_url,
+      build_number: this.build_number,
+      build_name: this.build_name,
+      build_reason: this.build_reason,
+      user: this.user,
+      runtime: this.runtime,
+      runtime_version: this.runtime_version,
+      os: this.os,
+      os_version: this.os_version,
+      testbeats_version: this.testbeats_version
+    }
+  }
+
+}
+
+module.exports = { BaseCI };

package/src/helpers/ci/circle-ci.js

@@ -0,0 +1,32 @@
+const { BaseCI } = require('./base.ci');
+
+const ENV = process.env;
+
+class CircleCI extends BaseCI {
+  constructor() {
+    super();
+    this.init();
+  }
+
+  init() {
+    this.setInfo(this.targets.ci, 'CIRCLE_CI');
+    this.setInfo(this.targets.git, '');
+    this.setInfo(this.targets.repository_url, ENV.CIRCLE_REPOSITORY_URL);
+    this.setInfo(this.targets.repository_name, ENV.CIRCLE_PROJECT_REPONAME);
+    this.setInfo(this.targets.repository_ref, ENV.CIRCLE_BRANCH);
+    this.setInfo(this.targets.repository_commit_sha, ENV.CIRCLE_SHA1);
+    this.setInfo(this.targets.branch_url, '');
+    this.setInfo(this.targets.branch_name, ENV.CIRCLE_BRANCH);
+    this.setInfo(this.targets.pull_request_url,'');
+    this.setInfo(this.targets.pull_request_name, '');
+    this.setInfo(this.targets.build_url, ENV.CIRCLE_BUILD_URL);
+    this.setInfo(this.targets.build_number, ENV.CIRCLE_BUILD_NUM);
+    this.setInfo(this.targets.build_name, ENV.CIRCLE_JOB);
+    this.setInfo(this.targets.build_reason, 'Push');
+    this.setInfo(this.targets.user, ENV.CIRCLE_USERNAME, true);
+  }
+}
+
+module.exports = {
+  CircleCI
+}

package/src/helpers/ci/github.js

@@ -0,0 +1,36 @@
+const { BaseCI } = require('./base.ci');
+
+const ENV = process.env;
+
+class GitHubCI extends BaseCI {
+  constructor() {
+    super();
+    this.init();
+  }
+
+  init() {
+    this.setInfo(this.targets.ci, 'GITHUB_ACTIONS');
+    this.setInfo(this.targets.git, 'GITHUB');
+    this.setInfo(this.targets.repository_url, ENV.GITHUB_SERVER_URL + '/' + ENV.GITHUB_REPOSITORY);
+    this.setInfo(this.targets.repository_name, ENV.GITHUB_REPOSITORY);
+    this.setInfo(this.targets.repository_ref, ENV.GITHUB_REF);
+    this.setInfo(this.targets.repository_commit_sha, ENV.GITHUB_SHA);
+    this.setInfo(this.targets.build_url, ENV.GITHUB_SERVER_URL + '/' + ENV.GITHUB_REPOSITORY + '/actions/runs/' + ENV.GITHUB_RUN_ID);
+    this.setInfo(this.targets.build_number, ENV.GITHUB_RUN_NUMBER);
+    this.setInfo(this.targets.build_name, ENV.GITHUB_WORKFLOW);
+    this.setInfo(this.targets.build_reason, ENV.GITHUB_EVENT_NAME);
+    this.setInfo(this.targets.user, ENV.GITHUB_ACTOR, true);
+
+    this.setInfo(this.targets.branch_url, this.repository_url + this.repository_ref.replace('refs/heads/', '/tree/'));
+    this.setInfo(this.targets.branch_name, this.repository_ref.replace('refs/heads/', ''));
+
+    if (this.repository_ref.includes('refs/pull')) {
+      this.setInfo(this.targets.pull_request_url, this.repository_url + this.repository_ref.replace('refs/pull/', '/pull/'));
+      this.setInfo(this.targets.pull_request_name, this.repository_ref.replace('refs/pull/', '').replace('/merge', ''));
+    }
+  }
+}
+
+module.exports = {
+  GitHubCI
+}

package/src/helpers/ci/gitlab.js

@@ -0,0 +1,37 @@
+const { BaseCI } = require('./base.ci');
+
+const ENV = process.env;
+
+class GitLabCI extends BaseCI {
+  constructor() {
+    super();
+    this.init();
+  }
+
+  init() {
+    this.setInfo(this.targets.ci, 'GITLAB');
+    this.setInfo(this.targets.git, 'GITLAB');
+    this.setInfo(this.targets.repository_url, ENV.CI_PROJECT_URL);
+    this.setInfo(this.targets.repository_name, ENV.CI_PROJECT_NAME);
+    this.setInfo(this.targets.repository_ref, '/-/tree/' + (ENV.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME || ENV.CI_COMMIT_REF_NAME));
+    this.setInfo(this.targets.repository_commit_sha, ENV.CI_MERGE_REQUEST_SOURCE_BRANCH_SHA || ENV.CI_COMMIT_SHA);
+    this.setInfo(this.targets.branch_url, ENV.CI_PROJECT_URL + '/-/tree/' + (ENV.CI_COMMIT_REF_NAME || ENV.CI_COMMIT_BRANCH));
+    this.setInfo(this.targets.branch_name, ENV.CI_COMMIT_REF_NAME || ENV.CI_COMMIT_BRANCH);
+    this.setInfo(this.targets.pull_request_url,'');
+    this.setInfo(this.targets.pull_request_name, '');
+    this.setInfo(this.targets.build_url, ENV.CI_JOB_URL);
+    this.setInfo(this.targets.build_number, ENV.CI_JOB_ID);
+    this.setInfo(this.targets.build_name, ENV.CI_JOB_NAME);
+    this.setInfo(this.targets.build_reason, ENV.CI_PIPELINE_SOURCE);
+
+    if (ENV.CI_OPEN_MERGE_REQUESTS) {
+      const pr_number = ENV.CI_OPEN_MERGE_REQUESTS.split("!")[1];
+      this.setInfo(this.targets.pull_request_name, "#" + pr_number);
+      this.setInfo(this.targets.pull_request_url, ENV.CI_PROJECT_URL + "/-/merge_requests/" + pr_number);
+    }
+  }
+}
+
+module.exports = {
+  GitLabCI
+}

package/src/helpers/ci/index.js

@@ -0,0 +1,45 @@
+const { GitHubCI } = require('./github');
+const { GitLabCI } = require('./gitlab');
+const { JenkinsCI } = require('./jenkins');
+const { AzureDevOpsCI } = require('./azure-devops');
+const { CircleCI } = require('./circle-ci');
+const { BaseCI } = require('./base.ci');
+
+const ENV = process.env;
+
+/**
+ * @returns {import('../../extensions/extensions').ICIInfo}
+ */
+function getCIInformation() {
+  if (ENV.GITHUB_ACTIONS) {
+    const ci = new GitHubCI();
+    return ci.info();
+  }
+
+  if (ENV.GITLAB_CI) {
+    const ci = new GitLabCI();
+    return ci.info();
+  }
+
+  if (ENV.JENKINS_URL) {
+    const ci = new JenkinsCI();
+    return ci.info();
+  }
+
+  if (ENV.SYSTEM_TEAMFOUNDATIONCOLLECTIONURI) {
+    const ci = new AzureDevOpsCI();
+    return ci.info();
+  }
+
+  if (ENV.CIRCLECI) {
+    const ci = new CircleCI();
+    return ci.info();
+  }
+
+  const ci = new BaseCI();
+  return ci.info();
+}
+
+module.exports = {
+  getCIInformation
+}

package/src/helpers/ci/jenkins.js

@@ -0,0 +1,36 @@
+const { BaseCI } = require('./base.ci');
+
+const ENV = process.env;
+
+class JenkinsCI extends BaseCI {
+  constructor() {
+    super();
+    this.init();
+  }
+
+  init() {
+    this.setInfo(this.targets.ci, 'JENKINS');
+    this.setInfo(this.targets.git, '');
+    this.setInfo(this.targets.repository_url, ENV.GIT_URL || ENV.GITHUB_URL || ENV.BITBUCKET_URL);
+    this.setInfo(this.targets.repository_name, ENV.JOB_NAME);
+    this.setInfo(this.targets.repository_ref, ENV.BRANCH || ENV.BRANCH_NAME);
+    this.setInfo(this.targets.repository_commit_sha, ENV.GIT_COMMIT || ENV.GIT_COMMIT_SHA || ENV.GITHUB_SHA || ENV.BITBUCKET_COMMIT);
+    this.setInfo(this.targets.branch_url, this.repository_url + this.repository_ref.replace('refs/heads/', '/tree/'));
+    this.setInfo(this.targets.branch_name, this.repository_ref.replace('refs/heads/', ''));
+
+    if (this.repository_ref.includes('refs/pull')) {
+      this.setInfo(this.targets.pull_request_url, this.repository_url + this.repository_ref.replace('refs/pull/', '/pull/'));
+      this.setInfo(this.targets.pull_request_name, this.repository_ref.replace('refs/pull/', '').replace('/merge', ''));
+    }
+
+    this.setInfo(this.targets.build_url, ENV.BUILD_URL);
+    this.setInfo(this.targets.build_number, ENV.BUILD_NUMBER);
+    this.setInfo(this.targets.build_name, ENV.JOB_NAME);
+    this.setInfo(this.targets.build_reason, ENV.BUILD_CAUSE);
+    this.setInfo(this.targets.user, ENV.USER || ENV.USERNAME, true);
+  }
+}
+
+module.exports = {
+  JenkinsCI
+}

package/src/helpers/constants.js

@@ -24,6 +24,7 @@ const EXTENSION = Object.freeze({
   FAILURE_ANALYSIS: 'failure-analysis',
   SMART_ANALYSIS: 'smart-analysis',
   ERROR_CLUSTERS: 'error-clusters',
+  BROWSERSTACK: 'browserstack',
   HYPERLINKS: 'hyperlinks',
   MENTIONS: 'mentions',
   REPORT_PORTAL_ANALYSIS: 'report-portal-analysis',
@@ -37,7 +38,8 @@ const EXTENSION = Object.freeze({
 
 const URLS = Object.freeze({
   PERCY: 'https://percy.io',
-  QUICK_CHART: 'https://quickchart.io'
+  QUICK_CHART: 'https://quickchart.io',
+  BROWSERSTACK: 'https://api.browserstack.com'
 });
 
 const PROCESS_STATUS = Object.freeze({

package/src/helpers/helper.js

@@ -14,18 +14,11 @@ function getPercentage(x, y) {
 function processText(raw) {
   const dataRefMatches = raw.match(DATA_REF_PATTERN);
   if (dataRefMatches) {
-    const values = [];
     for (let i = 0; i < dataRefMatches.length; i++) {
       const dataRefMatch = dataRefMatches[i];
       const content = dataRefMatch.slice(1, -1);
-      if (process.env[content]) {
-        values.push(process.env[content]);
-      } else {
-        values.push(content);
-      }
-    }
-    for (let i = 0; i < dataRefMatches.length; i++) {
-      raw = raw.replace(dataRefMatches[i], values[i]);
+      const envValue = process.env[content] || content;
+      raw = raw.replace(dataRefMatch, envValue);
     }
   }
   return raw;

package/src/index.d.ts

@@ -2,7 +2,7 @@ import { PerformanceParseOptions } from 'performance-results-parser';
 import PerformanceTestResult from 'performance-results-parser/src/models/PerformanceTestResult';
 import { Schedule, User } from 'rosters';
 import { ParseOptions } from 'test-results-parser';
-import TestResult from 'test-results-parser/src/models/TestResult';
+export import TestResult from 'test-results-parser/src/models/TestResult';
 
 export interface ITarget {
   name: TargetName;
@@ -17,7 +17,7 @@ export interface IExtension {
   enable?: string | boolean;
   condition?: Condition;
   hook?: Hook;
-  inputs?: ReportPortalAnalysisInputs | ReportPortalHistoryInputs | HyperlinkInputs | MentionInputs | QuickChartTestSummaryInputs | PercyAnalysisInputs | CustomExtensionInputs | MetadataInputs | CIInfoInputs | AIFailureSummaryInputs;
+  inputs?: ReportPortalAnalysisInputs | ReportPortalHistoryInputs | HyperlinkInputs | MentionInputs | QuickChartTestSummaryInputs | PercyAnalysisInputs | CustomExtensionInputs | MetadataInputs | CIInfoInputs | AIFailureSummaryInputs | BrowserstackInputs;
 }
 
 export type ExtensionName = 'report-portal-analysis' | 'hyperlinks' | 'mentions' | 'report-portal-history' | 'quick-chart-test-summary' | 'metadata' | 'ci-info' | 'custom' | 'ai-failure-summary';
@@ -83,7 +83,51 @@ export interface AIFailureSummaryInputs extends ExtensionInputs {
   failure_summary: string;
 }
 
+export interface BrowserStackAutomationBuild {
+  name: string;
+  hashed_id: string;
+  duration: number;
+  status: string;
+  build_tag: string;
+  public_url: string;
+}
 
+export interface BrowserStackAutomationSession {
+  name: string;
+  duration: number;
+  os: string;
+  os_version: string;
+  browser_version: string;
+  browser: string;
+  device: string;
+  status: string;
+  hashed_id: string;
+  reason: string;
+  build_name: string;
+  project_name: string;
+  build_hashed_id: string;
+  test_priority: string;
+  logs: string;
+  browserstack_status: string;
+  created_at: string;
+  browser_url: string;
+  public_url: string;
+  video_url: string;
+  browser_console_logs_url: string;
+  har_logs_url: string;
+  selenium_logs_url: string;
+  session_terminal_logs_url: string;
+  build_terminal_logs_url: string;
+}
+
+export interface BrowserstackInputs extends ExtensionInputs {
+  url?: string;
+  username?: string;
+  access_key?: string;
+  automation_build_name?: string;
+  automation_build?: BrowserStackAutomationBuild;
+  automation_sessions?: BrowserStackAutomationSession[];
+}
 
 export interface PercyAnalysisInputs extends ExtensionInputs {
   url?: string;

package/src/index.js

@@ -1,15 +1,22 @@
 const { PublishCommand } = require('./commands/publish.command');
+const { GenerateConfigCommand } = require('./commands/generate-config.command');
 
 function publish(options) {
   const publish_command = new PublishCommand(options);
   return publish_command.publish();
 }
 
+function generateConfig() {
+  const generate_command = new GenerateConfigCommand();
+  return generate_command.execute();
+}
+
 function defineConfig(config) {
-  return config
+  return config;
 }
 
 module.exports = {
   publish,
+  generateConfig,
   defineConfig
 }

package/src/setups/extensions.setup.js

@@ -0,0 +1,62 @@
+const { getAutomationBuilds, getAutomationBuildSessions } = require('../helpers/browserstack.helper');
+
+class ExtensionsSetup {
+  constructor(extensions, result) {
+    this.extensions = extensions;
+    this.result = result;
+  }
+
+  async run() {
+    for (const extension of this.extensions) {
+      if (extension.name === 'browserstack') {
+        const browserStackExtensionSetup = new BrowserStackExtensionSetup(extension.inputs, this.result);
+        await browserStackExtensionSetup.setup();
+      }
+    }
+  }
+}
+
+class BrowserStackExtensionSetup {
+  constructor(inputs, result) {
+    /** @type {import('../index').BrowserstackInputs} */
+    this.inputs = inputs;
+    this.result = result;
+  }
+
+  async setup() {
+    const build_rows = await getAutomationBuilds(this.inputs);
+    if (!Array.isArray(build_rows) || build_rows.length === 0) {
+      throw new Error('No builds found');
+    }
+    const automation_build = build_rows.find(_ => _.automation_build.name === this.inputs.automation_build_name);
+    if (!automation_build) {
+      throw new Error(`Build ${this.inputs.automation_build_name} not found`);
+    }
+    this.inputs.automation_build = automation_build.automation_build;
+    if (this.result) {
+      this.result.metadata = this.result.metadata || {};
+      this.result.metadata.ext_browserstack_automation_build = automation_build.automation_build;
+    }
+    this.inputs.automation_sessions = [];
+    const session_rows = await getAutomationBuildSessions(this.inputs, automation_build.automation_build.hashed_id);
+    if (!Array.isArray(session_rows) || session_rows.length === 0) {
+      throw new Error('No sessions found');
+    }
+    for (const session_row of session_rows) {
+      this.inputs.automation_sessions.push(session_row.automation_session);
+    }
+    if (this.result && this.result.suites && this.result.suites.length > 0) {
+      for (const suite of this.result.suites) {
+        const automation_session = this.inputs.automation_sessions.filter(_ => { _.name === suite.name })[0];
+        if (automation_session) {
+          suite.metadata = suite.metadata || {};
+          suite.metadata.ext_browserstack_automation_session = automation_session;
+        }
+      }
+    }
+  }
+}
+
+module.exports = {
+  ExtensionsSetup
+}