Merge pull request #206 from mortenlj/multi-variables

Support multi flag on multiple variable types (YAML)
K-Phoen · Feb 19, 2023 · 24710ed · 24710ed
2 parents f608f86 + 0756c91
commit 24710ed
Show file tree

Hide file tree

Showing 10 changed files with 166 additions and 10 deletions.
diff --git a/cmd/builder-example/main.go b/cmd/builder-example/main.go
@@ -76,7 +76,7 @@ func main() {
 		),
 		dashboard.VariableAsCustom(
 			"vX",
-			custom.Multi(),
+			custom.Multiple(),
 			custom.IncludeAll(),
 			custom.Values(map[string]string{
 				"v1": "v1",

diff --git a/decoder/dashboard_test.go b/decoder/dashboard_test.go
@@ -27,6 +27,7 @@ func TestUnmarshalYAML(t *testing.T) {
 		generalOptions(),
 		tagAnnotations(),
 		variables(),
+		variablesMultiple(),
 		textPanel(),
 		graphPanel(),
 		singleStatPanel(),
@@ -391,6 +392,42 @@ variables:
 	}
 }
 
+func variablesMultiple() testCase {
+	yaml := `title: Awesome dashboard
+
+timezone: browser
+
+variables:
+  - query:
+      name: status
+      label: HTTP status
+      datasource: prometheus-default
+      include_all: true
+      default_all: true
+      request: "label_values(prometheus_http_requests_total, code)"
+      multiple: true
+  - custom:
+      name: vX
+      label: vX
+      default: v1
+      values_map:
+        v1: v1
+      multiple: true
+  - datasource:
+      name: datasource
+      label: datasource
+      type: prometheus
+      regex: /applications-(?!staging)/
+      include_all: true
+      multiple: true
+`
+	return testCase{
+		name:                "variables_multiple",
+		yaml:                yaml,
+		expectedGrafanaJSON: "variables_multiple.json",
+	}
+}
+
 func textPanel() testCase {
 	yaml := `title: Awesome dashboard
 

diff --git a/decoder/testdata/variables_multiple.json b/decoder/testdata/variables_multiple.json
@@ -0,0 +1,107 @@
+{
+  "slug": "",
+  "title": "Awesome dashboard",
+  "originalTitle": "",
+  "tags": null,
+  "style": "dark",
+  "timezone": "browser",
+  "editable": false,
+  "hideControls": false,
+  "sharedCrosshair": false,
+  "templating": {
+    "list": [
+      {
+        "name": "status",
+        "type": "query",
+        "datasource": "prometheus-default",
+        "refresh": 1,
+        "options": [
+          {
+            "text": "All",
+            "value": "$__all",
+            "selected": false
+          }
+        ],
+        "includeAll": true,
+        "allFormat": "",
+        "allValue": "",
+        "multi": true,
+        "multiFormat": "",
+        "query": "label_values(prometheus_http_requests_total, code)",
+        "regex": "",
+        "current": {
+          "text": ["All"],
+          "value": "$__all"
+        },
+        "label": "HTTP status",
+        "hide": 0,
+        "sort": 0
+      },
+      {
+        "name": "vX",
+        "type": "custom",
+        "datasource": null,
+        "refresh": false,
+        "options": [
+          {
+            "text": "v1",
+            "value": "v1",
+            "selected": false
+          }
+        ],
+        "includeAll": false,
+        "allFormat": "",
+        "allValue": "",
+        "multi": true,
+        "multiFormat": "",
+        "query": "v1",
+        "regex": "",
+        "current": {
+          "text": ["v1"],
+          "value": "v1"
+        },
+        "label": "vX",
+        "hide": 0,
+        "sort": 0
+      },
+      {
+        "name": "datasource",
+        "type": "datasource",
+        "datasource": null,
+        "refresh": 1,
+        "options": [
+          {
+            "text": "All",
+            "value": "$__all",
+            "selected": false
+          }
+        ],
+        "includeAll": true,
+        "allFormat": "",
+        "allValue": "",
+        "multi": true,
+        "multiFormat": "",
+        "query": "prometheus",
+        "regex": "/applications-(?!staging)/",
+        "current": {
+          "text": null,
+          "value": null
+        },
+        "label": "datasource",
+        "hide": 0,
+        "sort": 0
+      }
+    ]
+  },
+  "annotations": {"list": null},
+  "links": null,
+  "panels": null,
+  "rows": [],
+  "time": {"from": "now-3h", "to": "now"},
+  "timepicker": {
+    "refresh_intervals": ["5s","10s","30s","1m","5m","15m","30m","1h","2h","1d"],
+    "time_options": ["5m","15m","1h","6h","12h","24h","2d","7d","30d"]
+  },
+  "schemaVersion": 0,
+  "version": 0
+}
diff --git a/decoder/variables.go b/decoder/variables.go
@@ -85,6 +85,7 @@ type VariableCustom struct {
 	IncludeAll bool              `yaml:"include_all"`
 	AllValue   string            `yaml:"all_value,omitempty"`
 	Hide       string            `yaml:",omitempty"`
+	Multiple   bool              `yaml:",omitempty"`
 }
 
 func (variable *VariableCustom) toOption() (dashboard.Option, error) {
@@ -104,6 +105,9 @@ func (variable *VariableCustom) toOption() (dashboard.Option, error) {
 	if variable.IncludeAll {
 		opts = append(opts, custom.IncludeAll())
 	}
+	if variable.Multiple {
+		opts = append(opts, custom.Multiple())
+	}
 
 	switch variable.Hide {
 	case "":
@@ -167,6 +171,7 @@ type VariableQuery struct {
 	DefaultAll bool   `yaml:"default_all"`
 	AllValue   string `yaml:"all_value,omitempty"`
 	Hide       string `yaml:",omitempty"`
+	Multiple   bool   `yaml:",omitempty"`
 }
 
 func (variable *VariableQuery) toOption() (dashboard.Option, error) {
@@ -192,6 +197,9 @@ func (variable *VariableQuery) toOption() (dashboard.Option, error) {
 	if variable.DefaultAll {
 		opts = append(opts, query.DefaultAll())
 	}
+	if variable.Multiple {
+		opts = append(opts, query.Multiple())
+	}
 
 	switch variable.Hide {
 	case "":
@@ -217,6 +225,7 @@ type VariableDatasource struct {
 	Regex      string
 	IncludeAll bool   `yaml:"include_all"`
 	Hide       string `yaml:",omitempty"`
+	Multiple   bool   `yaml:",omitempty"`
 }
 
 func (variable *VariableDatasource) toOption() (dashboard.Option, error) {
@@ -233,6 +242,9 @@ func (variable *VariableDatasource) toOption() (dashboard.Option, error) {
 	if variable.IncludeAll {
 		opts = append(opts, datasource.IncludeAll())
 	}
+	if variable.Multiple {
+		opts = append(opts, datasource.Multiple())
+	}
 
 	switch variable.Hide {
 	case "":

diff --git a/variable/custom/custom.go b/variable/custom/custom.go
@@ -103,8 +103,8 @@ func Hide() Option {
 	}
 }
 
-// Multi allows several values to be selected.
-func Multi() Option {
+// Multiple allows several values to be selected.
+func Multiple() Option {
 	return func(custom *Custom) {
 		custom.Builder.Multi = true
 	}

diff --git a/variable/custom/custom_test.go b/variable/custom/custom_test.go
@@ -73,7 +73,7 @@ func TestVariableCanBeHidden(t *testing.T) {
 func TestMultipleVariablesCanBeSelected(t *testing.T) {
 	req := require.New(t)
 
-	panel := New("", Multi())
+	panel := New("", Multiple())
 
 	req.True(panel.Builder.Multi)
 }

diff --git a/variable/datasource/datasource.go b/variable/datasource/datasource.go
@@ -74,8 +74,8 @@ func Hide() Option {
 	}
 }
 
-// Multi allows several values to be selected.
-func Multi() Option {
+// Multiple allows several values to be selected.
+func Multiple() Option {
 	return func(query *Datasource) {
 		query.Builder.Multi = true
 	}

diff --git a/variable/datasource/datasource_test.go b/variable/datasource/datasource_test.go
@@ -46,7 +46,7 @@ func TestVariableCanBeHidden(t *testing.T) {
 func TestMultipleVariablesCanBeSelected(t *testing.T) {
 	req := require.New(t)
 
-	panel := New("", Multi())
+	panel := New("", Multiple())
 
 	req.True(panel.Builder.Multi)
 }

diff --git a/variable/query/query.go b/variable/query/query.go
@@ -126,8 +126,8 @@ func Hide() Option {
 	}
 }
 
-// Multi allows several values to be selected.
-func Multi() Option {
+// Multiple allows several values to be selected.
+func Multiple() Option {
 	return func(query *Query) {
 		query.Builder.Multi = true
 	}

diff --git a/variable/query/query_test.go b/variable/query/query_test.go
@@ -44,7 +44,7 @@ func TestVariableCanBeHidden(t *testing.T) {
 func TestMultipleVariablesCanBeSelected(t *testing.T) {
 	req := require.New(t)
 
-	panel := New("", Multi())
+	panel := New("", Multiple())
 
 	req.True(panel.Builder.Multi)
 }