Add wait_until_completion to InfrahubBranchManager.create

Author: LucasG0

infrahub_sdk/branch.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import warnings
 from typing import TYPE_CHECKING, Any, Optional, Union
 from urllib.parse import urlencode
 
@@ -77,10 +78,19 @@ async def create(
         branch_name: str,
         sync_with_git: bool = True,
         description: str = "",
-        background_execution: bool = False,
-    ) -> BranchData:
+        wait_until_completion: bool = True,
+        background_execution: Optional[bool] = False,
+    ) -> BranchData | str:
+        if background_execution is not None:
+            warnings.warn(
+                "`background_execution` is deprecated, please use `wait_until_completion` instead.",
+                DeprecationWarning,
+                stacklevel=1,
+            )
+
+        wait_until_completion = wait_until_completion or not background_execution
         input_data = {
-            "background_execution": background_execution,
+            "wait_until_completion": wait_until_completion,
             "data": {
                 "name": branch_name,
                 "description": description,
@@ -90,7 +100,8 @@ async def create(
 
         query = Mutation(mutation="BranchCreate", input_data=input_data, query=MUTATION_QUERY_DATA)
         response = await self.client.execute_graphql(query=query.render(), tracker="mutation-branch-create")
-
+        if not wait_until_completion:
+            return BranchData(**response["BranchCreate"]["task"]["id"])
         return BranchData(**response["BranchCreate"]["object"])
 
     async def delete(self, branch_name: str) -> bool:

tests/integration/test_infrahub_client.py

@@ -283,3 +283,7 @@ async def test_profile(self, client: InfrahubClient, db: InfrahubDatabase, init_
 
         obj1 = await client.get(kind="BuiltinStatus", id=obj.id)
         assert obj1.description.value == "description in profile"
+
+    async def test_create_branch_async(self, client: InfrahubClient, db: InfrahubDatabase, init_db_base, base_dataset):
+        task_id = await client.branch.create(branch_name="new-branch")
+        assert isinstance(task_id, str)