Provisioning: add generic version handling for dashboard export (#114691)
* feat(provisioning): add generic version handling for dashboard export - Update export job to handle any dashboard version generically (v0, v1, v2, v3, etc.) - Dynamically construct GroupVersionResource for any stored version - Cache version-specific clients for efficiency - Add comprehensive table-driven unit tests for multiple versions - Add integration test to verify version handling end-to-end - Remove unnecessary version shim from clean operation (deletion works by name) * test: add unit test for v2 dashboard version (no suffix)
This commit is contained in:
Roberto Jiménez Sánchez
@@ -104,6 +104,168 @@ func TestIntegrationProvisioning_ExportUnifiedToRepository(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestIntegrationProvisioning_ExportDashboardsWithStoredVersions(t *testing.T) {
|
||||
testutil.SkipIntegrationTestInShortMode(t)
|
||||
|
||||
helper := runGrafana(t)
|
||||
ctx := context.Background()
|
||||
|
||||
// Test table for different dashboard versions
|
||||
tests := []struct {
|
||||
name string
|
||||
file string
|
||||
createFunc func(*unstructured.Unstructured, metav1.CreateOptions) (*unstructured.Unstructured, error)
|
||||
expectedTitle string
|
||||
expectedName string
|
||||
expectedVer string
|
||||
fileName string
|
||||
}{
|
||||
{
|
||||
name: "v0alpha1",
|
||||
file: "exportunifiedtorepository/dashboard-test-v0.yaml",
|
||||
createFunc: func(dashboard *unstructured.Unstructured, opts metav1.CreateOptions) (*unstructured.Unstructured, error) {
|
||||
return helper.DashboardsV0.Resource.Create(ctx, dashboard, opts)
|
||||
},
|
||||
expectedTitle: "Test dashboard. Created at v0",
|
||||
expectedName: "test-v0",
|
||||
expectedVer: "dashboard.grafana.app/v0alpha1",
|
||||
fileName: "test-dashboard-created-at-v0.json",
|
||||
},
|
||||
{
|
||||
name: "v1beta1",
|
||||
file: "exportunifiedtorepository/dashboard-test-v1.yaml",
|
||||
createFunc: func(dashboard *unstructured.Unstructured, opts metav1.CreateOptions) (*unstructured.Unstructured, error) {
|
||||
return helper.DashboardsV1.Resource.Create(ctx, dashboard, opts)
|
||||
},
|
||||
expectedTitle: "Test dashboard. Created at v1",
|
||||
expectedName: "test-v1",
|
||||
expectedVer: "dashboard.grafana.app/v1beta1",
|
||||
fileName: "test-dashboard-created-at-v1.json",
|
||||
},
|
||||
{
|
||||
name: "v2alpha1",
|
||||
file: "exportunifiedtorepository/dashboard-test-v2alpha1.yaml",
|
||||
createFunc: func(dashboard *unstructured.Unstructured, opts metav1.CreateOptions) (*unstructured.Unstructured, error) {
|
||||
return helper.DashboardsV2alpha1.Resource.Create(ctx, dashboard, opts)
|
||||
},
|
||||
expectedTitle: "Test dashboard. Created at v2alpha1",
|
||||
expectedName: "test-v2alpha1",
|
||||
expectedVer: "dashboard.grafana.app/v2alpha1",
|
||||
fileName: "test-dashboard-created-at-v2alpha1.json",
|
||||
},
|
||||
{
|
||||
name: "v2beta1",
|
||||
file: "exportunifiedtorepository/dashboard-test-v2beta1.yaml",
|
||||
createFunc: func(dashboard *unstructured.Unstructured, opts metav1.CreateOptions) (*unstructured.Unstructured, error) {
|
||||
return helper.DashboardsV2beta1.Resource.Create(ctx, dashboard, opts)
|
||||
},
|
||||
expectedTitle: "Test dashboard. Created at v2beta1",
|
||||
expectedName: "test-v2beta1",
|
||||
expectedVer: "dashboard.grafana.app/v2beta1",
|
||||
fileName: "test-dashboard-created-at-v2beta1.json",
|
||||
},
|
||||
}
|
||||
|
||||
// Create dashboards in different versions
|
||||
for _, tt := range tests {
|
||||
dashboard := helper.LoadYAMLOrJSONFile(tt.file)
|
||||
_, err := tt.createFunc(dashboard, metav1.CreateOptions{})
|
||||
require.NoError(t, err, "should be able to create %s dashboard", tt.name)
|
||||
}
|
||||
|
||||
// Create repository
|
||||
const repo = "version-test-repository"
|
||||
testRepo := TestRepo{
|
||||
Name: repo,
|
||||
Copies: map[string]string{},
|
||||
ExpectedDashboards: len(tests),
|
||||
ExpectedFolders: 0,
|
||||
}
|
||||
helper.CreateRepo(t, testRepo)
|
||||
|
||||
// Export dashboards
|
||||
spec := provisioning.JobSpec{
|
||||
Action: provisioning.JobActionPush,
|
||||
Push: &provisioning.ExportJobOptions{
|
||||
Folder: "",
|
||||
Path: "",
|
||||
},
|
||||
}
|
||||
helper.TriggerJobAndWaitForSuccess(t, repo, spec)
|
||||
|
||||
// Verify each dashboard was exported with its original stored version
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
fpath := filepath.Join(helper.ProvisioningPath, tt.fileName)
|
||||
//nolint:gosec // we are ok with reading files in testdata
|
||||
body, err := os.ReadFile(fpath)
|
||||
require.NoError(t, err, "exported file was not created at path %s", fpath)
|
||||
|
||||
obj := map[string]any{}
|
||||
err = json.Unmarshal(body, &obj)
|
||||
require.NoError(t, err, "exported file not json %s", fpath)
|
||||
|
||||
// Verify API version matches the stored version
|
||||
val, _, err := unstructured.NestedString(obj, "apiVersion")
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tt.expectedVer, val, "exported dashboard should have original stored version")
|
||||
|
||||
// Verify title
|
||||
val, _, err = unstructured.NestedString(obj, "spec", "title")
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tt.expectedTitle, val)
|
||||
|
||||
// Verify name
|
||||
val, _, err = unstructured.NestedString(obj, "metadata", "name")
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, tt.expectedName, val)
|
||||
|
||||
// Verify no status field in exported file
|
||||
require.Nil(t, obj["status"], "exported file should not have status element")
|
||||
})
|
||||
}
|
||||
|
||||
// Verify that listing via v1 API shows storedVersion when conversion fails
|
||||
// This tests the generic version handling logic
|
||||
dashboards, err := helper.DashboardsV1.Resource.List(ctx, metav1.ListOptions{})
|
||||
require.NoError(t, err, "should be able to list dashboards via v1 API")
|
||||
|
||||
for _, dashboard := range dashboards.Items {
|
||||
// Check if there's a storedVersion in conversion status
|
||||
status, found, _ := unstructured.NestedMap(dashboard.Object, "status")
|
||||
if found && status != nil {
|
||||
conversion, convFound, _ := unstructured.NestedMap(status, "conversion")
|
||||
if convFound && conversion != nil {
|
||||
storedVersion, storedFound, _ := unstructured.NestedString(conversion, "storedVersion")
|
||||
if storedFound && storedVersion != "" {
|
||||
// Verify that the storedVersion is preserved during export
|
||||
// by checking the exported file has the correct version
|
||||
dashboardName := dashboard.GetName()
|
||||
for _, tt := range tests {
|
||||
if tt.expectedName == dashboardName {
|
||||
fpath := filepath.Join(helper.ProvisioningPath, tt.fileName)
|
||||
//nolint:gosec // we are ok with reading files in testdata
|
||||
body, err := os.ReadFile(fpath)
|
||||
require.NoError(t, err, "exported file should exist for %s", dashboardName)
|
||||
|
||||
obj := map[string]any{}
|
||||
err = json.Unmarshal(body, &obj)
|
||||
require.NoError(t, err)
|
||||
|
||||
exportedVersion, _, err := unstructured.NestedString(obj, "apiVersion")
|
||||
require.NoError(t, err)
|
||||
// Extract version from apiVersion (e.g., "dashboard.grafana.app/v2alpha1" -> "v2alpha1")
|
||||
expectedVersion := "dashboard.grafana.app/" + storedVersion
|
||||
require.Equal(t, expectedVersion, exportedVersion,
|
||||
"exported version should match storedVersion %s for dashboard %s", storedVersion, dashboardName)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestIntegrationProvisioning_SecondRepositoryOnlyExportsNewDashboards(t *testing.T) {
|
||||
testutil.SkipIntegrationTestInShortMode(t)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user