Add ListClusterSizeSKUs to branches (#234)

* Add ListClusterSizeSKUs to database branches service

* Remove unused include rates attribute

Author: iheanyi

planetscale/branches.go

@@ -178,6 +178,14 @@ type DatabaseBranchesService interface {
 	EnableSafeMigrations(context.Context, *EnableSafeMigrationsRequest) (*DatabaseBranch, error)
 	DisableSafeMigrations(context.Context, *DisableSafeMigrationsRequest) (*DatabaseBranch, error)
 	LintSchema(context.Context, *LintSchemaRequest) ([]*SchemaLintError, error)
+	ListClusterSKUs(context.Context, *ListBranchClusterSKUsRequest, ...ListOption) ([]*ClusterSKU, error)
+}
+
+// ListBranchClusterSKUsRequest encapsulates the request for getting a list of Cluster SKUs for an organization.
+type ListBranchClusterSKUsRequest struct {
+	Organization string
+	Database     string
+	Branch       string
 }
 
 type databaseBranchesService struct {
@@ -439,6 +447,31 @@ func (d *databaseBranchesService) LintSchema(ctx context.Context, lintReq *LintS
 	return lintResp.Errors, nil
 }
 
+func (o *databaseBranchesService) ListClusterSKUs(ctx context.Context, listReq *ListBranchClusterSKUsRequest, opts ...ListOption) ([]*ClusterSKU, error) {
+	path := fmt.Sprintf("%s/cluster-size-skus", databaseBranchAPIPath(listReq.Organization, listReq.Database, listReq.Branch))
+
+	defaultOpts := defaultListOptions()
+	for _, opt := range opts {
+		opt(defaultOpts)
+	}
+
+	if vals := defaultOpts.URLValues.Encode(); vals != "" {
+		path += "?" + vals
+	}
+
+	req, err := o.client.newRequest(http.MethodGet, path, nil)
+	if err != nil {
+		return nil, errors.Wrap(err, "error creating http request")
+	}
+
+	clusterSKUs := []*ClusterSKU{}
+	if err := o.client.do(ctx, req, &clusterSKUs); err != nil {
+		return nil, err
+	}
+
+	return clusterSKUs, nil
+}
+
 func databaseBranchesAPIPath(org, db string) string {
 	return fmt.Sprintf("%s/%s/branches", databasesAPIPath(org), db)
 }

planetscale/branches_test.go

@@ -37,7 +37,7 @@ func TestDatabaseBranches_Create(t *testing.T) {
 	})
 
 	want := &DatabaseBranch{
-		ID: "planetscale-go-test-db-branch",
+		ID:   "planetscale-go-test-db-branch",
 		Name: testBranch,
 		Region: Region{
 			Slug: "us-west",
@@ -439,3 +439,120 @@ func TestDatabaseBranches_LintSchema(t *testing.T) {
 
 	c.Assert(lintErr, qt.DeepEquals, want)
 }
+
+func TestDatabaseBranches_ListClusterSKUs(t *testing.T) {
+	c := qt.New(t)
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(200)
+
+		c.Assert(r.URL.String(), qt.Equals, "/v1/organizations/my-cool-org/databases/my-cool-db/branches/main/cluster-size-skus")
+		out := `[
+		{
+			"name": "PS_10",
+			"type": "ClusterSizeSku",
+			"display_name": "PS-10",
+			"cpu": "1/8",
+			"provider_instance_type": null,
+			"storage": null,
+			"ram": "1",
+			"enabled": true,
+			"provider": null,
+			"rate": null,
+			"replica_rate": null,
+			"default_vtgate": "VTG_5",
+			"default_vtgate_rate": null,
+			"sort_order": 1
+		}
+	]`
+
+		_, err := w.Write([]byte(out))
+		c.Assert(err, qt.IsNil)
+	}))
+
+	client, err := NewClient(WithBaseURL(ts.URL))
+	c.Assert(err, qt.IsNil)
+
+	ctx := context.Background()
+
+	orgs, err := client.DatabaseBranches.ListClusterSKUs(ctx, &ListBranchClusterSKUsRequest{
+		Organization: "my-cool-org",
+		Database:     "my-cool-db",
+		Branch:       "main",
+	})
+
+	c.Assert(err, qt.IsNil)
+	want := []*ClusterSKU{
+		{
+			Name:          "PS_10",
+			DisplayName:   "PS-10",
+			CPU:           "1/8",
+			Memory:        1,
+			Enabled:       true,
+			DefaultVTGate: "VTG_5",
+			SortOrder:     1,
+		},
+	}
+
+	c.Assert(orgs, qt.DeepEquals, want)
+}
+
+func TestDatabaseBranches_ListClusterSKUsWithRates(t *testing.T) {
+	c := qt.New(t)
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(200)
+
+		c.Assert(r.URL.String(), qt.Equals, "/v1/organizations/my-cool-org/databases/my-cool-db/branches/main/cluster-size-skus?rates=true")
+		out := `[
+		{
+			"name": "PS_10",
+			"type": "ClusterSizeSku",
+			"display_name": "PS-10",
+			"cpu": "1/8",
+			"provider_instance_type": null,
+			"storage": "100",
+			"ram": "1",
+			"sort_order": 1,
+			"enabled": true,
+			"provider": null,
+			"rate": 39,
+			"replica_rate": 13,
+			"default_vtgate": "VTG_5",
+			"default_vtgate_rate": null
+		}
+	]`
+
+		_, err := w.Write([]byte(out))
+		c.Assert(err, qt.IsNil)
+	}))
+
+	client, err := NewClient(WithBaseURL(ts.URL))
+	c.Assert(err, qt.IsNil)
+
+	ctx := context.Background()
+
+	orgs, err := client.DatabaseBranches.ListClusterSKUs(ctx, &ListBranchClusterSKUsRequest{
+		Organization: "my-cool-org",
+		Database:     "my-cool-db",
+		Branch:       "main",
+	}, WithRates())
+
+	c.Assert(err, qt.IsNil)
+	want := []*ClusterSKU{
+		{
+			Name:          "PS_10",
+			DisplayName:   "PS-10",
+			CPU:           "1/8",
+			Memory:        1,
+			Enabled:       true,
+			Storage:       Pointer[int64](100),
+			Rate:          Pointer[int64](39),
+			ReplicaRate:   Pointer[int64](13),
+			DefaultVTGate: "VTG_5",
+			SortOrder:     1,
+		},
+	}
+
+	c.Assert(orgs, qt.DeepEquals, want)
+}

planetscale/organizations.go

@@ -35,7 +35,6 @@ type ListOrganizationRegionsRequest struct {
 // ListOrganizationClusterSKUsRequest encapsulates the request for getting a list of Cluster SKUs for an organization.
 type ListOrganizationClusterSKUsRequest struct {
 	Organization string
-	IncludeRates bool
 }
 
 // ClusterSKU represents a SKU for a PlanetScale cluster