Add support for multiple branches in builds API calls (#87)

* builds: add support for multiple `branch` values

BuildKite docs allow support for multiple branches when filtering. Works
the same way the `state` parameter does.

The `branch` value can be a scalar value, which we presume is a single
name of a branch, or it can be a list.

* deps: bump typing-extensions version to latest

Unable to build successfully with specifically 3.7.4.2 because `black`
specifically requires something newer than that, so it conflicts.

* tests: add tests for multi-branch values

* client: for `branch`, just add the raw value

pybuildkite/builds.py

@@ -108,7 +108,7 @@ def list_all(
             "created_to": self.__api_date_format(created_to),
             "finished_from": self.__api_date_format(finished_from),
             "state": self.__get_build_states_query_param(states),
-            "branch": branch,
+            "branch": self.__get_branches_query_param(branch),
             "commit": commit,
             "include_retried_jobs": True if include_retried_jobs is True else None,
             "page": page,
@@ -163,7 +163,7 @@ def list_all_for_org(
             "created_to": self.__api_date_format(created_to),
             "finished_from": self.__api_date_format(finished_from),
             "state": self.__get_build_states_query_param(states),
-            "branch": branch,
+            "branch": self.__get_branches_query_param(branch),
             "commit": commit,
             "include_retried_jobs": True if include_retried_jobs is True else None,
             "page": page,
@@ -222,7 +222,7 @@ def list_all_for_pipeline(
             "created_to": self.__api_date_format(created_to),
             "finished_from": self.__api_date_format(finished_from),
             "state": self.__get_build_states_query_param(states),
-            "branch": branch,
+            "branch": self.__get_branches_query_param(branch),
             "commit": commit,
             "include_retried_jobs": True if include_retried_jobs is True else None,
             "page": page,
@@ -364,3 +364,16 @@ def __get_build_states_query_param(states):
             for state in states:
                 param_string += "state[]={}&".format(state.value)
             return param_string[:-1]
+
+    @staticmethod
+    def __get_branches_query_param(branches):
+        if not branches:
+            return None
+
+        if isinstance(branches, List):
+            param_string = ""
+            for branch in branches:
+                param_string += "branch[]={}&".format(branch)
+            return param_string[:-1]
+        else:
+            return "branch=" + branches

pybuildkite/client.py

@@ -221,6 +221,8 @@ def _convert_query_params_to_string_for_bytes(query_params):
                 query_string += "&"
             if key == "state":
                 query_string += value
+            elif key == "branch":
+                query_string += value
             else:
                 query_string += key + "=" + str(value)
         return query_string

requirements.txt

@@ -5,6 +5,6 @@ pytest-cov==2.8.1
 requests==2.26.0
 urllib3==1.26.5
 black==22.6.0
-typing-extensions==3.7.4.2
+typing-extensions==4.5.0
 mypy==0.770
 mypy-extensions==0.4.3

tests/test_builds.py

@@ -216,3 +216,31 @@ def test_rebuild_build(fake_client):
         builds.path_for_build_number.format("org_slug", "pipeline_id", "build_number")
         + "/rebuild"
     )
+
+
+def test_multi_branch(fake_client):
+    builds = Builds(fake_client, "https://api.buildkite.com/v2/")
+    builds.rebuild_build("org_slug", "pipeline_id", "build_number")
+
+    builds.list_all_for_pipeline(
+        organization="org",
+        pipeline="pipe",
+        branch=["main", "master"]
+    )
+
+    args = fake_client.get.call_args[0][1]
+    assert args["branch"] == "branch[]=main&branch[]=master"
+
+
+def test_single_branch(fake_client):
+    builds = Builds(fake_client, "https://api.buildkite.com/v2/")
+    builds.rebuild_build("org_slug", "pipeline_id", "build_number")
+
+    builds.list_all_for_pipeline(
+        organization="org",
+        pipeline="pipe",
+        branch="main"
+    )
+
+    args = fake_client.get.call_args[0][1]
+    assert args["branch"] == "branch=main"