Merge branch 'feature/env-vars' into develop, closes #20

Author: binoculars

.travis.yml

@@ -13,18 +13,22 @@ before_install:
 - |
   if [ -n "$TRAVIS_BRANCH" ]; then
     LOWER=${TRAVIS_BRANCH,,}
-    export S3_PREFIX="branch-${LOWER//[^a-z0-9]}"
+    export CFN_S3_PREFIX="branch-${LOWER//[^a-z0-9]}"
   fi
 
   if [ -n "$TRAVIS_TAG" ]; then
     LOWER=${$TRAVIS_TAG,,}
-    export S3_PREFIX="tag-${LOWER//[^a-z0-9]}"
+    export CFN_S3_PREFIX="tag-${LOWER//[^a-z0-9]}"
   fi
 
-  export STACK_NAME="${TRAVIS_REPO_SLUG//[^-a-zA-Z]/-}-$S3_PREFIX"
+  export STACK_NAME="${TRAVIS_REPO_SLUG//[^-a-zA-Z]/-}-$CFN_S3_PREFIX"
   export BUCKET_PREFIX="${STACK_NAME:0:59}"
-  export BUILD_DIR="$TRAVIS_BUILD_DIR"
-  $BUILD_DIR/test/integration/aws/config.sh
+  export SOURCE_BUCKET="$BUCKET_PREFIX-src"
+  export DESTINATION_BUCKET="$BUCKET_PREFIX-dst"
+  export FFMPEG_ARGS=$'-c:a copy -vf scale=\'min(320\\,iw):-2\' -movflags +faststart -metadata description=http://my.site/$KEY_PREFIX.mp4 out.mp4 -vf thumbnail -vf scale=\'min(320\\,iw):-2\' -vframes 1 out.png'
+  export USE_GZIP=false
+  export MIME_TYPES='{"png":"image/png","mp4":"video/mp4"}'
+  export VIDEO_MAX_DURATION='30'
 
 before_script:
 - yarn global add gulp

README.md

@@ -73,15 +73,37 @@ At minimum, you need to modify:
 export AWS_ACCESS_KEY_ID=AKIDEXAMPLE
 export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY
 export AWS_REGION=us-east-1
-export CONFIG_FILE=../config/aws.json
+export DESTINATION_BUCKET=destination-bucket
+# Note that the following variable is single-quote escaped. Use $KEY_PREFIX to get the filename minus the extension.
+export FFMPEG_ARGS=$'-c:a copy -vf scale=\'min(320\\,iw):-2\' -movflags +faststart -metadata description=http://my.site/$KEY_PREFIX.mp4 out.mp4 -vf thumbnail -vf scale=\'min(320\\,iw):-2\' -vframes 1 out.png'
+export USE_GZIP=false
+export MIME_TYPES='{"png":"image/png","mp4":"video/mp4"}'
+export VIDEO_MAX_DURATION='30'
 # Node version
 nvm use 4.3.2 # This is subject to change
 # Babel-node test script
 node node_modules/babel-cli/bin/babel-node.js test/aws.js
 ```
 
 ### Gulp
-Be sure to create your functionBucket first (e.g. `aws s3 mb s3://function-bucket` or in the console)
+
+#### Task: `aws:create-cfn-bucket`
+Creates the CloudFormation for your CloudFormation template and Lambda function code. **Run this once**, the result of
+this goes in environment variable, `CFN_S3_BUCKET`
+
+#### Environment Settings
+The following environment variables must be set prior to using the rest of the gulp commands
+
+```bash
+export CFN_S3_BUCKET=cloudformation-bucket
+export SOURCE_BUCKET=source-bucket
+export DESTINATION_BUCKET=destination-bucket
+# Note that the following variable is single-quote escaped. Use $KEY_PREFIX to get the filename minus the extension.
+export FFMPEG_ARGS=$'-c:a copy -vf scale=\'min(320\\,iw):-2\' -movflags +faststart -metadata description=http://my.site/$KEY_PREFIX.mp4 out.mp4 -vf thumbnail -vf scale=\'min(320\\,iw):-2\' -vframes 1 out.png'
+export USE_GZIP=false # can be true or false
+export MIME_TYPES='{"png":"image/png","mp4":"video/mp4"}' # must be a JSON object with "extension": "mimeType" as the key/value pairs
+export VIDEO_MAX_DURATION='30' # must be a number
+```
 
 #### Task: `aws:default`
 Everything you need to get started. Note: You can change the stack name by setting environment variable `STACK_NAME`.

config_samples/aws.json

@@ -23,6 +23,25 @@
 			"AllowedPattern": ".*\\.zip",
 			"Description": "The S3 key for the lambda function code"
 		},
+		"FFmpegArgs": {
+			"Type": "String",
+			"Description": "The arguments for the FFmpeg command"
+		},
+		"MimeTypes": {
+			"Type": "String",
+			"Description": "A JSON map of extensions to MIME types"
+		},
+		"UseGzip": {
+			"Type": "String",
+			"AllowedPattern": "^(true|false)$",
+			"Description": "Whether to use gzip or not"
+		},
+		"VideoMaxDuration": {
+			"Type": "String",
+			"AllowedPattern": "^\\d+(\\.\\d+)*$",
+			"Default": "30",
+			"Description": "The maximum duration of a video, in seconds"
+		},
 		"ExecutionRoleManagedPolicyArn": {
 			"Type": "String",
 			"Default": "",
@@ -170,6 +189,25 @@
 						"Arn"
 					]
 				},
+				"Environment": {
+					"Variables": {
+						"DESTINATION_BUCKET": {
+							"Ref": "DestinationBucketName"
+						},
+						"FFMPEG_ARGS": {
+							"Ref": "FFmpegArgs"
+						},
+						"USE_GZIP": {
+							"Ref": "UseGzip"
+						},
+						"MIME_TYPES": {
+							"Ref": "MimeTypes"
+						},
+						"VIDEO_MAX_DURATION": {
+							"Ref": "VideoMaxDuration"
+						}
+					}
+				},
 				"Timeout": 30,
 				"Handler": "aws/index.handler",
 				"Runtime": "nodejs4.3",

platform/aws/cloudformation.json

@@ -12,21 +12,11 @@ const cloudFormation = new AWS.CloudFormation();
 const packageInfo = require('../../package.json');
 const lib = require('./gulp-lib');
 
-let config = {};
-try {
-	config = require('../../config/aws.json');
-} catch (ex) {
-	config = {};
-}
-
-const Bucket = process.env.S3_BUCKET || config.functionBucket;
-const s3Prefix = process.env.S3_PREFIX || packageInfo.name;
+const Bucket = process.env.CFN_S3_BUCKET;
+const s3Prefix = process.env.CFN_S3_PREFIX || packageInfo.name;
 const templateKey = `${s3Prefix}/cloudformation.template`;
 const lambdaKey = `${s3Prefix}/lambda.zip`;
 const StackName = process.env.STACK_NAME || packageInfo.name;
-const bucketPrefix = process.env.BUCKET_PREFIX;
-const sourceBucket = process.env.CI ? `${bucketPrefix}-src` : config.sourceBucket;
-const destinationBucket = process.env.CI ? `${bucketPrefix}-dst` : config.destinationBucket;
 const now = new Date();
 
 function getCloudFormationOperation(StackName) {
@@ -117,11 +107,11 @@ module.exports = function(gulp, prefix) {
 		const Parameters = [
 			{
 				ParameterKey: 'SourceBucketName',
-				ParameterValue: sourceBucket
+				ParameterValue: process.env.SOURCE_BUCKET
 			},
 			{
 				ParameterKey: 'DestinationBucketName',
-				ParameterValue: destinationBucket
+				ParameterValue: process.env.DESTINATION_BUCKET
 			},
 			{
 				ParameterKey: 'LambdaS3Bucket',
@@ -130,6 +120,22 @@ module.exports = function(gulp, prefix) {
 			{
 				ParameterKey: 'LambdaS3Key',
 				ParameterValue: lambdaKey
+			},
+			{
+				ParameterKey: 'FFmpegArgs',
+				ParameterValue: process.env.FFMPEG_ARGS
+			},
+			{
+				ParameterKey: 'UseGzip',
+				ParameterValue: process.env.USE_GZIP
+			},
+			{
+				ParameterKey: 'MimeTypes',
+				ParameterValue: process.env.MIME_TYPES
+			},
+			{
+				ParameterKey: 'VideoMaxDuration',
+				ParameterValue: process.env.VIDEO_MAX_DURATION
 			}
 		];
 
@@ -221,7 +227,7 @@ module.exports = function(gulp, prefix) {
 			['CIRegion', 'AWS_REGION'],
 			['ServiceRoleArn', 'CLOUDFORMATION_ROLE_ARN'],
 			['ModulePolicyArn', 'EXECUTION_ROLE_ARN'],
-			['Bucket', 'S3_BUCKET']
+			['Bucket', 'CFN_S3_BUCKET']
 		]);
 
 		return Promise
@@ -293,4 +299,12 @@ module.exports = function(gulp, prefix) {
 					.join('\n')
 			))
 	});
+
+	gulp.task(`${prefix}:create-cfn-bucket`, () => s3
+		.createBucket({
+			Bucket
+		})
+		.promise()
+		.catch(console.error)
+	);
 };