feat(pkger): extend SummaryTasks with its env references

references: #18407
influxdata · Jun 11, 2020 · b4e1ea7 · b4e1ea7
1 parent 8ca8ce9
commit b4e1ea7
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 4 deletions.
diff --git a/http/swagger.yml b/http/swagger.yml
@@ -8105,6 +8105,8 @@ components:
                     type: string
                   status:
                     type: string
+                  envReferences:
+                    $ref: "#/components/schemas/PkgEnvReferences"
             telegrafConfigs:
               type: array
               items:

diff --git a/pkger/models.go b/pkger/models.go
@@ -643,7 +643,8 @@ type SummaryTask struct {
 	Query       string          `json:"query"`
 	Status      influxdb.Status `json:"status"`
 
-	LabelAssociations []SummaryLabel `json:"labelAssociations"`
+	EnvReferences     []SummaryReference `json:"envReferences"`
+	LabelAssociations []SummaryLabel     `json:"labelAssociations"`
 }
 
 // SummaryTelegraf provides a summary of a pkg telegraf config.

diff --git a/pkger/parser_models.go b/pkger/parser_models.go
@@ -35,10 +35,10 @@ func (i *identity) PkgName() string {
 
 func (i *identity) summarizeReferences() []SummaryReference {
 	refs := make([]SummaryReference, 0)
-	if i.name != nil && i.name.EnvRef != "" {
+	if i.name.hasEnvRef() {
 		refs = append(refs, convertRefToRefSummary("metadata.name", i.name))
 	}
-	if i.displayName != nil && i.displayName.EnvRef != "" {
+	if i.displayName.hasEnvRef() {
 		refs = append(refs, convertRefToRefSummary("spec.name", i.displayName))
 	}
 	return refs
@@ -1474,7 +1474,7 @@ func (r *notificationRule) summarize() SummaryNotificationRule {
 	}
 
 	envRefs := summarizeCommonReferences(r.identity, r.labels)
-	if r.endpointName != nil && r.endpointName.EnvRef != "" {
+	if r.endpointName.hasEnvRef() {
 		envRefs = append(envRefs, convertRefToRefSummary("spec.endpointName", r.endpointName))
 	}
 
@@ -1722,6 +1722,7 @@ func (t *task) summarize() SummaryTask {
 		Query:       t.query,
 		Status:      t.Status(),
 
+		EnvReferences:     summarizeCommonReferences(t.identity, t.labels),
 		LabelAssociations: toSummaryLabels(t.labels...),
 	}
 }
@@ -1995,6 +1996,10 @@ func (r *references) hasValue() bool {
 	return r.EnvRef != "" || r.Secret != "" || r.val != nil
 }
 
+func (r *references) hasEnvRef() bool {
+	return r != nil && r.EnvRef != ""
+}
+
 func (r *references) String() string {
 	if r == nil {
 		return ""

diff --git a/pkger/parser_test.go b/pkger/parser_test.go
@@ -3163,6 +3163,27 @@ spec:
 			})
 		})
 
+		t.Run("with env refs should be valid", func(t *testing.T) {
+			testfileRunner(t, "testdata/task_ref.yml", func(t *testing.T, pkg *Pkg) {
+				actual := pkg.Summary().Tasks
+				require.Len(t, actual, 1)
+
+				expectedEnvRefs := []SummaryReference{
+					{
+						Field:        "metadata.name",
+						EnvRefKey:    "meta-name",
+						DefaultValue: "env-meta-name",
+					},
+					{
+						Field:        "spec.name",
+						EnvRefKey:    "spec-name",
+						DefaultValue: "env-spec-name",
+					},
+				}
+				assert.Equal(t, expectedEnvRefs, actual[0].EnvReferences)
+			})
+		})
+
 		t.Run("handles bad config", func(t *testing.T) {
 			tests := []struct {
 				kind   Kind

diff --git a/pkger/testdata/task_ref.yml b/pkger/testdata/task_ref.yml
@@ -0,0 +1,14 @@
+apiVersion: influxdata.com/v2alpha1
+kind: Task
+metadata:
+  name:
+    envRef:
+      key: meta-name
+spec:
+  name:
+    envRef:
+      key: spec-name
+  every: 10m
+  offset: 15s
+  query:  >
+    from(bucket: "rucket_1")