forceios 9.2.0

package/shared/utils.js

@@ -0,0 +1,453 @@
+/*
+ * Copyright (c) 2016-present, salesforce.com, inc.
+ * All rights reserved.
+ * Redistribution and use of this software in source and binary forms, with or
+ * without modification, are permitted provided that the following conditions
+ * are met:
+ * - Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ * - Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * - Neither the name of salesforce.com, inc. nor the names of its contributors
+ * may be used to endorse or promote products derived from this software without
+ * specific prior written permission of salesforce.com, inc.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+var shelljs = require('shelljs'),
+    execSync = require('child_process').execSync,
+    fs = require('fs'),
+    path = require('path'),
+    COLOR = require('./outputColors');
+
+var LOG_LEVELS = {
+    OFF: 0,
+    FATAL: 100,
+    ERROR: 200,
+    WARN: 300,
+    INFO: 400,
+    DEBUG: 500,
+    TRACE: 600,
+    ALL: Number.MAX_SAFE_INTEGER
+};
+
+var LOG_LEVEL = LOG_LEVELS.INFO;
+
+var exitOnFailure = false;
+
+/**
+ * Set log level
+ *
+ * @param {int} logLevel
+ */
+function setLogLevel(logLevel) {
+    LOG_LEVEL = logLevel;
+}
+
+/**
+ * Creates a comparable version number from a version string in the format x[.y[.ignored]].
+ * Currently only looks for major and minor version numbers.
+ *
+ * Examples:
+ * getVersionNumberFromString('5') will return 5000.
+ * getVersionNumberFromString('5.8') will return 5008
+ * getVersionNumberFromString('5.11.26-43.3.7') will return 5011
+ * getVersionNumberFromString('sandwich') will log an error and return 0
+ *
+ * @param {String} versionString The string representation of the version.
+ * @return {Number} The numeric version number, or 0 if the version string isn't a valid format.
+ */
+function getVersionNumberFromString(versionString) {
+	// Only supporting major/minor version checking at this point.
+    var versionRegex = new RegExp(/^[^\d]*(\d+)(\.(\d+))?(\.(\d+))?/, 'm');
+    var matchArray = versionString.match(versionRegex);
+	if (matchArray === null) {
+		log(LOG_LEVELS.WARN, 'Invalid version string "' + versionString + '". Should be in the format x[.y[.z[.ignored]]]');
+		return 0;
+	} else {
+        var majorVersion = parseInt(matchArray[1]);
+        var minorVersion = (matchArray[3] === undefined ? 0 : parseInt(matchArray[3]));
+        var patchVersion = (matchArray[5] === undefined ? 0 : parseInt(matchArray[5]));
+        var combinedVersion = (1000000 * majorVersion) + (1000 * minorVersion) + patchVersion;
+		return combinedVersion;
+	}
+}
+
+/**
+ * Checks the the version of a tool by running the given command
+ *
+ * @param {String} cmd Command to run to get the tool version
+ * @param {String} minVersionRequired Minimum version required
+ * @param {String} maxVersionSupported Maximum version supported
+ *
+ * @throws {Error} if tool not found or version too low
+ */
+function checkToolVersion(cmd, minVersionRequired, maxVersionSupported) {
+    var toolName = cmd.split(' ')[0];
+    var toolVersion;
+    try {
+	    var result = runProcessThrowError(cmd, null, true /* return output */);
+        toolVersion = result.replace(/\r?\n|\r/, '').replace(/[^0-9\.]*/, '');
+    }
+    catch (error) {
+        throw new Error(toolName + ' is required but could not be found. Please install ' + toolName + '.');
+    }
+
+    var toolVersionNum = getVersionNumberFromString(toolVersion);
+    var minVersionRequiredNum = getVersionNumberFromString(minVersionRequired);
+
+    if (toolVersionNum < minVersionRequiredNum) {
+        throw new Error('Installed ' + toolName + ' version (' + toolVersion + ') is less than the minimum required version ('
+                        + minVersionRequired + ').  Please update your version of ' + toolName + '.');
+    }
+
+    if (maxVersionSupported) {
+        var maxVersionSupportedNum = getVersionNumberFromString(maxVersionSupported);
+        if (toolVersionNum > maxVersionSupportedNum) {
+            throw new Error('Installed ' + toolName + ' version (' + toolVersion + ') is more than the maximum supported version ('
+                            + maxVersionSupported + ').  Please downgrade your version of ' + toolName + '.');
+        }
+    }
+}
+
+
+/**
+ * Replaces text in a file
+ *
+ * @param {String} fileName The file in which the text needs to be replaced.
+ * @param {String} textInFile Text in the file to be replaced.
+ * @param {String} replacementText Text used to replace the text in file.
+ */
+function replaceTextInFile(fileName, textInFile, replacementText) {
+    var contents = fs.readFileSync(fileName, 'utf8');
+    var lines = contents.split(/\r*\n/);
+    var result = lines.map(function (line) {
+        return line.replace(textInFile, replacementText);
+    }).join('\n');
+
+    fs.writeFileSync(fileName, result, 'utf8');
+}
+
+
+/**
+ * Run shell command - throws error if any
+ *
+ * @param {String} cmd The command to execute.
+ * @param {String} dir Optional. The directory the command should be executed in.
+ * @param {Boolean} returnOutput. If true, returns output as string. If false, pipes output through.
+ */
+function runProcessThrowError(cmd, dir, returnOutput) {
+    logDebug('Running: ' + cmd);
+    if (returnOutput) {
+        return execSync(cmd, {cwd: dir}).toString();
+    }
+    else {
+        var stdio = [];
+        if (LOG_LEVEL >= LOG_LEVELS.DEBUG) {
+            stdio = [0,1,2]
+        }
+        else if (LOG_LEVEL >= LOG_LEVELS.ERROR) {
+            stdio = [0,2]
+        }
+
+        execSync(cmd, {cwd: dir, stdio: stdio});
+    }
+}
+
+/**
+ * Run shell command - catch error if any (unless setExitOnFailure(true) was called)
+ *
+ * @param {String} cmd The command to execute.
+ * @param {String} msg Message to print on success/failure.
+ * @param {String} dir Optional. The directory the command should be executed in.
+ *
+ * @return true if successful, false otherwise
+ */
+function runProcessCatchError(cmd, msg, dir) {
+    var success = false;
+    logDebug('Running: ' + cmd);
+    try {
+        runProcessThrowError(cmd, dir);
+        if (msg) logInfo('!SUCCESS! ' + msg, COLOR.green);
+        success = true;
+    } catch (err) {
+        logError(msg ? '!FAILURE! ' + msg : '', err);
+        if (exitOnFailure) {
+            process.exit(1);
+        }
+    }
+    finally {
+        return success;
+    }
+}
+
+/**
+ * Run function - throws error if any
+ *
+ * @param {Function} func The function to execute.
+ * @param {String} dir Optional. The directory the function should be executed from.
+ */
+function runFunctionThrowError(func, dir) {
+    if (dir) shelljs.pushd(dir);
+    try {
+        return func();
+    }
+    finally {
+        if (dir) shelljs.popd();
+    }
+}
+
+/**
+ * Makes temp directory.
+ *
+ * @return {String} Path of temp directory
+ */
+
+function mkTmpDir() {
+    var d = new Date();
+    var timestamp = new Date(d.getTime() - 1000*60*d.getTimezoneOffset()).toISOString().replace(/[^0-9T.]/g, ''); // e.g. 20190510T134348.528 for Fri May 10 2019 13:43:48 GMT-0700 (Pacific Daylight Time)
+    var tmpDir = path.resolve('tmp' + timestamp);
+    logDebug('Making temp dir:' + tmpDir);
+    shelljs.mkdir('-p', tmpDir);
+    return tmpDir;
+}
+
+/**
+ * Make directory if it does not exist
+ * 
+ * @param {string} Path of directory to create
+*/
+function mkDirIfNeeded(dir) {
+    if (dir != '') {
+        shelljs.mkdir('-p', dir);
+    }
+}
+
+/**
+ * Replace string in files.
+ *
+ * @param {String or RegExp} from String to match.
+ * @param {String} to Replacement string.
+ * @param {Array} files List of files to do the replacements in.
+ */
+function replaceInFiles(from, to, files) {
+    var fromRegexp = typeof(from) === 'string' ? new RegExp(from, 'g') : from;
+    for (var i=0; i<files.length; i++) {
+        logDebug('Replacing ' + from + ' with ' + to + ' in: ' + files[i]);
+        replaceTextInFile(files[i], fromRegexp, to);
+    }
+}
+
+/**
+ * Move file or directory.
+ *
+ * @param {String} from Path of file or directory to move.
+ * @param {String} to New path for file or directory.
+ */
+function moveFile(from, to) {
+    logDebug('Moving: ' + from + ' to ' + to);
+    mkDirIfNeeded(path.parse(to).dir);
+    shelljs.mv(from, to);
+}
+
+/**
+ * Check there is a directory with given path
+ * @param {String} path of dir
+ */
+ function dirExists(path) {
+   return shelljs.test('-d', path);
+ }
+
+/**
+ * Copy recursively.
+ *
+ * @param {String} from Path of file or directory to copy.
+ * @param {String} to New path for file or directory.
+ */
+function copyFile(from, to) {
+    logDebug('Copying: ' + from + ' to ' + to);
+    shelljs.cp('-R', from, to);
+}
+
+/**
+ * Merge recursively. 
+ * Like copyFile except that it will merge into existing directories.
+ *
+ * @param {String} from Path of file or directory to move.
+ * @param {String} to New path for file or directory.
+ */
+function mergeFile(from, to) {
+    logDebug('Merging: ' + from + ' to ' + to);
+    shelljs.find(from).forEach(function(srcPath) {
+        var relativePath = path.relative(from, srcPath)
+        if(shelljs.test('-f', srcPath)) {
+            shelljs.cp(path.join(from, relativePath), path.join(to, relativePath));
+        } else {
+            shelljs.mkdir('-p', path.join(to, relativePath));            
+        }
+    })
+}
+
+
+/**
+ * Remove file or directory.
+ *
+ * @param {String} path Path of file or directory to remove.
+ */
+function removeFile(path) {
+    logDebug('Removing: ' + path);
+    shelljs.rm('-rf', path);
+}
+
+/**
+ * Separate repo url / path / branch from url of the form https://server/org/repo/path#branch or https://server/org/repo#branch or https://server/org/repo
+ * @param {String} Full url
+ * @return map with repo / path /branch {repo:https://server/org/repo, branch:branch, path:path}
+ */
+function separateRepoUrlPathBranch(fullUrl) {
+    var parts = fullUrl.split('#');
+    var repoWithPath = parts[0];
+    var branch = parts.length > 1 ? parts[1] : 'master';
+    var repo = repoWithPath.split('/').splice(0,5).join('/');
+    var path = repoWithPath.split('/').splice(5).join('/');
+    return {repo:repo, branch:branch, path:path};
+}
+
+/**
+ * Clone repo.
+ *
+ * @param {String} tmpDir Parent dir for clone
+ * @param {String} repoUrlWithBranch Repo URL e.g. https://github.com/xyz/abc or https://github.com/xyz/abc#branch
+ *
+ * @return repoDir
+ */
+
+function cloneRepo(tmpDir, repoUrlWithBranch) {
+    var parts = repoUrlWithBranch.split('#');
+    var repoUrl = parts[0];
+    var branch = parts.length > 1 ? parts[1] : 'master';
+    var subparts = repoUrl.split('/');
+    var repoName = subparts[subparts.length - 1];
+    var repoDir = path.join(tmpDir, repoName);
+
+    shelljs.mkdir('-p', repoDir);
+    runProcessThrowError('git clone --branch ' + branch + ' --single-branch --depth 1 --recurse-submodules ' + repoUrl + ' ' + '"' + repoDir + '"');
+    return repoDir;
+}
+
+/**
+ * Log paragraph (header or footer)
+ *
+ * @param {String} lines
+ */
+function logParagraph(lines, color) {
+    color = color || COLOR.green;
+    logInfo("");
+    logInfo("********************************************************************************", color);
+    logInfo("*", color);
+    for (var i=0; i<lines.length; i++) {
+        logInfo("*   " + lines[i], color);
+    }
+    logInfo("*", color);
+    logInfo("********************************************************************************", color);
+    logInfo("");
+}
+
+/**
+ * Log error
+ *
+ * @param {String} context
+ * @param {Error} error
+ */
+function logError(context, error) {
+    log(LOG_LEVELS.ERROR, context, COLOR.red)
+    if (error) {
+        log(LOG_LEVELS.ERROR, error.message, COLOR.red);
+        logDebug(error.stack);
+    }
+}
+
+/**
+ * Log info
+ *
+ * @param {String} msg Message to log.
+ * @param {String} color Color to use.
+ */
+function logInfo(msg, color) {
+    log(LOG_LEVELS.INFO, msg, color);
+}
+
+/**
+ * Log debug
+ *
+ * @param {String} msg Message to log.
+ * @param {String} color Color to use.
+ */
+function logDebug(msg, color) {
+    log(LOG_LEVELS.DEBUG, msg, color);
+}
+
+
+/**
+ * Log in color.
+ *
+ * @param {integer} logLevel Max LOG_LEVEL for which the message should be logged
+ * @param {String} msg Message to log.
+ * @param {String} color Color to use.
+ */
+function log(logLevel, msg, color) {
+    if (logLevel <= LOG_LEVEL) {
+        if (color) {
+            console.log(color + msg + COLOR.reset);
+        }
+        else {
+            console.log(msg);
+        }
+    }
+}
+
+/**
+ * Set behavior when running shell processes 
+ *
+ * @param {Boolean} exitOFailure - pass true to exit on shell process execution failure (default is false)
+ */
+function setExitOnFailure(b) {
+    exitOnFailure = b;
+}
+
+module.exports = {
+    LOG_LEVELS,
+    checkToolVersion,
+    cloneRepo,
+    copyFile,
+    dirExists,
+    getVersionNumberFromString,
+    log,
+    logDebug,
+    logError,
+    logInfo,
+    logParagraph,
+    mergeFile,
+    mkTmpDir,
+    mkDirIfNeeded,
+    moveFile,
+    setLogLevel,
+    removeFile,
+    replaceInFiles,
+    runFunctionThrowError,
+    runProcessCatchError,
+    runProcessThrowError,
+    separateRepoUrlPathBranch,
+    setExitOnFailure
+};