broker.go

/*
Copyright 2016 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 validation

import (
	apivalidation "k8s.io/apimachinery/pkg/api/validation"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/util/validation/field"

	sc "github.com/kubernetes-incubator/service-catalog/pkg/apis/servicecatalog"
)

// ValidateClusterServiceBrokerName is the validation function for Broker names.
var ValidateClusterServiceBrokerName = apivalidation.NameIsDNSSubdomain

// ValidateClusterServiceBroker implements the validation rules for a BrokerResource.
func ValidateClusterServiceBroker(broker *sc.ClusterServiceBroker) field.ErrorList {
	allErrs := field.ErrorList{}

	allErrs = append(allErrs,
		apivalidation.ValidateObjectMeta(&broker.ObjectMeta,
			false, /* namespace required */
			ValidateClusterServiceBrokerName,
			field.NewPath("metadata"))...)

	allErrs = append(allErrs, validateClusterServiceBrokerSpec(&broker.Spec, field.NewPath("spec"))...)
	return allErrs
}

func validateClusterServiceBrokerSpec(spec *sc.ClusterServiceBrokerSpec, fldPath *field.Path) field.ErrorList {
	allErrs := field.ErrorList{}

	if "" == spec.URL {
		allErrs = append(allErrs,
			field.Required(fldPath.Child("url"),
				"brokers must have a remote url to contact"))
	}

	// if there is auth information, check it to make sure that it's properly formatted
	if spec.AuthInfo != nil {
		if spec.AuthInfo.Basic != nil {
			secretRef := spec.AuthInfo.Basic.SecretRef
			if secretRef != nil {
				for _, msg := range apivalidation.ValidateNamespaceName(secretRef.Namespace, false /* prefix */) {
					allErrs = append(allErrs, field.Invalid(fldPath.Child("authInfo", "basic", "secretRef", "namespace"), secretRef.Namespace, msg))
				}
				for _, msg := range apivalidation.NameIsDNSSubdomain(secretRef.Name, false /* prefix */) {
					allErrs = append(allErrs, field.Invalid(fldPath.Child("authInfo", "basic", "secretRef", "name"), secretRef.Name, msg))
				}
			} else {
				allErrs = append(
					allErrs,
					field.Required(fldPath.Child("authInfo", "basic", "secretRef"), "a basic auth secret is required"),
				)
			}
		} else if spec.AuthInfo.Bearer != nil {
			secretRef := spec.AuthInfo.Bearer.SecretRef
			if secretRef != nil {
				for _, msg := range apivalidation.ValidateNamespaceName(secretRef.Namespace, false /* prefix */) {
					allErrs = append(allErrs, field.Invalid(fldPath.Child("authInfo", "bearer", "secretRef", "namespace"), secretRef.Namespace, msg))
				}
				for _, msg := range apivalidation.NameIsDNSSubdomain(secretRef.Name, false /* prefix */) {
					allErrs = append(allErrs, field.Invalid(fldPath.Child("authInfo", "bearer", "secretRef", "name"), secretRef.Name, msg))
				}
			} else {
				allErrs = append(
					allErrs,
					field.Required(fldPath.Child("authInfo", "bearer", "secretRef"), "a basic auth secret is required"),
				)
			}
		} else {
			// Authentication
			allErrs = append(
				allErrs,
				field.Required(fldPath.Child("authInfo"), "auth config is required"),
			)
		}
	}

	if spec.InsecureSkipTLSVerify && len(spec.CABundle) > 0 {
		allErrs = append(allErrs, field.Invalid(fldPath.Child("caBundle"), spec.CABundle, "caBundle cannot be used when insecureSkipTLSVerify is true"))
	}

	if "" == spec.RelistBehavior {
		allErrs = append(allErrs,
			field.Required(fldPath.Child("relistBehavior"),
				"relist behavior is required"))
	}

	isValidRelistBehavior := spec.RelistBehavior == sc.ServiceBrokerRelistBehaviorDuration ||
		spec.RelistBehavior == sc.ServiceBrokerRelistBehaviorManual
	if !isValidRelistBehavior {
		errMsg := "relist behavior must be \"Manual\" or \"Duration\""
		allErrs = append(
			allErrs,
			field.Required(fldPath.Child("relistBehavior"), errMsg),
		)
	}

	if spec.RelistBehavior == sc.ServiceBrokerRelistBehaviorDuration && spec.RelistDuration == nil {
		allErrs = append(
			allErrs,
			field.Required(fldPath.Child("relistDuration"), "relistDuration must be set if relistBehavior is set to Duration"),
		)
	}

	if spec.RelistBehavior == sc.ServiceBrokerRelistBehaviorManual && spec.RelistDuration != nil {
		allErrs = append(
			allErrs,
			field.Required(fldPath.Child("relistDuration"), "relistDuration must not be set if relistBehavior is set to Manual"),
		)
	}

	if spec.RelistRequests < 0 {
		allErrs = append(
			allErrs,
			field.Required(fldPath.Child("relistRequests"), "relistRequests must be greater than zero"),
		)
	}

	if spec.RelistDuration != nil {
		zeroDuration := metav1.Duration{Duration: 0}
		if spec.RelistDuration.Duration <= zeroDuration.Duration {
			allErrs = append(
				allErrs,
				field.Required(fldPath.Child("relistDuration"), "relistDuration must be greater than zero"),
			)
		}
	}

	return allErrs
}

// ValidateClusterServiceBrokerUpdate checks that when changing from an older broker to a newer broker is okay ?
func ValidateClusterServiceBrokerUpdate(new *sc.ClusterServiceBroker, old *sc.ClusterServiceBroker) field.ErrorList {
	allErrs := field.ErrorList{}
	allErrs = append(allErrs, ValidateClusterServiceBroker(new)...)
	return allErrs
}

// ValidateClusterServiceBrokerStatusUpdate checks that when changing from an older broker to a newer broker is okay.
func ValidateClusterServiceBrokerStatusUpdate(new *sc.ClusterServiceBroker, old *sc.ClusterServiceBroker) field.ErrorList {
	allErrs := field.ErrorList{}
	allErrs = append(allErrs, ValidateClusterServiceBrokerUpdate(new, old)...)
	return allErrs
}