feat: Add more debugging, including link to the ECS or CodeDeploy console (#56)

Author: clareliguori

index.js

@@ -25,6 +25,7 @@ async function updateEcsService(ecs, clusterName, service, taskDefArn, waitForSe
     service: service,
     taskDefinition: taskDefArn
   }).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`);
 
   // Wait for service stability
   if (waitForService && waitForService.toLowerCase() === 'true') {
@@ -169,6 +170,7 @@ async function createCodeDeployDeployment(codedeploy, clusterName, service, task
     }
   }).promise();
   core.setOutput('codedeploy-deployment-id', createDeployResponse.deploymentId);
+  core.info(`Deployment started. Watch this deployment's progress in the AWS CodeDeploy console: https://console.aws.amazon.com/codesuite/codedeploy/deployments/${createDeployResponse.deploymentId}?region=${aws.config.region}`);
 
   // Wait for deployment to complete
   if (waitForService && waitForService.toLowerCase() === 'true') {
@@ -220,7 +222,15 @@ async function run() {
       path.join(process.env.GITHUB_WORKSPACE, taskDefinitionFile);
     const fileContents = fs.readFileSync(taskDefPath, 'utf8');
     const taskDefContents = removeIgnoredAttributes(cleanNullKeys(yaml.parse(fileContents)));
-    const registerResponse = await ecs.registerTaskDefinition(taskDefContents).promise();
+    let registerResponse;
+    try {
+      registerResponse = await ecs.registerTaskDefinition(taskDefContents).promise();
+    } catch (error) {
+      core.setFailed("Failed to register task definition in ECS: " + error.message);
+      core.debug("Task definition contents:");
+      core.debug(JSON.stringify(taskDefContents, undefined, 4));
+      throw(error);
+    }
     const taskDefArn = registerResponse.taskDefinition.taskDefinitionArn;
     core.setOutput('task-definition-arn', taskDefArn);
 

index.test.js

@@ -15,6 +15,9 @@ const mockCodeDeployGetDeploymentGroup = jest.fn();
 const mockCodeDeployWaiter = jest.fn();
 jest.mock('aws-sdk', () => {
     return {
+        config: {
+            region: 'fake-region'
+        },
         ECS: jest.fn(() => ({
             registerTaskDefinition: mockEcsRegisterTaskDef,
             updateService: mockEcsUpdateService,
@@ -158,6 +161,7 @@ describe('Deploy to ECS', () => {
             taskDefinition: 'task:def:arn'
         });
         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");
     });
 
     test('cleans null keys out of the task definition contents', async () => {
@@ -299,6 +303,8 @@ describe('Deploy to ECS', () => {
 
         expect(mockEcsUpdateService).toHaveBeenCalledTimes(0);
         expect(mockEcsWaiter).toHaveBeenCalledTimes(0);
+
+        expect(core.info).toBeCalledWith("Deployment started. Watch this deployment's progress in the AWS CodeDeploy console: https://console.aws.amazon.com/codesuite/codedeploy/deployments/deployment-1?region=fake-region");
     });
 
     test('registers the task definition contents and creates a CodeDeploy deployment, waits for 1 hour + deployment group\'s wait time', async () => {
@@ -807,13 +813,16 @@ describe('Deploy to ECS', () => {
         expect(core.setFailed).toBeCalledWith('Unsupported deployment controller: EXTERNAL');
     });
 
-    test('error is caught by core.setFailed', async () => {
+
+    test('error is caught if task def registration fails', async () => {
         mockEcsRegisterTaskDef.mockImplementation(() => {
-            throw new Error();
+            throw new Error("Could not parse");
         });
 
         await run();
 
-        expect(core.setFailed).toBeCalled();
+        expect(core.setFailed).toHaveBeenCalledTimes(2);
+        expect(core.setFailed).toHaveBeenNthCalledWith(1, 'Failed to register task definition in ECS: Could not parse');
+        expect(core.setFailed).toHaveBeenNthCalledWith(2, 'Could not parse');
     });
 });