add: unit tests

Author: 07souravkunda

bin/helpers/utils.js

@@ -22,7 +22,7 @@ const usageReporting = require("./usageReporting"),
   config = require("../helpers/config"),
   pkg = require('../../package.json'),
   transports = require('./logger').transports,
-  { findGitConfig, printBuildLink, isTestObservabilitySession, isBrowserstackInfra, shouldReRunObservabilityTests } = require('../testObservability/helper/helper'),
+  o11yHelpers = require('../testObservability/helper/helper'),
   { OBSERVABILITY_ENV_VARS, TEST_OBSERVABILITY_REPORTER } = require('../testObservability/helper/constants');
 
 const request = require('request');
@@ -480,7 +480,7 @@ exports.setNodeVersion = (bsConfig, args) => {
 // specs can be passed via command line args as a string
 // command line args takes precedence over config
 exports.setUserSpecs = (bsConfig, args) => {
-  if(isBrowserstackInfra() && isTestObservabilitySession() && shouldReRunObservabilityTests()) {
+  if(o11yHelpers.isBrowserstackInfra() && o11yHelpers.isTestObservabilitySession() && o11yHelpers.shouldReRunObservabilityTests()) {
     bsConfig.run_settings.specs = process.env.BROWSERSTACK_RERUN_TESTS;
     return;
   }
@@ -580,8 +580,8 @@ exports.setSystemEnvs = (bsConfig) => {
       envKeys[key] = process.env[key];
     });
 
-    let gitConfigPath = findGitConfig(process.cwd());
-    if(!isBrowserstackInfra()) process.env.OBSERVABILITY_GIT_CONFIG_PATH_LOCAL = gitConfigPath;
+    let gitConfigPath = o11yHelpers.findGitConfig(process.cwd());
+    if(!o11yHelpers.isBrowserstackInfra()) process.env.OBSERVABILITY_GIT_CONFIG_PATH_LOCAL = gitConfigPath;
     if(gitConfigPath) {
       const relativePathFromGitConfig = path.relative(gitConfigPath, process.cwd());
       envKeys["OBSERVABILITY_GIT_CONFIG_PATH"] = relativePathFromGitConfig ? relativePathFromGitConfig : 'DEFAULT';
@@ -1184,8 +1184,8 @@ exports.handleSyncExit = (exitCode, dashboard_url) => {
     syncCliLogger.info(Constants.userMessages.BUILD_REPORT_MESSAGE);
     syncCliLogger.info(dashboard_url);
   }
-  if(isTestObservabilitySession()) {
-    printBuildLink(true, exitCode);
+  if(o11yHelpers.isTestObservabilitySession()) {
+    o11yHelpers.printBuildLink(true, exitCode);
   } else {
     process.exit(exitCode);
   }
@@ -1288,7 +1288,7 @@ exports.setConfig = (bsConfig, args) => {
 
 // blindly send other passed configs with run_settings and handle at backend
 exports.setOtherConfigs = (bsConfig, args) => {
-  if(isTestObservabilitySession() && process.env.BS_TESTOPS_JWT) {
+  if(o11yHelpers.isTestObservabilitySession() && process.env.BS_TESTOPS_JWT) {
     bsConfig["run_settings"]["reporter"] = TEST_OBSERVABILITY_REPORTER;
     return;
   }
@@ -1472,15 +1472,15 @@ async function processExitHandler(exitData){
   logger.warn(Constants.userMessages.PROCESS_KILL_MESSAGE);
   await this.stopBrowserStackBuild(exitData.bsConfig, exitData.args, exitData.buildId, null, exitData.buildReportData);
   await this.stopLocalBinary(exitData.bsConfig, exitData.bsLocalInstance, exitData.args, null, exitData.buildReportData);
-  await printBuildLink(true);
+  await o11yHelpers.printBuildLink(true);
   process.exit(0);
 }
 
 async function processO11yExitHandler(exitData){
   if (exitData.buildId) {
-    await printBuildLink(false);
+    await o11yHelpers.printBuildLink(false);
   } else {
-    await printBuildLink(true);
+    await o11yHelpers.printBuildLink(true);
   }
 }
 

test/unit/bin/helpers/utils.js

@@ -21,7 +21,8 @@ const utils = require('../../../../bin/helpers/utils'),
   fileHelpers = require('../../../../bin/helpers/fileHelpers'),
   testObjects = require('../../support/fixtures/testObjects'),
   syncLogger = require('../../../../bin/helpers/logger').syncCliLogger,
-  Contants = require('../../../../bin/helpers/constants');
+  Contants = require('../../../../bin/helpers/constants'),
+  o11yHelpers = require('../../../../bin/testObservability/helper/helper');
 const browserstack = require('browserstack-local');
 const { CYPRESS_V10_AND_ABOVE_TYPE, CYPRESS_V9_AND_OLDER_TYPE } = require('../../../../bin/helpers/constants');
 const { winstonLogger, syncCliLogger } = require('../../../../bin/helpers/logger');
@@ -3396,6 +3397,72 @@ describe('utils', () => {
     });
   });
 
+  describe('setO11yProcessHooks', () => {
+    it('should handle multiple calls', (done) => {
+      let buildId = null;
+      let bsConfig = testObjects.sampleBsConfig;
+      let bsLocalStub = sinon.stub();
+      let args= {};
+
+      let printBuildLinkStub = sinon.stub(o11yHelpers, 'printBuildLink').returns(Promise.resolve(true));
+      let processOnSpy = sinon.spy(process, 'on');
+
+      utils.setO11yProcessHooks(buildId, bsConfig, bsLocalStub, args);
+      sinon.assert.calledOnce(processOnSpy);
+      processOnSpy.restore();
+      processOnSpy = sinon.spy(process, 'on');
+      utils.setO11yProcessHooks('build_id', bsConfig, bsLocalStub, args);
+      sinon.assert.notCalled(processOnSpy);
+      processOnSpy.restore();
+      process.on('beforeExit', () => {
+        sinon.assert.calledOnce(printBuildLinkStub);
+        sinon.assert.calledWith(printBuildLinkStub, false);
+        done();
+      });
+      process.emit('beforeExit');
+      printBuildLinkStub.restore();
+      sinon.stub.restore();
+    });
+
+    it('should handle "beforeExit" event, with build id', (done) => {
+      let buildId = 'build_id';
+      let bsConfig = testObjects.sampleBsConfig;
+      let bsLocalStub = sinon.stub();
+      let args= {};
+
+      let printBuildLinkStub = sinon.stub(o11yHelpers, 'printBuildLink').returns(Promise.resolve(true));
+
+      utils.setO11yProcessHooks(buildId, bsConfig, bsLocalStub, args);
+      process.on('beforeExit', () => {
+        sinon.assert.calledOnce(printBuildLinkStub);
+        sinon.assert.calledWith(printBuildLinkStub, false);
+        done();
+      });
+      process.emit('beforeExit');
+      printBuildLinkStub.restore();
+      sinon.stub.restore();
+    });
+
+    it('should handle "beforeExit" event, without build id', (done) => {
+      let buildId = null;
+      let bsConfig = testObjects.sampleBsConfig;
+      let bsLocalStub = sinon.stub();
+      let args= {};
+
+      let printBuildLinkStub = sinon.stub(o11yHelpers, 'printBuildLink').returns(Promise.resolve(true));
+
+      utils.setO11yProcessHooks(buildId, bsConfig, bsLocalStub, args);
+      process.on('beforeExit', () => {
+        sinon.assert.calledOnce(printBuildLinkStub);
+        sinon.assert.calledWith(printBuildLinkStub, true);
+        done();
+      });
+      process.emit('beforeExit');
+      printBuildLinkStub.restore();
+      sinon.stub.restore();
+    });
+  });
+
   describe('fetchZipSize', () => {
     it('should return size in bytes if file is present', () => {
       sinon.stub(fs, 'statSync').returns({size: 123});