Merge pull request #7 from ByteInternet/create_brancher_helper_function

feat: Add helper function for creating a brancher in hypernode-api

Author: alejandrogarza

hypernode_api_python/client.py

@@ -9,6 +9,7 @@
 HYPERNODE_API_APP_DETAIL_WITH_ADDONS_ENDPOINT = "/v2/app/{}/with_addons?destroyed=false"
 HYPERNODE_API_APP_EAV_DESCRIPTION_ENDPOINT = "/v2/app/eav_descriptions/"
 HYPERNODE_API_APP_FLAVOR_ENDPOINT = "/v2/app/{}/flavor/"
+HYPERNODE_API_APP_BRANCHER_ENDPOINT = "/v2/app/{}/brancher/"
 HYPERNODE_API_APP_NEXT_BEST_PLAN_ENDPOINT = "/v2/app/{}/next_best_plan/"
 HYPERNODE_API_APP_PRODUCT_LIST_ENDPOINT = "/v2/product/app/{}/"
 HYPERNODE_API_APP_XGRADE_CHECK_ENDPOINT = "/v2/app/xgrade/{}/check/{}/"
@@ -628,3 +629,16 @@ def order_hypernode(self, data):
         :return obj response: The request response object
         """
         return self.requests("POST", HYPERNODE_API_APP_ORDER_ENDPOINT, data=data)
+
+    def create_brancher(self, app_name, data):
+        """
+        Create a new branch (server replica) of your Hypernode.
+
+        :param str app_name: The name of the Hypernode to create the branch from
+        :param dict data: Data regarding the branch to be created. An example could be:
+        {'clear': 'mysql'}.
+        :return obj response: The request response object
+        """
+        return self.requests(
+            "POST", HYPERNODE_API_APP_BRANCHER_ENDPOINT.format(app_name), data=data
+        )

tests/client/test_create_brancher.py

@@ -0,0 +1,36 @@
+from unittest import TestCase
+from unittest.mock import Mock
+
+from hypernode_api_python.client import (
+    HYPERNODE_API_APP_BRANCHER_ENDPOINT,
+    HypernodeAPIPython,
+)
+
+
+class TestCreateBrancher(TestCase):
+    def setUp(self):
+        self.client = HypernodeAPIPython(token="my_token")
+        self.mock_request = Mock()
+        self.client.requests = self.mock_request
+        self.app_name = "my_app"
+
+    def test_brancher_endpoint_is_correct(self):
+        self.assertEqual("/v2/app/{}/brancher/", HYPERNODE_API_APP_BRANCHER_ENDPOINT)
+
+    def test_calls_create_brancher_endpoint_properly(self):
+        data = {"clear_services": ["mysql"]}
+        self.client.create_brancher(self.app_name, data)
+
+        self.mock_request.assert_called_once_with(
+            "POST", f"/v2/app/{self.app_name}/brancher/", data=data
+        )
+
+    def test_returns_create_brancher_data(self):
+        response = Mock()
+        response.status_code = 200
+        self.mock_request.return_value = response
+
+        self.assertEqual(
+            self.client.create_brancher(self.app_name, {}),
+            self.mock_request.return_value,
+        )