feat: allow forceNewDeployment (#116)

* feat: allow forceNewDeployment

* test: remove trailing whitespace & comment adjustment

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Author: andhikamaheva

action.yml

@@ -28,6 +28,9 @@ inputs:
   codedeploy-deployment-group:
     description: "The name of the AWS CodeDeploy deployment group, if the ECS service uses the CODE_DEPLOY deployment controller. Will default to 'DgpECS-{cluster}-{service}'."
     required: false
+  force-new-deployment:
+    description: 'Whether to force a new deployment of the service. Valid value is "true". Will default to not force a new deployment.'
+    required: false
 outputs:
   task-definition-arn:
     description: 'The ARN of the registered ECS task definition'

index.js

@@ -18,12 +18,13 @@ const IGNORED_TASK_DEFINITION_ATTRIBUTES = [
 ];
 
 // Deploy to a service that uses the 'ECS' deployment controller
-async function updateEcsService(ecs, clusterName, service, taskDefArn, waitForService, waitForMinutes) {
+async function updateEcsService(ecs, clusterName, service, taskDefArn, waitForService, waitForMinutes, forceNewDeployment) {
   core.debug('Updating the service');
   await ecs.updateService({
     cluster: clusterName,
     service: service,
-    taskDefinition: taskDefArn
+    taskDefinition: taskDefArn,
+    forceNewDeployment: forceNewDeployment
   }).promise();
   core.info(`Deployment started. Watch this deployment's progress in the Amazon ECS console: https://console.aws.amazon.com/ecs/home?region=${aws.config.region}#/clusters/${clusterName}/services/${service}/events`);
 
@@ -221,6 +222,7 @@ async function run() {
     if (waitForMinutes > MAX_WAIT_MINUTES) {
       waitForMinutes = MAX_WAIT_MINUTES;
     }
+    const forceNewDeployment = core.getInput('force-new-deployment', { required: false }) || false;
 
     // Register the task definition
     core.debug('Registering the task definition');
@@ -263,7 +265,7 @@ async function run() {
 
       if (!serviceResponse.deploymentController) {
         // Service uses the 'ECS' deployment controller, so we can call UpdateService
-        await updateEcsService(ecs, clusterName, service, taskDefArn, waitForService, waitForMinutes);
+        await updateEcsService(ecs, clusterName, service, taskDefArn, waitForService, waitForMinutes, forceNewDeployment);
       } else if (serviceResponse.deploymentController.type == 'CODE_DEPLOY') {
         // Service uses CodeDeploy, so we should start a CodeDeploy deployment
         await createCodeDeployDeployment(codedeploy, clusterName, service, taskDefArn, waitForService, waitForMinutes);

index.test.js

@@ -146,7 +146,7 @@ describe('Deploy to ECS', () => {
         });
     });
 
-    test('registers the task definition contents and updates the service', async () => {
+     test('registers the task definition contents and updates the service', async () => {
         await run();
         expect(core.setFailed).toHaveBeenCalledTimes(0);
         expect(mockEcsRegisterTaskDef).toHaveBeenNthCalledWith(1, { family: 'task-def-family'});
@@ -158,7 +158,8 @@ describe('Deploy to ECS', () => {
         expect(mockEcsUpdateService).toHaveBeenNthCalledWith(1, {
             cluster: 'cluster-789',
             service: 'service-456',
-            taskDefinition: 'task:def:arn'
+            taskDefinition: 'task:def:arn',
+            forceNewDeployment: false
         });
         expect(mockEcsWaiter).toHaveBeenCalledTimes(0);
         expect(core.info).toBeCalledWith("Deployment started. Watch this deployment's progress in the Amazon ECS console: https://console.aws.amazon.com/ecs/home?region=fake-region#/clusters/cluster-789/services/service-456/events");
@@ -497,6 +498,7 @@ describe('Deploy to ECS', () => {
             .mockReturnValueOnce('cluster-789')         // cluster
             .mockReturnValueOnce('false')               // wait-for-service-stability
             .mockReturnValueOnce('')                    // wait-for-minutes
+            .mockReturnValueOnce('')                    // force-new-deployment
             .mockReturnValueOnce('/hello/appspec.json') // codedeploy-appspec
             .mockReturnValueOnce('MyApplication')       // codedeploy-application
             .mockReturnValueOnce('MyDeploymentGroup');  // codedeploy-deployment-group
@@ -608,7 +610,7 @@ describe('Deploy to ECS', () => {
         expect(mockEcsWaiter).toHaveBeenCalledTimes(0);
     });
 
-    test('registers the task definition contents at an absolute path', async () => {
+     test('registers the task definition contents at an absolute path', async () => {
         core.getInput = jest.fn().mockReturnValueOnce('/hello/task-definition.json');
         fs.readFileSync.mockImplementation((pathInput, encoding) => {
             if (encoding != 'utf8') {
@@ -649,7 +651,8 @@ describe('Deploy to ECS', () => {
         expect(mockEcsUpdateService).toHaveBeenNthCalledWith(1, {
             cluster: 'cluster-789',
             service: 'service-456',
-            taskDefinition: 'task:def:arn'
+            taskDefinition: 'task:def:arn',
+            forceNewDeployment: false
         });
         expect(mockEcsWaiter).toHaveBeenNthCalledWith(1, 'servicesStable', {
             services: ['service-456'],
@@ -668,7 +671,7 @@ describe('Deploy to ECS', () => {
             .mockReturnValueOnce('service-456')         // service
             .mockReturnValueOnce('cluster-789')         // cluster
             .mockReturnValueOnce('TRUE')                // wait-for-service-stability
-            .mockReturnValue('60');                     // wait-for-minutes
+            .mockReturnValueOnce('60');                     // wait-for-minutes
 
         await run();
         expect(core.setFailed).toHaveBeenCalledTimes(0);
@@ -682,7 +685,8 @@ describe('Deploy to ECS', () => {
         expect(mockEcsUpdateService).toHaveBeenNthCalledWith(1, {
             cluster: 'cluster-789',
             service: 'service-456',
-            taskDefinition: 'task:def:arn'
+            taskDefinition: 'task:def:arn',
+            forceNewDeployment: false
         });
         expect(mockEcsWaiter).toHaveBeenNthCalledWith(1, 'servicesStable', {
             services: ['service-456'],
@@ -701,7 +705,7 @@ describe('Deploy to ECS', () => {
             .mockReturnValueOnce('service-456')         // service
             .mockReturnValueOnce('cluster-789')         // cluster
             .mockReturnValueOnce('TRUE')                // wait-for-service-stability
-            .mockReturnValue('1000');                   // wait-for-minutes
+            .mockReturnValueOnce('1000');                   // wait-for-minutes
 
         await run();
         expect(core.setFailed).toHaveBeenCalledTimes(0);
@@ -715,7 +719,8 @@ describe('Deploy to ECS', () => {
         expect(mockEcsUpdateService).toHaveBeenNthCalledWith(1, {
             cluster: 'cluster-789',
             service: 'service-456',
-            taskDefinition: 'task:def:arn'
+            taskDefinition: 'task:def:arn',
+            forceNewDeployment: false
         });
         expect(mockEcsWaiter).toHaveBeenNthCalledWith(1, 'servicesStable', {
             services: ['service-456'],
@@ -727,6 +732,33 @@ describe('Deploy to ECS', () => {
         });
     });
 
+    test('force new deployment', async () => {
+        core.getInput = jest
+            .fn()
+            .mockReturnValueOnce('task-definition.json')  // task-definition
+            .mockReturnValueOnce('service-456')          // service
+            .mockReturnValueOnce('cluster-789')          // cluster
+            .mockReturnValueOnce('false')                // wait-for-service-stability
+            .mockReturnValueOnce('')                     // wait-for-minutes
+            .mockReturnValueOnce(true);                  // force-new-deployment
+
+        await run();
+        expect(core.setFailed).toHaveBeenCalledTimes(0);
+
+        expect(mockEcsRegisterTaskDef).toHaveBeenNthCalledWith(1, { family: 'task-def-family'});
+        expect(core.setOutput).toHaveBeenNthCalledWith(1, 'task-definition-arn', 'task:def:arn');
+        expect(mockEcsDescribeServices).toHaveBeenNthCalledWith(1, {
+            cluster: 'cluster-789',
+            services: ['service-456']
+        });
+        expect(mockEcsUpdateService).toHaveBeenNthCalledWith(1, {
+            cluster: 'cluster-789',
+            service: 'service-456',
+            taskDefinition: 'task:def:arn',
+            forceNewDeployment: true
+        });
+    });
+
     test('defaults to the default cluster', async () => {
         core.getInput = jest
             .fn()
@@ -745,7 +777,8 @@ describe('Deploy to ECS', () => {
         expect(mockEcsUpdateService).toHaveBeenNthCalledWith(1, {
             cluster: 'default',
             service: 'service-456',
-            taskDefinition: 'task:def:arn'
+            taskDefinition: 'task:def:arn',
+            forceNewDeployment: false
         });
     });
 
@@ -847,7 +880,6 @@ describe('Deploy to ECS', () => {
         expect(core.setFailed).toBeCalledWith('Unsupported deployment controller: EXTERNAL');
     });
 
-
     test('error is caught if task def registration fails', async () => {
         mockEcsRegisterTaskDef.mockImplementation(() => {
             throw new Error("Could not parse");
@@ -859,4 +891,4 @@ describe('Deploy to ECS', () => {
         expect(core.setFailed).toHaveBeenNthCalledWith(1, 'Failed to register task definition in ECS: Could not parse');
         expect(core.setFailed).toHaveBeenNthCalledWith(2, 'Could not parse');
     });
-});
+ });