Merge pull request #205 from mortenlj/yaml-uid-slug

Add support for setting slug and uid in YAML

dashboard/dashboard.go

@@ -155,6 +155,15 @@ func UID(uid string) Option {
 	}
 }
 
+// Slug sets the Slug used by the dashboard.
+func Slug(slug string) Option {
+	return func(builder *Builder) error {
+		builder.board.Slug = slug
+
+		return nil
+	}
+}
+
 // VariableAsCustom adds a templated variable, defined as a set of custom
 // values.
 // See https://grafana.com/docs/grafana/latest/reference/templating/#variable-types

dashboard/dashboard_test.go

@@ -4,8 +4,9 @@ import (
 	"encoding/json"
 	"testing"
 
-	"github.com/K-Phoen/grabana/variable/datasource"
 	"github.com/stretchr/testify/require"
+
+	"github.com/K-Phoen/grabana/variable/datasource"
 )
 
 func requireJSON(t *testing.T, payload []byte) {
@@ -82,6 +83,15 @@ func TestDashboardUIDCanBeSet(t *testing.T) {
 	req.Equal("foo", panel.board.UID)
 }
 
+func TestDashboardSlugCanBeSet(t *testing.T) {
+	req := require.New(t)
+
+	panel, err := New("", Slug("super-slug"))
+
+	req.NoError(err)
+	req.Equal("super-slug", panel.board.Slug)
+}
+
 func TestDashboardUIDWillBeHashedWhenTooLongForGrafana(t *testing.T) {
 	req := require.New(t)
 

decoder/dashboard.go

@@ -12,6 +12,8 @@ var ErrInvalidTimezone = fmt.Errorf("invalid timezone")
 
 type DashboardModel struct {
 	Title           string
+	Slug            string `yaml:",omitempty"`
+	UID             string `yaml:"uid,omitempty"`
 	Editable        bool
 	SharedCrosshair bool `yaml:"shared_crosshair"`
 	Tags            []string
@@ -38,6 +40,14 @@ func (d *DashboardModel) ToBuilder() (dashboard.Builder, error) {
 		opts = append(opts, dashboard.Tags(d.Tags))
 	}
 
+	if d.Slug != "" {
+		opts = append(opts, dashboard.Slug(d.Slug))
+	}
+
+	if d.UID != "" {
+		opts = append(opts, dashboard.UID(d.UID))
+	}
+
 	for _, externalLink := range d.ExternalLinks {
 		opts = append(opts, dashboard.ExternalLinks(externalLink.toModel()))
 	}

decoder/dashboard_test.go

@@ -314,6 +314,8 @@ rows:
 func generalOptions() testCase {
 	yaml := `title: Awesome dashboard
 
+slug: this_is_a_slug
+uid: my_uid
 editable: true
 shared_crosshair: true
 tags: [generated, yaml]

decoder/testdata/general_options.json

@@ -1,5 +1,6 @@
 {
-  "slug": "",
+  "slug": "this_is_a_slug",
+  "uid": "my_uid",
   "title": "Awesome dashboard",
   "originalTitle": "",
   "tags": ["generated", "yaml"],