operator-sdk/internal/generate: fix CSV path segments for multi-field structs (#4166)

joelanford · Eric Stroczynski · web-flow · commit 440b029ca038 · 2020-11-02T17:06:28.000-05:00
Co-authored-by: Eric Stroczynski &lt;estroczy@redhat.com&gt;
diff --git a/changelog/fragments/fix-csv-generate-path-segments.yaml b/changelog/fragments/fix-csv-generate-path-segments.yaml
@@ -0,0 +1,5 @@
+entries:
+  - description: >
+      Fixed an issue during CSV generation that caused incorrect paths to
+      be used in `specDescriptors` and `statusDescriptors`.
+    kind: "bugfix"
diff --git a/internal/generate/clusterserviceversion/bases/definitions/ast.go b/internal/generate/clusterserviceversion/bases/definitions/ast.go
@@ -66,9 +66,11 @@ func (g generator) getMarkedChildrenOfField(root markers.FieldInfo) (map[string]
 						}
 						// Create a new set of path segments using the parent's segments
 						// and add the field to the next fields to search.
+						parentSegments := make([]string, len(field.pathSegments), len(field.pathSegments)+1)
+						copy(parentSegments, field.pathSegments)
 						f := &fieldInfo{
 							FieldInfo:    finfo,
-							pathSegments: append(field.pathSegments, segment),
+							pathSegments: append(parentSegments, segment),
 						}
 						fields = append(fields, f)
 						// Marked fields get collected for the caller to parse.
diff --git a/internal/generate/testdata/clusterserviceversions/bases/with-ui-metadata.clusterserviceversion.yaml b/internal/generate/testdata/clusterserviceversions/bases/with-ui-metadata.clusterserviceversion.yaml
@@ -15,6 +15,35 @@ spec:
       kind: Memcached
       name: memcacheds.cache.example.com
       specDescriptors:
+      - description: List of Providers
+        displayName: Providers
+        path: providers
+      - description: Foo represents the Foo provider
+        displayName: Foo Provider
+        path: providers[0].foo
+      - description: CredentialsSecret is a reference to a secret containing authentication details for the Foo server
+        displayName: Secret Containing the Credentials
+        path: providers[0].foo.credentialsSecret
+        x-descriptors:
+        - urn:alm:descriptor:io.kubernetes:Secret
+      - description: Key represents the specific key to reference from the secret
+        displayName: Key within the secret
+        path: providers[0].foo.credentialsSecret.key
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:advanced
+        - urn:alm:descriptor:com.tectonic.ui:text
+      - description: Name represents the name of the secret
+        displayName: Name of the secret
+        path: providers[0].foo.credentialsSecret.name
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:advanced
+        - urn:alm:descriptor:com.tectonic.ui:text
+      - description: Namespace represents the namespace containing the secret
+        displayName: Namespace containing the secret
+        path: providers[0].foo.credentialsSecret.namespace
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:advanced
+        - urn:alm:descriptor:com.tectonic.ui:text
       - description: Size is the size of the memcached deployment
         displayName: Size
         path: size
diff --git a/internal/generate/testdata/clusterserviceversions/output/memcached-operator.clusterserviceversion.yaml b/internal/generate/testdata/clusterserviceversions/output/memcached-operator.clusterserviceversion.yaml
@@ -27,6 +27,35 @@ spec:
       kind: Memcached
       name: memcacheds.cache.example.com
       specDescriptors:
+      - description: List of Providers
+        displayName: Providers
+        path: providers
+      - description: Foo represents the Foo provider
+        displayName: Foo Provider
+        path: providers[0].foo
+      - description: CredentialsSecret is a reference to a secret containing authentication details for the Foo server
+        displayName: Secret Containing the Credentials
+        path: providers[0].foo.credentialsSecret
+        x-descriptors:
+        - urn:alm:descriptor:io.kubernetes:Secret
+      - description: Key represents the specific key to reference from the secret
+        displayName: Key within the secret
+        path: providers[0].foo.credentialsSecret.key
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:advanced
+        - urn:alm:descriptor:com.tectonic.ui:text
+      - description: Name represents the name of the secret
+        displayName: Name of the secret
+        path: providers[0].foo.credentialsSecret.name
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:advanced
+        - urn:alm:descriptor:com.tectonic.ui:text
+      - description: Namespace represents the namespace containing the secret
+        displayName: Namespace containing the secret
+        path: providers[0].foo.credentialsSecret.namespace
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:advanced
+        - urn:alm:descriptor:com.tectonic.ui:text
       - description: Size is the size of the memcached deployment
         displayName: Size
         path: size
diff --git a/internal/generate/testdata/go/api/v1alpha1/memcached_types.go b/internal/generate/testdata/go/api/v1alpha1/memcached_types.go
@@ -23,6 +23,40 @@ type MemcachedSpec struct {
 	// Size is the size of the memcached deployment
 	// +operator-sdk:csv:customresourcedefinitions:type=spec
 	Size int32 `json:"size"`
+
+	// List of Providers
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Providers"
+	Providers []Provider `json:"providers,omitempty"`
+}
+
+// Provider represents the container for a single provider
+type Provider struct {
+	// Foo represents the Foo provider
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Foo Provider"
+	Foo *FooProvider `json:"foo,omitempty"`
+}
+
+// FooProvider represents integration with Foo
+type FooProvider struct {
+	// CredentialsSecret is a reference to a secret containing authentication details for the Foo server
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Secret Containing the Credentials",xDescriptors="urn:alm:descriptor:io.kubernetes:Secret"
+	// +kubebuilder:validation:Required
+	CredentialsSecret *SecretRef `json:"credentialsSecret"`
+}
+
+// SecretRef represents a reference to an item within a Secret
+type SecretRef struct {
+	// Name represents the name of the secret
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Name of the secret",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:advanced","urn:alm:descriptor:com.tectonic.ui:text"}
+	Name string `json:"name"`
+
+	// Namespace represents the namespace containing the secret
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Namespace containing the secret",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:advanced","urn:alm:descriptor:com.tectonic.ui:text"}
+	Namespace string `json:"namespace"`
+
+	// Key represents the specific key to reference from the secret
+	// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Key within the secret",xDescriptors={"urn:alm:descriptor:com.tectonic.ui:advanced","urn:alm:descriptor:com.tectonic.ui:text"}
+	Key string `json:"key,omitempty"`
 }
 
 // MemcachedStatus defines the observed state of Memcached

Original file line number	Diff line number	Diff line change
`@@ -66,9 +66,11 @@ func (g generator) getMarkedChildrenOfField(root markers.FieldInfo) (map[string]`
`66`	`66`	`}`
`67`	`67`	`// Create a new set of path segments using the parent's segments`
`68`	`68`	`// and add the field to the next fields to search.`
	`69`	`+ parentSegments := make([]string, len(field.pathSegments), len(field.pathSegments)+1)`
	`70`	`+ copy(parentSegments, field.pathSegments)`
`69`	`71`	`f := &fieldInfo{`
`70`	`72`	`FieldInfo: finfo,`
`71`		`- pathSegments: append(field.pathSegments, segment),`
	`73`	`+ pathSegments: append(parentSegments, segment),`
`72`	`74`	`}`
`73`	`75`	`fields = append(fields, f)`
`74`	`76`	`// Marked fields get collected for the caller to parse.`