Merge pull request #183 from sttts/sttts-crd-schema-gen

Add crdschema generator

Author: k8s-ci-robot

Gopkg.lock

@@ -31,6 +31,7 @@ import (
 	prettyhelp "sigs.k8s.io/controller-tools/pkg/genall/help/pretty"
 	"sigs.k8s.io/controller-tools/pkg/markers"
 	"sigs.k8s.io/controller-tools/pkg/rbac"
+	"sigs.k8s.io/controller-tools/pkg/schemapatcher"
 	"sigs.k8s.io/controller-tools/pkg/webhook"
 )
 
@@ -46,10 +47,11 @@ var (
 	// each turns into a command line option,
 	// and has options for output forms.
 	allGenerators = map[string]genall.Generator{
-		"crd":     crd.Generator{},
-		"rbac":    rbac.Generator{},
-		"object":  deepcopy.Generator{},
-		"webhook": webhook.Generator{},
+		"crd":         crd.Generator{},
+		"rbac":        rbac.Generator{},
+		"object":      deepcopy.Generator{},
+		"webhook":     webhook.Generator{},
+		"schemapatch": schemapatcher.Generator{},
 	}
 
 	// allOutputRules defines the list of all known output rules, giving
@@ -134,6 +136,9 @@ func main() {
 	# Generate deepcopy/runtime.Object implementations for a particular file
 	controller-gen object paths=./apis/v1beta1/some_types.go
 
+	# Generate OpenAPI v3 schemas for API packages and merge them into existing CRD manifests
+	controller-gen schemapatch:manifests=./manifests output:dir=./manifests paths=./pkg/apis/... 
+
 	# Run all the generators for a given project
 	controller-gen paths=./apis/...
 

cmd/controller-gen/main.go

@@ -25,6 +25,7 @@ require (
 	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v2 v2.2.2 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20190709130402-674ba3eaed22
 	k8s.io/api v0.0.0-20190409021203-6e4e0e4f393b
 	k8s.io/apiextensions-apiserver v0.0.0-20190409022649-727a075fdec8
 	k8s.io/apimachinery v0.0.0-20190404173353-6a84e37a896d

go.mod

@@ -84,6 +84,8 @@ gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWD
 gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20190709130402-674ba3eaed22 h1:0efs3hwEZhFKsCoP8l6dDB1AZWMgnEl3yWXWRZTOaEA=
+gopkg.in/yaml.v3 v3.0.0-20190709130402-674ba3eaed22/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 k8s.io/api v0.0.0-20190409021203-6e4e0e4f393b h1:aBGgKJUM9Hk/3AE8WaZIApnTxG35kbuQba2w+SXqezo=
 k8s.io/api v0.0.0-20190409021203-6e4e0e4f393b/go.mod h1:iuAfoD4hCxJ8Onx9kaTIt30j7jUFS00AXQi6QMi99vA=
 k8s.io/apiextensions-apiserver v0.0.0-20190409022649-727a075fdec8 h1:q1Qvjzs/iEdXF6A1a8H3AKVFDzJNcJn3nXMs6R6qFtA=

go.sum

@@ -62,14 +62,14 @@ func (g Generator) Generate(ctx *genall.GenerationContext) error {
 		parser.NeedPackage(root)
 	}
 
-	metav1Pkg := findMetav1(ctx.Roots)
+	metav1Pkg := FindMetav1(ctx.Roots)
 	if metav1Pkg == nil {
 		// no objects in the roots, since nothing imported metav1
 		return nil
 	}
 
 	// TODO: allow selecting a specific object
-	kubeKinds := findKubeKinds(parser, metav1Pkg)
+	kubeKinds := FindKubeKinds(parser, metav1Pkg)
 	if len(kubeKinds) == 0 {
 		// no objects in the roots
 		return nil
@@ -116,9 +116,9 @@ func toTrivialVersions(crd *apiext.CustomResourceDefinition) {
 	crd.Spec.AdditionalPrinterColumns = canonicalColumns
 }
 
-// findMetav1 locates the actual package representing metav1 amongst
+// FindMetav1 locates the actual package representing metav1 amongst
 // the imports of the roots.
-func findMetav1(roots []*loader.Package) *loader.Package {
+func FindMetav1(roots []*loader.Package) *loader.Package {
 	for _, root := range roots {
 		pkg := root.Imports()["k8s.io/apimachinery/pkg/apis/meta/v1"]
 		if pkg != nil {
@@ -128,10 +128,10 @@ func findMetav1(roots []*loader.Package) *loader.Package {
 	return nil
 }
 
-// findKubeKinds locates all types that contain TypeMeta and ObjectMeta
+// FindKubeKinds locates all types that contain TypeMeta and ObjectMeta
 // (and thus may be a Kubernetes object), and returns the corresponding
 // group-kinds.
-func findKubeKinds(parser *Parser, metav1Pkg *loader.Package) []schema.GroupKind {
+func FindKubeKinds(parser *Parser, metav1Pkg *loader.Package) []schema.GroupKind {
 	// TODO(directxman12): technically, we should be finding metav1 per-package
 	var kubeKinds []schema.GroupKind
 	for typeIdent, info := range parser.Types {

pkg/crd/gen.go

@@ -58,6 +58,10 @@ type Parser struct {
 	GroupVersions map[*loader.Package]schema.GroupVersion
 	// CustomResourceDefinitions contains the known CustomResourceDefinitions for types in this parser.
 	CustomResourceDefinitions map[schema.GroupKind]apiext.CustomResourceDefinition
+	// FlattenedSchemata contains fully flattened schemata for use in building
+	// CustomResourceDefinition validation.  Each schema has been flattened by the flattener,
+	// and then embedded fields have been flattened with FlattenEmbedded.
+	FlattenedSchemata map[TypeIdent]apiext.JSONSchemaProps
 
 	// PackageOverrides indicates that the loading of any package with
 	// the given path should be handled by the given overrider.
@@ -95,6 +99,9 @@ func (p *Parser) init() {
 	if p.CustomResourceDefinitions == nil {
 		p.CustomResourceDefinitions = make(map[schema.GroupKind]apiext.CustomResourceDefinition)
 	}
+	if p.FlattenedSchemata == nil {
+		p.FlattenedSchemata = make(map[TypeIdent]apiext.JSONSchemaProps)
+	}
 }
 
 // indexTypes loads all types in the package into Types.
@@ -162,8 +169,20 @@ func (p *Parser) NeedSchemaFor(typ TypeIdent) {
 	schema := infoToSchema(ctxForInfo)
 
 	p.Schemata[typ] = *schema
+}
+
+func (p *Parser) NeedFlattenedSchemaFor(typ TypeIdent) {
+	p.init()
+
+	if _, knownSchema := p.FlattenedSchemata[typ]; knownSchema {
+		return
+	}
+
+	p.NeedSchemaFor(typ)
+	partialFlattened := p.flattener.FlattenType(typ)
+	fullyFlattened := FlattenEmbedded(partialFlattened, typ.Package)
 
-	return
+	p.FlattenedSchemata[typ] = *fullyFlattened
 }
 
 // NeedCRDFor lives off in spec.go

pkg/crd/parser.go

@@ -160,15 +160,17 @@ func (p *Parser) NeedCRDFor(groupKind schema.GroupKind, maxDescLen *int) {
 		if typeInfo == nil {
 			continue
 		}
-		fullSchema := FlattenEmbedded(p.flattener.FlattenType(typeIdent), pkg)
+		p.NeedFlattenedSchemaFor(typeIdent)
+		fullSchema := p.FlattenedSchemata[typeIdent]
+		fullSchema = *fullSchema.DeepCopy() // don't mutate the cache (we might be truncating description, etc)
 		if maxDescLen != nil {
-			TruncateDescription(fullSchema, *maxDescLen)
+			TruncateDescription(&fullSchema, *maxDescLen)
 		}
 		ver := apiext.CustomResourceDefinitionVersion{
 			Name:   p.GroupVersions[pkg].Version,
 			Served: true,
 			Schema: &apiext.CustomResourceValidation{
-				OpenAPIV3Schema: fullSchema,
+				OpenAPIV3Schema: &fullSchema, // fine to take a reference since we deepcopy above
 			},
 		}
 		crd.Spec.Versions = append(crd.Spec.Versions, ver)

pkg/crd/spec.go

@@ -0,0 +1,29 @@
+/*
+Copyright 2019 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 schemapatcher_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+func TestInPlaceCRDSchemaGeneration(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "In-Place CRD Patching Suite")
+}