Merge pull request #2 from rchougule/binary_check

code fixes and refactoring for both the actions (review comments).

Author: rchougule

setup-env/dist/index.js

@@ -597,6 +597,7 @@ class InputValidator {
    * 1. Push
    * 2. Pull Request
    * 3. Release
+   * 4. Other events
    * @returns {String} Metadata
    */
   static _getBuildInfo() {
@@ -665,7 +666,7 @@ class InputValidator {
    * @param {String} inputUsername BrowserStack Username
    * @returns {String} Modified Username
    */
-  static validateUsername(inputUsername) {
+  static updateUsername(inputUsername) {
     return `${inputUsername}-GitHubAction`;
   }
 
@@ -4297,9 +4298,7 @@ const ActionInput = __webpack_require__(972);
 /**
  * Entry point to initiate the Action.
  * 1. Triggers parsing of action input values
- * 2. Decides requirement of Local Binary
- * 3. Start/Stop Local Binary if required
- * 4. Triggers uploading of artifacts
+ * 2. Sets the environment variables required for BrowserStack
  */
 const run = async () => {
   try {
@@ -6103,11 +6102,10 @@ class ActionInput {
   }
 
   /**
-   * Triggers conditional validation of action input values based on the operation
-   * to be performed, i.e. start/no local connection required, stopping of local connection
+   * Validates the input values
    */
   _validateInput() {
-    this.username = InputValidator.validateUsername(this.username);
+    this.username = InputValidator.updateUsername(this.username);
     this.buildName = InputValidator.validateBuildName(this.buildName);
     this.projectName = InputValidator.validateProjectName(this.projectName);
   }
@@ -6119,7 +6117,10 @@ class ActionInput {
     core.startGroup('Setting Environment Variables');
 
     core.exportVariable(ENV_VARS.BROWSERSTACK_USERNAME, this.username);
+    core.info(`Use ${ENV_VARS.BROWSERSTACK_USERNAME} environment variable for your username in your tests\n`);
+
     core.exportVariable(ENV_VARS.BROWSERSTACK_ACCESS_KEY, this.accessKey);
+    core.info(`Use ${ENV_VARS.BROWSERSTACK_ACCESS_KEY} environment variable for your access key in your tests\n`);
 
     core.exportVariable(ENV_VARS.BROWSERSTACK_PROJECT_NAME, this.projectName);
     core.info(`${ENV_VARS.BROWSERSTACK_PROJECT_NAME} environment variable set as: ${this.projectName}`);

setup-env/src/actionInput/index.js

@@ -36,11 +36,10 @@ class ActionInput {
   }
 
   /**
-   * Triggers conditional validation of action input values based on the operation
-   * to be performed, i.e. start/no local connection required, stopping of local connection
+   * Validates the input values
    */
   _validateInput() {
-    this.username = InputValidator.validateUsername(this.username);
+    this.username = InputValidator.updateUsername(this.username);
     this.buildName = InputValidator.validateBuildName(this.buildName);
     this.projectName = InputValidator.validateProjectName(this.projectName);
   }
@@ -52,7 +51,10 @@ class ActionInput {
     core.startGroup('Setting Environment Variables');
 
     core.exportVariable(ENV_VARS.BROWSERSTACK_USERNAME, this.username);
+    core.info(`Use ${ENV_VARS.BROWSERSTACK_USERNAME} environment variable for your username in your tests\n`);
+
     core.exportVariable(ENV_VARS.BROWSERSTACK_ACCESS_KEY, this.accessKey);
+    core.info(`Use ${ENV_VARS.BROWSERSTACK_ACCESS_KEY} environment variable for your access key in your tests\n`);
 
     core.exportVariable(ENV_VARS.BROWSERSTACK_PROJECT_NAME, this.projectName);
     core.info(`${ENV_VARS.BROWSERSTACK_PROJECT_NAME} environment variable set as: ${this.projectName}`);

setup-env/src/actionInput/inputValidator.js

@@ -11,6 +11,7 @@ class InputValidator {
    * 1. Push
    * 2. Pull Request
    * 3. Release
+   * 4. Other events
    * @returns {String} Metadata
    */
   static _getBuildInfo() {
@@ -79,7 +80,7 @@ class InputValidator {
    * @param {String} inputUsername BrowserStack Username
    * @returns {String} Modified Username
    */
-  static validateUsername(inputUsername) {
+  static updateUsername(inputUsername) {
     return `${inputUsername}-GitHubAction`;
   }
 

setup-env/src/index.js

@@ -4,9 +4,7 @@ const ActionInput = require('./actionInput');
 /**
  * Entry point to initiate the Action.
  * 1. Triggers parsing of action input values
- * 2. Decides requirement of Local Binary
- * 3. Start/Stop Local Binary if required
- * 4. Triggers uploading of artifacts
+ * 2. Sets the environment variables required for BrowserStack
  */
 const run = async () => {
   try {

setup-env/test/actionInput/index.test.js

@@ -16,14 +16,14 @@ describe('Action Input operations for fetching all inputs, triggering validation
 
     beforeEach(() => {
       stubbedInput = sinon.stub(core, 'getInput');
-      sinon.stub(InputValidator, 'validateUsername').returns('validatedUsername');
+      sinon.stub(InputValidator, 'updateUsername').returns('validatedUsername');
       sinon.stub(InputValidator, 'validateBuildName').returns('validatedBuildName');
       sinon.stub(InputValidator, 'validateProjectName').returns('validatedProjectName');
     });
 
     afterEach(() => {
       core.getInput.restore();
-      InputValidator.validateUsername.restore();
+      InputValidator.updateUsername.restore();
       InputValidator.validateBuildName.restore();
       InputValidator.validateProjectName.restore();
     });
@@ -38,7 +38,7 @@ describe('Action Input operations for fetching all inputs, triggering validation
       sinon.assert.calledWith(core.getInput, INPUT.ACCESS_KEY, { required: true });
       sinon.assert.calledWith(core.getInput, INPUT.BUILD_NAME);
       sinon.assert.calledWith(core.getInput, INPUT.PROJECT_NAME);
-      sinon.assert.calledWith(InputValidator.validateUsername, 'someUsername');
+      sinon.assert.calledWith(InputValidator.updateUsername, 'someUsername');
       sinon.assert.calledWith(InputValidator.validateBuildName, 'someBuildName');
       sinon.assert.calledWith(InputValidator.validateProjectName, 'someProjectName');
       expect(actionInput.username).to.eq('validatedUsername');
@@ -54,7 +54,7 @@ describe('Action Input operations for fetching all inputs, triggering validation
       } catch (e) {
         expect(e.message).to.eq('Action input failed for reason: Username Required');
       }
-      sinon.assert.notCalled(InputValidator.validateUsername);
+      sinon.assert.notCalled(InputValidator.updateUsername);
       sinon.assert.notCalled(InputValidator.validateBuildName);
       sinon.assert.notCalled(InputValidator.validateProjectName);
     });
@@ -67,7 +67,7 @@ describe('Action Input operations for fetching all inputs, triggering validation
       } catch (e) {
         expect(e.message).to.eq('Action input failed for reason: Access Key Required');
       }
-      sinon.assert.notCalled(InputValidator.validateUsername);
+      sinon.assert.notCalled(InputValidator.updateUsername);
       sinon.assert.notCalled(InputValidator.validateBuildName);
       sinon.assert.notCalled(InputValidator.validateProjectName);
     });

setup-env/test/actionInput/inputValidator.test.js

@@ -8,7 +8,7 @@ describe('InputValidator class to validate individual fields of the action input
     context('Validates Username', () => {
       it("Returns the username with '-GitHubAction' suffix", () => {
         const inputUsername = 'someUsername';
-        expect(InputValidator.validateUsername(inputUsername)).to.eq(`${inputUsername}-GitHubAction`);
+        expect(InputValidator.updateUsername(inputUsername)).to.eq(`${inputUsername}-GitHubAction`);
       });
     });
 

setup-local/dist/index.js

@@ -1072,7 +1072,7 @@ const os = __webpack_require__(87);
 const path = __webpack_require__(622);
 const fs = __webpack_require__(747);
 const Utils = __webpack_require__(353);
-const ArtifactsManager = __webpack_require__(513);
+const ArtifactsManager = __webpack_require__(275);
 const constants = __webpack_require__(613);
 
 const {
@@ -1107,15 +1107,21 @@ class BinaryControl {
    * platform and the architecture
    */
   _decidePlatformAndBinary() {
-    if (this.platform === PLATFORMS.DARWIN) {
-      this.binaryLink = BINARY_LINKS.DARWIN;
-      this.binaryFolder = path.resolve(process.env.HOME, 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
-    } else if (this.platform === PLATFORMS.LINUX) {
-      this.binaryLink = os.arch() === 'x32' ? BINARY_LINKS.LINUX_32 : BINARY_LINKS.LINUX_64;
-      this.binaryFolder = path.resolve(process.env.HOME, 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
-    } else if (this.platform === PLATFORMS.WIN32) {
-      this.binaryLink = BINARY_LINKS.WINDOWS;
-      this.binaryFolder = path.resolve(process.env.GITHUB_WORKSPACE, '..', '..', 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
+    switch (this.platform) {
+      case PLATFORMS.DARWIN:
+        this.binaryLink = BINARY_LINKS.DARWIN;
+        this.binaryFolder = path.resolve(process.env.HOME, 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
+        break;
+      case PLATFORMS.LINUX:
+        this.binaryLink = os.arch() === 'x32' ? BINARY_LINKS.LINUX_32 : BINARY_LINKS.LINUX_64;
+        this.binaryFolder = path.resolve(process.env.HOME, 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
+        break;
+      case PLATFORMS.WIN32:
+        this.binaryLink = BINARY_LINKS.WINDOWS;
+        this.binaryFolder = path.resolve(process.env.GITHUB_WORKSPACE, '..', '..', 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
+        break;
+      default:
+        throw Error(`Unsupported Platform: ${this.platform}. No BrowserStackLocal binary found.`);
     }
   }
 
@@ -1205,11 +1211,11 @@ class BinaryControl {
    * Downloads the Local Binary, extracts it and adds it in the PATH variable
    */
   async downloadBinary() {
+    if (Utils.checkToolInCache(LOCAL_BINARY_NAME)) {
+      core.info('BrowserStackLocal binary already exists in cache. Using that instead of downloading again...');
+      return;
+    }
     try {
-      if (Utils.checkToolInCache(LOCAL_BINARY_NAME)) {
-        core.info('BrowserStackLocal binary already exists in cache. Using that instead of downloading again...');
-        return;
-      }
       await this._makeDirectory();
       core.info('Downloading BrowserStackLocal binary...');
       const downloadPath = await tc.downloadTool(this.binaryLink, path.resolve(this.binaryFolder, 'binaryZip'));
@@ -4986,6 +4992,40 @@ class Context {
 exports.Context = Context;
 //# sourceMappingURL=context.js.map
 
+/***/ }),
+
+/***/ 275:
+/***/ (function(module, __unusedexports, __webpack_require__) {
+
+const artifact = __webpack_require__(214);
+const core = __webpack_require__(470);
+
+class ArtifactsManager {
+  /**
+   * Upload artifacts to GitHub workflow
+   * @param {String} artifactName Name by which the artifact should be available post uploading
+   * @param {String[]} files Files to upload
+   * @param {String} rootFolder Folder in which the files reside
+   * @returns {Promise<artifact.UploadResponse>} Response of the upload operation
+   */
+  static async uploadArtifacts(artifactName, files, rootFolder) {
+    const artifactClient = artifact.create();
+    const response = await artifactClient.uploadArtifact(
+      artifactName,
+      files,
+      rootFolder, {
+        continueOnError: true,
+      },
+    );
+    core.info(`Response for upload: ${JSON.stringify(response)}`);
+    return response;
+  }
+}
+
+// eslint-disable-next-line import/prefer-default-export
+module.exports = ArtifactsManager;
+
+
 /***/ }),
 
 /***/ 280:
@@ -11143,40 +11183,6 @@ function addHook (state, kind, name, hook) {
 }
 
 
-/***/ }),
-
-/***/ 513:
-/***/ (function(module, __unusedexports, __webpack_require__) {
-
-const artifact = __webpack_require__(214);
-const core = __webpack_require__(470);
-
-class ArtifactsManager {
-  /**
-   * Upload artifacts to GitHub workflow
-   * @param {String} artifactName Name by which the artifact should be available post uploading
-   * @param {String[]} files Files to upload
-   * @param {String} rootFolder Folder in which the files reside
-   * @returns {Promise<artifact.UploadResponse>} Response of the upload operation
-   */
-  static async uploadArtifacts(artifactName, files, rootFolder) {
-    const artifactClient = artifact.create();
-    const response = await artifactClient.uploadArtifact(
-      artifactName,
-      files,
-      rootFolder, {
-        continueOnError: true,
-      },
-    );
-    core.info(`Response for upload: ${JSON.stringify(response)}`);
-    return response;
-  }
-}
-
-// eslint-disable-next-line import/prefer-default-export
-module.exports = ArtifactsManager;
-
-
 /***/ }),
 
 /***/ 521:
@@ -13975,8 +13981,8 @@ const {
  * Entry point to initiate the Action.
  * 1. Triggers parsing of action input values
  * 2. Decides requirement of Local Binary
- * 3. Start/Stop Local Binary if required
- * 4. Triggers uploading of artifacts
+ * 3. Start/Stop Local Binary
+ * 4. Triggers uploading of artifacts after stopping binary
  */
 const run = async () => {
   try {
@@ -16953,7 +16959,7 @@ class ActionInput {
 
   /**
    * Triggers conditional validation of action input values based on the operation
-   * to be performed, i.e. start/no local connection required, stopping of local connection
+   * to be performed, i.e. starting/stopping of local connection
    */
   _validateInput() {
     this.localTesting = InputValidator.validateLocalTesting(this.localTesting);

setup-local/src/actionInput/index.js

@@ -43,7 +43,7 @@ class ActionInput {
 
   /**
    * Triggers conditional validation of action input values based on the operation
-   * to be performed, i.e. start/no local connection required, stopping of local connection
+   * to be performed, i.e. starting/stopping of local connection
    */
   _validateInput() {
     this.localTesting = InputValidator.validateLocalTesting(this.localTesting);

setup-local/src/artifacts.js renamed to setup-local/src/artifactsManager.js

@@ -7,7 +7,7 @@ const os = require('os');
 const path = require('path');
 const fs = require('fs');
 const Utils = require('./utils');
-const ArtifactsManager = require('./artifacts');
+const ArtifactsManager = require('./artifactsManager');
 const constants = require('../config/constants');
 
 const {
@@ -42,15 +42,21 @@ class BinaryControl {
    * platform and the architecture
    */
   _decidePlatformAndBinary() {
-    if (this.platform === PLATFORMS.DARWIN) {
-      this.binaryLink = BINARY_LINKS.DARWIN;
-      this.binaryFolder = path.resolve(process.env.HOME, 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
-    } else if (this.platform === PLATFORMS.LINUX) {
-      this.binaryLink = os.arch() === 'x32' ? BINARY_LINKS.LINUX_32 : BINARY_LINKS.LINUX_64;
-      this.binaryFolder = path.resolve(process.env.HOME, 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
-    } else if (this.platform === PLATFORMS.WIN32) {
-      this.binaryLink = BINARY_LINKS.WINDOWS;
-      this.binaryFolder = path.resolve(process.env.GITHUB_WORKSPACE, '..', '..', 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
+    switch (this.platform) {
+      case PLATFORMS.DARWIN:
+        this.binaryLink = BINARY_LINKS.DARWIN;
+        this.binaryFolder = path.resolve(process.env.HOME, 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
+        break;
+      case PLATFORMS.LINUX:
+        this.binaryLink = os.arch() === 'x32' ? BINARY_LINKS.LINUX_32 : BINARY_LINKS.LINUX_64;
+        this.binaryFolder = path.resolve(process.env.HOME, 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
+        break;
+      case PLATFORMS.WIN32:
+        this.binaryLink = BINARY_LINKS.WINDOWS;
+        this.binaryFolder = path.resolve(process.env.GITHUB_WORKSPACE, '..', '..', 'work', 'binary', LOCAL_BINARY_FOLDER, this.platform);
+        break;
+      default:
+        throw Error(`Unsupported Platform: ${this.platform}. No BrowserStackLocal binary found.`);
     }
   }
 
@@ -140,11 +146,11 @@ class BinaryControl {
    * Downloads the Local Binary, extracts it and adds it in the PATH variable
    */
   async downloadBinary() {
+    if (Utils.checkToolInCache(LOCAL_BINARY_NAME)) {
+      core.info('BrowserStackLocal binary already exists in cache. Using that instead of downloading again...');
+      return;
+    }
     try {
-      if (Utils.checkToolInCache(LOCAL_BINARY_NAME)) {
-        core.info('BrowserStackLocal binary already exists in cache. Using that instead of downloading again...');
-        return;
-      }
       await this._makeDirectory();
       core.info('Downloading BrowserStackLocal binary...');
       const downloadPath = await tc.downloadTool(this.binaryLink, path.resolve(this.binaryFolder, 'binaryZip'));