Add: test cases

Author: nagpalkaran95

bin/helpers/atsHelper.js

@@ -1,5 +1,3 @@
-// TODO: confirm if we need to add command line args. if yes then decide priority
-
 const request = require('request'),
       logger = require('./logger').winstonLogger,
       utils = require('./utils'),
@@ -59,7 +57,7 @@ exports.getTurboScaleGridDetails = async (bsConfig) => {
       request.get(options, function (err, resp, data) {
         if(err) {
           logger.warn(utils.formatRequest(err, resp, data));
-          utils.sendUsageReport(bsConfig, args, err, Constants.messageTypes.ERROR, 'get_initial_details_failed', null, rawArgs);
+          utils.sendUsageReport(bsConfig, args, err, Constants.messageTypes.ERROR, 'get_ats_details_failed', null, rawArgs);
           resolve({});
         } else {
           try {
@@ -69,7 +67,7 @@ exports.getTurboScaleGridDetails = async (bsConfig) => {
           }
           if(resp.statusCode != 200) {
             logger.warn(`Warn: Get Initial Details Request failed with status code ${resp.statusCode}`);
-            utils.sendUsageReport(bsConfig, args, responseData["error"], Constants.messageTypes.ERROR, 'get_initial_details_failed', null, rawArgs);
+            utils.sendUsageReport(bsConfig, args, responseData["error"], Constants.messageTypes.ERROR, 'get_ats_details_failed', null, rawArgs);
             resolve({});
           }
           resolve(responseData);

test/unit/bin/helpers/atsHelper.js

@@ -0,0 +1,113 @@
+const { expect } = require("chai");
+const chai = require("chai"),
+  chaiAsPromised = require("chai-as-promised"),
+  sinon = require('sinon'),
+  request = require('request');
+
+const logger = require("../../../../bin/helpers/logger").winstonLogger,
+  testObjects = require("../../support/fixtures/testObjects"),
+  utils = require('../../../../bin/helpers/utils'),
+  atsHelper = require('../../../../bin/helpers/atsHelper');
+
+chai.use(chaiAsPromised);
+logger.transports["console.info"].silent = true;
+
+describe('#atsHelper', () => {
+  let bsConfig = testObjects.sampleBsConfig;
+  let sendUsageReportStub = null, requestStub = null;
+
+  beforeEach(() => {
+    sendUsageReportStub = sinon.stub(utils, 'sendUsageReport');
+    requestStub = sinon.stub(request, "get");
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  describe('#isTurboScaleSession', () => {
+    it('return true if env var set to true', () => {
+      process.env.BROWSERSTACK_TURBOSCALE = "true";
+      expect(atsHelper.isTurboScaleSession(bsConfig)).to.be.true;
+      delete BROWSERSTACK_TURBOSCALE;
+    });
+
+    it('return false if env var set to incorrect value', () => {
+      process.env.BROWSERSTACK_TURBOSCALE = "false";
+      expect(atsHelper.isTurboScaleSession(bsConfig)).to.be.false;
+      delete BROWSERSTACK_TURBOSCALE;
+    });
+
+    it('return true if set in config', () => {
+      expect(atsHelper.isTurboScaleSession(testObjects.sampleATSBsConfig)).to.be.true;
+    });
+
+    it('return false if not set in config as well as env var', () => {
+      expect(atsHelper.isTurboScaleSession(bsConfig)).to.be.false;
+    });
+  });
+
+  describe('#getTurboScaleOptions', () => {
+    it('return empty object if not set', () => {
+      expect(atsHelper.getTurboScaleOptions(testObjects.sampleATSBsConfig)).to.deep.include({});
+    });
+
+    it('return obj if set in config', () => {
+      expect(atsHelper.getTurboScaleOptions(testObjects.sampleATSBsConfigWithOptions)).to.deep.include({ gridName: 'abc' });
+    });
+  });
+
+  describe('#getTurboScaleGridName', () => {
+    it('return value set by env var', () => {
+      process.env.BROWSERSTACK_TURBOSCALE_GRID_NAME = "my-grid";
+      expect(atsHelper.getTurboScaleGridName(testObjects.sampleATSBsConfigWithOptions)).to.eq('my-grid');
+      delete process.env.BROWSERSTACK_TURBOSCALE_GRID_NAME;
+    });
+
+    it('return value set in config', () => {
+      expect(atsHelper.getTurboScaleGridName(testObjects.sampleATSBsConfigWithOptions)).to.eq('abc');
+    });
+
+    it('return NO_GRID_NAME_PASSED if value not set in config as well as env var', () => {
+      expect(atsHelper.getTurboScaleGridName(bsConfig)).to.eq('NO_GRID_NAME_PASSED');
+    });
+  });
+
+  describe('#getTurboScaleGridDetails', () => {
+    it('resolve with body', () => {
+      const body = {
+        id: '123',
+        name: 'grid-name',
+        url: 'https://abc.com/wd/hub',
+        playwrightUrl: 'wss://abc.com/playwright',
+        cypressUrl: 'https://abc.com/cypress',
+        isTrialGrid: false,
+        customRepeaters: ''
+      };
+
+      requestStub.yields(null, { statusCode: 200 }, body);
+      sendUsageReportStub.notCalled;
+      atsHelper.getTurboScaleGridDetails(testObjects.sampleATSBsConfigWithOptions).then((result) => {
+        expect(result).to.eq(body);
+      })
+    });
+
+    it('reject with empty object', () => {
+      const body = {
+        id: '123',
+        name: 'grid-name',
+        url: 'https://abc.com/wd/hub',
+        playwrightUrl: 'wss://abc.com/playwright',
+        cypressUrl: 'https://abc.com/cypress',
+        isTrialGrid: false,
+        customRepeaters: ''
+      };
+
+      requestStub.yields(null, { statusCode: 422 }, body);
+      atsHelper.getTurboScaleGridDetails(testObjects.sampleATSBsConfigWithOptions).then((result) => {
+        expect(result).to.eq({});
+        expect(sendUsageReportStub.calledOnce).to.be.true;
+      })
+    });
+  });
+});

test/unit/support/fixtures/testObjects.js

@@ -177,6 +177,35 @@ const runSampleRawArgs = {
   $0: "browserstack-cypress",
 };
 
+const sampleATSBsConfig = {
+  auth: {
+    username: "random-username",
+    access_key: "random-access-key",
+  },
+  run_settings: {
+    cypress_proj_dir: "random path",
+    cypressConfigFilePath: "random path",
+    cypressProjectDir: "random path",
+    turboScale: true,
+  }
+};
+
+const sampleATSBsConfigWithOptions = {
+  auth: {
+    username: "random-username",
+    access_key: "random-access-key",
+  },
+  run_settings: {
+    cypress_proj_dir: "random path",
+    cypressConfigFilePath: "random path",
+    cypressProjectDir: "random path",
+    turboScale: true,
+    turboScaleOptions: {
+      gridName: 'abc'
+    }
+  }
+};
+
 module.exports = Object.freeze({
   sampleBsConfig,
   sampleBsConfigWithParallels,
@@ -194,5 +223,7 @@ module.exports = Object.freeze({
   generateReportInputArgs,
   generateReportInputRawArgs,
   generateDownloadsInputArgs,
-  generateDownloadsInputRawArgs
+  generateDownloadsInputRawArgs,
+  sampleATSBsConfig,
+  sampleATSBsConfigWithOptions
 });