Merge pull request #215 from K-Phoen/dashboards-links

Dashboards links

dashboard/dashboard.go

@@ -213,8 +213,8 @@ func VariableAsDatasource(name string, options ...datasource.Option) Option {
 	}
 }
 
-// ExternalLinks adds a dashboard-level link.
-// See https://grafana.com/docs/grafana/latest/linking/dashboard-links/
+// ExternalLinks adds a dashboard-level external links.
+// See https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#add-a-url-link-to-a-dashboard
 func ExternalLinks(links ...ExternalLink) Option {
 	return func(builder *Builder) error {
 		for _, link := range links {
@@ -225,6 +225,18 @@ func ExternalLinks(links ...ExternalLink) Option {
 	}
 }
 
+// DashboardLinks adds a dashboard-level links to other dashboards.
+// See https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links
+func DashboardLinks(links ...DashboardLink) Option {
+	return func(builder *Builder) error {
+		for _, link := range links {
+			builder.board.Links = append(builder.board.Links, link.asSdk())
+		}
+
+		return nil
+	}
+}
+
 // Row adds a row to the dashboard.
 func Row(title string, options ...row.Option) Option {
 	return func(builder *Builder) error {

dashboard/dashboard_test.go

@@ -241,3 +241,12 @@ func TestDashboardCanHaveExternalLinks(t *testing.T) {
 	req.NoError(err)
 	req.Len(panel.board.Links, 2)
 }
+
+func TestDashboardCanHaveDashboardLinks(t *testing.T) {
+	req := require.New(t)
+
+	panel, err := New("", DashboardLinks(DashboardLink{}, DashboardLink{}))
+
+	req.NoError(err)
+	req.Len(panel.board.Links, 2)
+}

dashboard/link.go

@@ -15,7 +15,7 @@ const (
 )
 
 // ExternalLink describes dashboard-level external link.
-// See https://grafana.com/docs/grafana/latest/linking/dashboard-links/
+// See https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#add-a-url-link-to-a-dashboard
 type ExternalLink struct {
 	Title                 string
 	Description           string
@@ -46,3 +46,27 @@ func (link ExternalLink) asSdk() sdk.Link {
 		Type:        "link",
 	}
 }
+
+// DashboardLink describes dashboard-level links to other dashboards.
+// See https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/manage-dashboard-links/#dashboard-links
+type DashboardLink struct {
+	Title string
+	Tags  []string
+
+	AsDropdown            bool
+	IncludeTimeRange      bool
+	IncludeVariableValues bool
+	OpenInNewTab          bool
+}
+
+func (link DashboardLink) asSdk() sdk.Link {
+	return sdk.Link{
+		Title:       link.Title,
+		Tags:        link.Tags,
+		AsDropdown:  &link.AsDropdown,
+		IncludeVars: link.IncludeVariableValues,
+		KeepTime:    &link.IncludeTimeRange,
+		TargetBlank: &link.OpenInNewTab,
+		Type:        "dashboards",
+	}
+}

dashboard/link_test.go

@@ -38,3 +38,25 @@ func TestExternalLinkIconHasDefault(t *testing.T) {
 
 	req.Equal("external", *sdkLink.Icon)
 }
+
+func TestDashboardLinkAsSdk(t *testing.T) {
+	req := require.New(t)
+
+	link := DashboardLink{
+		Title:                 "my link",
+		Tags:                  []string{"my-service"},
+		AsDropdown:            true,
+		IncludeTimeRange:      true,
+		IncludeVariableValues: true,
+		OpenInNewTab:          true,
+	}
+	sdkLink := link.asSdk()
+
+	req.Equal("my link", sdkLink.Title)
+	req.ElementsMatch([]string{"my-service"}, link.Tags)
+	req.True(*sdkLink.AsDropdown)
+	req.True(sdkLink.IncludeVars)
+	req.True(*sdkLink.KeepTime)
+	req.True(*sdkLink.TargetBlank)
+	req.Equal("dashboards", sdkLink.Type)
+}

decoder/dashboard.go

@@ -25,6 +25,7 @@ type DashboardModel struct {
 	TagsAnnotation []dashboard.TagAnnotation `yaml:"tags_annotations,omitempty"`
 	Variables      []DashboardVariable       `yaml:",omitempty"`
 	ExternalLinks  []DashboardExternalLink   `yaml:"external_links,omitempty"`
+	DashboardLinks []DashboardInternalLink   `yaml:"dashboard_links,omitempty"`
 
 	Rows []DashboardRow
 }
@@ -52,6 +53,10 @@ func (d *DashboardModel) ToBuilder() (dashboard.Builder, error) {
 		opts = append(opts, dashboard.ExternalLinks(externalLink.toModel()))
 	}
 
+	for _, dashboardLink := range d.DashboardLinks {
+		opts = append(opts, dashboard.DashboardLinks(dashboardLink.toModel()))
+	}
+
 	if d.AutoRefresh != "" {
 		opts = append(opts, dashboard.AutoRefresh(d.AutoRefresh))
 	}

decoder/dashboardlink.go

@@ -0,0 +1,25 @@
+package decoder
+
+import (
+	"github.com/K-Phoen/grabana/dashboard"
+)
+
+type DashboardInternalLink struct {
+	Title                 string   `yaml:"title"`
+	Tags                  []string `yaml:"tags"`
+	AsDropdown            bool     `yaml:"as_dropdown,omitempty"`
+	IncludeTimeRange      bool     `yaml:"include_time_range,omitempty"`
+	IncludeVariableValues bool     `yaml:"include_variable_values,omitempty"`
+	OpenInNewTab          bool     `yaml:"open_in_new_tab,omitempty"`
+}
+
+func (l DashboardInternalLink) toModel() dashboard.DashboardLink {
+	return dashboard.DashboardLink{
+		Title:                 l.Title,
+		Tags:                  l.Tags,
+		AsDropdown:            l.AsDropdown,
+		IncludeTimeRange:      l.IncludeTimeRange,
+		IncludeVariableValues: l.IncludeVariableValues,
+		OpenInNewTab:          l.OpenInNewTab,
+	}
+}

decoder/dashboardlink_test.go

@@ -0,0 +1,29 @@
+package decoder
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestDashboardLink(t *testing.T) {
+	req := require.New(t)
+
+	yamlLink := DashboardInternalLink{
+		Title:                 "joe",
+		Tags:                  []string{"my-service"},
+		AsDropdown:            true,
+		IncludeTimeRange:      true,
+		IncludeVariableValues: true,
+		OpenInNewTab:          true,
+	}
+
+	model := yamlLink.toModel()
+
+	req.Equal("joe", model.Title)
+	req.ElementsMatch([]string{"my-service"}, model.Tags)
+	req.True(model.AsDropdown)
+	req.True(model.IncludeTimeRange)
+	req.True(model.IncludeVariableValues)
+	req.True(model.OpenInNewTab)
+}