test: integ test for failed ecs hotswap

packages/@aws-cdk-testing/cli-integ/resources/cdk-apps/app/app.js

@@ -286,13 +286,24 @@ class EcsHotswapStack extends cdk.Stack {
       vpc,
     });
 
-    // define a simple Fargate service
+    // allow stack to be used to test failed deployments
+    const image =
+      process.env.USE_INVALID_ECS_HOTSWAP_IMAGE == 'true'
+        ? 'nginx:invalidtag'
+        : 'nginx:alpine';
+
+    // when testing failure, allow for desired count to be boosted
+    // to invoke circuit breaker threshold of 10 failed tasks as quickly as possible
+    // https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-circuit-breaker.html#failure-threshold
+    const desiredCount = process.env.USE_HIGH_ECS_TASK_COUNT == 'true' ? 10 : 1;
+
+    // deploy basic service
     const taskDefinition = new ecs.FargateTaskDefinition(
       this,
       'task-definition'
     );
     taskDefinition.addContainer('nginx', {
-      image: ecs.ContainerImage.fromRegistry('nginx:alpine'),
+      image: ecs.ContainerImage.fromRegistry(image),
       environment: {
         SOME_VARIABLE: process.env.DYNAMIC_ECS_PROPERTY_VALUE ?? 'environment',
       },
@@ -301,6 +312,8 @@ class EcsHotswapStack extends cdk.Stack {
       cluster,
       taskDefinition,
       assignPublicIp: true, // required without NAT to pull image
+      circuitBreaker: { rollback: true },
+      desiredCount,
     });
 
     new cdk.CfnOutput(this, 'ClusterName', { value: cluster.clusterName });

packages/@aws-cdk-testing/cli-integ/tests/cli-integ-tests/cli.integtest.ts

@@ -1327,6 +1327,29 @@ integTest('hotswap deployment for ecs service waits for deployment to complete',
 
 }));
 
+integTest('hotswap deployment for ecs service detects failed deployment and errors', withDefaultFixture(async (fixture) => {
+  // GIVEN
+  await fixture.cdkDeploy('ecs-hotswap', {
+    modEnv: {
+      USE_HIGH_ECS_TASK_COUNT: 'true', // need to initially deploy high task count because hotswap deploy cannot modify task counts
+    },
+  });
+
+  // WHEN
+  const deployOutput = await fixture.cdkDeploy('ecs-hotswap', {
+    options: ['--hotswap'],
+    modEnv: {
+      USE_INVALID_ECS_HOTSWAP_IMAGE: 'true',
+      USE_HIGH_ECS_TASK_COUNT: 'true',
+    },
+    allowErrExit: true,
+  });
+
+  // THEN
+  expect(deployOutput).toContain(`❌  ${fixture.stackNamePrefix}-ecs-hotswap failed: ResourceNotReady: Resource is not in the state deploymentCompleted`);
+  expect(deployOutput).not.toContain('hotswapped!');
+}));
+
 async function listChildren(parent: string, pred: (x: string) => Promise<boolean>) {
   const ret = new Array<string>();
   for (const child of await fs.readdir(parent, { encoding: 'utf-8' })) {