Parameter change approval

src/approval/index.ts

@@ -13,6 +13,7 @@ import configureAWS from '../configureAWS';
 import {logger} from '../logger';
 import {diff} from '../diff';
 import {GlobalArguments} from '../cli';
+import {SUCCESS, FAILURE, INTERRUPT} from '../statusCodes';
 
 export type RequestArguments = GlobalArguments & {
   argsfile: string;
@@ -44,10 +45,10 @@ export async function request(argv: RequestArguments): Promise<number> {
       }
     }
 
-    return 0;
+    return SUCCESS;
   } else {
     logError(`\`ApprovedTemplateLocation\` must be provided in ${argv.argsfile}`);
-    return 1;
+    return FAILURE;
   }
 
 }
@@ -132,17 +133,17 @@ export async function review(argv: ReviewArguments): Promise<number> {
 
         console.log();
         logSuccess(`Template has been successfully approved!`);
-        return 0;
+        return SUCCESS;
       } else {
-        return 130;
+        return INTERRUPT;
       }
 
     } else {
       throw new Error(e);
     }
   }
 
-  return 0;
+  return SUCCESS;
 }
 
 function logSuccess(text: string) {

src/cfn/convertStackToIidy.ts

@@ -11,6 +11,7 @@ import def from '../default';
 import {getKMSAliasForParameter} from '../params';
 
 import {GlobalArguments} from '../cli';
+import {SUCCESS} from '../statusCodes';
 
 function parameterizeEnv(s0: string, environments = ['development', 'integration', 'staging', 'production']): string {
   let s = s0;
@@ -219,5 +220,5 @@ export async function convertStackToIIDY(argv: ConvertStackArguments): Promise<n
 
   fs.writeFileSync(pathmod.join(outputDir, 'stack-args.yaml'), yaml.dump(outputDoc));
   // TODO write iidy-environment.yaml and related files
-  return 0;
+  return SUCCESS;
 }

src/cfn/index.ts

@@ -34,6 +34,7 @@ import {AWSRegion} from '../aws-regions';
 import timeout from '../timeout';
 import def from '../default';
 import {diff} from '../diff';
+import {SUCCESS, FAILURE, INTERRUPT} from '../statusCodes';
 
 import {readFromImportLocation, transform, PreprocessOptions} from '../preprocess';
 import {getKMSAliasForParameter} from '../params';
@@ -752,7 +753,7 @@ async function listStacks(showTags = false, tagsFilter?: [string, string][]) {
   spinner.stop();
   if (stacks.length === 0) {
     console.log('No stacks found');
-    return 0;
+    return SUCCESS;
   }
 
   const timePadding = 24;
@@ -993,15 +994,15 @@ function showFinalComandSummary(wasSuccessful: boolean): number {
     console.log(formatSectionHeading(sprintf(`%-${COLUMN2_START}s`, 'Command Summary:')),
       cli.black(cli.bgGreenBright('Success')),
       '👍')
-    return 0;
+    return SUCCESS;
   } else {
     console.log(
       formatSectionHeading(sprintf(`%-${COLUMN2_START}s`, 'Command Summary:')),
       cli.bgRedBright('Failure'),
       ' (╯°□°）╯︵ ┻━┻ ',
       'Fix and try again.'
     )
-    return 1;
+    return FAILURE;
   }
 }
 
@@ -1136,7 +1137,7 @@ abstract class AbstractCloudFormationStackCommand {
       logger.error('Template version has not been approved or the current IAM principal does not have permission to access it. Run:');
       logger.error(`  iidy template-approval request ${this.argsfile}`);
       logger.error('to begin the approval process.');
-      return 1;
+      return FAILURE;
     }
     const createStackOutput = await this.cfn.createStack(createStackInput).promise();
     await this._updateStackTerminationPolicy();
@@ -1150,7 +1151,7 @@ abstract class AbstractCloudFormationStackCommand {
         logger.error('Template version has not been approved or the current IAM principal does not have permission to access it. Run:');
         logger.error(`  iidy template-approval request ${this.argsfile}`);
         logger.error('to being the approval process.');
-        return 1;
+        return FAILURE;
       }
       if (this.argv.stackPolicyDuringUpdate) {
         const {
@@ -1166,7 +1167,7 @@ abstract class AbstractCloudFormationStackCommand {
     } catch (e) {
       if (e.message === 'No updates are to be performed.') {
         logger.info('No changes detected so no stack update needed.');
-        return 0;
+        return SUCCESS;
       } else {
         throw e;
       }
@@ -1303,7 +1304,7 @@ class CreateChangeSet extends AbstractCloudFormationStackCommand {
     if (changeSet.Status === 'FAILED') {
       logger.error(changeSet.StatusReason as string, 'Deleting failed changeset.');
       await this.cfn.deleteChangeSet({ChangeSetName, StackName}).promise();
-      return 1;
+      return FAILURE;
     }
     console.log();
 
@@ -1321,7 +1322,7 @@ class CreateChangeSet extends AbstractCloudFormationStackCommand {
       console.log();
     }
     showFinalComandSummary(true);
-    return 0;
+    return SUCCESS;
   }
 
   async _waitForChangeSetCreateComplete() {
@@ -1379,7 +1380,7 @@ class EstimateStackCost extends AbstractCloudFormationStackCommand {
       await stackArgsToCreateStackInput(this.stackArgs, this.argsfile, this.environment, this.stackName)
     const estimateResp = await this.cfn.estimateTemplateCost({TemplateBody, TemplateURL, Parameters}).promise();
     console.log('Stack cost estimator: ', estimateResp.Url);
-    return 0;
+    return SUCCESS;
   }
 }
 
@@ -1444,7 +1445,7 @@ export async function updateStackMain(argv: GenericCLIArguments): Promise<number
         return createChangesetResult;
       } else {
         logger.info('No changes to apply');
-        return 0;
+        return SUCCESS;
       }
     }
     console.log()
@@ -1461,7 +1462,7 @@ export async function updateStackMain(argv: GenericCLIArguments): Promise<number
     } else {
       console.log(`You can do so later using\n`
         + `  iidy exec-changeset -s ${changeSetRunner.stackName} ${changeSetRunner.argsfile} ${changeSetRunner.changeSetName}`);
-      return 130;
+      return INTERRUPT;
     }
   } else {
     return new UpdateStack(argv, await loadStackArgs(argv)).run();
@@ -1477,7 +1478,7 @@ export async function createChangesetMain(argv: GenericCLIArguments): Promise<nu
     await watchStack(changesetRunner.stackName, new Date(), DEFAULT_EVENT_POLL_INTERVAL, argv.watchInactivityTimeout);
     console.log();
     await summarizeCompletedStackOperation(changesetRunner.stackName);
-    return 0;
+    return SUCCESS;
   } else {
     return changesetExitCode;
   }
@@ -1490,7 +1491,7 @@ export async function listStacksMain(argv: GenericCLIArguments): Promise<number>
     return [key, value.join('=')] as [string, string];
   });
   await listStacks(argv.tags, tagsFilter);
-  return 0;
+  return SUCCESS;
 }
 
 
@@ -1522,7 +1523,7 @@ export async function watchStackMain(argv: GenericCLIArguments): Promise<number>
   await watchStack(StackId, startTime, DEFAULT_EVENT_POLL_INTERVAL, argv.inactivityTimeout);
   console.log();
   await summarizeCompletedStackOperation(StackId);
-  return 0;
+  return SUCCESS;
 }
 
 export async function describeStackMain(argv: GenericCLIArguments): Promise<number> {
@@ -1541,7 +1542,7 @@ export async function describeStackMain(argv: GenericCLIArguments): Promise<numb
   await showStackEvents(StackName, eventCount, stackEventsPromise);
   console.log();
   await summarizeCompletedStackOperation(StackId, stackPromise);
-  return 0;
+  return SUCCESS;
 }
 
 export async function getStackInstancesMain(argv: GenericCLIArguments): Promise<number> {
@@ -1582,7 +1583,7 @@ export async function getStackInstancesMain(argv: GenericCLIArguments): Promise<
   console.log(
     cli.blackBright(
       `https://console.aws.amazon.com/ec2/v2/home?region=${region}#Instances:tag:aws:cloudformation:stack-name=${StackName};sort=desc:launchTime`));
-  return 0;
+  return SUCCESS;
 }
 
 export async function getStackTemplateMain(argv: GenericCLIArguments): Promise<number> {
@@ -1610,7 +1611,7 @@ export async function getStackTemplateMain(argv: GenericCLIArguments): Promise<n
     default:
       console.log(output.TemplateBody);
   }
-  return 0;
+  return SUCCESS;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -1631,10 +1632,10 @@ export async function deleteStackMain(argv: GenericCLIArguments): Promise<number
       auth_arn = ${cli.blackBright(iamIdent.Arn)}`;
     if (argv.failIfAbsent) {
       logger.error(msg);
-      return 1;
+      return FAILURE;
     } else {
       logger.info(msg);
-      return 0;
+      return SUCCESS;
     }
   }
   console.log();
@@ -1670,7 +1671,7 @@ export async function deleteStackMain(argv: GenericCLIArguments): Promise<number
     const {StackStatus} = await getStackDescription(StackId);
     return showFinalComandSummary(StackStatus === 'DELETE_COMPLETE');
   } else {
-    return 130;
+    return INTERRUPT;
   }
 }
 

src/demo.ts

@@ -10,6 +10,7 @@ import * as cli from 'cli-color';
 import timeout from './timeout';
 import {transform} from './preprocess';
 import * as yaml from './yaml';
+import {SUCCESS} from './statusCodes';
 
 type Banner = {
   type: 'banner',
@@ -67,7 +68,7 @@ class DemoRunner {
       // TODO check result
       child_process.execSync(`rm -r "${this.tmpdir.name}"`, {cwd: this.tmpdir.name});
     }
-    return 0;
+    return SUCCESS;
   }
 
   _unpackFiles(files: {[key: string]: string}) {

src/initStackArgs.ts

@@ -1,5 +1,6 @@
 import * as fs from 'fs';
 import {Arguments} from 'yargs';
+import {SUCCESS} from './statusCodes';
 
 export async function initStackArgs(argv: Arguments): Promise<number> {
 
@@ -83,5 +84,5 @@ NotificationARNs:
     console.log("cfn-template.yaml has been created!");
   }
 
-  return 0;
+  return SUCCESS;
 }

src/params/cli.ts

@@ -4,6 +4,7 @@ import {description, Handler, wrapCommandHandler} from '../cli';
 
 export interface ParamCommands {
   setParam: Handler;
+  reviewParam: Handler;
   getParam: Handler;
   getParamsByPath: Handler;
   getParamHistory: Handler;
@@ -14,6 +15,7 @@ const lazyLoad = (fnname: keyof ParamCommands): Handler =>
 
 const lazy: ParamCommands = {
   setParam: lazyLoad('setParam'),
+  reviewParam: lazyLoad('reviewParam'),
   getParam: lazyLoad('getParam'),
   getParamsByPath: lazyLoad('getParamsByPath'),
   getParamHistory: lazyLoad('getParamHistory'),
@@ -40,17 +42,31 @@ export function buildParamCommands(args: yargs.Argv, commands = lazy): yargs.Arg
     description('set a parameter value'),
     (args) =>
       args
+        .option('message', {
+          type: 'string',
+          description: 'descriptive message for parameter'
+        })
         .option('overwrite', {
           type: 'boolean', default: false,
           description: 'overwrite existing parameters'
         })
+        .option('with-approval', {
+          type: 'boolean', default: false,
+          description: 'require parameter review to apply change'
+        })
         .option('type', {
           type: 'string', default: 'SecureString',
           description: 'parameter type',
           choices: ['String', 'StringList', 'SecureString']
         }),
     wrapCommandHandler(commands.setParam))
 
+    .command(
+    'review <path>',
+    description('review a pending change'),
+    (args) => args,
+    wrapCommandHandler(commands.reviewParam))
+
     .command('get <path>',
     description('get a parameter value'),
     (args) =>