feat(GHA): workflow file creation onboarding

__tests__/cmds/__snapshots__/validate.test.ts.snap

@@ -1,5 +1,149 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt (github flag enabled) 1`] = `
+"
+Your GitHub Action has been created! ✨
+
+You're almost finished! Just a couple more steps:
+1. Commit and push your newly created file (.github/workflows/validate-test-opt-spec-github-file.yml) to GitHub 🚀
+2. Create a GitHub secret called \`README_API_KEY\` and populate that with a ReadMe API key 🔑"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt (github flag enabled) 2`] = `
+"# This GitHub Action workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
+# You can view our full documentation here: https://docs.readme.com/docs/rdme
+name: ReadMe GitHub Action 🦉
+
+on:
+  push:
+    branches:
+      # This workflow will run every time you push code to the following branch: \`validate-test-opt-spec-github-branch\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - validate-test-opt-spec-github-branch
+
+jobs:
+  rdme-validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`validate\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: validate __tests__/__fixtures__/petstore-simple-weird-version.json
+"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt (including workingDirectory) 1`] = `
+"
+Your GitHub Action has been created! ✨
+
+You're almost finished! Just a couple more steps:
+1. Commit and push your newly created file (.github/workflows/validate-test-opt-spec-workdir-file.yml) to GitHub 🚀
+2. Create a GitHub secret called \`README_API_KEY\` and populate that with a ReadMe API key 🔑"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt (including workingDirectory) 2`] = `
+"# This GitHub Action workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
+# You can view our full documentation here: https://docs.readme.com/docs/rdme
+name: ReadMe GitHub Action 🦉
+
+on:
+  push:
+    branches:
+      # This workflow will run every time you push code to the following branch: \`validate-test-opt-spec-github-branch\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - validate-test-opt-spec-github-branch
+
+jobs:
+  rdme-validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`validate\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: validate petstore.json --workingDirectory=./__tests__/__fixtures__/relative-ref-oas
+"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt 1`] = `
+"
+Your GitHub Action has been created! ✨
+
+You're almost finished! Just a couple more steps:
+1. Commit and push your newly created file (.github/workflows/validate-test-opt-spec-file.yml) to GitHub 🚀
+2. Create a GitHub secret called \`README_API_KEY\` and populate that with a ReadMe API key 🔑"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via opt 2`] = `
+"# This GitHub Action workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
+# You can view our full documentation here: https://docs.readme.com/docs/rdme
+name: ReadMe GitHub Action 🦉
+
+on:
+  push:
+    branches:
+      # This workflow will run every time you push code to the following branch: \`validate-test-opt-spec-branch\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - validate-test-opt-spec-branch
+
+jobs:
+  rdme-validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`validate\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: validate __tests__/__fixtures__/petstore-simple-weird-version.json
+"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via prompts 1`] = `
+"
+Your GitHub Action has been created! ✨
+
+You're almost finished! Just a couple more steps:
+1. Commit and push your newly created file (.github/workflows/validate-test-file.yml) to GitHub 🚀
+2. Create a GitHub secret called \`README_API_KEY\` and populate that with a ReadMe API key 🔑"
+`;
+
+exports[`rdme validate GHA onboarding E2E tests should create GHA workflow if user passes in spec via prompts 2`] = `
+"# This GitHub Action workflow was auto-generated by the \`rdme\` cli on 2022-01-01T00:00:00.000Z
+# You can view our full documentation here: https://docs.readme.com/docs/rdme
+name: ReadMe GitHub Action 🦉
+
+on:
+  push:
+    branches:
+      # This workflow will run every time you push code to the following branch: \`validate-test-branch\`
+      # Check out GitHub's docs for more info on configuring this:
+      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
+      - validate-test-branch
+
+jobs:
+  rdme-validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repo 📚
+        uses: actions/checkout@v3
+
+      - name: Run \`validate\` command 🚀
+        uses: readmeio/[email protected]
+        with:
+          rdme: validate __tests__/__fixtures__/petstore-simple-weird-version.json
+"
+`;
+
 exports[`rdme validate error handling should throw an error if an invalid OpenAPI 3.1 definition is supplied 1`] = `
 [SyntaxError: OpenAPI schema validation failed.
 

__tests__/cmds/openapi/reduce.test.ts

@@ -17,8 +17,6 @@ const getCommandOutput = () => consoleInfoSpy.mock.calls.join('\n\n');
 
 describe('rdme openapi:reduce', () => {
   beforeEach(() => {
-    jest.mock('fs');
-
     consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation();
   });
 

__tests__/cmds/validate.test.ts

@@ -1,10 +1,14 @@
 /* eslint-disable no-console */
+import type { Response } from 'simple-git';
+
 import fs from 'fs';
 
 import chalk from 'chalk';
 import prompts from 'prompts';
 
 import Command from '../../src/cmds/validate';
+import { git } from '../../src/lib/createGHA';
+import createGitRemoteMock from '../helpers/get-git-mock';
 
 const testWorkingDir = process.cwd();
 
@@ -105,4 +109,144 @@ describe('rdme validate', () => {
       return expect(validate.run({ spec: './__tests__/__fixtures__/invalid-swagger.json' })).rejects.toMatchSnapshot();
     });
   });
+
+  describe('CI tests', () => {
+    beforeEach(() => {
+      process.env.TEST_CI = 'true';
+    });
+
+    afterEach(() => {
+      delete process.env.TEST_CI;
+    });
+
+    it('should successfully validate prompt and not run GHA onboarding', async () => {
+      process.env.TEST_CREATEGHA = 'true';
+      const spec = '__tests__/__fixtures__/petstore-simple-weird-version.json';
+      await expect(validate.run({ spec })).resolves.toBe(chalk.green(`${spec} is a valid OpenAPI API definition!`));
+      delete process.env.TEST_CREATEGHA;
+    });
+
+    it('should fail if user attempts to pass `--github` flag in CI environment', () => {
+      return expect(
+        validate.run({ github: true, spec: '__tests__/__fixtures__/petstore-simple-weird-version.json' })
+      ).rejects.toStrictEqual(new Error('The `--github` flag is only for usage in non-CI environments.'));
+    });
+  });
+
+  describe('GHA onboarding E2E tests', () => {
+    let consoleInfoSpy;
+
+    beforeEach(() => {
+      consoleInfoSpy = jest.spyOn(console, 'info').mockImplementation();
+
+      // global Date override to handle timestamp generation
+      // stolen from here: https://github.com/facebook/jest/issues/2234#issuecomment-294873406
+      const DATE_TO_USE = new Date('2022');
+      // @ts-expect-error we're just overriding the constructor for tests,
+      // no need to construct everything
+      global.Date = jest.fn(() => DATE_TO_USE);
+
+      git.checkIsRepo = jest.fn(() => {
+        return Promise.resolve(true) as unknown as Response<boolean>;
+      });
+
+      git.remote = createGitRemoteMock();
+
+      process.env.TEST_CREATEGHA = 'true';
+    });
+
+    afterEach(() => {
+      consoleInfoSpy.mockRestore();
+      delete process.env.TEST_CREATEGHA;
+      jest.clearAllMocks();
+    });
+
+    it('should create GHA workflow if user passes in spec via prompts', async () => {
+      expect.assertions(6);
+      let yamlOutput;
+      const spec = '__tests__/__fixtures__/petstore-simple-weird-version.json';
+      const fileName = 'validate-test-file';
+      prompts.inject([spec, true, 'validate-test-branch', fileName]);
+
+      fs.writeFileSync = jest.fn((f, d) => {
+        yamlOutput = d;
+        return true;
+      });
+
+      await expect(validate.run({})).resolves.toMatchSnapshot();
+
+      expect(yamlOutput).toMatchSnapshot();
+      expect(fs.writeFileSync).toHaveBeenCalledWith(`.github/workflows/${fileName}.yml`, expect.any(String));
+      expect(console.info).toHaveBeenCalledTimes(2);
+      const output = getCommandOutput();
+      expect(output).toMatch('GitHub Repository detected!');
+      expect(output).toMatch('is a valid OpenAPI API definition!');
+    });
+
+    it('should create GHA workflow if user passes in spec via opt', async () => {
+      expect.assertions(3);
+      let yamlOutput;
+      const spec = '__tests__/__fixtures__/petstore-simple-weird-version.json';
+      const fileName = 'validate-test-opt-spec-file';
+      prompts.inject([true, 'validate-test-opt-spec-branch', fileName]);
+
+      fs.writeFileSync = jest.fn((f, d) => {
+        yamlOutput = d;
+        return true;
+      });
+
+      await expect(validate.run({ spec })).resolves.toMatchSnapshot();
+
+      expect(yamlOutput).toMatchSnapshot();
+      expect(fs.writeFileSync).toHaveBeenCalledWith(`.github/workflows/${fileName}.yml`, expect.any(String));
+    });
+
+    it('should create GHA workflow if user passes in spec via opt (github flag enabled)', async () => {
+      expect.assertions(3);
+      let yamlOutput;
+      const spec = '__tests__/__fixtures__/petstore-simple-weird-version.json';
+      const fileName = 'validate-test-opt-spec-github-file';
+      prompts.inject(['validate-test-opt-spec-github-branch', fileName]);
+
+      fs.writeFileSync = jest.fn((f, d) => {
+        yamlOutput = d;
+        return true;
+      });
+
+      await expect(validate.run({ spec, github: true })).resolves.toMatchSnapshot();
+
+      expect(yamlOutput).toMatchSnapshot();
+      expect(fs.writeFileSync).toHaveBeenCalledWith(`.github/workflows/${fileName}.yml`, expect.any(String));
+    });
+
+    it('should create GHA workflow if user passes in spec via opt (including workingDirectory)', async () => {
+      expect.assertions(3);
+      let yamlOutput;
+      const spec = 'petstore.json';
+      const fileName = 'validate-test-opt-spec-workdir-file';
+      prompts.inject([true, 'validate-test-opt-spec-github-branch', fileName]);
+
+      fs.writeFileSync = jest.fn((f, d) => {
+        yamlOutput = d;
+        return true;
+      });
+
+      await expect(
+        validate.run({ spec, workingDirectory: './__tests__/__fixtures__/relative-ref-oas' })
+      ).resolves.toMatchSnapshot();
+
+      expect(yamlOutput).toMatchSnapshot();
+      expect(fs.writeFileSync).toHaveBeenCalledWith(`.github/workflows/${fileName}.yml`, expect.any(String));
+    });
+
+    it('should reject if user says no to creating GHA workflow', () => {
+      const spec = '__tests__/__fixtures__/petstore-simple-weird-version.json';
+      prompts.inject([spec, false]);
+      return expect(validate.run({})).rejects.toStrictEqual(
+        new Error(
+          'GitHub Action Workflow cancelled. If you ever change your mind, you can run this command again with the `--github` flag.'
+        )
+      );
+    });
+  });
 });

__tests__/helpers/get-git-mock.ts

@@ -0,0 +1,40 @@
+import type { Response } from 'simple-git';
+
+/**
+ * Creates a Jest mock function for testing `git.remote`
+ * @param remote remote to return (usually `origin`)
+ * @param remoteUrl git URL for the given remote
+ * @param defaultBranch the HEAD branch
+ */
+export default function createGitRemoteMock(
+  remote = 'origin',
+  remoteUrl = 'https://github.com/readmeio/rdme.git',
+  defaultBranch = 'main'
+) {
+  return jest.fn(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 (!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>;
+  });
+}