mirror of
https://github.com/grafana/grafana.git
synced 2024-12-02 13:39:19 -06:00
100 lines
6.4 KiB
Go
100 lines
6.4 KiB
Go
package dashboards
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/grafana/grafana/pkg/models"
|
|
alertmodels "github.com/grafana/grafana/pkg/services/alerting/models"
|
|
"github.com/grafana/grafana/pkg/services/folder"
|
|
"github.com/grafana/grafana/pkg/services/quota"
|
|
)
|
|
|
|
// DashboardService is a service for operating on dashboards.
|
|
//
|
|
//go:generate mockery --name DashboardService --structname FakeDashboardService --inpackage --filename dashboard_service_mock.go
|
|
type DashboardService interface {
|
|
BuildSaveDashboardCommand(ctx context.Context, dto *SaveDashboardDTO, shouldValidateAlerts bool, validateProvisionedDashboard bool) (*SaveDashboardCommand, error)
|
|
DeleteDashboard(ctx context.Context, dashboardId int64, orgId int64) error
|
|
FindDashboards(ctx context.Context, query *models.FindPersistedDashboardsQuery) ([]DashboardSearchProjection, error)
|
|
GetDashboard(ctx context.Context, query *GetDashboardQuery) error
|
|
GetDashboardACLInfoList(ctx context.Context, query *GetDashboardACLInfoListQuery) error
|
|
GetDashboards(ctx context.Context, query *GetDashboardsQuery) error
|
|
GetDashboardTags(ctx context.Context, query *GetDashboardTagsQuery) error
|
|
GetDashboardUIDByID(ctx context.Context, query *GetDashboardRefByIDQuery) error
|
|
HasAdminPermissionInDashboardsOrFolders(ctx context.Context, query *models.HasAdminPermissionInDashboardsOrFoldersQuery) error
|
|
HasEditPermissionInFolders(ctx context.Context, query *models.HasEditPermissionInFoldersQuery) error
|
|
ImportDashboard(ctx context.Context, dto *SaveDashboardDTO) (*Dashboard, error)
|
|
MakeUserAdmin(ctx context.Context, orgID int64, userID, dashboardID int64, setViewAndEditPermissions bool) error
|
|
SaveDashboard(ctx context.Context, dto *SaveDashboardDTO, allowUiUpdate bool) (*Dashboard, error)
|
|
SearchDashboards(ctx context.Context, query *models.FindPersistedDashboardsQuery) error
|
|
UpdateDashboardACL(ctx context.Context, uid int64, items []*DashboardACL) error
|
|
DeleteACLByUser(ctx context.Context, userID int64) error
|
|
CountDashboardsInFolder(ctx context.Context, query *CountDashboardsInFolderQuery) (int64, error)
|
|
}
|
|
|
|
// PluginService is a service for operating on plugin dashboards.
|
|
type PluginService interface {
|
|
GetDashboardsByPluginID(ctx context.Context, query *GetDashboardsByPluginIDQuery) error
|
|
}
|
|
|
|
// DashboardProvisioningService is a service for operating on provisioned dashboards.
|
|
//
|
|
//go:generate mockery --name DashboardProvisioningService --structname FakeDashboardProvisioning --inpackage --filename dashboard_provisioning_mock.go
|
|
type DashboardProvisioningService interface {
|
|
DeleteOrphanedProvisionedDashboards(ctx context.Context, cmd *DeleteOrphanedProvisionedDashboardsCommand) error
|
|
DeleteProvisionedDashboard(ctx context.Context, dashboardID int64, orgID int64) error
|
|
GetProvisionedDashboardData(ctx context.Context, name string) ([]*DashboardProvisioning, error)
|
|
GetProvisionedDashboardDataByDashboardID(ctx context.Context, dashboardID int64) (*DashboardProvisioning, error)
|
|
GetProvisionedDashboardDataByDashboardUID(ctx context.Context, orgID int64, dashboardUID string) (*DashboardProvisioning, error)
|
|
SaveFolderForProvisionedDashboards(context.Context, *SaveDashboardDTO) (*Dashboard, error)
|
|
SaveProvisionedDashboard(ctx context.Context, dto *SaveDashboardDTO, provisioning *DashboardProvisioning) (*Dashboard, error)
|
|
UnprovisionDashboard(ctx context.Context, dashboardID int64) error
|
|
}
|
|
|
|
// Store is a dashboard store.
|
|
//
|
|
//go:generate mockery --name Store --structname FakeDashboardStore --inpackage --filename store_mock.go
|
|
type Store interface {
|
|
DeleteDashboard(ctx context.Context, cmd *DeleteDashboardCommand) error
|
|
DeleteOrphanedProvisionedDashboards(ctx context.Context, cmd *DeleteOrphanedProvisionedDashboardsCommand) error
|
|
FindDashboards(ctx context.Context, query *models.FindPersistedDashboardsQuery) ([]DashboardSearchProjection, error)
|
|
GetDashboard(ctx context.Context, query *GetDashboardQuery) (*Dashboard, error)
|
|
GetDashboardACLInfoList(ctx context.Context, query *GetDashboardACLInfoListQuery) error
|
|
GetDashboardUIDByID(ctx context.Context, query *GetDashboardRefByIDQuery) error
|
|
GetDashboards(ctx context.Context, query *GetDashboardsQuery) error
|
|
// GetDashboardsByPluginID retrieves dashboards identified by plugin.
|
|
GetDashboardsByPluginID(ctx context.Context, query *GetDashboardsByPluginIDQuery) error
|
|
GetDashboardTags(ctx context.Context, query *GetDashboardTagsQuery) error
|
|
GetProvisionedDashboardData(ctx context.Context, name string) ([]*DashboardProvisioning, error)
|
|
GetProvisionedDataByDashboardID(ctx context.Context, dashboardID int64) (*DashboardProvisioning, error)
|
|
GetProvisionedDataByDashboardUID(ctx context.Context, orgID int64, dashboardUID string) (*DashboardProvisioning, error)
|
|
HasAdminPermissionInDashboardsOrFolders(ctx context.Context, query *models.HasAdminPermissionInDashboardsOrFoldersQuery) error
|
|
HasEditPermissionInFolders(ctx context.Context, query *models.HasEditPermissionInFoldersQuery) error
|
|
// SaveAlerts saves dashboard alertmodels.
|
|
SaveAlerts(ctx context.Context, dashID int64, alerts []*alertmodels.Alert) error
|
|
SaveDashboard(ctx context.Context, cmd SaveDashboardCommand) (*Dashboard, error)
|
|
SaveProvisionedDashboard(ctx context.Context, cmd SaveDashboardCommand, provisioning *DashboardProvisioning) (*Dashboard, error)
|
|
UnprovisionDashboard(ctx context.Context, id int64) error
|
|
UpdateDashboardACL(ctx context.Context, uid int64, items []*DashboardACL) error
|
|
// ValidateDashboardBeforeSave validates a dashboard before save.
|
|
ValidateDashboardBeforeSave(ctx context.Context, dashboard *Dashboard, overwrite bool) (bool, error)
|
|
DeleteACLByUser(context.Context, int64) error
|
|
|
|
Count(context.Context, *quota.ScopeParameters) (*quota.Map, error)
|
|
// CountDashboardsInFolder returns the number of dashboards associated with
|
|
// the given parent folder ID.
|
|
CountDashboardsInFolder(ctx context.Context, request *CountDashboardsInFolderRequest) (int64, error)
|
|
}
|
|
|
|
// FolderStore is a folder store.
|
|
//
|
|
//go:generate mockery --name FolderStore --structname FakeFolderStore --inpackage --filename folder_store_mock.go
|
|
type FolderStore interface {
|
|
// GetFolderByTitle retrieves a folder by its title
|
|
GetFolderByTitle(ctx context.Context, orgID int64, title string) (*folder.Folder, error)
|
|
// GetFolderByUID retrieves a folder by its UID
|
|
GetFolderByUID(ctx context.Context, orgID int64, uid string) (*folder.Folder, error)
|
|
// GetFolderByID retrieves a folder by its ID
|
|
GetFolderByID(ctx context.Context, orgID int64, id int64) (*folder.Folder, error)
|
|
}
|