Add tests for PullFile#contents

sigmavirus24 · sigmavirus24 · commit 67ca14b9c433 · 2015-02-20T23:49:51.000-06:00
- Re-order methods
- Make existing PullFile#download unit test better
diff --git a/github3/pulls.py b/github3/pulls.py
@@ -82,6 +82,18 @@ def _update_attributes(self, pfile):
     def _repr(self):
         return '<Pull Request File [{0}]>'.format(self.filename)
 
+    def contents(self):
+        """Return the contents of the file as bytes.
+
+        :param stream: When true, the resulting object can be iterated over via
+            ``iter_contents``.
+        """
+        headers = {'Accept': 'application/octet-stream'}
+        resp = self._get(self.raw_url, headers=headers)
+        if self._boolean(resp, 200, 404):
+            return resp.content
+        return b''
+
     def download(self, path=None):
         """Download the contents for this file to disk.
 
@@ -100,18 +112,6 @@ def download(self, path=None):
             return utils.stream_response_to_file(resp, path)
         return None
 
-    def contents(self):
-        """Return the contents of the file as bytes.
-
-        :param stream: When true, the resulting object can be iterated over via
-            ``iter_contents``.
-        """
-        headers = {'Accept': 'application/octet-stream'}
-        resp = self._get(self.raw_url, headers=headers)
-        if self._boolean(resp, 200, 404):
-            return resp.content
-        return b''
-
 
 class PullRequest(models.GitHubCore):
 
diff --git a/tests/cassettes/PullFile_contents.json b/tests/cassettes/PullFile_contents.json
diff --git a/tests/integration/test_pulls.py b/tests/integration/test_pulls.py
@@ -132,18 +132,36 @@ def test_reply(self):
 
 class TestPullFile(IntegrationHelper):
     """Integration tests for the PullFile object."""
+    def get_pull_request_file(self, owner, repo, pull_number, filename):
+        p = self.gh.pull_request(owner, repo, pull_number)
+
+        for pull_file in p.files():
+            if pull_file.filename == filename:
+                break
+        else:
+            assert False, "Could not find '{0}'".format(filename)
+
+        return pull_file
+
+    def test_contents(self):
+        """Show that a user can retrieve the contents of a PR file."""
+        cassette_name = self.cassette_name('contents')
+        with self.recorder.use_cassette(cassette_name):
+            pull_file = self.get_pull_request_file(
+                owner='sigmavirus24', repo='github3.py', pull_number=286,
+                filename='github3/pulls.py'
+            )
+
+            assert isinstance(pull_file.contents(), bytes)
 
     def test_download(self):
         """Show that a user can download a file in a pull request."""
         cassette_name = self.cassette_name('download')
         with self.recorder.use_cassette(cassette_name):
-            p = self.gh.pull_request('sigmavirus24', 'github3.py', 286)
-
-            for pull_file in p.files():
-                if pull_file.filename == 'github3/pulls.py':
-                    break
-            else:
-                assert False, "Could not find 'github3/pulls.py'"
+            pull_file = self.get_pull_request_file(
+                owner='sigmavirus24', repo='github3.py', pull_number=286,
+                filename='github3/pulls.py'
+            )
 
             with tempfile.NamedTemporaryFile() as fd:
                 filename = pull_file.download(fd)
diff --git a/tests/unit/test_pulls.py b/tests/unit/test_pulls.py
@@ -309,7 +309,8 @@ def test_download(self, stream_response_to_file):
             self.example_data['raw_url'], stream=True,
             headers={'Accept': 'application/octet-stream'}
         )
-        stream_response_to_file.assert_called_once_with(mock.ANY, 'file1.txt')
+        stream_response_to_file.assert_called_once_with(response_mock,
+                                                        'file1.txt')
 
     @mock.patch('github3.utils.stream_response_to_file')
     def test_download_does_not_stream(self, stream_response_to_file):
@@ -323,3 +324,12 @@ def test_download_does_not_stream(self, stream_response_to_file):
             headers={'Accept': 'application/octet-stream'}
         )
         assert stream_response_to_file.called is False
+
+    def test_contents(self):
+        """Verify the request made to fetch a pull request file contents."""
+        self.instance.contents()
+
+        self.session.get.assert_called_once_with(
+            self.example_data['raw_url'],
+            headers={'Accept': 'application/octet-stream'}
+        )
