check_spec.rb

require_relative '../../assets/lib/commands/check'
require 'webmock/rspec'
require 'json'

describe Commands::Check do
  def check(payload)
    payload['source']['no_ssl_verify'] = true
    payload['version'] ||= {}
    Commands::Check.new(input: payload).output.map &:as_json
  end

  def stub_json(uri, body)
    stub_request(:get, uri)
      .to_return(headers: { 'Content-Type' => 'application/json' }, body: body.to_json)
  end

  context 'when targetting a base branch other than master' do
    before do
      stub_json('https://api.github.com/repos/jtarchie/test/statuses/abcdef', [])
      stub_json('https://api.github.com:443/repos/jtarchie/test/pulls?base=my-base-branch&direction=asc&per_page=100&sort=updated&state=open', [{ number: 1, head: { sha: 'abcdef' } }])
    end

    it 'retrieves pull requests for the specified base branch' do
      expect(check('source' => { 'repo' => 'jtarchie/test', 'base' => 'my-base-branch' })).to eq [{ 'ref' => 'abcdef', 'pr' => '1' }]
    end
  end

  context 'with check for `version: every`' do
    context 'when there are no pull requests' do
      before do
        stub_json('https://api.github.com/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open', [])
      end

      it 'returns no versions' do
        expect(check('source' => { 'repo' => 'jtarchie/test', 'every' => true })).to eq []
      end

      context 'when there is a last known version' do
        it 'returns no versions' do
          payload = { 'version' => { 'ref' => '1' }, 'source' => { 'repo' => 'jtarchie/test', 'every' => true } }

          expect(check(payload)).to eq []
        end
      end
    end

    context 'when there is an open pull request' do
      before do
        stub_json('https://api.github.com:443/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open', [{ number: 1, head: { sha: 'abcdef' } }])
      end

      it 'returns SHA of the pull request' do
        expect(check('source' => { 'repo' => 'jtarchie/test', 'every' => true }, 'version' => {})).to eq [{ 'ref' => 'abcdef', 'pr' => '1' }]
      end

      context 'and the version is the same as the pull request' do
        it 'returns that pull request' do
          payload = { 'version' => { 'ref' => 'abcdef', 'pr' => '1' }, 'source' => { 'repo' => 'jtarchie/test', 'every' => true } }

          expect(check(payload)).to eq [
            { 'ref' => 'abcdef', 'pr' => '1' }
          ]
        end
      end
    end

    context 'when there is more than one open pull request' do
      before do
        stub_json(
          'https://api.github.com:443/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open',
          [
            { number: 1, head: { sha: 'abcdef', repo: { full_name: 'jtarchie/test' } }, base: { repo: { full_name: 'jtarchie/test' } } },
            { number: 3, head: { sha: 'ghijkl', repo: { full_name: 'jtarchie/test' } }, base: { repo: { full_name: 'jtarchie/test' } } },
            { number: 2, head: { sha: 'zyxwvu', repo: { full_name: 'someother/repo' } }, base: { repo: { full_name: 'jtarchie/test' } } },
          ]
        )
      end

      it 'returns all PRs oldest to newest last' do
        expect(check('source' => { 'repo' => 'jtarchie/test', 'every' => true }, 'version' => {})).to eq [
          { 'ref' => 'abcdef', 'pr' => '1' },
          { 'ref' => 'ghijkl', 'pr' => '3' },
          { 'ref' => 'zyxwvu', 'pr' => '2' },
        ]
      end

      it 'filters out PRs from forked repos when requested' do
        expect(check('source' => { 'repo' => 'jtarchie/test', 'every' => true, 'disallow_forks' => true }, 'version' => {})).to eq [
          { 'ref' => 'abcdef', 'pr' => '1' },
          { 'ref' => 'ghijkl', 'pr' => '3' },
        ]
      end
    end
  end

  context 'with current check steps' do
    context 'when there are no pull requests' do
      before do
        stub_json('https://api.github.com/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open', [])
      end

      it 'returns no versions' do
        expect(check('source' => { 'repo' => 'jtarchie/test' })).to eq []
      end

      context 'when there is a last known version' do
        it 'returns no versions' do
          payload = { 'version' => { 'ref' => '1' }, 'source' => { 'repo' => 'jtarchie/test' } }

          expect(check(payload)).to eq []
        end
      end
    end

    context 'when there is an open pull request' do
      before do
        stub_json('https://api.github.com/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open', [{ number: 1, head: { sha: 'abcdef' } }])
      end

      context 'that has no status' do
        before do
          stub_json('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef', [])
        end

        it 'returns SHA of the pull request' do
          expect(check('source' => { 'repo' => 'jtarchie/test' }, 'version' => {})).to eq [{ 'ref' => 'abcdef', 'pr' => '1' }]
        end

        context 'and the version is the same as the pull request' do
          it 'returns no versions' do
            payload = { 'version' => { 'ref' => 'abcdef', 'pr' => '1' }, 'source' => { 'repo' => 'jtarchie/test' } }

            expect(check(payload)).to eq []
          end
        end
      end

      context 'that has a pending status' do
        before do
          stub_json('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef', [{ state: 'pending', context: 'concourse-ci' }])
        end

        it 'returns no versions' do
          expect(check('source' => { 'repo' => 'jtarchie/test' }, 'version' => {})).to eq []
        end

        context 'and the version is the same as the pull request' do
          it 'returns no versions' do
            payload = { 'version' => { 'ref' => 'abcdef', 'pr' => '1' }, 'source' => { 'repo' => 'jtarchie/test' } }

            expect(check(payload)).to eq []
          end
        end
      end

      context 'that has another status' do
        it 'does not return it' do
          stub_json('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef', [
                      { state: 'pending', context: 'concourse-ci' },
                      { state: 'success', context: 'concourse-ci' }
                    ])

          expect(check('source' => { 'repo' => 'jtarchie/test' }, 'version' => {})).to eq []
        end
      end
    end

    context 'when there is more than one open pull request' do
      before do
        stub_json('https://api.github.com/repos/jtarchie/test/statuses/abcdef', [])
        stub_json('https://api.github.com/repos/jtarchie/test/statuses/zyxwvu', [])
        stub_json('https://api.github.com/repos/jtarchie/test/pulls?direction=asc&per_page=100&sort=updated&state=open', [
                    { number: 2, head: { sha: 'zyxwvu', repo: { full_name: 'someotherowner/repo' } }, base: { repo: { full_name: 'jtarchie/test' } } },
                    { number: 1, head: { sha: 'abcdef', repo: { full_name: 'jtarchie/test' } }, base: { repo: { full_name: 'jtarchie/test' } } },
                  ])
      end

      context 'and the version is the same as the older pull request' do
        it 'returns the latest pull request when the current version is not pending' do
          payload = { 'version' => { 'ref' => 'abcdef', 'pr' => '1' }, 'source' => { 'repo' => 'jtarchie/test' } }

          stub_json('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef', [{ state: 'pending', context: 'concourse-ci' }])

          stub_json('https://api.github.com:443/repos/jtarchie/test/statuses/zyxwvu', [])

          expect(check(payload)).to eq [{ 'ref' => 'zyxwvu', 'pr' => '2' }]
        end

        it 'returns nothing when its still pending' do
          payload = { 'version' => { 'ref' => 'abcdef', 'pr' => '1' }, 'source' => { 'repo' => 'jtarchie/test' } }

          stub_json('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef', [{ state: 'success', context: 'concourse-ci' }])

          stub_json('https://api.github.com:443/repos/jtarchie/test/statuses/zyxwvu', [{ state: 'pending', context: 'concourse-ci' }])

          expect(check(payload)).to eq []
        end
      end

      context 'and `disallow_forks` is not set' do
        it 'returns the most recently updated pull request' do
          expect(check('source' => { 'repo' => 'jtarchie/test' })).to eq [{ 'ref' => 'zyxwvu', 'pr' => '2' }]
        end
      end

      context 'and `disallow_forks` is set to true' do
        it 'returns the most recently updated internal pull request' do
          expect(check('source' => { 'repo' => 'jtarchie/test', 'disallow_forks' => true })).to eq [{ 'ref' => 'abcdef', 'pr' => '1' }]
        end
      end
    end
  end
end