123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250 |
- /*
- 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 schemaconv
- import (
- "errors"
- "fmt"
- "path"
- "strings"
- "k8s.io/kube-openapi/pkg/util/proto"
- "sigs.k8s.io/structured-merge-diff/schema"
- )
- // ToSchema converts openapi definitions into a schema suitable for structured
- // merge (i.e. kubectl apply v2).
- func ToSchema(models proto.Models) (*schema.Schema, error) {
- c := convert{
- input: models,
- output: &schema.Schema{},
- }
- if err := c.convertAll(); err != nil {
- return nil, err
- }
- return c.output, nil
- }
- type convert struct {
- input proto.Models
- output *schema.Schema
- currentName string
- current *schema.Atom
- errorMessages []string
- }
- func (c *convert) push(name string, a *schema.Atom) *convert {
- return &convert{
- input: c.input,
- output: c.output,
- currentName: name,
- current: a,
- }
- }
- func (c *convert) top() *schema.Atom { return c.current }
- func (c *convert) pop(c2 *convert) {
- c.errorMessages = append(c.errorMessages, c2.errorMessages...)
- }
- func (c *convert) convertAll() error {
- for _, name := range c.input.ListModels() {
- model := c.input.LookupModel(name)
- c.insertTypeDef(name, model)
- }
- if len(c.errorMessages) > 0 {
- return errors.New(strings.Join(c.errorMessages, "\n"))
- }
- return nil
- }
- func (c *convert) reportError(format string, args ...interface{}) {
- c.errorMessages = append(c.errorMessages,
- c.currentName+": "+fmt.Sprintf(format, args...),
- )
- }
- func (c *convert) insertTypeDef(name string, model proto.Schema) {
- def := schema.TypeDef{
- Name: name,
- }
- c2 := c.push(name, &def.Atom)
- model.Accept(c2)
- c.pop(c2)
- if def.Atom == (schema.Atom{}) {
- // This could happen if there were a top-level reference.
- return
- }
- c.output.Types = append(c.output.Types, def)
- }
- func (c *convert) makeRef(model proto.Schema) schema.TypeRef {
- var tr schema.TypeRef
- if r, ok := model.(*proto.Ref); ok {
- if r.Reference() == "io.k8s.apimachinery.pkg.runtime.RawExtension" {
- return schema.TypeRef{
- Inlined: schema.Atom{
- Untyped: &schema.Untyped{},
- },
- }
- }
- // reference a named type
- _, n := path.Split(r.Reference())
- tr.NamedType = &n
- } else {
- // compute the type inline
- c2 := c.push("inlined in "+c.currentName, &tr.Inlined)
- model.Accept(c2)
- c.pop(c2)
- if tr == (schema.TypeRef{}) {
- // emit warning?
- tr.Inlined.Untyped = &schema.Untyped{}
- }
- }
- return tr
- }
- func (c *convert) VisitKind(k *proto.Kind) {
- a := c.top()
- a.Struct = &schema.Struct{}
- for _, name := range k.FieldOrder {
- member := k.Fields[name]
- tr := c.makeRef(member)
- a.Struct.Fields = append(a.Struct.Fields, schema.StructField{
- Name: name,
- Type: tr,
- })
- }
- // TODO: Get element relationship when we start adding it to the spec.
- }
- func toStringSlice(o interface{}) (out []string, ok bool) {
- switch t := o.(type) {
- case []interface{}:
- for _, v := range t {
- switch vt := v.(type) {
- case string:
- out = append(out, vt)
- }
- }
- return out, true
- }
- return nil, false
- }
- func (c *convert) VisitArray(a *proto.Array) {
- atom := c.top()
- atom.List = &schema.List{
- ElementRelationship: schema.Atomic,
- }
- l := atom.List
- l.ElementType = c.makeRef(a.SubType)
- ext := a.GetExtensions()
- if val, ok := ext["x-kubernetes-list-type"]; ok {
- if val == "atomic" {
- l.ElementRelationship = schema.Atomic
- } else if val == "set" {
- l.ElementRelationship = schema.Associative
- } else if val == "map" {
- l.ElementRelationship = schema.Associative
- if keys, ok := ext["x-kubernetes-list-map-keys"]; ok {
- if keyNames, ok := toStringSlice(keys); ok {
- l.Keys = keyNames
- } else {
- c.reportError("uninterpreted map keys: %#v", keys)
- }
- } else {
- c.reportError("missing map keys")
- }
- } else {
- c.reportError("unknown list type %v", val)
- l.ElementRelationship = schema.Atomic
- }
- } else if val, ok := ext["x-kubernetes-patch-strategy"]; ok {
- if val == "merge" || val == "merge,retainKeys" {
- l.ElementRelationship = schema.Associative
- if key, ok := ext["x-kubernetes-patch-merge-key"]; ok {
- if keyName, ok := key.(string); ok {
- l.Keys = []string{keyName}
- } else {
- c.reportError("uninterpreted merge key: %#v", key)
- }
- } else {
- // It's not an error for this to be absent, it
- // means it's a set.
- }
- } else if val == "retainKeys" {
- } else {
- c.reportError("unknown patch strategy %v", val)
- l.ElementRelationship = schema.Atomic
- }
- }
- }
- func (c *convert) VisitMap(m *proto.Map) {
- a := c.top()
- a.Map = &schema.Map{}
- a.Map.ElementType = c.makeRef(m.SubType)
- // TODO: Get element relationship when we start putting it into the
- // spec.
- }
- func (c *convert) VisitPrimitive(p *proto.Primitive) {
- a := c.top()
- ptr := func(s schema.Scalar) *schema.Scalar { return &s }
- switch p.Type {
- case proto.Integer:
- a.Scalar = ptr(schema.Numeric)
- case proto.Number:
- a.Scalar = ptr(schema.Numeric)
- case proto.String:
- switch p.Format {
- case "":
- a.Scalar = ptr(schema.String)
- case "byte":
- // byte really means []byte and is encoded as a string.
- a.Scalar = ptr(schema.String)
- case "int-or-string":
- a.Untyped = &schema.Untyped{}
- case "date-time":
- a.Untyped = &schema.Untyped{}
- default:
- a.Untyped = &schema.Untyped{}
- }
- case proto.Boolean:
- a.Scalar = ptr(schema.Boolean)
- default:
- a.Untyped = &schema.Untyped{}
- }
- }
- func (c *convert) VisitArbitrary(a *proto.Arbitrary) {
- c.top().Untyped = &schema.Untyped{}
- }
- func (c *convert) VisitReference(proto.Reference) {
- // Do nothing, we handle references specially
- }
|