feat(pkger): make envRef default values support more types

references: #18237
influxdata · Jul 28, 2020 · a745bf0 · a745bf0
1 parent 902cdeb
commit a745bf0
Show file tree

Hide file tree

Showing 5 changed files with 74 additions and 53 deletions.
diff --git a/pkger/models.go b/pkger/models.go
@@ -648,10 +648,10 @@ type SummaryLabelMapping struct {
 // SummaryReference informs the consumer of required references for
 // this resource.
 type SummaryReference struct {
-	Field        string `json:"resourceField"`
-	EnvRefKey    string `json:"envRefKey"`
-	Value        string `json:"value"`
-	DefaultValue string `json:"defaultValue"`
+	Field        string      `json:"resourceField"`
+	EnvRefKey    string      `json:"envRefKey"`
+	Value        string      `json:"value"`
+	DefaultValue interface{} `json:"defaultValue"`
 }
 
 // SummaryTask provides a summary of a task.

diff --git a/pkger/parser.go b/pkger/parser.go
@@ -1772,7 +1772,7 @@ func ifaceToReference(i interface{}) *references {
 			switch f {
 			case fieldReferencesEnv:
 				ref.EnvRef = keyRes.stringShort(fieldKey)
-				ref.defaultVal = keyRes.stringShort(fieldDefault)
+				ref.defaultVal = keyRes[fieldDefault]
 			case fieldReferencesSecret:
 				ref.Secret = keyRes.stringShort(fieldKey)
 			}

diff --git a/pkger/parser_models.go b/pkger/parser_models.go
@@ -2050,10 +2050,11 @@ const (
 )
 
 type references struct {
+	EnvRef string
+	Secret string
+
 	val        interface{}
-	defaultVal string
-	EnvRef     string
-	Secret     string
+	defaultVal interface{}
 }
 
 func (r *references) hasValue() bool {
@@ -2072,18 +2073,15 @@ func (r *references) String() string {
 		return v
 	}
 	if r.EnvRef != "" {
-		return r.defaultEnvValue()
+		s, _ := ifaceToStr(r.defaultVal)
+		if s != "" {
+			return s
+		}
+		return "env-" + r.EnvRef
 	}
 	return ""
 }
 
-func (r *references) defaultEnvValue() string {
-	if r.defaultVal != "" {
-		return r.defaultVal
-	}
-	return "env-" + r.EnvRef
-}
-
 func (r *references) StringVal() string {
 	if r.val != nil {
 		s, _ := r.val.(string)
@@ -2107,7 +2105,7 @@ func convertRefToRefSummary(field string, ref *references) SummaryReference {
 		Field:        field,
 		EnvRefKey:    ref.EnvRef,
 		Value:        ref.StringVal(),
-		DefaultValue: ref.defaultEnvValue(),
+		DefaultValue: ref.defaultVal,
 	}
 }
 

diff --git a/pkger/parser_test.go b/pkger/parser_test.go
@@ -74,9 +74,8 @@ func TestParse(t *testing.T) {
 						DefaultValue: "spectacles",
 					},
 					{
-						Field:        "spec.associations[0].name",
-						EnvRefKey:    "label-meta-name",
-						DefaultValue: "env-label-meta-name",
+						Field:     "spec.associations[0].name",
+						EnvRefKey: "label-meta-name",
 					},
 				}
 				assert.Equal(t, expectedEnvRefs, actual[0].EnvReferences)
@@ -215,14 +214,12 @@ spec:
 
 				expected := sumLabelGen("env-meta-name", "env-spec-name", "", "",
 					SummaryReference{
-						Field:        "metadata.name",
-						EnvRefKey:    "meta-name",
-						DefaultValue: "env-meta-name",
+						Field:     "metadata.name",
+						EnvRefKey: "meta-name",
 					},
 					SummaryReference{
-						Field:        "spec.name",
-						EnvRefKey:    "spec-name",
-						DefaultValue: "env-spec-name",
+						Field:     "spec.name",
+						EnvRefKey: "spec-name",
 					},
 				)
 				assert.Contains(t, actual, expected)
@@ -598,9 +595,8 @@ spec:
 						DefaultValue: "spectacles",
 					},
 					{
-						Field:        "spec.associations[0].name",
-						EnvRefKey:    "label-meta-name",
-						DefaultValue: "env-label-meta-name",
+						Field:     "spec.associations[0].name",
+						EnvRefKey: "label-meta-name",
 					},
 				}
 				assert.Equal(t, expectedEnvRefs, actual[0].EnvReferences)
@@ -2309,9 +2305,8 @@ spec:
 						DefaultValue: "spectacles",
 					},
 					{
-						Field:        "spec.associations[0].name",
-						EnvRefKey:    "label-meta-name",
-						DefaultValue: "env-label-meta-name",
+						Field:     "spec.associations[0].name",
+						EnvRefKey: "label-meta-name",
 					},
 				}
 				assert.Equal(t, expected, actual[0].EnvReferences)
@@ -2571,9 +2566,8 @@ spec:
 						DefaultValue: "spectacles",
 					},
 					{
-						Field:        "spec.associations[0].name",
-						EnvRefKey:    "label-meta-name",
-						DefaultValue: "env-label-meta-name",
+						Field:     "spec.associations[0].name",
+						EnvRefKey: "label-meta-name",
 					},
 				}
 				assert.Equal(t, expectedEnvRefs, actual[0].EnvReferences)
@@ -2896,14 +2890,12 @@ spec:
 						DefaultValue: "spectacles",
 					},
 					{
-						Field:        "spec.associations[0].name",
-						EnvRefKey:    "label-meta-name",
-						DefaultValue: "env-label-meta-name",
+						Field:     "spec.associations[0].name",
+						EnvRefKey: "label-meta-name",
 					},
 					{
-						Field:        "spec.endpointName",
-						EnvRefKey:    "endpoint-meta-name",
-						DefaultValue: "env-endpoint-meta-name",
+						Field:     "spec.endpointName",
+						EnvRefKey: "endpoint-meta-name",
 					},
 				}
 				assert.Equal(t, expectedEnvRefs, actual[0].EnvReferences)
@@ -3238,9 +3230,8 @@ spec:
 						DefaultValue: "spectacles",
 					},
 					{
-						Field:        "spec.associations[0].name",
-						EnvRefKey:    "label-meta-name",
-						DefaultValue: "env-label-meta-name",
+						Field:     "spec.associations[0].name",
+						EnvRefKey: "label-meta-name",
 					},
 				}
 				assert.Equal(t, expectedEnvRefs, actual[0].EnvReferences)
@@ -3457,9 +3448,8 @@ spec:
 						DefaultValue: "spectacles",
 					},
 					{
-						Field:        "spec.associations[0].name",
-						EnvRefKey:    "label-meta-name",
-						DefaultValue: "env-label-meta-name",
+						Field:     "spec.associations[0].name",
+						EnvRefKey: "label-meta-name",
 					},
 				}
 				assert.Equal(t, expectedEnvRefs, actual[0].EnvReferences)
@@ -3588,19 +3578,17 @@ spec:
 						DefaultValue: "spectacles",
 					},
 					{
-						Field:        "spec.associations[0].name",
-						EnvRefKey:    "label-meta-name",
-						DefaultValue: "env-label-meta-name",
+						Field:     "spec.associations[0].name",
+						EnvRefKey: "label-meta-name",
 					},
 					{
 						Field:        "spec.selected[0]",
 						EnvRefKey:    "the-selected",
 						DefaultValue: "second val",
 					},
 					{
-						Field:        "spec.selected[1]",
-						EnvRefKey:    "the-2nd",
-						DefaultValue: "env-the-2nd",
+						Field:     "spec.selected[1]",
+						EnvRefKey: "the-2nd",
 					},
 				}
 				assert.Equal(t, expectedEnvRefs, actual[0].EnvReferences)

diff --git a/pkger/testdata/dashboard_params.yml b/pkger/testdata/dashboard_params.yml
@@ -0,0 +1,35 @@
+apiVersion: influxdata.com/v2alpha1
+kind: Dashboard
+metadata:
+  name: dash-1
+spec:
+  charts:
+    - kind: Single_Stat
+      name: single stat
+      xPos: 1
+      yPos: 2
+      width: 6
+      height: 3
+      queries:
+        - query: |
+            option params = {
+              bucket:   "foo",
+              start:    -1d,
+              stop:     now(),
+              name:     "max",
+              floatVal: 1.0,
+              minVal:   10
+            }
+
+            from(bucket: params.bucket)
+              |> range(start: params.start, end: params.stop)
+              |> filter(fn: (r) => r._measurement == "processes")
+              |> filter(fn: (r) => r.floater == params.floatVal)
+              |> filter(fn: (r) => r._value > params.minVal)
+              |> aggregateWindow(every: v.windowPeriod, fn: max)
+              |> yield(name: params.name)
+      colors:
+        - name: laser
+          type: text
+          hex: "#8F8AF4"
+          value: 3