Merge pull request #52 from JupiterOne/INT-2374-commitWebLink

INT-2374 - Add support for `commitWebLink` on `gitlab_merge_request`

CHANGELOG.md

@@ -8,7 +8,13 @@ and this project adheres to
 
 ## [Unreleased]
 
-## 4.0.0 - 2021-01-20
+## 4.1.0 - 2021-01-20
+
+- New properties added to resources:
+
+  | Entity                 | Properties      |
+  | ---------------------- | --------------- |
+  | `gitlab_merge_request` | `commitWebLink` |
 
 ### Changed
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupiterone/graph-gitlab",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "A JupiterOne Integration",
   "license": "MPL-2.0",
   "main": "dist/index.js",

src/converters/index.ts

@@ -11,6 +11,7 @@ import {
   GitLabProject,
   GitLabUser,
 } from '../provider/types';
+import { getCommitWebLinkFromMergeRequest } from '../util/mergeRequest';
 
 export function createProjectEntity(project: GitLabProject): Entity {
   const { _links, ...source } = project; // drop the _links
@@ -153,6 +154,7 @@ export function createMergeRequestEntity(
         sha: mergeRequest.sha,
         mergeCommitSha: mergeRequest.merge_commit_sha || undefined,
         squashCommitSha: mergeRequest.squash_commit_sha || undefined,
+        commitWebLink: getCommitWebLinkFromMergeRequest(mergeRequest),
       },
     },
   });

src/util/mergeRequest.test.ts

@@ -0,0 +1,72 @@
+import {
+  buildCommitWebLinkFromCommitSha,
+  getBaseRepositoryUrlFromWebUrl,
+  getCommitWebLinkFromMergeRequest,
+} from './mergeRequest';
+
+describe('#getBaseRepositoryUrlFromWebUrl', () => {
+  test('should return base repository URL if valid input supplied', () => {
+    expect(
+      getBaseRepositoryUrlFromWebUrl(
+        'https://gitlab.com/jupiterone-dev/test-proj/-/merge_requests/1',
+      ),
+    ).toEqual('https://gitlab.com/jupiterone-dev/test-proj');
+  });
+
+  test('should return undefined if invalid input supplied', () => {
+    expect(getBaseRepositoryUrlFromWebUrl('')).toEqual(undefined);
+  });
+});
+
+describe('#buildCommitWebLinkFromCommitSha', () => {
+  test('should return base repository URL if valid input supplied', () => {
+    expect(
+      buildCommitWebLinkFromCommitSha(
+        'https://gitlab.com/jupiterone-dev/test-proj',
+        'abcdef',
+      ),
+    ).toEqual('https://gitlab.com/jupiterone-dev/test-proj/-/commit/abcdef');
+  });
+});
+
+describe('#getCommitWebLinkFromMergeRequest', () => {
+  test('should build commit web link from merge request when both merge commit sha and squash commit sha present', () => {
+    expect(
+      getCommitWebLinkFromMergeRequest({
+        web_url:
+          'https://gitlab.com/jupiterone-dev/test-proj/-/merge_requests/1',
+        merge_commit_sha: 'abc123',
+        squash_commit_sha: 'abc456',
+      }),
+    ).toEqual('https://gitlab.com/jupiterone-dev/test-proj/-/commit/abc123');
+  });
+
+  test('should build commit web link from merge commit sha if no squash commit present', () => {
+    expect(
+      getCommitWebLinkFromMergeRequest({
+        web_url:
+          'https://gitlab.com/jupiterone-dev/test-proj/-/merge_requests/1',
+        merge_commit_sha: 'abc123',
+      }),
+    ).toEqual('https://gitlab.com/jupiterone-dev/test-proj/-/commit/abc123');
+  });
+
+  test('should build commit web link from squash commit sha if no merge commit sha present', () => {
+    expect(
+      getCommitWebLinkFromMergeRequest({
+        web_url:
+          'https://gitlab.com/jupiterone-dev/test-proj/-/merge_requests/1',
+        squash_commit_sha: 'abc456',
+      }),
+    ).toEqual('https://gitlab.com/jupiterone-dev/test-proj/-/commit/abc456');
+  });
+
+  test('should return undefined if neither merge commit or squash commit sha is present', () => {
+    expect(
+      getCommitWebLinkFromMergeRequest({
+        web_url:
+          'https://gitlab.com/jupiterone-dev/test-proj/-/merge_requests/1',
+      }),
+    ).toEqual(undefined);
+  });
+});

src/util/mergeRequest.ts

@@ -0,0 +1,32 @@
+import { GitLabMergeRequest } from '../provider/types';
+
+/**
+ * Example input: https://gitlab.com/jupiterone-dev/test-proj/-/merge_requests/1
+ * Example output: https://gitlab.com/jupiterone-dev/test-proj
+ */
+export function getBaseRepositoryUrlFromWebUrl(
+  webUrl: string,
+): string | undefined {
+  // ['https://gitlab.com/jupiterone-dev/test-proj', 'merge_requests/1']
+  const expectedSplitPartsSize = 2;
+  const parts = webUrl.split('/-/');
+  if (parts.length !== expectedSplitPartsSize) return undefined;
+  return parts[0];
+}
+
+export function buildCommitWebLinkFromCommitSha(
+  baseUrl: string,
+  commitSha: string,
+) {
+  return `${baseUrl}/-/commit/${commitSha}`;
+}
+
+export function getCommitWebLinkFromMergeRequest(
+  mergeRequest: GitLabMergeRequest,
+): string | undefined {
+  const sha = mergeRequest.merge_commit_sha || mergeRequest.squash_commit_sha;
+  if (!sha) return;
+
+  const baseUrl = getBaseRepositoryUrlFromWebUrl(mergeRequest.web_url);
+  return baseUrl && buildCommitWebLinkFromCommitSha(baseUrl, sha);
+}

test/schemas.ts

@@ -98,5 +98,6 @@ export const prSchema: GraphObjectSchema = {
     sha: { type: 'string' },
     mergeCommitSha: { type: 'string' },
     squashCommitSha: { type: 'string' },
+    commitWebLink: { type: 'string' },
   },
 };