@coalescesoftware/coa 1.0.101 → 1.0.113

package/bin/CLIProfile.js

@@ -19,20 +19,37 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GetCLIConfig = exports.ICLIProfileExample = void 0;
+exports.GetCLIConfig = exports.ICLIProfileExample = exports.GetDefaultLocationForCoaConfigFile = void 0;
 /* eslint-disable multiline-comment-style */
 const Shared = __importStar(require("@coalescesoftware/shared"));
+const immer = __importStar(require("immer"));
 const os = require('os');
 const path = require('path');
 const ini = require('ini');
 const fs = require('fs');
+const RemoveCredentialsFromCLIProfile = (cliProfile) => {
+    return immer.produce(cliProfile, (draft) => {
+        if (draft.snowflakePassword)
+            draft.snowflakePassword = '<REDACTED>';
+        if (draft.snowflakeAccount)
+            draft.snowflakeAccount = '<REDACTED>';
+    });
+};
+const RemoveCredentialsFromCLIProfiles = (cliProfiles) => {
+    return immer.produce(cliProfiles, (draftState) => {
+        Object.keys(draftState).forEach((cliProfileName) => {
+            draftState[cliProfileName] = RemoveCredentialsFromCLIProfile(cliProfiles[cliProfileName]);
+        });
+    });
+};
 const CLILogger = Shared.Logging.GetLogger(Shared.Logging.LoggingArea.CLI_INTERNAL);
-const getDefaultLocationForCoaConfigFile = () => {
+const GetDefaultLocationForCoaConfigFile = () => {
     const homedir = os.homedir();
     const coaConfigLocation = path.join(homedir, ".coa/config");
     CLILogger.info("using default location", coaConfigLocation);
     return coaConfigLocation;
 };
+exports.GetDefaultLocationForCoaConfigFile = GetDefaultLocationForCoaConfigFile;
 //voodoo typescript magic in order to get runtime and compiletime ICLIProfile code
 //https://stackoverflow.com/questions/45670705/iterate-over-interface-properties-in-typescript
 exports.ICLIProfileExample = {
@@ -45,9 +62,12 @@ exports.ICLIProfileExample = {
     snowflakeRole: "Snowflake Role",
     snowflakeUsername: "Snowflake Username",
     snowflakeWarehouse: "Snowflake Warehouse",
-    token: "Coalesce Token"
+    token: "Coalesce Token",
+    jobID: "Coalesce JobID",
+    include: "Coalesce Node Selector",
+    exclude: "Coalesce Node Selector"
 };
-const readCLIProfiles = (filePath) => {
+const ReadCLIProfiles = (filePath) => {
     return fs.promises.readFile(filePath, 'utf-8').then((file) => {
         return ini.parse(file);
     }).catch((err) => {
@@ -55,10 +75,9 @@ const readCLIProfiles = (filePath) => {
         throw new Error("unable to read cli profile");
     });
 };
-const getFinalCLIProfile = (commandLineOverrides) => {
+const GetFinalCLIProfile = (commandLineOverrides, configFileLocation) => {
     let profileToUseOverride = commandLineOverrides.profile ? commandLineOverrides.profile : null;
-    const defaultPath = getDefaultLocationForCoaConfigFile();
-    return readCLIProfiles(defaultPath).then((cliProfiles) => {
+    return ReadCLIProfiles(configFileLocation).then((cliProfiles) => {
         return cliProfiles;
     }).catch((err) => {
         //unable to read cli profiles 
@@ -74,7 +93,7 @@ const getFinalCLIProfile = (commandLineOverrides) => {
         const profileToUse = profileToUseOverride || //cli override
             (!!defaultCLIProfile && defaultCLIProfile.profile) //default profile exists
             || "";
-        CLILogger.info("using profile", profileToUse, "cliProfiles", JSON.stringify(cliProfiles));
+        CLILogger.info("using profile", profileToUse, "cliProfiles", JSON.stringify(RemoveCredentialsFromCLIProfiles(cliProfiles)));
         if (profileToUse) {
             if (!(profileToUse in cliProfiles)) {
                 throw new Error(`unable to find profile ${profileToUse}`);
@@ -86,13 +105,16 @@ const getFinalCLIProfile = (commandLineOverrides) => {
         return finalCLIProfile;
     });
 };
-const GetCLIConfig = (commandLineOverrides) => {
-    return getFinalCLIProfile(commandLineOverrides).then((cliProfile) => {
-        CLILogger.info("got final cli profile", JSON.stringify(cliProfile));
-        return {
+const GetCLIConfig = (commandLineOverrides, configFileLocation) => {
+    return GetFinalCLIProfile(commandLineOverrides, configFileLocation).then((cliProfile) => {
+        CLILogger.info("got final cli profile configFileLocation:", configFileLocation, JSON.stringify(RemoveCredentialsFromCLIProfile(cliProfile)));
+        const cliConfig = {
             token: cliProfile.token,
             runDetails: {
-                environmentID: cliProfile.environmentID
+                environmentID: cliProfile.environmentID,
+                jobID: cliProfile.jobID,
+                includeNodesSelector: cliProfile.include,
+                excludeNodesSelector: cliProfile.exclude
             },
             userCredentials: {
                 snowflakeAccount: cliProfile.snowflakeAccount,
@@ -104,6 +126,8 @@ const GetCLIConfig = (commandLineOverrides) => {
                 snowflakeWarehouse: cliProfile.snowflakeWarehouse
             }
         };
+        Shared.Common.CleanupUndefinedValuesFromObject(cliConfig);
+        return cliConfig;
     });
 };
 exports.GetCLIConfig = GetCLIConfig;

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.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;
@@ -104,4 +106,14 @@ const GetUserConnectionForCLI = (userID, runInfo) => {
     });
 };
 exports.GetUserConnectionForCLI = GetUserConnectionForCLI;
+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/RunOutput.js

@@ -0,0 +1,82 @@
+"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.SaveRunOutputToFile = void 0;
+const Shared = __importStar(require("@coalescesoftware/shared"));
+const CLILogger = Shared.Logging.GetLogger(Shared.Logging.LoggingArea.CLI);
+const cleanRunResult = (nodeID, runResult) => {
+    return {
+        nodeID,
+        queryResultSequence: runResult.queryResultSequence
+    };
+};
+const GetRunOutputForRunCounter = (firestore, teamID, runID) => {
+    let runData;
+    return Shared.Runs.getRun(firestore, teamID, runID).get()
+        .then((runDataResult /*query snapshot*/) => {
+        if (!runDataResult.docs.length) {
+            const errorMessage = `wasnt able to get exactly one run for runID ${runID}`;
+            CLILogger.emergContext({
+                orgID: teamID
+            }, errorMessage);
+            throw new Error(errorMessage);
+        }
+        const runInfo = runDataResult.docs[0].data();
+        runData = {
+            runResults: {
+                runStartTime: runInfo.runStartTime,
+                runEndTime: runInfo.runEndTime,
+                runType: runInfo.runType,
+                runStatus: runInfo.runStatus,
+                runID: runInfo.id,
+                runResults: []
+            }
+        };
+        return Shared.Runs.getRunRunResultsCollection(firestore, teamID, runID.toString())
+            .get().then((queryResult /*querySnapshot*/) => {
+            let runResults = {};
+            queryResult.docs.forEach((runResultDoc) => {
+                const stepCounter = runResultDoc.id;
+                const runResult = runResultDoc.data();
+                runResults[stepCounter] = cleanRunResult(stepCounter, runResult.history[0]);
+            });
+            runData.runResults.runResults = runInfo.runHistory.map((stepCounter) => {
+                return runResults[stepCounter];
+            });
+        });
+    }).then(() => {
+        return runData;
+    });
+};
+const SaveRunOutputToFile = (runOutputFileLocation, runIDString, token) => {
+    return Shared.SchedulerOperations.AuthenticateFirebaseTokenAndRetrieveTeamInfoForCLI(token, undefined).then((authInfo) => {
+        const { teamInfo, firebase } = authInfo;
+        const teamID = teamInfo.fbTeamID;
+        const firestore = firebase.firestore();
+        const runID = parseInt(runIDString);
+        return GetRunOutputForRunCounter(firestore, teamID, runID);
+    }).then((runOutput) => {
+        const runOutputJSON = Shared.Common.StringifyFirestoreObject(runOutput);
+        return Shared.Common.WriteFile(runOutputFileLocation, runOutputJSON + "\n");
+    });
+};
+exports.SaveRunOutputToFile = SaveRunOutputToFile;
+//# sourceMappingURL=RunOutput.js.map

package/bin/index.js

@@ -31,6 +31,7 @@ const Shared = __importStar(require("@coalescesoftware/shared"));
 const CLIProfile = __importStar(require("./CLIProfile"));
 const chalk_1 = __importDefault(require("chalk"));
 const commander_1 = require("commander");
+const CommonCLI = __importStar(require("./CommonCLI"));
 const fs_1 = __importDefault(require("fs"));
 // setting this needs to be first!
 Shared.Logging.SetHTTPTransportOptions(Shared.Logging.EHttpServices.CLI);
@@ -39,7 +40,8 @@ const LogCLIInternal = Shared.Logging.GetLogger(Shared.Logging.LoggingArea.CLI_I
 const program = new commander_1.Command();
 program.version(require("../package.json").version, "-v, --version");
 program.option("-b, --debug", "Output extra debugging", false);
-const addOverridesToCommand = (command) => {
+program.option("--config <coa-config-location>", "coa config file location", CLIProfile.GetDefaultLocationForCoaConfigFile());
+const AddOverridesToCommand = (command) => {
     Object.keys(CLIProfile.ICLIProfileExample).forEach((key) => {
         command.option(`--${key} <value>`, CLIProfile.ICLIProfileExample[key], "");
     });
@@ -47,14 +49,13 @@ const addOverridesToCommand = (command) => {
 };
 //computeCLIOverrides returns an object that has a value if any of them have been specified at the command line
 //this is used as the final override when getting a CLIConfig
-const computeCLIOverrides = (command) => {
+const ComputeCLIOverrides = (command) => {
     let overrides = {};
     Object.keys(CLIProfile.ICLIProfileExample).forEach((key) => {
         const source = command.getOptionValueSource(key);
-        if (source == 'cli') {
+        if (source == "cli") {
             overrides[key] = command.getOptionValue(key);
         }
-        return overrides;
     });
     return overrides;
 };
@@ -68,12 +69,12 @@ program.command("none", { hidden: true, isDefault: true })
 /**
  * Plan command is responsible for reading files and creating a Coalesce Deployment Plan
  */
-addOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Plan))
+AddOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Plan))
     .option("-d, --dir <dir>", "Coalesce pipeline Yaml file path", ".")
     .option("--out <plan-location>", "Coalesce plan location", "./coa-plan.json")
     .description("plan a Coalesce deployment")
     .action((options, cmd) => {
-    const cliOverrides = computeCLIOverrides(cmd);
+    const cliOverrides = ComputeCLIOverrides(cmd);
     const optsWithGlobals = cmd.optsWithGlobals();
     const directoryPath = optsWithGlobals.dir;
     let logContextToUse;
@@ -89,7 +90,7 @@ addOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Plan))
         Shared.CLIOperations.DisableNonCLIConsoleLogs();
     }
     let config;
-    return CLIProfile.GetCLIConfig(cliOverrides)
+    return CLIProfile.GetCLIConfig(cliOverrides, optsWithGlobals.config)
         .then((configResult) => {
         config = configResult;
         return Shared.SchedulerOperations.AuthenticateFirebaseTokenAndRetrieveTeamInfoForCLI(config.token, undefined);
@@ -118,11 +119,12 @@ addOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Plan))
 /**
  * Deploy command is responsible for taking an already generated plan, and executing it
  */
-addOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Deploy))
+AddOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Deploy))
     .option("-p, --plan <plan-location>", "Coalesce plan location", "./coa-plan.json")
+    .option("-o, --out <output json>", "Run Results Output in Json ")
     .description("run a coalesce deployment plan")
     .action((options, cmd) => {
-    const cliOverrides = computeCLIOverrides(cmd);
+    const cliOverrides = ComputeCLIOverrides(cmd);
     const optsWithGlobals = cmd.optsWithGlobals();
     const plan = JSON.parse(fs_1.default.readFileSync(optsWithGlobals.plan, { encoding: "utf-8" }));
     // const config = JSON.parse(fs.readFileSync(cmd.config, { encoding: "utf-8" }))
@@ -140,7 +142,7 @@ addOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Deploy))
     let logContextToUse;
     let runInfo;
     let config;
-    return CLIProfile.GetCLIConfig(cliOverrides)
+    return CLIProfile.GetCLIConfig(cliOverrides, optsWithGlobals.config)
         .then((configResult) => {
         config = configResult;
         return Shared.SchedulerOperations.AuthenticateFirebaseTokenAndRetrieveTeamInfoForCLI(config.token, undefined);
@@ -161,14 +163,17 @@ addOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Deploy))
             const { runCounter, runCompletion, logContext } = result;
             logContextToUse = logContext !== null && logContext !== void 0 ? logContext : {};
             LogCLI.infoContext(logContextToUse, chalk_1.default.whiteBright(`Job ${runCounter}: ${chalk_1.default.green("running")}...`));
-            return runCompletion;
+            return runCompletion.finally(() => {
+                const outputFilePath = optsWithGlobals.out;
+                CommonCLI.FinishWithOutputFile(logContextToUse, outputFilePath, runCounter, config.token);
+            });
         })
             .then(() => {
             LogCLI.infoContext(logContextToUse, "Deployment successful!");
             Shared.CLIOperations.ExitCLISafe(0);
         })
             .catch(error => {
-            LogCLI.errorContext(logContextToUse, chalk_1.default.redBright(`An error occurred during deployment ${error}`));
+            LogCLI.errorContext(logContextToUse, chalk_1.default.redBright(`An error occurred during deployment ${error.toString()}`));
             Shared.CLIOperations.ExitCLISafe(1);
         });
     });
@@ -176,10 +181,11 @@ addOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Deploy))
 /**
  * Refresh command begins a locally executed Coalesce Environment Run
  */
-addOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Refresh))
+AddOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Refresh))
     .description("runs a Coalesce pipeline")
+    .option("-o, --out <output json>", "Run Results Output in Json ")
     .action((options, command) => {
-    const cliOverrides = computeCLIOverrides(command);
+    const cliOverrides = ComputeCLIOverrides(command);
     const optsWithGlobals = command.optsWithGlobals();
     //const token = fs.readFileSync(cmd.token, { encoding: "utf8" })
     //const config = JSON.parse(fs.readFileSync(cmd.config, { encoding: "utf8" }))
@@ -201,21 +207,26 @@ addOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Refresh)
     //WHY DO WE HAVE THIS CONFIG? 
     let runInfo;
     let config;
-    return CLIProfile.GetCLIConfig(cliOverrides)
+    return CLIProfile.GetCLIConfig(cliOverrides, optsWithGlobals.config)
         .then((configResult) => {
         config = configResult;
         return Shared.SchedulerOperations.AuthenticateFirebaseTokenAndRetrieveTeamInfoForCLI(config.token, undefined);
-    }).then(({ teamInfo }) => {
+    })
+        .then(({ teamInfo }) => {
         Shared.Logging.SetBackendGlobalContext({ userID: teamInfo.fbUserID, orgID: teamInfo.fbTeamID });
         runInfo = {
             runType: Shared.Runner.ERunType.refresh,
             runStatus: Shared.Runner.ERunStatus.running,
             runDetails: {
-                environmentID: config.runDetails.environmentID
+                environmentID: config.runDetails.environmentID,
+                jobID: config.runDetails.jobID,
+                includeNodesSelector: config.runDetails.includeNodesSelector,
+                excludeNodesSelector: config.runDetails.excludeNodesSelector
             },
             userCredentials: config.userCredentials,
             runTimeParameters: {}
         };
+        Shared.Common.CleanupUndefinedValuesFromObject(runInfo);
         LogCLIInternal.infoContext(logContextToUse, "cliOverrides", cliOverrides);
         LogCLIInternal.infoContext(logContextToUse, "got the cli config", config);
         LogCLIInternal.infoContext(logContextToUse, "got the run info", config);
@@ -225,11 +236,13 @@ addOverridesToCommand(program.command(Shared.CLIOperations.ECLICommands.Refresh)
             const { runCounter, runCompletion, logContext } = result;
             logContextToUse = logContext !== null && logContext !== void 0 ? logContext : {};
             LogCLI.infoContext(logContextToUse, chalk_1.default.whiteBright(`Refresh run initialized. RunCounter: ${runCounter}`));
-            return runCompletion;
-        })
-            .then(() => {
-            LogCLI.infoContext(logContextToUse, "Refresh successful!");
-            Shared.CLIOperations.ExitCLISafe(0);
+            return runCompletion.finally(() => {
+                const outputFilePath = optsWithGlobals.out;
+                CommonCLI.FinishWithOutputFile(logContextToUse, outputFilePath, runCounter, config.token);
+            }).then(() => {
+                LogCLI.infoContext(logContextToUse, "Refresh successful!");
+                Shared.CLIOperations.ExitCLISafe(0);
+            });
         })
             .catch(error => {
             LogCLI.errorContext(logContextToUse, chalk_1.default.redBright(`Error during refresh!: ${error.toString()}`));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@coalescesoftware/coa",
-    "version": "1.0.101",
+    "version": "1.0.113",
     "license": "ISC",
     "author": "Coalesce Automation, Inc.",
     "main": "index.js",
@@ -12,7 +12,7 @@
         "start-cli-debug": "yarn run start --debug"
     },
     "dependencies": {
-        "@coalescesoftware/shared": "^1.0.110",
+        "@coalescesoftware/shared": "^1.0.113",
         "chalk": "^4.1.2",
         "commander": "^9.2.0",
         "firebase": "8.2.0",