fix(ecs): rename cfnservice id to resource

aws · Feb 18, 2020 · cfdf1fa · cfdf1fa
1 parent c505348
commit cfdf1fa
Show file tree

Hide file tree

Showing 3 changed files with 144 additions and 3 deletions.
diff --git a/packages/@aws-cdk/aws-ecs/lib/base/base-service.ts b/packages/@aws-cdk/aws-ecs/lib/base/base-service.ts
@@ -6,6 +6,7 @@ import * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';
 import * as iam from '@aws-cdk/aws-iam';
 import * as cloudmap from '@aws-cdk/aws-servicediscovery';
 import { Construct, Duration, IResolvable, IResource, Lazy, Resource, Stack } from '@aws-cdk/core';
+import * as cxapi from '@aws-cdk/cx-api';
 import { LoadBalancerTargetOptions, NetworkMode, TaskDefinition } from '../base/task-definition';
 import { ICluster } from '../cluster';
 import { Protocol } from '../container-definition';
@@ -318,7 +319,11 @@ export abstract class BaseService extends Resource
 
     this.taskDefinition = taskDefinition;
 
-    this.resource = new CfnService(this, "Service", {
+    const cfnServiceId =  this.node.tryGetContext(cxapi.ENABLE_CFN_SERVICE_RESOURCE_RENAME)
+      ? "Resource"
+      : "Service";
+
+    this.resource = new CfnService(this, cfnServiceId, {
       desiredCount: props.desiredCount,
       serviceName: this.physicalName,
       loadBalancers: Lazy.anyValue({ produce: () => this.loadBalancers }, { omitEmptyArray: true }),

diff --git a/packages/@aws-cdk/aws-ecs/test/fargate/test.fargate-service.ts b/packages/@aws-cdk/aws-ecs/test/fargate/test.fargate-service.ts
@@ -1,16 +1,145 @@
-import { expect, haveResource, haveResourceLike } from '@aws-cdk/assert';
+import { beASupersetOfTemplate, expect, haveResource, haveResourceLike } from '@aws-cdk/assert';
 import * as appscaling from '@aws-cdk/aws-applicationautoscaling';
 import * as cloudwatch from '@aws-cdk/aws-cloudwatch';
 import * as ec2 from '@aws-cdk/aws-ec2';
 import * as elbv2 from '@aws-cdk/aws-elasticloadbalancingv2';
 import * as cloudmap from '@aws-cdk/aws-servicediscovery';
 import * as cdk from '@aws-cdk/core';
+import * as cxapi from '@aws-cdk/cx-api';
 import { Test } from 'nodeunit';
 import * as ecs from '../../lib';
 import { LaunchType } from '../../lib/base/base-service';
 
 export = {
   "When creating a Fargate Service": {
+    "with service id renamed to resource (with feature flag enabled)"(test: Test) {
+      // GIVEN
+      const app = new cdk.App({
+        context: { [cxapi.ENABLE_CFN_SERVICE_RESOURCE_RENAME]: 'true' }
+      });
+      const stack = new cdk.Stack(app, 'FeatureStack');
+      const vpc = new ec2.Vpc(stack, 'MyVpc', {});
+      const cluster = new ecs.Cluster(stack, 'EcsCluster', { vpc });
+      const taskDefinition = new ecs.FargateTaskDefinition(stack, 'FargateTaskDef');
+
+      taskDefinition.addContainer("web", {
+        image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
+      });
+
+      new ecs.FargateService(stack, "Fargate", {
+        cluster,
+        taskDefinition,
+      });
+
+      // THEN
+      expect(stack).to(beASupersetOfTemplate({
+        Fargate001516A4: {
+          Type: "AWS::ECS::Service",
+          Properties: {
+            Cluster: {
+              Ref: "EcsCluster97242B84"
+            },
+            DeploymentConfiguration: {
+              MaximumPercent: 200,
+              MinimumHealthyPercent: 50
+            },
+            DesiredCount: 1,
+            EnableECSManagedTags: false,
+            LaunchType: "FARGATE",
+            NetworkConfiguration: {
+              AwsvpcConfiguration: {
+                AssignPublicIp: "DISABLED",
+                SecurityGroups: [
+                  {
+                    "Fn::GetAtt": [
+                      "FargateSecurityGroup953082A8",
+                      "GroupId"
+                    ]
+                  }
+                ],
+                Subnets: [
+                  {
+                    Ref: "MyVpcPrivateSubnet1Subnet5057CF7E"
+                  },
+                  {
+                    Ref: "MyVpcPrivateSubnet2Subnet0040C983"
+                  }
+                ]
+              }
+            },
+            TaskDefinition: {
+              Ref: "FargateTaskDefC6FB60B4"
+            }
+          }
+        }
+      }));
+
+      test.done();
+    },
+    "with service id renamed to resource (with feature flag disabled)"(test: Test) {
+      // GIVEN
+      const app = new cdk.App({
+        context: { [cxapi.ENABLE_CFN_SERVICE_RESOURCE_RENAME]: 'false' }
+      });
+      const stack = new cdk.Stack(app, 'FeatureStack');
+      const vpc = new ec2.Vpc(stack, 'MyVpc', {});
+      const cluster = new ecs.Cluster(stack, 'EcsCluster', { vpc });
+      const taskDefinition = new ecs.FargateTaskDefinition(stack, 'FargateTaskDef');
+
+      taskDefinition.addContainer("web", {
+        image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
+      });
+
+      new ecs.FargateService(stack, "Fargate", {
+        cluster,
+        taskDefinition,
+      });
+
+      // THEN
+      expect(stack).to(beASupersetOfTemplate({
+        FargateService7B4DE80D: {
+          Type: "AWS::ECS::Service",
+          Properties: {
+            Cluster: {
+              Ref: "EcsCluster97242B84"
+            },
+            DeploymentConfiguration: {
+              MaximumPercent: 200,
+              MinimumHealthyPercent: 50
+            },
+            DesiredCount: 1,
+            EnableECSManagedTags: false,
+            LaunchType: "FARGATE",
+            NetworkConfiguration: {
+              AwsvpcConfiguration: {
+                AssignPublicIp: "DISABLED",
+                SecurityGroups: [
+                  {
+                    "Fn::GetAtt": [
+                      "FargateSecurityGroup953082A8",
+                      "GroupId"
+                    ]
+                  }
+                ],
+                Subnets: [
+                  {
+                    Ref: "MyVpcPrivateSubnet1Subnet5057CF7E"
+                  },
+                  {
+                    Ref: "MyVpcPrivateSubnet2Subnet0040C983"
+                  }
+                ]
+              }
+            },
+            TaskDefinition: {
+              Ref: "FargateTaskDefC6FB60B4"
+            }
+          }
+        }
+      }));
+
+      test.done();
+    },
     "with only required properties set, it correctly sets default properties"(test: Test) {
       // GIVEN
       const stack = new cdk.Stack();

diff --git a/packages/@aws-cdk/cx-api/lib/features.ts b/packages/@aws-cdk/cx-api/lib/features.ts
@@ -21,14 +21,20 @@
 export const ENABLE_STACK_NAME_DUPLICATES_CONTEXT = '@aws-cdk/core:enableStackNameDuplicates';
 
 /**
- * IF this is set, `cdk diff` will always exit with 0.
+ * If this is set, `cdk diff` will always exit with 0.
  *
  * Use `cdk diff --fail` to exit with 1 if there's a diff.
  */
 export const ENABLE_DIFF_NO_FAIL_CONTEXT = 'aws-cdk:enableDiffNoFail';
 /** @deprecated use `ENABLE_DIFF_NO_FAIL_CONTEXT` */
 export const ENABLE_DIFF_NO_FAIL = ENABLE_DIFF_NO_FAIL_CONTEXT;
 
+/**
+ * If this is set, any newly created ECS service will have the logical name end
+ * with `Resource` rather than `Service`.
+ */
+export const ENABLE_CFN_SERVICE_RESOURCE_RENAME = 'aws-cdk/aws-ecs:enableCfnServiceResourceRename';
+
 /**
  * This map includes context keys and values for feature flags that enable
  * capabilities "from the future", which we could not introduce as the default
@@ -45,4 +51,5 @@ export const ENABLE_DIFF_NO_FAIL = ENABLE_DIFF_NO_FAIL_CONTEXT;
 export const FUTURE_FLAGS = {
   [ENABLE_STACK_NAME_DUPLICATES_CONTEXT]: 'true',
   [ENABLE_DIFF_NO_FAIL_CONTEXT]: 'true',
+  [ENABLE_CFN_SERVICE_RESOURCE_RENAME]: 'true',
 };