provision_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"
)

const (
	testInstanceID       = "test-instance-id"
	testServiceID        = "test-service-id"
	testPlanID           = "test-plan-id"
	testOrganizationGUID = "test-organization-guid"
	testSpaceGUID        = "test-space-guid"
)

func defaultProvisionRequest() *ProvisionRequest {
	return &ProvisionRequest{
		InstanceID:       testInstanceID,
		ServiceID:        testServiceID,
		PlanID:           testPlanID,
		OrganizationGUID: testOrganizationGUID,
		SpaceGUID:        testSpaceGUID,
	}
}

func defaultAsyncProvisionRequest() *ProvisionRequest {
	r := defaultProvisionRequest()
	r.AcceptsIncomplete = true
	return r
}

const successProvisionRequestBody = `{"service_id":"test-service-id","plan_id":"test-plan-id","organization_guid":"test-organization-guid","space_guid":"test-space-guid"}`

const successProvisionResponseBody = `{
  "dashboard_url": "https://example.com/dashboard"
}`

var testDashboardURL = "https://example.com/dashboard"
var testOperation OperationKey = "test-operation-key"

func successProvisionResponse() *ProvisionResponse {
	return &ProvisionResponse{
		DashboardURL: &testDashboardURL,
	}
}

const successAsyncProvisionResponseBody = `{
  "dashboard_url": "https://example.com/dashboard",
  "operation": "test-operation-key"
}`

func successProvisionResponseAsync() *ProvisionResponse {
	r := successProvisionResponse()
	r.Async = true
	r.OperationKey = &testOperation
	return r
}

const contextProvisionRequestBody = `{"service_id":"test-service-id","plan_id":"test-plan-id","organization_guid":"test-organization-guid","space_guid":"test-space-guid","context":{"foo":"bar"}}`

func TestProvisionInstance(t *testing.T) {
	cases := []struct {
		name                string
		version             APIVersion
		enableAlpha         bool
		originatingIdentity *OriginatingIdentity
		request             *ProvisionRequest
		httpChecks          httpChecks
		httpReaction        httpReaction
		expectedResponse    *ProvisionResponse
		expectedErrMessage  string
		expectedErr         error
	}{
		{
			name: "invalid request",
			request: func() *ProvisionRequest {
				r := defaultProvisionRequest()
				r.InstanceID = ""
				return r
			}(),
			expectedErrMessage: "instanceID is required",
		},
		{
			name: "success - created",
			httpReaction: httpReaction{
				status: http.StatusCreated,
				body:   successProvisionResponseBody,
			},
			expectedResponse: successProvisionResponse(),
		},
		{
			name: "success - ok",
			httpReaction: httpReaction{
				status: http.StatusOK,
				body:   successProvisionResponseBody,
			},
			expectedResponse: successProvisionResponse(),
		},
		{
			name:    "success - asynchronous",
			request: defaultAsyncProvisionRequest(),
			httpChecks: httpChecks{
				params: map[string]string{
					AcceptsIncomplete: "true",
				},
			},
			httpReaction: httpReaction{
				status: http.StatusAccepted,
				body:   successAsyncProvisionResponseBody,
			},
			expectedResponse: successProvisionResponseAsync(),
		},
		{
			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:   successAsyncProvisionResponseBody,
			},
			expectedErrMessage: "Status: 202; ErrorMessage: <nil>; Description: <nil>; ResponseError: <nil>",
		},
		{
			name: "200 with malformed response",
			httpReaction: httpReaction{
				status: http.StatusOK,
				body:   malformedResponse,
			},
			expectedErrMessage: "Status: 200; ErrorMessage: <nil>; Description: <nil>; ResponseError: unexpected end of JSON input",
		},
		{
			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:    "context - 2.12",
			version: Version2_12(),
			request: func() *ProvisionRequest {
				r := defaultProvisionRequest()
				r.Context = map[string]interface{}{
					"foo": "bar",
				}
				return r
			}(),
			httpChecks: httpChecks{
				body: contextProvisionRequestBody,
			},
			httpReaction: httpReaction{
				status: http.StatusCreated,
				body:   successProvisionResponseBody,
			},
			expectedResponse: successProvisionResponse(),
		},
		{
			name: "context - 2.11",
			request: func() *ProvisionRequest {
				r := defaultProvisionRequest()
				r.Context = map[string]interface{}{
					"foo": "bar",
				}
				return r
			}(),
			httpChecks: httpChecks{
				body: successProvisionRequestBody,
			},
			httpReaction: httpReaction{
				status: http.StatusCreated,
				body:   successProvisionResponseBody,
			},
			expectedResponse: successProvisionResponse(),
		},
		{
			name:                "originating identity included",
			version:             Version2_13(),
			originatingIdentity: testOriginatingIdentity,
			httpChecks:          httpChecks{headers: map[string]string{OriginatingIdentityHeader: testOriginatingIdentityHeaderValue}},
			httpReaction: httpReaction{
				status: http.StatusCreated,
				body:   successProvisionResponseBody,
			},
			expectedResponse: successProvisionResponse(),
		},
		{
			name:                "originating identity excluded",
			version:             Version2_13(),
			originatingIdentity: nil,
			httpChecks:          httpChecks{headers: map[string]string{OriginatingIdentityHeader: ""}},
			httpReaction: httpReaction{
				status: http.StatusCreated,
				body:   successProvisionResponseBody,
			},
			expectedResponse: successProvisionResponse(),
		},
		{
			name:                "originating identity not sent unless API version >= 2.13",
			version:             Version2_12(),
			originatingIdentity: testOriginatingIdentity,
			httpChecks:          httpChecks{headers: map[string]string{OriginatingIdentityHeader: ""}},
			httpReaction: httpReaction{
				status: http.StatusCreated,
				body:   successProvisionResponseBody,
			},
			expectedResponse: successProvisionResponse(),
		},
	}

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

		tc.request.OriginatingIdentity = tc.originatingIdentity

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

		if tc.httpChecks.body == "" {
			tc.httpChecks.body = successProvisionRequestBody
		}

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

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

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

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

func TestValidateProvisionRequest(t *testing.T) {
	cases := []struct {
		name    string
		request *ProvisionRequest
		valid   bool
	}{
		{
			name:    "valid",
			request: defaultProvisionRequest(),
			valid:   true,
		},
		{
			name: "missing instance ID",
			request: func() *ProvisionRequest {
				r := defaultProvisionRequest()
				r.InstanceID = ""
				return r
			}(),
			valid: false,
		},
		{
			name: "missing service ID",
			request: func() *ProvisionRequest {
				r := defaultProvisionRequest()
				r.ServiceID = ""
				return r
			}(),
			valid: false,
		},
		{
			name: "missing plan ID",
			request: func() *ProvisionRequest {
				r := defaultProvisionRequest()
				r.PlanID = ""
				return r
			}(),
			valid: false,
		},
		{
			name: "missing organization GUID",
			request: func() *ProvisionRequest {
				r := defaultProvisionRequest()
				r.OrganizationGUID = ""
				return r
			}(),
			valid: false,
		},
		{
			name: "missing space GUID",
			request: func() *ProvisionRequest {
				r := defaultProvisionRequest()
				r.SpaceGUID = ""
				return r
			}(),
			valid: false,
		},
	}

	for _, tc := range cases {
		err := validateProvisionRequest(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)
		}
	}
}