openapi.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 openapi

import (
	"fmt"
	"strings"

	"github.com/go-openapi/spec"
	"github.com/golang/glog"

	"k8s.io/apimachinery/pkg/runtime/schema"
	"k8s.io/apimachinery/pkg/util/sets"
)

// groupVersionKindExtensionKey is the key used to lookup the GroupVersionKind value
// for an object definition from the definition's "extensions" map.
const groupVersionKindExtensionKey = "x-kubernetes-group-version-kind"

// Integer is the name for integer types
const Integer = "integer"

// String is the name for string types
const String = "string"

// Bool is the name for boolean types
const Boolean = "boolean"

// Map is the name for map types
// types.go struct fields that are maps will have an open API type "object"
// types.go struct fields that are actual objects appearing as a struct
// in a types.go file will have no type defined
// and have a json pointer reference to the type definition
const Map = "object"

// Array is the name for array types
const Array = "array"

// Resources contains the object definitions for Kubernetes resource apis
// Fields are public for binary serialization (private fields don't get serialized)
type Resources struct {
	// GroupVersionKindToName maps GroupVersionKinds to Type names
	GroupVersionKindToName map[schema.GroupVersionKind]string
	// NameToDefinition maps Type names to TypeDefinitions
	NameToDefinition map[string]Kind
}

// LookupResource returns the Kind for the specified groupVersionKind
func (r Resources) LookupResource(groupVersionKind schema.GroupVersionKind) (Kind, bool) {
	name, found := r.GroupVersionKindToName[groupVersionKind]
	if !found {
		return Kind{}, false
	}
	def, found := r.NameToDefinition[name]
	if !found {
		return Kind{}, false
	}
	return def, true
}

// Kind defines a Kubernetes object Kind
type Kind struct {
	// Name is the lookup key given to this Kind by the open API spec.
	// May not contain any semantic meaning or relation to the API definition,
	// simply must be unique for each object definition in the Open API spec.
	// e.g. io.k8s.kubernetes.pkg.apis.apps.v1beta1.Deployment
	Name string

	// IsResource is true if the Kind is a Resource (it has API endpoints)
	// e.g. Deployment is a Resource, DeploymentStatus is NOT a Resource
	IsResource bool

	// GroupVersionKind uniquely defines a resource type in the Kubernetes API
	// and is present for all resources.
	// Empty for non-resource Kinds (e.g. those without APIs).
	// e.g. "Group": "apps", "Version": "v1beta1", "Kind": "Deployment"
	GroupVersionKind schema.GroupVersionKind

	// Present only for definitions that represent primitive types with additional
	// semantic meaning beyond just string, integer, boolean - e.g.
	// Fields with a PrimitiveType should follow the validation of the primitive type.
	// io.k8s.apimachinery.pkg.apis.meta.v1.Time
	// io.k8s.apimachinery.pkg.util.intstr.IntOrString
	PrimitiveType string

	// Extensions are openapi extensions for the object definition.
	Extensions spec.Extensions

	// Fields are the fields defined for this Kind
	Fields map[string]Type
}

// Type defines a field type and are expected to be one of:
// - IsKind
// - IsMap
// - IsArray
// - IsPrimitive
type Type struct {
	// Name is the name of the type
	TypeName string

	// IsKind is true if the definition represents a Kind
	IsKind bool
	// IsPrimitive is true if the definition represents a primitive type - e.g. string, boolean, integer
	IsPrimitive bool
	// IsArray is true if the definition represents an array type
	IsArray bool
	// IsMap is true if the definition represents a map type
	IsMap bool

	// ElementType will be specified for arrays and maps
	// if IsMap == true, then ElementType is the type of the value (key is always string)
	// if IsArray == true, then ElementType is the type of the element
	ElementType *Type

	// Extensions are extensions for this field and may contain
	// metadata from the types.go struct field tags.
	// e.g. contains patchStrategy, patchMergeKey, etc
	Extensions spec.Extensions
}

// NewOpenAPIData parses the resource definitions in openapi data by groupversionkind and name
func NewOpenAPIData(s *spec.Swagger) (*Resources, error) {
	o := &Resources{
		GroupVersionKindToName: map[schema.GroupVersionKind]string{},
		NameToDefinition:       map[string]Kind{},
	}
	// Parse and index definitions by name
	for name, d := range s.Definitions {
		definition := o.parseDefinition(name, d)
		o.NameToDefinition[name] = definition
		if len(definition.GroupVersionKind.Kind) > 0 {
			o.GroupVersionKindToName[definition.GroupVersionKind] = name
		}
	}

	if err := o.validate(); err != nil {
		return nil, err
	}

	return o, nil
}

// validate makes sure the definition for each field type is found in the map
func (o *Resources) validate() error {
	types := sets.String{}
	for _, d := range o.NameToDefinition {
		for _, f := range d.Fields {
			for _, t := range o.getTypeNames(f) {
				types.Insert(t)
			}
		}
	}
	for _, n := range types.List() {
		_, found := o.NameToDefinition[n]
		if !found {
			return fmt.Errorf("Unable to find definition for field of type %v", n)
		}
	}
	return nil
}

func (o *Resources) getTypeNames(elem Type) []string {
	t := []string{}
	if elem.IsKind {
		t = append(t, elem.TypeName)
	}
	if elem.ElementType != nil && elem.ElementType.IsKind {
		t = append(t, o.getTypeNames(*elem.ElementType)...)
	}
	return t
}

func (o *Resources) parseDefinition(name string, s spec.Schema) Kind {
	gvk, err := o.getGroupVersionKind(s)
	value := Kind{
		Name:             name,
		GroupVersionKind: gvk,
		Extensions:       s.Extensions,
		Fields:           map[string]Type{},
	}
	if err != nil {
		glog.Warning(err)
	}

	// Definition represents a primitive type - e.g.
	// io.k8s.apimachinery.pkg.util.intstr.IntOrString
	if o.isPrimitive(s) {
		value.PrimitiveType = o.getTypeNameForField(s)
	}
	for fieldname, property := range s.Properties {
		value.Fields[fieldname] = o.parseField(property)
	}
	return value
}

func (o *Resources) parseField(s spec.Schema) Type {
	def := Type{
		TypeName:    o.getTypeNameForField(s),
		IsPrimitive: o.isPrimitive(s),
		IsArray:     o.isArray(s),
		IsMap:       o.isMap(s),
		IsKind:      o.isDefinitionReference(s),
	}

	if elementType, arrayErr := o.getElementType(s); arrayErr == nil {
		d := o.parseField(elementType)
		def.ElementType = &d
	} else if valueType, mapErr := o.getValueType(s); mapErr == nil {
		d := o.parseField(valueType)
		def.ElementType = &d
	}

	def.Extensions = s.Extensions

	return def
}

// isArray returns true if s is an array type.
func (o *Resources) isArray(s spec.Schema) bool {
	if len(s.Properties) > 0 {
		// Open API can have embedded type definitions, but Kubernetes doesn't generate these.
		// This should just be a sanity check against changing the format.
		return false
	}
	return o.getType(s) == Array
}

// isMap returns true if s is a map type.
func (o *Resources) isMap(s spec.Schema) bool {
	if len(s.Properties) > 0 {
		// Open API can have embedded type definitions, but Kubernetes doesn't generate these.
		// This should just be a sanity check against changing the format.
		return false
	}
	return o.getType(s) == Map
}

// isPrimitive returns true if s is a primitive type
// Note: For object references that represent primitive types - e.g. IntOrString - this will
// be false, and the referenced Kind will have a non-empty "PrimitiveType".
func (o *Resources) isPrimitive(s spec.Schema) bool {
	if len(s.Properties) > 0 {
		// Open API can have embedded type definitions, but Kubernetes doesn't generate these.
		// This should just be a sanity check against changing the format.
		return false
	}
	t := o.getType(s)
	if t == Integer || t == Boolean || t == String {
		return true
	}
	return false
}

func (*Resources) getType(s spec.Schema) string {
	if len(s.Type) != 1 {
		return ""
	}
	return strings.ToLower(s.Type[0])
}

func (o *Resources) getTypeNameForField(s spec.Schema) string {
	// Get the reference for complex types
	if o.isDefinitionReference(s) {
		return o.nameForDefinitionField(s)
	}
	// Recurse if type is array
	if o.isArray(s) {
		return fmt.Sprintf("%s array", o.getTypeNameForField(*s.Items.Schema))
	}
	if o.isMap(s) {
		return fmt.Sprintf("%s map", o.getTypeNameForField(*s.AdditionalProperties.Schema))
	}

	// Get the value for primitive types
	if o.isPrimitive(s) {
		return fmt.Sprintf("%s", s.Type[0])
	}
	return ""
}

// isDefinitionReference returns true s is a complex type that should have a Kind.
func (o *Resources) isDefinitionReference(s spec.Schema) bool {
	if len(s.Properties) > 0 {
		// Open API can have embedded type definitions, but Kubernetes doesn't generate these.
		// This should just be a sanity check against changing the format.
		return false
	}
	if len(s.Type) > 0 {
		// Definition references won't have a type
		return false
	}

	p := s.SchemaProps.Ref.GetPointer().String()
	return len(p) > 0 && strings.HasPrefix(p, "/definitions/")
}

// getElementType returns the type of an element for arrays
// returns an error if s is not an array.
func (o *Resources) getElementType(s spec.Schema) (spec.Schema, error) {
	if !o.isArray(s) {
		return spec.Schema{}, fmt.Errorf("%v is not an array type", s.Type)
	}
	return *s.Items.Schema, nil
}

// getElementType returns the type of an element for maps
// returns an error if s is not a map.
func (o *Resources) getValueType(s spec.Schema) (spec.Schema, error) {
	if !o.isMap(s) {
		return spec.Schema{}, fmt.Errorf("%v is not an map type", s.Type)
	}
	return *s.AdditionalProperties.Schema, nil
}

// nameForDefinitionField returns the definition name for the schema (field) if it is a complex type
func (o *Resources) nameForDefinitionField(s spec.Schema) string {
	p := s.SchemaProps.Ref.GetPointer().String()
	if len(p) == 0 {
		return ""
	}

	// Strip the "definitions/" pieces of the reference
	return strings.Replace(p, "/definitions/", "", -1)
}

// getGroupVersionKind implements OpenAPIData
// getGVK parses the gropuversionkind for a resource definition from the x-kubernetes
// extensions
// Expected format for s.Extensions: map[string][]map[string]string
// map[x-kubernetes-group-version-kind:[map[Group:authentication.k8s.io Version:v1 Kind:TokenReview]]]
func (o *Resources) getGroupVersionKind(s spec.Schema) (schema.GroupVersionKind, error) {
	empty := schema.GroupVersionKind{}

	// Get the extensions
	extList, f := s.Extensions[groupVersionKindExtensionKey]
	if !f {
		return empty, fmt.Errorf("No %s extension present in %v", groupVersionKindExtensionKey, s.Extensions)
	}

	// Expect a empty of a list with 1 element
	extListCasted, ok := extList.([]interface{})
	if !ok {
		return empty, fmt.Errorf("%s extension has unexpected type %T in %s", groupVersionKindExtensionKey, extListCasted, s.Extensions)
	}
	if len(extListCasted) == 0 {
		return empty, fmt.Errorf("No Group Version Kind found in %v", extListCasted)
	}
	if len(extListCasted) != 1 {
		return empty, fmt.Errorf("Multiple Group Version gvkToName found in %v", extListCasted)
	}
	gvk := extListCasted[0]

	// Expect a empty of a map with 3 entries
	gvkMap, ok := gvk.(map[string]interface{})
	if !ok {
		return empty, fmt.Errorf("%s extension has unexpected type %T in %s", groupVersionKindExtensionKey, gvk, s.Extensions)
	}
	group, ok := gvkMap["Group"].(string)
	if !ok {
		return empty, fmt.Errorf("%s extension missing Group: %v", groupVersionKindExtensionKey, gvkMap)
	}
	version, ok := gvkMap["Version"].(string)
	if !ok {
		return empty, fmt.Errorf("%s extension missing Version: %v", groupVersionKindExtensionKey, gvkMap)
	}
	kind, ok := gvkMap["Kind"].(string)
	if !ok {
		return empty, fmt.Errorf("%s extension missing Kind: %v", groupVersionKindExtensionKey, gvkMap)
	}

	return schema.GroupVersionKind{
		Group:   group,
		Version: version,
		Kind:    kind,
	}, nil
}