Handle Service Instances in SM client (#742)

* rm internal/ from gitignore * Add Operation struct * Add ServiceInstance struct * ServiceInstances path const * Change the field name in collections of SM objects to Items * GET Service Instances * GET Service Instance by ID * Add SI, Error structs for SM responses * POST Service Instance * Refactor http response body reading * DELETE Service Instance * PATCH Service Instance * GET Service Instance params * Add fake SI JSONs for tests * GET Service Instances test * GET Service Instance by ID test * POST Service Instance test * Refactor SM client unit test to use typed structs instead of generic maps * PATCH Service Instance test * DELETE Service Instance by ID test
kyma-project · Jun 28, 2024 · 9e3ef78 · 9e3ef78
1 parent fd39848
commit 9e3ef78
Show file tree

Hide file tree

Showing 10 changed files with 1,053 additions and 100 deletions.
diff --git a/.gitignore b/.gitignore
@@ -221,7 +221,6 @@ scripts/run.bat
 scripts/**/*.js
 scripts/**/*.js.map
 coverage/
-internal/
 **/.DS_Store
 .settings
 **/.vs

diff --git a/internal/api/vm/converters.go b/internal/api/vm/converters.go
@@ -22,11 +22,11 @@ func ToSecretVM(list v1.SecretList) Secrets {
 
 func ToServiceOfferingsVM(offerings *types.ServiceOfferings) ServiceOfferings {
 	toReturn := ServiceOfferings{
-		NumItems: len(offerings.ServiceOfferings),
+		NumItems: len(offerings.Items),
 		Items:    []ServiceOffering{},
 	}
 
-	for _, offering := range offerings.ServiceOfferings {
+	for _, offering := range offerings.Items {
 		imageUrl, _ := offering.MetadataValueByFieldName(types.ServiceOfferingImageUrl)
 		displayName, _ := offering.MetadataValueByFieldName(types.ServiceOfferingDisplayName)
 		supportUrl, _ := offering.MetadataValueByFieldName(types.ServiceOfferingSupportURL)
@@ -55,7 +55,7 @@ func ToServiceOfferingDetailsVM(details *types.ServiceOfferingDetails) ServiceOf
 
 	toReturn.LongDescription, _ = details.MetadataValueByFieldName(types.ServiceOfferingLongDescription)
 
-	for _, plan := range details.ServicePlans.ServicePlans {
+	for _, plan := range details.ServicePlans.Items {
 		toReturn.Plans = append(toReturn.Plans, ServiceOfferingPlan{
 			Name:        plan.Name,
 			Description: plan.Description,

diff --git a/internal/service-manager/client.go b/internal/service-manager/client.go
@@ -1,6 +1,7 @@
 package servicemanager
 
 import (
+	"bytes"
 	"context"
 	"fmt"
 	"io"
@@ -19,11 +20,13 @@ import (
 )
 
 const (
-	componentName        = "ServiceManagerClient"
-	defaultSecret        = "sap-btp-service-operator"
-	defaultNamespace     = "kyma-system"
+	componentName    = "ServiceManagerClient"
+	defaultSecret    = "sap-btp-service-operator"
+	defaultNamespace = "kyma-system"
+
 	ServiceOfferingsPath = "/v1/service_offerings"
 	ServicePlansPath     = "/v1/service_plans"
+	ServiceInstancesPath = "/v1/service_instances"
 
 	// see https://help.sap.com/docs/service-manager/sap-service-manager/filtering-parameters-and-operators
 	URLFieldQueryKey                          = "fieldQuery"
@@ -152,8 +155,7 @@ func (c *Client) ServiceOfferings() (*types.ServiceOfferings, error) {
 		return nil, err
 	}
 
-	defer resp.Body.Close()
-	body, err := io.ReadAll(resp.Body)
+	body, err := c.readResponseBody(resp.Body)
 	if err != nil {
 		return nil, err
 	}
@@ -195,8 +197,7 @@ func (c *Client) serviceOfferingByID(serviceOfferingID string) (*types.ServiceOf
 		return nil, err
 	}
 
-	defer resp.Body.Close()
-	body, err := io.ReadAll(resp.Body)
+	body, err := c.readResponseBody(resp.Body)
 	if err != nil {
 		return nil, err
 	}
@@ -224,8 +225,7 @@ func (c *Client) servicePlansForServiceOffering(serviceOfferingID string) (*type
 		return nil, err
 	}
 
-	defer resp.Body.Close()
-	body, err := io.ReadAll(resp.Body)
+	body, err := c.readResponseBody(resp.Body)
 	if err != nil {
 		return nil, err
 	}
@@ -237,3 +237,207 @@ func (c *Client) servicePlansForServiceOffering(serviceOfferingID string) (*type
 
 	return &plans, nil
 }
+
+func (c *Client) ServiceInstances() (*types.ServiceInstances, error) {
+	req, err := http.NewRequest(http.MethodGet, c.smURL+ServiceInstancesPath, nil)
+	if err != nil {
+		return nil, err
+	}
+	req.Header.Add("Content-Type", "application/json")
+
+	resp, err := c.httpClient.Do(req)
+	if err != nil {
+		return nil, err
+	}
+
+	body, err := c.readResponseBody(resp.Body)
+	if err != nil {
+		return nil, err
+	}
+	var serviceInstances types.ServiceInstances
+	if err := json.Unmarshal(body, &serviceInstances); err != nil {
+		return nil, err
+	}
+
+	return &serviceInstances, nil
+}
+
+func (c *Client) ServiceInstance(serviceInstanceID string) (*types.ServiceInstance, error) {
+	req, err := http.NewRequest(http.MethodGet, c.smURL+ServiceInstancesPath+"/"+serviceInstanceID, nil)
+	if err != nil {
+		return nil, err
+	}
+	req.Header.Add("Content-Type", "application/json")
+
+	resp, err := c.httpClient.Do(req)
+	if err != nil {
+		return nil, err
+	}
+
+	switch resp.StatusCode {
+	case http.StatusOK:
+		return c.serviceInstanceResponse(resp)
+	default:
+		return nil, c.errorResponse(resp)
+	}
+
+}
+
+func (c *Client) ServiceInstanceParameters(serviceInstanceID string) (map[string]string, error) {
+	req, err := http.NewRequest(http.MethodGet, c.smURL+ServiceInstancesPath+"/"+serviceInstanceID+"/parameters", nil)
+	if err != nil {
+		return nil, err
+	}
+	req.Header.Add("Content-Type", "application/json")
+
+	resp, err := c.httpClient.Do(req)
+	if err != nil {
+		return nil, err
+	}
+
+	switch resp.StatusCode {
+	case http.StatusOK:
+		return c.serviceInstanceParamsResponse(resp)
+	default:
+		return nil, c.errorResponse(resp)
+	}
+}
+
+func (c *Client) CreateServiceInstance(si *types.ServiceInstance) (*types.ServiceInstance, error) {
+	requestBody, err := json.Marshal(si)
+	if err != nil {
+		return nil, err
+	}
+
+	req, err := http.NewRequest(http.MethodPost, c.smURL+ServiceInstancesPath, bytes.NewBuffer(requestBody))
+	if err != nil {
+		return nil, err
+	}
+	req.Header.Add("Content-Type", "application/json")
+
+	resp, err := c.httpClient.Do(req)
+	if err != nil {
+		return nil, err
+	}
+
+	switch resp.StatusCode {
+	case http.StatusCreated:
+		return c.serviceInstanceResponse(resp)
+	case http.StatusAccepted:
+		return nil, nil
+	default:
+		return nil, c.errorResponse(resp)
+	}
+}
+
+func (c *Client) DeleteServiceInstance(serviceInstanceID string) error {
+	req, err := http.NewRequest(http.MethodDelete, c.smURL+ServiceInstancesPath+"/"+serviceInstanceID, nil)
+	if err != nil {
+		return err
+	}
+
+	resp, err := c.httpClient.Do(req)
+	if err != nil {
+		return err
+	}
+
+	switch resp.StatusCode {
+	case http.StatusOK:
+		fallthrough
+	case http.StatusAccepted:
+		return nil
+	default:
+		return c.errorResponse(resp)
+	}
+}
+
+func (c *Client) serviceInstanceResponse(resp *http.Response) (*types.ServiceInstance, error) {
+	body, err := c.readResponseBody(resp.Body)
+	if err != nil {
+		return nil, err
+	}
+
+	var siResp types.ServiceInstance
+	if err := json.Unmarshal(body, &siResp); err != nil {
+		return nil, err
+	}
+
+	return &siResp, nil
+}
+
+func (c *Client) serviceInstanceParamsResponse(resp *http.Response) (map[string]string, error) {
+	body, err := c.readResponseBody(resp.Body)
+	if err != nil {
+		return nil, err
+	}
+
+	var params map[string]string
+	if err := json.Unmarshal(body, params); err != nil {
+		return nil, err
+	}
+
+	return params, nil
+}
+
+func (c *Client) UpdateServiceInstance(si *types.ServiceInstanceUpdateRequest) (*types.ServiceInstance, error) {
+	id := *si.ID
+	si.ID = nil
+
+	if !c.validServiceInstanceUpdateRequestBody(si) {
+		return nil, fmt.Errorf("invalid request body - share fields must be updated alone")
+	}
+
+	requestBody, err := json.Marshal(si)
+	if err != nil {
+		return nil, err
+	}
+
+	req, err := http.NewRequest(http.MethodPatch, c.smURL+ServiceInstancesPath+"/"+id, bytes.NewBuffer(requestBody))
+	if err != nil {
+		return nil, err
+	}
+
+	resp, err := c.httpClient.Do(req)
+	if err != nil {
+		return nil, err
+	}
+
+	switch resp.StatusCode {
+	case http.StatusOK:
+		return c.serviceInstanceResponse(resp)
+	case http.StatusAccepted:
+		return nil, nil
+	default:
+		return nil, c.errorResponse(resp)
+	}
+}
+
+func (c *Client) errorResponse(resp *http.Response) error {
+	body, err := c.readResponseBody(resp.Body)
+	if err != nil {
+		return err
+	}
+
+	var errResp types.ErrorResponse
+	if err := json.Unmarshal(body, &errResp); err != nil {
+		return err
+	}
+
+	return fmt.Errorf("error: %s", errResp.Error())
+}
+
+func (c *Client) readResponseBody(respBody io.ReadCloser) ([]byte, error) {
+	defer respBody.Close()
+	bodyInBytes, err := io.ReadAll(respBody)
+	if err != nil {
+		return nil, err
+	}
+	return bodyInBytes, nil
+}
+
+func (c *Client) validServiceInstanceUpdateRequestBody(si *types.ServiceInstanceUpdateRequest) bool {
+	if si.Shared != nil {
+		return si.ID == nil && si.Name == nil && si.ServicePlanID == nil && si.Parameters == nil && len(si.Labels) == 0
+	}
+	return true
+}