add support for version: every in the check step

Author: jtarchie

README.md

@@ -51,6 +51,10 @@ resource_types:
 * `api_endpoint`: *Optional.* If the repository is located on a GitHub Enterprise
   instance you need to specify the base api endpoint (e.g. "https://\<hostname\>/api/v3/").
 
+* `every`: *Optional* If set to `true`, it will override the `check` step so every pull request can be iterated
+through, without relying on a status being on it. This feature should only be used in
+concourse version 1.2.x and higher and the [`version: every`](http://concourse.ci/get-step.html#get-version).
+
 ## Behavior
 
 ### `check`: Check for new pull requests

assets/lib/check.rb

@@ -10,9 +10,13 @@
 
 input['version'] ||= {}
 
-next_pull_request = repo.next_pull_request(id: input['version']['pr'], sha: input['version']['ref'])
-if next_pull_request
-  json!([next_pull_request.as_json])
+if input['source']['every']
+  json!(repo.pull_requests.map(&:as_json))
 else
-  json!([])
+  next_pull_request = repo.next_pull_request(id: input['version']['pr'], sha: input['version']['ref'])
+  if next_pull_request
+    json!([next_pull_request.as_json])
+  else
+    json!([])
+  end
 end

assets/lib/in.rb

@@ -17,6 +17,8 @@ def ref
   input['version']['ref']
 end
 
+$stderr.puts 'DEPRECATION: Please note that you should update to using `version: every` on your `get` for this resource.'
+
 pr = Octokit.pull_request(input['source']['repo'], input['version']['pr'])
 id = pr['number']
 branch_ref = pr['head']['ref']

spec/integration/check_spec.rb

@@ -11,126 +11,190 @@
   context 'when working with an external API' do
     it 'makes requests with respect to that endpoint' do
       proxy.stub('https://test.example.com:443/repos/jtarchie/test/pulls')
-           .and_return(json: [])
+        .and_return(json: [])
 
       expect(check(source: {
-                     repo: 'jtarchie/test',
-                     api_endpoint: 'https://test.example.com'
-                   })).to eq []
+        repo: 'jtarchie/test',
+        api_endpoint: 'https://test.example.com'
+      })).to eq []
     end
   end
 
-  context 'when there are no pull requests' do
-    before do
-      proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls')
-           .and_return(json: [])
-    end
+  context 'with check for `version: every`' do
+    context 'when there are no pull requests' do
+      before do
+        proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls')
+             .and_return(json: [])
+      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 } }
 
-    it 'returns no versions' do
-      expect(check(source: { repo: 'jtarchie/test' })).to eq []
+          proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls/1')
+               .and_return(json: {})
+
+          expect(check(payload)).to eq []
+        end
+      end
     end
 
-    context 'when there is a last known version' do
-      it 'returns no versions' do
-        payload = { version: { ref: '1' }, source: { repo: 'jtarchie/test' } }
+    context 'when there is an open pull request' do
+      before do
+        proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls')
+             .and_return(json: [{ number: 1, head: { sha: 'abcdef' } }])
+      end
 
-        proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls/1')
-             .and_return(json: {})
+      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 []
+          expect(check(payload)).to eq [
+            { 'ref' => 'abcdef', 'pr' => '1' }
+          ]
+        end
       end
     end
-  end
 
-  context 'when there is an open pull request' do
-    before do
-      proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls')
-           .and_return(json: [{ number: 1, head: { sha: 'abcdef' } }])
+    context 'when there is more than one open pull request' do
+      before do
+        proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls')
+             .and_return(json: [
+                           { number: 2, head: { sha: 'zyxwvu' } },
+                           { number: 1, head: { sha: 'abcdef' } }
+                         ])
+      end
+
+      it 'returns all the pull request SHAs' do
+        expect(check(source: { repo: 'jtarchie/test', every: true }, version: {})).to eq [
+          { 'ref' => 'zyxwvu', 'pr' => '2' },
+          { 'ref' => 'abcdef', 'pr' => '1' }
+        ]
+      end
     end
+  end
 
-    context 'that has no status' do
+  context 'with current check steps' do
+    context 'when there are no pull requests' do
       before do
-        proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef')
+        proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls')
              .and_return(json: [])
       end
 
-      it 'returns SHA of the pull request' do
-        expect(check(source: { repo: 'jtarchie/test' }, version: {})).to eq [{ 'ref' => 'abcdef', 'pr' => '1' }]
+      it 'returns no versions' do
+        expect(check(source: { repo: 'jtarchie/test' })).to eq []
       end
 
-      context 'and the version is the same as the pull request' do
+      context 'when there is a last known version' do
         it 'returns no versions' do
-          payload = { version: { ref: 'abcdef', pr: '1' }, source: { repo: 'jtarchie/test' } }
+          payload = { version: { ref: '1' }, source: { repo: 'jtarchie/test' } }
+
+          proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls/1')
+               .and_return(json: {})
 
           expect(check(payload)).to eq []
         end
       end
     end
 
-    context 'that has a pending status' do
+    context 'when there is an open pull request' do
       before do
-        proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef')
-             .and_return(json: [{ state: 'pending', context: 'concourse-ci' }])
+        proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls')
+             .and_return(json: [{ number: 1, head: { sha: 'abcdef' } }])
       end
 
-      it 'returns no versions' do
-        expect(check(source: { repo: 'jtarchie/test' }, version: {})).to eq []
+      context 'that has no status' do
+        before do
+          proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef')
+               .and_return(json: [])
+        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 'and the version is the same as the pull request' do
+      context 'that has a pending status' do
+        before do
+          proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef')
+               .and_return(json: [{ state: 'pending', context: 'concourse-ci' }])
+        end
+
         it 'returns no versions' do
-          payload = { version: { ref: 'abcdef', pr: '1' }, source: { repo: 'jtarchie/test' } }
+          expect(check(source: { repo: 'jtarchie/test' }, version: {})).to eq []
+        end
 
-          expect(check(payload)).to eq []
+        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
-    end
 
-    context 'that has another status' do
-      it 'does not return it' do
-        proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef')
-             .and_return(json: [
-                           { state: 'pending', context: 'concourse-ci' },
-                           { state: 'success', context: 'concourse-ci' }
-                         ])
+      context 'that has another status' do
+        it 'does not return it' do
+          proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef')
+               .and_return(json: [
+                             { state: 'pending', context: 'concourse-ci' },
+                             { state: 'success', context: 'concourse-ci' }
+                           ])
 
-        expect(check(source: { repo: 'jtarchie/test' }, version: {})).to eq []
+          expect(check(source: { repo: 'jtarchie/test' }, version: {})).to eq []
+        end
       end
     end
-  end
 
-  context 'when there is more than one open pull request' do
-    before do
-      proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls')
-           .and_return(json: [
-                         { number: 2, head: { sha: 'zyxwvu' } },
-                         { number: 1, head: { sha: 'abcdef' } }
-                       ])
-    end
+    context 'when there is more than one open pull request' do
+      before do
+        proxy.stub('https://api.github.com:443/repos/jtarchie/test/pulls')
+             .and_return(json: [
+                           { number: 2, head: { sha: 'zyxwvu' } },
+                           { number: 1, head: { sha: 'abcdef' } }
+                         ])
+      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' } }
+      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' } }
 
-        proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef')
-             .and_return(json: [{ state: 'pending', context: 'concourse-ci' }])
+          proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef')
+               .and_return(json: [{ state: 'pending', context: 'concourse-ci' }])
 
-        proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/zyxwvu')
-             .and_return(json: [])
+          proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/zyxwvu')
+               .and_return(json: [])
 
-        expect(check(payload)).to eq [{ 'ref' => 'zyxwvu', 'pr' => '2' }]
-      end
+          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' } }
+        it 'returns nothing when its still pending' do
+          payload = { version: { ref: 'abcdef', pr: '1' }, source: { repo: 'jtarchie/test' } }
 
-        proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef')
-             .and_return(json: [{ state: 'success', context: 'concourse-ci' }])
+          proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/abcdef')
+               .and_return(json: [{ state: 'success', context: 'concourse-ci' }])
 
-        proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/zyxwvu')
-             .and_return(json: [{ state: 'pending', context: 'concourse-ci' }])
+          proxy.stub('https://api.github.com:443/repos/jtarchie/test/statuses/zyxwvu')
+               .and_return(json: [{ state: 'pending', context: 'concourse-ci' }])
 
-        expect(check(payload)).to eq []
+          expect(check(payload)).to eq []
+        end
       end
     end
   end

spec/integration/in_spec.rb

@@ -72,4 +72,11 @@ def commit(msg)
       expect(error).to include 'git clone failed'
     end
   end
+
+  context 'when `every` is not defined' do
+    it 'shows a deprecation warning' do
+      _, error = get(version: { ref: @ref, pr: '1' }, source: { uri: git_uri, repo: 'jtarchie/test' })
+      expect(error).to include 'DEPRECATION: Please note that you should update to using `version: every` on your `get` for this resource.'
+    end
+  end
 end