deprovision_instance_test.go

/*
Copyright 2019 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v2

import (
	"fmt"
	"net/http"
	"testing"
)

func defaultDeprovisionRequest() *DeprovisionRequest {
	return &DeprovisionRequest{
		InstanceID: testInstanceID,
		ServiceID:  testServiceID,
		PlanID:     testPlanID,
	}
}

func defaultAsyncDeprovisionRequest() *DeprovisionRequest {
	r := defaultDeprovisionRequest()
	r.AcceptsIncomplete = true
	return r
}

const successDeprovisionResponseBody = `{}`

func successDeprovisionResponse() *DeprovisionResponse {
	return &DeprovisionResponse{}
}

const successAsyncDeprovisionResponseBody = `{
  "operation": "test-operation-key"
}`

func successDeprovisionResponseAsync() *DeprovisionResponse {
	r := successDeprovisionResponse()
	r.Async = true
	r.OperationKey = &testOperation
	return r
}

func TestDeprovisionInstance(t *testing.T) {
	cases := []struct {
		name                string
		version             APIVersion
		enableAlpha         bool
		originatingIdentity *OriginatingIdentity
		request             *DeprovisionRequest
		httpChecks          httpChecks
		httpReaction        httpReaction
		expectedResponse    *DeprovisionResponse
		expectedErrMessage  string
		expectedErr         error
	}{
		{
			name: "invalid request",
			request: func() *DeprovisionRequest {
				r := defaultDeprovisionRequest()
				r.InstanceID = ""
				return r
			}(),
			expectedErrMessage: "instanceID is required",
		},
		{
			name: "success - ok",
			httpReaction: httpReaction{
				status: http.StatusOK,
				body:   successDeprovisionResponseBody,
			},
			httpChecks: httpChecks{
				params: map[string]string{
					VarKeyServiceID: string(testServiceID),
					VarKeyPlanID:    string(testPlanID),
				},
			},
			expectedResponse: successDeprovisionResponse(),
		},
		{
			name: "success - gone",
			httpReaction: httpReaction{
				status: http.StatusGone,
				body:   successDeprovisionResponseBody,
			},
			expectedResponse: successDeprovisionResponse(),
		},
		{
			name:    "success - async",
			request: defaultAsyncDeprovisionRequest(),
			httpChecks: httpChecks{
				params: map[string]string{
					AcceptsIncomplete: "true",
				},
			},
			httpReaction: httpReaction{
				status: http.StatusAccepted,
				body:   successAsyncDeprovisionResponseBody,
			},
			expectedResponse: successDeprovisionResponseAsync(),
		},
		{
			name:    "accepted with malformed response",
			request: defaultAsyncDeprovisionRequest(),
			httpChecks: httpChecks{
				params: map[string]string{
					AcceptsIncomplete: "true",
				},
			},
			httpReaction: httpReaction{
				status: http.StatusAccepted,
				body:   malformedResponse,
			},
			expectedErrMessage: "unexpected end of JSON input",
		},
		{
			name: "http error",
			httpReaction: httpReaction{
				err: fmt.Errorf("http error"),
			},
			expectedErrMessage: "http error",
		},
		{
			name: "202 with no async support",
			httpReaction: httpReaction{
				status: http.StatusAccepted,
				body:   successAsyncDeprovisionResponseBody,
			},
			expectedErrMessage: "Status: 202; ErrorMessage: <nil>; Description: <nil>; ResponseError: <nil>",
		},
		{
			name: "200 with malformed response",
			httpReaction: httpReaction{
				status: http.StatusOK,
				body:   malformedResponse,
			},
			expectedResponse: successDeprovisionResponse(),
		},
		{
			name: "500 with malformed response",
			httpReaction: httpReaction{
				status: http.StatusInternalServerError,
				body:   malformedResponse,
			},
			expectedErrMessage: "Status: 500; ErrorMessage: <nil>; Description: <nil>; ResponseError: unexpected end of JSON input",
		},
		{
			name: "500 with conventional failure response",
			httpReaction: httpReaction{
				status: http.StatusInternalServerError,
				body:   conventionalFailureResponseBody,
			},
			expectedErr: testHTTPStatusCodeError(),
		},
		{
			name:                "originating identity included",
			version:             Version2_13(),
			originatingIdentity: testOriginatingIdentity,
			httpReaction: httpReaction{
				status: http.StatusOK,
				body:   successDeprovisionResponseBody,
			},
			httpChecks: httpChecks{
				headers: map[string]string{OriginatingIdentityHeader: testOriginatingIdentityHeaderValue},
				params: map[string]string{
					VarKeyServiceID: string(testServiceID),
					VarKeyPlanID:    string(testPlanID),
				},
			},
			expectedResponse: successDeprovisionResponse(),
		},
		{
			name:                "originating identity excluded",
			version:             Version2_13(),
			originatingIdentity: nil,
			httpReaction: httpReaction{
				status: http.StatusOK,
				body:   successDeprovisionResponseBody,
			},
			httpChecks: httpChecks{
				headers: map[string]string{OriginatingIdentityHeader: ""},
				params: map[string]string{
					VarKeyServiceID: string(testServiceID),
					VarKeyPlanID:    string(testPlanID),
				},
			},
			expectedResponse: successDeprovisionResponse(),
		},
		{
			name:                "originating identity not sent unless API version >= 2.13",
			version:             Version2_12(),
			originatingIdentity: testOriginatingIdentity,
			httpReaction: httpReaction{
				status: http.StatusOK,
				body:   successDeprovisionResponseBody,
			},
			httpChecks: httpChecks{
				headers: map[string]string{OriginatingIdentityHeader: ""},
				params: map[string]string{
					VarKeyServiceID: string(testServiceID),
					VarKeyPlanID:    string(testPlanID),
				},
			},
			expectedResponse: successDeprovisionResponse(),
		},
	}

	for _, tc := range cases {
		if tc.request == nil {
			tc.request = defaultDeprovisionRequest()
		}

		tc.request.OriginatingIdentity = tc.originatingIdentity

		if tc.httpChecks.URL == "" {
			tc.httpChecks.URL = "/v2/service_instances/test-instance-id"
		}

		if tc.version.label == "" {
			tc.version = Version2_11()
		}

		klient := newTestClient(t, tc.name, tc.version, tc.enableAlpha, tc.httpChecks, tc.httpReaction)

		response, err := klient.DeprovisionInstance(tc.request)

		doResponseChecks(t, tc.name, response, err, tc.expectedResponse, tc.expectedErrMessage, tc.expectedErr)
	}
}

func TestValidateDeprovisionRequest(t *testing.T) {
	cases := []struct {
		name    string
		request *DeprovisionRequest
		valid   bool
	}{
		{
			name:    "valid",
			request: defaultDeprovisionRequest(),
			valid:   true,
		},
		{
			name: "missing instance ID",
			request: func() *DeprovisionRequest {
				r := defaultDeprovisionRequest()
				r.InstanceID = ""
				return r
			}(),
			valid: false,
		},
		{
			name: "missing service ID",
			request: func() *DeprovisionRequest {
				r := defaultDeprovisionRequest()
				r.ServiceID = ""
				return r
			}(),
			valid: false,
		},
		{
			name: "missing plan ID",
			request: func() *DeprovisionRequest {
				r := defaultDeprovisionRequest()
				r.PlanID = ""
				return r
			}(),
			valid: false,
		},
	}

	for _, tc := range cases {
		err := validateDeprovisionRequest(tc.request)
		if err != nil {
			if tc.valid {
				t.Errorf("%v: expected valid, got error: %v", tc.name, err)
			}
		} else if !tc.valid {
			t.Errorf("%v: expected invalid, got valid", tc.name)
		}
	}
}