mirror of
https://github.com/grafana/grafana.git
synced 2025-02-20 11:48:34 -06:00
706b301285
* feat(nested folders): add CountDashboardsInFolder This commit adds a new method to the Dashboard service and stores: CountDashboardsInFolder. The command struct takes a folderUID, but the store implementation still depends on the parent folder ID. This is temporary; eventually we will replace all references to FolderIDs (associated with Dashboards) with folder UIDs. There are some unfortunate additional test changes that were necessary after generating the service & store mocks; it looks like that hasn't been generated since the last change(s). * more test updates * don't forget the service test * that didn't end up used, so bye for now * agree to disagree with the linter
519 lines
16 KiB
Go
519 lines
16 KiB
Go
package dashboards
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"path/filepath"
|
|
"runtime"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/mock"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/grafana/grafana/pkg/infra/log"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/services/dashboards"
|
|
"github.com/grafana/grafana/pkg/util"
|
|
)
|
|
|
|
const (
|
|
defaultDashboards = "testdata/test-dashboards/folder-one"
|
|
brokenDashboards = "testdata/test-dashboards/broken-dashboards"
|
|
oneDashboard = "testdata/test-dashboards/one-dashboard"
|
|
containingID = "testdata/test-dashboards/containing-id"
|
|
unprovision = "testdata/test-dashboards/unprovision"
|
|
foldersFromFilesStructure = "testdata/test-dashboards/folders-from-files-structure"
|
|
configName = "default"
|
|
)
|
|
|
|
func TestCreatingNewDashboardFileReader(t *testing.T) {
|
|
setup := func() *config {
|
|
return &config{
|
|
Name: "Default",
|
|
Type: "file",
|
|
OrgID: 1,
|
|
Folder: "",
|
|
Options: map[string]interface{}{},
|
|
}
|
|
}
|
|
|
|
t.Run("using path parameter", func(t *testing.T) {
|
|
cfg := setup()
|
|
cfg.Options["path"] = defaultDashboards
|
|
reader, err := NewDashboardFileReader(cfg, log.New("test-logger"), nil, nil)
|
|
require.NoError(t, err)
|
|
require.NotEqual(t, reader.Path, "")
|
|
})
|
|
|
|
t.Run("using folder as options", func(t *testing.T) {
|
|
cfg := setup()
|
|
cfg.Options["folder"] = defaultDashboards
|
|
reader, err := NewDashboardFileReader(cfg, log.New("test-logger"), nil, nil)
|
|
require.NoError(t, err)
|
|
require.NotEqual(t, reader.Path, "")
|
|
})
|
|
|
|
t.Run("using foldersFromFilesStructure as options", func(t *testing.T) {
|
|
cfg := setup()
|
|
cfg.Options["path"] = foldersFromFilesStructure
|
|
cfg.Options["foldersFromFilesStructure"] = true
|
|
reader, err := NewDashboardFileReader(cfg, log.New("test-logger"), nil, nil)
|
|
require.NoError(t, err)
|
|
require.NotEqual(t, reader.Path, "")
|
|
})
|
|
|
|
t.Run("using full path", func(t *testing.T) {
|
|
cfg := setup()
|
|
fullPath := "/var/lib/grafana/dashboards"
|
|
if runtime.GOOS == "windows" {
|
|
fullPath = `c:\var\lib\grafana`
|
|
}
|
|
|
|
cfg.Options["folder"] = fullPath
|
|
reader, err := NewDashboardFileReader(cfg, log.New("test-logger"), nil, nil)
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, reader.Path, fullPath)
|
|
require.True(t, filepath.IsAbs(reader.Path))
|
|
})
|
|
|
|
t.Run("using relative path", func(t *testing.T) {
|
|
cfg := setup()
|
|
cfg.Options["folder"] = defaultDashboards
|
|
reader, err := NewDashboardFileReader(cfg, log.New("test-logger"), nil, nil)
|
|
require.NoError(t, err)
|
|
|
|
resolvedPath := reader.resolvedPath()
|
|
require.True(t, filepath.IsAbs(resolvedPath))
|
|
})
|
|
}
|
|
|
|
func TestDashboardFileReader(t *testing.T) {
|
|
logger := log.New("test-logger")
|
|
cfg := &config{}
|
|
|
|
fakeService := &dashboards.FakeDashboardProvisioning{}
|
|
defer fakeService.AssertExpectations(t)
|
|
fakeStore := &fakeDashboardStore{}
|
|
setup := func() {
|
|
cfg = &config{
|
|
Name: configName,
|
|
Type: "file",
|
|
OrgID: 1,
|
|
Folder: "",
|
|
Options: map[string]interface{}{},
|
|
}
|
|
}
|
|
|
|
t.Run("Reading dashboards from disk", func(t *testing.T) {
|
|
t.Run("Can read default dashboard", func(t *testing.T) {
|
|
setup()
|
|
cfg.Options["path"] = defaultDashboards
|
|
cfg.Folder = "Team A"
|
|
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, configName).Return(nil, nil).Once()
|
|
fakeService.On("SaveFolderForProvisionedDashboards", mock.Anything, mock.Anything).Return(&models.Dashboard{Id: 1}, nil).Once()
|
|
fakeService.On("SaveProvisionedDashboard", mock.Anything, mock.Anything, mock.Anything).Return(&models.Dashboard{Id: 2}, nil).Times(2)
|
|
|
|
reader, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
reader.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("Can read default dashboard and replace old version in database", func(t *testing.T) {
|
|
setup()
|
|
cfg.Options["path"] = oneDashboard
|
|
|
|
inserted := 0
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, configName).Return(nil, nil).Once()
|
|
fakeService.On("SaveProvisionedDashboard", mock.Anything, mock.Anything, mock.Anything).
|
|
Return(&models.Dashboard{}, nil).Once().
|
|
Run(func(args mock.Arguments) {
|
|
inserted++
|
|
})
|
|
|
|
reader, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
reader.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
|
|
assert.Equal(t, inserted, 1)
|
|
})
|
|
|
|
t.Run("Dashboard with older timestamp and the same checksum will not replace imported dashboard", func(t *testing.T) {
|
|
setup()
|
|
cfg.Options["path"] = oneDashboard
|
|
absPath, err := filepath.Abs(oneDashboard + "/dashboard1.json")
|
|
require.NoError(t, err)
|
|
stat, err := os.Stat(oneDashboard + "/dashboard1.json")
|
|
require.NoError(t, err)
|
|
file, err := os.Open(filepath.Clean(absPath))
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() {
|
|
_ = file.Close()
|
|
})
|
|
|
|
checksum, err := util.Md5Sum(file)
|
|
require.NoError(t, err)
|
|
|
|
provisionedDashboard := []*models.DashboardProvisioning{
|
|
{
|
|
Name: "Default",
|
|
ExternalId: absPath,
|
|
Updated: stat.ModTime().AddDate(0, 0, +1).Unix(),
|
|
CheckSum: checksum,
|
|
},
|
|
}
|
|
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, configName).Return(provisionedDashboard, nil).Once()
|
|
|
|
reader, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
reader.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("Dashboard with older timestamp and different checksum will replace imported dashboard", func(t *testing.T) {
|
|
setup()
|
|
cfg.Options["path"] = oneDashboard
|
|
absPath, err := filepath.Abs(oneDashboard + "/dashboard1.json")
|
|
require.NoError(t, err)
|
|
stat, err := os.Stat(oneDashboard + "/dashboard1.json")
|
|
require.NoError(t, err)
|
|
|
|
provisionedDashboard := []*models.DashboardProvisioning{
|
|
{
|
|
Name: "Default",
|
|
ExternalId: absPath,
|
|
Updated: stat.ModTime().AddDate(0, 0, +1).Unix(),
|
|
CheckSum: "fakechecksum",
|
|
},
|
|
}
|
|
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, configName).Return(provisionedDashboard, nil).Once()
|
|
fakeService.On("SaveProvisionedDashboard", mock.Anything, mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil).Once()
|
|
|
|
reader, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
reader.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("Dashboard with newer timestamp and the same checksum will not replace imported dashboard", func(t *testing.T) {
|
|
setup()
|
|
cfg.Options["path"] = oneDashboard
|
|
absPath, err := filepath.Abs(oneDashboard + "/dashboard1.json")
|
|
require.NoError(t, err)
|
|
stat, err := os.Stat(oneDashboard + "/dashboard1.json")
|
|
require.NoError(t, err)
|
|
file, err := os.Open(filepath.Clean(absPath))
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() {
|
|
_ = file.Close()
|
|
})
|
|
|
|
checksum, err := util.Md5Sum(file)
|
|
require.NoError(t, err)
|
|
|
|
provisionedDashboard := []*models.DashboardProvisioning{
|
|
{
|
|
Name: "Default",
|
|
ExternalId: absPath,
|
|
Updated: stat.ModTime().AddDate(0, 0, -1).Unix(),
|
|
CheckSum: checksum,
|
|
},
|
|
}
|
|
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, configName).Return(provisionedDashboard, nil).Once()
|
|
|
|
reader, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
reader.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("Dashboard with newer timestamp and different checksum should replace imported dashboard", func(t *testing.T) {
|
|
setup()
|
|
cfg.Options["path"] = oneDashboard
|
|
absPath, err := filepath.Abs(oneDashboard + "/dashboard1.json")
|
|
require.NoError(t, err)
|
|
stat, err := os.Stat(oneDashboard + "/dashboard1.json")
|
|
require.NoError(t, err)
|
|
|
|
provisionedDashboard := []*models.DashboardProvisioning{
|
|
{
|
|
Name: "Default",
|
|
ExternalId: absPath,
|
|
Updated: stat.ModTime().AddDate(0, 0, -1).Unix(),
|
|
CheckSum: "fakechecksum",
|
|
},
|
|
}
|
|
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, configName).Return(provisionedDashboard, nil).Once()
|
|
fakeService.On("SaveProvisionedDashboard", mock.Anything, mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil).Once()
|
|
|
|
reader, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
reader.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("Overrides id from dashboard.json files", func(t *testing.T) {
|
|
setup()
|
|
cfg.Options["path"] = containingID
|
|
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, configName).Return(nil, nil).Once()
|
|
fakeService.On("SaveProvisionedDashboard", mock.Anything, mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil).Once()
|
|
|
|
reader, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
reader.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("Get folder from files structure", func(t *testing.T) {
|
|
setup()
|
|
cfg.Options["path"] = foldersFromFilesStructure
|
|
cfg.Options["foldersFromFilesStructure"] = true
|
|
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, configName).Return(nil, nil).Once()
|
|
fakeService.On("SaveFolderForProvisionedDashboards", mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil).Times(2)
|
|
fakeService.On("SaveProvisionedDashboard", mock.Anything, mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil).Times(3)
|
|
|
|
reader, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
reader.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("Invalid configuration should return error", func(t *testing.T) {
|
|
setup()
|
|
cfg := &config{
|
|
Name: "Default",
|
|
Type: "file",
|
|
OrgID: 1,
|
|
Folder: "",
|
|
}
|
|
|
|
_, err := NewDashboardFileReader(cfg, logger, nil, nil)
|
|
require.NotNil(t, err)
|
|
})
|
|
|
|
t.Run("Broken dashboards should not cause error", func(t *testing.T) {
|
|
setup()
|
|
cfg.Options["path"] = brokenDashboards
|
|
|
|
_, err := NewDashboardFileReader(cfg, logger, nil, nil)
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("Two dashboard providers should be able to provisioned the same dashboard without uid", func(t *testing.T) {
|
|
setup()
|
|
cfg1 := &config{Name: "1", Type: "file", OrgID: 1, Folder: "f1", Options: map[string]interface{}{"path": containingID}}
|
|
cfg2 := &config{Name: "2", Type: "file", OrgID: 1, Folder: "f2", Options: map[string]interface{}{"path": containingID}}
|
|
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, mock.AnythingOfType("string")).Return(nil, nil).Times(2)
|
|
fakeService.On("SaveFolderForProvisionedDashboards", mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil).Times(2)
|
|
fakeService.On("SaveProvisionedDashboard", mock.Anything, mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil).Times(2)
|
|
|
|
reader1, err := NewDashboardFileReader(cfg1, logger, nil, fakeStore)
|
|
reader1.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader1.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
|
|
reader2, err := NewDashboardFileReader(cfg2, logger, nil, fakeStore)
|
|
reader2.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader2.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
})
|
|
})
|
|
|
|
t.Run("Should not create new folder if folder name is missing", func(t *testing.T) {
|
|
setup()
|
|
cfg := &config{
|
|
Name: "Default",
|
|
Type: "file",
|
|
OrgID: 1,
|
|
Folder: "",
|
|
Options: map[string]interface{}{
|
|
"folder": defaultDashboards,
|
|
},
|
|
}
|
|
r, err := NewDashboardFileReader(cfg, logger, nil, nil)
|
|
require.NoError(t, err)
|
|
|
|
_, err = r.getOrCreateFolderID(context.Background(), cfg, fakeService, cfg.Folder)
|
|
require.Equal(t, err, ErrFolderNameMissing)
|
|
})
|
|
|
|
t.Run("can get or Create dashboard folder", func(t *testing.T) {
|
|
setup()
|
|
cfg := &config{
|
|
Name: "Default",
|
|
Type: "file",
|
|
OrgID: 1,
|
|
Folder: "TEAM A",
|
|
Options: map[string]interface{}{
|
|
"folder": defaultDashboards,
|
|
},
|
|
}
|
|
fakeService.On("SaveFolderForProvisionedDashboards", mock.Anything, mock.Anything).Return(&models.Dashboard{Id: 1}, nil).Once()
|
|
|
|
r, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
require.NoError(t, err)
|
|
|
|
_, err = r.getOrCreateFolderID(context.Background(), cfg, fakeService, cfg.Folder)
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("should not create dashboard folder with uid general", func(t *testing.T) {
|
|
setup()
|
|
cfg := &config{
|
|
Name: "DefaultB",
|
|
Type: "file",
|
|
OrgID: 1,
|
|
Folder: "TEAM B",
|
|
FolderUID: "general",
|
|
Options: map[string]interface{}{
|
|
"folder": defaultDashboards,
|
|
},
|
|
}
|
|
|
|
r, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
require.NoError(t, err)
|
|
|
|
_, err = r.getOrCreateFolderID(context.Background(), cfg, fakeService, cfg.Folder)
|
|
require.ErrorIs(t, err, dashboards.ErrFolderInvalidUID)
|
|
})
|
|
|
|
t.Run("Walking the folder with dashboards", func(t *testing.T) {
|
|
setup()
|
|
noFiles := map[string]os.FileInfo{}
|
|
|
|
t.Run("should skip dirs that starts with .", func(t *testing.T) {
|
|
shouldSkip := createWalkFn(noFiles)("path", &FakeFileInfo{isDirectory: true, name: ".folder"}, nil)
|
|
require.Equal(t, shouldSkip, filepath.SkipDir)
|
|
})
|
|
|
|
t.Run("should keep walking if file is not .json", func(t *testing.T) {
|
|
shouldSkip := createWalkFn(noFiles)("path", &FakeFileInfo{isDirectory: true, name: "folder"}, nil)
|
|
require.Nil(t, shouldSkip)
|
|
})
|
|
})
|
|
|
|
t.Run("Given missing dashboard file", func(t *testing.T) {
|
|
absPath1, err := filepath.Abs(unprovision + "/dashboard1.json")
|
|
require.NoError(t, err)
|
|
// This one does not exist on disk, simulating a deleted file
|
|
absPath2, err := filepath.Abs(unprovision + "/dashboard2.json")
|
|
require.NoError(t, err)
|
|
|
|
provisionedDashboard := []*models.DashboardProvisioning{
|
|
{DashboardId: 1, Name: "Default", ExternalId: absPath1},
|
|
{DashboardId: 2, Name: "Default", ExternalId: absPath2},
|
|
}
|
|
|
|
setupFakeService := func() {
|
|
setup()
|
|
cfg = &config{
|
|
Name: configName,
|
|
Type: "file",
|
|
OrgID: 1,
|
|
Options: map[string]interface{}{
|
|
"folder": unprovision,
|
|
},
|
|
}
|
|
}
|
|
|
|
t.Run("Missing dashboard should be unprovisioned if DisableDeletion = true", func(t *testing.T) {
|
|
setupFakeService()
|
|
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, configName).Return(provisionedDashboard, nil).Once()
|
|
fakeService.On("UnprovisionDashboard", mock.Anything, mock.Anything).Return(nil).Once()
|
|
fakeService.On("SaveProvisionedDashboard", mock.Anything, mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil).Once()
|
|
|
|
cfg.DisableDeletion = true
|
|
|
|
reader, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
require.NoError(t, err)
|
|
reader.dashboardProvisioningService = fakeService
|
|
|
|
err = reader.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("Missing dashboard should be deleted if DisableDeletion = false", func(t *testing.T) {
|
|
setupFakeService()
|
|
|
|
fakeService.On("GetProvisionedDashboardData", mock.Anything, configName).Return(provisionedDashboard, nil).Once()
|
|
fakeService.On("SaveProvisionedDashboard", mock.Anything, mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil).Once()
|
|
fakeService.On("DeleteProvisionedDashboard", mock.Anything, mock.Anything, mock.Anything).Return(nil).Once()
|
|
|
|
reader, err := NewDashboardFileReader(cfg, logger, nil, fakeStore)
|
|
reader.dashboardProvisioningService = fakeService
|
|
require.NoError(t, err)
|
|
|
|
err = reader.walkDisk(context.Background())
|
|
require.NoError(t, err)
|
|
})
|
|
})
|
|
}
|
|
|
|
type FakeFileInfo struct {
|
|
isDirectory bool
|
|
name string
|
|
}
|
|
|
|
func (ffi *FakeFileInfo) IsDir() bool {
|
|
return ffi.isDirectory
|
|
}
|
|
|
|
func (ffi FakeFileInfo) Size() int64 {
|
|
return 1
|
|
}
|
|
|
|
func (ffi FakeFileInfo) Mode() os.FileMode {
|
|
return 0777
|
|
}
|
|
|
|
func (ffi FakeFileInfo) Name() string {
|
|
return ffi.name
|
|
}
|
|
|
|
func (ffi FakeFileInfo) ModTime() time.Time {
|
|
return time.Time{}
|
|
}
|
|
|
|
func (ffi FakeFileInfo) Sys() interface{} {
|
|
return nil
|
|
}
|
|
|
|
type fakeDashboardStore struct{}
|
|
|
|
func (fds *fakeDashboardStore) GetDashboard(_ context.Context, _ *models.GetDashboardQuery) error {
|
|
return dashboards.ErrDashboardNotFound
|
|
}
|