Fix list branch query (#316)

* fix: uses correct approach for query params

* refactor: slight corrections

* feat: add tests for ListBranches

* docs: updates method description

* feat: improves test

Author: kuzminT

.gitignore

@@ -1 +1,3 @@
 vendor
+.idea
+.env

repository.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"io"
 	"io/ioutil"
 	"net/url"
 	"path"
@@ -440,11 +441,17 @@ func (r *Repository) ListRefs(rbo *RepositoryRefOptions) (*RepositoryRefs, error
 	return decodeRepositoryRefs(bodyString)
 }
 
+// ListBranches gets all branches in the Bitbucket repository and returns them as a RepositoryBranches.
+// You can pass query parameter to filter branches by name.
+//
+// Bitbucket API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-refs/#api-repositories-workspace-repo-slug-refs-get
 func (r *Repository) ListBranches(rbo *RepositoryBranchOptions) (*RepositoryBranches, error) {
-
 	params := url.Values{}
+
 	if rbo.Query != "" {
-		params.Add("q", rbo.Query)
+		// https://developer.atlassian.com/cloud/bitbucket/rest/intro/#operators
+		query := fmt.Sprintf("name ~ \"%s\"", rbo.Query)
+		params.Set("q", query)
 	}
 
 	if rbo.Sort != "" {
@@ -468,12 +475,12 @@ func (r *Repository) ListBranches(rbo *RepositoryBranchOptions) (*RepositoryBran
 	if err != nil {
 		return nil, err
 	}
-	bodyBytes, err := ioutil.ReadAll(response)
+	bodyBytes, err := io.ReadAll(response)
 	if err != nil {
 		return nil, err
 	}
-	bodyString := string(bodyBytes)
-	return decodeRepositoryBranches(bodyString)
+
+	return decodeRepositoryBranches(string(bodyBytes))
 }
 
 func (r *Repository) GetBranch(rbo *RepositoryBranchOptions) (*RepositoryBranch, error) {

tests/repository_test.go

@@ -737,3 +737,25 @@ func TestSetRepositoryUserPermissions(t *testing.T) {
 	}
 
 }
+
+func TestListBranches(t *testing.T) {
+	client := setup(t)
+
+	opts := &bitbucket.RepositoryBranchOptions{
+		Owner:    owner,
+		RepoSlug: repo,
+		Pagelen:  10,
+		Query:    "develop",
+	}
+
+	response, err := client.Repositories.Repository.ListBranches(opts)
+	if err != nil {
+		t.Fatalf("ListBranches() returned an error: %v", err)
+	}
+	if response == nil {
+		t.Fatal("Cannot get list branches")
+	}
+	if response.Size == 0 {
+		t.Fatalf("Expected to find at least one branch for query '%s', but found none", opts.Query)
+	}
+}