add “mark-complete” functionality

Author: hcliff

README.md

@@ -16,7 +16,7 @@ This action integrates asana with github.
 
 ### `action`
 
-**Required** The action to be performed assert-link|add-comment|remove-comment|move-section
+**Required** The action to be performed assert-link|add-comment|remove-comment|move-section|complete-task
 
 ### `github-token`
 
@@ -50,6 +50,10 @@ if you don't want to move task omit `targets`.
 
 **Required for `assert-link`** When set to true will fail pull requests without an asana link
 
+### `is-complete`
+
+**Required for `complete-task`** If the task is complete or not
+
 ## Example usage
 
 ```yaml
@@ -133,4 +137,23 @@ jobs:
           # if the branch is labeled a hotfix, skip this check
           link-required: ${{ !contains(github.event.pull_request.labels.*.name, 'hotfix') }}
           github-token: ${{ github.token }}
+```
+
+```yaml
+name: Mark a task complete
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: everphone-gmbh/github-asana-action
+        if: github.event.pull_request.merged
+        with:
+          asana-pat: ${{ secrets.ASANA_PAT }}
+          action: 'complete-task'
+          is-complete: true
 ```

action.js

@@ -49,7 +49,14 @@ async function addComment(client, taskId, commentId, text, isPinned) {
   }
 }
 
-module.exports = async function action() {  
+async function buildClient(asanaPAT) {
+  return asana.Client.create({
+    defaultHeaders: { 'asana-enable': 'new-sections,string_ids' },
+    logAsanaChangeWarnings: false
+  }).useAccessToken(asanaPAT).authorize();
+}
+
+async function action() {  
   const 
     ASANA_PAT = core.getInput('asana-pat', {required: true}),
     ACTION = core.getInput('action', {required: true}),
@@ -61,11 +68,7 @@ module.exports = async function action() {
 
   console.log('pull_request', PULL_REQUEST);
 
-  const client = await asana.Client.create({
-    defaultHeaders: { 'asana-enable': 'new-sections,string_ids' },
-    logAsanaChangeWarnings: false
-  }).useAccessToken(ASANA_PAT).authorize();
-
+  const client = await buildClient(ASANA_PAT);
   if(client === null){
     throw new Error('client authorization failed');
   }
@@ -134,6 +137,22 @@ module.exports = async function action() {
       }
       return removedCommentIds;
     }
+    case 'complete-task': {
+      const isComplete = core.getInput('is-complete') === 'true';
+      const taskIds = [];
+      for(const taskId of foundAsanaTasks) {
+        console.info("marking task", taskId, isComplete ? 'complete' : 'incomplete');
+        try {
+          await client.tasks.update(taskId, {
+            completed: isComplete
+          });
+        } catch (error) {
+          console.error('rejecting promise', error);
+        }
+        taskIds.push(taskId);
+      };
+      return taskIds;
+    }
     case 'move-section': {
       const targetJSON = core.getInput('targets', {required: true});
       const targets = JSON.parse(targetJSON);
@@ -148,3 +167,9 @@ module.exports = async function action() {
       core.setFailed("unexpected action ${ACTION}");
   }
 }
+
+module.exports = {
+  action,
+  default: action,
+  buildClient: buildClient
+};

action.test.js

@@ -4,15 +4,22 @@ const github = require('@actions/github');
 
 describe('asana github actions', () => {
   let inputs = {};
-  const defaultBody = 'Implement https://app.asana.com/0/1178251625498057/1178251625498064 in record time';
+  let defaultBody;
+  let client;
+  let task;
+
   const asanaPAT = process.env['ASANA_PAT'];
   if(!asanaPAT) {
     throw new Error('need ASANA_PAT in the test env');
   }
+  const projectId = process.env['ASANA_PROJECT_ID'];
+  if(!projectId) {
+    throw new Error('need ASANA_PROJECT_ID in the test env');
+  }
 
   const commentId = Date.now().toString();
 
-  beforeAll(() => {
+  beforeAll(async () => {
       // Mock getInput
       jest.spyOn(core, 'getInput').mockImplementation((name, options) => {
         if(inputs[name] === undefined && options && options.required){
@@ -31,6 +38,23 @@ describe('asana github actions', () => {
       github.context.sha = '1234567890123456789012345678901234567890'
 
       process.env['GITHUB_REPOSITORY'] = 'a-cool-owner/a-cool-repo'
+
+      client = await action.buildClient(asanaPAT);
+      if(client === null){
+        throw new Error('client authorization failed');
+      }
+
+      task = await client.tasks.create({
+        'name': 'my fantastic task',
+        'notes': 'generated automatically by the test suite',
+        'projects': [projectId]
+      });
+
+      defaultBody = `Implement https://app.asana.com/0/${projectId}/${task.gid} in record time`;
+    })
+
+    afterAll(async () => {
+      await client.tasks.delete(task);
     })
 
     beforeEach(() => {
@@ -64,7 +88,7 @@ describe('asana github actions', () => {
         }
       });
 
-      await action();
+      await action.action();
 
       expect(mockCreateStatus).toHaveBeenCalledWith({
         owner: 'a-cool-owner',
@@ -91,10 +115,10 @@ describe('asana github actions', () => {
         }
       };
 
-      await expect(action()).resolves.toHaveLength(1);
+      await expect(action.action()).resolves.toHaveLength(1);
 
       // rerunning with the same comment-Id should not create a new comment
-      await expect(action()).resolves.toHaveLength(0);
+      await expect(action.action()).resolves.toHaveLength(0);
     });
 
     test('removing a comment', async () => {
@@ -110,7 +134,7 @@ describe('asana github actions', () => {
         }
       };
 
-      await expect(action()).resolves.toHaveLength(1);
+      await expect(action.action()).resolves.toHaveLength(1);
     });
 
     test('moving sections', async () => {
@@ -125,14 +149,31 @@ describe('asana github actions', () => {
         }
       };
 
-      await expect(action()).resolves.toHaveLength(1);
+      await expect(action.action()).resolves.toHaveLength(1);
 
       inputs = {
         'asana-pat': asanaPAT,
         'action': 'move-section',
         'targets': '[{"project": "Asana bot test environment", "section": "New"}]'
       }
 
-      await expect(action()).resolves.toHaveLength(1);
+      await expect(action.action()).resolves.toHaveLength(1);
+    });
+
+    test('completing task', async () => {
+      inputs = {
+        'asana-pat': asanaPAT,
+        'action': 'complete-task',
+        'is-complete': 'true'
+      }
+      github.context.payload = {
+        pull_request: {
+          'body': defaultBody
+        }
+      };
+
+      await expect(action.action()).resolves.toHaveLength(1);
+      const actualTask = await client.tasks.findById(task.gid);
+      expect(actualTask.completed).toBe(true);
     });
 });

action.yml

@@ -5,7 +5,7 @@ inputs:
     description: 'Asana Public Access Token.'
     required: true
   action:
-    description: 'The action to be performed assert-link|add-comment|remove-comment|move-section'
+    description: 'The action to be performed assert-link|add-comment|remove-comment|move-section|complete-task'
     required: false
   trigger-phrase:
     description: 'Prefix before the task i.e ASANA TASK: https://app.asana.com/1/2/3'
@@ -26,6 +26,8 @@ inputs:
   targets:
     description: 'JSON array of objects having project and section where to move current task. Move task only if it exists in target project.'
     required: false
+  is-complete:
+    description: 'Is the task complete'
 branding:
   icon: 'chevron-right'  
   color: 'gray-dark'

index.js

@@ -3,7 +3,7 @@ const action = require('./action');
 
 async function run() {
   try {
-    await action();
+    await action.action();
   } catch (error) {
     core.setFailed(error.message);
   }