-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
the command is used as an approval process for the cfn-template.yaml. When a template is uploaded to an s3 bucket through the cmd, it appends the suffix `.pending` to the filename. This then enables the maintainers/admins to review the changes in the cfn-template.yaml before using it for the stack. When a template has already been approved (the filename is not appended with `.pending`) it results to a noop. When a template is changed, the filename is changed because of the md5 hashing.
- Loading branch information
1 parent
7651f0e
commit 16bf034
Showing
6 changed files
with
220 additions
and
4 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| import { S3 } from 'aws-sdk'; | ||
| import { Md5 } from 'ts-md5/dist/md5'; | ||
| import * as fs from 'fs'; | ||
| import * as cli from 'cli-color'; | ||
| import * as path from 'path'; | ||
| import * as url from 'url'; | ||
| import * as jsdiff from 'diff'; | ||
| import * as inquirer from 'inquirer'; | ||
|
|
||
| import { Arguments } from 'yargs'; | ||
| import { loadStackArgs } from '../cfn/index'; | ||
| import configureAWS from '../configureAWS'; | ||
| import { logger } from '../logger'; | ||
|
|
||
| export async function requestApproveTemplate(argv: Arguments): Promise<number> { | ||
| const stackArgs = await loadStackArgs(argv); | ||
|
|
||
| if (typeof stackArgs.ApprovedTemplateLocation === 'string' && stackArgs.ApprovedTemplateLocation.length > 0) { | ||
| const s3 = new S3(); | ||
|
|
||
| await configureAWS(stackArgs.Profile, stackArgs.Region); | ||
|
|
||
| const templatePath = path.resolve(path.dirname(argv.argsfile), stackArgs.Template); | ||
| const cfnTemplate = await fs.readFileSync(templatePath); | ||
|
|
||
| const s3Url = url.parse(stackArgs.ApprovedTemplateLocation); | ||
| const s3Path = s3Url.path ? s3Url.path : ''; | ||
| const s3Bucket = s3Url.hostname ? s3Url.hostname : ''; | ||
|
|
||
| const fileName = new Md5().appendStr(cfnTemplate.toString()).end().toString(); | ||
| const fullFileName = `${fileName}${path.extname(stackArgs.Template)}.pending`; | ||
|
|
||
| const hashedKey = path.join(s3Path.substring(1), fullFileName); | ||
|
|
||
| try { | ||
| await s3.headObject({ | ||
| Bucket: s3Bucket, | ||
| Key: hashedKey | ||
| }).promise(); | ||
|
|
||
| logSuccess(`👍 Your template has already been approved`); | ||
| } catch (e) { | ||
| if (e.code === 'NotFound') { | ||
| await s3.putObject({ | ||
| Body: cfnTemplate, | ||
| Bucket: s3Bucket, | ||
| Key: hashedKey | ||
| }).promise(); | ||
|
|
||
| logSuccess(`Successfully uploaded the cloudformation template to ${stackArgs.ApprovedTemplateLocation}`); | ||
| logSuccess(`Approve template with:\n iidy approve-template s3://${s3Bucket}/${hashedKey}`); | ||
| } else { | ||
| throw new Error(e); | ||
| } | ||
| } | ||
|
|
||
| return 0; | ||
| } else { | ||
| logError(`\`ApprovedTemplateLocation\` must be provided in ${argv.argsfile}`); | ||
| return 1; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| export async function approveTemplate(argv: Arguments): Promise<number> { | ||
| await configureAWS(argv.profile, 'us-east-1'); | ||
| const s3 = new S3(); | ||
|
|
||
| const s3Url = url.parse(argv.filename); | ||
| const s3Path = s3Url.path ? s3Url.path.replace(/^\//, '') : ''; | ||
| const s3Bucket = s3Url.hostname ? s3Url.hostname : ''; | ||
|
|
||
| const bucketDir = path.parse(s3Path).dir; | ||
|
|
||
| try { | ||
| await s3.headObject({ | ||
| Bucket: s3Bucket, | ||
| Key: s3Path.replace(/\.pending$/, '') | ||
| }).promise(); | ||
|
|
||
| logSuccess(`👍 The template has already been approved`); | ||
| } catch (e) { | ||
| if (e.code === 'NotFound') { | ||
|
|
||
| const pendingTemplate = await s3.getObject({ | ||
| Bucket: s3Bucket, | ||
| Key: s3Path | ||
| }).promise().then((template) => template.Body); | ||
|
|
||
| const previouslyApprovedTemplate = await s3.getObject({ | ||
| Bucket: s3Bucket, | ||
| Key: `${bucketDir}/latest` | ||
| }).promise() | ||
| .then((template) => template.Body) | ||
| .catch((e) => { | ||
| if (e.code !== 'NoSuchKey') { | ||
| return Promise.reject(e); | ||
| } | ||
| return Buffer.from(''); | ||
| }); | ||
|
|
||
| const diff = jsdiff.diffLines( | ||
| previouslyApprovedTemplate!.toString(), | ||
| pendingTemplate!.toString(), | ||
| ); | ||
| let colorizedString = ''; | ||
|
|
||
| diff.forEach(function(part) { | ||
| if (part.added) { | ||
| colorizedString = colorizedString + cli.green(part.value); | ||
| } else if (part.removed) { | ||
| colorizedString = colorizedString + cli.red(part.value); | ||
| } | ||
| }); | ||
| console.log(colorizedString); | ||
|
|
||
| const resp = await inquirer.prompt( | ||
| { | ||
| name: 'confirmed', | ||
| type: 'confirm', default: false, | ||
| message: `Do these changes look good for you?` | ||
| }); | ||
|
|
||
| if (resp.confirmed) { | ||
| // create a new pending file | ||
| await s3.putObject({ | ||
| Body: pendingTemplate, | ||
| Bucket: s3Bucket, | ||
| Key: s3Path.replace(/\.pending$/, '') | ||
| }).promise(); | ||
| logDebug('Created a new cfn-template'); | ||
|
|
||
| // copy to latest | ||
| await s3.putObject({ | ||
| Body: pendingTemplate, | ||
| Bucket: s3Bucket, | ||
| Key: `${bucketDir}/latest` | ||
| }).promise(); | ||
| logDebug('Updated latest'); | ||
|
|
||
| // delete the old pending file | ||
| await s3.deleteObject({ | ||
| Bucket: s3Bucket, | ||
| Key: s3Path | ||
| }).promise(); | ||
| logDebug('Deleted pending file.'); | ||
|
|
||
| console.log(); | ||
| logSuccess(`Template has been successfully approved!`); | ||
| return 0; | ||
| } else { | ||
| return 0; | ||
| } | ||
|
|
||
| } else { | ||
| throw new Error(e); | ||
| } | ||
| } | ||
|
|
||
| return 0; | ||
| } | ||
|
|
||
| function logSuccess(text: string) { | ||
| logger.info(cli.green(text)); | ||
| } | ||
|
|
||
| function logDebug(text: string) { | ||
| logger.debug(text); | ||
| } | ||
|
|
||
| function logError(text: string) { | ||
| logger.error(cli.red(text)); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters