Dashboard Migrations: V5 - no-op (#112224)

* migrate to v19

* migrate to v18

* Migration to be verified: v17 Convert minSpan to maxPerRow in panels

* Migration to be verified: 16 Grid layout migration

* Refactor v17 and v19 migrations to use shared helper functions

* Migration to be verified: 15 No-op migration for schema consistency

* Migration to be verified: 14 Shared crosshair to graph tooltip migration

* cleanup

* wip

* complete migration

* fix lint issues

* refactor and test with minimal graph config

* update tests

* migrate to v12

* extract defaults outside the func

* lint

* lint

* add missing showValues prop

* migrate to v11

* migrate to v10

* add test files

* update

* migrate to v9

* migrate to v8

* add context and fix latest version

* add context

* add context

* generate snapshots

* v13 should be no-op

* clean up

* fix tests

* add context

* snapshots

* generate snapshots

* update

* snapshots

* wip

* fix test

* remove nav when cleaning up defaults

* migrate to v6

* update comments

* migrate to v5

* remove v28

* remove singlestat migraiton from frontend migrator because this is an automigration

* remove unused function

* Remove v24 table plugin logic

* cleanup

* remove plugin version for automigrate as it was used only in v24 and v28 that have been removed

* cleanup

* update snapshot

* update snapshot

* update snapshot

* update snapshot

* update snapshot

---------

Co-authored-by: Dominik Prokop <dominik.prokop@grafana.com>

apps/dashboard/pkg/migration/schemaversion/migrations.go

@@ -7,7 +7,7 @@ import (
 )
 
 const (
-	MIN_VERSION    = 5
+	MIN_VERSION    = 4
 	LATEST_VERSION = 42
 )
 
@@ -35,6 +35,7 @@ type PanelPluginInfo struct {
 
 func GetMigrations(dsInfoProvider DataSourceInfoProvider) map[int]SchemaVersionMigrationFunc {
 	return map[int]SchemaVersionMigrationFunc{
+		5:  V5,
 		6:  V6,
 		7:  V7,
 		8:  V8,

apps/dashboard/pkg/migration/schemaversion/v5.go

@@ -0,0 +1,11 @@
+package schemaversion
+
+import (
+	"context"
+)
+
+// V5 is a no-op migration
+func V5(_ context.Context, dashboard map[string]interface{}) error {
+	dashboard["schemaVersion"] = 5
+	return nil
+}

apps/dashboard/pkg/migration/schemaversion/v5_test.go

@@ -0,0 +1,38 @@
+package schemaversion_test
+
+import (
+	"testing"
+
+	"github.com/grafana/grafana/apps/dashboard/pkg/migration/schemaversion"
+)
+
+func TestV5(t *testing.T) {
+	tests := []migrationTestCase{
+		{
+			name: "v5 no-op migration, updates schema version only",
+			input: map[string]interface{}{
+				"title":         "V5 No-Op Migration Test Dashboard",
+				"schemaVersion": 4,
+				"panels": []interface{}{
+					map[string]interface{}{
+						"type":  "graph",
+						"title": "Panel remains unchanged",
+						"id":    1,
+					},
+				},
+			},
+			expected: map[string]interface{}{
+				"title":         "V5 No-Op Migration Test Dashboard",
+				"schemaVersion": 5,
+				"panels": []interface{}{
+					map[string]interface{}{
+						"type":  "graph",
+						"title": "Panel remains unchanged",
+						"id":    1,
+					},
+				},
+			},
+		},
+	}
+	runMigrationTests(t, tests, schemaversion.V5)
+}

apps/dashboard/pkg/migration/testdata/input/v5.no-op.json

@@ -0,0 +1,18 @@
+{
+    "title": "V5 No-Op Migration Test",
+    "schemaVersion": 4,
+    "panels": [
+        {
+            "id": 1,
+            "type": "singlestat"
+        },
+        {
+            "id": 2,
+            "type": "singlestat"
+        },
+        {
+            "id": 3,
+            "type": "graph"
+        }
+    ]
+}

apps/dashboard/pkg/migration/testdata/output/latest_version/v5.no-op.v42.json

@@ -0,0 +1,98 @@
+{
+  "annotations": {
+    "list": [
+      {
+        "builtIn": 1,
+        "datasource": {
+          "type": "grafana",
+          "uid": "-- Grafana --"
+        },
+        "enable": true,
+        "hide": true,
+        "iconColor": "rgba(0, 211, 255, 1)",
+        "name": "Annotations \u0026 Alerts",
+        "type": "dashboard"
+      }
+    ]
+  },
+  "editable": true,
+  "fiscalYearStartMonth": 0,
+  "graphTooltip": 0,
+  "links": [],
+  "panels": [
+    {
+      "autoMigrateFrom": "singlestat",
+      "datasource": {
+        "apiVersion": "v1",
+        "type": "prometheus",
+        "uid": "default-ds-uid"
+      },
+      "id": 1,
+      "targets": [
+        {
+          "datasource": {
+            "apiVersion": "v1",
+            "type": "prometheus",
+            "uid": "default-ds-uid"
+          },
+          "refId": "A"
+        }
+      ],
+      "type": "stat"
+    },
+    {
+      "autoMigrateFrom": "singlestat",
+      "datasource": {
+        "apiVersion": "v1",
+        "type": "prometheus",
+        "uid": "default-ds-uid"
+      },
+      "id": 2,
+      "targets": [
+        {
+          "datasource": {
+            "apiVersion": "v1",
+            "type": "prometheus",
+            "uid": "default-ds-uid"
+          },
+          "refId": "A"
+        }
+      ],
+      "type": "stat"
+    },
+    {
+      "autoMigrateFrom": "graph",
+      "datasource": {
+        "apiVersion": "v1",
+        "type": "prometheus",
+        "uid": "default-ds-uid"
+      },
+      "id": 3,
+      "targets": [
+        {
+          "datasource": {
+            "apiVersion": "v1",
+            "type": "prometheus",
+            "uid": "default-ds-uid"
+          },
+          "refId": "A"
+        }
+      ],
+      "type": "timeseries"
+    }
+  ],
+  "refresh": "",
+  "schemaVersion": 42,
+  "tags": [],
+  "templating": {
+    "list": []
+  },
+  "time": {
+    "from": "now-6h",
+    "to": "now"
+  },
+  "timepicker": {},
+  "timezone": "",
+  "title": "V5 No-Op Migration Test",
+  "weekStart": ""
+}

apps/dashboard/pkg/migration/testdata/output/single_version/v5.no-op.v5.json

@@ -0,0 +1,52 @@
+{
+  "annotations": {
+    "list": [
+      {
+        "builtIn": 1,
+        "datasource": {
+          "type": "grafana",
+          "uid": "-- Grafana --"
+        },
+        "enable": true,
+        "hide": true,
+        "iconColor": "rgba(0, 211, 255, 1)",
+        "name": "Annotations \u0026 Alerts",
+        "type": "dashboard"
+      }
+    ]
+  },
+  "editable": true,
+  "fiscalYearStartMonth": 0,
+  "graphTooltip": 0,
+  "links": [],
+  "panels": [
+    {
+      "autoMigrateFrom": "singlestat",
+      "id": 1,
+      "type": "stat"
+    },
+    {
+      "autoMigrateFrom": "singlestat",
+      "id": 2,
+      "type": "stat"
+    },
+    {
+      "autoMigrateFrom": "graph",
+      "id": 3,
+      "type": "timeseries"
+    }
+  ],
+  "schemaVersion": 5,
+  "tags": [],
+  "templating": {
+    "list": []
+  },
+  "time": {
+    "from": "now-6h",
+    "to": "now"
+  },
+  "timepicker": {},
+  "timezone": "",
+  "title": "V5 No-Op Migration Test",
+  "weekStart": ""
+}