[Bitbucket] Allow to enable/disable forking of an repo atlassian-api#503

Author: gonchik

atlassian/bitbucket/__init__.py

@@ -1025,6 +1025,40 @@ def update_repo(self, project_key, repository_slug, **params):
         url = self._url_repo(project_key, repository_slug)
         return self.put(url, data=params)
 
+    def get_repo_forkable(self, project_key, repository_slug):
+        """Return whether a Bitbucket Server/Data Center repository is forkable.
+
+        :param project_key: Project key, or a ``~user`` personal repository owner.
+        :param repository_slug: URL-compatible repository identifier.
+        :return: The repository's ``forkable`` flag, or ``None`` when omitted
+            by an older Bitbucket version.
+        """
+        return (self.get_repo(project_key, repository_slug) or {}).get("forkable")
+
+    def set_repo_forkable(self, project_key, repository_slug, forkable):
+        """Enable or disable forking for a Server/Data Center repository.
+
+        The caller requires repository administration permission. This uses the
+        repository ``PUT`` endpoint and preserves the behavior of
+        :meth:`update_repo` for all other repository fields.
+
+        :param project_key: Project key, or a ``~user`` personal repository owner.
+        :param repository_slug: URL-compatible repository identifier.
+        :param forkable: ``True`` to allow forks or ``False`` to prohibit them.
+        :return: Updated repository representation.
+        """
+        if not isinstance(forkable, bool):
+            raise TypeError("forkable must be a boolean")
+        return self.update_repo(project_key, repository_slug, forkable=forkable)
+
+    def enable_repo_forking(self, project_key, repository_slug):
+        """Enable forking for a Server/Data Center repository."""
+        return self.set_repo_forkable(project_key, repository_slug, True)
+
+    def disable_repo_forking(self, project_key, repository_slug):
+        """Disable forking for a Server/Data Center repository."""
+        return self.set_repo_forkable(project_key, repository_slug, False)
+
     def delete_repo(self, project_key, repository_slug):
         """
         Delete a specific repository from a project. This operates based on slug not name which may

docs/bitbucket.rst

@@ -324,6 +324,13 @@ Manage code
     # The authenticated user must have PROJECT_ADMIN permission for the context project to call this resource.
     bitbucket.create_repo(project_key, repository, forkable=False, is_private=True)
 
+    # Bitbucket Server/Data Center: inspect or change whether a repository
+    # accepts forks. These calls require repository administration permission.
+    is_forkable = bitbucket.get_repo_forkable(project_key, repository)
+    bitbucket.set_repo_forkable(project_key, repository, forkable=True)
+    bitbucket.enable_repo_forking(project_key, repository)
+    bitbucket.disable_repo_forking(project_key, repository)
+
     # Get branches from repo
     bitbucket.get_branches(project, repository, filter='', limit=99999, details=True, boost_matches=False)
 

tests/test_bitbucket_server.py

@@ -118,6 +118,27 @@ def test_create_hook_script_rejects_unknown_hook_type(self):
         with self.assertRaisesRegex(ValueError, "PRE.*POST"):
             self.bitbucket.create_hook_script(b"#!/bin/sh", "Invalid", "PRE_RECEIVE")
 
+
+class TestRepositoryForking(TestCase):
+    def setUp(self):
+        self.bitbucket = Bitbucket("https://bitbucket.example.com", username="admin", password="password")
+
+    @patch.object(Bitbucket, "get_repo", return_value={"forkable": True})
+    def test_get_repo_forkable(self, mock_get_repo):
+        assert self.bitbucket.get_repo_forkable("PRJ", "repo") is True
+        mock_get_repo.assert_called_once_with("PRJ", "repo")
+
+    @patch.object(Bitbucket, "update_repo", return_value={"forkable": False})
+    def test_set_repo_forkable_uses_repository_put_wrapper(self, mock_update_repo):
+        result = self.bitbucket.set_repo_forkable("PRJ", "repo", False)
+
+        assert result == {"forkable": False}
+        mock_update_repo.assert_called_once_with("PRJ", "repo", forkable=False)
+
+    def test_set_repo_forkable_requires_boolean(self):
+        with self.assertRaisesRegex(TypeError, "boolean"):
+            self.bitbucket.set_repo_forkable("PRJ", "repo", "false")
+
     @patch.object(Bitbucket, "put")
     def test_configure_project_hook_script(self, mock_put):
         self.bitbucket.configure_project_hook_script("PROJ", 12, ["repo:refs_changed"])