[AV-62009] Code Health - Pass in Success Codes to Client

examples/user/create_user.tf

@@ -8,9 +8,7 @@ resource "capella_user" "new_user" {
   name  = var.user_name
   email = var.email
 
-  organization_roles = [
-    "organizationMember"
-  ]
+  organization_roles = var.organization_roles
 
   resources = [
     {

examples/user/variables.tf

@@ -22,3 +22,8 @@ variable "user_name" {
 variable "email" {
   description = "Capella Email Address"
 }
+
+variable "organization_roles" {
+  description = "Capella Organization Roles"
+  type = list(string)
+}

internal/api/client.go

@@ -31,9 +31,27 @@ type Response struct {
 	Body     []byte
 }
 
+// RequestCfg is used to encapsulate request details to endpoints
+type EndpointCfg struct {
+	// Url is url of the endpoint to be contacted
+	Url string
+
+	// Method is the HTTP method to be requested.
+	Method string
+
+	// SuccessStatus represents the HTTP status code associated
+	// with a successful response from the endpoint.
+	SuccessStatus int
+}
+
 // Execute is used to construct and execute a HTTP request.
 // It then returns the response.
-func (c *Client) Execute(url string, method string, payload any, authToken string, headers map[string]string) (response *Response, err error) {
+func (c *Client) Execute(
+	endpointCfg EndpointCfg,
+	payload any,
+	authToken string,
+	headers map[string]string,
+) (response *Response, err error) {
 	var requestBody []byte
 	if payload != nil {
 		requestBody, err = json.Marshal(payload)
@@ -42,7 +60,7 @@ func (c *Client) Execute(url string, method string, payload any, authToken strin
 		}
 	}
 
-	req, err := http.NewRequest(method, url, bytes.NewReader(requestBody))
+	req, err := http.NewRequest(endpointCfg.Method, endpointCfg.Url, bytes.NewReader(requestBody))
 	if err != nil {
 		return nil, fmt.Errorf("%s: %v", errors.ErrConstructingRequest, err)
 	}
@@ -63,10 +81,12 @@ func (c *Client) Execute(url string, method string, payload any, authToken strin
 		return
 	}
 
-	if apiRes.StatusCode >= http.StatusBadRequest {
+	if apiRes.StatusCode != endpointCfg.SuccessStatus {
 		var apiError Error
 		if err := json.Unmarshal(responseBody, &apiError); err != nil {
-			return nil, fmt.Errorf("status: %d, body: %s", apiRes.StatusCode, responseBody)
+			return nil, fmt.Errorf(
+				"unexpected code: %d, expected: %d, body: %s",
+				apiRes.StatusCode, endpointCfg.SuccessStatus, responseBody)
 		}
 		return nil, apiError
 	}

internal/api/pagination.go

@@ -66,13 +66,14 @@ func GetPaginated[DataSchema ~[]T, T any](
 	ctx context.Context,
 	client *Client,
 	token string,
-	url string,
+	cfg EndpointCfg,
 	sortBy sortParameter,
 ) (DataSchema, error) {
 	var (
 		responses DataSchema
 		page      = 1
 		perPage   = 10
+		baseUrl   = cfg.Url
 	)
 
 	type overlay struct {
@@ -81,12 +82,11 @@ func GetPaginated[DataSchema ~[]T, T any](
 	}
 
 	for {
-		// construct pagination parameters
-		pageParams := fmt.Sprintf("?page=%d&perPage=%d&sortBy=%s", page, perPage, string(sortBy))
+		cfg.Url = baseUrl + fmt.Sprintf("?page=%d&perPage=%d&sortBy=%s", page, perPage, string(sortBy))
+		cfg.Method = http.MethodGet
 
 		response, err := client.Execute(
-			url+pageParams,
-			http.MethodGet,
+			cfg,
 			nil,
 			token,
 			nil,

internal/datasources/allowlists.go

@@ -138,7 +138,8 @@ func (d *AllowLists) listAllowLists(ctx context.Context, organizationId, project
 		clusterId,
 	)
 
-	return api.GetPaginated[[]api.GetAllowListResponse](ctx, d.Client, d.Token, url, api.SortById)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
+	return api.GetPaginated[[]api.GetAllowListResponse](ctx, d.Client, d.Token, cfg, api.SortById)
 }
 
 // Configure adds the provider configured client to the allowlist data source.

internal/datasources/apikeys.go

@@ -3,6 +3,7 @@ package datasources
 import (
 	"context"
 	"fmt"
+	"net/http"
 
 	"terraform-provider-capella/internal/api"
 	providerschema "terraform-provider-capella/internal/schema"
@@ -86,7 +87,9 @@ func (d *ApiKeys) Read(ctx context.Context, req datasource.ReadRequest, resp *da
 	}
 
 	url := fmt.Sprintf("%s/v4/organizations/%s/apikeys", d.HostURL, organizationId)
-	response, err := api.GetPaginated[[]api.GetApiKeyResponse](ctx, d.Client, d.Token, url, api.SortByName)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
+
+	response, err := api.GetPaginated[[]api.GetApiKeyResponse](ctx, d.Client, d.Token, cfg, api.SortByName)
 	switch err := err.(type) {
 	case nil:
 	case api.Error:

internal/datasources/appservices.go

@@ -2,10 +2,9 @@ package datasources
 
 import (
 	"context"
-	"encoding/json"
 	"fmt"
 	"net/http"
-	"terraform-provider-capella/internal/api/appservice"
+	appservice "terraform-provider-capella/internal/api/appservice"
 
 	"terraform-provider-capella/internal/api"
 	"terraform-provider-capella/internal/errors"
@@ -62,13 +61,10 @@ func (d *AppServices) Read(ctx context.Context, req datasource.ReadRequest, resp
 		organizationId = state.OrganizationId.ValueString()
 	)
 
-	response, err := d.Client.Execute(
-		fmt.Sprintf("%s/v4/organizations/%s/appservices", d.HostURL, organizationId),
-		http.MethodGet,
-		nil,
-		d.Token,
-		nil,
-	)
+	url := fmt.Sprintf("%s/v4/organizations/%s/appservices", d.HostURL, organizationId)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
+
+	response, err := api.GetPaginated[[]appservice.GetAppServiceResponse](ctx, d.Client, d.Token, cfg, api.SortById)
 	switch err := err.(type) {
 	case nil:
 	case api.Error:
@@ -85,17 +81,7 @@ func (d *AppServices) Read(ctx context.Context, req datasource.ReadRequest, resp
 		return
 	}
 
-	appServicesResp := appservice.GetAppServicesResponse{}
-	err = json.Unmarshal(response.Body, &appServicesResp)
-	if err != nil {
-		resp.Diagnostics.AddError(
-			"Error reading app services",
-			"Could not read app services, unexpected error: "+err.Error(),
-		)
-		return
-	}
-
-	for _, appService := range appServicesResp.Data {
+	for _, appService := range response {
 		audit := providerschema.NewCouchbaseAuditData(appService.Audit)
 
 		auditObj, diags := types.ObjectValueFrom(ctx, audit.AttributeTypes(), audit)

internal/datasources/buckets.go

@@ -3,6 +3,7 @@ package datasources
 import (
 	"context"
 	"fmt"
+	"net/http"
 	"terraform-provider-capella/internal/api/bucket"
 
 	"terraform-provider-capella/internal/api"
@@ -146,7 +147,9 @@ func (d *Buckets) Read(ctx context.Context, req datasource.ReadRequest, resp *da
 	}
 
 	url := fmt.Sprintf("%s/v4/organizations/%s/projects/%s/clusters/%s/buckets", d.HostURL, organizationId, projectId, clusterId)
-	response, err := api.GetPaginated[[]bucket.GetBucketResponse](ctx, d.Client, d.Token, url, api.SortById)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
+
+	response, err := api.GetPaginated[[]bucket.GetBucketResponse](ctx, d.Client, d.Token, cfg, api.SortById)
 	switch err := err.(type) {
 	case nil:
 	case api.Error:

internal/datasources/certificate.go

@@ -80,9 +80,10 @@ func (c *Certificate) Read(ctx context.Context, req datasource.ReadRequest, resp
 		clusterId      = state.ClusterId.ValueString()
 	)
 
+	url := fmt.Sprintf("%s/v4/organizations/%s/projects/%s/clusters/%s/certificates", c.HostURL, organizationId, projectId, clusterId)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
 	response, err := c.Client.Execute(
-		fmt.Sprintf("%s/v4/organizations/%s/projects/%s/clusters/%s/certificates", c.HostURL, organizationId, projectId, clusterId),
-		http.MethodGet,
+		cfg,
 		nil,
 		c.Token,
 		nil,

internal/datasources/clusters.go

@@ -3,6 +3,7 @@ package datasources
 import (
 	"context"
 	"fmt"
+	"net/http"
 
 	"terraform-provider-capella/internal/api"
 	clusterapi "terraform-provider-capella/internal/api/cluster"
@@ -50,16 +51,16 @@ func (d *Clusters) Read(ctx context.Context, req datasource.ReadRequest, resp *d
 
 	if state.OrganizationId.IsNull() {
 		resp.Diagnostics.AddError(
-			"Error creating cluster",
-			"Could not create cluster, unexpected error: organization ID cannot be empty.",
+			"Error reading cluster",
+			"Could not read cluster, unexpected error: organization ID cannot be empty.",
 		)
 		return
 	}
 
 	if state.ProjectId.IsNull() {
 		resp.Diagnostics.AddError(
-			"Error creating cluster",
-			"Could not create cluster, unexpected error: project ID cannot be empty.",
+			"Error reading cluster",
+			"Could not read cluster, unexpected error: project ID cannot be empty.",
 		)
 		return
 	}
@@ -70,7 +71,9 @@ func (d *Clusters) Read(ctx context.Context, req datasource.ReadRequest, resp *d
 	)
 
 	url := fmt.Sprintf("%s/v4/organizations/%s/projects/%s/clusters", d.HostURL, organizationId, projectId)
-	response, err := api.GetPaginated[[]clusterapi.GetClusterResponse](ctx, d.Client, d.Token, url, api.SortById)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
+
+	response, err := api.GetPaginated[[]clusterapi.GetClusterResponse](ctx, d.Client, d.Token, cfg, api.SortById)
 	switch err := err.(type) {
 	case nil:
 	case api.Error:

internal/datasources/database_credentials.go

@@ -3,6 +3,7 @@ package datasources
 import (
 	"context"
 	"fmt"
+	"net/http"
 
 	"terraform-provider-capella/internal/api"
 	providerschema "terraform-provider-capella/internal/schema"
@@ -113,7 +114,9 @@ func (d *DatabaseCredentials) Read(ctx context.Context, req datasource.ReadReque
 	}
 
 	url := fmt.Sprintf("%s/v4/organizations/%s/projects/%s/clusters/%s/users", d.HostURL, organizationId, projectId, clusterId)
-	response, err := api.GetPaginated[[]api.GetDatabaseCredentialResponse](ctx, d.Client, d.Token, url, api.SortById)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
+
+	response, err := api.GetPaginated[[]api.GetDatabaseCredentialResponse](ctx, d.Client, d.Token, cfg, api.SortById)
 	switch err := err.(type) {
 	case nil:
 	case api.Error:

internal/datasources/organization.go

@@ -70,9 +70,10 @@ func (o *Organization) Read(ctx context.Context, req datasource.ReadRequest, res
 	var organizationId = state.OrganizationId.ValueString()
 
 	// Make request to get organization
+	url := fmt.Sprintf("%s/v4/organizations/%s", o.HostURL, organizationId)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
 	response, err := o.Client.Execute(
-		fmt.Sprintf("%s/v4/organizations/%s", o.HostURL, organizationId),
-		http.MethodGet,
+		cfg,
 		nil,
 		o.Token,
 		nil,

internal/datasources/projects.go

@@ -3,6 +3,7 @@ package datasources
 import (
 	"context"
 	"fmt"
+	"net/http"
 
 	"terraform-provider-capella/internal/api"
 	providerschema "terraform-provider-capella/internal/schema"
@@ -76,7 +77,9 @@ func (d *Projects) Read(ctx context.Context, req datasource.ReadRequest, resp *d
 	var organizationId = state.OrganizationId.ValueString()
 
 	url := fmt.Sprintf("%s/v4/organizations/%s/projects", d.HostURL, organizationId)
-	response, err := api.GetPaginated[[]api.GetProjectResponse](ctx, d.Client, d.Token, url, api.SortById)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
+
+	response, err := api.GetPaginated[[]api.GetProjectResponse](ctx, d.Client, d.Token, cfg, api.SortById)
 	switch err := err.(type) {
 	case nil:
 	case api.Error:

internal/datasources/users.go

@@ -97,7 +97,9 @@ func (d *Users) Read(ctx context.Context, req datasource.ReadRequest, resp *data
 
 	// Make request to list Users
 	url := fmt.Sprintf("%s/v4/organizations/%s/users", d.HostURL, organizationId)
-	response, err := api.GetPaginated[[]api.GetUserResponse](ctx, d.Client, d.Token, url, api.SortById)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
+
+	response, err := api.GetPaginated[[]api.GetUserResponse](ctx, d.Client, d.Token, cfg, api.SortById)
 	switch err := err.(type) {
 	case nil:
 	case api.Error:

internal/resources/allowlist.go

@@ -74,15 +74,16 @@ func (r *AllowList) Create(ctx context.Context, req resource.CreateRequest, resp
 		ExpiresAt: plan.ExpiresAt.ValueString(),
 	}
 
+	url := fmt.Sprintf(
+		"%s/v4/organizations/%s/projects/%s/clusters/%s/allowedcidrs",
+		r.HostURL,
+		plan.OrganizationId.ValueString(),
+		plan.ProjectId.ValueString(),
+		plan.ClusterId.ValueString(),
+	)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodPost, SuccessStatus: http.StatusCreated}
 	response, err := r.Client.Execute(
-		fmt.Sprintf(
-			"%s/v4/organizations/%s/projects/%s/clusters/%s/allowedcidrs",
-			r.HostURL,
-			plan.OrganizationId.ValueString(),
-			plan.ProjectId.ValueString(),
-			plan.ClusterId.ValueString(),
-		),
-		http.MethodPost,
+		cfg,
 		allowListRequest,
 		r.Token,
 		nil,
@@ -227,16 +228,17 @@ func (r *AllowList) Delete(ctx context.Context, req resource.DeleteRequest, resp
 		allowListID    = IDs[providerschema.Id]
 	)
 	// Execute request to delete existing allowlist
+	url := fmt.Sprintf(
+		"%s/v4/organizations/%s/projects/%s/clusters/%s/allowedcidrs/%s",
+		r.HostURL,
+		organizationId,
+		projectId,
+		clusterId,
+		allowListID,
+	)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodDelete, SuccessStatus: http.StatusNoContent}
 	_, err = r.Client.Execute(
-		fmt.Sprintf(
-			"%s/v4/organizations/%s/projects/%s/clusters/%s/allowedcidrs/%s",
-			r.HostURL,
-			organizationId,
-			projectId,
-			clusterId,
-			allowListID,
-		),
-		http.MethodDelete,
+		cfg,
 		nil,
 		r.Token,
 		nil,
@@ -274,16 +276,17 @@ func (r *AllowList) ImportState(ctx context.Context, req resource.ImportStateReq
 
 // getAllowList is used to retrieve an existing allow list
 func (r *AllowList) getAllowList(ctx context.Context, organizationId, projectId, clusterId, allowListId string) (*api.GetAllowListResponse, error) {
+	url := fmt.Sprintf(
+		"%s/v4/organizations/%s/projects/%s/clusters/%s/allowedcidrs/%s",
+		r.HostURL,
+		organizationId,
+		projectId,
+		clusterId,
+		allowListId,
+	)
+	cfg := api.EndpointCfg{Url: url, Method: http.MethodGet, SuccessStatus: http.StatusOK}
 	response, err := r.Client.Execute(
-		fmt.Sprintf(
-			"%s/v4/organizations/%s/projects/%s/clusters/%s/allowedcidrs/%s",
-			r.HostURL,
-			organizationId,
-			projectId,
-			clusterId,
-			allowListId,
-		),
-		http.MethodGet,
+		cfg,
 		nil,
 		r.Token,
 		nil,