Update pathconfigs library

implement CRD support and add unit tests Add integration test for crd support address comments
2026-06-13 10:00:56 +00:00 · 2018-06-14 10:08:20 -07:00
parent e7ecceb0c2
commit ea00134776
19 changed files with 740 additions and 13 deletions
--- a/pkg/crds/constants.go
+++ b/pkg/crds/constants.go
@@ -0,0 +1,43 @@
+/*
+Copyright 2018 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 crds read in files for CRD schemas and parse annotations from it
+package crds
+
+// Annotation is to mark a field as annotations.
+// "x-kubernetes-annotation": ""
+const Annotation = "x-kubernetes-annotation"
+
+// LabelSelector is to mark a field as LabelSelector
+// "x-kubernetes-label-selector": ""
+const LabelSelector = "x-kubernetes-label-selector"
+
+// Identity is to mark a field as Identity
+// "x-kubernetes-identity": ""
+const Identity = "x-kubernetes-identity"
+
+// Version marks the type version of an object ref field
+// "x-kubernetes-object-ref-api-version": <apiVersion name>
+const Version = "x-kubernetes-object-ref-api-version"
+
+// Kind marks the type name of an object ref field
+// "x-kubernetes-object-ref-kind": <kind name>
+const Kind = "x-kubernetes-object-ref-kind"
+
+// NameKey marks the field key that refers to an object of an object ref field
+// "x-kubernetes-object-ref-name-key": "name"
+// default is "name"
+const NameKey = "x-kubernetes-object-ref-name-key"
--- a/pkg/crds/crds.go
+++ b/pkg/crds/crds.go
@@ -18,10 +18,192 @@ limitations under the License.
 package crds

 import (
+	"encoding/json"
+	"reflect"
+	"strings"
+
+	"github.com/ghodss/yaml"
 	"github.com/kubernetes-sigs/kustomize/pkg/loader"
+	"github.com/kubernetes-sigs/kustomize/pkg/transformers"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+	"k8s.io/kube-openapi/pkg/common"
 )

+type pathConfigs struct {
+	labelPathConfig          transformers.PathConfig
+	annotationPathConfig     transformers.PathConfig
+	prefixPathConfig         transformers.PathConfig
+	namereferencePathConfigs []transformers.ReferencePathConfig
+}
+
+func (p *pathConfigs) addLabelPathConfig(config transformers.PathConfig) {
+	if *(p.labelPathConfig.GroupVersionKind) == *config.GroupVersionKind {
+		p.labelPathConfig.Path = append(p.labelPathConfig.Path, config.Path...)
+	} else {
+		p.labelPathConfig = config
+	}
+}
+
+func (p *pathConfigs) addAnnotationPathConfig(config transformers.PathConfig) {
+	if *(p.annotationPathConfig.GroupVersionKind) == *config.GroupVersionKind {
+		p.annotationPathConfig.Path = append(p.labelPathConfig.Path, config.Path...)
+	} else {
+		p.annotationPathConfig = config
+	}
+}
+
+func (p *pathConfigs) addNamereferencePathConfig(config transformers.ReferencePathConfig) {
+	p.namereferencePathConfigs = transformers.MergeNameReferencePathConfigs(p.namereferencePathConfigs, config)
+}
+
+func (p *pathConfigs) addPrefixPathConfig(config transformers.PathConfig) {
+	if *(p.prefixPathConfig.GroupVersionKind) == *config.GroupVersionKind {
+		p.prefixPathConfig.Path = append(p.prefixPathConfig.Path, config.Path...)
+	} else {
+		p.prefixPathConfig = config
+	}
+}
+
 // RegisterCRDs parse CRD schemas from paths and update various pathConfigs
 func RegisterCRDs(loader loader.Loader, paths []string) error {
+	pathConfigs := []pathConfigs{}
+	for _, path := range paths {
+		pathConfig, err := registerCRD(loader, path)
+		if err != nil {
+			return err
+		}
+		pathConfigs = append(pathConfigs, pathConfig...)
+	}
+	addPathConfigs(pathConfigs)
 	return nil
 }
+
+// register CRD from one path
+func registerCRD(loader loader.Loader, path string) ([]pathConfigs, error) {
+	result := []pathConfigs{}
+
+	content, err := loader.Load(path)
+	if err != nil {
+		return result, err
+	}
+
+	var types map[string]common.OpenAPIDefinition
+	if content[0] == '{' {
+		err = json.Unmarshal(content, &types)
+		if err != nil {
+			return nil, err
+		}
+	} else {
+		err = yaml.Unmarshal(content, &types)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	crds := getCRDs(types)
+	for crd, gvk := range crds {
+		crdPathConfigs := pathConfigs{}
+		err = getCRDPathConfig(types, crd, crd, gvk, []string{}, &crdPathConfigs)
+		if err != nil {
+			return result, err
+		}
+		if !reflect.DeepEqual(crdPathConfigs, pathConfigs{}) {
+			result = append(result, crdPathConfigs)
+		}
+	}
+
+	return result, nil
+}
+
+// getCRDs get all CRD types
+func getCRDs(types map[string]common.OpenAPIDefinition) map[string]schema.GroupVersionKind {
+	crds := map[string]schema.GroupVersionKind{}
+
+	for typename, t := range types {
+		properties := t.Schema.SchemaProps.Properties
+		_, foundKind := properties["kind"]
+		_, foundAPIVersion := properties["apiVersion"]
+		_, foundMetadata := properties["metadata"]
+		if foundKind && foundAPIVersion && foundMetadata {
+			// TODO: Get Group and Version for CRD from the openAPI definition once
+			// "x-kubernetes-group-version-kind" is available in CRD
+			kind := strings.Split(typename, ".")[len(strings.Split(typename, "."))-1]
+			crds[typename] = schema.GroupVersionKind{Kind: kind}
+		}
+	}
+	return crds
+}
+
+// getCRDPathConfig gets pathConfigs for one CRD recursively
+func getCRDPathConfig(types map[string]common.OpenAPIDefinition, atype string, crd string, gvk schema.GroupVersionKind,
+	path []string, configs *pathConfigs) error {
+	if _, ok := types[crd]; !ok {
+		return nil
+	}
+
+	for propname, property := range types[atype].Schema.SchemaProps.Properties {
+		_, annotate := property.Extensions.GetString(Annotation)
+		if annotate {
+			configs.addAnnotationPathConfig(
+				transformers.PathConfig{
+					CreateIfNotPresent: false,
+					GroupVersionKind:   &gvk,
+					Path:               append(path, propname),
+				},
+			)
+		}
+		_, label := property.Extensions.GetString(LabelSelector)
+		if label {
+			configs.addLabelPathConfig(
+				transformers.PathConfig{
+					CreateIfNotPresent: false,
+					GroupVersionKind:   &gvk,
+					Path:               append(path, propname),
+				},
+			)
+		}
+		_, identity := property.Extensions.GetString(Identity)
+		if identity {
+			configs.addPrefixPathConfig(
+				transformers.PathConfig{
+					CreateIfNotPresent: false,
+					GroupVersionKind:   &gvk,
+					Path:               append(path, propname),
+				},
+			)
+		}
+		version, ok := property.Extensions.GetString(Version)
+		if ok {
+			kind, ok := property.Extensions.GetString(Kind)
+			if ok {
+				nameKey, ok := property.Extensions.GetString(NameKey)
+				if !ok {
+					nameKey = "name"
+				}
+				configs.addNamereferencePathConfig(transformers.NewReferencePathConfig(
+					schema.GroupVersionKind{Kind: kind, Version: version},
+					[]transformers.PathConfig{
+						{CreateIfNotPresent: false,
+							GroupVersionKind: &gvk,
+							Path:             append(path, propname, nameKey),
+						}}))
+
+			}
+		}
+
+		if property.Ref.GetURL() != nil {
+			getCRDPathConfig(types, property.Ref.String(), crd, gvk, append(path, propname), configs)
+		}
+	}
+	return nil
+}
+
+// addPathConfigs add extra path configs to the default ones
+func addPathConfigs(p []pathConfigs) {
+	for _, pc := range p {
+		transformers.AddLabelsPathConfigs(pc.labelPathConfig)
+		transformers.AddAnnotationsPathConfigs(pc.annotationPathConfig)
+		transformers.AddNameReferencePathConfigs(pc.namereferencePathConfigs)
+		transformers.AddPrefixPathConfigs(pc.prefixPathConfig)
+	}
+}
--- a/pkg/crds/crds_test.go
+++ b/pkg/crds/crds_test.go
@@ -0,0 +1,187 @@
+/*
+Copyright 2018 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 crds
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/kubernetes-sigs/kustomize/pkg/internal/loadertest"
+	"github.com/kubernetes-sigs/kustomize/pkg/loader"
+	"github.com/kubernetes-sigs/kustomize/pkg/transformers"
+	"k8s.io/apimachinery/pkg/runtime/schema"
+)
+
+const (
+	crdContent = `
+{
+	"github.com/example/pkg/apis/jingfang/v1beta1.Bee": {
+		"Schema": {
+			"description": "Bee",
+			"properties": {
+				"apiVersion": {
+					"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert 
+recognized schemas to the latest internal value, and may reject unrecognized values. 
+More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
+					"type": "string"
+				},
+				"kind": {
+					"description": "Kind is a string value representing the REST resource this object represents. Servers may infer
+this from the endpoint the client submits requests to. Cannot be updated. In CamelCase.
+More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
+					"type": "string"
+				},
+				"metadata": {
+					"$ref": "k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta"
+				},
+				"spec": {
+					"$ref": "github.com/example/pkg/apis/jingfang/v1beta1.BeeSpec"
+				},
+				"status": {
+					"$ref": "github.com/example/pkg/apis/jingfang/v1beta1.BeeStatus"
+				}
+			}
+		},
+		"Dependencies": [
+			"github.com/example/pkg/apis/jingfang/v1beta1.BeeSpec",
+			"github.com/example/pkg/apis/jingfang/v1beta1.BeeStatus",
+			"k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta"
+		]
+	},
+	"github.com/example/pkg/apis/jingfang/v1beta1.BeeSpec": {
+		"Schema": {
+			"description": "BeeSpec defines the desired state of Bee"
+		},
+		"Dependencies": []
+	},
+	"github.com/example/pkg/apis/jingfang/v1beta1.BeeStatus": {
+		"Schema": {
+			"description": "BeeStatus defines the observed state of Bee"
+		},
+		"Dependencies": []
+	},
+	"github.com/example/pkg/apis/jingfang/v1beta1.MyKind": {
+		"Schema": {
+			"description": "MyKind",
+			"properties": {
+				"apiVersion": {
+					"description": "APIVersion defines the versioned schema of this representation of an object.
+Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values.
+More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
+					"type": "string"
+				},
+				"kind": {
+					"description": "Kind is a string value representing the REST resource this object represents.
+Servers may infer this from the endpoint the client submits requests to. Cannot be updated.
+In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
+					"type": "string"
+				},
+				"metadata": {
+					"$ref": "k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta"
+				},
+				"spec": {
+					"$ref": "github.com/example/pkg/apis/jingfang/v1beta1.MyKindSpec"
+				},
+				"status": {
+					"$ref": "github.com/example/pkg/apis/jingfang/v1beta1.MyKindStatus"
+				}
+			}
+		},
+		"Dependencies": [
+			"github.com/example/pkg/apis/jingfang/v1beta1.MyKindSpec",
+			"github.com/example/pkg/apis/jingfang/v1beta1.MyKindStatus",
+			"k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta"
+		]
+	},
+	"github.com/example/pkg/apis/jingfang/v1beta1.MyKindSpec": {
+		"Schema": {
+			"description": "MyKindSpec defines the desired state of MyKind",
+			"properties": {
+				"beeRef": {
+					"x-kubernetes-object-ref-api-version": "v1beta1",
+					"x-kubernetes-object-ref-kind": "Bee",
+					"$ref": "github.com/example/pkg/apis/jingfang/v1beta1.Bee"
+				},
+				"secretRef": {
+					"description": "If defined, we use this secret for configuring the MYSQL_ROOT_PASSWORD 
+If it is not set we generate a secret dynamically",
+					"x-kubernetes-object-ref-api-version": "v1",
+					"x-kubernetes-object-ref-kind": "Secret",
+					"$ref": "k8s.io/api/core/v1.LocalObjectReference"
+				}
+			}
+		},
+		"Dependencies": [
+			"github.com/example/pkg/apis/jingfang/v1beta1.Bee",
+			"k8s.io/api/core/v1.LocalObjectReference"
+		]
+	},
+	"github.com/example/pkg/apis/jingfang/v1beta1.MyKindStatus": {
+		"Schema": {
+			"description": "MyKindStatus defines the observed state of MyKind"
+		},
+		"Dependencies": []
+	}
+}
+`
+)
+
+func makeLoader(t *testing.T) loader.Loader {
+	loader := loadertest.NewFakeLoader("/testpath")
+	err := loader.AddFile("/testpath/crd.json", []byte(crdContent))
+	if err != nil {
+		t.Fatalf("Failed to setup fake loader.")
+	}
+	return loader
+}
+
+func TestRegisterCRD(t *testing.T) {
+	expected := []pathConfigs{
+		{
+			namereferencePathConfigs: []transformers.ReferencePathConfig{
+				transformers.NewReferencePathConfig(
+					schema.GroupVersionKind{Kind: "Bee", Version: "v1beta1"},
+					[]transformers.PathConfig{
+						{
+							CreateIfNotPresent: false,
+							GroupVersionKind:   &schema.GroupVersionKind{Kind: "MyKind"},
+							Path:               []string{"spec", "beeRef", "name"},
+						},
+					},
+				),
+				transformers.NewReferencePathConfig(
+					schema.GroupVersionKind{Kind: "Secret", Version: "v1"},
+					[]transformers.PathConfig{
+						{
+							CreateIfNotPresent: false,
+							GroupVersionKind:   &schema.GroupVersionKind{Kind: "MyKind"},
+							Path:               []string{"spec", "secretRef", "name"},
+						},
+					},
+				),
+			},
+		},
+	}
+
+	loader := makeLoader(t)
+
+	pathconfig, _ := registerCRD(loader, "/testpath/crd.json")
+
+	if !reflect.DeepEqual(pathconfig, expected) {
+		t.Fatalf("expected\n %v\n but got\n %v\n", expected, pathconfig)
+	}
+}