validate.go

/*
Copyright 2017 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 registrytest

import (
	"fmt"

	"k8s.io/apiserver/pkg/registry/generic/registry"
	"k8s.io/apiserver/pkg/registry/rest"
	"k8s.io/kubernetes/pkg/util/slice"
)

// ValidateStorageStrategies ensures any instances of the generic registry.Store in the given storage map
// have expected strategies defined.
func ValidateStorageStrategies(storageMap map[string]rest.Storage, exceptions StrategyExceptions) []error {
	errs := []error{}

	// Used to ensure we saw all the expected exceptions:
	hasExportExceptionsSeen := []string{}

	for k, storage := range storageMap {
		switch t := storage.(type) {
		case registry.GenericStore:
			// At this point it appears all uses of the generic registry store should have a create, update, and
			// delete strategy set:
			if t.GetCreateStrategy() == nil {
				errs = append(errs, fmt.Errorf("store for type [%v] does not have a CreateStrategy", k))
			}
			if t.GetUpdateStrategy() == nil {
				errs = append(errs, fmt.Errorf("store for type [%v] does not have an UpdateStrategy", k))
			}
			if t.GetDeleteStrategy() == nil {
				errs = append(errs, fmt.Errorf("store for type [%v] does not have a DeleteStrategy", k))
			}

			// Check that ExportStrategy is set if applicable:
			if slice.ContainsString(exceptions.HasExportStrategy, k, nil) {
				hasExportExceptionsSeen = append(hasExportExceptionsSeen, k)
				if t.GetExportStrategy() == nil {
					errs = append(errs, fmt.Errorf("store for type [%v] does not have an ExportStrategy", k))
				}
			} else {
				// By default we expect Stores to not have additional export logic:
				if t.GetExportStrategy() != nil {
					errs = append(errs, fmt.Errorf("store for type [%v] has an unexpected ExportStrategy", k))
				}
			}

		}
	}

	// Ensure that we saw all our expected exceptions:
	for _, expKey := range exceptions.HasExportStrategy {
		if !slice.ContainsString(hasExportExceptionsSeen, expKey, nil) {
			errs = append(errs, fmt.Errorf("no generic store seen for expected ExportStrategy: %v", expKey))
		}
	}

	return errs
}

// StrategyExceptions carries information on what exceptions to default strategy expectations are expected.
type StrategyExceptions struct {
	// HasExportStrategy is a list of the resource keys whose store should have a custom export strategy.
	HasExportStrategy []string
}