add: timestamp suffix to binary log files to differentiate between steps

Author: rchougule

setup-local/config/constants.js

@@ -15,6 +15,7 @@ module.exports = {
   ENV_VARS: {
     BROWSERSTACK_ACCESS_KEY: 'BROWSERSTACK_ACCESS_KEY',
     BROWSERSTACK_LOCAL_IDENTIFIER: 'BROWSERSTACK_LOCAL_IDENTIFIER',
+    BROWSERSTACK_LOCAL_LOGS_FILE: 'BROWSERSTACK_LOCAL_LOGS_FILE',
   },
 
   BINARY_LINKS: {

setup-local/src/binaryControl.js

@@ -6,6 +6,7 @@ const github = require('@actions/github');
 const os = require('os');
 const path = require('path');
 const fs = require('fs');
+const Utils = require('./utils');
 const ArtifactsManager = require('./artifacts');
 const constants = require('../config/constants');
 
@@ -19,6 +20,9 @@ const {
   ALLOWED_INPUT_VALUES: {
     LOCAL_TESTING,
   },
+  ENV_VARS: {
+    BROWSERSTACK_LOCAL_LOGS_FILE,
+  },
 } = constants;
 
 /**
@@ -61,8 +65,9 @@ class BinaryControl {
    * Generates logging file name and its path for Local Binary
    */
   _generateLogFileMetadata() {
-    this.logFileName = `${LOCAL_LOG_FILE_PREFIX}_${github.context.job}.log`;
+    this.logFileName = process.env[BROWSERSTACK_LOCAL_LOGS_FILE] || `${LOCAL_LOG_FILE_PREFIX}_${github.context.job}_${new Date().toISOString()}.log`;
     this.logFilePath = path.resolve(this.binaryFolder, this.logFileName);
+    core.exportVariable(BROWSERSTACK_LOCAL_LOGS_FILE, this.logFileName);
   }
 
   /**
@@ -131,23 +136,16 @@ class BinaryControl {
     };
   }
 
-  _binaryExists() {
-    const localBinary = tc.findAllVersions(LOCAL_BINARY_NAME);
-    return localBinary.length ? true : false;
-  }
-
   /**
    * Downloads the Local Binary, extracts it and adds it in the PATH variable
    */
   async downloadBinary() {
     try {
-      if (this._binaryExists()) {
-        console.log(core.getState('jinga'));
+      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.saveState('jinga', 'lala');
       core.info('Downloading BrowserStackLocal binary...');
       const downloadPath = await tc.downloadTool(this.binaryLink, path.resolve(this.binaryFolder, 'binaryZip'));
       const extractedPath = await tc.extractZip(downloadPath, this.binaryFolder);
@@ -218,7 +216,6 @@ class BinaryControl {
    * Uploads BrowserStackLocal generated logs (if the file exists for the job)
    */
   async uploadLogFilesIfAny() {
-    core.saveState
     this._generateLogFileMetadata();
     if (fs.existsSync(this.logFilePath)) {
       await ArtifactsManager.uploadArtifacts(
@@ -228,6 +225,7 @@ class BinaryControl {
       );
       await io.rmRF(this.logFilePath);
     }
+    Utils.clearEnvironmentVariable(BROWSERSTACK_LOCAL_LOGS_FILE);
   }
 }
 

setup-local/src/utils/index.js

@@ -0,0 +1,14 @@
+const tc = require('@actions/tool-cache');
+
+class Utils {
+  static clearEnvironmentVariable(environmentVariable) {
+    delete process.env[environmentVariable];
+  }
+
+  static checkToolInCache(toolName) {
+    const toolCache = tc.findAllVersions(toolName);
+    return toolCache.length !== 0;
+  }
+}
+
+module.exports = Utils;