@coalescesoftware/coa 1.0.112 → 1.0.115

package/bin/CLIProfile.js

@@ -55,6 +55,7 @@ exports.GetDefaultLocationForCoaConfigFile = GetDefaultLocationForCoaConfigFile;
 exports.ICLIProfileExample = {
     profile: "Profile To Use",
     environmentID: "Environment ID",
+    parameters: "Parameters",
     snowflakeAccount: "Snowflake Account To Use",
     snowflakeAuthType: "Snowflake Auth Type (Basic, KeyPair)",
     snowflakeKeyPairPath: "Snowflake Key Pair Path",
@@ -68,21 +69,29 @@ exports.ICLIProfileExample = {
     exclude: "Coalesce Node Selector"
 };
 const ReadCLIProfiles = (filePath) => {
-    return fs.promises.readFile(filePath, 'utf-8').then((file) => {
+    let filePathToUse;
+    if (!filePath) {
+        filePathToUse = (0, exports.GetDefaultLocationForCoaConfigFile)();
+    }
+    else {
+        filePathToUse = filePath;
+    }
+    return fs.promises.readFile(filePathToUse, 'utf-8')
+        .then((file) => {
         return ini.parse(file);
-    }).catch((err) => {
+    })
+        .catch((err) => {
         CLILogger.error("unable to read cli profile file filePath:", filePath, err);
-        throw new Error("unable to read cli profile");
+        if (!filePath) //if no filepath was specified, silently proceed
+            return {};
+        else //unable to proceed couldnt read file
+            throw new Error(`unable to read cli profile:${filePathToUse}`);
     });
 };
 const GetFinalCLIProfile = (commandLineOverrides, configFileLocation) => {
     let profileToUseOverride = commandLineOverrides.profile ? commandLineOverrides.profile : null;
-    return ReadCLIProfiles(configFileLocation).then((cliProfiles) => {
-        return cliProfiles;
-    }).catch((err) => {
-        //unable to read cli profiles 
-        return {};
-    }).then((cliProfiles) => {
+    return ReadCLIProfiles(configFileLocation)
+        .then((cliProfiles) => {
         const defaultCLIProfile = cliProfiles.default;
         let finalCLIProfile = {};
         //if theres a default cli profile, start with that
@@ -105,6 +114,8 @@ const GetFinalCLIProfile = (commandLineOverrides, configFileLocation) => {
         return finalCLIProfile;
     });
 };
+//Get CLI Config given command line overrides and a config file
+//config file location can be null - which means to use default location
 const GetCLIConfig = (commandLineOverrides, configFileLocation) => {
     return GetFinalCLIProfile(commandLineOverrides, configFileLocation).then((cliProfile) => {
         CLILogger.info("got final cli profile configFileLocation:", configFileLocation, JSON.stringify(RemoveCredentialsFromCLIProfile(cliProfile)));
@@ -124,7 +135,8 @@ const GetCLIConfig = (commandLineOverrides, configFileLocation) => {
                 snowflakeRole: cliProfile.snowflakeRole,
                 snowflakeUsername: cliProfile.snowflakeUsername,
                 snowflakeWarehouse: cliProfile.snowflakeWarehouse
-            }
+            },
+            runtimeParameters: cliProfile.parameters
         };
         Shared.Common.CleanupUndefinedValuesFromObject(cliConfig);
         return cliConfig;

package/bin/{Common.js → CommonCLI/CommonCLI.js}

@@ -19,11 +19,32 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetUserConnectionForCLI = exports.CleanupCLIJob = void 0;
+exports.GetUserConnectionForCLI = exports.CleanupCLIJob = exports.GetToken = exports.GetConfig = exports.ConsoleLog = void 0;
 const Shared = __importStar(require("@coalescesoftware/shared"));
-const fs = __importStar(require("fs"));
 const crypto = __importStar(require("crypto"));
+const fs = __importStar(require("fs"));
 const RunnerBackendLogger = Shared.Logging.GetLogger(Shared.Logging.LoggingArea.RunnerBackend);
+exports.ConsoleLog = console.log;
+const GetConfig = (path) => {
+    try {
+        return JSON.parse(fs.readFileSync(path, { encoding: "utf8" }));
+    }
+    catch (error) {
+        (0, exports.ConsoleLog)(`Unable to read or parse config file: ${error}`);
+        throw error;
+    }
+};
+exports.GetConfig = GetConfig;
+const GetToken = (path) => {
+    try {
+        return fs.readFileSync(path, { encoding: "utf8" }).trim();
+    }
+    catch (error) {
+        (0, exports.ConsoleLog)(`Unable to read token file: ${error}`);
+        throw error;
+    }
+};
+exports.GetToken = GetToken;
 const CleanupCLIJob = (runCompletion, firebase, logContext, action) => {
     const cleanupPromise = new Promise((resolve, reject) => {
         let promiseError = null;
@@ -75,20 +96,18 @@ const GetKeyPairKey = (keyPairPath) => {
 const GetUserConnectionForCLI = (userID, runInfo) => {
     return new Promise((resolve, reject) => {
         var _a, _b, _c, _d;
+        Shared.Common.assert(Shared.Logging.LoggingArea.RunnerBackend, !!((_a = runInfo.userCredentials) === null || _a === void 0 ? void 0 : _a.snowflakeAuthType), "ERROR (GetUserConnectionForCLI): no auth type provided");
         const output = {
             connectionDetails: {
                 userID,
                 user: "mx2323",
                 role: "SYSADMIN",
                 warehouse: "COMPUTE_WH",
-                authenticator: (_a = runInfo.userCredentials) === null || _a === void 0 ? void 0 : _a.snowflakeAuthType
+                authenticator: (_b = runInfo.userCredentials) === null || _b === void 0 ? void 0 : _b.snowflakeAuthType
             },
-            connectionType: (_b = runInfo.userCredentials) === null || _b === void 0 ? void 0 : _b.snowflakeAuthType
+            connectionType: (_c = runInfo.userCredentials) === null || _c === void 0 ? void 0 : _c.snowflakeAuthType
         };
-        if (!((_c = runInfo.userCredentials) === null || _c === void 0 ? void 0 : _c.snowflakeAuthType)) {
-            reject(new Error("ERROR (GetUserConnectionForCLI): no auth type provided"));
-        }
-        else if (((_d = runInfo.userCredentials) === null || _d === void 0 ? void 0 : _d.snowflakeAuthType) === Shared.ConnectionOperations.EUserConnectionTypes.keyPair) {
+        if (((_d = runInfo.userCredentials) === null || _d === void 0 ? void 0 : _d.snowflakeAuthType) === Shared.ConnectionOperations.EUserConnectionTypes.keyPair) {
             GetKeyPairKey(Shared.Common.getValueSafe(runInfo, ["userCredentials", "snowflakeKeyPairPath"], ""))
                 .then((keyPair) => {
                 output.connectionDetails.keyPair = keyPair;
@@ -104,4 +123,4 @@ const GetUserConnectionForCLI = (userID, runInfo) => {
     });
 };
 exports.GetUserConnectionForCLI = GetUserConnectionForCLI;
-//# sourceMappingURL=Common.js.map
+//# sourceMappingURL=CommonCLI.js.map

package/bin/CommonCLI/CommonCLI.test.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const CommonCLI = __importStar(require("./CommonCLI"));
+test("should fail to read and parse invalid JSON", () => {
+    expect(() => {
+        CommonCLI.GetConfig("cli/src/__mocks__/invalid.json");
+    }).toThrow("Unexpected token I in JSON at position 0");
+});
+//# sourceMappingURL=CommonCLI.test.js.map

package/bin/CommonCLI.js

@@ -19,11 +19,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetUserConnectionForCLI = exports.CleanupCLIJob = void 0;
+exports.FinishWithOutputFile = exports.ValidateRuntimeParameters = exports.GetRuntimeParametersFromFirestore = exports.GetUserConnectionForCLI = exports.CleanupCLIJob = void 0;
 const Shared = __importStar(require("@coalescesoftware/shared"));
 const fs = __importStar(require("fs"));
 const crypto = __importStar(require("crypto"));
+const RunOutput = __importStar(require("./RunOutput"));
 const RunnerBackendLogger = Shared.Logging.GetLogger(Shared.Logging.LoggingArea.RunnerBackend);
+const LogCLIInternal = Shared.Logging.GetLogger(Shared.Logging.LoggingArea.CLI_INTERNAL);
 const CleanupCLIJob = (runCompletion, firebase, logContext, action) => {
     const cleanupPromise = new Promise((resolve, reject) => {
         let promiseError = null;
@@ -74,21 +76,20 @@ const GetKeyPairKey = (keyPairPath) => {
 };
 const GetUserConnectionForCLI = (userID, runInfo) => {
     return new Promise((resolve, reject) => {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f;
         const output = {
             connectionDetails: {
                 userID,
                 user: (_a = runInfo.userCredentials) === null || _a === void 0 ? void 0 : _a.snowflakeUsername,
                 role: (_b = runInfo.userCredentials) === null || _b === void 0 ? void 0 : _b.snowflakeRole,
                 warehouse: (_c = runInfo.userCredentials) === null || _c === void 0 ? void 0 : _c.snowflakeWarehouse,
-                authenticator: (_d = runInfo.userCredentials) === null || _d === void 0 ? void 0 : _d.snowflakeAuthType
             },
-            connectionType: (_e = runInfo.userCredentials) === null || _e === void 0 ? void 0 : _e.snowflakeAuthType
+            connectionType: (_d = runInfo.userCredentials) === null || _d === void 0 ? void 0 : _d.snowflakeAuthType
         };
-        if (!((_f = runInfo.userCredentials) === null || _f === void 0 ? void 0 : _f.snowflakeAuthType)) {
+        if (!((_e = runInfo.userCredentials) === null || _e === void 0 ? void 0 : _e.snowflakeAuthType)) {
             reject(new Error("ERROR (GetUserConnectionForCLI): no auth type provided"));
         }
-        else if (((_g = runInfo.userCredentials) === null || _g === void 0 ? void 0 : _g.snowflakeAuthType) === Shared.ConnectionOperations.EUserConnectionTypes.keyPair) {
+        else if (((_f = runInfo.userCredentials) === null || _f === void 0 ? void 0 : _f.snowflakeAuthType) === Shared.ConnectionOperations.EUserConnectionTypes.keyPair) {
             GetKeyPairKey(Shared.Common.getValueSafe(runInfo, ["userCredentials", "snowflakeKeyPairPath"], ""))
                 .then((keyPair) => {
                 output.connectionDetails.keyPair = keyPair;
@@ -104,4 +105,35 @@ const GetUserConnectionForCLI = (userID, runInfo) => {
     });
 };
 exports.GetUserConnectionForCLI = GetUserConnectionForCLI;
+////////
+// Runtime Parameters
+///////
+const GetRuntimeParametersFromFirestore = (firestore, teamID, environmentID) => {
+    return Shared.CommonOperations.getWorkspaceDocumentRefAdmin(firestore, teamID, environmentID).get().then((workspace) => {
+        return workspace.get("runTimeParameters");
+    });
+};
+exports.GetRuntimeParametersFromFirestore = GetRuntimeParametersFromFirestore;
+const ValidateRuntimeParameters = (runtimeParameters) => {
+    try {
+        JSON.parse(runtimeParameters);
+    }
+    catch (error) {
+        throw new Error(`Failed to parse runtime parameters: ${error.message}`);
+    }
+};
+exports.ValidateRuntimeParameters = ValidateRuntimeParameters;
+////////
+// Output File 
+///////
+const FinishWithOutputFile = (logContextToUse, outputFilePath, runCounter, token) => {
+    if (!outputFilePath) {
+        return Promise.resolve();
+    }
+    else {
+        LogCLIInternal.infoContext(logContextToUse, "saving run results to file", outputFilePath);
+        return RunOutput.SaveRunOutputToFile(outputFilePath, runCounter.toString(), token);
+    }
+};
+exports.FinishWithOutputFile = FinishWithOutputFile;
 //# sourceMappingURL=CommonCLI.js.map

package/bin/Deploy/Deploy.js

@@ -0,0 +1,70 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeployWithCLI = void 0;
+const Shared = __importStar(require("@coalescesoftware/shared"));
+const CommonCLI = __importStar(require("../CommonCLI/CommonCLI"));
+const CryptoJS = require("crypto-js");
+const v8 = require("v8");
+Shared.Snowflake.CryptoJS = CryptoJS;
+Shared.Snowflake.salt = CryptoJS.lib.WordArray.random(128 / 8);
+Shared.Snowflake.v8 = v8;
+const LogCLI = Shared.Logging.GetLogger(Shared.Logging.LoggingArea.CLI);
+/**
+ *
+ * @param plan
+ * @param config
+ * @param token
+ * @returns
+ */
+const DeployWithCLI = (plan, config, token) => {
+    let firebase;
+    let logContext;
+    let teamDetailsStored, runInfo, RunSQL;
+    return Shared.SchedulerOperations.AuthenticateFirebaseTokenAndRetrieveTeamInfoForCLI(token, undefined)
+        .then((teamDetails) => {
+        var _a;
+        teamDetailsStored = teamDetails;
+        const { teamInfo, teamInfo: { fbUserID: userID, fbTeamID: teamID } } = teamDetails;
+        firebase = teamDetails.firebase;
+        const environmentID = (_a = config.runDetails) === null || _a === void 0 ? void 0 : _a.environmentID;
+        logContext = Shared.Logging.CreateLogContext(teamID, environmentID, userID);
+        const connectionCache = new Shared.Snowflake.ConnectionStorageClass();
+        RunSQL = Shared.SQLExecutorCreators.CreateRunSQLWithoutScheduler(teamDetails, connectionCache);
+        runInfo = Shared.DeployOperations.CreateDeployRequestObject(plan.plan, plan.environmentState, teamInfo, plan.gitInfo, plan.targetEnvironment, "");
+        runInfo.userCredentials = config.userCredentials;
+        return CommonCLI.GetUserConnectionForCLI(userID, runInfo);
+    })
+        .then((connection) => {
+        LogCLI.infoContext(logContext, "Deploy starting (CLI)");
+        return Shared.SchedulerOperations.HandleDeploy(runInfo, teamDetailsStored, RunSQL, connection);
+    })
+        .then(({ runCounter, runCompletion }) => {
+        const cleanupPromise = CommonCLI.CleanupCLIJob(runCompletion, firebase, logContext, "Deploy");
+        return {
+            runCounter,
+            runCompletion: cleanupPromise,
+            logContext,
+        };
+    });
+};
+exports.DeployWithCLI = DeployWithCLI;
+//# sourceMappingURL=Deploy.js.map

package/bin/Deploy.js

@@ -50,7 +50,7 @@ const DeployWithCLI = (plan, config, token) => {
         logContext = Shared.Logging.CreateLogContext(teamID, environmentID, userID);
         const connectionCache = new Shared.Snowflake.ConnectionStorageClass();
         RunSQL = Shared.SQLExecutorCreators.CreateRunSQLWithoutScheduler(teamDetails, connectionCache);
-        runInfo = Shared.DeployOperations.CreateDeployRequestObject(plan.plan, plan.environmentState, teamInfo, plan.gitInfo, plan.targetEnvironment, "");
+        runInfo = Shared.DeployOperations.CreateDeployRequestObject(plan.plan, plan.environmentState, teamInfo, plan.gitInfo, plan.targetEnvironment, plan.runtimeParameters);
         runInfo.userCredentials = config.userCredentials;
         return CommonCLI.GetUserConnectionForCLI(userID, runInfo);
     })