fix(aws-ecs): allow linux parameters to be settable (#2397)

SoManyHs · rix0rrr · commit 417e5e89403c · 2019-05-07T10:21:46.000+02:00
Fixes #2380
diff --git a/packages/@aws-cdk/aws-codepipeline-actions/test/integ.pipeline-ecs-deploy.expected.json b/packages/@aws-cdk/aws-codepipeline-actions/test/integ.pipeline-ecs-deploy.expected.json
@@ -231,14 +231,6 @@
             "Essential": true,
             "Image": "amazon/amazon-ecs-sample",
             "Links": [],
-            "LinuxParameters": {
-              "Capabilities": {
-                "Add": [],
-                "Drop": []
-              },
-              "Devices": [],
-              "Tmpfs": []
-            },
             "MountPoints": [],
             "Name": "Container",
             "PortMappings": [],
diff --git a/packages/@aws-cdk/aws-ecs/lib/container-definition.ts b/packages/@aws-cdk/aws-ecs/lib/container-definition.ts
@@ -168,6 +168,11 @@ export interface ContainerDefinitionOptions {
    * Configures a custom log driver for the container.
    */
   readonly logging?: LogDriver;
+
+  /**
+   * Configures Linux Parameters
+   */
+  readonly linuxParameters?: LinuxParameters;
 }
 
 /**
@@ -187,7 +192,7 @@ export class ContainerDefinition extends cdk.Construct {
   /**
    * Access Linux Parameters
    */
-  public readonly linuxParameters = new LinuxParameters();
+  public readonly linuxParameters?: LinuxParameters;
 
   /**
    * The configured mount points
@@ -234,6 +239,7 @@ export class ContainerDefinition extends cdk.Construct {
     this.essential = props.essential !== undefined ? props.essential : true;
     this.taskDefinition = props.taskDefinition;
     this.memoryLimitSpecified = props.memoryLimitMiB !== undefined || props.memoryReservationMiB !== undefined;
+    this.linuxParameters = props.linuxParameters;
 
     props.image.bind(this);
     if (props.logging) { props.logging.bind(this); }
@@ -394,7 +400,7 @@ export class ContainerDefinition extends cdk.Construct {
       extraHosts: this.props.extraHosts && renderKV(this.props.extraHosts, 'hostname', 'ipAddress'),
       healthCheck: this.props.healthCheck && renderHealthCheck(this.props.healthCheck),
       links: this.links,
-      linuxParameters: this.linuxParameters.renderLinuxParameters(),
+      linuxParameters: this.linuxParameters && this.linuxParameters.renderLinuxParameters(),
     };
   }
 }
diff --git a/packages/@aws-cdk/aws-ecs/lib/linux-parameters.ts b/packages/@aws-cdk/aws-ecs/lib/linux-parameters.ts
@@ -1,38 +1,61 @@
+import cdk = require('@aws-cdk/cdk');
 import { CfnTaskDefinition } from './ecs.generated';
 
 /**
- * Linux parameter setup in a container
+ * Properties for defining Linux Parameters
  */
-export class LinuxParameters {
+export interface LinuxParametersProps {
   /**
    * Whether the init process is enabled
    */
-  public initProcessEnabled?: boolean;
+  readonly initProcessEnabled?: boolean;
 
   /**
    * The shared memory size
    */
-  public sharedMemorySize?: number;
+  readonly sharedMemorySize?: number;
+}
+
+/**
+ * Linux Parameters for an ECS container
+ */
+export class LinuxParameters extends cdk.Construct {
+  /**
+   * Whether the init process is enabled
+   */
+  private readonly initProcessEnabled?: boolean;
+
+  /**
+   * The shared memory size. Not valid for Fargate launch type
+   */
+  private readonly sharedMemorySize?: number;
 
   /**
    * Capabilities to be added
    */
-  private readonly capAdd: Capability[] = [];
+  private readonly capAdd = new Array<Capability>();
 
   /**
    * Capabilities to be dropped
    */
-  private readonly capDrop: Capability[] = [];
+  private readonly capDrop = new Array<Capability>();
 
   /**
    * Device mounts
    */
-  private readonly devices: Device[] = [];
+  private readonly devices = new Array<Device>();
 
   /**
-   * TMPFS mounts
+   * TmpFs mounts
    */
-  private readonly tmpfs: Tmpfs[] = [];
+  private readonly tmpfs = new Array<Tmpfs>();
+
+  constructor(scope: cdk.Construct, id: string, props: LinuxParametersProps = {}) {
+    super(scope, id);
+
+    this.sharedMemorySize = props.sharedMemorySize;
+    this.initProcessEnabled = props.initProcessEnabled;
+  }
 
   /**
    * Add one or more capabilities
@@ -61,6 +84,8 @@ export class LinuxParameters {
 
   /**
    * Add one or more tmpfs mounts
+   *
+   * Only works with EC2 launch type.
    */
   public addTmpfs(...tmpfs: Tmpfs[]) {
     this.tmpfs.push(...tmpfs);
diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/integ.event-task.lit.expected.json b/packages/@aws-cdk/aws-ecs/test/ec2/integ.event-task.lit.expected.json
@@ -710,14 +710,6 @@
               ]
             },
             "Links": [],
-            "LinuxParameters": {
-              "Capabilities": {
-                "Add": [],
-                "Drop": []
-              },
-              "Devices": [],
-              "Tmpfs": []
-            },
             "LogConfiguration": {
               "LogDriver": "awslogs",
               "Options": {
@@ -1159,4 +1151,4 @@
       "Description": "S3 key for asset version \"aws-ecs-integ-ecs/AdoptEcrRepositorydbc60defc59544bcaa5c28c95d68f62c/Code\""
     }
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/integ.lb-awsvpc-nw.expected.json b/packages/@aws-cdk/aws-ecs/test/ec2/integ.lb-awsvpc-nw.expected.json
@@ -766,14 +766,6 @@
             "Essential": true,
             "Image": "amazon/amazon-ecs-sample",
             "Links": [],
-            "LinuxParameters": {
-              "Capabilities": {
-                "Add": [],
-                "Drop": []
-              },
-              "Devices": [],
-              "Tmpfs": []
-            },
             "Memory": 256,
             "MountPoints": [],
             "Name": "web",
@@ -1006,4 +998,4 @@
       }
     }
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/integ.lb-bridge-nw.expected.json b/packages/@aws-cdk/aws-ecs/test/ec2/integ.lb-bridge-nw.expected.json
@@ -787,14 +787,6 @@
             "Essential": true,
             "Image": "amazon/amazon-ecs-sample",
             "Links": [],
-            "LinuxParameters": {
-              "Capabilities": {
-                "Add": [],
-                "Drop": []
-              },
-              "Devices": [],
-              "Tmpfs": []
-            },
             "Memory": 256,
             "MountPoints": [],
             "Name": "web",
@@ -969,4 +961,4 @@
       }
     }
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/integ.sd-awsvpc-nw.expected.json b/packages/@aws-cdk/aws-ecs/test/ec2/integ.sd-awsvpc-nw.expected.json
@@ -775,14 +775,6 @@
             "Essential": true,
             "Image": "amazon/amazon-ecs-sample",
             "Links": [],
-            "LinuxParameters": {
-              "Capabilities": {
-                "Add": [],
-                "Drop": []
-              },
-              "Devices": [],
-              "Tmpfs": []
-            },
             "Memory": 256,
             "MountPoints": [],
             "Name": "frontend",
diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/integ.sd-bridge-nw.expected.json b/packages/@aws-cdk/aws-ecs/test/ec2/integ.sd-bridge-nw.expected.json
@@ -775,14 +775,6 @@
             "Essential": true,
             "Image": "amazon/amazon-ecs-sample",
             "Links": [],
-            "LinuxParameters": {
-              "Capabilities": {
-                "Add": [],
-                "Drop": []
-              },
-              "Devices": [],
-              "Tmpfs": []
-            },
             "Memory": 256,
             "MountPoints": [],
             "Name": "frontend",
diff --git a/packages/@aws-cdk/aws-ecs/test/ec2/test.ec2-task-definition.ts b/packages/@aws-cdk/aws-ecs/test/ec2/test.ec2-task-definition.ts
@@ -71,14 +71,6 @@ export = {
           Memory: 512,
           Image: "amazon/amazon-ecs-sample",
           Links: [],
-          LinuxParameters: {
-            Capabilities: {
-              Add: [],
-              Drop: []
-            },
-            Devices: [],
-            Tmpfs: []
-          },
           MountPoints: [],
           Name: "web",
           PortMappings: [{
diff --git a/packages/@aws-cdk/aws-ecs/test/fargate/integ.asset-image.expected.json b/packages/@aws-cdk/aws-ecs/test/fargate/integ.asset-image.expected.json
@@ -761,14 +761,6 @@
               ]
             },
             "Links": [],
-            "LinuxParameters": {
-              "Capabilities": {
-                "Add": [],
-                "Drop": []
-              },
-              "Devices": [],
-              "Tmpfs": []
-            },
             "LogConfiguration": {
               "LogDriver": "awslogs",
               "Options": {
@@ -1040,4 +1032,4 @@
       }
     }
   }
-}
+}
diff --git a/packages/@aws-cdk/aws-ecs/test/fargate/integ.l3.expected.json b/packages/@aws-cdk/aws-ecs/test/fargate/integ.l3.expected.json
@@ -481,14 +481,6 @@
             "Essential": true,
             "Image": "amazon/amazon-ecs-sample",
             "Links": [],
-            "LinuxParameters": {
-              "Capabilities": {
-                "Add": [],
-                "Drop": []
-              },
-              "Devices": [],
-              "Tmpfs": []
-            },
             "LogConfiguration": {
               "LogDriver": "awslogs",
               "Options": {
diff --git a/packages/@aws-cdk/aws-ecs/test/fargate/integ.lb-awsvpc-nw.expected.json b/packages/@aws-cdk/aws-ecs/test/fargate/integ.lb-awsvpc-nw.expected.json
@@ -381,14 +381,6 @@
             "Essential": true,
             "Image": "amazon/amazon-ecs-sample",
             "Links": [],
-            "LinuxParameters": {
-              "Capabilities": {
-                "Add": [],
-                "Drop": []
-              },
-              "Devices": [],
-              "Tmpfs": []
-            },
             "MountPoints": [],
             "Name": "web",
             "PortMappings": [
diff --git a/packages/@aws-cdk/aws-ecs/test/test.container-definition.ts b/packages/@aws-cdk/aws-ecs/test/test.container-definition.ts
diff --git a/packages/decdk/test/__snapshots__/synth.test.js.snap b/packages/decdk/test/__snapshots__/synth.test.js.snap

Original file line number	Diff line number	Diff line change
`@@ -761,14 +761,6 @@`
`761`	`761`	`]`
`762`	`762`	`},`
`763`	`763`	`"Links": [],`
`764`		`- "LinuxParameters": {`
`765`		`- "Capabilities": {`
`766`		`- "Add": [],`
`767`		`- "Drop": []`
`768`		`- },`
`769`		`- "Devices": [],`
`770`		`- "Tmpfs": []`
`771`		`- },`
`772`	`764`	`"LogConfiguration": {`
`773`	`765`	`"LogDriver": "awslogs",`
`774`	`766`	`"Options": {`
`@@ -1040,4 +1032,4 @@`
`1040`	`1032`	`}`
`1041`	`1033`	`}`
`1042`	`1034`	`}`
`1043`		`-}`
	`1035`	`+}`