Merge pull request sigmavirus24#870 from jacquerie/add-unit-tests-for-branch-protection

sigmavirus24 · web-flow · commit c34e55333ebb · 2018-07-23T07:26:04.000-05:00
Add unit tests for protect and unprotect methods
diff --git a/tests/unit/test_repos_branch.py b/tests/unit/test_repos_branch.py
@@ -3,7 +3,10 @@
 from . import helper
 
 get_example_data = helper.create_example_data_helper('repos_branch_example')
-url_for = helper.create_url_helper(
+url_for_branches = helper.create_url_helper(
+    'https://api.github.com/repos/octocat/Hello-World/branches/master'
+)
+url_for_commits = helper.create_url_helper(
     'https://api.github.com/repos/octocat/Hello-World/commits/master'
 )
 
@@ -22,6 +25,112 @@ def test_latest_sha(self):
         }
         self.instance.latest_sha(differs_from='123')
         self.session.get.assert_called_once_with(
-            url_for(),
+            url_for_commits(),
             headers=headers
         )
+
+    def test_protect(self):
+        """Verify the request to protect a branch."""
+        headers = {
+            'Accept': 'application/vnd.github.loki-preview+json'
+        }
+        json = {
+            'protection': {
+                'enabled': True,
+                'required_status_checks': {
+                    'enforcement_level': 'non_admins',
+                    'contexts': [
+                        'continuous-integration/travis-ci'
+                    ]
+                }
+            }
+        }
+
+        self.instance.protect()
+        self.session.patch.assert_called_once_with(
+            url_for_branches(),
+            headers=headers,
+            json=json
+        )
+
+    def test_protect_enforcement(self):
+        """Verify the request to protect a branch changing enforcement."""
+        headers = {
+            'Accept': 'application/vnd.github.loki-preview+json'
+        }
+        json = {
+            'protection': {
+                'enabled': True,
+                'required_status_checks': {
+                    'enforcement_level': 'off',
+                    'contexts': [
+                        'continuous-integration/travis-ci'
+                    ]
+                }
+            }
+        }
+
+        self.instance.protect(enforcement='off')
+        self.session.patch.assert_called_once_with(
+            url_for_branches(),
+            headers=headers,
+            json=json
+        )
+
+    def test_protect_status_checks(self):
+        """Verify the request to protect a branch changing status checks."""
+        headers = {
+            'Accept': 'application/vnd.github.loki-preview+json'
+        }
+        json = {
+            'protection': {
+                'enabled': True,
+                'required_status_checks': {
+                    'enforcement_level': 'non_admins',
+                    'contexts': [
+                        'another/status-check'
+                    ]
+                }
+            }
+        }
+
+        self.instance.protect(status_checks=['another/status-check'])
+        self.session.patch.assert_called_once_with(
+            url_for_branches(),
+            headers=headers,
+            json=json
+        )
+
+    def test_unprotect(self):
+        """Verify the request to unprotect a branch."""
+        headers = {
+            'Accept': 'application/vnd.github.loki-preview+json'
+        }
+        json = {
+            'protection': {
+                'enabled': False
+            }
+        }
+
+        self.instance.unprotect()
+        self.session.patch.assert_called_once_with(
+            url_for_branches(),
+            headers=headers,
+            json=json
+        )
+
+
+class TestBranchRequiresAuth(helper.UnitRequiresAuthenticationHelper):
+
+    """Unit tests for Branch methods that require authentication."""
+
+    described_class = github3.repos.branch.Branch
+    example_data = get_example_data()
+
+    def test_protect(self):
+        """Verify that protecting a branch requires authentication."""
+        self.assert_requires_auth(self.instance.protect)
+
+    def test_unprotect(self):
+        """Verify that unprotecting a branch requires authentication."""
+        self.assert_requires_auth(self.instance.unprotect)
