@zebrunner/javascript-agent-mocha/lib/request-builder.js

Zebrunner Agent for Mocha

const { v4: uuidv4 } = require('uuid');
const { testSessionStatuses } = require('./constants');
const { isEmptyObject } = require('./utils');
const ConfigResolver = require('./config-resolver');

const API_URLS = {
  URL_REFRESH: '/api/iam/v1/auth/refresh',

  URL_EXCHANGE_RUN_CONTEXT: '/api/reporting/v1/run-context-exchanges',
  URL_START_RUN: '/api/reporting/v1/test-runs?projectKey=${project}',
  URL_FINISH_RUN: '/api/reporting/v1/test-runs/',

  URL_START_TEST: '/api/reporting/v1/test-runs/${testRunId}/tests',
  URL_UPDATE_TEST: '/api/reporting/v1/test-runs/${testRunId}/tests/${testId}',
  URL_FINISH_TEST: '/api/reporting/v1/test-runs/${testRunId}/tests/${testId}',
  URL_REVERT_TEST_REGISTRATION: '/api/reporting/v1/test-runs/${testRunId}/tests/${testId}',

  URL_START_SESSION: '/api/reporting/v1/test-runs/${testRunId}/test-sessions',
  URL_UPDATE_SESSION: '/api/reporting/v1/test-runs/${testRunId}/test-sessions/${testSessionId}',
  URL_FINISH_SESSION: '/api/reporting/v1/test-runs/${testRunId}/test-sessions/${testSessionId}',

  URL_SEND_LOGS: '/api/reporting/v1/test-runs/${testRunId}/logs',
  URL_SEND_SCREENSHOT: '/api/reporting/v1/test-runs/${testRunId}/tests/${testId}/screenshots',

  URL_ATTACH_TEST_RUN_LABELS: '/api/reporting/v1/test-runs/${testRunId}/labels',
  URL_ATTACH_TEST_LABELS: '/api/reporting/v1/test-runs/${testRunId}/tests/${testId}/labels',

  URL_ATTACH_TEST_RUN_ARTIFACT_REFERENCES:
    '/api/reporting/v1/test-runs/${testRunId}/artifact-references',
  URL_ATTACH_TEST_ARTIFACT_REFERENCES:
    '/api/reporting/v1/test-runs/${testRunId}/tests/${testId}/artifact-references',

  URL_UPLOAD_TEST_RUN_ARTIFACT: '/api/reporting/v1/test-runs/${testRunId}/artifacts',
  URL_UPLOAD_TEST_ARTIFACT: '/api/reporting/v1/test-runs/${testRunId}/tests/${testId}/artifacts',

  URL_UPDATE_TCM_CONFIGS: '/api/reporting/v1/test-runs/${testRunId}/tcm-configs',
  URL_UPSERT_TEST_TEST_CASES:
    '/api/reporting/v1/test-runs/${testRunId}/tests/${testId}/test-cases:upsert',
};

const getRefreshToken = (token) => ({
  refreshToken: token,
});

const getTestRunStart = (reporterConfig, testRunUuid = null) => {
  const configResolver = new ConfigResolver(reporterConfig);

  const testRunStartBody = {
    uuid: testRunUuid || uuidv4(),
    name: configResolver.getReportingRunDisplayName(),
    startedAt: new Date(),
    status: 'IN_PROGRESS',
    framework: 'mocha',
    config: {
      treatSkipsAsFailures: configResolver.getReportingTreatSkipsAsFailures(),
    },
    milestone: {},
    notifications: {
      notifyOnEachFailure: configResolver.getReportingNotificationOnEachFailure(),
      targets: [],
    },
  };

  if (configResolver.getReportingRunEnvironment()) {
    testRunStartBody.config.environment = configResolver.getReportingRunEnvironment();
  }

  if (configResolver.getReportingRunBuild()) {
    testRunStartBody.config.build = configResolver.getReportingRunBuild();
  }

  if (configResolver.getReportingMilestoneId()) {
    testRunStartBody.milestone.id = configResolver.getReportingMilestoneId();
  }

  if (configResolver.getReportingMilestoneName()) {
    testRunStartBody.milestone.name = configResolver.getReportingMilestoneName();
  }

  if (configResolver.getReportingNotificationSlackChannels()) {
    testRunStartBody.notifications.targets.push({
      type: 'SLACK_CHANNELS',
      value: configResolver.getReportingNotificationSlackChannels(),
    });
  }

  if (configResolver.getReportingNotificationMsTeamsChannels()) {
    testRunStartBody.notifications.targets.push({
      type: 'MS_TEAMS_CHANNELS',
      value: configResolver.getReportingNotificationMsTeamsChannels(),
    });
  }

  if (configResolver.getReportingNotificationEmails()) {
    testRunStartBody.notifications.targets.push({
      type: 'EMAIL_RECIPIENTS',
      value: configResolver.getReportingNotificationEmails(),
    });
  }

  return testRunStartBody;
};

const getTestRunEnd = () => ({
  endedAt: new Date(),
});

const getTestStart = (test) => ({
  name: test.fullTitle,
  startedAt: new Date(),
  className: test.testFileName,
  methodName: test.title,
  testGroups: test.testGroups,
});

const setMaintainer = (maintainer) => ({
  maintainer,
});

const getTestEnd = (test) => ({
  endedAt: new Date(),
  result: test.status,
  reason: test.reason,
});

const getTestSessionStart = (session) => ({
  sessionId: session.sessionId,
  initiatedAt: new Date(),
  startedAt: new Date(),
  status: testSessionStatuses.RUNNING,
  desiredCapabilities: session.desiredCapabilities,
  capabilities: session.capabilities,
});

const getTestSessionUpdate = (testIds) => ({
  testIds,
});

const getTestSessionEnd = (testIds) => ({
  endedAt: new Date(),
  testIds,
});

const getAttachLabels = (labels) => ({
  items: [...labels],
});

const getAttachArtifactReferences = (references) => ({
  items: [...references],
});

const getUpsertTestCases = (testCases) => ({
  items: [...testCases],
});

const getUpdateTcmConfigs = (reporterConfig) => {
  const configResolver = new ConfigResolver(reporterConfig);

  const updateTcmConfigsBody = {};

  if (!isEmptyObject(configResolver.getReportingTcmZebrunner())) {
    const zebrunnerConfig = configResolver.getReportingTcmZebrunner();
    updateTcmConfigsBody.zebrunnerSyncEnabled = zebrunnerConfig.pushResults;
    updateTcmConfigsBody.zebrunnerSyncRealTime = zebrunnerConfig.pushInRealTime;
    updateTcmConfigsBody.zebrunnerTestRunId = zebrunnerConfig.testRunId;
  }

  if (!isEmptyObject(configResolver.getReportingTcmTestRail())) {
    const testRailConfig = configResolver.getReportingTcmTestRail();
    updateTcmConfigsBody.testRailSyncEnabled = testRailConfig.pushResults;
    updateTcmConfigsBody.testRailSyncRealTime = testRailConfig.pushInRealTime;
    updateTcmConfigsBody.testRailSuiteId = testRailConfig.suiteId;
    updateTcmConfigsBody.testRailRunId = testRailConfig.runId;
    updateTcmConfigsBody.testRailIncludeAllCases = testRailConfig.includeAllTestCasesInNewRun;
    updateTcmConfigsBody.testRailRunName = testRailConfig.runName;
    updateTcmConfigsBody.testRailAssignee = testRailConfig.assignee;
    updateTcmConfigsBody.testRailMilestoneName = testRailConfig.milestoneName;
  }

  if (!isEmptyObject(configResolver.getReportingTcmXray())) {
    const xrayConfig = configResolver.getReportingTcmXray();
    updateTcmConfigsBody.xraySyncEnabled = xrayConfig.pushResults;
    updateTcmConfigsBody.xraySyncRealTime = xrayConfig.pushInRealTime;
    updateTcmConfigsBody.xrayTestExecutionKey = xrayConfig.executionKey;
  }

  if (!isEmptyObject(configResolver.getReportingTcmZephyr())) {
    const zephyrConfig = configResolver.getReportingTcmZephyr();
    updateTcmConfigsBody.zephyrSyncEnabled = zephyrConfig.pushResults;
    updateTcmConfigsBody.zephyrSyncRealTime = zephyrConfig.pushInRealTime;
    updateTcmConfigsBody.zephyrTestCycleKey = zephyrConfig.testCycleKey;
    updateTcmConfigsBody.zephyrJiraProjectKey = zephyrConfig.jiraProjectKey;
  }

  return updateTcmConfigsBody;
};

module.exports = {
  API_URLS,
  getRefreshToken,
  getTestRunStart,
  getTestRunEnd,
  getTestStart,
  setMaintainer,
  getTestEnd,
  getTestSessionStart,
  getTestSessionUpdate,
  getTestSessionEnd,
  getAttachLabels,
  getAttachArtifactReferences,
  getUpsertTestCases,
  getUpdateTcmConfigs,
};