Merge branch 'v9' into next

Author: kanadgupta

__tests__/commands/openapi/validate.test.ts

@@ -4,7 +4,7 @@ import prompts from 'prompts';
 import { describe, beforeAll, beforeEach, afterEach, it, expect, vi } from 'vitest';
 
 import Command from '../../../src/commands/openapi/validate.js';
-import { after, before } from '../../helpers/get-gha-setup.js';
+import { gitMock } from '../../helpers/git-mock.js';
 import { runCommand, runCommandWithHooks, type OclifOutput } from '../../helpers/oclif.js';
 
 describe('rdme openapi validate', () => {
@@ -112,13 +112,13 @@ describe('rdme openapi validate', () => {
     let yamlOutput;
 
     beforeEach(() => {
-      before((fileName, data) => {
+      gitMock.before((fileName, data) => {
         yamlOutput = data;
       });
     });
 
     afterEach(() => {
-      after();
+      gitMock.after();
     });
 
     it('should create GHA workflow if user passes in spec via prompts', async () => {

__tests__/helpers/get-gha-setup.ts

@@ -0,0 +1,120 @@
+import type { Response } from 'simple-git';
+
+import fs from 'node:fs';
+
+import { vi } from 'vitest';
+
+import configstore from '../../src/lib/configstore.js';
+import * as getPkgVersion from '../../src/lib/getPkg.js';
+import { git } from '../../src/lib/git.js';
+import * as isCI from '../../src/lib/isCI.js';
+
+const fsWriteFileSync = fs.writeFileSync;
+
+/**
+ * Creates a mock function for testing `git.remote`.
+ */
+export function getGitRemoteMock(
+  /** remote to return (usually `origin`) */
+  remote = 'origin',
+  /** git URL for the given remote */
+  remoteUrl = 'https://github.com/readmeio/rdme.git',
+  /** the HEAD branch */
+  defaultBranch = 'main',
+) {
+  return vi.fn<(typeof git)['remote']>(arr => {
+    // first call (used to grab remote for usage in subsequent commands)
+    if (!arr.length) {
+      if (!remote) return Promise.reject(new Error('Bad mock uh oh')) as unknown as Response<string>;
+      return Promise.resolve(remote) as unknown as Response<string>;
+    }
+    // second call (used to grab default branch)
+    if (arr.length === 2 && arr[0] === 'show' && arr[1] === remote) {
+      if (remote === 'bad-remote') {
+        return Promise.reject(
+          new Error(`fatal: unable to access '${remoteUrl}': Could not resolve host: ${remoteUrl}`),
+        ) as unknown as Response<string>;
+      }
+      if (!defaultBranch) return Promise.reject(new Error('Bad mock uh oh')) as unknown as Response<string>;
+      return Promise.resolve(`* remote origin
+  Fetch URL: ${remoteUrl}
+  Push  URL: ${remoteUrl}
+  HEAD branch: ${defaultBranch}
+`) as unknown as Response<string>;
+    }
+
+    // third call (used to grab remote URLs)
+    if (arr.length === 1 && arr[0] === '-v') {
+      if (!remoteUrl) return Promise.reject(new Error('Bad mock uh oh')) as unknown as Response<string>;
+      return Promise.resolve(`origin  ${remoteUrl} (fetch)
+origin  ${remoteUrl} (push)
+    `) as unknown as Response<string>;
+    }
+
+    return Promise.reject(new Error('Bad mock uh oh')) as unknown as Response<string>;
+  });
+}
+
+/**
+ * Helper functions for setting up and tearing down tests for our GitHub Action onboarding.
+ *
+ * @see {@link __tests__/lib/createGHA.test.ts}
+ */
+export const gitMock = {
+  before: function before(
+    /** the mock function that should be called in place of `fs.writeFileSync` */
+    writeFileSyncCb: typeof fs.writeFileSync = () => {},
+  ) {
+    fs.writeFileSync = vi.fn(writeFileSyncCb);
+
+    git.checkIsRepo = vi.fn(() => {
+      return Promise.resolve(true) as Response<boolean>;
+    });
+
+    git.remote = getGitRemoteMock();
+
+    vi.setSystemTime(new Date('2022'));
+
+    vi.stubEnv('TEST_RDME_CREATEGHA', 'true');
+
+    const spy = vi.spyOn(getPkgVersion, 'getMajorPkgVersion');
+    spy.mockResolvedValue(7);
+  },
+
+  after: function after() {
+    configstore.clear();
+    fs.writeFileSync = fsWriteFileSync;
+    vi.clearAllMocks();
+    vi.unstubAllEnvs();
+  },
+};
+
+/**
+ * Helper functions for setting up tests for simulating a GitHub Actions runner environment
+ */
+export const githubActionsEnv = {
+  before: function before() {
+    vi.resetModules();
+
+    // List of all GitHub Actions env variables:
+    // https://docs.github.com/en/actions/learn-github-actions/environment-variables#default-environment-variables
+    vi.stubEnv('GITHUB_ACTION', '__repo-owner_name-of-action-repo');
+    vi.stubEnv('GITHUB_ACTIONS', 'true');
+    vi.stubEnv('GITHUB_REPOSITORY', 'octocat/Hello-World');
+    vi.stubEnv('GITHUB_RUN_ATTEMPT', '3');
+    vi.stubEnv('GITHUB_RUN_ID', '1658821493');
+    vi.stubEnv('GITHUB_RUN_NUMBER', '3');
+    vi.stubEnv('GITHUB_SERVER_URL', 'https://github.com');
+    vi.stubEnv('GITHUB_SHA', 'ffac537e6cbbf934b08745a378932722df287a53');
+    vi.stubEnv('TEST_RDME_CI', 'true');
+    vi.stubEnv('TEST_RDME_GHA', 'true');
+
+    const ciNameSpy = vi.spyOn(isCI, 'ciName');
+    ciNameSpy.mockReturnValue('GitHub Actions (test)');
+  },
+
+  after: function after() {
+    vi.unstubAllEnvs();
+    vi.resetAllMocks();
+  },
+};

__tests__/helpers/get-git-mock.ts

@@ -39,8 +39,6 @@ export function setupOclifConfig() {
 export function runCommand(Command: CommandClass) {
   return async function runCommandAgainstArgs(args?: string[]) {
     const oclifConfig = await setupOclifConfig();
-    // @ts-expect-error this is the pattern recommended by the @oclif/test docs.
-    // Not sure how to get this working with type generics.
     return captureOutput<string>(() => Command.run(args, oclifConfig), { testNodeEnv });
   };
 }

__tests__/helpers/git-mock.ts

@@ -9,10 +9,10 @@ import prompts from 'prompts';
 import { describe, beforeEach, afterEach, it, expect, vi, type MockInstance, beforeAll } from 'vitest';
 
 import configstore from '../../src/lib/configstore.js';
-import { getConfigStoreKey, getGHAFileName, git } from '../../src/lib/createGHA/index.js';
+import { getConfigStoreKey, getGHAFileName } from '../../src/lib/createGHA/index.js';
 import { getMajorPkgVersion } from '../../src/lib/getPkg.js';
-import { after, before } from '../helpers/get-gha-setup.js';
-import getGitRemoteMock from '../helpers/get-git-mock.js';
+import { git } from '../../src/lib/git.js';
+import { getGitRemoteMock, gitMock } from '../helpers/git-mock.js';
 import ghaWorkflowSchema from '../helpers/github-workflow-schema.json' with { type: 'json' };
 import { setupOclifConfig } from '../helpers/oclif.js';
 import { toBeValidSchema } from '../helpers/vitest.matchers.js';
@@ -36,13 +36,13 @@ describe('#createGHA', () => {
     consoleInfoSpy = vi.spyOn(console, 'info').mockImplementation(() => {});
     oclifConfig = await setupOclifConfig();
 
-    before((fileName, data) => {
+    gitMock.before((fileName, data) => {
       yamlOutput = data;
     });
   });
 
   afterEach(() => {
-    after();
+    gitMock.after();
 
     consoleInfoSpy.mockRestore();
     process.chdir(testWorkingDir);

__tests__/helpers/oclif.ts

@@ -5,14 +5,18 @@ import pkg from '../../package.json' with { type: 'json' };
 import DocsUploadCommand from '../../src/commands/docs/upload.js';
 import { cleanAPIv1Headers, fetchSchema, handleAPIv1Res, readmeAPIv1Fetch } from '../../src/lib/readmeAPIFetch.js';
 import { getAPIv1Mock, oasFetchMock } from '../helpers/get-api-mock.js';
+import { githubActionsEnv } from '../helpers/git-mock.js';
 import { setupOclifConfig } from '../helpers/oclif.js';
-import { after, before } from '../helpers/setup-gha-env.js';
 
 describe('#readmeAPIv1Fetch()', () => {
   describe('GitHub Actions environment', () => {
-    beforeEach(before);
+    beforeEach(() => {
+      githubActionsEnv.before();
+    });
 
-    afterEach(after);
+    afterEach(() => {
+      githubActionsEnv.after();
+    });
 
     it('should have correct headers for requests in GitHub Action env', async () => {
       const key = 'API_KEY';