Merge pull request #170 from planetscale/improve-dr-list

Add ability to list deploy requests by state, branch & into_branch

Author: mscoutermarsh

planetscale/deploy_requests.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"net/http"
+	"net/url"
 	"time"
 
 	"github.com/pkg/errors"
@@ -63,6 +64,9 @@ type GetDeployRequestRequest struct {
 type ListDeployRequestsRequest struct {
 	Organization string
 	Database     string
+	State        string
+	Branch       string
+	IntoBranch   string
 }
 
 // DeployOperation encapsulates a deploy operation within a deployment from the
@@ -427,7 +431,24 @@ func (d *deployRequestsService) Diff(ctx context.Context, diffReq *DiffRequest)
 }
 
 func (d *deployRequestsService) List(ctx context.Context, listReq *ListDeployRequestsRequest) ([]*DeployRequest, error) {
-	req, err := d.client.newRequest(http.MethodGet, deployRequestsAPIPath(listReq.Organization, listReq.Database), nil)
+	baseURL := deployRequestsAPIPath(listReq.Organization, listReq.Database)
+
+	queryParams := url.Values{}
+	if listReq.State != "" {
+		queryParams.Set("state", listReq.State)
+	}
+	if listReq.Branch != "" {
+		queryParams.Set("branch", listReq.Branch)
+	}
+	if listReq.IntoBranch != "" {
+		queryParams.Set("into_branch", listReq.IntoBranch)
+	}
+
+	if len(queryParams) > 0 {
+		baseURL += "?" + queryParams.Encode()
+	}
+
+	req, err := d.client.newRequest(http.MethodGet, baseURL, nil)
 	if err != nil {
 		return nil, errors.Wrap(err, "error creating http request")
 	}

planetscale/deploy_requests_test.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"net/http"
 	"net/http/httptest"
+	"net/url"
 	"testing"
 	"time"
 
@@ -283,6 +284,56 @@ func TestDeployRequests_List(t *testing.T) {
 	c.Assert(requests, qt.DeepEquals, want)
 }
 
+func TestDeployRequests_ListQueryParams(t *testing.T) {
+	c := qt.New(t)
+
+	var receivedQueryParams url.Values
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		receivedQueryParams = r.URL.Query()
+
+		w.WriteHeader(200)
+		out := `{"data": [{"id": "test-deploy-request-id", "branch": "development", "into_branch": "some-branch", "notes": "", "created_at": "2021-01-14T10:19:23.000Z", "updated_at": "2021-01-14T10:19:23.000Z", "closed_at": "2021-01-14T10:19:23.000Z"}]}`
+		_, err := w.Write([]byte(out))
+		c.Assert(err, qt.IsNil)
+	}))
+
+	client, err := NewClient(WithBaseURL(ts.URL))
+	c.Assert(err, qt.IsNil)
+
+	ctx := context.Background()
+
+	requests, err := client.DeployRequests.List(ctx, &ListDeployRequestsRequest{
+		Organization: testOrg,
+		Database:     testDatabase,
+		State:        "closed",
+		Branch:       "dev",
+		IntoBranch:   "main",
+	})
+
+	testTime := time.Date(2021, time.January, 14, 10, 19, 23, 0, time.UTC)
+
+	want := []*DeployRequest{
+		{
+			ID:         "test-deploy-request-id",
+			Branch:     "development",
+			IntoBranch: "some-branch",
+			Notes:      "",
+			CreatedAt:  testTime,
+			UpdatedAt:  testTime,
+			ClosedAt:   &testTime,
+		},
+	}
+
+	c.Assert(err, qt.IsNil)
+	c.Assert(requests, qt.DeepEquals, want)
+
+	// Assert the expected query parameters
+	c.Assert(receivedQueryParams.Get("state"), qt.Equals, "closed")
+	c.Assert(receivedQueryParams.Get("branch"), qt.Equals, "dev")
+	c.Assert(receivedQueryParams.Get("into_branch"), qt.Equals, "main")
+}
+
 func TestDeployRequests_SkipRevertDeploy(t *testing.T) {
 	c := qt.New(t)