Merge pull request sigmavirus24#803 from sigmavirus24/bug/801

sigmavirus24 · web-flow · commit de04628c08ed · 2018-03-21T19:03:20.000-05:00
Generate the _api attribute for ShortBranch objects
diff --git a/github3/repos/branch.py b/github3/repos/branch.py
@@ -25,12 +25,14 @@ class _Branch(models.GitHubCore):
     def _update_attributes(self, branch):
         self.commit = commit.MiniCommit(branch['commit'], self)
         self.name = branch['name']
+        base = self.commit.url.split('/commit', 1)[0]
+        self._api = self._build_url('branches', self.name, base_url=base)
 
     def _repr(self):
         return '<{0} [{1}]>'.format(self.class_name, self.name)
 
     def latest_sha(self, differs_from=''):
-        """Check if SHA-1 is the same as remote branch.
+        """Check if SHA-1 is the same as the remote branch.
 
         See: https://git.io/vaqIw
 
@@ -139,10 +141,6 @@ def _update_attributes(self, branch):
         self.protection_url = branch['protection_url']
         if self.links and 'self' in self.links:
             self._api = self.links['self']
-        elif isinstance(self.commit, commit.ShortCommit):
-            # Branches obtained via `repo.branches` don't have links.
-            base = self.commit.url.split('/commit', 1)[0]
-            self._api = self._build_url('branches', self.name, base_url=base)
 
 
 class ShortBranch(_Branch):
diff --git a/tests/unit/helper.py b/tests/unit/helper.py
@@ -44,14 +44,32 @@ def build_url(self, *args, **kwargs):
     return github3.session.GitHubSession().build_url(*args, **kwargs)
 
 
-class UnitHelper(unittest.TestCase):
+def enterprise_build_url_builder(enterprise_url):
+    """Build a URL builder function."""
+    def enterprise_build_url(self, *args, **kwargs):
+        """A function to proxy to the actual GitHubSession#build_url method."""
+        # We want to assert what is happening with the actual calls to the
+        # Internet. We can proxy this.
+        return github3.session.GitHubSession().build_url(
+            *args,
+            base_url=enterprise_url,
+            **kwargs
+        )
+    return enterprise_build_url
 
+
+class UnitHelper(unittest.TestCase):
     """Base class for unittests."""
 
     # Sub-classes must assign the class to this during definition
     described_class = None
     # Sub-classes must also assign a dictionary to this during definition
     example_data = {}
+    enterprise_url = None
+
+    @staticmethod
+    def get_build_url_proxy():
+        return build_url
 
     def create_mocked_session(self):
         """Use mock to auto-spec a GitHubSession and return an instance."""
@@ -89,7 +107,10 @@ def create_instance_of_described_class(self):
             instance = self.described_class(self.example_data, session)
 
         else:
-            instance = self.described_class()
+            if self.enterprise_url is None:
+                instance = self.described_class()
+            else:
+                instance = self.described_class(self.enterprise_url)
             instance.session = self.session
 
         return instance
@@ -154,13 +175,18 @@ def put_called_with(self, *args, **kwargs):
     def setUp(self):
         """Use to set up attributes on self before each test."""
         self.session = self.create_session_mock()
-        self.instance = self.create_instance_of_described_class()
         # Proxy the build_url method to the class so it can build the URL and
         # we can assert things about the call that will be attempted to the
         # internet
-        self.described_class._build_url = build_url
+        self.old_build_url = self.described_class._build_url
+        self.described_class._build_url = self.get_build_url_proxy()
+        self.instance = self.create_instance_of_described_class()
         self.after_setup()
 
+    def tearDown(self):
+        """Reset attributes on items under test."""
+        self.described_class._build_url = self.old_build_url
+
     def after_setup(self):
         """No-op method to avoid people having to override setUp."""
         pass
@@ -234,42 +260,17 @@ def assert_requires_auth(self, func, *args, **kwargs):
 
 
 class UnitGitHubObjectHelper(UnitHelper):
-
     """Base class for GitHubObject unit tests."""
+    # TODO(sigmavirus24): delete me
 
-    def setUp(self):
-        self.session = None
-        self.instance = self.create_instance_of_described_class()
-        # Proxy the build_url method to the class so it can build the URL and
-        # we can assert things about the call that will be attempted to the
-        # internet
-        self.described_class._build_url = build_url
-        self.after_setup()
-        pass
+    pass
 
 
 @pytest.mark.usefixtures('enterprise_url')
 class UnitGitHubEnterpriseHelper(UnitHelper):
 
-    def build_url(self, *args, **kwargs):
-        """A function to proxy to the actual GitHubSession#build_url method."""
-        # We want to assert what is happening with the actual calls to the
-        # Internet. We can proxy this.
-        return github3.session.GitHubSession().build_url(
-            *args,
-            base_url=self.enterprise_url,
-            **kwargs
-        )
-
-    def setUp(self):
-        self.session = self.create_session_mock()
-        self.instance = github3.GitHubEnterprise(self.enterprise_url)
-        self.instance.session = self.session
-        # Proxy the build_url method to the class so it can build the URL and
-        # we can assert things about the call that will be attempted to the
-        # internet
-        self.instance._build_url = self.build_url
-        self.after_setup()
+    def get_build_url_proxy(self):
+        return enterprise_build_url_builder(self.enterprise_url)
 
 
 is_py3 = (3, 0) <= sys.version_info < (4, 0)
diff --git a/tests/unit/json/repos_branch_example b/tests/unit/json/repos_branch_example
@@ -3,6 +3,7 @@
   "commit": {
     "sha": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
     "commit": {
+      "url": "https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d",
       "author": {
         "name": "The Octocat",
         "date": "2012-03-06T15:06:50-08:00",
