Merge pull request #83 from planetscale/iheanyi/add-promote-branch

Add `Promote` function to `DatabaseBranches`

Author: iheanyi

Diff for: planetscale/branches.go

@@ -14,6 +14,7 @@ type DatabaseBranch struct {
 	Name         string    `json:"name"`
 	ParentBranch string    `json:"parent_branch"`
 	Region       Region    `json:"region"`
+	Production   bool      `json:"production"`
 	CreatedAt    time.Time `json:"created_at"`
 	UpdatedAt    time.Time `json:"updated_at"`
 	Status       string    `json:"status,omitempty"`
@@ -86,6 +87,14 @@ type RefreshSchemaRequest struct {
 	Branch       string `json:"-"`
 }
 
+// PromoteBranchRequest encapsulates the request for promoting a branch to
+// production.
+type PromoteBranchRequest struct {
+	Organization string `json:"-"`
+	Database     string `json:"-"`
+	Branch       string `json:"branch"`
+}
+
 // DatabaseBranchesService is an interface for communicating with the PlanetScale
 // Database Branch API endpoint.
 type DatabaseBranchesService interface {
@@ -97,6 +106,7 @@ type DatabaseBranchesService interface {
 	Diff(context.Context, *DiffBranchRequest) ([]*Diff, error)
 	Schema(context.Context, *BranchSchemaRequest) ([]*Diff, error)
 	RefreshSchema(context.Context, *RefreshSchemaRequest) error
+	Promote(context.Context, *PromoteBranchRequest) (*DatabaseBranch, error)
 }
 
 type databaseBranchesService struct {
@@ -243,6 +253,24 @@ func (d *databaseBranchesService) RefreshSchema(ctx context.Context, refreshReq
 	return nil
 }
 
+// PromoteBranch promotes a database's branch from a development branch to a
+// production branch.
+func (d *databaseBranchesService) Promote(ctx context.Context, promoteReq *PromoteBranchRequest) (*DatabaseBranch, error) {
+	path := fmt.Sprintf("%s/%s/promote-branch", databasesAPIPath(promoteReq.Organization), promoteReq.Database)
+	req, err := d.client.newRequest(http.MethodPost, path, promoteReq)
+	if err != nil {
+		return nil, errors.Wrap(err, "error creating request for branch promotion")
+	}
+
+	branch := &DatabaseBranch{}
+	err = d.client.do(ctx, req, &branch)
+	if err != nil {
+		return nil, err
+	}
+
+	return branch, nil
+}
+
 func databaseBranchesAPIPath(org, db string) string {
 	return fmt.Sprintf("%s/%s/branches", databasesAPIPath(org), db)
 }

Diff for: planetscale/branches_test.go

@@ -2,6 +2,7 @@ package planetscale
 
 import (
 	"context"
+	"encoding/json"
 	"net/http"
 	"net/http/httptest"
 	"testing"
@@ -259,3 +260,45 @@ func TestBranches_RefreshSchema(t *testing.T) {
 	})
 	c.Assert(err, qt.IsNil)
 }
+
+func TestBranches_Promote(t *testing.T) {
+	c := qt.New(t)
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		c.Assert(http.MethodPost, qt.Equals, r.Method)
+		w.WriteHeader(200)
+
+		payload := make(map[string]interface{})
+		decoder := json.NewDecoder(r.Body)
+		err := decoder.Decode(&payload)
+		c.Assert(err, qt.IsNil)
+
+		c.Assert(payload["branch"], qt.Equals, "planetscale-go-test-db-branch")
+
+		out := `{"id":"planetscale-go-test-db-branch","type":"database_branch","name":"planetscale-go-test-db-branch","created_at":"2021-01-14T10:19:23.000Z","updated_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()
+	org := "my-org"
+	name := "planetscale-go-test-db"
+
+	db, err := client.DatabaseBranches.Promote(ctx, &PromoteBranchRequest{
+		Organization: org,
+		Database:     name,
+		Branch:       "planetscale-go-test-db-branch",
+	})
+
+	want := &DatabaseBranch{
+		Name:      testBranch,
+		CreatedAt: time.Date(2021, time.January, 14, 10, 19, 23, 000, time.UTC),
+		UpdatedAt: time.Date(2021, time.January, 14, 10, 19, 23, 000, time.UTC),
+	}
+
+	c.Assert(err, qt.IsNil)
+	c.Assert(db, qt.DeepEquals, want)
+}