support dry run when installing runner via init (#626)

* support dry run when installing runner via  init

* wip

* wip

Co-authored-by: roi.kramer <[email protected]>

Author: oren-codefresh

lib/interface/cli/commands/hybrid/InstallationPlan.js

@@ -23,6 +23,12 @@ const STEP_STATUSES = {
     SKIPPED: 'skipped',
 };
 
+const DRY_RUN_VALUES = {
+    agentName: 'dry-run-agent-id',
+    agentToken: 'dry-run-token',
+    runtimeName: 'dry-run-runtime-name',
+};
+
 function _ensureDirectory(location) {
     if (!existsSync(location)) {
         mkdirSync(location);
@@ -58,6 +64,7 @@ class InstallationPlan {
         installationEvent,
         exitOnError = true,
         condition = true,
+        executeOnDryRun = false,
     }) {
         if (!this.completedSteps[name]) {
             this.state.pendingSteps.push({
@@ -70,6 +77,7 @@ class InstallationPlan {
                 installationEvent,
                 exitOnError,
                 condition,
+                executeOnDryRun,
                 status: STEP_STATUSES.PENDING,
             });
         }
@@ -93,7 +101,17 @@ class InstallationPlan {
             this.state.finishedSteps.push(step);
             const _args = step.args || [step.arg];
 
+            let shouldSkip = false;
+
+            if (this._isDryRun() && !step.executeOnDryRun) {
+                shouldSkip = true;
+            }
+
             if (!step.condition || (_.isFunction(step.condition) && !await step.condition())) {
+                shouldSkip = true;
+            }
+
+            if (shouldSkip) {
                 console.log(`skipping step: ${colors.cyan(step.name)}`);
                 step.status = STEP_STATUSES.SKIPPED;
                 this._writeState();
@@ -143,9 +161,17 @@ class InstallationPlan {
     }
 
     getContext(key) {
+        if (this._isDryRun() && _.isUndefined(this.state.context.key)) {
+            return DRY_RUN_VALUES[key];
+        }
         return this.state.context[key];
     }
 
+    _isDryRun() {
+        const { argv } = this.state.context;
+        return argv && argv.dryRun;
+    }
+
     _writeState() {
         writeFileSync(INSTALLATION_STATE_FILE_PATH, JSON.stringify(this.state));
     }

lib/interface/cli/commands/hybrid/helper.js

@@ -678,6 +678,7 @@ async function installAppProxy({
     appProxyIngressClass, // --app-proxy-ingress-class
     apiHost, // --api-host
     envVars, // --envVars
+    dryRun, // --dry-run
 }) {
     const binLocation = await downloadVeonona();
     const componentRunner = new Runner(binLocation);
@@ -731,6 +732,9 @@ async function installAppProxy({
     if (appProxyHost) {
         cmd.push(`--host=${appProxyHost}`);
     }
+    if (dryRun) {
+        cmd.push('--dry-run');
+    }
     if (appProxyIngressClass) {
         cmd.push(`--ingress-class=${appProxyIngressClass}`);
     }
@@ -835,6 +839,7 @@ async function attachRuntime({
     valuesFile, // --values
     setValue, // --set-value
     setFile, // --set-file
+    dryRun,
 }) {
     const binLocation = await downloadVeonona();
     const componentRunner = new Runner(binLocation);
@@ -885,6 +890,9 @@ async function attachRuntime({
     if (setFile) {
         cmd.push(`--set-file=${setFile}`);
     }
+    if (dryRun) {
+        cmd.push('--dry-run');
+    }
     await componentRunner.run(components.venona, cmd);
 }
 

lib/interface/cli/commands/hybrid/init.cmd.js

@@ -59,6 +59,7 @@ function printInstallationOptionsSummary({
     noProxy,
     appProxy,
     appProxyHost,
+    dryRun,
 }) {
     let summary = `\n${colors.green('Installation options summary:')} 
     1. Kubernetes Context: ${colors.cyan(kubeContextName)}
@@ -73,6 +74,9 @@ function printInstallationOptionsSummary({
     if (appProxy) {
         summary += `7. App-Proxy hostname: ${colors.cyan(appProxyHost)}\n`;
     }
+    if (dryRun) {
+        summary += '**** running in dry-run mode ****';
+    }
     console.log(summary);
 }
 
@@ -194,6 +198,11 @@ const initCmd = new Command({
             default: true,
             type: 'boolean',
         })
+        .option('dry-run', {
+            describe: 'Will save all of the manifests to be deployed on the cluster to: ./manifests/',
+            default: false,
+            type: 'boolean',
+        })
         .example('codefresh runner init --values values.yaml (see values file example here: '
             + 'https://github.com/codefresh-io/venona/blob/release-1.0/venonactl/example/values-example.yaml)'),
     handler: async (argv) => {
@@ -249,6 +258,7 @@ const initCmd = new Command({
             reResources,
             userVolumeMounts,
             userVolumes,
+            'dry-run': dryRun,
         } = _argv;
         let {
             'kube-context-name': kubeContextName,
@@ -395,6 +405,7 @@ const initCmd = new Command({
             noProxy,
             appProxy,
             appProxyHost,
+            dryRun,
         });
 
         if (token) {
@@ -410,14 +421,14 @@ const initCmd = new Command({
             console.log(`A Codefresh context named '${INSTALLATION_DEFAULTS.CF_CONTEXT_NAME}' was added to your "cfconfig" file.`);
         }
 
-        const [, progress] = await to(async () => installationProgress.create(sdk['runner-installation'], {
+        const progress = dryRun ? {} : await installationProgress.create(sdk['runner-installation'], {
             options: {
                 kubeContextName,
                 kubeNamespace,
                 shouldMakeDefaultRe,
                 shouldExecutePipeline,
             },
-        }));
+        });
         const progressReporter = installationProgress.buildReporter(sdk['runner-installation'], progress);
 
         let installationPlan;
@@ -506,9 +517,11 @@ const initCmd = new Command({
                     valuesFile, // --values
                     setValue, // --set-value
                     setFile, // --set-file
+                    dryRun,
                 });
             },
             installationEvent: installationProgress.events.AGENT_INSTALLED,
+            executeOnDryRun: true,
         });
 
         // generate new runtime name
@@ -667,9 +680,11 @@ const initCmd = new Command({
                     setValue,
                     setFile,
                     storageClassName,
+                    dryRun,
                 });
             },
             installationEvent: installationProgress.events.RUNTIME_INSTALLED,
+            executeOnDryRun: true,
         });
 
         installationPlan.addStep({
@@ -688,12 +703,14 @@ const initCmd = new Command({
                     setFile,
                     appProxyHost,
                     appProxyIngressClass,
+                    dryRun,
                 });
                 const appProxyUrl = `https://${appProxyHost}${appProxyPathPrefix || ''}`;
                 installationPlan.addContext('appProxyIP', `${appProxyUrl}`);
             },
             installationEvent: installationProgress.events.APP_PROXY_INSTALLED,
             condition: !!appProxy,
+            executeOnDryRun: true,
         });
 
         // update runtime with ingress IP
@@ -752,9 +769,11 @@ const initCmd = new Command({
                     restartAgent: true, // --restart-agent
                     verbose, // --verbose
                     runtimeName: installationPlan.getContext('runtimeName'), // --runtimeName
+                    dryRun,
                 });
             },
             installationEvent: installationProgress.events.RUNNER_INSTALLED,
+            executeOnDryRun: true,
         });
 
         // install monitoring
@@ -770,6 +789,7 @@ const initCmd = new Command({
                 'env-vars': envVars,
                 'set-value': setValue,
                 'set-file': setFile,
+                'dry-run': dryRun,
                 token: _.get(sdk, 'config.context.token'),
                 verbose,
                 noExit: true, // to prevent if from calling inner: process.exit()
@@ -778,6 +798,7 @@ const initCmd = new Command({
             },
             successMessage: 'Successfully installed cluster monitoring',
             installationEvent: installationProgress.events.MONITOR_INSTALLED,
+            executeOnDryRun: true,
             condition: async () => {
                 if (!installMonitor) {
                     return false;

lib/interface/cli/commands/monitor/install.cmd.js

@@ -47,6 +47,11 @@ const installMonitorCmd = new Command({
         })
         .option('verbose', {
             describe: 'Print logs',
+        })
+        .option('dry-run', {
+            describe: 'dry run',
+            default: false,
+            type: 'boolean',
         }),
     handler: async (argv) => {
         const {
@@ -63,6 +68,7 @@ const installMonitorCmd = new Command({
             'env-vars': envVars,
             'set-value': setValue,
             'set-file': setFile,
+            'dry-run': dryRun,
             //        noExit,
         } = argv;
         const binLocation = await downloadVeonona();
@@ -137,6 +143,9 @@ const installMonitorCmd = new Command({
                 commands.push(`--set-value=EnvVars.${parts[0]}=${parts[1].replace(/,/g, '\\,')}`);
             });
         }
+        if (dryRun) {
+            commands.push('--dry-run');
+        }
 
         await componentRunner.run(components.venona, commands);
     },