index.test.js

const nock = require('nock');
const fs = require('fs');

const { Toolkit } = require('actions-toolkit');

function mockGetPRCommitListRequest(commits) {
  nock('https://api.github.com')
    .get('/repos/vijaykramesh/pr-lint-action-test/pulls/1/commits')
    .query(true)
    .reply(200, commits);
}

function encodeContent(content) {
  return Buffer.from(content).toString('base64');
}

function configFixture(fileName = 'all.yml') {
  return {
    type: 'file',
    encoding: 'base64',
    size: 5362,
    name: fileName,
    path: `.github/${fileName}`,
    content: encodeContent(fs.readFileSync(`./fixtures/${fileName}`)),
    sha: '3d21ec53a331a6f037a91c368710b99387d012c1',
    url:
      'https://api.github.com/repos/vijaykramesh/pr-lint-action/contents/.github/pr-lint.yml',
    git_url:
      'https://api.github.com/repos/vijaykramesh/pr-lint-action/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1',
    html_url:
      'https://github.com/vijaykramesh/pr-lint-action/blob/master/.github/pr-lint.yml',
    download_url:
      'https://raw.githubusercontent.com/vijaykramesh/pr-lint-action/master/.github/pr-lint.yml',
    _links: {
      git:
        'https://api.github.com/repos/vijaykramesh/pr-lint-action/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1',
      self:
        'https://api.github.com/repos/vijaykramesh/pr-lint-action/contents/.github/pr-lint.yml',
      html:
        'https://github.com/vijaykramesh/pr-lint-action/blob/master/.github/pr-lint.yml',
    },
  };
}

function pullRequestOpenedFixture({ title, ref_name }) {
  return {
    pull_request: {
      number: 1,
      title,
      head: {
        ref: ref_name,
      },
    },
    repository: {
      name: 'pr-lint-action-test',
      owner: {
        login: 'vijaykramesh',
      },
    },
  };
}

describe('pr-lint-action', () => {
  let action; let
    tools;

  // Mock Toolkit.run to define `action` so we can call it
  Toolkit.run = (fn) => { action = fn; };
  // Load up our entrypoint file
  // eslint-disable-next-line
  require('./index.js');

  const bad_title_and_branch = { title: 'no ticket in me', ref_name: 'no-ticket-in-me' };
  const good_title_and_branch = { title: '[PROJ-1234] a good PR title', ref_name: 'bug/PROJ-1234/a_good_branch' };
  const good_title_and_bad_branch = { title: '[PROJ-1234] a good PR title', ref_name: 'fix_things' };
  const bad_title_and_good_branch = { title: 'no ticket in me', ref_name: 'bug/PROJ_1234/a_good_branch' };
  const lower_case_good_title_and_branch = { title: '[proj-1234] a lower case good title', ref_name: 'bug/proj_1234/a_good_lowercase_branch' };
  const no_brackets_title_and_branch = { title: 'PROJ-1234 a good no brackets PR title', ref_name: 'bug/PROJ-1234/a_good_branch' };

  const good_commits = [
    { commit: { message: 'PROJ-1234 Commit 1' } },
    { commit: { message: 'PROJ-1234 Commit 2' } },
    { commit: { message: 'PROJ-1234 Commit 3' } },
  ];
  const lower_case_good_commits = [
    { commit: { message: 'PROJ-1234 Commit 1' } },
    { commit: { message: 'PROJ-1234 Commit 2' } },
    { commit: { message: 'abc-1234 Commit 3' } },
  ];
  const bad_commits = [
    { commit: { message: 'PRJ-123 Commit 1' } },
    { commit: { message: 'PROJ-1234 Commit 2' } },
    { commit: { message: 'Commit 3' } },
  ];

  beforeEach(() => {
    // Create a new Toolkit instance
    tools = new Toolkit();
    // Mock methods on it!
    tools.exit.success = jest.fn();
    tools.exit.failure = jest.fn();
  });

  it('fails if check_title is true and title does not match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('title.yml'));

    tools.context.payload = pullRequestOpenedFixture(bad_title_and_good_branch);

    await action(tools);
    expect(tools.exit.failure).toHaveBeenCalledWith('PR Linting Failed');
    expect.assertions(1);
  });

  it('fails if bad title and branch', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('title.yml'));

    tools.context.payload = pullRequestOpenedFixture(bad_title_and_branch);

    await action(tools);
    expect(tools.exit.failure).toHaveBeenCalledWith('PR Linting Failed');

    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('branch.yml'));

    tools.context.payload = pullRequestOpenedFixture(bad_title_and_branch);

    await action(tools);
    expect(tools.exit.failure).toHaveBeenCalledWith('PR Linting Failed');
    expect.assertions(2);
  });

  it('passes if check_title is false and title does not match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('branch.yml'));

    tools.context.payload = pullRequestOpenedFixture(bad_title_and_good_branch);

    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('passes if check_title is true and title matches', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('title.yml'));

    tools.context.payload = pullRequestOpenedFixture(good_title_and_branch);

    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('fails if check_branch is true and branch does not match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('branch.yml'));

    tools.context.payload = pullRequestOpenedFixture(good_title_and_bad_branch);

    await action(tools);
    expect(tools.exit.failure).toHaveBeenCalledWith('PR Linting Failed');
    expect.assertions(1);
  });

  it('passes if check_branch is false and branch does not match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('title.yml'));

    tools.context.payload = pullRequestOpenedFixture(good_title_and_bad_branch);

    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('passes if check_branch is true and branch matches', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('branch.yml'));

    tools.context.payload = pullRequestOpenedFixture(bad_title_and_good_branch);

    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('passes if check_commits is true and all commits match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('commits.yml'));

    mockGetPRCommitListRequest(good_commits);

    tools.context.payload = pullRequestOpenedFixture(good_title_and_branch);
    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('fails if check_commits is true and some commits do not match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('commits.yml'));

    mockGetPRCommitListRequest(bad_commits);

    tools.context.payload = pullRequestOpenedFixture(good_title_and_branch);
    await action(tools);
    expect(tools.exit.failure).toHaveBeenCalledWith('PR Linting Failed');
    expect.assertions(1);
  });

  it('passes if check_commits is false and all commits match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('title.yml'));

    mockGetPRCommitListRequest(good_commits);

    tools.context.payload = pullRequestOpenedFixture(good_title_and_branch);
    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('passes if check_commits is false and some commits do not match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('title.yml'));

    mockGetPRCommitListRequest(bad_commits);

    tools.context.payload = pullRequestOpenedFixture(good_title_and_branch);
    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('fails if check_branch and check_title is true and title does not match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('all.yml'));

    mockGetPRCommitListRequest(good_commits);

    tools.context.payload = pullRequestOpenedFixture(bad_title_and_good_branch);
    await action(tools);
    expect(tools.exit.failure).toHaveBeenCalledWith('PR Linting Failed');
    expect.assertions(1);
  });

  it('fails if check_branch and check_title is true and title does not match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('all.yml'));

    mockGetPRCommitListRequest(good_commits);

    tools.context.payload = pullRequestOpenedFixture(bad_title_and_good_branch);
    await action(tools);
    expect(tools.exit.failure).toHaveBeenCalledWith('PR Linting Failed');
    expect.assertions(1);
  });

  it('passes if check_branch and check_title is true and both match', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('all.yml'));

    mockGetPRCommitListRequest(good_commits);

    tools.context.payload = pullRequestOpenedFixture(good_title_and_branch);
    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('passes if ignore_case and lower case title/branch', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('all.yml'));

    mockGetPRCommitListRequest(good_commits);

    tools.context.payload = pullRequestOpenedFixture(lower_case_good_title_and_branch);
    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('passes if ignore_case and lower case commits', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('all.yml'));

    mockGetPRCommitListRequest(lower_case_good_commits);

    tools.context.payload = pullRequestOpenedFixture(lower_case_good_title_and_branch);
    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('fails if not ignore_case and lower case title/branch', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('no-ignore-case.yml'));

    mockGetPRCommitListRequest(good_commits);

    tools.context.payload = pullRequestOpenedFixture(lower_case_good_title_and_branch);
    await action(tools);
    expect(tools.exit.failure).toHaveBeenCalledWith('PR Linting Failed');
    expect.assertions(1);
  });

  it('passes if require_brackets is false and title matches without brackets', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('no-brackets.yml'));

    tools.context.payload = pullRequestOpenedFixture(no_brackets_title_and_branch);

    await action(tools);
    expect(tools.exit.success).toHaveBeenCalled();
    expect.assertions(1);
  });

  it('fails if require_brackets is true or default and title matches without brackets', async () => {
    nock('https://api.github.com')
      .get(/\/repos\/vijaykramesh\/.*/)
      .query(true)
      .reply(200, configFixture('title.yml'));

    tools.context.payload = pullRequestOpenedFixture(no_brackets_title_and_branch);

    await action(tools);
    expect(tools.exit.failure).toHaveBeenCalledWith('PR Linting Failed');
    expect.assertions(1);
  });
});