refactor: move common operations out of checkRun

Author: samchungy

src/api/github/checkRun.test.ts

@@ -1,17 +1,18 @@
 import { Octokit } from '@octokit/rest';
 import { Endpoints } from '@octokit/types';
-import git, { ReadCommitResult } from 'isomorphic-git';
 import { mocked } from 'ts-jest/utils';
 
 import * as GitHub from '../github';
 
 import { createCheckRun } from './checkRun';
+import { getHeadSha, getOwnerRepo } from './util';
 
 type CreateCheckRunResponse =
   Endpoints['POST /repos/{owner}/{repo}/check-runs']['response'];
 
 jest.mock('@octokit/rest');
 jest.mock('isomorphic-git');
+jest.mock('./util');
 
 const mockClient = {
   checks: {
@@ -50,12 +51,13 @@ describe('createCheckRun', () => {
 
   beforeEach(() => {
     mocked(Octokit).mockReturnValue(mockClient as unknown as Octokit);
-    mocked(git.listRemotes).mockResolvedValue([
-      { remote: 'origin', url: '[email protected]:seek-oss/skuba.git' },
-    ]);
-    mocked(git.log).mockResolvedValue([
-      { oid: 'cdd335a418c3dc6804be1c642b19bb63437e2cad' } as ReadCommitResult,
-    ]);
+    mocked(getHeadSha).mockResolvedValue(
+      'cdd335a418c3dc6804be1c642b19bb63437e2cad',
+    );
+    mocked(getOwnerRepo).mockResolvedValue({
+      owner: 'seek-oss',
+      repo: 'skuba',
+    });
     mockClient.checks.create.mockReturnValue(createResponse);
   });
 

src/api/github/checkRun.ts

@@ -1,10 +1,10 @@
 import { Octokit } from '@octokit/rest';
 import { Endpoints } from '@octokit/types';
-import fs from 'fs-extra';
-import git from 'isomorphic-git';
 
 import { pluralise } from '../../utils/logging';
 
+import { getHeadSha, getOwnerRepo } from './util';
+
 type Output = NonNullable<
   Endpoints['POST /repos/{owner}/{repo}/check-runs']['parameters']['output']
 >;
@@ -13,48 +13,6 @@ export type Annotation = NonNullable<Output['annotations']>[number];
 
 const GITHUB_MAX_ANNOTATIONS = 50;
 
-/**
- * Matches the owner and repository names in a GitHub repository URL.
- *
- * For example, given the following input strings:
- *
- * ```console
- * [email protected]:seek-oss/skuba.git
- * https://github.com/seek-oss/skuba.git
- * ```
- *
- * This pattern will produce the following matches:
- *
- * 1. seek-oss
- * 2. skuba
- */
-const ownerRepoRegex = /github.com(?::|\/)(.+)\/(.+).git$/;
-
-const getOwnerRepo = async (
-  dir: string,
-): Promise<{ owner: string; repo: string }> => {
-  const remotes = await git.listRemotes({ dir, fs });
-
-  for (const { url } of remotes) {
-    const match = ownerRepoRegex.exec(url);
-
-    const owner = match?.[1];
-    const repo = match?.[2];
-
-    if (owner && repo) {
-      return { owner, repo };
-    }
-  }
-
-  throw new Error('Could not find a GitHub remote');
-};
-
-const getHeadSha = async (dir: string): Promise<string> => {
-  const [commit] = await git.log({ depth: 1, dir, fs });
-
-  return commit.oid;
-};
-
 /**
  * Suffixes the title with the number of annotations added, e.g.
  *

src/api/github/util.test.ts

@@ -0,0 +1,34 @@
+import git, { ReadCommitResult } from 'isomorphic-git';
+import { mocked } from 'ts-jest/utils';
+
+import { getHeadSha, getOwnerRepo } from './util';
+
+const dir = process.cwd();
+
+beforeEach(() => {
+  mocked(git.listRemotes).mockResolvedValue([
+    { remote: 'origin', url: '[email protected]:seek-oss/skuba.git' },
+  ]);
+  mocked(git.log).mockResolvedValue([
+    { oid: 'cdd335a418c3dc6804be1c642b19bb63437e2cad' } as ReadCommitResult,
+  ]);
+});
+
+afterEach(() => {
+  jest.resetAllMocks();
+});
+
+describe('getOwnerRepo', () => {
+  it('should extract a GitHub owner and repo from Git remotes', () => {
+    expect(getOwnerRepo(dir)).toStrictEqual({
+      owner: 'seek-oss',
+      repo: 'skuba',
+    });
+  });
+});
+
+describe('getHeadSha', () => {
+  it('should extract a GitHub owner and repo from Git remotes', () => {
+    expect(getHeadSha(dir)).toBe('cdd335a418c3dc6804be1c642b19bb63437e2cad');
+  });
+});

src/api/github/util.ts

@@ -0,0 +1,46 @@
+import fs from 'fs-extra';
+import git from 'isomorphic-git';
+
+const getHeadSha = async (dir: string): Promise<string> => {
+  const [commit] = await git.log({ depth: 1, dir, fs });
+
+  return commit.oid;
+};
+
+/**
+ * Matches the owner and repository names in a GitHub repository URL.
+ *
+ * For example, given the following input strings:
+ *
+ * ```console
+ * [email protected]:seek-oss/skuba.git
+ * https://github.com/seek-oss/skuba.git
+ * ```
+ *
+ * This pattern will produce the following matches:
+ *
+ * 1. seek-oss
+ * 2. skuba
+ */
+const ownerRepoRegex = /github.com(?::|\/)(.+)\/(.+).git$/;
+
+const getOwnerRepo = async (
+  dir: string,
+): Promise<{ owner: string; repo: string }> => {
+  const remotes = await git.listRemotes({ dir, fs });
+
+  for (const { url } of remotes) {
+    const match = ownerRepoRegex.exec(url);
+
+    const owner = match?.[1];
+    const repo = match?.[2];
+
+    if (owner && repo) {
+      return { owner, repo };
+    }
+  }
+
+  throw new Error('Could not find a GitHub remote');
+};
+
+export { getOwnerRepo, getHeadSha };