feat(uneditable): Adds linting for editable dashboards

docs/rules/template-uneditable-rule.md

@@ -0,0 +1,3 @@
+# template-uneditable-rule
+Checks that dashboard is not able to be edited in the ui. This is due to the fact dashboards are declared as code
+and therefore that code should be the accurate source of truth for the dashboard

lint/lint.go

@@ -271,8 +271,9 @@ type Dashboard struct {
 	Templating struct {
 		List []Template `json:"list"`
 	} `json:"templating"`
-	Rows   []Row   `json:"rows,omitempty"`
-	Panels []Panel `json:"panels,omitempty"`
+	Rows     []Row   `json:"rows,omitempty"`
+	Panels   []Panel `json:"panels,omitempty"`
+	Editable bool    `json:"editable,omitempty"`
 }
 
 // GetPanels returns the all panels whether they are nested in the (now deprecated) "rows" property or

lint/rule_uneditable.go

@@ -0,0 +1,19 @@
+package lint
+
+func NewUneditableRule() *DashboardRuleFunc {
+	return &DashboardRuleFunc{
+		name:        "uneditable-dashboard",
+		description: "Checks that the dashboard is not editable.",
+		fn: func(d Dashboard) DashboardRuleResults {
+			r := DashboardRuleResults{}
+			if d.Editable {
+				r.AddFixableError(d, "is editable, it should be set to 'editable: false'", FixUneditableRule)
+			}
+			return r
+		},
+	}
+}
+
+func FixUneditableRule(d *Dashboard) {
+	d.Editable = false
+}

lint/rule_uneditable_test.go

@@ -0,0 +1,64 @@
+package lint
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestNewUneditableRule(t *testing.T) {
+	linter := NewUneditableRule()
+
+	for _, tc := range []struct {
+		name      string
+		result    Result
+		dashboard Dashboard
+		fixed     *Dashboard
+	}{
+		{
+			name:   "OK",
+			result: ResultSuccess,
+			dashboard: Dashboard{
+				Title:    "test",
+				Editable: false,
+			},
+		},
+		{
+			name: "error",
+			result: Result{
+				Severity: Error,
+				Message:  `Dashboard 'test' is editable, it should be set to 'editable: false'`,
+			},
+			dashboard: Dashboard{
+				Title:    "test",
+				Editable: true,
+			},
+		},
+		{
+			name: "autofix",
+			result: Result{
+				Severity: Fixed,
+				Message:  `Dashboard 'test' is editable, it should be set to 'editable: false'`,
+			},
+			dashboard: Dashboard{
+				Title:    "test",
+				Editable: true,
+			},
+			fixed: &Dashboard{
+				Title:    "test",
+				Editable: false,
+			},
+		},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			autofix := tc.fixed != nil
+			testRuleWithAutofix(t, linter, &tc.dashboard, []Result{tc.result}, autofix)
+			if autofix {
+				expected, _ := json.Marshal(tc.fixed)
+				actual, _ := json.Marshal(tc.dashboard)
+				require.Equal(t, string(expected), string(actual))
+			}
+		})
+	}
+}

lint/rules.go

@@ -186,6 +186,7 @@ func NewRuleSet() RuleSet {
 			NewTargetJobRule(),
 			NewTargetInstanceRule(),
 			NewTargetCounterAggRule(),
+			NewUneditableRule(),
 		},
 	}
 }

lint/testdata/dashboard.json

@@ -1,4 +1,5 @@
 {
+  "editable": true,
   "__inputs": [
     {
       "name": "DS_PROMETHEUS",