Add Issue to GitHub Project v2 call (opensearch-project#31)

* Adding issue to github project v2 call

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

* Probably implement add issue to project v2

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

* Add more requirements

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

* Improve octokit test

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

* Add more tests

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

* Add more tests

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

* Update test cases

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

* Add more tests

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

* bump version

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

---------

Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>

Author: peterzhuamazon

README.md

@@ -81,6 +81,8 @@ For detailed instructions on starting the service with Docker, refer to the proj
 
 Please bump package version with every new commit by updating `package.json` and run `npm install` to update `package-lock.json`. Please do not use `npm version <>` as it will not sign DCO for your commit.
 
+You can run `npm run build` before sending any Pull Request to ensure all the lint / format / test pass beforehand.
+
 ## Code of Conduct
 
 This project has adopted [the Open Source Code of Conduct](CODE_OF_CONDUCT.md).

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "opensearch-automation-app",
-  "version": "0.1.15",
+  "version": "0.1.16",
   "description": "An Automation App that handles all your GitHub Repository Activities",
   "author": "Peter Zhu",
   "homepage": "https://github.com/opensearch-project/automation-app",
@@ -13,7 +13,7 @@
     "automation-app"
   ],
   "scripts": {
-    "build": "npm run format-dryrun && npm run clean && npm run lint && npm run compile",
+    "build": "npm install && npm run format-dryrun && npm run clean && npm run lint && npm run compile",
     "postbuild": "npm run test",
     "compile": "tsc",
     "dev": "npm run clean && npm run compile && probot run ./bin/app.js",

package.json

@@ -0,0 +1,98 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+// Name         : addIssueToGitHubProjectV2
+// Description  : add issue to github project v2 based on labels
+// Arguments    :
+//   - labels   : (array) label name, add any of the listed labels on an issue will add the issue to project listed in `projects` arg
+//   - projects : (array) the list of `<Organization Name>/<Project Number> for the issues to be added to.
+//              : Ex: `opensearch-project/206` which is the OpenSearch Roadmap Project
+// Requirements : ADDITIONAL_RESOURCE_CONTEXT=true
+
+import { randomBytes } from 'crypto';
+import { Probot } from 'probot';
+import { Resource } from '../service/resource/resource';
+import { validateResourceConfig } from '../utility/verification/verify-resource';
+
+export interface AddIssueToGitHubProjectV2Params {
+  labels: string[];
+  projects: string[];
+}
+
+export async function validateProjects(app: Probot, resource: Resource, projectsArray: string[]): Promise<Boolean> {
+  return projectsArray.every((proj) => {
+    const projOrg = proj.split('/')[0];
+    const projNum = Number(proj.split('/')[1]);
+    const project = resource.organizations.get(projOrg)?.projects.get(projNum);
+
+    if (!project) {
+      app.log.error(`Project ${projNum} in organization ${projOrg} is not defined in resource config!`);
+      return false;
+    }
+
+    return true;
+  });
+}
+
+export default async function addIssueToGitHubProjectV2(
+  app: Probot,
+  context: any,
+  resource: Resource,
+  { labels, projects }: AddIssueToGitHubProjectV2Params,
+): Promise<Map<string, [string, string]> | null> {
+  if (!(await validateResourceConfig(app, context, resource))) return null;
+  if (!(await validateProjects(app, resource, projects))) return null;
+
+  // Verify triggered label
+  const label = context.payload.label.name.trim();
+  if (!labels.includes(label)) {
+    app.log.error(`"${label}" is not defined in call paramter "labels": ${labels}.`);
+    return null;
+  }
+
+  const orgName = context.payload.organization.login;
+  const repoName = context.payload.repository.name;
+  const issueNumber = context.payload.issue.number;
+  const issueNodeId = context.payload.issue.node_id;
+  const itemIdMap = new Map<string, [string, string]>();
+
+  // Add to project
+  try {
+    await Promise.all(
+      projects.map(async (project) => {
+        app.log.info(`Attempt to add ${orgName}/${repoName}/${issueNumber} to project ${project}`);
+        const mutationId = await randomBytes(20).toString('hex');
+        const projectSplit = project.split('/');
+        const projectNodeId = resource.organizations.get(projectSplit[0])?.projects.get(Number(projectSplit[1]))?.nodeId;
+        const addToProjectMutation = `
+          mutation {
+            addProjectV2ItemById(input: {
+              clientMutationId: "${mutationId}",
+              contentId: "${issueNodeId}",
+              projectId: "${projectNodeId}",
+            }) {
+              item {
+                id
+              }
+            }
+          }
+        `;
+        const responseAddToProject = await context.octokit.graphql(addToProjectMutation);
+        app.log.info(responseAddToProject);
+        const itemId = responseAddToProject.addProjectV2ItemById.item.id;
+        itemIdMap.set(project, [itemId, label]);
+      }),
+    );
+  } catch (e) {
+    app.log.error(`ERROR: ${e}`);
+    return null;
+  }
+
+  return itemIdMap;
+}

src/call/add-issue-to-github-project-v2.ts

@@ -11,15 +11,17 @@ import { Probot } from 'probot';
 import { Resource } from '../../service/resource/resource';
 
 export async function validateResourceConfig(app: Probot, context: any, resource: Resource): Promise<boolean> {
+  // Verify org and repo between context and loaded resource config
   const contextOrgName = context.payload.organization?.login || context.payload.repository?.owner?.login;
   const contextRepoName = context.payload.repository?.name;
 
   const org = resource.organizations.get(contextOrgName);
   const repo = org?.repositories.get(contextRepoName);
 
-  if (!org || !repo) {
+  if (!contextOrgName || !contextRepoName || !org || !repo) {
     app.log.error(`${contextOrgName}/${contextRepoName} is not defined in resource config!`);
     return false;
   }
+
   return true;
 }

src/utility/verification/verify-resource.ts

@@ -0,0 +1,134 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+import addIssueToGitHubProjectV2, { AddIssueToGitHubProjectV2Params } from '../../src/call/add-issue-to-github-project-v2';
+import { validateProjects } from '../../src/call/add-issue-to-github-project-v2';
+import { Probot, Logger } from 'probot';
+
+// Mock mutationId return
+jest.mock('crypto', () => ({
+  randomBytes: jest.fn(() => {
+    return {
+      toString: jest.fn().mockReturnValue('mutation-id'),
+    };
+  }),
+}));
+
+describe('addIssueToGitHubProjectV2Functions', () => {
+  let app: Probot;
+  let context: any;
+  let resource: any;
+  let params: AddIssueToGitHubProjectV2Params;
+
+  beforeEach(() => {
+    app = new Probot({ appId: 1, secret: 'test', privateKey: 'test' });
+    app.log = {
+      info: jest.fn(),
+      error: jest.fn(),
+    } as unknown as Logger;
+
+    context = {
+      payload: {
+        label: { name: 'Meta' },
+        organization: { login: 'test-org' },
+        repository: { name: 'test-repo' },
+        issue: { number: 111, node_id: 'issue-111-nodeid' },
+      },
+      octokit: {
+        graphql: jest.fn(),
+      },
+    };
+
+    resource = {
+      organizations: new Map([
+        [
+          'test-org',
+          {
+            projects: new Map([[222, { nodeId: 'project-222-nodeid' }]]),
+            repositories: new Map([['test-repo', 'repo object']]),
+          },
+        ],
+      ]),
+    };
+
+    params = {
+      labels: ['Meta', 'RFC'],
+      projects: ['test-org/222'],
+    };
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  describe('validateProjects', () => {
+    it('should print error if validateProjects returns false', async () => {
+      resource.organizations.get('test-org').projects.delete(222);
+
+      const result = await validateProjects(app, resource, params.projects);
+
+      expect(app.log.error).toHaveBeenCalledWith('Project 222 in organization test-org is not defined in resource config!');
+      expect(result).toBe(false);
+      expect(context.octokit.graphql).not.toHaveBeenCalled();
+    });
+  });
+
+  describe('addIssueToGitHubProjectV2', () => {
+    it('should print error if context label does not match the ones in resource config', async () => {
+      context.payload.label.name = 'enhancement';
+
+      const result = await addIssueToGitHubProjectV2(app, context, resource, params);
+
+      expect(app.log.error).toHaveBeenCalledWith('"enhancement" is not defined in call paramter "labels": Meta,RFC.');
+      expect(result).toBe(null);
+      expect(context.octokit.graphql).not.toHaveBeenCalled();
+    });
+
+    it('should add context issue to project when conditions are met', async () => {
+      const graphQLResponse = {
+        addProjectV2ItemById: { item: { id: 'new-item-id' } },
+      };
+
+      context.octokit.graphql.mockResolvedValue(graphQLResponse);
+
+      const result = await addIssueToGitHubProjectV2(app, context, resource, params);
+
+      /* prettier-ignore-start */
+      const graphQLCallStack = `
+          mutation {
+            addProjectV2ItemById(input: {
+              clientMutationId: "mutation-id",
+              contentId: "issue-111-nodeid",
+              projectId: "project-222-nodeid",
+            }) {
+              item {
+                id
+              }
+            }
+          }
+        `;
+      /* prettier-ignore-end */
+
+      expect(context.octokit.graphql).toHaveBeenCalledWith(graphQLCallStack);
+      expect(JSON.stringify((result as Map<string, [string, string]>).get('test-org/222'))).toBe('["new-item-id","Meta"]');
+      expect(app.log.info).toHaveBeenCalledWith(graphQLResponse);
+    });
+
+    it('should print log error when GraphQL call fails', async () => {
+      context.octokit.graphql.mockRejectedValue(new Error('GraphQL request failed'));
+
+      const result = await addIssueToGitHubProjectV2(app, context, resource, params);
+
+      expect(context.octokit.graphql).rejects.toThrow('GraphQL request failed');
+      expect(context.octokit.graphql).toHaveBeenCalled();
+      expect(result).toBe(null);
+      expect(app.log.error).toHaveBeenCalledWith('ERROR: Error: GraphQL request failed');
+    });
+  });
+});

test/call/add-issue-to-github-project-v2.test.ts

@@ -10,6 +10,7 @@
 import { STSClient, AssumeRoleCommand } from '@aws-sdk/client-sts';
 import { Client as OpenSearchClient } from '@opensearch-project/opensearch';
 import { OpensearchClient } from '../../../src/utility/opensearch/opensearch-client';
+import { AwsSigv4Signer } from '@opensearch-project/opensearch/aws-v3';
 
 jest.mock('@aws-sdk/client-sts');
 jest.mock('@opensearch-project/opensearch');
@@ -47,6 +48,10 @@ describe('OpensearchClient', () => {
     }));
   });
 
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
   describe('getClient', () => {
     it('should return an OpenSearch client with valid credentials', async () => {
       const opensearchClient = new OpensearchClient();
@@ -58,6 +63,15 @@ describe('OpensearchClient', () => {
         RoleSessionName: 'githubWorkflowRunsMonitorSession',
       });
       expect(client).toBeInstanceOf(OpenSearchClient);
+
+      const getCredentials = (AwsSigv4Signer as jest.Mock).mock.calls[0][0].getCredentials;
+      const credentials = await getCredentials();
+
+      expect(credentials).toEqual({
+        accessKeyId: 'mockAccessKeyId',
+        secretAccessKey: 'mockSecretAccessKey',
+        sessionToken: 'mockSessionToken',
+      });
     });
 
     it('should throw an error if credentials are undefined', async () => {

test/utility/opensearch/opensearch-client.test.ts

@@ -8,23 +8,40 @@
  */
 
 import { octokitAuth } from '../../../src/utility/probot/octokit';
-import { Probot, Logger } from 'probot';
+import { Probot, ProbotOctokit, Logger } from 'probot';
 
 describe('octokitFunctions', () => {
   let app: Probot;
   let installationId: number;
+  let octokitMock: ProbotOctokit
 
   beforeEach(() => {
     app = new Probot({ appId: 1, secret: 'test', privateKey: 'test' });
     app.log = {
       info: jest.fn(),
       error: jest.fn(),
     } as unknown as Logger;
+
+    octokitMock = {} as ProbotOctokit;
+    app.auth = jest.fn().mockResolvedValue(octokitMock);
+
+    installationId = 123;
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
   });
 
   describe('octokitAuth', () => {
     it('should fail if no installation id', async () => {
-      await expect(octokitAuth(app, installationId)).rejects.toThrowError('Please provide installation id of your github app!');
+      await expect(octokitAuth(app, undefined as any)).rejects.toThrowError('Please provide installation id of your github app!');
+    });
+
+    it('should call app.auth if installationId present and return ProbotOctokit', async () => {
+      const result = await octokitAuth(app, installationId);
+
+      expect(app.auth).toHaveBeenCalledWith(installationId);
+      expect(result).toBe(octokitMock);
     });
   });
 });

test/utility/probot/octokit.test.ts

@@ -36,6 +36,10 @@ describe('verifyResourceFunctions', () => {
     };
   });
 
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
   describe('validateResourceConfig', () => {
     it('should fail if no org or repo data in payload', async () => {
       const result = await validateResourceConfig(app, context, resource);