Merge pull request #511 from kevindelgado/pr/386-no-desc-metadata

🐛 Don't generate description on metadata of CRD structural schema
kubernetes-sigs · Feb 17, 2021 · ea8d4ea · ea8d4ea
2 parents 557da25 + d7d8fd1
commit ea8d4ea
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 6 deletions.
diff --git a/pkg/crd/gen.go b/pkg/crd/gen.go
@@ -161,10 +161,14 @@ func (g Generator) Generate(ctx *genall.GenerationContext) error {
 		}
 
 		for i, crd := range versionedCRDs {
-			// defaults are not allowed to be specified in v1beta1 CRDs, so strip them
-			// before writing to a file
+			// defaults are not allowed to be specified in v1beta1 CRDs and
+			// decriptions are not allowed on the metadata regardless of version
+			// strip them before writing to a file
 			if crdVersions[i] == "v1beta1" {
 				removeDefaultsFromSchemas(crd.(*apiextlegacy.CustomResourceDefinition))
+				removeDescriptionFromMetadataLegacy(crd.(*apiextlegacy.CustomResourceDefinition))
+			} else {
+				removeDescriptionFromMetadata(crd.(*apiext.CustomResourceDefinition))
 			}
 			var fileName string
 			if i == 0 {
@@ -181,6 +185,47 @@ func (g Generator) Generate(ctx *genall.GenerationContext) error {
 	return nil
 }
 
+func removeDescriptionFromMetadata(crd *apiext.CustomResourceDefinition) {
+	for _, versionSpec := range crd.Spec.Versions {
+		if versionSpec.Schema != nil {
+			removeDescriptionFromMetadataProps(versionSpec.Schema.OpenAPIV3Schema)
+		}
+	}
+}
+
+func removeDescriptionFromMetadataProps(v *apiext.JSONSchemaProps) {
+	if m, ok := v.Properties["metadata"]; ok {
+		meta := &m
+		if meta.Description != "" {
+			meta.Description = ""
+			v.Properties["metadata"] = m
+
+		}
+	}
+}
+
+func removeDescriptionFromMetadataLegacy(crd *apiextlegacy.CustomResourceDefinition) {
+	if crd.Spec.Validation != nil {
+		removeDescriptionFromMetadataPropsLegacy(crd.Spec.Validation.OpenAPIV3Schema)
+	}
+	for _, versionSpec := range crd.Spec.Versions {
+		if versionSpec.Schema != nil {
+			removeDescriptionFromMetadataPropsLegacy(versionSpec.Schema.OpenAPIV3Schema)
+		}
+	}
+}
+
+func removeDescriptionFromMetadataPropsLegacy(v *apiextlegacy.JSONSchemaProps) {
+	if m, ok := v.Properties["metadata"]; ok {
+		meta := &m
+		if meta.Description != "" {
+			meta.Description = ""
+			v.Properties["metadata"] = m
+
+		}
+	}
+}
+
 // removeDefaultsFromSchemas will remove all instances of default values being
 // specified across all defined API versions
 func removeDefaultsFromSchemas(crd *apiextlegacy.CustomResourceDefinition) {

diff --git a/pkg/crd/gen_integration_test.go b/pkg/crd/gen_integration_test.go
@@ -67,7 +67,7 @@ var _ = Describe("CRD Generation proper defaulting", func() {
 		}
 	})
 
-	It("should strip v1beta1 CRDs of default fields", func() {
+	It("should strip v1beta1 CRDs of default fields and metadata description", func() {
 		By("calling Generate")
 		gen := &crd.Generator{
 			CRDVersions: []string{"v1beta1"},
@@ -84,7 +84,7 @@ var _ = Describe("CRD Generation proper defaulting", func() {
 
 	})
 
-	It("should not strip v1 CRDs of default fields", func() {
+	It("should not strip v1 CRDs of default fields and metadata description", func() {
 		By("calling Generate")
 		gen := &crd.Generator{
 			CRDVersions: []string{"v1"},

diff --git a/pkg/crd/testdata/gen/bar.example.com_foos.v1beta1.yaml b/pkg/crd/testdata/gen/bar.example.com_foos.v1beta1.yaml
@@ -27,6 +27,7 @@ spec:
         metadata:
           type: object
         spec:
+          description: Spec comments SHOULD appear in the CRD spec
           properties:
             defaultedString:
               description: This tests that defaulted fields are stripped for v1beta1, but not for v1
@@ -35,6 +36,7 @@ spec:
           - defaultedString
           type: object
         status:
+          description: Status comments SHOULD appear in the CRD spec
           type: object
       type: object
   version: foo

diff --git a/pkg/crd/testdata/gen/bar.example.com_foos.yaml b/pkg/crd/testdata/gen/bar.example.com_foos.yaml
@@ -29,6 +29,7 @@ spec:
           metadata:
             type: object
           spec:
+            description: Spec comments SHOULD appear in the CRD spec
             properties:
               defaultedString:
                 default: fooDefaultString
@@ -38,6 +39,7 @@ spec:
             - defaultedString
             type: object
           status:
+            description: Status comments SHOULD appear in the CRD spec
             type: object
         type: object
     served: true

diff --git a/pkg/crd/testdata/gen/foo_types.go b/pkg/crd/testdata/gen/foo_types.go
@@ -33,9 +33,13 @@ type FooSpec struct {
 type FooStatus struct{}
 
 type Foo struct {
-	metav1.TypeMeta   `json:",inline"`
+	// TypeMeta comments should NOT appear in the CRD spec
+	metav1.TypeMeta `json:",inline"`
+	// ObjectMeta comments should NOT appear in the CRD spec
 	metav1.ObjectMeta `json:"metadata,omitempty"`
 
-	Spec   FooSpec   `json:"spec,omitempty"`
+	// Spec comments SHOULD appear in the CRD spec
+	Spec FooSpec `json:"spec,omitempty"`
+	// Status comments SHOULD appear in the CRD spec
 	Status FooStatus `json:"status,omitempty"`
 }