@rlyle1179/serverless-aws-batch 1.1.19 → 1.1.20

package/lib/docker.js

@@ -1,139 +1,139 @@
-const BbPromise = require('bluebird');
-const { spawnSync } = require('child_process');
-const _ = require('lodash');
-const fse = require('fs-extra');
-const path = require('path');
-const util = require('util');
-const { getDockerLoginToECRCommand } = require('./awscli');
-
-const DOCKER_TAG = `${Date.now()}`;
-
-/**
- * @returns {string} "<ECR Repo Name>:latest"
- */
-function getDockerImageName() {
-    return `${this.provider.naming.getECRRepositoryURL()}:${DOCKER_TAG}`;
-}
-
-/**
- * Helper function to run a docker command
- * @param {string[]} options
- * @param {string} cwd Current working directory
- * @return {Object}
- */
-function dockerCommand(options, cwd = null, stdio = null) {
-    const cmd = 'docker';
-    var spawnOptions = {
-        encoding: 'utf-8'
-    }
-    if (cwd != null) {
-        spawnOptions.cwd = cwd;
-    }
-    if (stdio != null) {
-        spawnOptions.stdio = stdio;
-    }
-    
-    //console.error("dockerCommand:", options, spawnOptions);
-    const ps = spawnSync(cmd, options, spawnOptions);
-    if (ps.error) {
-        if (ps.error.code === 'ENOENT') {
-            throw new Error('docker not found! Please install it.');
-        }
-        throw new Error(ps.error);
-    } else if (ps.status !== 0) {
-        //console.error("docker output:", ps.output);
-        //console.error("docker stdout:", ps.stdout);
-        //console.error("docker stderr:", ps.stderr)
-        throw new Error(ps.stderr);
-    }
-    return ps;
-}
-
-/**
- * Build the custom Docker image by copying our package to the /var/task directory
- * in the docker image.
- * 
- * Our base image uses the Lambda Docker Image for the platform:
- * https://hub.docker.com/r/lambci/lambda/
- */
-function buildDockerImage() {
-    let image = this.provider.naming.getDockerImageName();
-    this.serverless.cli.log(`Building docker image: "${image}"...`);
-
-    // Get any additional run commands we'd like to include in the docker image
-    let addtionalBuildCommands = "";
-    if (this.serverless.service.custom
-        && this.serverless.service.custom.awsBatch
-        && this.serverless.service.custom.awsBatch.addtionalBuildCommands) {
-
-        _.forEach(
-            this.serverless.service.custom.awsBatch.addtionalBuildCommands,
-            runCommand => {
-                addtionalBuildCommands += `${runCommand}\n`;
-            }
-        )
-    }
-
-    let additionalCommands = "";
-    if (this.serverless.service.custom
-        && this.serverless.service.custom.awsBatch
-        && this.serverless.service.custom.awsBatch.additionalCommands) {
-
-        _.forEach(
-            this.serverless.service.custom.awsBatch.additionalCommands,
-            runCommand => {
-                additionalCommands += `${runCommand}\n`;
-            }
-        )
-    }
-
-    let buildImage = _.get(this.serverless.service,"custom.awsBatch.buildImage", "368461407828.dkr.ecr.us-east-1.amazonaws.com/build-batch-image-base:latest" );
-    let batchImage = _.get(this.serverless.service,"custom.awsBatch.batchImage", "368461407828.dkr.ecr.us-east-1.amazonaws.com/batch-image-base:latest" );
-
-    // Override some of the default lambci environmental variables.
-    //   - Function Timeout and Function Memory are set by Env Variables on the Job Definition
-    //   - Access Key and Secret are unset to that we use the role on the container that AWS provides
-    const dockerFileContents = `
-    FROM ${buildImage} AS builder
-    USER root
-    RUN mkdir -p /tmp/task/
-    COPY ${this.serverless.service.service}.zip /tmp/task
-    RUN cd /tmp/task && unzip -q ${this.serverless.service.service}.zip && rm ${this.serverless.service.service}.zip
-    ${addtionalBuildCommands}
-
-    FROM ${batchImage}
-    USER root
-    COPY --from=builder /tmp/task /var/task/
-    ${additionalCommands}
-    RUN rm -rf /tmp/*
-    USER sbx_user1051
-    `;
-
-    const servicePath = this.serverless.config.servicePath || '';
-    const packagePath = path.join(servicePath || '.', '.serverless');
-    const dockerFile = path.join(packagePath, 'Dockerfile');
-    fse.writeFileSync(dockerFile, dockerFileContents);
-
-    const dockerOptions = ['build', '-f', dockerFile, '-t', image, '.'];
-    dockerCommand(dockerOptions, packagePath, 'inherit');
-
-    return BbPromise.resolve();
-}
-
-/**
- * Uses docker to upload the image to ECR
- */
-function pushDockerImageToECR() {
-    // Log docker into our AWS ECR repo so that we can push images to it
-    this.serverless.cli.log("Logging into ECR...");
-    const loginCommand = getDockerLoginToECRCommand.bind(this)();
-    dockerCommand(loginCommand.split(" "));
-
-    // Then perform the upload
-    this.serverless.cli.log("Uploading to ECR...");
-    dockerCommand(['push', '--all-tags', this.provider.naming.getECRRepositoryURL()], null, 'inherit');
-
-    return BbPromise.resolve();
-}
-
-module.exports = { getDockerImageName, buildDockerImage, pushDockerImageToECR };
+const BbPromise = require('bluebird');
+const { spawnSync } = require('child_process');
+const _ = require('lodash');
+const fse = require('fs-extra');
+const path = require('path');
+const util = require('util');
+const { getDockerLoginToECRCommand } = require('./awscli');
+
+const DOCKER_TAG = `${Date.now()}`;
+
+/**
+ * @returns {string} "<ECR Repo Name>:latest"
+ */
+function getDockerImageName() {
+    return `${this.provider.naming.getECRRepositoryURL()}:${DOCKER_TAG}`;
+}
+
+/**
+ * Helper function to run a docker command
+ * @param {string[]} options
+ * @param {string} cwd Current working directory
+ * @return {Object}
+ */
+function dockerCommand(options, cwd = null, stdio = null) {
+    const cmd = 'docker';
+    var spawnOptions = {
+        encoding: 'utf-8'
+    }
+    if (cwd != null) {
+        spawnOptions.cwd = cwd;
+    }
+    if (stdio != null) {
+        spawnOptions.stdio = stdio;
+    }
+    
+    //console.error("dockerCommand:", options, spawnOptions);
+    const ps = spawnSync(cmd, options, spawnOptions);
+    if (ps.error) {
+        if (ps.error.code === 'ENOENT') {
+            throw new Error('docker not found! Please install it.');
+        }
+        throw new Error(ps.error);
+    } else if (ps.status !== 0) {
+        //console.error("docker output:", ps.output);
+        //console.error("docker stdout:", ps.stdout);
+        //console.error("docker stderr:", ps.stderr)
+        throw new Error(ps.stderr);
+    }
+    return ps;
+}
+
+/**
+ * Build the custom Docker image by copying our package to the /var/task directory
+ * in the docker image.
+ * 
+ * Our base image uses the Lambda Docker Image for the platform:
+ * https://hub.docker.com/r/lambci/lambda/
+ */
+function buildDockerImage() {
+    let image = this.provider.naming.getDockerImageName();
+    this.serverless.cli.log(`Building docker image: "${image}"...`);
+
+    // Get any additional run commands we'd like to include in the docker image
+    let addtionalBuildCommands = "";
+    if (this.serverless.service.custom
+        && this.serverless.service.custom.awsBatch
+        && this.serverless.service.custom.awsBatch.addtionalBuildCommands) {
+
+        _.forEach(
+            this.serverless.service.custom.awsBatch.addtionalBuildCommands,
+            runCommand => {
+                addtionalBuildCommands += `${runCommand}\n`;
+            }
+        )
+    }
+
+    let additionalCommands = "";
+    if (this.serverless.service.custom
+        && this.serverless.service.custom.awsBatch
+        && this.serverless.service.custom.awsBatch.additionalCommands) {
+
+        _.forEach(
+            this.serverless.service.custom.awsBatch.additionalCommands,
+            runCommand => {
+                additionalCommands += `${runCommand}\n`;
+            }
+        )
+    }
+
+    let buildImage = _.get(this.serverless.service,"custom.awsBatch.buildImage", "368461407828.dkr.ecr.us-east-1.amazonaws.com/build-batch-image-base:latest" );
+    let batchImage = _.get(this.serverless.service,"custom.awsBatch.batchImage", "368461407828.dkr.ecr.us-east-1.amazonaws.com/batch-image-base:latest" );
+
+    // Override some of the default lambci environmental variables.
+    //   - Function Timeout and Function Memory are set by Env Variables on the Job Definition
+    //   - Access Key and Secret are unset to that we use the role on the container that AWS provides
+    const dockerFileContents = `
+    FROM ${buildImage} AS builder
+    USER root
+    RUN mkdir -p /tmp/task/
+    COPY ${this.serverless.service.service}.zip /tmp/task
+    RUN cd /tmp/task && unzip -q ${this.serverless.service.service}.zip && rm ${this.serverless.service.service}.zip
+    ${addtionalBuildCommands}
+
+    FROM ${batchImage}
+    USER root
+    COPY --from=builder /tmp/task /var/task/
+    ${additionalCommands}
+    RUN rm -rf /tmp/*
+    USER sbx_user1051
+    `;
+
+    const servicePath = this.serverless.config.servicePath || '';
+    const packagePath = path.join(servicePath || '.', '.serverless');
+    const dockerFile = path.join(packagePath, 'Dockerfile');
+    fse.writeFileSync(dockerFile, dockerFileContents);
+
+    const dockerOptions = ['build', '-f', dockerFile, '-t', image, '.'];
+    dockerCommand(dockerOptions, packagePath, 'inherit');
+
+    return BbPromise.resolve();
+}
+
+/**
+ * Uses docker to upload the image to ECR
+ */
+function pushDockerImageToECR() {
+    // Log docker into our AWS ECR repo so that we can push images to it
+    this.serverless.cli.log("Logging into ECR...");
+    const loginCommand = getDockerLoginToECRCommand.bind(this)();
+    dockerCommand(loginCommand.split(" "));
+
+    // Then perform the upload
+    this.serverless.cli.log("Uploading to ECR...");
+    dockerCommand(['push', '--all-tags', this.provider.naming.getECRRepositoryURL()], null, 'inherit');
+
+    return BbPromise.resolve();
+}
+
+module.exports = { getDockerImageName, buildDockerImage, pushDockerImageToECR };

package/lib/ecr.js

@@ -1,30 +1,30 @@
-const { getAWSAccountID } = require('./awscli');
-
-/**
- * @returns {string} "ECRRepository"
- */
-function getECRLogicalId() {
-  return "ECRRepository";
-}
-
-/**
- * @returns {string} "<serviceName>-<stage>"
- */
-function getECRRepositoryName() {
-  return `${this.provider.serverless.service.service}-${this.provider.getStage()}`;
-}
-
-
-/**
- * @type {string} "<awsAccountID>.dkr.ecr.us-east-1.amazonaws.com/<serviceName>-<stage>:<tag>"
- */
-
-function getECRRepositoryURL() {
-  return `${getAWSAccountID()}.dkr.ecr.${this.provider.getRegion()}.amazonaws.com/${this.provider.naming.getECRRepositoryName()}`
-}
-
-module.exports = {
-  getECRLogicalId,
-  getECRRepositoryName,
-  getECRRepositoryURL
+const { getAWSAccountID } = require('./awscli');
+
+/**
+ * @returns {string} "ECRRepository"
+ */
+function getECRLogicalId() {
+  return "ECRRepository";
+}
+
+/**
+ * @returns {string} "<serviceName>-<stage>"
+ */
+function getECRRepositoryName() {
+  return `${this.provider.serverless.service.service}-${this.provider.getStage()}`;
+}
+
+
+/**
+ * @type {string} "<awsAccountID>.dkr.ecr.us-east-1.amazonaws.com/<serviceName>-<stage>:<tag>"
+ */
+
+function getECRRepositoryURL() {
+  return `${getAWSAccountID()}.dkr.ecr.${this.provider.getRegion()}.amazonaws.com/${this.provider.naming.getECRRepositoryName()}`
+}
+
+module.exports = {
+  getECRLogicalId,
+  getECRRepositoryName,
+  getECRRepositoryURL
 }

package/lib/generateCoreTemplate.js

@@ -1,121 +1,121 @@
-// Handles setting up our ECR repository so that we can push our docker image to it
-
-'use strict';
-
-const BbPromise = require('bluebird');
-const path = require('path');
-const _ = require('lodash');
-var util = require('util');
-
-const lifeCyclePolicies = {
-    "rules": [
-        {
-            "rulePriority": 1,
-            "description": "Remove images over 90 days old",
-            "selection": {
-                "tagStatus": "any",
-                "countType": "sinceImagePushed",
-                "countUnit": "days",
-                "countNumber": 90
-            },
-            "action": {
-                "type": "expire"
-            }
-        }
-    ]
-};
-
-/**
- * Adds the ECR repository to the "create" template so that we have a repository we can upload our docker image to
- * during deployment.
- */
-function generateCoreTemplate() {
-    // Setup our ECR Repository to delete untagged images after 1 day
-    // const ecrTemplate = `
-    //   {
-    //     "Type" : "AWS::ECR::Repository",
-    //     "Properties" : {
-    //       "LifecyclePolicy" : {
-    //         "LifecyclePolicyText" : ${JSON.stringify(JSON.stringify(lifeCyclePolicies))}
-    //       },
-    //       "RepositoryName" : "${this.provider.naming.getECRRepositoryName()}"
-    //     }
-    //   }
-    // `;
-    const ecrTemplate = `
-      {
-        "Type" : "AWS::ECR::Repository",
-        "Properties" : {
-          "RepositoryName" : "${this.provider.naming.getECRRepositoryName()}"
-        }
-      }
-    `;
-
-    const newECRObject = {
-        [this.provider.naming.getECRLogicalId()]: JSON.parse(ecrTemplate)
-    };
-
-    // Add it to our initial compiled cloud formation templates
-    _.merge(
-        this.serverless.service.provider.compiledCloudFormationTemplate.Resources,
-        newECRObject
-    );
-
-    // Look for the serverless-log-forwarding custom parameters, if found, then forward the logs
-    // from our batch jobs to the same ARN...
-    const logGroupName = _.get(this.serverless.service,"custom.awsBatch.logGroupName");
-    const logDestinationArn = _.get(this.serverless.service,"custom.logForwarding.destinationARN" );
-    if ( logDestinationArn && logGroupName ) {
-        const batchLogGroupTemplate = {
-            "BatchLogGroupLambdaPermission": {
-                "Type": "AWS::Lambda::Permission",
-                "Properties": {
-                    "FunctionName": logDestinationArn,
-                    "Action": "lambda:InvokeFunction",
-                    "Principal": "logs.us-east-1.amazonaws.com"
-                }
-            },
-            "BatchLogGroup": {
-                "Type": "AWS::Logs::LogGroup",
-                "Properties": {
-                    "LogGroupName": logGroupName,
-                    "RetentionInDays": 7
-                }
-            },
-            "BatchLogGroupSubscriptionFilter": {
-                "Type": "AWS::Logs::SubscriptionFilter",
-                "Properties": {
-                    "DestinationArn": logDestinationArn,
-                    "FilterPattern": "",
-                    "LogGroupName": logGroupName
-                },
-                "DependsOn": [
-                    "BatchLogGroupLambdaPermission",
-                    "BatchLogGroup"
-                ]
-            }
-        }
-    
-        _.merge(
-            this.serverless.service.provider.compiledCloudFormationTemplate.Resources,
-            batchLogGroupTemplate
-        );
-    }
-
-    // Then write it back out to the file
-    const coreTemplateFileName = this.provider.naming.getCoreTemplateFileName();
-
-    const coreTemplateFilePath = path.join(this.serverless.config.servicePath,
-        '.serverless',
-        coreTemplateFileName);
-
-    this.serverless.utils.writeFileSync(coreTemplateFilePath,
-        this.serverless.service.provider.compiledCloudFormationTemplate);
-
-    this.serverless.service.provider.coreCloudFormationTemplate =
-        _.cloneDeep(this.serverless.service.provider.compiledCloudFormationTemplate);
-
-    return BbPromise.resolve();
-}
-
+// Handles setting up our ECR repository so that we can push our docker image to it
+
+'use strict';
+
+const BbPromise = require('bluebird');
+const path = require('path');
+const _ = require('lodash');
+var util = require('util');
+
+const lifeCyclePolicies = {
+    "rules": [
+        {
+            "rulePriority": 1,
+            "description": "Remove images over 90 days old",
+            "selection": {
+                "tagStatus": "any",
+                "countType": "sinceImagePushed",
+                "countUnit": "days",
+                "countNumber": 90
+            },
+            "action": {
+                "type": "expire"
+            }
+        }
+    ]
+};
+
+/**
+ * Adds the ECR repository to the "create" template so that we have a repository we can upload our docker image to
+ * during deployment.
+ */
+function generateCoreTemplate() {
+    // Setup our ECR Repository to delete untagged images after 1 day
+    // const ecrTemplate = `
+    //   {
+    //     "Type" : "AWS::ECR::Repository",
+    //     "Properties" : {
+    //       "LifecyclePolicy" : {
+    //         "LifecyclePolicyText" : ${JSON.stringify(JSON.stringify(lifeCyclePolicies))}
+    //       },
+    //       "RepositoryName" : "${this.provider.naming.getECRRepositoryName()}"
+    //     }
+    //   }
+    // `;
+    const ecrTemplate = `
+      {
+        "Type" : "AWS::ECR::Repository",
+        "Properties" : {
+          "RepositoryName" : "${this.provider.naming.getECRRepositoryName()}"
+        }
+      }
+    `;
+
+    const newECRObject = {
+        [this.provider.naming.getECRLogicalId()]: JSON.parse(ecrTemplate)
+    };
+
+    // Add it to our initial compiled cloud formation templates
+    _.merge(
+        this.serverless.service.provider.compiledCloudFormationTemplate.Resources,
+        newECRObject
+    );
+
+    // Look for the serverless-log-forwarding custom parameters, if found, then forward the logs
+    // from our batch jobs to the same ARN...
+    const logGroupName = _.get(this.serverless.service,"custom.awsBatch.logGroupName");
+    const logDestinationArn = _.get(this.serverless.service,"custom.logForwarding.destinationARN" );
+    if ( logDestinationArn && logGroupName ) {
+        const batchLogGroupTemplate = {
+            "BatchLogGroupLambdaPermission": {
+                "Type": "AWS::Lambda::Permission",
+                "Properties": {
+                    "FunctionName": logDestinationArn,
+                    "Action": "lambda:InvokeFunction",
+                    "Principal": "logs.us-east-1.amazonaws.com"
+                }
+            },
+            "BatchLogGroup": {
+                "Type": "AWS::Logs::LogGroup",
+                "Properties": {
+                    "LogGroupName": logGroupName,
+                    "RetentionInDays": 7
+                }
+            },
+            "BatchLogGroupSubscriptionFilter": {
+                "Type": "AWS::Logs::SubscriptionFilter",
+                "Properties": {
+                    "DestinationArn": logDestinationArn,
+                    "FilterPattern": "",
+                    "LogGroupName": logGroupName
+                },
+                "DependsOn": [
+                    "BatchLogGroupLambdaPermission",
+                    "BatchLogGroup"
+                ]
+            }
+        }
+    
+        _.merge(
+            this.serverless.service.provider.compiledCloudFormationTemplate.Resources,
+            batchLogGroupTemplate
+        );
+    }
+
+    // Then write it back out to the file
+    const coreTemplateFileName = this.provider.naming.getCoreTemplateFileName();
+
+    const coreTemplateFilePath = path.join(this.serverless.config.servicePath,
+        '.serverless',
+        coreTemplateFileName);
+
+    this.serverless.utils.writeFileSync(coreTemplateFilePath,
+        this.serverless.service.provider.compiledCloudFormationTemplate);
+
+    this.serverless.service.provider.coreCloudFormationTemplate =
+        _.cloneDeep(this.serverless.service.provider.compiledCloudFormationTemplate);
+
+    return BbPromise.resolve();
+}
+
 module.exports = { generateCoreTemplate };