@testrevolution/bugbug-cli 8.14.6 → 8.16.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@testrevolution/bugbug-cli",
   "description": "BugBug CLI",
-  "version": "8.14.6",
+  "version": "8.16.0",
   "keywords": [
     "automation",
     "cli",

package/src/__mocks__/api.js

@@ -41,6 +41,12 @@ module.exports = {
       webappUrl: 'http://localhost:3000/organizations/ed67dc98-16be-48d5-97fe-2f579ca6a62a/projects/cli-cc3abe1c-4540-4451-8bdc-41ac893e5720/runs-history/tests/cabe0d21-7693-4953-8851-581554a70368/',
     },
   },
+  stopTestRunRunSuccess: {
+    data: {
+      id: '95a37d6a-a7a5-42ae-8fe3-336a120b807b',
+      status: 'stopped',
+    },
+  },
   getResultTestRunSuccess: {
     data: {
       details: [{

package/src/__tests__/commands.spec.js

@@ -21,13 +21,12 @@ beforeAll(() => {
 afterAll(() => {
   config.__RewireAPI__.__ResetDependency__('readConfig');
 });
+jest.mock('axios');
 
 afterEach(() => {
   jest.restoreAllMocks();
 });
 
-jest.mock('axios');
-
 describe('commands module', () => {
   describe('help', () => {
     it('should console log main help menu', async () => {

package/src/__tests__/commands.stop.spec.js

@@ -0,0 +1,95 @@
+const axios = require('axios');
+
+const {
+  remote: remoteCommand,
+} = require('../commands');
+const settings = require('../settings');
+const config = require('../utils/config');
+// eslint-disable-next-line jest/no-mocks-import
+const apiMocks = require('../__mocks__/api');
+
+const configValue = { item: 'value', token: '1337' };
+
+beforeAll(() => {
+  // rewire discussion
+  // https://github.com/facebook/jest/issues/936#issuecomment-545080082
+  config.__RewireAPI__.__Rewire__('readConfig', jest.fn().mockReturnValue(configValue));
+});
+
+afterAll(() => {
+  config.__RewireAPI__.__ResetDependency__('readConfig');
+});
+jest.mock('axios');
+
+afterEach(() => {
+  jest.restoreAllMocks();
+});
+
+describe('commands stop module', () => {
+  beforeAll(() => {
+    settings.API_POLLING_INTERVAL = 1;
+    settings.API_POLLING_MAX_RETRY_TIMES = 5;
+    settings.API_URL = 'https://bugbug.io/test-api/';
+  });
+
+  it('should return error when testRunId is missing', async () => {
+    const consoleLogSpy = jest.spyOn(console, 'error').mockImplementation();
+    const args = {
+      _: ['remote', 'stop', 'test'],
+      noprogress: true,
+    };
+    await remoteCommand(args);
+
+    expect(consoleLogSpy).toHaveBeenNthCalledWith(1, 'Missing testRun id.');
+  });
+
+  it('stop test command should call API', async () => {
+    const consoleLogSpy = jest.spyOn(console, 'error').mockImplementation();
+    axios.mockResolvedValueOnce(apiMocks.stopTestRunRunSuccess);
+    const id = '95a37d6a-a7a5-42ae-8fe3-336a120b807b';
+    const args = {
+      _: ['remote', 'stop', 'test', id],
+      noprogress: true,
+    };
+    await remoteCommand(args);
+
+    expect(consoleLogSpy).toHaveBeenNthCalledWith(1, `Status: ${apiMocks.stopTestRunRunSuccess.data.status}`);
+    expect(axios).toHaveBeenCalledWith({
+      method: 'POST',
+      url: `https://bugbug.io/test-api/v1/testruns/${id}/stop/`,
+      data: { triggeredBy: 'cli' },
+      params: {},
+      headers: { Authorization: `Token ${configValue.token}`, 'User-Agent': settings.USER_AGENT },
+    });
+  });
+
+  it('stop test action should call stopTestRun function', async () => {
+    const stopMock = jest.fn();
+    remoteCommand.__RewireAPI__.__Rewire__('stopTestRun', stopMock);
+
+    const id = '95a37d6a-a7a5-42ae-8fe3-336a120b807b';
+    const args = {
+      _: ['remote', 'stop', 'test', id],
+      noprogress: true,
+    };
+    await remoteCommand(args);
+    expect(stopMock).toHaveBeenCalledWith(id, {
+      noprogress: true, nowait: false, outputPath: 'test-report.xml', reporter: 'inline', triggeredBy: 'cli', withDetails: false,
+    });
+  });
+
+  it('stop suite action should call stopSuiteRun function', async () => {
+    const stopMock = jest.fn();
+    remoteCommand.__RewireAPI__.__Rewire__('stopSuiteRun', stopMock);
+
+    const id = '95a37d6a-a7a5-42ae-8fe3-336a120b807b';
+    const args = {
+      _: ['remote', 'stop', 'suite', id],
+      noprogress: true,
+    };
+    await remoteCommand(args);
+    expect(stopMock).toHaveBeenCalledWith(id, {
+      noprogress: true, nowait: false, outputPath: 'test-report.xml', reporter: 'inline', triggeredBy: 'cli', withDetails: false,
+    });
+  });
+});

package/src/commands/help.js

@@ -23,6 +23,7 @@ const help = {
     * run [test|suite] <string:testId|suiteId> [--no-wait] [--no-progress] [--debug] [--with-details] [--profile] [--variable] [--result-timeout <int>]
     * status [test|suite] <string:testRunId|suiteRunId> [--no-progress] [--debug]
     * result [test|suite] <string:testRunId|suiteRunId> [--no-progress] [--debug] [--with-details] [--result-timeout <int>]
+    * stop [test|suite] <string:testRunId|suiteRunId> [--no-progress] [--debug] [--result-timeout <int>]
 
     optional flags:
     * --debug - show more data (like raw API response)

package/src/commands/remote.js

@@ -128,6 +128,33 @@ const run = async (type, data, extraParams) => {
   return getExitCode(false);
 };
 
+const stop = async (type, { id }, extraParams) => {
+  const { noprogress } = extraParams;
+  const route = settings.API_ROUTING[`${type}Stop`];
+  const spinner = getSpinner(noprogress);
+
+  if (!id) {
+    spinner.fail(`Missing ${type}Run id.`);
+    return getExitCode(false);
+  }
+
+  const path = format(route.path, id);
+
+  try {
+    const response = await apiCall(path, route.method, {}, {}, extraParams.triggeredBy);
+    printStatus(spinner, response.data.status);
+
+    return getExitCode(true);
+  } catch (error) {
+    if (error.response?.status === 404) {
+      spinner.fail(`No ${type}Run with id ${id} found.`);
+    } else {
+      await printErrorResponse(spinner, error);
+    }
+  }
+  return getExitCode(false);
+};
+
 const runTest = async (testId, profileName, variables, extraParams) => run(settings.TYPE_TEST, {
   test_id: testId, profile_name: profileName, variables,
 }, extraParams);
@@ -136,6 +163,14 @@ const runSuite = async (suiteId, profileName, variables, extraParams) => run(set
   suite_id: suiteId, profile_name: profileName, variables,
 }, extraParams);
 
+const stopTestRun = async (testRunId, extraParams) => stop(settings.TYPE_TEST, {
+  id: testRunId,
+}, extraParams);
+
+const stopSuiteRun = async (suiteRunId, extraParams) => stop(settings.TYPE_SUITE, {
+  id: suiteRunId,
+}, extraParams);
+
 const checkTokenConfig = async () => {
   try {
     if (await getConfigValue('token') === undefined) {
@@ -223,6 +258,13 @@ module.exports = async (args) => {
     case settings.ACTION_STATUS:
       exitCode = await checkStatus(objectType, id, extraParams);
       break;
+    case settings.ACTION_STOP:
+      if (objectType === settings.TYPE_TEST) {
+        exitCode = await stopTestRun(id, extraParams);
+      } else if (objectType === settings.TYPE_SUITE) {
+        exitCode = await stopSuiteRun(id, extraParams);
+      }
+      break;
     case settings.ACTION_RESULT:
       exitCode = await getResult(objectType, id, extraParams);
       break;

package/src/settings.js

@@ -25,6 +25,7 @@ const ACTION_HELP = 'help';
 const ACTION_SET_TOKEN = 'set-token';
 const ACTION_LIST = 'list';
 const ACTION_RUN = 'run';
+const ACTION_STOP = 'stop';
 const ACTION_STATUS = 'status';
 const ACTION_RESULT = 'result';
 
@@ -35,10 +36,12 @@ const API_ROUTING = {
   suiteResult: { method: 'GET', path: `${API_VERSION}/suiteruns/%s/` },
   suiteRun: { method: 'POST', path: `${API_VERSION}/suiteruns/` },
   suiteStatus: { method: 'GET', path: `${API_VERSION}/suiteruns/%s/status/` },
+  suiteStop: { method: 'POST', path: `${API_VERSION}/suiteruns/%s/stop/` },
   testList: { method: 'GET', path: `${API_VERSION}/tests/` },
   testResult: { method: 'GET', path: `${API_VERSION}/testruns/%s/` },
   testRun: { method: 'POST', path: `${API_VERSION}/testruns/` },
   testStatus: { method: 'GET', path: `${API_VERSION}/testruns/%s/status/` },
+  testStop: { method: 'POST', path: `${API_VERSION}/testruns/%s/stop/` },
 };
 
 const API_POLLING_MODIFIED_INTERVAL = 120000; // 120 seconds
@@ -81,6 +84,7 @@ module.exports = {
   ACTION_RUN,
   ACTION_SET_TOKEN,
   ACTION_STATUS,
+  ACTION_STOP,
   API_CALL_RETRIES,
   API_CALL_RETRY_DELAY,
   API_ERROR_QUOTA_EXCEEDED,