{ - data: PanelData; + data?: PanelData; pluginId: string; title: string; options?: Partial
;
diff --git a/packages/grafana-runtime/src/utils/PublicDashboardDataSource.test.ts b/packages/grafana-runtime/src/utils/PublicDashboardDataSource.test.ts
index c86ee702e7c..f72460483f8 100644
--- a/packages/grafana-runtime/src/utils/PublicDashboardDataSource.test.ts
+++ b/packages/grafana-runtime/src/utils/PublicDashboardDataSource.test.ts
@@ -1,9 +1,14 @@
import { of } from 'rxjs';
import { BackendSrv, BackendSrvRequest } from 'src/services';
-import { DataQueryRequest, DataSourceRef } from '@grafana/data';
+import { DataQueryRequest, DataSourceInstanceSettings, DataSourceRef } from '@grafana/data';
-import { PublicDashboardDataSource } from '../../../../public/app/features/dashboard/services/PublicDashboardDataSource';
+import {
+ PUBLIC_DATASOURCE,
+ PublicDashboardDataSource,
+} from '../../../../public/app/features/dashboard/services/PublicDashboardDataSource';
+
+import { DataSourceWithBackend } from './DataSourceWithBackend';
const mockDatasourceRequest = jest.fn();
@@ -28,7 +33,7 @@ describe('PublicDashboardDatasource', () => {
mockDatasourceRequest.mockReset();
mockDatasourceRequest.mockReturnValue(Promise.resolve({}));
- const ds = new PublicDashboardDataSource();
+ const ds = new PublicDashboardDataSource('public');
const panelId = 1;
const publicDashboardAccessToken = 'abc123';
@@ -47,4 +52,27 @@ describe('PublicDashboardDatasource', () => {
`/api/public/dashboards/${publicDashboardAccessToken}/panels/${panelId}/query`
);
});
+
+ test('returns public datasource uid when datasource passed in is null', () => {
+ let ds = new PublicDashboardDataSource(null);
+ expect(ds.uid).toBe(PUBLIC_DATASOURCE);
+ });
+
+ test('returns datasource when datasource passed in is a string', () => {
+ let ds = new PublicDashboardDataSource('theDatasourceUid');
+ expect(ds.uid).toBe('theDatasourceUid');
+ });
+
+ test('returns datasource uid when datasource passed in is a DataSourceRef implementation', () => {
+ const datasource = { type: 'datasource', uid: 'abc123' };
+ let ds = new PublicDashboardDataSource(datasource);
+ expect(ds.uid).toBe('abc123');
+ });
+
+ test('returns datasource uid when datasource passed in is a DatasourceApi instance', () => {
+ const settings: DataSourceInstanceSettings = { id: 1, uid: 'abc123' } as DataSourceInstanceSettings;
+ const datasource = new DataSourceWithBackend(settings);
+ let ds = new PublicDashboardDataSource(datasource);
+ expect(ds.uid).toBe('abc123');
+ });
});
diff --git a/packages/grafana-toolkit/docker/grafana-plugin-ci-e2e/scripts/deploy.sh b/packages/grafana-toolkit/docker/grafana-plugin-ci-e2e/scripts/deploy.sh
index e5120dc6eaa..b4aa39c685c 100755
--- a/packages/grafana-toolkit/docker/grafana-plugin-ci-e2e/scripts/deploy.sh
+++ b/packages/grafana-toolkit/docker/grafana-plugin-ci-e2e/scripts/deploy.sh
@@ -41,7 +41,7 @@ chmod 755 /usr/local/bin/golangci-lint
# Install code climate
get_file "https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64" \
"/usr/local/bin/cc-test-reporter" \
- "9fbe34cd207924d8f51ac0f3ffa690df4169e055cd7134a2370f6650f5b356e1"
+ "9e6c3e628b1258aefbc6e3550438a691abb0d1924d63c038881031d3d343c7d0"
chmod 755 /usr/local/bin/cc-test-reporter
wget -O /usr/local/bin/grabpl "https://grafana-downloads.storage.googleapis.com/grafana-build-pipeline/v2.9.27/grabpl"
diff --git a/packages/grafana-ui/src/components/Button/Button.tsx b/packages/grafana-ui/src/components/Button/Button.tsx
index 2479687518a..bce87b5a739 100644
--- a/packages/grafana-ui/src/components/Button/Button.tsx
+++ b/packages/grafana-ui/src/components/Button/Button.tsx
@@ -9,6 +9,7 @@ import { IconName } from '../../types/icon';
import { ComponentSize } from '../../types/size';
import { getPropertiesForButtonSize } from '../Forms/commonStyles';
import { Icon } from '../Icon/Icon';
+import { PopoverContent, Tooltip, TooltipPlacement } from '../Tooltip';
export type ButtonVariant = 'primary' | 'secondary' | 'destructive';
export const allButtonVariants: ButtonVariant[] = ['primary', 'secondary', 'destructive'];
@@ -24,6 +25,10 @@ type CommonProps = {
children?: React.ReactNode;
fullWidth?: boolean;
type?: string;
+ /** Tooltip content to display on hover */
+ tooltip?: PopoverContent;
+ /** Position of the tooltip */
+ tooltipPlacement?: TooltipPlacement;
};
export type ButtonProps = CommonProps & ButtonHTMLAttributes
- {hasLinks &&
diff --git a/packages/grafana-ui/src/components/Table/JSONViewCell.tsx b/packages/grafana-ui/src/components/Table/JSONViewCell.tsx
index 029dd2abd2d..70c73fce64e 100644
--- a/packages/grafana-ui/src/components/Table/JSONViewCell.tsx
+++ b/packages/grafana-ui/src/components/Table/JSONViewCell.tsx
@@ -27,7 +27,7 @@ export function JSONViewCell(props: TableCellProps): JSX.Element {
displayValue = JSON.stringify(value, null, ' ');
}
- const hasLinks = getCellLinks(field, row)?.length;
+ const hasLinks = Boolean(getCellLinks(field, row)?.length);
return (
diff --git a/packages/grafana-ui/src/components/Table/styles.ts b/packages/grafana-ui/src/components/Table/styles.ts
index 7bb9d5b5b21..bc7261316c2 100644
--- a/packages/grafana-ui/src/components/Table/styles.ts
+++ b/packages/grafana-ui/src/components/Table/styles.ts
@@ -165,7 +165,6 @@ export const getTableStyles = (theme: GrafanaTheme2) => {
imageCellLink: css`
cursor: pointer;
overflow: hidden;
- width: 100%;
height: 100%;
`,
headerFilter: css`
diff --git a/packages/grafana-ui/src/components/Tabs/VerticalTab.tsx b/packages/grafana-ui/src/components/Tabs/VerticalTab.tsx
new file mode 100644
index 00000000000..c1fdeccff2b
--- /dev/null
+++ b/packages/grafana-ui/src/components/Tabs/VerticalTab.tsx
@@ -0,0 +1,96 @@
+import { css, cx } from '@emotion/css';
+import React from 'react';
+
+import { GrafanaTheme2 } from '@grafana/data';
+import { selectors } from '@grafana/e2e-selectors';
+
+import { useStyles2 } from '../../themes/ThemeContext';
+import { Icon } from '../Icon/Icon';
+
+import { Counter } from './Counter';
+import { TabProps } from './Tab';
+
+export const VerticalTab = React.forwardRef
diff --git a/packages/jaeger-ui-components/src/TraceTimelineViewer/SpanDetail/index.test.js b/packages/jaeger-ui-components/src/TraceTimelineViewer/SpanDetail/index.test.js
index e13a3550f97..b9423169915 100644
--- a/packages/jaeger-ui-components/src/TraceTimelineViewer/SpanDetail/index.test.js
+++ b/packages/jaeger-ui-components/src/TraceTimelineViewer/SpanDetail/index.test.js
@@ -146,14 +146,14 @@ describe('
+
+ );
+}
+
+const getStyles = (theme: GrafanaTheme) => ({
+ infoText: css`
+ label: infoText;
+ padding-bottom: ${theme.spacing.md};
+ color: ${theme.colors.textSemiWeak};
+ `,
+
+ row: css`
+ label: row;
+ align-items: baseline;
+ `,
+});
diff --git a/packages/jaeger-ui-components/src/types/index.tsx b/packages/jaeger-ui-components/src/types/index.tsx
index 9f1aa8d9115..a491bb9df8b 100644
--- a/packages/jaeger-ui-components/src/types/index.tsx
+++ b/packages/jaeger-ui-components/src/types/index.tsx
@@ -13,6 +13,7 @@
// limitations under the License.
export { TraceSpan, TraceResponse, Trace, TraceProcess, TraceKeyValuePair, TraceLink } from './trace';
-export { SpanLinkFunc, SpanLinkDef } from './links';
+export { SpanBarOptions, SpanBarOptionsData } from '../settings/SpanBarSettings';
export { default as TTraceTimeline } from './TTraceTimeline';
export { default as TNil } from './TNil';
+export { SpanLinkFunc, SpanLinkDef } from './links';
diff --git a/packaging/docker/Dockerfile b/packaging/docker/Dockerfile
index b9efa36aeea..2b88967dec7 100644
--- a/packaging/docker/Dockerfile
+++ b/packaging/docker/Dockerfile
@@ -35,13 +35,13 @@ RUN apk add --no-cache openssl --repository=http://dl-cdn.alpinelinux.org/alpine
RUN if [ `arch` = "x86_64" ]; then \
apk add --no-cache libaio libnsl && \
ln -s /usr/lib/libnsl.so.2 /usr/lib/libnsl.so.1 && \
- wget https://github.com/sgerrand/alpine-pkg-glibc/releases/download/2.30-r0/glibc-2.30-r0.apk \
- -O /tmp/glibc-2.30-r0.apk && \
- wget https://github.com/sgerrand/alpine-pkg-glibc/releases/download/2.30-r0/glibc-bin-2.30-r0.apk \
- -O /tmp/glibc-bin-2.30-r0.apk && \
- apk add --no-cache --allow-untrusted /tmp/glibc-2.30-r0.apk /tmp/glibc-bin-2.30-r0.apk && \
- rm -f /tmp/glibc-2.30-r0.apk && \
- rm -f /tmp/glibc-bin-2.30-r0.apk && \
+ wget https://github.com/sgerrand/alpine-pkg-glibc/releases/download/2.35-r0/glibc-2.35-r0.apk \
+ -O /tmp/glibc-2.35-r0.apk && \
+ wget https://github.com/sgerrand/alpine-pkg-glibc/releases/download/2.35-r0/glibc-bin-2.35-r0.apk \
+ -O /tmp/glibc-bin-2.35-r0.apk && \
+ apk add --no-cache --allow-untrusted /tmp/glibc-2.35-r0.apk /tmp/glibc-bin-2.35-r0.apk && \
+ rm -f /tmp/glibc-2.35-r0.apk && \
+ rm -f /tmp/glibc-bin-2.35-r0.apk && \
rm -f /lib/ld-linux-x86-64.so.2 && \
rm -f /etc/ld.so.cache; \
fi
diff --git a/packaging/docker/README.md b/packaging/docker/README.md
index ea592592fce..d2b1a889262 100644
--- a/packaging/docker/README.md
+++ b/packaging/docker/README.md
@@ -16,6 +16,10 @@ Further documentation can be found at http://docs.grafana.org/installation/docke
## Changelog
+### v9.0.3
+
+- Upgraded glibc version to glibc [2.35](https://sourceware.org/pipermail/libc-alpha/2022-February/136040.html) [#51107](https://github.com/grafana/grafana/pull/51107/files)
+
### v8.3.0-beta2
- Our Alpine based images have been upgraded to Alpine [3.14.3](https://alpinelinux.org/posts/Alpine-3.14.3-released.html) [#41922](https://github.com/grafana/grafana/pull/41922) [@hairyhenderson](https://github.com/hairyhenderson)
diff --git a/pkg/api/accesscontrol.go b/pkg/api/accesscontrol.go
index f834d307068..b750ab71410 100644
--- a/pkg/api/accesscontrol.go
+++ b/pkg/api/accesscontrol.go
@@ -223,11 +223,12 @@ func (hs *HTTPServer) declareFixedRoles() error {
Role: ac.RoleDTO{
Name: "fixed:teams:creator",
DisplayName: "Team creator",
- Description: "Create teams and read organisation users (required to manage the created teams).",
+ Description: "Create teams and read organisation users and service accounts (required to manage the created teams).",
Group: "Teams",
Permissions: []ac.Permission{
{Action: ac.ActionTeamsCreate},
{Action: ac.ActionOrgUsersRead, Scope: ac.ScopeUsersAll},
+ {Action: serviceaccounts.ActionRead, Scope: serviceaccounts.ScopeAll},
},
},
Grants: teamCreatorGrants,
diff --git a/pkg/api/annotations.go b/pkg/api/annotations.go
index 492b87af29b..894f4382ead 100644
--- a/pkg/api/annotations.go
+++ b/pkg/api/annotations.go
@@ -53,7 +53,7 @@ func (hs *HTTPServer) GetAnnotations(c *models.ReqContext) response.Response {
item.DashboardUID = val
} else {
query := models.GetDashboardQuery{Id: item.DashboardId, OrgId: c.OrgId}
- err := hs.dashboardService.GetDashboard(c.Req.Context(), &query)
+ err := hs.DashboardService.GetDashboard(c.Req.Context(), &query)
if err == nil && query.Result != nil {
item.DashboardUID = &query.Result.Uid
dashboardCache[item.DashboardId] = &query.Result.Uid
@@ -82,7 +82,7 @@ func (hs *HTTPServer) PostAnnotation(c *models.ReqContext) response.Response {
// overwrite dashboardId when dashboardUID is not empty
if cmd.DashboardUID != "" {
query := models.GetDashboardQuery{OrgId: c.OrgId, Uid: cmd.DashboardUID}
- err := hs.dashboardService.GetDashboard(c.Req.Context(), &query)
+ err := hs.DashboardService.GetDashboard(c.Req.Context(), &query)
if err == nil {
cmd.DashboardId = query.Result.Id
}
@@ -291,7 +291,7 @@ func (hs *HTTPServer) MassDeleteAnnotations(c *models.ReqContext) response.Respo
if cmd.DashboardUID != "" {
query := models.GetDashboardQuery{OrgId: c.OrgId, Uid: cmd.DashboardUID}
- err := hs.dashboardService.GetDashboard(c.Req.Context(), &query)
+ err := hs.DashboardService.GetDashboard(c.Req.Context(), &query)
if err == nil {
cmd.DashboardId = query.Result.Id
}
diff --git a/pkg/api/annotations_test.go b/pkg/api/annotations_test.go
index 8b97423c59d..c2bbd3baaeb 100644
--- a/pkg/api/annotations_test.go
+++ b/pkg/api/annotations_test.go
@@ -343,7 +343,7 @@ func postAnnotationScenario(t *testing.T, desc string, url string, routePattern
t.Run(fmt.Sprintf("%s %s", desc, url), func(t *testing.T) {
hs := setupSimpleHTTPServer(nil)
hs.SQLStore = store
- hs.dashboardService = dashSvc
+ hs.DashboardService = dashSvc
sc := setupScenarioContext(t, url)
sc.defaultHandler = routing.Wrap(func(c *models.ReqContext) response.Response {
@@ -428,7 +428,7 @@ func deleteAnnotationsScenario(t *testing.T, desc string, url string, routePatte
t.Run(fmt.Sprintf("%s %s", desc, url), func(t *testing.T) {
hs := setupSimpleHTTPServer(nil)
hs.SQLStore = store
- hs.dashboardService = dashSvc
+ hs.DashboardService = dashSvc
sc := setupScenarioContext(t, url)
sc.defaultHandler = routing.Wrap(func(c *models.ReqContext) response.Response {
diff --git a/pkg/api/api.go b/pkg/api/api.go
index 3d0c0279717..df4aaf68295 100644
--- a/pkg/api/api.go
+++ b/pkg/api/api.go
@@ -13,6 +13,7 @@ import (
"github.com/grafana/grafana/pkg/services/dashboards"
"github.com/grafana/grafana/pkg/services/datasources"
"github.com/grafana/grafana/pkg/services/featuremgmt"
+ publicdashboardsapi "github.com/grafana/grafana/pkg/services/publicdashboards/api"
"github.com/grafana/grafana/pkg/services/serviceaccounts"
"github.com/grafana/grafana/pkg/web"
)
@@ -28,7 +29,7 @@ func (hs *HTTPServer) registerRoutes() {
reqGrafanaAdmin := middleware.ReqGrafanaAdmin
reqEditorRole := middleware.ReqEditorRole
reqOrgAdmin := middleware.ReqOrgAdmin
- reqOrgAdminDashOrFolderAdminOrTeamAdmin := middleware.OrgAdminDashOrFolderAdminOrTeamAdmin(hs.SQLStore, hs.dashboardService)
+ reqOrgAdminDashOrFolderAdminOrTeamAdmin := middleware.OrgAdminDashOrFolderAdminOrTeamAdmin(hs.SQLStore, hs.DashboardService)
reqCanAccessTeams := middleware.AdminOrEditorAndFeatureEnabled(hs.Cfg.EditorsCanAdmin)
reqSnapshotPublicModeOrSignedIn := middleware.SnapshotPublicModeOrSignedIn(hs.Cfg)
redirectFromLegacyPanelEditURL := middleware.RedirectFromLegacyPanelEditURL(hs.Cfg)
@@ -75,6 +76,7 @@ func (hs *HTTPServer) registerRoutes() {
r.Get("/admin/orgs", authorizeInOrg(reqGrafanaAdmin, ac.UseGlobalOrg, orgsAccessEvaluator), hs.Index)
r.Get("/admin/orgs/edit/:id", authorizeInOrg(reqGrafanaAdmin, ac.UseGlobalOrg, orgsAccessEvaluator), hs.Index)
r.Get("/admin/stats", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionServerStatsRead)), hs.Index)
+ r.Get("/admin/storage/*", reqGrafanaAdmin, hs.Index)
r.Get("/admin/ldap", authorize(reqGrafanaAdmin, ac.EvalPermission(ac.ActionLDAPStatusRead)), hs.Index)
r.Get("/styleguide", reqSignedIn, hs.Index)
@@ -102,6 +104,10 @@ func (hs *HTTPServer) registerRoutes() {
r.Get("/dashboards/*", reqSignedIn, hs.Index)
r.Get("/goto/:uid", reqSignedIn, hs.redirectFromShortURL, hs.Index)
+ if hs.Features.IsEnabled(featuremgmt.FlagPublicDashboards) {
+ r.Get("/public-dashboards/:accessToken", publicdashboardsapi.SetPublicDashboardFlag(), hs.Index)
+ }
+
r.Get("/explore", authorize(func(c *models.ReqContext) {
if f, ok := reqSignedIn.(func(c *models.ReqContext)); ok {
f(c)
@@ -327,10 +333,12 @@ func (hs *HTTPServer) registerRoutes() {
apiRoute.Any("/plugins/:pluginId/resources/*", hs.CallResource)
apiRoute.Get("/plugins/errors", routing.Wrap(hs.GetPluginErrorsList))
- apiRoute.Group("/plugins", func(pluginRoute routing.RouteRegister) {
- pluginRoute.Post("/:pluginId/install", routing.Wrap(hs.InstallPlugin))
- pluginRoute.Post("/:pluginId/uninstall", routing.Wrap(hs.UninstallPlugin))
- }, reqGrafanaAdmin)
+ if hs.Cfg.PluginAdminEnabled && !hs.Cfg.PluginAdminExternalManageEnabled {
+ apiRoute.Group("/plugins", func(pluginRoute routing.RouteRegister) {
+ pluginRoute.Post("/:pluginId/install", routing.Wrap(hs.InstallPlugin))
+ pluginRoute.Post("/:pluginId/uninstall", routing.Wrap(hs.UninstallPlugin))
+ }, reqGrafanaAdmin)
+ }
apiRoute.Group("/plugins", func(pluginRoute routing.RouteRegister) {
pluginRoute.Get("/:pluginId/dashboards/", routing.Wrap(hs.GetPluginDashboards))
@@ -388,11 +396,6 @@ func (hs *HTTPServer) registerRoutes() {
})
dashboardRoute.Group("/uid/:uid", func(dashUidRoute routing.RouteRegister) {
- if hs.Features.IsEnabled(featuremgmt.FlagPublicDashboards) {
- dashUidRoute.Get("/public-config", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.GetPublicDashboardConfig))
- dashUidRoute.Post("/public-config", authorize(reqSignedIn, ac.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(hs.SavePublicDashboardConfig))
- }
-
if hs.ThumbService != nil {
dashUidRoute.Get("/img/:kind/:theme", hs.ThumbService.GetImage)
if hs.Features.IsEnabled(featuremgmt.FlagDashboardPreviewsAdmin) {
@@ -595,7 +598,7 @@ func (hs *HTTPServer) registerRoutes() {
// grafana.net proxy
r.Any("/api/gnet/*", reqSignedIn, hs.ProxyGnetRequest)
- // Gravatar service.
+ // Gravatar service
r.Get("/avatar/:hash", hs.AvatarCacheServer.Handler)
// Snapshots
@@ -605,13 +608,6 @@ func (hs *HTTPServer) registerRoutes() {
r.Get("/api/snapshots-delete/:deleteKey", reqSnapshotPublicModeOrSignedIn, routing.Wrap(hs.DeleteDashboardSnapshotByDeleteKey))
r.Delete("/api/snapshots/:key", reqEditorRole, routing.Wrap(hs.DeleteDashboardSnapshot))
- // Public API
- if hs.Features.IsEnabled(featuremgmt.FlagPublicDashboards) {
- r.Get("/public-dashboards/:accessToken", middleware.SetPublicDashboardFlag(), hs.Index)
- r.Get("/api/public/dashboards/:accessToken", routing.Wrap(hs.GetPublicDashboard))
- r.Post("/api/public/dashboards/:accessToken/panels/:panelId/query", routing.Wrap(hs.QueryPublicDashboard))
- }
-
// Frontend logs
sourceMapStore := frontendlogging.NewSourceMapStore(hs.Cfg, hs.pluginStaticRouteResolver, frontendlogging.ReadSourceMapFromFS)
r.Post("/log", middleware.RateLimit(hs.Cfg.Sentry.EndpointRPS, hs.Cfg.Sentry.EndpointBurst, time.Now),
diff --git a/pkg/api/common_test.go b/pkg/api/common_test.go
index e28a0758726..3111965b170 100644
--- a/pkg/api/common_test.go
+++ b/pkg/api/common_test.go
@@ -43,7 +43,6 @@ import (
"github.com/grafana/grafana/pkg/services/searchusers"
"github.com/grafana/grafana/pkg/services/searchusers/filters"
"github.com/grafana/grafana/pkg/services/sqlstore"
- "github.com/grafana/grafana/pkg/services/sqlstore/mockstore"
"github.com/grafana/grafana/pkg/setting"
"github.com/grafana/grafana/pkg/web"
"github.com/grafana/grafana/pkg/web/webtest"
@@ -341,15 +340,6 @@ func setupHTTPServerWithCfg(t *testing.T, useFakeAccessControl, enableAccessCont
return setupHTTPServerWithCfgDb(t, useFakeAccessControl, enableAccessControl, cfg, db, db, featuremgmt.WithFeatures())
}
-func setupHTTPServerWithMockDb(t *testing.T, useFakeAccessControl, enableAccessControl bool, features *featuremgmt.FeatureManager) accessControlScenarioContext {
- // Use a new conf
- cfg := setting.NewCfg()
- db := sqlstore.InitTestDB(t)
- db.Cfg = setting.NewCfg()
-
- return setupHTTPServerWithCfgDb(t, useFakeAccessControl, enableAccessControl, cfg, db, mockstore.NewSQLStoreMock(), features)
-}
-
func setupHTTPServerWithCfgDb(t *testing.T, useFakeAccessControl, enableAccessControl bool, cfg *setting.Cfg, db *sqlstore.SQLStore, store sqlstore.Store, features *featuremgmt.FeatureManager) accessControlScenarioContext {
t.Helper()
@@ -396,7 +386,7 @@ func setupHTTPServerWithCfgDb(t *testing.T, useFakeAccessControl, enableAccessCo
AccessControl: ac,
teamPermissionsService: teamPermissionService,
searchUsersService: searchusers.ProvideUsersService(db, filters.ProvideOSSSearchUserFilter()),
- dashboardService: dashboardservice.ProvideDashboardService(
+ DashboardService: dashboardservice.ProvideDashboardService(
cfg, dashboardsStore, nil, features,
accesscontrolmock.NewMockedPermissionsService(), accesscontrolmock.NewMockedPermissionsService(), ac,
),
diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go
index 8b07440df31..95b88909641 100644
--- a/pkg/api/dashboard.go
+++ b/pkg/api/dashboard.go
@@ -144,7 +144,7 @@ func (hs *HTTPServer) GetDashboard(c *models.ReqContext) response.Response {
// lookup folder title
if dash.FolderId > 0 {
query := models.GetDashboardQuery{Id: dash.FolderId, OrgId: c.OrgId}
- if err := hs.dashboardService.GetDashboard(c.Req.Context(), &query); err != nil {
+ if err := hs.DashboardService.GetDashboard(c.Req.Context(), &query); err != nil {
if errors.Is(err, dashboards.ErrFolderNotFound) {
return response.Error(404, "Folder not found", err)
}
@@ -235,7 +235,7 @@ func (hs *HTTPServer) getDashboardHelper(ctx context.Context, orgID int64, id in
query = models.GetDashboardQuery{Id: id, OrgId: orgID}
}
- if err := hs.dashboardService.GetDashboard(ctx, &query); err != nil {
+ if err := hs.DashboardService.GetDashboard(ctx, &query); err != nil {
return nil, response.Error(404, "Dashboard not found", err)
}
@@ -262,7 +262,7 @@ func (hs *HTTPServer) deleteDashboard(c *models.ReqContext) response.Response {
hs.log.Error("Failed to disconnect library elements", "dashboard", dash.Id, "user", c.SignedInUser.UserId, "error", err)
}
- err = hs.dashboardService.DeleteDashboard(c.Req.Context(), dash.Id, c.OrgId)
+ err = hs.DashboardService.DeleteDashboard(c.Req.Context(), dash.Id, c.OrgId)
if err != nil {
var dashboardErr dashboards.DashboardErr
if ok := errors.As(err, &dashboardErr); ok {
@@ -387,7 +387,7 @@ func (hs *HTTPServer) postDashboard(c *models.ReqContext, cmd models.SaveDashboa
Overwrite: cmd.Overwrite,
}
- dashboard, err := hs.dashboardService.SaveDashboard(alerting.WithUAEnabled(ctx, hs.Cfg.UnifiedAlerting.IsEnabled()), dashItem, allowUiUpdate)
+ dashboard, err := hs.DashboardService.SaveDashboard(alerting.WithUAEnabled(ctx, hs.Cfg.UnifiedAlerting.IsEnabled()), dashItem, allowUiUpdate)
if dashboard != nil && hs.entityEventsService != nil {
if err := hs.entityEventsService.SaveEvent(ctx, store.SaveEventCmd{
@@ -460,7 +460,7 @@ func (hs *HTTPServer) GetHomeDashboard(c *models.ReqContext) response.Response {
if preference.HomeDashboardID != 0 {
slugQuery := models.GetDashboardRefByIdQuery{Id: preference.HomeDashboardID}
- err := hs.dashboardService.GetDashboardUIDById(c.Req.Context(), &slugQuery)
+ err := hs.DashboardService.GetDashboardUIDById(c.Req.Context(), &slugQuery)
if err == nil {
url := models.GetDashboardUrl(slugQuery.Result.Uid, slugQuery.Result.Slug)
dashRedirect := dtos.DashboardRedirect{RedirectUri: url}
@@ -546,7 +546,7 @@ func (hs *HTTPServer) GetDashboardVersions(c *models.ReqContext) response.Respon
OrgId: c.SignedInUser.OrgId,
Uid: dashUID,
}
- if err := hs.dashboardService.GetDashboard(c.Req.Context(), &q); err != nil {
+ if err := hs.DashboardService.GetDashboard(c.Req.Context(), &q); err != nil {
return response.Error(http.StatusBadRequest, "failed to get dashboard by UID", err)
}
dashID = q.Result.Id
@@ -605,7 +605,7 @@ func (hs *HTTPServer) GetDashboardVersion(c *models.ReqContext) response.Respons
OrgId: c.SignedInUser.OrgId,
Uid: dashUID,
}
- if err := hs.dashboardService.GetDashboard(c.Req.Context(), &q); err != nil {
+ if err := hs.DashboardService.GetDashboard(c.Req.Context(), &q); err != nil {
return response.Error(http.StatusBadRequest, "failed to get dashboard by UID", err)
}
dashID = q.Result.Id
@@ -782,7 +782,7 @@ func (hs *HTTPServer) RestoreDashboardVersion(c *models.ReqContext) response.Res
func (hs *HTTPServer) GetDashboardTags(c *models.ReqContext) {
query := models.GetDashboardTagsQuery{OrgId: c.OrgId}
- err := hs.dashboardService.GetDashboardTags(c.Req.Context(), &query)
+ err := hs.DashboardService.GetDashboardTags(c.Req.Context(), &query)
if err != nil {
c.JsonApiErr(500, "Failed to get tags from database", err)
return
@@ -803,7 +803,7 @@ func (hs *HTTPServer) GetDashboardUIDs(c *models.ReqContext) {
continue
}
q.Id = id
- err = hs.dashboardService.GetDashboardUIDById(c.Req.Context(), q)
+ err = hs.DashboardService.GetDashboardUIDById(c.Req.Context(), q)
if err != nil {
continue
}
diff --git a/pkg/api/dashboard_permission.go b/pkg/api/dashboard_permission.go
index 4ae1ce4d36e..6bbec530a18 100644
--- a/pkg/api/dashboard_permission.go
+++ b/pkg/api/dashboard_permission.go
@@ -143,7 +143,7 @@ func (hs *HTTPServer) UpdateDashboardPermissions(c *models.ReqContext) response.
return response.Success("Dashboard permissions updated")
}
- if err := hs.dashboardService.UpdateDashboardACL(c.Req.Context(), dashID, items); err != nil {
+ if err := hs.DashboardService.UpdateDashboardACL(c.Req.Context(), dashID, items); err != nil {
if errors.Is(err, models.ErrDashboardAclInfoMissing) ||
errors.Is(err, models.ErrDashboardPermissionDashboardEmpty) {
return response.Error(409, err.Error(), err)
diff --git a/pkg/api/dashboard_permission_test.go b/pkg/api/dashboard_permission_test.go
index 14cc1abc5cf..0b15fee9012 100644
--- a/pkg/api/dashboard_permission_test.go
+++ b/pkg/api/dashboard_permission_test.go
@@ -39,7 +39,7 @@ func TestDashboardPermissionAPIEndpoint(t *testing.T) {
Cfg: settings,
SQLStore: mockSQLStore,
Features: features,
- dashboardService: dashboardservice.ProvideDashboardService(
+ DashboardService: dashboardservice.ProvideDashboardService(
settings, dashboardStore, nil, features, folderPermissions, dashboardPermissions, ac,
),
AccessControl: accesscontrolmock.New().WithDisabled(),
diff --git a/pkg/api/dashboard_public.go b/pkg/api/dashboard_public.go
deleted file mode 100644
index 9850a9cee5d..00000000000
--- a/pkg/api/dashboard_public.go
+++ /dev/null
@@ -1,141 +0,0 @@
-package api
-
-import (
- "errors"
- "fmt"
- "net/http"
- "strconv"
- "strings"
-
- "github.com/grafana/grafana/pkg/api/dtos"
- "github.com/grafana/grafana/pkg/api/response"
- "github.com/grafana/grafana/pkg/models"
- "github.com/grafana/grafana/pkg/services/dashboards"
- "github.com/grafana/grafana/pkg/services/datasources"
- "github.com/grafana/grafana/pkg/web"
-)
-
-// gets public dashboard
-func (hs *HTTPServer) GetPublicDashboard(c *models.ReqContext) response.Response {
- accessToken := web.Params(c.Req)[":accessToken"]
-
- dash, err := hs.dashboardService.GetPublicDashboard(c.Req.Context(), accessToken)
- if err != nil {
- return handleDashboardErr(http.StatusInternalServerError, "Failed to get public dashboard", err)
- }
-
- meta := dtos.DashboardMeta{
- Slug: dash.Slug,
- Type: models.DashTypeDB,
- CanStar: false,
- CanSave: false,
- CanEdit: false,
- CanAdmin: false,
- CanDelete: false,
- Created: dash.Created,
- Updated: dash.Updated,
- Version: dash.Version,
- IsFolder: false,
- FolderId: dash.FolderId,
- PublicDashboardAccessToken: accessToken,
- }
-
- dto := dtos.DashboardFullWithMeta{Meta: meta, Dashboard: dash.Data}
-
- return response.JSON(http.StatusOK, dto)
-}
-
-// gets public dashboard configuration for dashboard
-func (hs *HTTPServer) GetPublicDashboardConfig(c *models.ReqContext) response.Response {
- pdc, err := hs.dashboardService.GetPublicDashboardConfig(c.Req.Context(), c.OrgId, web.Params(c.Req)[":uid"])
- if err != nil {
- return handleDashboardErr(http.StatusInternalServerError, "Failed to get public dashboard config", err)
- }
- return response.JSON(http.StatusOK, pdc)
-}
-
-// sets public dashboard configuration for dashboard
-func (hs *HTTPServer) SavePublicDashboardConfig(c *models.ReqContext) response.Response {
- pubdash := &models.PublicDashboard{}
- if err := web.Bind(c.Req, pubdash); err != nil {
- return response.Error(http.StatusBadRequest, "bad request data", err)
- }
-
- // Always set the org id to the current auth session orgId
- pubdash.OrgId = c.OrgId
-
- dto := dashboards.SavePublicDashboardConfigDTO{
- OrgId: c.OrgId,
- DashboardUid: web.Params(c.Req)[":uid"],
- UserId: c.UserId,
- PublicDashboard: pubdash,
- }
-
- pubdash, err := hs.dashboardService.SavePublicDashboardConfig(c.Req.Context(), &dto)
- if err != nil {
- return handleDashboardErr(http.StatusInternalServerError, "Failed to save public dashboard configuration", err)
- }
-
- return response.JSON(http.StatusOK, pubdash)
-}
-
-// QueryPublicDashboard returns all results for a given panel on a public dashboard
-// POST /api/public/dashboard/:accessToken/panels/:panelId/query
-func (hs *HTTPServer) QueryPublicDashboard(c *models.ReqContext) response.Response {
- panelId, err := strconv.ParseInt(web.Params(c.Req)[":panelId"], 10, 64)
- if err != nil {
- return response.Error(http.StatusBadRequest, "invalid panel ID", err)
- }
-
- dashboard, err := hs.dashboardService.GetPublicDashboard(c.Req.Context(), web.Params(c.Req)[":accessToken"])
- if err != nil {
- return response.Error(http.StatusInternalServerError, "could not fetch dashboard", err)
- }
-
- publicDashboard, err := hs.dashboardService.GetPublicDashboardConfig(c.Req.Context(), dashboard.OrgId, dashboard.Uid)
- if err != nil {
- return response.Error(http.StatusInternalServerError, "could not fetch public dashboard", err)
- }
-
- reqDTO, err := hs.dashboardService.BuildPublicDashboardMetricRequest(
- c.Req.Context(),
- dashboard,
- publicDashboard,
- panelId,
- )
- if err != nil {
- return handleDashboardErr(http.StatusInternalServerError, "Failed to get queries for public dashboard", err)
- }
-
- // Get all needed datasource UIDs from queries
- var uids []string
- for _, query := range reqDTO.Queries {
- uids = append(uids, query.Get("datasource").Get("uid").MustString())
- }
-
- // Create a temp user with read-only datasource permissions
- anonymousUser := &models.SignedInUser{OrgId: dashboard.OrgId, Permissions: make(map[int64]map[string][]string)}
- permissions := make(map[string][]string)
- datasourceScope := fmt.Sprintf("datasources:uid:%s", strings.Join(uids, ","))
- permissions[datasources.ActionQuery] = []string{datasourceScope}
- permissions[datasources.ActionRead] = []string{datasourceScope}
- anonymousUser.Permissions[dashboard.OrgId] = permissions
-
- resp, err := hs.queryDataService.QueryDataMultipleSources(c.Req.Context(), anonymousUser, c.SkipCache, reqDTO, true)
-
- if err != nil {
- return hs.handleQueryMetricsError(err)
- }
- return hs.toJsonStreamingResponse(resp)
-}
-
-// util to help us unpack a dashboard err or use default http code and message
-func handleDashboardErr(defaultCode int, defaultMsg string, err error) response.Response {
- var dashboardErr dashboards.DashboardErr
-
- if ok := errors.As(err, &dashboardErr); ok {
- return response.Error(dashboardErr.StatusCode, dashboardErr.Error(), dashboardErr)
- }
-
- return response.Error(defaultCode, defaultMsg, err)
-}
diff --git a/pkg/api/dashboard_public_test.go b/pkg/api/dashboard_public_test.go
deleted file mode 100644
index 3c99b40b74d..00000000000
--- a/pkg/api/dashboard_public_test.go
+++ /dev/null
@@ -1,630 +0,0 @@
-package api
-
-import (
- "context"
- "encoding/json"
- "errors"
- "fmt"
- "io/ioutil"
- "net/http"
- "strings"
- "testing"
-
- "github.com/google/uuid"
- "github.com/grafana/grafana-plugin-sdk-go/backend"
- "github.com/grafana/grafana-plugin-sdk-go/data"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/mock"
- "github.com/stretchr/testify/require"
-
- "github.com/grafana/grafana/pkg/api/dtos"
- "github.com/grafana/grafana/pkg/components/simplejson"
- "github.com/grafana/grafana/pkg/infra/localcache"
- "github.com/grafana/grafana/pkg/models"
- "github.com/grafana/grafana/pkg/services/dashboards"
- "github.com/grafana/grafana/pkg/services/datasources"
- fakeDatasources "github.com/grafana/grafana/pkg/services/datasources/fakes"
- "github.com/grafana/grafana/pkg/services/datasources/service"
- "github.com/grafana/grafana/pkg/services/featuremgmt"
- "github.com/grafana/grafana/pkg/services/query"
- "github.com/grafana/grafana/pkg/services/sqlstore"
- "github.com/grafana/grafana/pkg/setting"
- "github.com/grafana/grafana/pkg/web/webtest"
-)
-
-func TestAPIGetPublicDashboard(t *testing.T) {
- t.Run("It should 404 if featureflag is not enabled", func(t *testing.T) {
- sc := setupHTTPServerWithMockDb(t, false, false, featuremgmt.WithFeatures())
- dashSvc := dashboards.NewFakeDashboardService(t)
- dashSvc.On("GetPublicDashboard", mock.Anything, mock.AnythingOfType("string")).
- Return(&models.Dashboard{}, nil).Maybe()
- sc.hs.dashboardService = dashSvc
-
- setInitCtxSignedInViewer(sc.initCtx)
- response := callAPI(
- sc.server,
- http.MethodGet,
- "/api/public/dashboards",
- nil,
- t,
- )
- assert.Equal(t, http.StatusNotFound, response.Code)
- response = callAPI(
- sc.server,
- http.MethodGet,
- "/api/public/dashboards/asdf",
- nil,
- t,
- )
- assert.Equal(t, http.StatusNotFound, response.Code)
- })
-
- DashboardUid := "dashboard-abcd1234"
- token, err := uuid.NewRandom()
- require.NoError(t, err)
- accessToken := fmt.Sprintf("%x", token)
-
- testCases := []struct {
- Name string
- AccessToken string
- ExpectedHttpResponse int
- publicDashboardResult *models.Dashboard
- publicDashboardErr error
- }{
- {
- Name: "It gets a public dashboard",
- AccessToken: accessToken,
- ExpectedHttpResponse: http.StatusOK,
- publicDashboardResult: &models.Dashboard{
- Data: simplejson.NewFromAny(map[string]interface{}{
- "Uid": DashboardUid,
- }),
- },
- publicDashboardErr: nil,
- },
- {
- Name: "It should return 404 if isPublicDashboard is false",
- AccessToken: accessToken,
- ExpectedHttpResponse: http.StatusNotFound,
- publicDashboardResult: nil,
- publicDashboardErr: dashboards.ErrPublicDashboardNotFound,
- },
- }
-
- for _, test := range testCases {
- t.Run(test.Name, func(t *testing.T) {
- sc := setupHTTPServerWithMockDb(t, false, false, featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards))
- dashSvc := dashboards.NewFakeDashboardService(t)
- dashSvc.On("GetPublicDashboard", mock.Anything, mock.AnythingOfType("string")).
- Return(test.publicDashboardResult, test.publicDashboardErr)
- sc.hs.dashboardService = dashSvc
-
- setInitCtxSignedInViewer(sc.initCtx)
- response := callAPI(
- sc.server,
- http.MethodGet,
- fmt.Sprintf("/api/public/dashboards/%s", test.AccessToken),
- nil,
- t,
- )
-
- assert.Equal(t, test.ExpectedHttpResponse, response.Code)
-
- if test.publicDashboardErr == nil {
- var dashResp dtos.DashboardFullWithMeta
- err := json.Unmarshal(response.Body.Bytes(), &dashResp)
- require.NoError(t, err)
-
- assert.Equal(t, DashboardUid, dashResp.Dashboard.Get("Uid").MustString())
- assert.Equal(t, false, dashResp.Meta.CanEdit)
- assert.Equal(t, false, dashResp.Meta.CanDelete)
- assert.Equal(t, false, dashResp.Meta.CanSave)
- } else {
- var errResp struct {
- Error string `json:"error"`
- }
- err := json.Unmarshal(response.Body.Bytes(), &errResp)
- require.NoError(t, err)
- assert.Equal(t, test.publicDashboardErr.Error(), errResp.Error)
- }
- })
- }
-}
-
-func TestAPIGetPublicDashboardConfig(t *testing.T) {
- pubdash := &models.PublicDashboard{IsEnabled: true}
-
- testCases := []struct {
- Name string
- DashboardUid string
- ExpectedHttpResponse int
- PublicDashboardResult *models.PublicDashboard
- PublicDashboardError error
- }{
- {
- Name: "retrieves public dashboard config when dashboard is found",
- DashboardUid: "1",
- ExpectedHttpResponse: http.StatusOK,
- PublicDashboardResult: pubdash,
- PublicDashboardError: nil,
- },
- {
- Name: "returns 404 when dashboard not found",
- DashboardUid: "77777",
- ExpectedHttpResponse: http.StatusNotFound,
- PublicDashboardResult: nil,
- PublicDashboardError: dashboards.ErrDashboardNotFound,
- },
- {
- Name: "returns 500 when internal server error",
- DashboardUid: "1",
- ExpectedHttpResponse: http.StatusInternalServerError,
- PublicDashboardResult: nil,
- PublicDashboardError: errors.New("database broken"),
- },
- }
-
- for _, test := range testCases {
- t.Run(test.Name, func(t *testing.T) {
- sc := setupHTTPServerWithMockDb(t, false, false, featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards))
- dashSvc := dashboards.NewFakeDashboardService(t)
- dashSvc.On("GetPublicDashboardConfig", mock.Anything, mock.AnythingOfType("int64"), mock.AnythingOfType("string")).
- Return(test.PublicDashboardResult, test.PublicDashboardError)
- sc.hs.dashboardService = dashSvc
-
- setInitCtxSignedInViewer(sc.initCtx)
- response := callAPI(
- sc.server,
- http.MethodGet,
- "/api/dashboards/uid/1/public-config",
- nil,
- t,
- )
-
- assert.Equal(t, test.ExpectedHttpResponse, response.Code)
-
- if response.Code == http.StatusOK {
- var pdcResp models.PublicDashboard
- err := json.Unmarshal(response.Body.Bytes(), &pdcResp)
- require.NoError(t, err)
- assert.Equal(t, test.PublicDashboardResult, &pdcResp)
- }
- })
- }
-}
-
-func TestApiSavePublicDashboardConfig(t *testing.T) {
- testCases := []struct {
- Name string
- DashboardUid string
- publicDashboardConfig *models.PublicDashboard
- ExpectedHttpResponse int
- saveDashboardError error
- }{
- {
- Name: "returns 200 when update persists",
- DashboardUid: "1",
- publicDashboardConfig: &models.PublicDashboard{IsEnabled: true},
- ExpectedHttpResponse: http.StatusOK,
- saveDashboardError: nil,
- },
- {
- Name: "returns 500 when not persisted",
- ExpectedHttpResponse: http.StatusInternalServerError,
- publicDashboardConfig: &models.PublicDashboard{},
- saveDashboardError: errors.New("backend failed to save"),
- },
- {
- Name: "returns 404 when dashboard not found",
- ExpectedHttpResponse: http.StatusNotFound,
- publicDashboardConfig: &models.PublicDashboard{},
- saveDashboardError: dashboards.ErrDashboardNotFound,
- },
- }
-
- for _, test := range testCases {
- t.Run(test.Name, func(t *testing.T) {
- sc := setupHTTPServerWithMockDb(t, false, false, featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards))
-
- dashSvc := dashboards.NewFakeDashboardService(t)
- dashSvc.On("SavePublicDashboardConfig", mock.Anything, mock.AnythingOfType("*dashboards.SavePublicDashboardConfigDTO")).
- Return(&models.PublicDashboard{IsEnabled: true}, test.saveDashboardError)
- sc.hs.dashboardService = dashSvc
-
- setInitCtxSignedInViewer(sc.initCtx)
- response := callAPI(
- sc.server,
- http.MethodPost,
- "/api/dashboards/uid/1/public-config",
- strings.NewReader(`{ "isPublic": true }`),
- t,
- )
-
- assert.Equal(t, test.ExpectedHttpResponse, response.Code)
-
- // check the result if it's a 200
- if response.Code == http.StatusOK {
- val, err := json.Marshal(test.publicDashboardConfig)
- require.NoError(t, err)
- assert.Equal(t, string(val), response.Body.String())
- }
- })
- }
-}
-
-// `/public/dashboards/:uid/query`` endpoint test
-func TestAPIQueryPublicDashboard(t *testing.T) {
- queryReturnsError := false
-
- qds := query.ProvideService(
- nil,
- &fakeDatasources.FakeCacheService{
- DataSources: []*datasources.DataSource{
- {Uid: "mysqlds"},
- {Uid: "promds"},
- {Uid: "promds2"},
- },
- },
- nil,
- &fakePluginRequestValidator{},
- &fakeDatasources.FakeDataSourceService{},
- &fakePluginClient{
- QueryDataHandlerFunc: func(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
- if queryReturnsError {
- return nil, errors.New("error")
- }
-
- resp := backend.Responses{}
-
- for _, query := range req.Queries {
- resp[query.RefID] = backend.DataResponse{
- Frames: []*data.Frame{
- {
- RefID: query.RefID,
- Name: "query-" + query.RefID,
- },
- },
- }
- }
- return &backend.QueryDataResponse{Responses: resp}, nil
- },
- },
- &fakeOAuthTokenService{},
- )
-
- setup := func(enabled bool) (*webtest.Server, *dashboards.FakeDashboardService) {
- fakeDashboardService := &dashboards.FakeDashboardService{}
-
- return SetupAPITestServer(t, func(hs *HTTPServer) {
- hs.queryDataService = qds
- hs.Features = featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards, enabled)
- hs.dashboardService = fakeDashboardService
- }), fakeDashboardService
- }
-
- t.Run("Status code is 404 when feature toggle is disabled", func(t *testing.T) {
- server, _ := setup(false)
-
- req := server.NewPostRequest(
- "/api/public/dashboards/abc123/panels/2/query",
- strings.NewReader("{}"),
- )
- resp, err := server.SendJSON(req)
- require.NoError(t, err)
- require.NoError(t, resp.Body.Close())
- require.Equal(t, http.StatusNotFound, resp.StatusCode)
- })
-
- t.Run("Status code is 400 when the panel ID is invalid", func(t *testing.T) {
- server, _ := setup(true)
-
- req := server.NewPostRequest(
- "/api/public/dashboards/abc123/panels/notanumber/query",
- strings.NewReader("{}"),
- )
- resp, err := server.SendJSON(req)
- require.NoError(t, err)
- require.NoError(t, resp.Body.Close())
- require.Equal(t, http.StatusBadRequest, resp.StatusCode)
- })
-
- t.Run("Returns query data when feature toggle is enabled", func(t *testing.T) {
- server, fakeDashboardService := setup(true)
-
- fakeDashboardService.On("GetPublicDashboard", mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil)
- fakeDashboardService.On("GetPublicDashboardConfig", mock.Anything, mock.Anything, mock.Anything).Return(&models.PublicDashboard{}, nil)
-
- fakeDashboardService.On(
- "BuildPublicDashboardMetricRequest",
- mock.Anything,
- mock.Anything,
- mock.Anything,
- int64(2),
- ).Return(dtos.MetricRequest{
- Queries: []*simplejson.Json{
- simplejson.MustJson([]byte(`
- {
- "datasource": {
- "type": "prometheus",
- "uid": "promds"
- },
- "exemplar": true,
- "expr": "query_2_A",
- "interval": "",
- "legendFormat": "",
- "refId": "A"
- }
- `)),
- },
- }, nil)
- req := server.NewPostRequest(
- "/api/public/dashboards/abc123/panels/2/query",
- strings.NewReader("{}"),
- )
- resp, err := server.SendJSON(req)
- require.NoError(t, err)
- bodyBytes, err := ioutil.ReadAll(resp.Body)
- require.NoError(t, err)
- require.JSONEq(
- t,
- `{
- "results": {
- "A": {
- "frames": [
- {
- "data": {
- "values": []
- },
- "schema": {
- "fields": [],
- "refId": "A",
- "name": "query-A"
- }
- }
- ]
- }
- }
- }`,
- string(bodyBytes),
- )
- require.NoError(t, resp.Body.Close())
- require.Equal(t, http.StatusOK, resp.StatusCode)
- })
-
- t.Run("Status code is 500 when the query fails", func(t *testing.T) {
- server, fakeDashboardService := setup(true)
-
- fakeDashboardService.On("GetPublicDashboard", mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil)
- fakeDashboardService.On("GetPublicDashboardConfig", mock.Anything, mock.Anything, mock.Anything).Return(&models.PublicDashboard{}, nil)
- fakeDashboardService.On(
- "BuildPublicDashboardMetricRequest",
- mock.Anything,
- mock.Anything,
- mock.Anything,
- int64(2),
- ).Return(dtos.MetricRequest{
- Queries: []*simplejson.Json{
- simplejson.MustJson([]byte(`
- {
- "datasource": {
- "type": "prometheus",
- "uid": "promds"
- },
- "exemplar": true,
- "expr": "query_2_A",
- "interval": "",
- "legendFormat": "",
- "refId": "A"
- }
- `)),
- },
- }, nil)
- req := server.NewPostRequest(
- "/api/public/dashboards/abc123/panels/2/query",
- strings.NewReader("{}"),
- )
- queryReturnsError = true
- resp, err := server.SendJSON(req)
- require.NoError(t, err)
- require.NoError(t, resp.Body.Close())
- require.Equal(t, http.StatusInternalServerError, resp.StatusCode)
- queryReturnsError = false
- })
-
- t.Run("Status code is 200 when a panel has queries from multiple datasources", func(t *testing.T) {
- server, fakeDashboardService := setup(true)
-
- fakeDashboardService.On("GetPublicDashboard", mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil)
- fakeDashboardService.On("GetPublicDashboardConfig", mock.Anything, mock.Anything, mock.Anything).Return(&models.PublicDashboard{}, nil)
- fakeDashboardService.On(
- "BuildPublicDashboardMetricRequest",
- mock.Anything,
- mock.Anything,
- mock.Anything,
- int64(2),
- ).Return(dtos.MetricRequest{
- Queries: []*simplejson.Json{
- simplejson.MustJson([]byte(`
- {
- "datasource": {
- "type": "prometheus",
- "uid": "promds"
- },
- "exemplar": true,
- "expr": "query_2_A",
- "interval": "",
- "legendFormat": "",
- "refId": "A"
- }
- `)),
- simplejson.MustJson([]byte(`
- {
- "datasource": {
- "type": "prometheus",
- "uid": "promds2"
- },
- "exemplar": true,
- "expr": "query_2_B",
- "interval": "",
- "legendFormat": "",
- "refId": "B"
- }
- `)),
- },
- }, nil)
- req := server.NewPostRequest(
- "/api/public/dashboards/abc123/panels/2/query",
- strings.NewReader("{}"),
- )
- resp, err := server.SendJSON(req)
- require.NoError(t, err)
- bodyBytes, err := ioutil.ReadAll(resp.Body)
- require.NoError(t, err)
- require.JSONEq(
- t,
- `{
- "results": {
- "A": {
- "frames": [
- {
- "data": {
- "values": []
- },
- "schema": {
- "fields": [],
- "refId": "A",
- "name": "query-A"
- }
- }
- ]
- },
- "B": {
- "frames": [
- {
- "data": {
- "values": []
- },
- "schema": {
- "fields": [],
- "refId": "B",
- "name": "query-B"
- }
- }
- ]
- }
- }
- }`,
- string(bodyBytes),
- )
- require.NoError(t, resp.Body.Close())
- require.Equal(t, http.StatusOK, resp.StatusCode)
- })
-}
-
-func TestIntegrationUnauthenticatedUserCanGetPubdashPanelQueryData(t *testing.T) {
- config := setting.NewCfg()
- db := sqlstore.InitTestDB(t)
- scenario := setupHTTPServerWithCfgDb(t, false, false, config, db, db, featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards))
- scenario.initCtx.SkipCache = true
- cacheService := service.ProvideCacheService(localcache.ProvideService(), db)
- qds := query.ProvideService(
- nil,
- cacheService,
- nil,
- &fakePluginRequestValidator{},
- &fakeDatasources.FakeDataSourceService{},
- &fakePluginClient{
- QueryDataHandlerFunc: func(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
- resp := backend.Responses{
- "A": backend.DataResponse{
- Frames: []*data.Frame{{}},
- },
- }
- return &backend.QueryDataResponse{Responses: resp}, nil
- },
- },
- &fakeOAuthTokenService{},
- )
- scenario.hs.queryDataService = qds
-
- _ = db.AddDataSource(context.Background(), &datasources.AddDataSourceCommand{
- Uid: "ds1",
- OrgId: 1,
- Name: "laban",
- Type: datasources.DS_MYSQL,
- Access: datasources.DS_ACCESS_DIRECT,
- Url: "http://test",
- Database: "site",
- ReadOnly: true,
- })
-
- // Create Dashboard
- saveDashboardCmd := models.SaveDashboardCommand{
- OrgId: 1,
- FolderId: 1,
- IsFolder: false,
- Dashboard: simplejson.NewFromAny(map[string]interface{}{
- "id": nil,
- "title": "test",
- "panels": []map[string]interface{}{
- {
- "id": 1,
- "targets": []map[string]interface{}{
- {
- "datasource": map[string]string{
- "type": "mysql",
- "uid": "ds1",
- },
- "refId": "A",
- },
- },
- },
- },
- }),
- }
- dashboard, _ := scenario.dashboardsStore.SaveDashboard(saveDashboardCmd)
-
- // Create public dashboard
- savePubDashboardCmd := &dashboards.SavePublicDashboardConfigDTO{
- DashboardUid: dashboard.Uid,
- OrgId: dashboard.OrgId,
- PublicDashboard: &models.PublicDashboard{
- IsEnabled: true,
- },
- }
-
- pubdash, err := scenario.hs.dashboardService.SavePublicDashboardConfig(context.Background(), savePubDashboardCmd)
- require.NoError(t, err)
-
- response := callAPI(
- scenario.server,
- http.MethodPost,
- fmt.Sprintf("/api/public/dashboards/%s/panels/1/query", pubdash.AccessToken),
- strings.NewReader(`{}`),
- t,
- )
-
- require.Equal(t, http.StatusOK, response.Code)
- bodyBytes, err := ioutil.ReadAll(response.Body)
- require.NoError(t, err)
- require.JSONEq(
- t,
- `{
- "results": {
- "A": {
- "frames": [
- {
- "data": {
- "values": []
- },
- "schema": {
- "fields": []
- }
- }
- ]
- }
- }
- }`,
- string(bodyBytes),
- )
-}
diff --git a/pkg/api/dashboard_test.go b/pkg/api/dashboard_test.go
index 7ababd06b01..d43a7383faf 100644
--- a/pkg/api/dashboard_test.go
+++ b/pkg/api/dashboard_test.go
@@ -139,7 +139,7 @@ func TestDashboardAPIEndpoint(t *testing.T) {
SQLStore: mockSQLStore,
AccessControl: accesscontrolmock.New(),
Features: featuremgmt.WithFeatures(),
- dashboardService: dashboardService,
+ DashboardService: dashboardService,
dashboardVersionService: fakeDashboardVersionService,
}
hs.CoremodelStaticRegistry, hs.CoremodelRegistry = setupDashboardCoremodel(t)
@@ -259,7 +259,7 @@ func TestDashboardAPIEndpoint(t *testing.T) {
LibraryElementService: &mockLibraryElementService{},
SQLStore: mockSQLStore,
AccessControl: accesscontrolmock.New(),
- dashboardService: dashboardService,
+ DashboardService: dashboardService,
dashboardVersionService: fakeDashboardVersionService,
}
hs.CoremodelStaticRegistry, hs.CoremodelRegistry = setupDashboardCoremodel(t)
@@ -900,7 +900,7 @@ func TestDashboardAPIEndpoint(t *testing.T) {
dashboardProvisioningService: mockDashboardProvisioningService{},
SQLStore: mockSQLStore,
AccessControl: accesscontrolmock.New(),
- dashboardService: dashboardService,
+ DashboardService: dashboardService,
}
hs.CoremodelStaticRegistry, hs.CoremodelRegistry = setupDashboardCoremodel(t)
hs.callGetDashboard(sc)
@@ -954,7 +954,7 @@ func getDashboardShouldReturn200WithConfig(t *testing.T, sc *scenarioContext, pr
cfg, dashboardStore, nil, features,
folderPermissions, dashboardPermissions, ac,
),
- dashboardService: dashboardService,
+ DashboardService: dashboardService,
}
hs.CoremodelStaticRegistry, hs.CoremodelRegistry = setupDashboardCoremodel(t)
@@ -986,7 +986,7 @@ func (hs *HTTPServer) callGetDashboardVersions(sc *scenarioContext) {
func (hs *HTTPServer) callDeleteDashboardByUID(t *testing.T,
sc *scenarioContext, mockDashboard *dashboards.FakeDashboardService) {
- hs.dashboardService = mockDashboard
+ hs.DashboardService = mockDashboard
sc.handlerFunc = hs.DeleteDashboardByUID
sc.fakeReqWithParams("DELETE", sc.url, map[string]string{}).exec()
}
@@ -1018,7 +1018,7 @@ func postDashboardScenario(t *testing.T, desc string, url string, routePattern s
pluginStore: &fakePluginStore{},
LibraryPanelService: &mockLibraryPanelService{},
LibraryElementService: &mockLibraryElementService{},
- dashboardService: dashboardService,
+ DashboardService: dashboardService,
folderService: folderService,
Features: featuremgmt.WithFeatures(),
}
@@ -1088,7 +1088,7 @@ func restoreDashboardVersionScenario(t *testing.T, desc string, url string, rout
QuotaService: "a.QuotaService{Cfg: cfg},
LibraryPanelService: &mockLibraryPanelService{},
LibraryElementService: &mockLibraryElementService{},
- dashboardService: mock,
+ DashboardService: mock,
SQLStore: sqlStore,
Features: featuremgmt.WithFeatures(),
dashboardVersionService: fakeDashboardVersionService,
diff --git a/pkg/api/dtos/models.go b/pkg/api/dtos/models.go
index c0fe84cb2dc..343b5f6c1b2 100644
--- a/pkg/api/dtos/models.go
+++ b/pkg/api/dtos/models.go
@@ -70,6 +70,8 @@ type MetricRequest struct {
// required: false
Debug bool `json:"debug"`
+ PublicDashboardAccessToken string `json:"publicDashboardAccessToken"`
+
HTTPRequest *http.Request `json:"-"`
}
diff --git a/pkg/api/fakes.go b/pkg/api/fakes.go
index 23b5a89c52d..6b1eda6f2ff 100644
--- a/pkg/api/fakes.go
+++ b/pkg/api/fakes.go
@@ -6,6 +6,28 @@ import (
"github.com/grafana/grafana/pkg/plugins"
)
+type fakePluginManager struct {
+ plugins map[string]fakePlugin
+}
+
+type fakePlugin struct {
+ pluginID string
+ version string
+}
+
+func (pm *fakePluginManager) Add(_ context.Context, pluginID, version string) error {
+ pm.plugins[pluginID] = fakePlugin{
+ pluginID: pluginID,
+ version: version,
+ }
+ return nil
+}
+
+func (pm *fakePluginManager) Remove(_ context.Context, pluginID string) error {
+ delete(pm.plugins, pluginID)
+ return nil
+}
+
type fakePluginStore struct {
plugins.Store
diff --git a/pkg/api/folder_permission.go b/pkg/api/folder_permission.go
index e622c21ab05..892e9e043aa 100644
--- a/pkg/api/folder_permission.go
+++ b/pkg/api/folder_permission.go
@@ -126,7 +126,7 @@ func (hs *HTTPServer) UpdateFolderPermissions(c *models.ReqContext) response.Res
return response.Success("Dashboard permissions updated")
}
- if err := hs.dashboardService.UpdateDashboardACL(c.Req.Context(), folder.Id, items); err != nil {
+ if err := hs.DashboardService.UpdateDashboardACL(c.Req.Context(), folder.Id, items); err != nil {
if errors.Is(err, models.ErrDashboardAclInfoMissing) {
err = models.ErrFolderAclInfoMissing
}
diff --git a/pkg/api/folder_permission_test.go b/pkg/api/folder_permission_test.go
index 48e88febbed..093522d2d9e 100644
--- a/pkg/api/folder_permission_test.go
+++ b/pkg/api/folder_permission_test.go
@@ -42,7 +42,7 @@ func TestFolderPermissionAPIEndpoint(t *testing.T) {
folderService: folderService,
folderPermissionsService: folderPermissions,
dashboardPermissionsService: dashboardPermissions,
- dashboardService: service.ProvideDashboardService(
+ DashboardService: service.ProvideDashboardService(
settings, dashboardStore, nil, features, folderPermissions, dashboardPermissions, ac,
),
AccessControl: accesscontrolmock.New().WithDisabled(),
diff --git a/pkg/api/http_server.go b/pkg/api/http_server.go
index e633beffd1f..ac80801de41 100644
--- a/pkg/api/http_server.go
+++ b/pkg/api/http_server.go
@@ -62,6 +62,8 @@ import (
pluginSettings "github.com/grafana/grafana/pkg/services/pluginsettings/service"
pref "github.com/grafana/grafana/pkg/services/preference"
"github.com/grafana/grafana/pkg/services/provisioning"
+
+ publicdashboardsApi "github.com/grafana/grafana/pkg/services/publicdashboards/api"
"github.com/grafana/grafana/pkg/services/query"
"github.com/grafana/grafana/pkg/services/queryhistory"
"github.com/grafana/grafana/pkg/services/quota"
@@ -148,7 +150,7 @@ type HTTPServer struct {
authenticator loginpkg.Authenticator
teamPermissionsService accesscontrol.TeamPermissionsService
NotificationService *notifications.NotificationService
- dashboardService dashboards.DashboardService
+ DashboardService dashboards.DashboardService
dashboardProvisioningService dashboards.DashboardProvisioningService
folderService dashboards.FolderService
DatasourcePermissionsService permissions.DatasourcePermissionsService
@@ -163,6 +165,7 @@ type HTTPServer struct {
folderPermissionsService accesscontrol.FolderPermissionsService
dashboardPermissionsService accesscontrol.DashboardPermissionsService
dashboardVersionService dashver.Service
+ PublicDashboardsApi *publicdashboardsApi.Api
starService star.Service
CoremodelRegistry *registry.Generic
CoremodelStaticRegistry *registry.Static
@@ -202,7 +205,7 @@ func ProvideHTTPServer(opts ServerOptions, cfg *setting.Cfg, routeRegister routi
teamsPermissionsService accesscontrol.TeamPermissionsService, folderPermissionsService accesscontrol.FolderPermissionsService,
dashboardPermissionsService accesscontrol.DashboardPermissionsService, dashboardVersionService dashver.Service,
starService star.Service, csrfService csrf.Service, coremodelRegistry *registry.Generic, coremodelStaticRegistry *registry.Static,
- kvStore kvstore.KVStore, secretsMigrator secrets.Migrator, remoteSecretsCheck secretsKV.UseRemoteSecretsPluginCheck,
+ kvStore kvstore.KVStore, secretsMigrator secrets.Migrator, remoteSecretsCheck secretsKV.UseRemoteSecretsPluginCheck, publicDashboardsApi *publicdashboardsApi.Api,
) (*HTTPServer, error) {
web.Env = cfg.Env
m := web.New()
@@ -267,7 +270,7 @@ func ProvideHTTPServer(opts ServerOptions, cfg *setting.Cfg, routeRegister routi
authInfoService: authInfoService,
authenticator: authenticator,
NotificationService: notificationService,
- dashboardService: dashboardService,
+ DashboardService: dashboardService,
dashboardProvisioningService: dashboardProvisioningService,
folderService: folderService,
DatasourcePermissionsService: datasourcePermissionsService,
@@ -287,6 +290,7 @@ func ProvideHTTPServer(opts ServerOptions, cfg *setting.Cfg, routeRegister routi
CoremodelRegistry: coremodelRegistry,
CoremodelStaticRegistry: coremodelStaticRegistry,
kvStore: kvStore,
+ PublicDashboardsApi: publicDashboardsApi,
secretsMigrator: secretsMigrator,
}
if hs.Listener != nil {
diff --git a/pkg/api/index.go b/pkg/api/index.go
index aaca41afe05..00c375931c6 100644
--- a/pkg/api/index.go
+++ b/pkg/api/index.go
@@ -294,6 +294,7 @@ func (hs *HTTPServer) getNavTree(c *models.ReqContext, hasEditPerm bool, prefs *
Url: hs.Cfg.AppSubURL + "/org/apikeys",
})
}
+
if enableServiceAccount(hs, c) {
configNodes = append(configNodes, &dtos.NavLink{
Text: "Service accounts",
@@ -406,7 +407,7 @@ func (hs *HTTPServer) buildStarredItemsNavLinks(c *models.ReqContext, prefs *pre
Id: dashboardId,
OrgId: c.OrgId,
}
- err := hs.dashboardService.GetDashboard(c.Req.Context(), query)
+ err := hs.DashboardService.GetDashboard(c.Req.Context(), query)
if err == nil {
starredDashboards = append(starredDashboards, query.Result)
}
@@ -458,6 +459,15 @@ func (hs *HTTPServer) buildDashboardNavLinks(c *models.ReqContext, hasEditPerm b
})
}
+ if hs.Features.IsEnabled(featuremgmt.FlagScenes) {
+ dashboardChildNavs = append(dashboardChildNavs, &dtos.NavLink{
+ Text: "Scenes",
+ Id: "scenes",
+ Url: hs.Cfg.AppSubURL + "/scenes",
+ Icon: "apps",
+ })
+ }
+
if hasEditPerm {
dashboardChildNavs = append(dashboardChildNavs, &dtos.NavLink{
Text: "Divider", Divider: true, Id: "divider", HideFromTabs: true,
@@ -646,6 +656,16 @@ func (hs *HTTPServer) buildAdminNavLinks(c *models.ReqContext) []*dtos.NavLink {
})
}
+ if hasAccess(ac.ReqGrafanaAdmin, ac.EvalPermission(ac.ActionSettingsRead)) && hs.Features.IsEnabled(featuremgmt.FlagStorage) {
+ adminNavLinks = append(adminNavLinks, &dtos.NavLink{
+ Text: "Storage",
+ Id: "storage",
+ Description: "Manage file storage",
+ Icon: "cube",
+ Url: hs.Cfg.AppSubURL + "/admin/storage",
+ })
+ }
+
if hs.Cfg.LDAPEnabled && hasAccess(ac.ReqGrafanaAdmin, ac.EvalPermission(ac.ActionLDAPStatusRead)) {
adminNavLinks = append(adminNavLinks, &dtos.NavLink{
Text: "LDAP", Id: "ldap", Url: hs.Cfg.AppSubURL + "/admin/ldap", Icon: "book",
@@ -663,7 +683,7 @@ func (hs *HTTPServer) buildAdminNavLinks(c *models.ReqContext) []*dtos.NavLink {
func (hs *HTTPServer) editorInAnyFolder(c *models.ReqContext) bool {
hasEditPermissionInFoldersQuery := models.HasEditPermissionInFoldersQuery{SignedInUser: c.SignedInUser}
- if err := hs.dashboardService.HasEditPermissionInFolders(c.Req.Context(), &hasEditPermissionInFoldersQuery); err != nil {
+ if err := hs.DashboardService.HasEditPermissionInFolders(c.Req.Context(), &hasEditPermissionInFoldersQuery); err != nil {
return false
}
return hasEditPermissionInFoldersQuery.Result
diff --git a/pkg/api/playlist_play.go b/pkg/api/playlist_play.go
index c75a550d579..035c4d402f4 100644
--- a/pkg/api/playlist_play.go
+++ b/pkg/api/playlist_play.go
@@ -16,7 +16,7 @@ func (hs *HTTPServer) populateDashboardsByID(ctx context.Context, dashboardByIDs
if len(dashboardByIDs) > 0 {
dashboardQuery := models.GetDashboardsQuery{DashboardIds: dashboardByIDs}
- if err := hs.dashboardService.GetDashboards(ctx, &dashboardQuery); err != nil {
+ if err := hs.DashboardService.GetDashboards(ctx, &dashboardQuery); err != nil {
return result, err
}
diff --git a/pkg/api/plugins_test.go b/pkg/api/plugins_test.go
index 9e869285efd..8aefeac8e62 100644
--- a/pkg/api/plugins_test.go
+++ b/pkg/api/plugins_test.go
@@ -4,25 +4,96 @@ import (
"context"
"encoding/json"
"fmt"
+ "io"
"io/ioutil"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
+ "strings"
"testing"
- "github.com/grafana/grafana/pkg/infra/log/logtest"
-
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/grafana/grafana-plugin-sdk-go/backend"
"github.com/grafana/grafana/pkg/infra/log"
+ "github.com/grafana/grafana/pkg/infra/log/logtest"
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/plugins"
"github.com/grafana/grafana/pkg/setting"
+ "github.com/grafana/grafana/pkg/web/webtest"
)
+func Test_PluginsInstallAndUninstall(t *testing.T) {
+ type tc struct {
+ pluginAdminEnabled bool
+ pluginAdminExternalManageEnabled bool
+ expectedHTTPStatus int
+ expectedHTTPBody string
+ }
+ tcs := []tc{
+ {pluginAdminEnabled: true, pluginAdminExternalManageEnabled: true, expectedHTTPStatus: 404, expectedHTTPBody: "404 page not found\n"},
+ {pluginAdminEnabled: true, pluginAdminExternalManageEnabled: false, expectedHTTPStatus: 200, expectedHTTPBody: ""},
+ {pluginAdminEnabled: false, pluginAdminExternalManageEnabled: true, expectedHTTPStatus: 404, expectedHTTPBody: "404 page not found\n"},
+ {pluginAdminEnabled: false, pluginAdminExternalManageEnabled: false, expectedHTTPStatus: 404, expectedHTTPBody: "404 page not found\n"},
+ }
+
+ testName := func(action string, testCase tc) string {
+ return fmt.Sprintf("%s request returns %d when adminEnabled: %t and externalEnabled: %t",
+ action, testCase.expectedHTTPStatus, testCase.pluginAdminEnabled, testCase.pluginAdminExternalManageEnabled)
+ }
+
+ pm := &fakePluginManager{
+ plugins: make(map[string]fakePlugin),
+ }
+ for _, tc := range tcs {
+ srv := SetupAPITestServer(t, func(hs *HTTPServer) {
+ hs.Cfg = &setting.Cfg{
+ PluginAdminEnabled: tc.pluginAdminEnabled,
+ PluginAdminExternalManageEnabled: tc.pluginAdminExternalManageEnabled,
+ }
+ hs.pluginManager = pm
+ })
+
+ t.Run(testName("Install", tc), func(t *testing.T) {
+ req := srv.NewPostRequest("/api/plugins/test/install", strings.NewReader("{ \"version\": \"1.0.2\" }"))
+ webtest.RequestWithSignedInUser(req, &models.SignedInUser{UserId: 1, OrgId: 1, OrgRole: models.ROLE_EDITOR, IsGrafanaAdmin: true})
+ resp, err := srv.SendJSON(req)
+ require.NoError(t, err)
+
+ body := new(strings.Builder)
+ _, err = io.Copy(body, resp.Body)
+ require.NoError(t, err)
+ require.Equal(t, tc.expectedHTTPBody, body.String())
+ require.NoError(t, resp.Body.Close())
+ require.Equal(t, tc.expectedHTTPStatus, resp.StatusCode)
+
+ if tc.expectedHTTPStatus == 200 {
+ require.Equal(t, fakePlugin{pluginID: "test", version: "1.0.2"}, pm.plugins["test"])
+ }
+ })
+
+ t.Run(testName("Uninstall", tc), func(t *testing.T) {
+ req := srv.NewPostRequest("/api/plugins/test/uninstall", strings.NewReader("{}"))
+ webtest.RequestWithSignedInUser(req, &models.SignedInUser{UserId: 1, OrgId: 1, OrgRole: models.ROLE_VIEWER, IsGrafanaAdmin: true})
+ resp, err := srv.SendJSON(req)
+ require.NoError(t, err)
+
+ body := new(strings.Builder)
+ _, err = io.Copy(body, resp.Body)
+ require.NoError(t, err)
+ require.Equal(t, tc.expectedHTTPBody, body.String())
+ require.NoError(t, resp.Body.Close())
+ require.Equal(t, tc.expectedHTTPStatus, resp.StatusCode)
+
+ if tc.expectedHTTPStatus == 200 {
+ require.Empty(t, pm.plugins)
+ }
+ })
+ }
+}
+
func Test_GetPluginAssets(t *testing.T) {
pluginID := "test-plugin"
pluginDir := "."
diff --git a/pkg/api/preferences.go b/pkg/api/preferences.go
index e1acad29947..e13f6b07837 100644
--- a/pkg/api/preferences.go
+++ b/pkg/api/preferences.go
@@ -31,7 +31,7 @@ func (hs *HTTPServer) SetHomeDashboard(c *models.ReqContext) response.Response {
dashboardID := cmd.HomeDashboardID
if cmd.HomeDashboardUID != nil {
query := models.GetDashboardQuery{Uid: *cmd.HomeDashboardUID}
- err := hs.dashboardService.GetDashboard(c.Req.Context(), &query)
+ err := hs.DashboardService.GetDashboard(c.Req.Context(), &query)
if err != nil {
return response.Error(404, "Dashboard not found", err)
}
@@ -65,7 +65,7 @@ func (hs *HTTPServer) getPreferencesFor(ctx context.Context, orgID, userID, team
// when homedashboardID is 0, that means it is the default home dashboard, no UID would be returned in the response
if preference.HomeDashboardID != 0 {
query := models.GetDashboardQuery{Id: preference.HomeDashboardID, OrgId: orgID}
- err = hs.dashboardService.GetDashboard(ctx, &query)
+ err = hs.DashboardService.GetDashboard(ctx, &query)
if err == nil {
dashboardUID = query.Result.Uid
}
@@ -105,7 +105,7 @@ func (hs *HTTPServer) updatePreferencesFor(ctx context.Context, orgID, userID, t
dashboardID := dtoCmd.HomeDashboardID
if dtoCmd.HomeDashboardUID != nil {
query := models.GetDashboardQuery{Uid: *dtoCmd.HomeDashboardUID, OrgId: orgID}
- err := hs.dashboardService.GetDashboard(ctx, &query)
+ err := hs.DashboardService.GetDashboard(ctx, &query)
if err != nil {
return response.Error(404, "Dashboard not found", err)
}
@@ -151,7 +151,7 @@ func (hs *HTTPServer) patchPreferencesFor(ctx context.Context, orgID, userID, te
dashboardID := dtoCmd.HomeDashboardID
if dtoCmd.HomeDashboardUID != nil {
query := models.GetDashboardQuery{Uid: *dtoCmd.HomeDashboardUID, OrgId: orgID}
- err := hs.dashboardService.GetDashboard(ctx, &query)
+ err := hs.DashboardService.GetDashboard(ctx, &query)
if err != nil {
return response.Error(404, "Dashboard not found", err)
}
diff --git a/pkg/api/preferences_test.go b/pkg/api/preferences_test.go
index e62af23b504..5796ad1e867 100644
--- a/pkg/api/preferences_test.go
+++ b/pkg/api/preferences_test.go
@@ -40,7 +40,7 @@ func TestAPIEndpoint_GetCurrentOrgPreferences_LegacyAccessControl(t *testing.T)
q.Result = &models.Dashboard{Uid: "home", Id: 1}
}).Return(nil)
- sc.hs.dashboardService = dashSvc
+ sc.hs.DashboardService = dashSvc
prefService := preftest.NewPreferenceServiceFake()
prefService.ExpectedPreference = &pref.Preference{HomeDashboardID: 1, Theme: "dark"}
@@ -169,7 +169,7 @@ func TestAPIEndpoint_PatchUserPreferences(t *testing.T) {
q := args.Get(1).(*models.GetDashboardQuery)
q.Result = &models.Dashboard{Uid: "home", Id: 1}
}).Return(nil)
- sc.hs.dashboardService = dashSvc
+ sc.hs.DashboardService = dashSvc
t.Run("Returns 200 on success", func(t *testing.T) {
response := callAPI(sc.server, http.MethodPatch, patchUserPreferencesUrl, input, t)
assert.Equal(t, http.StatusOK, response.Code)
diff --git a/pkg/api/stars.go b/pkg/api/stars.go
index 73eeae19ab1..fb8e76114ac 100644
--- a/pkg/api/stars.go
+++ b/pkg/api/stars.go
@@ -26,7 +26,7 @@ func (hs *HTTPServer) GetStars(c *models.ReqContext) response.Response {
Id: dashboardId,
OrgId: c.OrgId,
}
- err := hs.dashboardService.GetDashboard(c.Req.Context(), query)
+ err := hs.DashboardService.GetDashboard(c.Req.Context(), query)
// Grafana admin users may have starred dashboards in multiple orgs. This will avoid returning errors when the dashboard is in another org
if err == nil {
diff --git a/pkg/models/dashboard_queries.go b/pkg/models/dashboard_queries.go
index 0490071b116..7f27011e73c 100644
--- a/pkg/models/dashboard_queries.go
+++ b/pkg/models/dashboard_queries.go
@@ -4,7 +4,23 @@ import (
"github.com/grafana/grafana/pkg/components/simplejson"
)
-func GetQueriesFromDashboard(dashboard *simplejson.Json) map[int64][]*simplejson.Json {
+func GetUniqueDashboardDatasourceUids(dashboard *simplejson.Json) []string {
+ var datasourceUids []string
+ exists := map[string]bool{}
+
+ for _, panelObj := range dashboard.Get("panels").MustArray() {
+ panel := simplejson.NewFromAny(panelObj)
+ uid := panel.Get("datasource").Get("uid").MustString()
+ if _, ok := exists[uid]; !ok {
+ datasourceUids = append(datasourceUids, uid)
+ exists[uid] = true
+ }
+ }
+
+ return datasourceUids
+}
+
+func GroupQueriesByPanelId(dashboard *simplejson.Json) map[int64][]*simplejson.Json {
result := make(map[int64][]*simplejson.Json)
for _, panelObj := range dashboard.Get("panels").MustArray() {
diff --git a/pkg/models/dashboard_queries_test.go b/pkg/models/dashboard_queries_test.go
index 95daa3bae22..ed02d11c88b 100644
--- a/pkg/models/dashboard_queries_test.go
+++ b/pkg/models/dashboard_queries_test.go
@@ -56,6 +56,79 @@ const (
"schemaVersion": 35
}`
+ dashboardWithDuplicateDatasources = `
+{
+ "panels": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "abc123"
+ },
+ "id": 1,
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "abc123"
+ },
+ "exemplar": true,
+ "expr": "go_goroutines{job=\"$job\"}",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ ],
+ "title": "Panel Title",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "_yxMP8Ynk"
+ },
+ "id": 2,
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "_yxMP8Ynk"
+ },
+ "exemplar": true,
+ "expr": "go_goroutines{job=\"$job\"}",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ ],
+ "title": "Panel Title",
+ "type": "timeseries"
+ },
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "_yxMP8Ynk"
+ },
+ "id": 3,
+ "targets": [
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "_yxMP8Ynk"
+ },
+ "exemplar": true,
+ "expr": "go_goroutines{job=\"$job\"}",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ ],
+ "title": "Panel Title",
+ "type": "timeseries"
+ }
+ ],
+ "schemaVersion": 35
+}`
+
oldStyleDashboard = `
{
"panels": [
@@ -79,12 +152,32 @@ const (
}`
)
-func TestGetQueriesFromDashboard(t *testing.T) {
+func TestGetUniqueDashboardDatasourceUids(t *testing.T) {
+ t.Run("can get unique datasource ids from dashboard", func(t *testing.T) {
+ json, err := simplejson.NewJson([]byte(dashboardWithDuplicateDatasources))
+ require.NoError(t, err)
+
+ uids := GetUniqueDashboardDatasourceUids(json)
+ require.Len(t, uids, 2)
+ require.Equal(t, "abc123", uids[0])
+ require.Equal(t, "_yxMP8Ynk", uids[1])
+ })
+
+ t.Run("can get no datasource uids from empty dashboard", func(t *testing.T) {
+ json, err := simplejson.NewJson([]byte(`{"panels": {}}`))
+ require.NoError(t, err)
+
+ uids := GetUniqueDashboardDatasourceUids(json)
+ require.Len(t, uids, 0)
+ })
+}
+
+func TestGroupQueriesByPanelId(t *testing.T) {
t.Run("can extract no queries from empty dashboard", func(t *testing.T) {
json, err := simplejson.NewJson([]byte(`{"panels": {}}`))
require.NoError(t, err)
- queries := GetQueriesFromDashboard(json)
+ queries := GroupQueriesByPanelId(json)
require.Len(t, queries, 0)
})
@@ -92,7 +185,7 @@ func TestGetQueriesFromDashboard(t *testing.T) {
json, err := simplejson.NewJson([]byte(dashboardWithNoQueries))
require.NoError(t, err)
- queries := GetQueriesFromDashboard(json)
+ queries := GroupQueriesByPanelId(json)
require.Len(t, queries, 1)
require.Contains(t, queries, int64(2))
require.Len(t, queries[2], 0)
@@ -102,7 +195,7 @@ func TestGetQueriesFromDashboard(t *testing.T) {
json, err := simplejson.NewJson([]byte(dashboardWithQueries))
require.NoError(t, err)
- queries := GetQueriesFromDashboard(json)
+ queries := GroupQueriesByPanelId(json)
require.Len(t, queries, 1)
require.Contains(t, queries, int64(2))
require.Len(t, queries[2], 2)
@@ -138,7 +231,7 @@ func TestGetQueriesFromDashboard(t *testing.T) {
json, err := simplejson.NewJson([]byte(oldStyleDashboard))
require.NoError(t, err)
- queries := GetQueriesFromDashboard(json)
+ queries := GroupQueriesByPanelId(json)
require.Len(t, queries, 1)
require.Contains(t, queries, int64(2))
require.Len(t, queries[2], 1)
diff --git a/pkg/server/wire.go b/pkg/server/wire.go
index c53b0bf19b0..8c3aafa4930 100644
--- a/pkg/server/wire.go
+++ b/pkg/server/wire.go
@@ -77,6 +77,10 @@ import (
"github.com/grafana/grafana/pkg/services/pluginsettings"
pluginSettings "github.com/grafana/grafana/pkg/services/pluginsettings/service"
"github.com/grafana/grafana/pkg/services/preference/prefimpl"
+ "github.com/grafana/grafana/pkg/services/publicdashboards"
+ publicdashboardsApi "github.com/grafana/grafana/pkg/services/publicdashboards/api"
+ publicdashboardsStore "github.com/grafana/grafana/pkg/services/publicdashboards/database"
+ publicdashboardsService "github.com/grafana/grafana/pkg/services/publicdashboards/service"
"github.com/grafana/grafana/pkg/services/query"
"github.com/grafana/grafana/pkg/services/queryhistory"
"github.com/grafana/grafana/pkg/services/quota"
@@ -275,6 +279,11 @@ var wireBasicSet = wire.NewSet(
wire.Bind(new(accesscontrol.DashboardPermissionsService), new(*ossaccesscontrol.DashboardPermissionsService)),
starimpl.ProvideService,
dashverimpl.ProvideService,
+ publicdashboardsService.ProvideService,
+ wire.Bind(new(publicdashboards.Service), new(*publicdashboardsService.PublicDashboardServiceImpl)),
+ publicdashboardsStore.ProvideStore,
+ wire.Bind(new(publicdashboards.Store), new(*publicdashboardsStore.PublicDashboardStoreImpl)),
+ publicdashboardsApi.ProvideApi,
userimpl.ProvideService,
orgimpl.ProvideService,
)
diff --git a/pkg/services/accesscontrol/database/database.go b/pkg/services/accesscontrol/database/database.go
index c89b0801341..9e4d02f4b92 100644
--- a/pkg/services/accesscontrol/database/database.go
+++ b/pkg/services/accesscontrol/database/database.go
@@ -2,6 +2,7 @@ package database
import (
"context"
+ "strconv"
"strings"
"github.com/grafana/grafana/pkg/services/accesscontrol"
@@ -110,3 +111,46 @@ func deletePermissions(sess *sqlstore.DBSession, ids []int64) error {
return nil
}
+
+func (s *AccessControlStore) DeleteUserPermissions(ctx context.Context, userID int64) error {
+ err := s.sql.WithDbSession(ctx, func(sess *sqlstore.DBSession) error {
+ // Delete user role assignments
+ if _, err := sess.Exec("DELETE FROM user_role WHERE user_id = ?", userID); err != nil {
+ return err
+ }
+
+ // Delete permissions that are scoped to user
+ if _, err := sess.Exec("DELETE FROM permission WHERE scope = ?", accesscontrol.Scope("users", "id", strconv.FormatInt(userID, 10))); err != nil {
+ return err
+ }
+
+ var roleIDs []int64
+ if err := sess.SQL("SELECT id FROM role WHERE name = ?", accesscontrol.ManagedUserRoleName(userID)).Find(&roleIDs); err != nil {
+ return err
+ }
+
+ if len(roleIDs) == 0 {
+ return nil
+ }
+
+ query := "DELETE FROM permission WHERE role_id IN(? " + strings.Repeat(",?", len(roleIDs)-1) + ")"
+ args := make([]interface{}, 0, len(roleIDs)+1)
+ args = append(args, query)
+ for _, id := range roleIDs {
+ args = append(args, id)
+ }
+
+ // Delete managed user permissions
+ if _, err := sess.Exec(args...); err != nil {
+ return err
+ }
+
+ // Delete managed user roles
+ if _, err := sess.Exec("DELETE FROM role WHERE name = ?", accesscontrol.ManagedUserRoleName(userID)); err != nil {
+ return err
+ }
+
+ return nil
+ })
+ return err
+}
diff --git a/pkg/services/accesscontrol/database/database_test.go b/pkg/services/accesscontrol/database/database_test.go
index 094f27fd01c..1531523dc67 100644
--- a/pkg/services/accesscontrol/database/database_test.go
+++ b/pkg/services/accesscontrol/database/database_test.go
@@ -131,6 +131,31 @@ func TestAccessControlStore_GetUserPermissions(t *testing.T) {
}
}
+func TestAccessControlStore_DeleteUserPermissions(t *testing.T) {
+ store, sql := setupTestEnv(t)
+
+ user, _ := createUserAndTeam(t, sql, 1)
+
+ _, err := store.SetUserResourcePermission(context.Background(), 1, accesscontrol.User{ID: user.ID}, types.SetResourcePermissionCommand{
+ Actions: []string{"dashboards:write"},
+ Resource: "dashboards",
+ ResourceID: "1",
+ }, nil)
+ require.NoError(t, err)
+
+ err = store.DeleteUserPermissions(context.Background(), user.ID)
+ require.NoError(t, err)
+
+ permissions, err := store.GetUserPermissions(context.Background(), accesscontrol.GetUserPermissionsQuery{
+ OrgID: 1,
+ UserID: user.ID,
+ Roles: []string{"Admin"},
+ Actions: []string{"dashboards:write"},
+ })
+ require.NoError(t, err)
+ assert.Len(t, permissions, 0)
+}
+
func createUserAndTeam(t *testing.T, sql *sqlstore.SQLStore, orgID int64) (*user.User, models.Team) {
t.Helper()
diff --git a/pkg/services/accesscontrol/database/resource_permissions.go b/pkg/services/accesscontrol/database/resource_permissions.go
index ab34e1c63f3..0a39bb2663a 100644
--- a/pkg/services/accesscontrol/database/resource_permissions.go
+++ b/pkg/services/accesscontrol/database/resource_permissions.go
@@ -9,23 +9,25 @@ import (
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/services/accesscontrol"
"github.com/grafana/grafana/pkg/services/accesscontrol/resourcepermissions/types"
+ "github.com/grafana/grafana/pkg/services/serviceaccounts"
"github.com/grafana/grafana/pkg/services/sqlstore"
)
type flatResourcePermission struct {
- ID int64 `xorm:"id"`
- RoleName string
- Action string
- Scope string
- UserId int64
- UserLogin string
- UserEmail string
- TeamId int64
- TeamEmail string
- Team string
- BuiltInRole string
- Created time.Time
- Updated time.Time
+ ID int64 `xorm:"id"`
+ RoleName string
+ Action string
+ Scope string
+ UserId int64
+ UserLogin string
+ UserEmail string
+ UserIsServiceAccount bool
+ TeamId int64
+ TeamEmail string
+ Team string
+ BuiltInRole string
+ Created time.Time
+ Updated time.Time
}
func (p *flatResourcePermission) IsManaged(scope string) bool {
@@ -292,6 +294,7 @@ func (s *AccessControlStore) getResourcePermissions(sess *sqlstore.DBSession, or
ur.user_id AS user_id,
u.login AS user_login,
u.email AS user_email,
+ u.is_service_account AS user_is_service_account,
0 AS team_id,
'' AS team,
'' AS team_email,
@@ -302,6 +305,7 @@ func (s *AccessControlStore) getResourcePermissions(sess *sqlstore.DBSession, or
0 AS user_id,
'' AS user_login,
'' AS user_email,
+ false AS user_is_service_account,
tr.team_id AS team_id,
t.name AS team,
t.email AS team_email,
@@ -312,6 +316,7 @@ func (s *AccessControlStore) getResourcePermissions(sess *sqlstore.DBSession, or
0 AS user_id,
'' AS user_login,
'' AS user_email,
+ false AS user_is_service_account,
0 as team_id,
'' AS team,
'' AS team_email,
@@ -370,8 +375,13 @@ func (s *AccessControlStore) getResourcePermissions(sess *sqlstore.DBSession, or
if err != nil {
return nil, err
}
- user := userSelect + userFrom + where + " AND " + userFilter.Where
+ serviceAccountFilter, err := accesscontrol.Filter(query.User, "u.id", "serviceaccounts:id:", serviceaccounts.ActionRead)
+ if err != nil {
+ return nil, err
+ }
+ user := userSelect + userFrom + where + " AND (" + userFilter.Where + " OR " + serviceAccountFilter.Where + ") "
args = append(args, userFilter.Args...)
+ args = append(args, serviceAccountFilter.Args...)
teamFilter, err := accesscontrol.Filter(query.User, "t.id", "teams:id:", accesscontrol.ActionTeamsRead)
if err != nil {
@@ -457,20 +467,21 @@ func flatPermissionsToResourcePermission(scope string, permissions []flatResourc
first := permissions[0]
return &accesscontrol.ResourcePermission{
- ID: first.ID,
- RoleName: first.RoleName,
- Actions: actions,
- Scope: first.Scope,
- UserId: first.UserId,
- UserLogin: first.UserLogin,
- UserEmail: first.UserEmail,
- TeamId: first.TeamId,
- TeamEmail: first.TeamEmail,
- Team: first.Team,
- BuiltInRole: first.BuiltInRole,
- Created: first.Created,
- Updated: first.Updated,
- IsManaged: first.IsManaged(scope),
+ ID: first.ID,
+ RoleName: first.RoleName,
+ Actions: actions,
+ Scope: first.Scope,
+ UserId: first.UserId,
+ UserLogin: first.UserLogin,
+ UserEmail: first.UserEmail,
+ UserIsServiceAccount: first.UserIsServiceAccount,
+ TeamId: first.TeamId,
+ TeamEmail: first.TeamEmail,
+ Team: first.Team,
+ BuiltInRole: first.BuiltInRole,
+ Created: first.Created,
+ Updated: first.Updated,
+ IsManaged: first.IsManaged(scope),
}
}
@@ -581,6 +592,7 @@ func (s *AccessControlStore) getResourcePermissionsByIds(sess *sqlstore.DBSessio
ur.user_id AS user_id,
u.login AS user_login,
u.email AS user_email,
+ u.is_service_account AS user_is_service_account,
tr.team_id AS team_id,
t.name AS team,
t.email AS team_email,
diff --git a/pkg/services/accesscontrol/models.go b/pkg/services/accesscontrol/models.go
index 0317ea73b52..85ef4f1188b 100644
--- a/pkg/services/accesscontrol/models.go
+++ b/pkg/services/accesscontrol/models.go
@@ -222,20 +222,21 @@ type ScopeParams struct {
// ResourcePermission is structure that holds all actions that either a team / user / builtin-role
// can perform against specific resource.
type ResourcePermission struct {
- ID int64
- RoleName string
- Actions []string
- Scope string
- UserId int64
- UserLogin string
- UserEmail string
- TeamId int64
- TeamEmail string
- Team string
- BuiltInRole string
- IsManaged bool
- Created time.Time
- Updated time.Time
+ ID int64
+ RoleName string
+ Actions []string
+ Scope string
+ UserId int64
+ UserLogin string
+ UserEmail string
+ UserIsServiceAccount bool
+ TeamId int64
+ TeamEmail string
+ Team string
+ BuiltInRole string
+ IsManaged bool
+ Created time.Time
+ Updated time.Time
}
func (p *ResourcePermission) Contains(targetActions []string) bool {
diff --git a/pkg/services/accesscontrol/ossaccesscontrol/permissions_services.go b/pkg/services/accesscontrol/ossaccesscontrol/permissions_services.go
index a271c3bbd6f..de8da4c50b4 100644
--- a/pkg/services/accesscontrol/ossaccesscontrol/permissions_services.go
+++ b/pkg/services/accesscontrol/ossaccesscontrol/permissions_services.go
@@ -58,9 +58,10 @@ func ProvideTeamPermissions(
return nil
},
Assignments: resourcepermissions.Assignments{
- Users: true,
- Teams: false,
- BuiltInRoles: false,
+ Users: true,
+ Teams: false,
+ BuiltInRoles: false,
+ ServiceAccounts: true,
},
PermissionsToActions: map[string][]string{
"Member": TeamMemberActions,
@@ -149,9 +150,10 @@ func ProvideDashboardPermissions(
return []string{}, nil
},
Assignments: resourcepermissions.Assignments{
- Users: true,
- Teams: true,
- BuiltInRoles: true,
+ Users: true,
+ Teams: true,
+ BuiltInRoles: true,
+ ServiceAccounts: false,
},
PermissionsToActions: map[string][]string{
"View": DashboardViewActions,
@@ -206,9 +208,10 @@ func ProvideFolderPermissions(
return nil
},
Assignments: resourcepermissions.Assignments{
- Users: true,
- Teams: true,
- BuiltInRoles: true,
+ Users: true,
+ Teams: true,
+ BuiltInRoles: true,
+ ServiceAccounts: false,
},
PermissionsToActions: map[string][]string{
"View": append(DashboardViewActions, FolderViewActions...),
diff --git a/pkg/services/accesscontrol/resourcepermissions/api.go b/pkg/services/accesscontrol/resourcepermissions/api.go
index a1892130cfd..c4d8d963ef8 100644
--- a/pkg/services/accesscontrol/resourcepermissions/api.go
+++ b/pkg/services/accesscontrol/resourcepermissions/api.go
@@ -40,7 +40,7 @@ func (a *api) registerEndpoints() {
scope := accesscontrol.Scope(a.service.options.Resource, a.service.options.ResourceAttribute, accesscontrol.Parameter(":resourceID"))
r.Get("/description", auth(disable, accesscontrol.EvalPermission(actionRead)), routing.Wrap(a.getDescription))
r.Get("/:resourceID", inheritanceSolver, auth(disable, accesscontrol.EvalPermission(actionRead, scope)), routing.Wrap(a.getPermissions))
- if a.service.options.Assignments.Users {
+ if a.service.options.Assignments.Users || a.service.options.Assignments.ServiceAccounts {
r.Post("/:resourceID/users/:userID", inheritanceSolver, auth(disable, accesscontrol.EvalPermission(actionWrite, scope)), routing.Wrap(a.setUserPermission))
}
if a.service.options.Assignments.Teams {
@@ -53,9 +53,10 @@ func (a *api) registerEndpoints() {
}
type Assignments struct {
- Users bool `json:"users"`
- Teams bool `json:"teams"`
- BuiltInRoles bool `json:"builtInRoles"`
+ Users bool `json:"users"`
+ Teams bool `json:"teams"`
+ BuiltInRoles bool `json:"builtInRoles"`
+ ServiceAccounts bool `json:"serviceAccounts"`
}
type Description struct {
@@ -71,18 +72,19 @@ func (a *api) getDescription(c *models.ReqContext) response.Response {
}
type resourcePermissionDTO struct {
- ID int64 `json:"id"`
- RoleName string `json:"roleName"`
- IsManaged bool `json:"isManaged"`
- UserID int64 `json:"userId,omitempty"`
- UserLogin string `json:"userLogin,omitempty"`
- UserAvatarUrl string `json:"userAvatarUrl,omitempty"`
- Team string `json:"team,omitempty"`
- TeamID int64 `json:"teamId,omitempty"`
- TeamAvatarUrl string `json:"teamAvatarUrl,omitempty"`
- BuiltInRole string `json:"builtInRole,omitempty"`
- Actions []string `json:"actions"`
- Permission string `json:"permission"`
+ ID int64 `json:"id"`
+ RoleName string `json:"roleName"`
+ IsManaged bool `json:"isManaged"`
+ UserID int64 `json:"userId,omitempty"`
+ UserLogin string `json:"userLogin,omitempty"`
+ UserAvatarUrl string `json:"userAvatarUrl,omitempty"`
+ UserIsServiceAccount bool `json:"userIsServiceAccount,omitempty"`
+ Team string `json:"team,omitempty"`
+ TeamID int64 `json:"teamId,omitempty"`
+ TeamAvatarUrl string `json:"teamAvatarUrl,omitempty"`
+ BuiltInRole string `json:"builtInRole,omitempty"`
+ Actions []string `json:"actions"`
+ Permission string `json:"permission"`
}
func (a *api) getPermissions(c *models.ReqContext) response.Response {
@@ -110,18 +112,19 @@ func (a *api) getPermissions(c *models.ReqContext) response.Response {
}
dto = append(dto, resourcePermissionDTO{
- ID: p.ID,
- RoleName: p.RoleName,
- UserID: p.UserId,
- UserLogin: p.UserLogin,
- UserAvatarUrl: dtos.GetGravatarUrl(p.UserEmail),
- Team: p.Team,
- TeamID: p.TeamId,
- TeamAvatarUrl: teamAvatarUrl,
- BuiltInRole: p.BuiltInRole,
- Actions: p.Actions,
- Permission: permission,
- IsManaged: p.IsManaged,
+ ID: p.ID,
+ RoleName: p.RoleName,
+ UserID: p.UserId,
+ UserLogin: p.UserLogin,
+ UserAvatarUrl: dtos.GetGravatarUrl(p.UserEmail),
+ UserIsServiceAccount: p.UserIsServiceAccount,
+ Team: p.Team,
+ TeamID: p.TeamId,
+ TeamAvatarUrl: teamAvatarUrl,
+ BuiltInRole: p.BuiltInRole,
+ Actions: p.Actions,
+ Permission: permission,
+ IsManaged: p.IsManaged,
})
}
}
diff --git a/pkg/services/accesscontrol/resourcepermissions/api_test.go b/pkg/services/accesscontrol/resourcepermissions/api_test.go
index 2f32ae41b81..2178aa8d0fe 100644
--- a/pkg/services/accesscontrol/resourcepermissions/api_test.go
+++ b/pkg/services/accesscontrol/resourcepermissions/api_test.go
@@ -18,6 +18,7 @@ import (
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/services/accesscontrol"
"github.com/grafana/grafana/pkg/services/contexthandler/ctxkey"
+ "github.com/grafana/grafana/pkg/services/serviceaccounts"
"github.com/grafana/grafana/pkg/services/sqlstore"
"github.com/grafana/grafana/pkg/services/user"
"github.com/grafana/grafana/pkg/setting"
@@ -159,12 +160,12 @@ func TestApi_getPermissions(t *testing.T) {
for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
- service, sql := setupTestEnvironment(t, tt.permissions, testOptions)
+ service, sql := setupTestEnvironment(t, tt.permissions, testOptionsDashboards)
server := setupTestServer(t, &models.SignedInUser{OrgId: 1, Permissions: map[int64]map[string][]string{1: accesscontrol.GroupScopesByAction(tt.permissions)}}, service)
seedPermissions(t, tt.resourceID, sql, service)
- permissions, recorder := getPermission(t, server, testOptions.Resource, tt.resourceID)
+ permissions, recorder := getPermission(t, server, testOptionsDashboards.Resource, tt.resourceID)
assert.Equal(t, tt.expectedStatus, recorder.Code)
if tt.expectedStatus == http.StatusOK {
@@ -236,14 +237,14 @@ func TestApi_setBuiltinRolePermission(t *testing.T) {
for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
- service, _ := setupTestEnvironment(t, tt.permissions, testOptions)
+ service, _ := setupTestEnvironment(t, tt.permissions, testOptionsDashboards)
server := setupTestServer(t, &models.SignedInUser{OrgId: 1, Permissions: map[int64]map[string][]string{1: accesscontrol.GroupScopesByAction(tt.permissions)}}, service)
- recorder := setPermission(t, server, testOptions.Resource, tt.resourceID, tt.permission, "builtInRoles", tt.builtInRole)
+ recorder := setPermission(t, server, testOptionsDashboards.Resource, tt.resourceID, tt.permission, "builtInRoles", tt.builtInRole)
assert.Equal(t, tt.expectedStatus, recorder.Code)
if tt.expectedStatus == http.StatusOK {
- permissions, _ := getPermission(t, server, testOptions.Resource, tt.resourceID)
+ permissions, _ := getPermission(t, server, testOptionsDashboards.Resource, tt.resourceID)
require.Len(t, permissions, 1)
assert.Equal(t, tt.permission, permissions[0].Permission)
assert.Equal(t, tt.builtInRole, permissions[0].BuiltInRole)
@@ -314,19 +315,19 @@ func TestApi_setTeamPermission(t *testing.T) {
for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
- service, sql := setupTestEnvironment(t, tt.permissions, testOptions)
+ service, sql := setupTestEnvironment(t, tt.permissions, testOptionsDashboards)
server := setupTestServer(t, &models.SignedInUser{OrgId: 1, Permissions: map[int64]map[string][]string{1: accesscontrol.GroupScopesByAction(tt.permissions)}}, service)
// seed team
_, err := sql.CreateTeam("test", "test@test.com", 1)
require.NoError(t, err)
- recorder := setPermission(t, server, testOptions.Resource, tt.resourceID, tt.permission, "teams", strconv.Itoa(int(tt.teamID)))
+ recorder := setPermission(t, server, testOptionsDashboards.Resource, tt.resourceID, tt.permission, "teams", strconv.Itoa(int(tt.teamID)))
assert.Equal(t, tt.expectedStatus, recorder.Code)
assert.Equal(t, tt.expectedStatus, recorder.Code)
if tt.expectedStatus == http.StatusOK {
- permissions, _ := getPermission(t, server, testOptions.Resource, tt.resourceID)
+ permissions, _ := getPermission(t, server, testOptionsDashboards.Resource, tt.resourceID)
require.Len(t, permissions, 1)
assert.Equal(t, tt.permission, permissions[0].Permission)
assert.Equal(t, tt.teamID, permissions[0].TeamID)
@@ -397,19 +398,18 @@ func TestApi_setUserPermission(t *testing.T) {
for _, tt := range tests {
t.Run(tt.desc, func(t *testing.T) {
- service, sql := setupTestEnvironment(t, tt.permissions, testOptions)
+ service, sql := setupTestEnvironment(t, tt.permissions, testOptionsDashboards)
server := setupTestServer(t, &models.SignedInUser{OrgId: 1, Permissions: map[int64]map[string][]string{1: accesscontrol.GroupScopesByAction(tt.permissions)}}, service)
// seed user
_, err := sql.CreateUser(context.Background(), user.CreateUserCommand{Login: "test", OrgID: 1})
require.NoError(t, err)
- recorder := setPermission(t, server, testOptions.Resource, tt.resourceID, tt.permission, "users", strconv.Itoa(int(tt.userID)))
+ recorder := setPermission(t, server, testOptionsDashboards.Resource, tt.resourceID, tt.permission, "users", strconv.Itoa(int(tt.userID)))
assert.Equal(t, tt.expectedStatus, recorder.Code)
- assert.Equal(t, tt.expectedStatus, recorder.Code)
if tt.expectedStatus == http.StatusOK {
- permissions, _ := getPermission(t, server, testOptions.Resource, tt.resourceID)
+ permissions, _ := getPermission(t, server, testOptionsDashboards.Resource, tt.resourceID)
require.Len(t, permissions, 1)
assert.Equal(t, tt.permission, permissions[0].Permission)
assert.Equal(t, tt.userID, permissions[0].UserID)
@@ -418,6 +418,92 @@ func TestApi_setUserPermission(t *testing.T) {
}
}
+type setServiceAccountPermissionTestCase struct {
+ desc string
+ serviceaccountID int64
+ resourceID string
+ expectedStatus int
+ permission string
+ permissions []accesscontrol.Permission
+}
+
+func TestApi_setServiceAccountPermission(t *testing.T) {
+ tests := []setServiceAccountPermissionTestCase{
+ {
+ desc: "should set Edit permission for serviceaccount 1",
+ serviceaccountID: 1,
+ resourceID: "1",
+ expectedStatus: 200,
+ permission: "Edit",
+ permissions: []accesscontrol.Permission{
+ {Action: "teams.permissions:read", Scope: "teams:id:1"},
+ {Action: "teams.permissions:write", Scope: "teams:id:1"},
+ {Action: accesscontrol.ActionTeamsRead, Scope: accesscontrol.ScopeTeamsAll},
+ {Action: serviceaccounts.ActionRead, Scope: serviceaccounts.ScopeAll},
+ },
+ },
+ {
+ desc: "should set View permission for serviceaccount 1",
+ serviceaccountID: 1,
+ resourceID: "1",
+ expectedStatus: 200,
+ permission: "View",
+ permissions: []accesscontrol.Permission{
+ {Action: "teams.permissions:read", Scope: "teams:id:1"},
+ {Action: "teams.permissions:write", Scope: "teams:id:1"},
+ {Action: accesscontrol.ActionTeamsRead, Scope: accesscontrol.ScopeTeamsAll},
+ {Action: serviceaccounts.ActionRead, Scope: serviceaccounts.ScopeAll},
+ },
+ },
+ {
+ desc: "should set return http 400 when serviceaccount does not exist",
+ serviceaccountID: 2,
+ resourceID: "1",
+ expectedStatus: http.StatusBadRequest,
+ permission: "View",
+ permissions: []accesscontrol.Permission{
+ {Action: "teams.permissions:read", Scope: "teams:id:1"},
+ {Action: "teams.permissions:write", Scope: "teams:id:1"},
+ {Action: accesscontrol.ActionTeamsRead, Scope: accesscontrol.ScopeTeamsAll},
+ {Action: serviceaccounts.ActionRead, Scope: serviceaccounts.ScopeAll},
+ },
+ },
+ {
+ desc: "should return http 403 when missing permissions",
+ serviceaccountID: 1,
+ resourceID: "1",
+ expectedStatus: http.StatusForbidden,
+ permission: "View",
+ permissions: []accesscontrol.Permission{
+ {Action: "teams.permissions:read", Scope: "teams:id:1"},
+ {Action: accesscontrol.ActionTeamsRead, Scope: accesscontrol.ScopeTeamsAll},
+ },
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.desc, func(t *testing.T) {
+ service, sql := setupTestEnvironment(t, tt.permissions, testOptionsTeams)
+ server := setupTestServer(t, &models.SignedInUser{OrgId: 1, Permissions: map[int64]map[string][]string{1: accesscontrol.GroupScopesByAction(tt.permissions)}}, service)
+
+ // seed serviceaccount
+ _, err := sql.CreateUser(context.Background(), user.CreateUserCommand{Login: "test", OrgID: 1, IsServiceAccount: true})
+ require.NoError(t, err)
+
+ recorder := setPermission(t, server, testOptionsTeams.Resource, tt.resourceID, tt.permission, "users", strconv.Itoa(int(tt.serviceaccountID)))
+ assert.Equal(t, tt.expectedStatus, recorder.Code)
+
+ if tt.expectedStatus == http.StatusOK {
+ permissions, _ := getPermission(t, server, testOptionsTeams.Resource, tt.resourceID)
+ require.Len(t, permissions, 1)
+ assert.Equal(t, tt.permission, permissions[0].Permission)
+ assert.Equal(t, tt.serviceaccountID, permissions[0].UserID)
+ assert.Equal(t, true, permissions[0].UserIsServiceAccount)
+ }
+ })
+ }
+}
+
func setupTestServer(t *testing.T, user *models.SignedInUser, service *Service) *web.Mux {
server := web.New()
server.UseMiddleware(web.Renderer(path.Join(setting.StaticRootPath, "views"), "[[", "]]"))
@@ -444,13 +530,14 @@ func contextProvider(tc *testContext) web.Handler {
}
}
-var testOptions = Options{
+var testOptionsDashboards = Options{
Resource: "dashboards",
ResourceAttribute: "id",
Assignments: Assignments{
- Users: true,
- Teams: true,
- BuiltInRoles: true,
+ Users: true,
+ Teams: true,
+ BuiltInRoles: true,
+ ServiceAccounts: true,
},
PermissionsToActions: map[string][]string{
"View": {"dashboards:read"},
@@ -458,6 +545,21 @@ var testOptions = Options{
},
}
+var testOptionsTeams = Options{
+ Resource: "teams",
+ ResourceAttribute: "id",
+ Assignments: Assignments{
+ Users: true,
+ Teams: true,
+ BuiltInRoles: true,
+ ServiceAccounts: true,
+ },
+ PermissionsToActions: map[string][]string{
+ "View": {"teams:read"},
+ "Edit": {"teams:read", "teams:write", "teams:delete"},
+ },
+}
+
func getPermission(t *testing.T, server *web.Mux, resource, resourceID string) ([]resourcePermissionDTO, *httptest.ResponseRecorder) {
req, err := http.NewRequest(http.MethodGet, fmt.Sprintf("/api/access-control/%s/%s", resource, resourceID), nil)
require.NoError(t, err)
diff --git a/pkg/services/accesscontrol/resourcepermissions/service.go b/pkg/services/accesscontrol/resourcepermissions/service.go
index d8ae4903963..2722dba149a 100644
--- a/pkg/services/accesscontrol/resourcepermissions/service.go
+++ b/pkg/services/accesscontrol/resourcepermissions/service.go
@@ -275,7 +275,7 @@ func (s *Service) validateResource(ctx context.Context, orgID int64, resourceID
}
func (s *Service) validateUser(ctx context.Context, orgID, userID int64) error {
- if !s.options.Assignments.Users {
+ if !(s.options.Assignments.Users || s.options.Assignments.ServiceAccounts) {
return ErrInvalidAssignment
}
diff --git a/pkg/services/accesscontrol/resourcepermissions/service_test.go b/pkg/services/accesscontrol/resourcepermissions/service_test.go
index 8775502ab99..be8a18c5db8 100644
--- a/pkg/services/accesscontrol/resourcepermissions/service_test.go
+++ b/pkg/services/accesscontrol/resourcepermissions/service_test.go
@@ -38,7 +38,7 @@ func TestService_SetUserPermission(t *testing.T) {
t.Run(tt.desc, func(t *testing.T) {
service, sql := setupTestEnvironment(t, []accesscontrol.Permission{}, Options{
Resource: "dashboards",
- Assignments: Assignments{Users: true},
+ Assignments: Assignments{Users: true, ServiceAccounts: true},
PermissionsToActions: nil,
})
@@ -159,9 +159,10 @@ func TestService_SetPermissions(t *testing.T) {
options: Options{
Resource: "dashboards",
Assignments: Assignments{
- Users: true,
- Teams: true,
- BuiltInRoles: true,
+ Users: true,
+ Teams: true,
+ BuiltInRoles: true,
+ ServiceAccounts: true,
},
PermissionsToActions: map[string][]string{
"View": {"dashboards:read"},
@@ -178,9 +179,10 @@ func TestService_SetPermissions(t *testing.T) {
options: Options{
Resource: "dashboards",
Assignments: Assignments{
- Users: true,
- Teams: true,
- BuiltInRoles: true,
+ Users: true,
+ Teams: true,
+ BuiltInRoles: true,
+ ServiceAccounts: true,
},
PermissionsToActions: map[string][]string{
"View": {"dashboards:read"},
diff --git a/pkg/services/dashboards/dashboard.go b/pkg/services/dashboards/dashboard.go
index c47af49680d..b3a1b3cffe3 100644
--- a/pkg/services/dashboards/dashboard.go
+++ b/pkg/services/dashboards/dashboard.go
@@ -3,14 +3,12 @@ package dashboards
import (
"context"
- "github.com/grafana/grafana/pkg/api/dtos"
"github.com/grafana/grafana/pkg/models"
)
//go:generate mockery --name DashboardService --structname FakeDashboardService --inpackage --filename dashboard_service_mock.go
// DashboardService is a service for operating on dashboards.
type DashboardService interface {
- BuildPublicDashboardMetricRequest(ctx context.Context, dashboard *models.Dashboard, publicDashboard *models.PublicDashboard, panelId int64) (dtos.MetricRequest, error)
BuildSaveDashboardCommand(ctx context.Context, dto *SaveDashboardDTO, shouldValidateAlerts bool, validateProvisionedDashboard bool) (*models.SaveDashboardCommand, error)
DeleteDashboard(ctx context.Context, dashboardId int64, orgId int64) error
FindDashboards(ctx context.Context, query *models.FindPersistedDashboardsQuery) ([]DashboardSearchProjection, error)
@@ -19,14 +17,11 @@ type DashboardService interface {
GetDashboards(ctx context.Context, query *models.GetDashboardsQuery) error
GetDashboardTags(ctx context.Context, query *models.GetDashboardTagsQuery) error
GetDashboardUIDById(ctx context.Context, query *models.GetDashboardRefByIdQuery) error
- GetPublicDashboard(ctx context.Context, accessToken string) (*models.Dashboard, error)
- GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*models.PublicDashboard, error)
HasAdminPermissionInDashboardsOrFolders(ctx context.Context, query *models.HasAdminPermissionInDashboardsOrFoldersQuery) error
HasEditPermissionInFolders(ctx context.Context, query *models.HasEditPermissionInFoldersQuery) error
ImportDashboard(ctx context.Context, dto *SaveDashboardDTO) (*models.Dashboard, error)
MakeUserAdmin(ctx context.Context, orgID int64, userID, dashboardID int64, setViewAndEditPermissions bool) error
SaveDashboard(ctx context.Context, dto *SaveDashboardDTO, allowUiUpdate bool) (*models.Dashboard, error)
- SavePublicDashboardConfig(ctx context.Context, dto *SavePublicDashboardConfigDTO) (*models.PublicDashboard, error)
SearchDashboards(ctx context.Context, query *models.FindPersistedDashboardsQuery) error
UpdateDashboardACL(ctx context.Context, uid int64, items []*models.DashboardAcl) error
}
@@ -65,18 +60,13 @@ type Store interface {
GetProvisionedDashboardData(name string) ([]*models.DashboardProvisioning, error)
GetProvisionedDataByDashboardID(dashboardID int64) (*models.DashboardProvisioning, error)
GetProvisionedDataByDashboardUID(orgID int64, dashboardUID string) (*models.DashboardProvisioning, error)
- GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*models.PublicDashboard, error)
- GetPublicDashboard(ctx context.Context, accessToken string) (*models.PublicDashboard, *models.Dashboard, error)
- GenerateNewPublicDashboardUid(ctx context.Context) (string, error)
HasAdminPermissionInDashboardsOrFolders(ctx context.Context, query *models.HasAdminPermissionInDashboardsOrFoldersQuery) error
HasEditPermissionInFolders(ctx context.Context, query *models.HasEditPermissionInFoldersQuery) error
// SaveAlerts saves dashboard alerts.
SaveAlerts(ctx context.Context, dashID int64, alerts []*models.Alert) error
SaveDashboard(cmd models.SaveDashboardCommand) (*models.Dashboard, error)
SaveProvisionedDashboard(cmd models.SaveDashboardCommand, provisioning *models.DashboardProvisioning) (*models.Dashboard, error)
- SavePublicDashboardConfig(ctx context.Context, cmd models.SavePublicDashboardConfigCommand) (*models.PublicDashboard, error)
UnprovisionDashboard(ctx context.Context, id int64) error
- UpdatePublicDashboardConfig(ctx context.Context, cmd models.SavePublicDashboardConfigCommand) error
UpdateDashboardACL(ctx context.Context, uid int64, items []*models.DashboardAcl) error
// ValidateDashboardBeforeSave validates a dashboard before save.
ValidateDashboardBeforeSave(dashboard *models.Dashboard, overwrite bool) (bool, error)
diff --git a/pkg/services/dashboards/dashboard_service_mock.go b/pkg/services/dashboards/dashboard_service_mock.go
index 7f46f43096c..8e42d531998 100644
--- a/pkg/services/dashboards/dashboard_service_mock.go
+++ b/pkg/services/dashboards/dashboard_service_mock.go
@@ -1,14 +1,12 @@
-// Code generated by mockery v2.12.1. DO NOT EDIT.
+// Code generated by mockery v2.12.2. DO NOT EDIT.
package dashboards
import (
context "context"
- dtos "github.com/grafana/grafana/pkg/api/dtos"
- mock "github.com/stretchr/testify/mock"
-
models "github.com/grafana/grafana/pkg/models"
+ mock "github.com/stretchr/testify/mock"
testing "testing"
)
@@ -18,27 +16,6 @@ type FakeDashboardService struct {
mock.Mock
}
-// BuildPublicDashboardMetricRequest provides a mock function with given fields: ctx, dashboard, publicDashboard, panelId
-func (_m *FakeDashboardService) BuildPublicDashboardMetricRequest(ctx context.Context, dashboard *models.Dashboard, publicDashboard *models.PublicDashboard, panelId int64) (dtos.MetricRequest, error) {
- ret := _m.Called(ctx, dashboard, publicDashboard, panelId)
-
- var r0 dtos.MetricRequest
- if rf, ok := ret.Get(0).(func(context.Context, *models.Dashboard, *models.PublicDashboard, int64) dtos.MetricRequest); ok {
- r0 = rf(ctx, dashboard, publicDashboard, panelId)
- } else {
- r0 = ret.Get(0).(dtos.MetricRequest)
- }
-
- var r1 error
- if rf, ok := ret.Get(1).(func(context.Context, *models.Dashboard, *models.PublicDashboard, int64) error); ok {
- r1 = rf(ctx, dashboard, publicDashboard, panelId)
- } else {
- r1 = ret.Error(1)
- }
-
- return r0, r1
-}
-
// BuildSaveDashboardCommand provides a mock function with given fields: ctx, dto, shouldValidateAlerts, validateProvisionedDashboard
func (_m *FakeDashboardService) BuildSaveDashboardCommand(ctx context.Context, dto *SaveDashboardDTO, shouldValidateAlerts bool, validateProvisionedDashboard bool) (*models.SaveDashboardCommand, error) {
ret := _m.Called(ctx, dto, shouldValidateAlerts, validateProvisionedDashboard)
@@ -169,52 +146,6 @@ func (_m *FakeDashboardService) GetDashboards(ctx context.Context, query *models
return r0
}
-// GetPublicDashboard provides a mock function with given fields: ctx, accessToken
-func (_m *FakeDashboardService) GetPublicDashboard(ctx context.Context, accessToken string) (*models.Dashboard, error) {
- ret := _m.Called(ctx, accessToken)
-
- var r0 *models.Dashboard
- if rf, ok := ret.Get(0).(func(context.Context, string) *models.Dashboard); ok {
- r0 = rf(ctx, accessToken)
- } else {
- if ret.Get(0) != nil {
- r0 = ret.Get(0).(*models.Dashboard)
- }
- }
-
- var r1 error
- if rf, ok := ret.Get(1).(func(context.Context, string) error); ok {
- r1 = rf(ctx, accessToken)
- } else {
- r1 = ret.Error(1)
- }
-
- return r0, r1
-}
-
-// GetPublicDashboardConfig provides a mock function with given fields: ctx, orgId, dashboardUid
-func (_m *FakeDashboardService) GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*models.PublicDashboard, error) {
- ret := _m.Called(ctx, orgId, dashboardUid)
-
- var r0 *models.PublicDashboard
- if rf, ok := ret.Get(0).(func(context.Context, int64, string) *models.PublicDashboard); ok {
- r0 = rf(ctx, orgId, dashboardUid)
- } else {
- if ret.Get(0) != nil {
- r0 = ret.Get(0).(*models.PublicDashboard)
- }
- }
-
- var r1 error
- if rf, ok := ret.Get(1).(func(context.Context, int64, string) error); ok {
- r1 = rf(ctx, orgId, dashboardUid)
- } else {
- r1 = ret.Error(1)
- }
-
- return r0, r1
-}
-
// HasAdminPermissionInDashboardsOrFolders provides a mock function with given fields: ctx, query
func (_m *FakeDashboardService) HasAdminPermissionInDashboardsOrFolders(ctx context.Context, query *models.HasAdminPermissionInDashboardsOrFoldersQuery) error {
ret := _m.Called(ctx, query)
@@ -303,29 +234,6 @@ func (_m *FakeDashboardService) SaveDashboard(ctx context.Context, dto *SaveDash
return r0, r1
}
-// SavePublicDashboardConfig provides a mock function with given fields: ctx, dto
-func (_m *FakeDashboardService) SavePublicDashboardConfig(ctx context.Context, dto *SavePublicDashboardConfigDTO) (*models.PublicDashboard, error) {
- ret := _m.Called(ctx, dto)
-
- var r0 *models.PublicDashboard
- if rf, ok := ret.Get(0).(func(context.Context, *SavePublicDashboardConfigDTO) *models.PublicDashboard); ok {
- r0 = rf(ctx, dto)
- } else {
- if ret.Get(0) != nil {
- r0 = ret.Get(0).(*models.PublicDashboard)
- }
- }
-
- var r1 error
- if rf, ok := ret.Get(1).(func(context.Context, *SavePublicDashboardConfigDTO) error); ok {
- r1 = rf(ctx, dto)
- } else {
- r1 = ret.Error(1)
- }
-
- return r0, r1
-}
-
// SearchDashboards provides a mock function with given fields: ctx, query
func (_m *FakeDashboardService) SearchDashboards(ctx context.Context, query *models.FindPersistedDashboardsQuery) error {
ret := _m.Called(ctx, query)
diff --git a/pkg/services/dashboards/models.go b/pkg/services/dashboards/models.go
index 2fedc4abf01..f2f3db9c2ac 100644
--- a/pkg/services/dashboards/models.go
+++ b/pkg/services/dashboards/models.go
@@ -15,13 +15,6 @@ type SaveDashboardDTO struct {
Dashboard *models.Dashboard
}
-type SavePublicDashboardConfigDTO struct {
- DashboardUid string
- OrgId int64
- UserId int64
- PublicDashboard *models.PublicDashboard
-}
-
type DashboardSearchProjection struct {
ID int64 `xorm:"id"`
UID string `xorm:"uid"`
diff --git a/pkg/services/dashboards/service/dashboard_public.go b/pkg/services/dashboards/service/dashboard_public.go
deleted file mode 100644
index 3da5b9e2f31..00000000000
--- a/pkg/services/dashboards/service/dashboard_public.go
+++ /dev/null
@@ -1,150 +0,0 @@
-package service
-
-import (
- "context"
- "fmt"
- "time"
-
- "github.com/google/uuid"
- "github.com/grafana/grafana/pkg/api/dtos"
- "github.com/grafana/grafana/pkg/components/simplejson"
- "github.com/grafana/grafana/pkg/models"
- "github.com/grafana/grafana/pkg/services/dashboards"
-)
-
-// Gets public dashboard via access token
-func (dr *DashboardServiceImpl) GetPublicDashboard(ctx context.Context, accessToken string) (*models.Dashboard, error) {
- pubdash, d, err := dr.dashboardStore.GetPublicDashboard(ctx, accessToken)
-
- if err != nil {
- return nil, err
- }
-
- if pubdash == nil || d == nil {
- return nil, dashboards.ErrPublicDashboardNotFound
- }
-
- if !pubdash.IsEnabled {
- return nil, dashboards.ErrPublicDashboardNotFound
- }
-
- ts := pubdash.BuildTimeSettings(d)
- d.Data.SetPath([]string{"time", "from"}, ts.From)
- d.Data.SetPath([]string{"time", "to"}, ts.To)
-
- return d, nil
-}
-
-// GetPublicDashboardConfig is a helper method to retrieve the public dashboard configuration for a given dashboard from the database
-func (dr *DashboardServiceImpl) GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*models.PublicDashboard, error) {
- pdc, err := dr.dashboardStore.GetPublicDashboardConfig(ctx, orgId, dashboardUid)
- if err != nil {
- return nil, err
- }
-
- return pdc, nil
-}
-
-// SavePublicDashboardConfig is a helper method to persist the sharing config
-// to the database. It handles validations for sharing config and persistence
-func (dr *DashboardServiceImpl) SavePublicDashboardConfig(ctx context.Context, dto *dashboards.SavePublicDashboardConfigDTO) (*models.PublicDashboard, error) {
- if len(dto.DashboardUid) == 0 {
- return nil, dashboards.ErrDashboardIdentifierNotSet
- }
-
- // set default value for time settings
- if dto.PublicDashboard.TimeSettings == nil {
- dto.PublicDashboard.TimeSettings = simplejson.New()
- }
-
- if dto.PublicDashboard.Uid == "" {
- return dr.savePublicDashboardConfig(ctx, dto)
- }
-
- return dr.updatePublicDashboardConfig(ctx, dto)
-}
-
-func (dr *DashboardServiceImpl) savePublicDashboardConfig(ctx context.Context, dto *dashboards.SavePublicDashboardConfigDTO) (*models.PublicDashboard, error) {
- uid, err := dr.dashboardStore.GenerateNewPublicDashboardUid(ctx)
- if err != nil {
- return nil, err
- }
-
- accessToken, err := GenerateAccessToken()
- if err != nil {
- return nil, err
- }
-
- cmd := models.SavePublicDashboardConfigCommand{
- DashboardUid: dto.DashboardUid,
- OrgId: dto.OrgId,
- PublicDashboard: models.PublicDashboard{
- Uid: uid,
- DashboardUid: dto.DashboardUid,
- OrgId: dto.OrgId,
- IsEnabled: dto.PublicDashboard.IsEnabled,
- TimeSettings: dto.PublicDashboard.TimeSettings,
- CreatedBy: dto.UserId,
- CreatedAt: time.Now(),
- AccessToken: accessToken,
- },
- }
-
- return dr.dashboardStore.SavePublicDashboardConfig(ctx, cmd)
-}
-
-func (dr *DashboardServiceImpl) updatePublicDashboardConfig(ctx context.Context, dto *dashboards.SavePublicDashboardConfigDTO) (*models.PublicDashboard, error) {
- cmd := models.SavePublicDashboardConfigCommand{
- PublicDashboard: models.PublicDashboard{
- Uid: dto.PublicDashboard.Uid,
- IsEnabled: dto.PublicDashboard.IsEnabled,
- TimeSettings: dto.PublicDashboard.TimeSettings,
- UpdatedBy: dto.UserId,
- UpdatedAt: time.Now(),
- },
- }
-
- err := dr.dashboardStore.UpdatePublicDashboardConfig(ctx, cmd)
- if err != nil {
- return nil, err
- }
-
- publicDashboard, err := dr.dashboardStore.GetPublicDashboardConfig(ctx, dto.OrgId, dto.DashboardUid)
- if err != nil {
- return nil, err
- }
-
- return publicDashboard, nil
-}
-
-// BuildPublicDashboardMetricRequest merges public dashboard parameters with
-// dashboard and returns a metrics request to be sent to query backend
-func (dr *DashboardServiceImpl) BuildPublicDashboardMetricRequest(ctx context.Context, dashboard *models.Dashboard, publicDashboard *models.PublicDashboard, panelId int64) (dtos.MetricRequest, error) {
- if !publicDashboard.IsEnabled {
- return dtos.MetricRequest{}, dashboards.ErrPublicDashboardNotFound
- }
-
- queriesByPanel := models.GetQueriesFromDashboard(dashboard.Data)
-
- if _, ok := queriesByPanel[panelId]; !ok {
- return dtos.MetricRequest{}, dashboards.ErrPublicDashboardPanelNotFound
- }
-
- ts := publicDashboard.BuildTimeSettings(dashboard)
-
- return dtos.MetricRequest{
- From: ts.From,
- To: ts.To,
- Queries: queriesByPanel[panelId],
- }, nil
-}
-
-// generates a uuid formatted without dashes to use as access token
-func GenerateAccessToken() (string, error) {
- token, err := uuid.NewRandom()
- if err != nil {
- return "", err
- }
-
- return fmt.Sprintf("%x", token[:]), nil
-}
diff --git a/pkg/services/dashboards/store_mock.go b/pkg/services/dashboards/store_mock.go
index 8ecefb4e05c..ddf976aa679 100644
--- a/pkg/services/dashboards/store_mock.go
+++ b/pkg/services/dashboards/store_mock.go
@@ -1,4 +1,4 @@
-// Code generated by mockery v2.12.1. DO NOT EDIT.
+// Code generated by mockery v2.12.2. DO NOT EDIT.
package dashboards
@@ -67,27 +67,6 @@ func (_m *FakeDashboardStore) FindDashboards(ctx context.Context, query *models.
return r0, r1
}
-// GenerateNewPublicDashboardUid provides a mock function with given fields: ctx
-func (_m *FakeDashboardStore) GenerateNewPublicDashboardUid(ctx context.Context) (string, error) {
- ret := _m.Called(ctx)
-
- var r0 string
- if rf, ok := ret.Get(0).(func(context.Context) string); ok {
- r0 = rf(ctx)
- } else {
- r0 = ret.Get(0).(string)
- }
-
- var r1 error
- if rf, ok := ret.Get(1).(func(context.Context) error); ok {
- r1 = rf(ctx)
- } else {
- r1 = ret.Error(1)
- }
-
- return r0, r1
-}
-
// GetDashboard provides a mock function with given fields: ctx, query
func (_m *FakeDashboardStore) GetDashboard(ctx context.Context, query *models.GetDashboardQuery) (*models.Dashboard, error) {
ret := _m.Called(ctx, query)
@@ -319,61 +298,6 @@ func (_m *FakeDashboardStore) GetProvisionedDataByDashboardUID(orgID int64, dash
return r0, r1
}
-// GetPublicDashboard provides a mock function with given fields: ctx, accessToken
-func (_m *FakeDashboardStore) GetPublicDashboard(ctx context.Context, accessToken string) (*models.PublicDashboard, *models.Dashboard, error) {
- ret := _m.Called(ctx, accessToken)
-
- var r0 *models.PublicDashboard
- if rf, ok := ret.Get(0).(func(context.Context, string) *models.PublicDashboard); ok {
- r0 = rf(ctx, accessToken)
- } else {
- if ret.Get(0) != nil {
- r0 = ret.Get(0).(*models.PublicDashboard)
- }
- }
-
- var r1 *models.Dashboard
- if rf, ok := ret.Get(1).(func(context.Context, string) *models.Dashboard); ok {
- r1 = rf(ctx, accessToken)
- } else {
- if ret.Get(1) != nil {
- r1 = ret.Get(1).(*models.Dashboard)
- }
- }
-
- var r2 error
- if rf, ok := ret.Get(2).(func(context.Context, string) error); ok {
- r2 = rf(ctx, accessToken)
- } else {
- r2 = ret.Error(2)
- }
-
- return r0, r1, r2
-}
-
-// GetPublicDashboardConfig provides a mock function with given fields: ctx, orgId, dashboardUid
-func (_m *FakeDashboardStore) GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*models.PublicDashboard, error) {
- ret := _m.Called(ctx, orgId, dashboardUid)
-
- var r0 *models.PublicDashboard
- if rf, ok := ret.Get(0).(func(context.Context, int64, string) *models.PublicDashboard); ok {
- r0 = rf(ctx, orgId, dashboardUid)
- } else {
- if ret.Get(0) != nil {
- r0 = ret.Get(0).(*models.PublicDashboard)
- }
- }
-
- var r1 error
- if rf, ok := ret.Get(1).(func(context.Context, int64, string) error); ok {
- r1 = rf(ctx, orgId, dashboardUid)
- } else {
- r1 = ret.Error(1)
- }
-
- return r0, r1
-}
-
// HasAdminPermissionInDashboardsOrFolders provides a mock function with given fields: ctx, query
func (_m *FakeDashboardStore) HasAdminPermissionInDashboardsOrFolders(ctx context.Context, query *models.HasAdminPermissionInDashboardsOrFoldersQuery) error {
ret := _m.Called(ctx, query)
@@ -462,29 +386,6 @@ func (_m *FakeDashboardStore) SaveProvisionedDashboard(cmd models.SaveDashboardC
return r0, r1
}
-// SavePublicDashboardConfig provides a mock function with given fields: ctx, cmd
-func (_m *FakeDashboardStore) SavePublicDashboardConfig(ctx context.Context, cmd models.SavePublicDashboardConfigCommand) (*models.PublicDashboard, error) {
- ret := _m.Called(ctx, cmd)
-
- var r0 *models.PublicDashboard
- if rf, ok := ret.Get(0).(func(context.Context, models.SavePublicDashboardConfigCommand) *models.PublicDashboard); ok {
- r0 = rf(ctx, cmd)
- } else {
- if ret.Get(0) != nil {
- r0 = ret.Get(0).(*models.PublicDashboard)
- }
- }
-
- var r1 error
- if rf, ok := ret.Get(1).(func(context.Context, models.SavePublicDashboardConfigCommand) error); ok {
- r1 = rf(ctx, cmd)
- } else {
- r1 = ret.Error(1)
- }
-
- return r0, r1
-}
-
// UnprovisionDashboard provides a mock function with given fields: ctx, id
func (_m *FakeDashboardStore) UnprovisionDashboard(ctx context.Context, id int64) error {
ret := _m.Called(ctx, id)
@@ -513,20 +414,6 @@ func (_m *FakeDashboardStore) UpdateDashboardACL(ctx context.Context, uid int64,
return r0
}
-// UpdatePublicDashboardConfig provides a mock function with given fields: ctx, cmd
-func (_m *FakeDashboardStore) UpdatePublicDashboardConfig(ctx context.Context, cmd models.SavePublicDashboardConfigCommand) error {
- ret := _m.Called(ctx, cmd)
-
- var r0 error
- if rf, ok := ret.Get(0).(func(context.Context, models.SavePublicDashboardConfigCommand) error); ok {
- r0 = rf(ctx, cmd)
- } else {
- r0 = ret.Error(0)
- }
-
- return r0
-}
-
// ValidateDashboardBeforeSave provides a mock function with given fields: dashboard, overwrite
func (_m *FakeDashboardStore) ValidateDashboardBeforeSave(dashboard *models.Dashboard, overwrite bool) (bool, error) {
ret := _m.Called(dashboard, overwrite)
diff --git a/pkg/services/datasources/models.go b/pkg/services/datasources/models.go
index 616074ce8cd..68b938da257 100644
--- a/pkg/services/datasources/models.go
+++ b/pkg/services/datasources/models.go
@@ -31,9 +31,9 @@ const (
type DsAccess string
type DataSource struct {
- Id int64 `json:"id"`
- OrgId int64 `json:"orgId"`
- Version int `json:"version"`
+ Id int64 `json:"id,omitempty"`
+ OrgId int64 `json:"orgId,omitempty"`
+ Version int `json:"version,omitempty"`
Name string `json:"name"`
Type string `json:"type"`
@@ -54,8 +54,8 @@ type DataSource struct {
ReadOnly bool `json:"readOnly"`
Uid string `json:"uid"`
- Created time.Time `json:"created"`
- Updated time.Time `json:"updated"`
+ Created time.Time `json:"created,omitempty"`
+ Updated time.Time `json:"updated,omitempty"`
}
// AllowedCookies parses the jsondata.keepCookies and returns a list of
diff --git a/pkg/services/export/commit_helper.go b/pkg/services/export/commit_helper.go
new file mode 100644
index 00000000000..b19749c6a03
--- /dev/null
+++ b/pkg/services/export/commit_helper.go
@@ -0,0 +1,153 @@
+package export
+
+import (
+ "context"
+ "fmt"
+ "io/ioutil"
+ "os"
+ "path"
+ "strings"
+ "time"
+
+ "github.com/go-git/go-git/v5"
+ "github.com/go-git/go-git/v5/plumbing/object"
+ "github.com/grafana/grafana-plugin-sdk-go/data"
+ "github.com/grafana/grafana/pkg/services/sqlstore"
+ jsoniter "github.com/json-iterator/go"
+)
+
+type commitHelper struct {
+ ctx context.Context
+ repo *git.Repository
+ work *git.Worktree
+ orgDir string // includes the orgID
+ workDir string // same as the worktree root
+ orgID int64
+ users map[int64]*userInfo
+}
+
+type commitBody struct {
+ fpath string // absolute
+ body []byte
+ frame *data.Frame
+}
+
+type commitOptions struct {
+ body []commitBody
+ when time.Time
+ userID int64
+ comment string
+}
+
+func (ch *commitHelper) initOrg(sql *sqlstore.SQLStore, orgID int64) error {
+ return sql.WithDbSession(ch.ctx, func(sess *sqlstore.DBSession) error {
+ sess.Table("user").
+ Join("inner", "org_user", "user.id = org_user.user_id").
+ Cols("user.*", "org_user.role").
+ Where("org_user.org_id = ?", orgID).
+ Asc("user.id")
+
+ rows := make([]*userInfo, 0)
+ err := sess.Find(&rows)
+ if err != nil {
+ return err
+ }
+
+ lookup := make(map[int64]*userInfo, len(rows))
+ for _, row := range rows {
+ lookup[row.ID] = row
+ }
+ ch.users = lookup
+ ch.orgID = orgID
+ return err
+ })
+}
+
+func (ch *commitHelper) add(opts commitOptions) error {
+ for _, b := range opts.body {
+ if !strings.HasPrefix(b.fpath, ch.orgDir) {
+ return fmt.Errorf("invalid path, must be within the root folder")
+ }
+
+ // make sure the parent exists
+ err := os.MkdirAll(path.Dir(b.fpath), 0750)
+ if err != nil {
+ return err
+ }
+
+ body := b.body
+ if b.frame != nil {
+ body, err = jsoniter.ConfigCompatibleWithStandardLibrary.MarshalIndent(b.frame, "", " ")
+ if err != nil {
+ return err
+ }
+ }
+
+ err = ioutil.WriteFile(b.fpath, body, 0644)
+ if err != nil {
+ return err
+ }
+
+ sub := b.fpath[len(ch.workDir)+1:]
+ _, err = ch.work.Add(sub)
+ if err != nil {
+ status, e2 := ch.work.Status()
+ if e2 != nil {
+ return fmt.Errorf("error adding: %s (invalud work status: %s)", sub, e2.Error())
+ }
+ fmt.Printf("STATUS: %+v\n", status)
+ return fmt.Errorf("unable to add file: %s (%d)", sub, len(b.body))
+ }
+ }
+
+ user, ok := ch.users[opts.userID]
+ if !ok {
+ user = &userInfo{
+ Name: "admin",
+ Email: "admin@unknown.org",
+ }
+ }
+ sig := user.getAuthor()
+ if opts.when.Unix() > 10 {
+ sig.When = opts.when
+ }
+
+ copts := &git.CommitOptions{
+ Author: &sig,
+ }
+
+ _, err := ch.work.Commit(opts.comment, copts)
+ return err
+}
+
+type userInfo struct {
+ ID int64 `json:"-" xorm:"id"`
+ Login string `json:"login"`
+ Email string `json:"email"`
+ Name string `json:"name"`
+ Password string `json:"password"`
+ Salt string `json:"salt"`
+ Role string `json:"org_role"` // org role
+ Theme string `json:"-"` // managed in preferences
+ Created time.Time `json:"-"` // managed in git or external source
+ Updated time.Time `json:"-"` // managed in git or external source
+ IsDisabled bool `json:"disabled" xorm:"is_disabled"`
+ IsServiceAccount bool `json:"serviceAccount" xorm:"is_service_account"`
+ LastSeenAt time.Time `json:"-" xorm:"last_seen_at"`
+}
+
+func (u *userInfo) getAuthor() object.Signature {
+ return object.Signature{
+ Name: firstRealStringX(u.Name, u.Login, u.Email, "?"),
+ Email: firstRealStringX(u.Email, u.Login, u.Name, "?"),
+ }
+}
+
+func firstRealStringX(vals ...string) string {
+ for _, v := range vals {
+ if v != "" {
+ return v
+ }
+ }
+ return "?"
+}
diff --git a/pkg/services/export/dummy_job.go b/pkg/services/export/dummy_job.go
index 029bc8edabb..f892b1cea6b 100644
--- a/pkg/services/export/dummy_job.go
+++ b/pkg/services/export/dummy_job.go
@@ -1,7 +1,6 @@
package export
import (
- "errors"
"fmt"
"math"
"math/rand"
@@ -23,10 +22,6 @@ type dummyExportJob struct {
}
func startDummyExportJob(cfg ExportConfig, broadcaster statusBroadcaster) (Job, error) {
- if cfg.Format != "git" {
- return nil, errors.New("only git format is supported")
- }
-
job := &dummyExportJob{
logger: log.New("dummy_export_job"),
cfg: cfg,
diff --git a/pkg/services/export/export_anno.go b/pkg/services/export/export_anno.go
new file mode 100644
index 00000000000..4f3d0f96684
--- /dev/null
+++ b/pkg/services/export/export_anno.go
@@ -0,0 +1,129 @@
+package export
+
+import (
+ "encoding/json"
+ "fmt"
+ "path/filepath"
+ "time"
+
+ "github.com/grafana/grafana-plugin-sdk-go/data"
+ "github.com/grafana/grafana/pkg/services/sqlstore"
+ jsoniter "github.com/json-iterator/go"
+)
+
+func exportAnnotations(helper *commitHelper, job *gitExportJob) error {
+ return job.sql.WithDbSession(helper.ctx, func(sess *sqlstore.DBSession) error {
+ type annoResult struct {
+ ID int64 `xorm:"id"`
+ DashboardID int64 `xorm:"dashboard_id"`
+ PanelID int64 `xorm:"panel_id"`
+ UserID int64 `xorm:"user_id"`
+ Text string `xorm:"text"`
+ Epoch int64 `xorm:"epoch"`
+ EpochEnd int64 `xorm:"epoch_end"`
+ Created int64 `xorm:"created"` // not used
+ Tags string `xorm:"tags"` // JSON Array
+ }
+
+ type annoEvent struct {
+ PanelID int64 `json:"panel"`
+ Text string `json:"text"`
+ Epoch int64 `json:"epoch"` // dashboard/start+end is really the UID
+ EpochEnd int64 `json:"epoch_end,omitempty"`
+ Tags []string
+ }
+
+ rows := make([]*annoResult, 0)
+
+ sess.Table("annotation").
+ Where("org_id = ? AND alert_id = 0", helper.orgID).Asc("epoch")
+
+ err := sess.Find(&rows)
+ if err != nil {
+ return err
+ }
+
+ count := len(rows)
+ f_ID := data.NewFieldFromFieldType(data.FieldTypeInt64, count)
+ f_DashboardID := data.NewFieldFromFieldType(data.FieldTypeInt64, count)
+ f_PanelID := data.NewFieldFromFieldType(data.FieldTypeInt64, count)
+ f_Epoch := data.NewFieldFromFieldType(data.FieldTypeTime, count)
+ f_EpochEnd := data.NewFieldFromFieldType(data.FieldTypeNullableTime, count)
+ f_Text := data.NewFieldFromFieldType(data.FieldTypeString, count)
+ f_Tags := data.NewFieldFromFieldType(data.FieldTypeJSON, count)
+
+ f_ID.Name = "ID"
+ f_DashboardID.Name = "DashboardID"
+ f_PanelID.Name = "PanelID"
+ f_Epoch.Name = "Epoch"
+ f_EpochEnd.Name = "EpochEnd"
+ f_Text.Name = "Text"
+ f_Tags.Name = "Tags"
+
+ for id, row := range rows {
+ f_ID.Set(id, row.ID)
+ f_DashboardID.Set(id, row.DashboardID)
+ f_PanelID.Set(id, row.PanelID)
+ f_Epoch.Set(id, time.UnixMilli(row.Epoch))
+ if row.Epoch != row.EpochEnd {
+ f_EpochEnd.SetConcrete(id, time.UnixMilli(row.EpochEnd))
+ }
+ f_Text.Set(id, row.Text)
+ f_Tags.Set(id, json.RawMessage(row.Tags))
+
+ // Save a file for each
+ event := &annoEvent{
+ PanelID: row.PanelID,
+ Text: row.Text,
+ }
+ err = json.Unmarshal([]byte(row.Tags), &event.Tags)
+ if err != nil {
+ return err
+ }
+ fname := fmt.Sprintf("%d", row.Epoch)
+ if row.Epoch != row.EpochEnd {
+ fname += "-" + fmt.Sprintf("%d", row.EpochEnd)
+ }
+
+ err = helper.add(commitOptions{
+ body: []commitBody{
+ {
+ fpath: filepath.Join(helper.orgDir,
+ "annotations",
+ "dashboard",
+ fmt.Sprintf("id-%d", row.DashboardID),
+ fname+".json"),
+ body: prettyJSON(event),
+ },
+ },
+ when: time.UnixMilli(row.Epoch),
+ comment: fmt.Sprintf("Added annotation (%d)", row.ID),
+ userID: row.UserID,
+ })
+ if err != nil {
+ return err
+ }
+ }
+
+ frame := data.NewFrame("", f_ID, f_DashboardID, f_PanelID, f_Epoch, f_EpochEnd, f_Text, f_Tags)
+ js, err := jsoniter.ConfigCompatibleWithStandardLibrary.MarshalIndent(frame, "", " ")
+ if err != nil {
+ return err
+ }
+
+ err = helper.add(commitOptions{
+ body: []commitBody{
+ {
+ fpath: filepath.Join(helper.orgDir, "annotations", "annotations.json"),
+ body: js, // TODO, pretty?
+ },
+ },
+ when: time.Now(),
+ comment: "Exported annotations",
+ })
+ if err != nil {
+ return err
+ }
+ return err
+ })
+}
diff --git a/pkg/services/export/export_auth.go b/pkg/services/export/export_auth.go
new file mode 100644
index 00000000000..37da1a92d63
--- /dev/null
+++ b/pkg/services/export/export_auth.go
@@ -0,0 +1,73 @@
+package export
+
+import (
+ "fmt"
+ "path"
+
+ "github.com/grafana/grafana/pkg/services/sqlstore"
+)
+
+func dumpAuthTables(helper *commitHelper, job *gitExportJob) error {
+ return job.sql.WithDbSession(helper.ctx, func(sess *sqlstore.DBSession) error {
+ commit := commitOptions{
+ comment: "auth tables dump",
+ }
+
+ tables := []string{
+ "user", // joined with "org_user" to get the role
+ "user_role",
+ "builtin_role",
+ "api_key",
+ "team", "team_group", "team_role", "team_member",
+ "role",
+ "temp_user",
+ "user_auth_token", // no org_id... is it temporary?
+ "permission",
+ }
+
+ for _, table := range tables {
+ switch table {
+ case "permission":
+ sess.Table(table).
+ Join("left", "role", "permission.role_id = role.id").
+ Cols("permission.*").
+ Where("org_id = ?", helper.orgID).
+ Asc("permission.id")
+ case "user":
+ sess.Table(table).
+ Join("inner", "org_user", "user.id = org_user.user_id").
+ Cols("user.*", "org_user.role").
+ Where("org_user.org_id = ?", helper.orgID).
+ Asc("user.id")
+ case "user_auth_token":
+ sess.Table(table).
+ Join("inner", "org_user", "user_auth_token.id = org_user.user_id").
+ Cols("user_auth_token.*").
+ Where("org_user.org_id = ?", helper.orgID).
+ Asc("user_auth_token.id")
+ default:
+ sess.Table(table).Where("org_id = ?", helper.orgID).Asc("id")
+ }
+
+ raw, err := sess.QueryInterface()
+ if err != nil {
+ return fmt.Errorf("unable to read: %s // %s", table, err.Error())
+ }
+ if len(raw) < 1 {
+ continue // don't write empty files
+ }
+ frame, err := queryResultToDataFrame(raw, frameOpts{
+ skip: []string{"org_id", "version", "help_flags1", "theme"},
+ })
+ if err != nil {
+ return err
+ }
+ frame.Name = table
+ commit.body = append(commit.body, commitBody{
+ fpath: path.Join(helper.orgDir, "auth", "sql.dump", table+".json"),
+ frame: frame,
+ })
+ }
+ return helper.add(commit)
+ })
+}
diff --git a/pkg/services/export/export_dashboards.go b/pkg/services/export/export_dashboards.go
new file mode 100644
index 00000000000..212c31c1a38
--- /dev/null
+++ b/pkg/services/export/export_dashboards.go
@@ -0,0 +1,229 @@
+package export
+
+import (
+ "bytes"
+ "encoding/json"
+ "fmt"
+ "path"
+ "path/filepath"
+ "strings"
+ "time"
+
+ "github.com/google/uuid"
+ "github.com/grafana/grafana/pkg/infra/filestorage"
+ "github.com/grafana/grafana/pkg/services/searchV2/extract"
+ "github.com/grafana/grafana/pkg/services/sqlstore"
+)
+
+func exportDashboards(helper *commitHelper, job *gitExportJob, lookup dsLookup) error {
+ alias := make(map[string]string, 100)
+ ids := make(map[int64]string, 100)
+ folders := make(map[int64]string, 100)
+
+ // Should root files be at the root or in a subfolder called "general"?
+ if true {
+ folders[0] = "general"
+ }
+
+ rootDir := path.Join(helper.orgDir, "root")
+ folderStructure := commitOptions{
+ when: time.Now(),
+ comment: "Exported folder structure",
+ }
+
+ err := job.sql.WithDbSession(helper.ctx, func(sess *sqlstore.DBSession) error {
+ type dashDataQueryResult struct {
+ Id int64
+ UID string `xorm:"uid"`
+ IsFolder bool `xorm:"is_folder"`
+ FolderID int64 `xorm:"folder_id"`
+ Slug string `xorm:"slug"`
+ Data []byte
+ Created time.Time
+ Updated time.Time
+ }
+
+ rows := make([]*dashDataQueryResult, 0)
+
+ sess.Table("dashboard").
+ Where("org_id = ?", helper.orgID).
+ Cols("id", "is_folder", "folder_id", "data", "slug", "created", "updated", "uid")
+
+ err := sess.Find(&rows)
+ if err != nil {
+ return err
+ }
+
+ // Process all folders
+ for _, row := range rows {
+ if !row.IsFolder {
+ continue
+ }
+ dash, err := extract.ReadDashboard(bytes.NewReader(row.Data), lookup)
+ if err != nil {
+ return err
+ }
+
+ dash.UID = row.UID
+ slug := cleanFileName(dash.Title)
+ folder := map[string]string{
+ "title": dash.Title,
+ }
+
+ folderStructure.body = append(folderStructure.body, commitBody{
+ fpath: path.Join(rootDir, slug, "__folder.json"),
+ body: prettyJSON(folder),
+ })
+
+ alias[dash.UID] = slug
+ folders[row.Id] = slug
+
+ if row.Created.Before(folderStructure.when) {
+ folderStructure.when = row.Created
+ }
+ }
+
+ // Now process the dashboards in each folder
+ for _, row := range rows {
+ if row.IsFolder {
+ continue
+ }
+ fname := row.Slug + "-dash.json"
+ fpath, ok := folders[row.FolderID]
+ if ok {
+ fpath = path.Join(fpath, fname)
+ } else {
+ fpath = fname
+ }
+
+ alias[row.UID] = fpath
+ ids[row.Id] = fpath
+ }
+
+ return err
+ })
+ if err != nil {
+ return err
+ }
+
+ err = helper.add(folderStructure)
+ if err != nil {
+ return err
+ }
+
+ err = helper.add(commitOptions{
+ body: []commitBody{
+ {
+ fpath: filepath.Join(helper.orgDir, "root-alias.json"),
+ body: prettyJSON(alias),
+ },
+ {
+ fpath: filepath.Join(helper.orgDir, "root-ids.json"),
+ body: prettyJSON(ids),
+ },
+ },
+ when: folderStructure.when,
+ comment: "adding UID alias structure",
+ })
+ if err != nil {
+ return err
+ }
+
+ // Now walk the history
+ err = job.sql.WithDbSession(helper.ctx, func(sess *sqlstore.DBSession) error {
+ type dashVersionResult struct {
+ DashId int64 `xorm:"dashboard_id"`
+ Version int64 `xorm:"version"`
+ Created time.Time `xorm:"created"`
+ CreatedBy int64 `xorm:"created_by"`
+ Message string `xorm:"message"`
+ Data []byte
+ }
+
+ rows := make([]*dashVersionResult, 0, len(ids))
+
+ sess.Table("dashboard_version").
+ Join("INNER", "dashboard", "dashboard.id = dashboard_version.dashboard_id").
+ Where("org_id = ?", job.orgID).
+ Cols("dashboard_version.dashboard_id",
+ "dashboard_version.version",
+ "dashboard_version.created",
+ "dashboard_version.created_by",
+ "dashboard_version.message",
+ "dashboard_version.data").
+ Asc("dashboard_version.created")
+
+ err := sess.Find(&rows)
+ if err != nil {
+ return err
+ }
+
+ count := int64(0)
+
+ // Process all folders (only one level deep!!!)
+ for _, row := range rows {
+ fpath, ok := ids[row.DashId]
+ if !ok {
+ continue
+ }
+
+ msg := row.Message
+ if msg == "" {
+ msg = fmt.Sprintf("Version: %d", row.Version)
+ }
+
+ err = helper.add(commitOptions{
+ body: []commitBody{
+ {
+ fpath: filepath.Join(rootDir, fpath),
+ body: cleanDashboardJSON(row.Data),
+ },
+ },
+ userID: row.CreatedBy,
+ when: row.Created,
+ comment: msg,
+ })
+ if err != nil {
+ return err
+ }
+
+ count++
+ fmt.Printf("COMMIT: %d // %s (%d)\n", count, fpath, row.Version)
+
+ job.status.Current = count
+ job.status.Last = fpath
+ job.status.Changed = time.Now().UnixMilli()
+ job.broadcaster(job.status)
+ }
+
+ return nil
+ })
+
+ return err
+}
+
+func cleanDashboardJSON(data []byte) []byte {
+ var dash map[string]interface{}
+ err := json.Unmarshal(data, &dash)
+ if err != nil {
+ return nil
+ }
+ delete(dash, "id")
+ delete(dash, "uid")
+ delete(dash, "version")
+
+ clean, _ := json.MarshalIndent(dash, "", " ")
+ return clean
+}
+
+// replace any unsafe file name characters... TODO, but be a standard way to do this cleanly!!!
+func cleanFileName(name string) string {
+ name = strings.ReplaceAll(name, "/", "-")
+ name = strings.ReplaceAll(name, "\\", "-")
+ name = strings.ReplaceAll(name, ":", "-")
+ if err := filestorage.ValidatePath(filestorage.Delimiter + name); err != nil {
+ randomName, _ := uuid.NewRandom()
+ return randomName.String()
+ }
+ return name
+}
diff --git a/pkg/services/export/export_ds.go b/pkg/services/export/export_ds.go
new file mode 100644
index 00000000000..4dbe53c5553
--- /dev/null
+++ b/pkg/services/export/export_ds.go
@@ -0,0 +1,72 @@
+package export
+
+import (
+ "fmt"
+ "path/filepath"
+ "sort"
+
+ "github.com/grafana/grafana/pkg/services/datasources"
+ "github.com/grafana/grafana/pkg/services/searchV2/extract"
+)
+
+type dsLookup func(ref *extract.DataSourceRef) *extract.DataSourceRef
+
+func exportDataSources(helper *commitHelper, job *gitExportJob) (dsLookup, error) {
+ cmd := &datasources.GetDataSourcesQuery{
+ OrgId: job.orgID,
+ }
+ err := job.sql.GetDataSources(helper.ctx, cmd)
+ if err != nil {
+ return nil, err
+ }
+
+ sort.SliceStable(cmd.Result, func(i, j int) bool {
+ return cmd.Result[i].Created.After(cmd.Result[j].Created)
+ })
+
+ byUID := make(map[string]*extract.DataSourceRef, len(cmd.Result))
+ byName := make(map[string]*extract.DataSourceRef, len(cmd.Result))
+ for _, ds := range cmd.Result {
+ ref := &extract.DataSourceRef{
+ UID: ds.Uid,
+ Type: ds.Type,
+ }
+ byUID[ds.Uid] = ref
+ byName[ds.Name] = ref
+ ds.OrgId = 0
+ ds.Version = 0
+
+ err := helper.add(commitOptions{
+ body: []commitBody{
+ {
+ fpath: filepath.Join(helper.orgDir, "datasources", fmt.Sprintf("%s-ds.json", ds.Uid)),
+ body: prettyJSON(ds),
+ },
+ },
+ when: ds.Created,
+ comment: fmt.Sprintf("Add datasource: %s", ds.Name),
+ })
+ if err != nil {
+ return nil, err
+ }
+ }
+
+ // Return the lookup function
+ return func(ref *extract.DataSourceRef) *extract.DataSourceRef {
+ if ref == nil || ref.UID == "" {
+ return &extract.DataSourceRef{
+ UID: "default.uid",
+ Type: "default.type",
+ }
+ }
+ v, ok := byUID[ref.UID]
+ if ok {
+ return v
+ }
+ v, ok = byName[ref.UID]
+ if ok {
+ return v
+ }
+ return nil
+ }, nil
+}
diff --git a/pkg/services/export/export_snapshots.go b/pkg/services/export/export_snapshots.go
new file mode 100644
index 00000000000..e9390cc8b79
--- /dev/null
+++ b/pkg/services/export/export_snapshots.go
@@ -0,0 +1,43 @@
+package export
+
+import (
+ "fmt"
+ "path/filepath"
+ "time"
+
+ "github.com/grafana/grafana/pkg/services/dashboardsnapshots"
+)
+
+func exportSnapshots(helper *commitHelper, job *gitExportJob) error {
+ cmd := &dashboardsnapshots.GetDashboardSnapshotsQuery{
+ OrgId: job.orgID,
+ Limit: 500000,
+ SignedInUser: nil,
+ }
+ if cmd.SignedInUser == nil {
+ return fmt.Errorf("snapshots requires an admin user")
+ }
+
+ err := job.dashboardsnapshotsService.SearchDashboardSnapshots(helper.ctx, cmd)
+ if err != nil {
+ return err
+ }
+
+ if len(cmd.Result) < 1 {
+ return nil // nothing
+ }
+
+ gitcmd := commitOptions{
+ when: time.Now(),
+ comment: "Export playlists",
+ }
+
+ for _, snapshot := range cmd.Result {
+ gitcmd.body = append(gitcmd.body, commitBody{
+ fpath: filepath.Join(helper.orgDir, "snapshot", fmt.Sprintf("%d-snapshot.json", snapshot.Id)),
+ body: prettyJSON(snapshot),
+ })
+ }
+
+ return helper.add(gitcmd)
+}
diff --git a/pkg/services/export/export_sys_playlists.go b/pkg/services/export/export_sys_playlists.go
new file mode 100644
index 00000000000..83943db9563
--- /dev/null
+++ b/pkg/services/export/export_sys_playlists.go
@@ -0,0 +1,40 @@
+package export
+
+import (
+ "fmt"
+ "path/filepath"
+ "time"
+
+ "github.com/grafana/grafana/pkg/models"
+)
+
+func exportSystemPlaylists(helper *commitHelper, job *gitExportJob) error {
+ cmd := &models.GetPlaylistsQuery{
+ OrgId: job.orgID,
+ Limit: 500000,
+ }
+ err := job.sql.SearchPlaylists(helper.ctx, cmd)
+ if err != nil {
+ return err
+ }
+
+ if len(cmd.Result) < 1 {
+ return nil // nothing
+ }
+
+ gitcmd := commitOptions{
+ when: time.Now(),
+ comment: "Export playlists",
+ }
+
+ for _, playlist := range cmd.Result {
+ // TODO: fix the playlist API so it returns the json we need :)
+
+ gitcmd.body = append(gitcmd.body, commitBody{
+ fpath: filepath.Join(helper.orgDir, "system", "playlists", fmt.Sprintf("%s-playlist.json", playlist.UID)),
+ body: prettyJSON(playlist),
+ })
+ }
+
+ return helper.add(gitcmd)
+}
diff --git a/pkg/services/export/export_sys_preferences.go b/pkg/services/export/export_sys_preferences.go
new file mode 100644
index 00000000000..926240acc04
--- /dev/null
+++ b/pkg/services/export/export_sys_preferences.go
@@ -0,0 +1,128 @@
+package export
+
+import (
+ "fmt"
+ "path"
+ "path/filepath"
+ "time"
+
+ "github.com/grafana/grafana/pkg/services/sqlstore"
+)
+
+func exportSystemPreferences(helper *commitHelper, job *gitExportJob) error {
+ type preferences struct {
+ UserID int64 `json:"-" xorm:"user_id"`
+ TeamID int64 `json:"-" xorm:"team_id"`
+ HomeDashboardID int64 `json:"-" xorm:"home_dashboard_id"`
+ Updated time.Time `json:"-" xorm:"updated"`
+ JSONData map[string]interface{} `json:"-" xorm:"json_data"`
+
+ Theme string `json:"theme"`
+ Locale string `json:"locale"`
+ Timezone string `json:"timezone"`
+ WeekStart string `json:"week_start,omitempty"`
+ HomeDashboard string `json:"home,omitempty" xorm:"uid"` // dashboard
+ NavBar interface{} `json:"navbar,omitempty"`
+ QueryHistory interface{} `json:"queryHistory,omitempty"`
+ }
+
+ prefsDir := path.Join(helper.orgDir, "system", "preferences")
+ users := make(map[int64]*userInfo, len(helper.users))
+ for _, user := range helper.users {
+ users[user.ID] = user
+ }
+
+ return job.sql.WithDbSession(helper.ctx, func(sess *sqlstore.DBSession) error {
+ rows := make([]*preferences, 0)
+
+ sess.Table("preferences").
+ Join("LEFT", "dashboard", "dashboard.id = preferences.home_dashboard_id").
+ Cols("preferences.*", "dashboard.uid").
+ Where("preferences.org_id = ?", helper.orgID)
+
+ err := sess.Find(&rows)
+ if err != nil {
+ return err
+ }
+
+ var comment string
+ var fpath string
+ for _, row := range rows {
+ if row.TeamID > 0 {
+ fpath = filepath.Join(prefsDir, "team", fmt.Sprintf("%d.json", row.TeamID))
+ comment = fmt.Sprintf("Team preferences: %d", row.TeamID)
+ } else if row.UserID == 0 {
+ fpath = filepath.Join(prefsDir, "default.json")
+ comment = "Default preferences"
+ } else {
+ user, ok := users[row.UserID]
+ if ok {
+ delete(users, row.UserID)
+ } else {
+ user = &userInfo{
+ Login: fmt.Sprintf("__%d__", row.UserID),
+ }
+ }
+ fpath = filepath.Join(prefsDir, "user", fmt.Sprintf("%s.json", user.Login))
+ comment = fmt.Sprintf("User preferences: %s", user.getAuthor().Name)
+ }
+
+ if row.JSONData != nil {
+ v, ok := row.JSONData["locale"]
+ if ok && row.Locale == "" {
+ s, ok := v.(string)
+ if ok {
+ row.Locale = s
+ }
+ }
+
+ v, ok = row.JSONData["navbar"]
+ if ok && row.NavBar == nil {
+ row.NavBar = v
+ }
+
+ v, ok = row.JSONData["queryHistory"]
+ if ok && row.QueryHistory == nil {
+ row.QueryHistory = v
+ }
+ }
+
+ err := helper.add(commitOptions{
+ body: []commitBody{
+ {
+ fpath: fpath,
+ body: prettyJSON(row),
+ },
+ },
+ when: row.Updated,
+ comment: comment,
+ userID: row.UserID,
+ })
+ if err != nil {
+ return err
+ }
+ }
+
+ // add a file for all useres that may not be in the system
+ for _, user := range users {
+ row := preferences{
+ Theme: user.Theme, // never set?
+ }
+ err := helper.add(commitOptions{
+ body: []commitBody{
+ {
+ fpath: filepath.Join(prefsDir, "user", fmt.Sprintf("%s.json", user.Login)),
+ body: prettyJSON(row),
+ },
+ },
+ when: user.Updated,
+ comment: "user preferences",
+ userID: row.UserID,
+ })
+ if err != nil {
+ return err
+ }
+ }
+ return err
+ })
+}
diff --git a/pkg/services/export/export_sys_stars.go b/pkg/services/export/export_sys_stars.go
new file mode 100644
index 00000000000..53fd6fea0b9
--- /dev/null
+++ b/pkg/services/export/export_sys_stars.go
@@ -0,0 +1,65 @@
+package export
+
+import (
+ "fmt"
+ "path/filepath"
+
+ "github.com/grafana/grafana/pkg/services/sqlstore"
+)
+
+func exportSystemStars(helper *commitHelper, job *gitExportJob) error {
+ byUser := make(map[int64][]string, 50)
+
+ err := job.sql.WithDbSession(helper.ctx, func(sess *sqlstore.DBSession) error {
+ type starResult struct {
+ User int64 `xorm:"user_id"`
+ UID string `xorm:"uid"`
+ }
+
+ rows := make([]*starResult, 0)
+
+ sess.Table("star").
+ Join("INNER", "dashboard", "dashboard.id = star.dashboard_id").
+ Cols("star.user_id", "dashboard.uid").
+ Where("dashboard.org_id = ?", helper.orgID)
+
+ err := sess.Find(&rows)
+ if err != nil {
+ return err
+ }
+
+ for _, row := range rows {
+ stars := append(byUser[row.User], fmt.Sprintf("dashboard/%s", row.UID))
+ byUser[row.User] = stars
+ }
+ return err
+ })
+ if err != nil {
+ return err
+ }
+
+ for userID, stars := range byUser {
+ user, ok := helper.users[userID]
+ if !ok {
+ user = &userInfo{
+ Login: fmt.Sprintf("__unknown_%d", userID),
+ }
+ }
+
+ err := helper.add(commitOptions{
+ body: []commitBody{
+ {
+ fpath: filepath.Join(helper.orgDir, "system", "stars", fmt.Sprintf("%s.json", user.Login)),
+ body: prettyJSON(stars),
+ },
+ },
+ when: user.Updated,
+ comment: "user preferences",
+ userID: userID,
+ })
+ if err != nil {
+ return err
+ }
+ }
+ return nil
+}
diff --git a/pkg/services/export/frame_helper.go b/pkg/services/export/frame_helper.go
new file mode 100644
index 00000000000..1f7a291d8e5
--- /dev/null
+++ b/pkg/services/export/frame_helper.go
@@ -0,0 +1,138 @@
+package export
+
+import (
+ "encoding/json"
+ "fmt"
+ "strings"
+
+ "github.com/grafana/grafana-plugin-sdk-go/data"
+)
+
+type fieldInfo struct {
+ Name string
+ Conv data.FieldConverter
+}
+
+type frameOpts struct {
+ schema []fieldInfo
+ skip []string
+}
+
+func prettyJSON(v interface{}) []byte {
+ b, _ := json.MarshalIndent(v, "", " ")
+ return b
+}
+
+func queryResultToDataFrame(rows []map[string]interface{}, opts frameOpts) (*data.Frame, error) {
+ count := len(rows)
+ if count < 1 {
+ return nil, nil // empty frame
+ }
+
+ schema := opts.schema
+ if len(schema) < 1 {
+ skip := make(map[string]bool, len(opts.skip))
+ for _, k := range opts.skip {
+ skip[k] = true
+ }
+
+ for k, v := range rows[0] {
+ if skip[k] {
+ continue
+ }
+ field := fieldInfo{
+ Name: k,
+ Conv: data.FieldConverter{
+ OutputFieldType: data.FieldTypeFor(v),
+ },
+ }
+ if field.Conv.OutputFieldType == data.FieldTypeUnknown {
+ fmt.Printf("UNKNOWN type: %s / %v\n", k, v)
+ continue
+ }
+
+ // Don't write passwords to disk for now!!!!
+ if k == "password" || k == "salt" {
+ field.Conv.Converter = func(v interface{}) (interface{}, error) {
+ return fmt.Sprintf("<%s>", k), nil
+ }
+ }
+
+ schema = append(schema, field)
+ }
+ }
+
+ fields := make([]*data.Field, len(schema))
+ for i, s := range schema {
+ fields[i] = data.NewFieldFromFieldType(s.Conv.OutputFieldType, count)
+ fields[i].Name = s.Name
+ }
+
+ var err error
+ for i, row := range rows {
+ for j, s := range schema {
+ v, ok := row[s.Name]
+ if ok && v != nil {
+ if s.Conv.Converter != nil {
+ v, err = s.Conv.Converter(v)
+ if err != nil {
+ return nil, fmt.Errorf("converting field: %s // %s", s.Name, err.Error())
+ }
+ }
+ fields[j].Set(i, v)
+ }
+ }
+ }
+
+ // Fields are in random order
+ if len(opts.schema) < 1 {
+ last := []*data.Field{}
+ frame := data.NewFrame("")
+ lookup := make(map[string]*data.Field, len(fields))
+ for _, f := range fields {
+ if f.Name == "id" {
+ frame.Fields = append(frame.Fields, f) // first
+ continue
+ }
+ lookup[f.Name] = f
+ }
+
+ // First items
+ for _, name := range []string{"name", "login", "email", "role", "description", "uid"} {
+ f, ok := lookup[name]
+ if ok {
+ frame.Fields = append(frame.Fields, f) // first
+ delete(lookup, name)
+ }
+ }
+
+ // IDs
+ for k, f := range lookup {
+ if strings.HasSuffix(k, "_id") {
+ frame.Fields = append(frame.Fields, f) // first
+ delete(lookup, k)
+ } else if strings.HasPrefix(k, "is_") {
+ last = append(last, f) // first
+ delete(lookup, k)
+ }
+ }
+
+ // Last items
+ for _, name := range []string{"created", "updated"} {
+ f, ok := lookup[name]
+ if ok {
+ last = append(last, f) // first
+ delete(lookup, name)
+ }
+ }
+
+ // Rest
+ for _, f := range lookup {
+ frame.Fields = append(frame.Fields, f)
+ }
+
+ frame.Fields = append(frame.Fields, last...)
+ return frame, nil
+ }
+ return data.NewFrame("", fields...), nil
+}
diff --git a/pkg/services/export/git_export_job.go b/pkg/services/export/git_export_job.go
new file mode 100644
index 00000000000..21243e05c52
--- /dev/null
+++ b/pkg/services/export/git_export_job.go
@@ -0,0 +1,205 @@
+package export
+
+import (
+ "context"
+ "fmt"
+ "path"
+ "sync"
+ "time"
+
+ "github.com/go-git/go-git/v5"
+ "github.com/go-git/go-git/v5/plumbing"
+
+ "github.com/grafana/grafana/pkg/infra/log"
+ "github.com/grafana/grafana/pkg/models"
+ "github.com/grafana/grafana/pkg/services/dashboardsnapshots"
+ "github.com/grafana/grafana/pkg/services/sqlstore"
+)
+
+var _ Job = new(gitExportJob)
+
+type gitExportJob struct {
+ logger log.Logger
+ sql *sqlstore.SQLStore
+ dashboardsnapshotsService dashboardsnapshots.Service
+ orgID int64
+ rootDir string
+
+ statusMu sync.Mutex
+ status ExportStatus
+ cfg ExportConfig
+ broadcaster statusBroadcaster
+}
+
+type simpleExporter = func(helper *commitHelper, job *gitExportJob) error
+
+func startGitExportJob(cfg ExportConfig, sql *sqlstore.SQLStore, dashboardsnapshotsService dashboardsnapshots.Service, rootDir string, orgID int64, broadcaster statusBroadcaster) (Job, error) {
+ job := &gitExportJob{
+ logger: log.New("git_export_job"),
+ cfg: cfg,
+ sql: sql,
+ dashboardsnapshotsService: dashboardsnapshotsService,
+ orgID: orgID,
+ rootDir: rootDir,
+ broadcaster: broadcaster,
+ status: ExportStatus{
+ Running: true,
+ Target: "git export",
+ Started: time.Now().UnixMilli(),
+ Current: 0,
+ },
+ }
+
+ broadcaster(job.status)
+ go job.start()
+ return job, nil
+}
+
+func (e *gitExportJob) getStatus() ExportStatus {
+ e.statusMu.Lock()
+ defer e.statusMu.Unlock()
+
+ return e.status
+}
+
+func (e *gitExportJob) getConfig() ExportConfig {
+ e.statusMu.Lock()
+ defer e.statusMu.Unlock()
+
+ return e.cfg
+}
+
+// Utility function to export dashboards
+func (e *gitExportJob) start() {
+ defer func() {
+ e.logger.Info("Finished git export job")
+
+ e.statusMu.Lock()
+ defer e.statusMu.Unlock()
+ s := e.status
+ if err := recover(); err != nil {
+ e.logger.Error("export panic", "error", err)
+ s.Status = fmt.Sprintf("ERROR: %v", err)
+ }
+ // Make sure it finishes OK
+ if s.Finished < 10 {
+ s.Finished = time.Now().UnixMilli()
+ }
+ s.Running = false
+ if s.Status == "" {
+ s.Status = "done"
+ }
+ s.Target = e.rootDir
+ e.status = s
+ e.broadcaster(s)
+ }()
+
+ err := e.doExportWithHistory()
+ if err != nil {
+ e.logger.Error("ERROR", "e", err)
+ e.status.Status = "ERROR"
+ e.status.Last = err.Error()
+ e.broadcaster(e.status)
+ }
+}
+
+func (e *gitExportJob) doExportWithHistory() error {
+ r, err := git.PlainInit(e.rootDir, false)
+ if err != nil {
+ return err
+ }
+ // default to "main" branch
+ h := plumbing.NewSymbolicReference(plumbing.HEAD, plumbing.ReferenceName("refs/heads/main"))
+ err = r.Storer.SetReference(h)
+ if err != nil {
+ return err
+ }
+
+ w, err := r.Worktree()
+ if err != nil {
+ return err
+ }
+ helper := &commitHelper{
+ repo: r,
+ work: w,
+ ctx: context.Background(),
+ workDir: e.rootDir,
+ orgDir: e.rootDir,
+ }
+
+ cmd := &models.SearchOrgsQuery{}
+ err = e.sql.SearchOrgs(helper.ctx, cmd)
+ if err != nil {
+ return err
+ }
+
+ // Export each org
+ for _, org := range cmd.Result {
+ if len(cmd.Result) > 1 {
+ helper.orgDir = path.Join(e.rootDir, fmt.Sprintf("org_%d", org.Id))
+ }
+ err = helper.initOrg(e.sql, org.Id)
+ if err != nil {
+ return err
+ }
+
+ err = e.doOrgExportWithHistory(helper)
+ if err != nil {
+ return err
+ }
+ }
+
+ // cleanup the folder
+ e.status.Target = "pruning..."
+ e.broadcaster(e.status)
+ err = r.Prune(git.PruneOptions{})
+
+ // TODO
+ // git gc --prune=now --aggressive
+
+ return err
+}
+
+func (e *gitExportJob) doOrgExportWithHistory(helper *commitHelper) error {
+ lookup, err := exportDataSources(helper, e)
+ if err != nil {
+ return err
+ }
+
+ if true {
+ err = exportDashboards(helper, e, lookup)
+ if err != nil {
+ return err
+ }
+ }
+
+ // Run all the simple exporters
+ exporters := []simpleExporter{
+ dumpAuthTables,
+ exportSystemPreferences,
+ exportSystemStars,
+ exportSystemPlaylists,
+ exportAnnotations,
+ }
+
+ // This needs a real admin user to use the interfaces (and decrypt)
+ if false {
+ exporters = append(exporters, exportSnapshots)
+ }
+
+ for _, fn := range exporters {
+ err = fn(helper, e)
+ if err != nil {
+ return err
+ }
+ }
+ return err
+}
+
+/**
+
+git remote add origin git@github.com:ryantxu/test-dash-repo.git
+git branch -M main
+git push -u origin main
+
+**/
diff --git a/pkg/services/export/service.go b/pkg/services/export/service.go
index ee4f1b040ea..6551775a065 100644
--- a/pkg/services/export/service.go
+++ b/pkg/services/export/service.go
@@ -2,15 +2,21 @@ package export
import (
"encoding/json"
+ "fmt"
"net/http"
+ "os"
+ "path/filepath"
"sync"
+ "time"
"github.com/grafana/grafana/pkg/api/response"
"github.com/grafana/grafana/pkg/infra/log"
"github.com/grafana/grafana/pkg/models"
+ "github.com/grafana/grafana/pkg/services/dashboardsnapshots"
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/grafana/grafana/pkg/services/live"
"github.com/grafana/grafana/pkg/services/sqlstore"
+ "github.com/grafana/grafana/pkg/setting"
)
type ExportService interface {
@@ -22,25 +28,31 @@ type ExportService interface {
}
type StandardExport struct {
- logger log.Logger
- sql *sqlstore.SQLStore
- glive *live.GrafanaLive
- mutex sync.Mutex
+ logger log.Logger
+ glive *live.GrafanaLive
+ mutex sync.Mutex
+ dataDir string
+
+ // Services
+ sql *sqlstore.SQLStore
+ dashboardsnapshotsService dashboardsnapshots.Service
// updated with mutex
exportJob Job
}
-func ProvideService(sql *sqlstore.SQLStore, features featuremgmt.FeatureToggles, gl *live.GrafanaLive) ExportService {
+func ProvideService(sql *sqlstore.SQLStore, features featuremgmt.FeatureToggles, gl *live.GrafanaLive, cfg *setting.Cfg, dashboardsnapshotsService dashboardsnapshots.Service) ExportService {
if !features.IsEnabled(featuremgmt.FlagExport) {
return &StubExport{}
}
return &StandardExport{
- sql: sql,
- glive: gl,
- logger: log.New("export_service"),
- exportJob: &stoppedJob{},
+ sql: sql,
+ glive: gl,
+ logger: log.New("export_service"),
+ dashboardsnapshotsService: dashboardsnapshotsService,
+ exportJob: &stoppedJob{},
+ dataDir: cfg.DataPath,
}
}
@@ -67,9 +79,23 @@ func (ex *StandardExport) HandleRequestExport(c *models.ReqContext) response.Res
return response.Error(http.StatusLocked, "export already running", nil)
}
- job, err := startDummyExportJob(cfg, func(s ExportStatus) {
+ var job Job
+ broadcast := func(s ExportStatus) {
ex.broadcastStatus(c.OrgId, s)
- })
+ }
+ switch cfg.Format {
+ case "dummy":
+ job, err = startDummyExportJob(cfg, broadcast)
+ case "git":
+ dir := filepath.Join(ex.dataDir, "export_git", fmt.Sprintf("git_%d", time.Now().Unix()))
+ if err := os.MkdirAll(dir, os.ModePerm); err != nil {
+ return response.Error(http.StatusBadRequest, "Error creating export folder", nil)
+ }
+ job, err = startGitExportJob(cfg, ex.sql, ex.dashboardsnapshotsService, dir, c.OrgId, broadcast)
+ default:
+ return response.Error(http.StatusBadRequest, "Unsupported job format", nil)
+ }
+
if err != nil {
ex.logger.Error("failed to start export job", "err", err)
return response.Error(http.StatusBadRequest, "failed to start export job", err)
diff --git a/pkg/services/featuremgmt/registry.go b/pkg/services/featuremgmt/registry.go
index 75e64a2ebca..81c39c2bace 100644
--- a/pkg/services/featuremgmt/registry.go
+++ b/pkg/services/featuremgmt/registry.go
@@ -227,6 +227,12 @@ var (
State: FeatureStateAlpha,
FrontendOnly: true,
},
+ {
+ Name: "scenes",
+ Description: "Experimental framework to build interactive dashboards",
+ State: FeatureStateAlpha,
+ FrontendOnly: true,
+ },
{
Name: "useLegacyHeatmapPanel",
Description: "Continue to use the angular/flot based heatmap panel",
diff --git a/pkg/services/featuremgmt/toggles_gen.go b/pkg/services/featuremgmt/toggles_gen.go
index d9ff3c122ae..d95e7241994 100644
--- a/pkg/services/featuremgmt/toggles_gen.go
+++ b/pkg/services/featuremgmt/toggles_gen.go
@@ -167,6 +167,10 @@ const (
// Allow elements nesting
FlagCanvasPanelNesting = "canvasPanelNesting"
+ // FlagScenes
+ // Experimental framework to build interactive dashboards
+ FlagScenes = "scenes"
+
// FlagUseLegacyHeatmapPanel
// Continue to use the angular/flot based heatmap panel
FlagUseLegacyHeatmapPanel = "useLegacyHeatmapPanel"
diff --git a/pkg/services/kmsproviders/osskmsproviders/osskmsproviders.go b/pkg/services/kmsproviders/osskmsproviders/osskmsproviders.go
index 4292ed16a58..511e7dc7091 100644
--- a/pkg/services/kmsproviders/osskmsproviders/osskmsproviders.go
+++ b/pkg/services/kmsproviders/osskmsproviders/osskmsproviders.go
@@ -24,10 +24,6 @@ func ProvideService(enc encryption.Internal, settings setting.Provider, features
}
func (s Service) Provide() (map[secrets.ProviderID]secrets.Provider, error) {
- if s.features.IsEnabled(featuremgmt.FlagDisableEnvelopeEncryption) {
- return nil, nil
- }
-
return map[secrets.ProviderID]secrets.Provider{
kmsproviders.Default: grafana.New(s.settings, s.enc),
}, nil
diff --git a/pkg/services/ngalert/api/api_provisioning.go b/pkg/services/ngalert/api/api_provisioning.go
index d1a6a1f1d59..2569d256b9f 100644
--- a/pkg/services/ngalert/api/api_provisioning.go
+++ b/pkg/services/ngalert/api/api_provisioning.go
@@ -54,6 +54,7 @@ type AlertRuleService interface {
CreateAlertRule(ctx context.Context, rule alerting_models.AlertRule, provenance alerting_models.Provenance) (alerting_models.AlertRule, error)
UpdateAlertRule(ctx context.Context, rule alerting_models.AlertRule, provenance alerting_models.Provenance) (alerting_models.AlertRule, error)
DeleteAlertRule(ctx context.Context, orgID int64, ruleUID string, provenance alerting_models.Provenance) error
+ GetRuleGroup(ctx context.Context, orgID int64, folder, group string) (definitions.AlertRuleGroup, error)
UpdateRuleGroup(ctx context.Context, orgID int64, folderUID, rulegroup string, interval int64) error
}
@@ -284,7 +285,18 @@ func (srv *ProvisioningSrv) RouteDeleteAlertRule(c *models.ReqContext, UID strin
return response.JSON(http.StatusNoContent, "")
}
-func (srv *ProvisioningSrv) RoutePutAlertRuleGroup(c *models.ReqContext, ag definitions.AlertRuleGroup, folderUID string, group string) response.Response {
+func (srv *ProvisioningSrv) RouteGetAlertRuleGroup(c *models.ReqContext, folder string, group string) response.Response {
+ g, err := srv.alertRules.GetRuleGroup(c.Req.Context(), c.OrgId, folder, group)
+ if err != nil {
+ if errors.Is(err, store.ErrAlertRuleGroupNotFound) {
+ return ErrResp(http.StatusNotFound, err, "")
+ }
+ return ErrResp(http.StatusInternalServerError, err, "")
+ }
+ return response.JSON(http.StatusOK, g)
+}
+
+func (srv *ProvisioningSrv) RoutePutAlertRuleGroup(c *models.ReqContext, ag definitions.AlertRuleGroupMetadata, folderUID string, group string) response.Response {
err := srv.alertRules.UpdateRuleGroup(c.Req.Context(), c.OrgId, folderUID, group, ag.Interval)
if err != nil {
if errors.Is(err, store.ErrOptimisticLock) {
diff --git a/pkg/services/ngalert/api/api_provisioning_test.go b/pkg/services/ngalert/api/api_provisioning_test.go
index 118dd0edb27..88574902f5f 100644
--- a/pkg/services/ngalert/api/api_provisioning_test.go
+++ b/pkg/services/ngalert/api/api_provisioning_test.go
@@ -239,6 +239,28 @@ func TestProvisioningApi(t *testing.T) {
require.Equal(t, 404, response.Status())
})
})
+
+ t.Run("alert rule groups", func(t *testing.T) {
+ t.Run("are present, GET returns 200", func(t *testing.T) {
+ sut := createProvisioningSrvSut(t)
+ rc := createTestRequestCtx()
+ insertRule(t, sut, createTestAlertRule("rule", 1))
+
+ response := sut.RouteGetAlertRuleGroup(&rc, "folder-uid", "my-cool-group")
+
+ require.Equal(t, 200, response.Status())
+ })
+
+ t.Run("are missing, GET returns 404", func(t *testing.T) {
+ sut := createProvisioningSrvSut(t)
+ rc := createTestRequestCtx()
+ insertRule(t, sut, createTestAlertRule("rule", 1))
+
+ response := sut.RouteGetAlertRuleGroup(&rc, "folder-uid", "does not exist")
+
+ require.Equal(t, 404, response.Status())
+ })
+ })
}
func createProvisioningSrvSut(t *testing.T) ProvisioningSrv {
@@ -382,6 +404,7 @@ func createTestAlertRule(title string, orgID int64) definitions.AlertRule {
},
},
RuleGroup: "my-cool-group",
+ FolderUID: "folder-uid",
For: time.Second * 60,
NoDataState: models.OK,
ExecErrState: models.OkErrState,
diff --git a/pkg/services/ngalert/api/authorization.go b/pkg/services/ngalert/api/authorization.go
index a2ebca1fb1f..49f2ad16cd2 100644
--- a/pkg/services/ngalert/api/authorization.go
+++ b/pkg/services/ngalert/api/authorization.go
@@ -185,7 +185,8 @@ func (api *API) authorize(method, path string) web.Handler {
http.MethodGet + "/api/v1/provisioning/templates/{name}",
http.MethodGet + "/api/v1/provisioning/mute-timings",
http.MethodGet + "/api/v1/provisioning/mute-timings/{name}",
- http.MethodGet + "/api/v1/provisioning/alert-rules/{UID}":
+ http.MethodGet + "/api/v1/provisioning/alert-rules/{UID}",
+ http.MethodGet + "/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}":
fallback = middleware.ReqOrgAdmin
eval = ac.EvalPermission(ac.ActionAlertingProvisioningRead) // organization scope
diff --git a/pkg/services/ngalert/api/forked_provisioning.go b/pkg/services/ngalert/api/forked_provisioning.go
index 6446ef47bb5..3339ab10d1f 100644
--- a/pkg/services/ngalert/api/forked_provisioning.go
+++ b/pkg/services/ngalert/api/forked_provisioning.go
@@ -95,6 +95,10 @@ func (f *ForkedProvisioningApi) forkRouteDeleteAlertRule(ctx *models.ReqContext,
return f.svc.RouteDeleteAlertRule(ctx, UID)
}
-func (f *ForkedProvisioningApi) forkRoutePutAlertRuleGroup(ctx *models.ReqContext, ag apimodels.AlertRuleGroup, folder, group string) response.Response {
+func (f *ForkedProvisioningApi) forkRouteGetAlertRuleGroup(ctx *models.ReqContext, folder, group string) response.Response {
+ return f.svc.RouteGetAlertRuleGroup(ctx, folder, group)
+}
+
+func (f *ForkedProvisioningApi) forkRoutePutAlertRuleGroup(ctx *models.ReqContext, ag apimodels.AlertRuleGroupMetadata, folder, group string) response.Response {
return f.svc.RoutePutAlertRuleGroup(ctx, ag, folder, group)
}
diff --git a/pkg/services/ngalert/api/generated_base_api_provisioning.go b/pkg/services/ngalert/api/generated_base_api_provisioning.go
index b449a168658..8fb66c89cc1 100644
--- a/pkg/services/ngalert/api/generated_base_api_provisioning.go
+++ b/pkg/services/ngalert/api/generated_base_api_provisioning.go
@@ -24,6 +24,7 @@ type ProvisioningApiForkingService interface {
RouteDeleteMuteTiming(*models.ReqContext) response.Response
RouteDeleteTemplate(*models.ReqContext) response.Response
RouteGetAlertRule(*models.ReqContext) response.Response
+ RouteGetAlertRuleGroup(*models.ReqContext) response.Response
RouteGetContactpoints(*models.ReqContext) response.Response
RouteGetMuteTiming(*models.ReqContext) response.Response
RouteGetMuteTimings(*models.ReqContext) response.Response
@@ -61,6 +62,11 @@ func (f *ForkedProvisioningApi) RouteGetAlertRule(ctx *models.ReqContext) respon
uIDParam := web.Params(ctx.Req)[":UID"]
return f.forkRouteGetAlertRule(ctx, uIDParam)
}
+func (f *ForkedProvisioningApi) RouteGetAlertRuleGroup(ctx *models.ReqContext) response.Response {
+ folderUIDParam := web.Params(ctx.Req)[":FolderUID"]
+ groupParam := web.Params(ctx.Req)[":Group"]
+ return f.forkRouteGetAlertRuleGroup(ctx, folderUIDParam, groupParam)
+}
func (f *ForkedProvisioningApi) RouteGetContactpoints(ctx *models.ReqContext) response.Response {
return f.forkRouteGetContactpoints(ctx)
}
@@ -113,7 +119,7 @@ func (f *ForkedProvisioningApi) RoutePutAlertRule(ctx *models.ReqContext) respon
func (f *ForkedProvisioningApi) RoutePutAlertRuleGroup(ctx *models.ReqContext) response.Response {
folderUIDParam := web.Params(ctx.Req)[":FolderUID"]
groupParam := web.Params(ctx.Req)[":Group"]
- conf := apimodels.AlertRuleGroup{}
+ conf := apimodels.AlertRuleGroupMetadata{}
if err := web.Bind(ctx.Req, &conf); err != nil {
return response.Error(http.StatusBadRequest, "bad request data", err)
}
@@ -203,6 +209,16 @@ func (api *API) RegisterProvisioningApiEndpoints(srv ProvisioningApiForkingServi
m,
),
)
+ group.Get(
+ toMacaronPath("/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}"),
+ api.authorize(http.MethodGet, "/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}"),
+ metrics.Instrument(
+ http.MethodGet,
+ "/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}",
+ srv.RouteGetAlertRuleGroup,
+ m,
+ ),
+ )
group.Get(
toMacaronPath("/api/v1/provisioning/contact-points"),
api.authorize(http.MethodGet, "/api/v1/provisioning/contact-points"),
diff --git a/pkg/services/ngalert/api/tooling/api.json b/pkg/services/ngalert/api/tooling/api.json
index e976a0da3fd..60645a449f3 100644
--- a/pkg/services/ngalert/api/tooling/api.json
+++ b/pkg/services/ngalert/api/tooling/api.json
@@ -308,7 +308,7 @@
],
"type": "object"
},
- "AlertRuleGroup": {
+ "AlertRuleGroupMetadata": {
"properties": {
"interval": {
"format": "int64",
@@ -470,30 +470,6 @@
},
"type": "array"
},
- "DashboardAclUpdateItem": {
- "properties": {
- "permission": {
- "$ref": "#/definitions/PermissionType"
- },
- "role": {
- "enum": [
- "Viewer",
- "Editor",
- "Admin"
- ],
- "type": "string"
- },
- "teamId": {
- "format": "int64",
- "type": "integer"
- },
- "userId": {
- "format": "int64",
- "type": "integer"
- }
- },
- "type": "object"
- },
"DateTime": {
"description": "DateTime is a time but it serializes to ISO8601 format with millis\nIt knows how to read 3 different variations of a RFC3339 date time.\nMost APIs we encounter want either millisecond or second precision times.\nThis just tries to make it worry-free.",
"format": "date-time",
@@ -1336,48 +1312,6 @@
},
"type": "array"
},
- "MetricRequest": {
- "properties": {
- "debug": {
- "type": "boolean"
- },
- "from": {
- "description": "From Start time in epoch timestamps in milliseconds or relative using Grafana time units.",
- "example": "now-1h",
- "type": "string"
- },
- "queries": {
- "description": "queries.refId – Specifies an identifier of the query. Is optional and default to “A”.\nqueries.datasourceId – Specifies the data source to be queried. Each query in the request must have an unique datasourceId.\nqueries.maxDataPoints - Species maximum amount of data points that dashboard panel can render. Is optional and default to 100.\nqueries.intervalMs - Specifies the time interval in milliseconds of time series. Is optional and defaults to 1000.",
- "example": [
- {
- "datasource": {
- "uid": "PD8C576611E62080A"
- },
- "format": "table",
- "intervalMs": 86400000,
- "maxDataPoints": 1092,
- "rawSql": "SELECT 1 as valueOne, 2 as valueTwo",
- "refId": "A"
- }
- ],
- "items": {
- "$ref": "#/definitions/Json"
- },
- "type": "array"
- },
- "to": {
- "description": "To End time in epoch timestamps in milliseconds or relative using Grafana time units.",
- "example": "now",
- "type": "string"
- }
- },
- "required": [
- "from",
- "to",
- "queries"
- ],
- "type": "object"
- },
"MonthRange": {
"properties": {
"Begin": {
@@ -1425,34 +1359,6 @@
},
"type": "object"
},
- "NavLink": {
- "properties": {
- "id": {
- "type": "string"
- },
- "target": {
- "type": "string"
- },
- "text": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "NavbarPreference": {
- "properties": {
- "savedItems": {
- "items": {
- "$ref": "#/definitions/NavLink"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
"NotFound": {
"type": "object"
},
@@ -1668,53 +1574,9 @@
},
"type": "object"
},
- "PatchPrefsCmd": {
- "properties": {
- "homeDashboardId": {
- "default": 0,
- "description": "The numerical :id of a favorited dashboard",
- "format": "int64",
- "type": "integer"
- },
- "homeDashboardUID": {
- "type": "string"
- },
- "locale": {
- "type": "string"
- },
- "navbar": {
- "$ref": "#/definitions/NavbarPreference"
- },
- "queryHistory": {
- "$ref": "#/definitions/QueryHistoryPreference"
- },
- "theme": {
- "enum": [
- "light",
- "dark"
- ],
- "type": "string"
- },
- "timezone": {
- "enum": [
- "utc",
- "browser"
- ],
- "type": "string"
- },
- "weekStart": {
- "type": "string"
- }
- },
- "type": "object"
- },
"PermissionDenied": {
"type": "object"
},
- "PermissionType": {
- "format": "int64",
- "type": "integer"
- },
"Point": {
"properties": {
"T": {
@@ -2036,14 +1898,6 @@
},
"type": "object"
},
- "QueryHistoryPreference": {
- "properties": {
- "homeTab": {
- "type": "string"
- }
- },
- "type": "object"
- },
"Receiver": {
"properties": {
"email_configs": {
@@ -2738,6 +2592,7 @@
"type": "object"
},
"URL": {
+ "description": "The general form represented is:\n\n[scheme:][//[userinfo@]host][/]path[?query][#fragment]\n\nURLs that do not start with a slash after the scheme are interpreted as:\n\nscheme:opaque[?query][#fragment]\n\nNote that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/.\nA consequence is that it is impossible to tell which slashes in the Path were\nslashes in the raw URL and which were %2f. This distinction is rarely important,\nbut when it is, the code should use RawPath, an optional field which only gets\nset if the default encoding is different from Path.\n\nURL's String method uses the EscapedPath method to obtain the path. See the\nEscapedPath method for more details.",
"properties": {
"ForceQuery": {
"type": "boolean"
@@ -2770,58 +2625,7 @@
"$ref": "#/definitions/Userinfo"
}
},
- "title": "URL is a custom URL type that allows validation at configuration load time.",
- "type": "object"
- },
- "UpdateDashboardAclCommand": {
- "properties": {
- "items": {
- "items": {
- "$ref": "#/definitions/DashboardAclUpdateItem"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "UpdatePrefsCmd": {
- "properties": {
- "homeDashboardId": {
- "default": 0,
- "description": "The numerical :id of a favorited dashboard",
- "format": "int64",
- "type": "integer"
- },
- "homeDashboardUID": {
- "type": "string"
- },
- "locale": {
- "type": "string"
- },
- "navbar": {
- "$ref": "#/definitions/NavbarPreference"
- },
- "queryHistory": {
- "$ref": "#/definitions/QueryHistoryPreference"
- },
- "theme": {
- "enum": [
- "light",
- "dark"
- ],
- "type": "string"
- },
- "timezone": {
- "enum": [
- "utc",
- "browser"
- ],
- "type": "string"
- },
- "weekStart": {
- "type": "string"
- }
- },
+ "title": "A URL represents a parsed URL (technically, a URI reference).",
"type": "object"
},
"Userinfo": {
@@ -2991,7 +2795,6 @@
"type": "object"
},
"alertGroup": {
- "description": "AlertGroup alert group",
"properties": {
"alerts": {
"description": "alerts",
@@ -3015,7 +2818,6 @@
"type": "object"
},
"alertGroups": {
- "description": "AlertGroups alert groups",
"items": {
"$ref": "#/definitions/alertGroup"
},
@@ -3123,6 +2925,7 @@
"$ref": "#/definitions/Duration"
},
"gettableAlert": {
+ "description": "GettableAlert gettable alert",
"properties": {
"annotations": {
"$ref": "#/definitions/labelSet"
@@ -3184,7 +2987,6 @@
"type": "array"
},
"gettableSilence": {
- "description": "GettableSilence gettable silence",
"properties": {
"comment": {
"description": "comment",
@@ -3344,7 +3146,6 @@
"type": "array"
},
"postableSilence": {
- "description": "PostableSilence postable silence",
"properties": {
"comment": {
"description": "comment",
@@ -3382,6 +3183,7 @@
"type": "object"
},
"receiver": {
+ "description": "Receiver receiver",
"properties": {
"name": {
"description": "name",
@@ -3730,6 +3532,35 @@
}
},
"/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}": {
+ "get": {
+ "operationId": "RouteGetAlertRuleGroup",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "FolderUID",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "Group",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/responses/AlertRuleGroup"
+ },
+ "404": {
+ "description": " Not found."
+ }
+ },
+ "summary": "Get a rule group.",
+ "tags": [
+ "provisioning"
+ ]
+ },
"put": {
"consumes": [
"application/json"
@@ -3752,15 +3583,15 @@
"in": "body",
"name": "Body",
"schema": {
- "$ref": "#/definitions/AlertRuleGroup"
+ "$ref": "#/definitions/AlertRuleGroupMetadata"
}
}
],
"responses": {
"200": {
- "description": "AlertRuleGroup",
+ "description": "AlertRuleGroupMetadata",
"schema": {
- "$ref": "#/definitions/AlertRuleGroup"
+ "$ref": "#/definitions/AlertRuleGroupMetadata"
}
},
"400": {
diff --git a/pkg/services/ngalert/api/tooling/definitions/alertmanager_validation.go b/pkg/services/ngalert/api/tooling/definitions/alertmanager_validation.go
index 5b6365ea412..20338b4fc5a 100644
--- a/pkg/services/ngalert/api/tooling/definitions/alertmanager_validation.go
+++ b/pkg/services/ngalert/api/tooling/definitions/alertmanager_validation.go
@@ -101,6 +101,34 @@ func (r *Route) Validate() error {
return r.validateChild()
}
+func (r *Route) ValidateReceivers(receivers map[string]struct{}) error {
+ if _, exists := receivers[r.Receiver]; !exists {
+ return fmt.Errorf("receiver '%s' does not exist", r.Receiver)
+ }
+ for _, children := range r.Routes {
+ err := children.ValidateReceivers(receivers)
+ if err != nil {
+ return err
+ }
+ }
+ return nil
+}
+
+func (r *Route) ValidateMuteTimes(muteTimes map[string]struct{}) error {
+ for _, name := range r.MuteTimeIntervals {
+ if _, exists := muteTimes[name]; !exists {
+ return fmt.Errorf("mute time interval '%s' does not exist", name)
+ }
+ }
+ for _, child := range r.Routes {
+ err := child.ValidateMuteTimes(muteTimes)
+ if err != nil {
+ return err
+ }
+ }
+ return nil
+}
+
func (mt *MuteTimeInterval) Validate() error {
s, err := yaml.Marshal(mt.MuteTimeInterval)
if err != nil {
diff --git a/pkg/services/ngalert/api/tooling/definitions/provisioning_alert_rules.go b/pkg/services/ngalert/api/tooling/definitions/provisioning_alert_rules.go
index 44a7df7491e..d54f27090bd 100644
--- a/pkg/services/ngalert/api/tooling/definitions/provisioning_alert_rules.go
+++ b/pkg/services/ngalert/api/tooling/definitions/provisioning_alert_rules.go
@@ -135,6 +135,14 @@ func NewAlertRule(rule models.AlertRule, provenance models.Provenance) AlertRule
}
}
+// swagger:route GET /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group} provisioning stable RouteGetAlertRuleGroup
+//
+// Get a rule group.
+//
+// Responses:
+// 200: AlertRuleGroup
+// 404: description: Not found.
+
// swagger:route PUT /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group} provisioning stable RoutePutAlertRuleGroup
//
// Update the interval of a rule group.
@@ -143,16 +151,16 @@ func NewAlertRule(rule models.AlertRule, provenance models.Provenance) AlertRule
// - application/json
//
// Responses:
-// 200: AlertRuleGroup
+// 200: AlertRuleGroupMetadata
// 400: ValidationError
-// swagger:parameters RoutePutAlertRuleGroup
+// swagger:parameters RouteGetAlertRuleGroup RoutePutAlertRuleGroup
type FolderUIDPathParam struct {
// in:path
FolderUID string `json:"FolderUID"`
}
-// swagger:parameters RoutePutAlertRuleGroup
+// swagger:parameters RouteGetAlertRuleGroup RoutePutAlertRuleGroup
type RuleGroupPathParam struct {
// in:path
Group string `json:"Group"`
@@ -161,9 +169,16 @@ type RuleGroupPathParam struct {
// swagger:parameters RoutePutAlertRuleGroup
type AlertRuleGroupPayload struct {
// in:body
- Body AlertRuleGroup
+ Body AlertRuleGroupMetadata
+}
+
+type AlertRuleGroupMetadata struct {
+ Interval int64 `json:"interval"`
}
type AlertRuleGroup struct {
- Interval int64 `json:"interval"`
+ Title string `json:"title"`
+ FolderUID string `json:"folderUid"`
+ Interval int64 `json:"interval"`
+ Rules []models.AlertRule `json:"rules"`
}
diff --git a/pkg/services/ngalert/api/tooling/post.json b/pkg/services/ngalert/api/tooling/post.json
index 5f1dc277dda..05c7dbeb931 100644
--- a/pkg/services/ngalert/api/tooling/post.json
+++ b/pkg/services/ngalert/api/tooling/post.json
@@ -308,7 +308,7 @@
],
"type": "object"
},
- "AlertRuleGroup": {
+ "AlertRuleGroupMetadata": {
"properties": {
"interval": {
"format": "int64",
@@ -2592,6 +2592,7 @@
"type": "object"
},
"URL": {
+ "description": "The general form represented is:\n\n[scheme:][//[userinfo@]host][/]path[?query][#fragment]\n\nURLs that do not start with a slash after the scheme are interpreted as:\n\nscheme:opaque[?query][#fragment]\n\nNote that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/.\nA consequence is that it is impossible to tell which slashes in the Path were\nslashes in the raw URL and which were %2f. This distinction is rarely important,\nbut when it is, the code should use RawPath, an optional field which only gets\nset if the default encoding is different from Path.\n\nURL's String method uses the EscapedPath method to obtain the path. See the\nEscapedPath method for more details.",
"properties": {
"ForceQuery": {
"type": "boolean"
@@ -2624,7 +2625,7 @@
"$ref": "#/definitions/Userinfo"
}
},
- "title": "URL is a custom URL type that allows validation at configuration load time.",
+ "title": "A URL represents a parsed URL (technically, a URI reference).",
"type": "object"
},
"Userinfo": {
@@ -2794,6 +2795,7 @@
"type": "object"
},
"alertGroup": {
+ "description": "AlertGroup alert group",
"properties": {
"alerts": {
"description": "alerts",
@@ -2988,6 +2990,7 @@
"type": "array"
},
"gettableSilence": {
+ "description": "GettableSilence gettable silence",
"properties": {
"comment": {
"description": "comment",
@@ -3146,6 +3149,7 @@
"type": "array"
},
"postableSilence": {
+ "description": "PostableSilence postable silence",
"properties": {
"comment": {
"description": "comment",
@@ -5157,6 +5161,35 @@
}
},
"/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}": {
+ "get": {
+ "operationId": "RouteGetAlertRuleGroup",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "FolderUID",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "Group",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/responses/AlertRuleGroup"
+ },
+ "404": {
+ "description": " Not found."
+ }
+ },
+ "summary": "Get a rule group.",
+ "tags": [
+ "provisioning"
+ ]
+ },
"put": {
"consumes": [
"application/json"
@@ -5179,15 +5212,15 @@
"in": "body",
"name": "Body",
"schema": {
- "$ref": "#/definitions/AlertRuleGroup"
+ "$ref": "#/definitions/AlertRuleGroupMetadata"
}
}
],
"responses": {
"200": {
- "description": "AlertRuleGroup",
+ "description": "AlertRuleGroupMetadata",
"schema": {
- "$ref": "#/definitions/AlertRuleGroup"
+ "$ref": "#/definitions/AlertRuleGroupMetadata"
}
},
"400": {
diff --git a/pkg/services/ngalert/api/tooling/spec.json b/pkg/services/ngalert/api/tooling/spec.json
index 61d42c493db..6878508f9b7 100644
--- a/pkg/services/ngalert/api/tooling/spec.json
+++ b/pkg/services/ngalert/api/tooling/spec.json
@@ -1893,6 +1893,36 @@
}
},
"/api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}": {
+ "get": {
+ "tags": [
+ "provisioning",
+ "stable"
+ ],
+ "summary": "Get a rule group.",
+ "operationId": "RouteGetAlertRuleGroup",
+ "parameters": [
+ {
+ "type": "string",
+ "name": "FolderUID",
+ "in": "path",
+ "required": true
+ },
+ {
+ "type": "string",
+ "name": "Group",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/responses/AlertRuleGroup"
+ },
+ "404": {
+ "description": " Not found."
+ }
+ }
+ },
"put": {
"consumes": [
"application/json"
@@ -1920,15 +1950,15 @@
"name": "Body",
"in": "body",
"schema": {
- "$ref": "#/definitions/AlertRuleGroup"
+ "$ref": "#/definitions/AlertRuleGroupMetadata"
}
}
],
"responses": {
"200": {
- "description": "AlertRuleGroup",
+ "description": "AlertRuleGroupMetadata",
"schema": {
- "$ref": "#/definitions/AlertRuleGroup"
+ "$ref": "#/definitions/AlertRuleGroupMetadata"
}
},
"400": {
@@ -2629,7 +2659,7 @@
}
}
},
- "AlertRuleGroup": {
+ "AlertRuleGroupMetadata": {
"type": "object",
"properties": {
"interval": {
@@ -4917,8 +4947,9 @@
}
},
"URL": {
+ "description": "The general form represented is:\n\n[scheme:][//[userinfo@]host][/]path[?query][#fragment]\n\nURLs that do not start with a slash after the scheme are interpreted as:\n\nscheme:opaque[?query][#fragment]\n\nNote that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/.\nA consequence is that it is impossible to tell which slashes in the Path were\nslashes in the raw URL and which were %2f. This distinction is rarely important,\nbut when it is, the code should use RawPath, an optional field which only gets\nset if the default encoding is different from Path.\n\nURL's String method uses the EscapedPath method to obtain the path. See the\nEscapedPath method for more details.",
"type": "object",
- "title": "URL is a custom URL type that allows validation at configuration load time.",
+ "title": "A URL represents a parsed URL (technically, a URI reference).",
"properties": {
"ForceQuery": {
"type": "boolean"
@@ -5119,6 +5150,7 @@
}
},
"alertGroup": {
+ "description": "AlertGroup alert group",
"type": "object",
"required": [
"alerts",
@@ -5143,7 +5175,6 @@
"$ref": "#/definitions/alertGroup"
},
"alertGroups": {
- "description": "AlertGroups alert groups",
"type": "array",
"items": {
"$ref": "#/definitions/alertGroup"
@@ -5252,7 +5283,6 @@
"$ref": "#/definitions/Duration"
},
"gettableAlert": {
- "description": "GettableAlert gettable alert",
"type": "object",
"required": [
"labels",
@@ -5309,7 +5339,6 @@
"$ref": "#/definitions/gettableAlert"
},
"gettableAlerts": {
- "description": "GettableAlerts gettable alerts",
"type": "array",
"items": {
"$ref": "#/definitions/gettableAlert"
@@ -5515,6 +5544,7 @@
"$ref": "#/definitions/postableSilence"
},
"receiver": {
+ "description": "Receiver receiver",
"type": "object",
"required": [
"name"
diff --git a/pkg/services/ngalert/notifier/available_channels.go b/pkg/services/ngalert/notifier/available_channels.go
index 948a70102b1..48c82c7bc7d 100644
--- a/pkg/services/ngalert/notifier/available_channels.go
+++ b/pkg/services/ngalert/notifier/available_channels.go
@@ -696,6 +696,14 @@ func GetAvailableNotifiers() []*alerting.NotifierPlugin {
Placeholder: `{{ template "default.message" . }}`,
PropertyName: "message",
},
+ { // New in 9.1.
+ Label: "Title",
+ Element: alerting.ElementTypeInput,
+ InputType: alerting.InputTypeText,
+ Description: "Templated title of the message",
+ PropertyName: "title",
+ Placeholder: `{{ template "default.title" . }}`,
+ },
},
},
{
diff --git a/pkg/services/ngalert/notifier/channels/wecom.go b/pkg/services/ngalert/notifier/channels/wecom.go
index 12fb42ced1e..4d25c1b8eff 100644
--- a/pkg/services/ngalert/notifier/channels/wecom.go
+++ b/pkg/services/ngalert/notifier/channels/wecom.go
@@ -18,6 +18,7 @@ type WeComConfig struct {
*NotificationChannelConfig
URL string
Message string
+ Title string
}
func WeComFactory(fc FactoryConfig) (NotificationChannel, error) {
@@ -40,6 +41,7 @@ func NewWeComConfig(config *NotificationChannelConfig, decryptFunc GetDecryptedV
NotificationChannelConfig: config,
URL: url,
Message: config.Settings.Get("message").MustString(`{{ template "default.message" .}}`),
+ Title: config.Settings.Get("title").MustString(DefaultMessageTitleEmbed),
}, nil
}
@@ -55,6 +57,7 @@ func NewWeComNotifier(config *WeComConfig, ns notifications.WebhookSender, t *te
}),
URL: config.URL,
Message: config.Message,
+ Title: config.Title,
log: log.New("alerting.notifier.wecom"),
ns: ns,
tmpl: t,
@@ -66,6 +69,7 @@ type WeComNotifier struct {
*Base
URL string
Message string
+ Title string
tmpl *template.Template
log log.Logger
ns notifications.WebhookSender
@@ -82,7 +86,7 @@ func (w *WeComNotifier) Notify(ctx context.Context, as ...*types.Alert) (bool, e
"msgtype": "markdown",
}
content := fmt.Sprintf("# %s\n%s\n",
- tmpl(DefaultMessageTitleEmbed),
+ tmpl(w.Title),
tmpl(w.Message),
)
diff --git a/pkg/services/ngalert/notifier/channels/wecom_test.go b/pkg/services/ngalert/notifier/channels/wecom_test.go
index 4c7bfd2b49f..d5343f360b6 100644
--- a/pkg/services/ngalert/notifier/channels/wecom_test.go
+++ b/pkg/services/ngalert/notifier/channels/wecom_test.go
@@ -76,6 +76,33 @@ func TestWeComNotifier(t *testing.T) {
"msgtype": "markdown",
},
expMsgError: nil,
+ }, {
+ name: "Custom title and message with multiple alerts",
+ settings: `{
+ "url": "http://localhost",
+ "message": "{{ len .Alerts.Firing }} alerts are firing, {{ len .Alerts.Resolved }} are resolved",
+ "title": "This notification is {{ .Status }}!"
+ }`,
+ alerts: []*types.Alert{
+ {
+ Alert: model.Alert{
+ Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val1"},
+ Annotations: model.LabelSet{"ann1": "annv1"},
+ },
+ }, {
+ Alert: model.Alert{
+ Labels: model.LabelSet{"alertname": "alert1", "lbl1": "val2"},
+ Annotations: model.LabelSet{"ann1": "annv2"},
+ },
+ },
+ },
+ expMsg: map[string]interface{}{
+ "markdown": map[string]interface{}{
+ "content": "# This notification is firing!\n2 alerts are firing, 0 are resolved\n",
+ },
+ "msgtype": "markdown",
+ },
+ expMsgError: nil,
}, {
name: "Error in initing",
settings: `{}`,
diff --git a/pkg/services/ngalert/provisioning/alert_rules.go b/pkg/services/ngalert/provisioning/alert_rules.go
index 04e4e9a8987..5d618317eda 100644
--- a/pkg/services/ngalert/provisioning/alert_rules.go
+++ b/pkg/services/ngalert/provisioning/alert_rules.go
@@ -7,6 +7,7 @@ import (
"time"
"github.com/grafana/grafana/pkg/infra/log"
+ "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
"github.com/grafana/grafana/pkg/services/ngalert/models"
"github.com/grafana/grafana/pkg/services/ngalert/store"
"github.com/grafana/grafana/pkg/util"
@@ -89,6 +90,32 @@ func (service *AlertRuleService) CreateAlertRule(ctx context.Context, rule model
return rule, nil
}
+func (service *AlertRuleService) GetRuleGroup(ctx context.Context, orgID int64, folder, group string) (definitions.AlertRuleGroup, error) {
+ q := models.ListAlertRulesQuery{
+ OrgID: orgID,
+ NamespaceUIDs: []string{folder},
+ RuleGroup: group,
+ }
+ if err := service.ruleStore.ListAlertRules(ctx, &q); err != nil {
+ return definitions.AlertRuleGroup{}, err
+ }
+ if len(q.Result) == 0 {
+ return definitions.AlertRuleGroup{}, store.ErrAlertRuleGroupNotFound
+ }
+ res := definitions.AlertRuleGroup{
+ Title: q.Result[0].RuleGroup,
+ FolderUID: q.Result[0].NamespaceUID,
+ Interval: q.Result[0].IntervalSeconds,
+ Rules: []models.AlertRule{},
+ }
+ for _, r := range q.Result {
+ if r != nil {
+ res.Rules = append(res.Rules, *r)
+ }
+ }
+ return res, nil
+}
+
// UpdateRuleGroup will update the interval for all rules in the group.
func (service *AlertRuleService) UpdateRuleGroup(ctx context.Context, orgID int64, namespaceUID string, ruleGroup string, interval int64) error {
if err := models.ValidateRuleGroupInterval(interval, service.baseIntervalSeconds); err != nil {
diff --git a/pkg/services/ngalert/provisioning/notification_policies.go b/pkg/services/ngalert/provisioning/notification_policies.go
index f03611fc86d..8597360fa03 100644
--- a/pkg/services/ngalert/provisioning/notification_policies.go
+++ b/pkg/services/ngalert/provisioning/notification_policies.go
@@ -16,7 +16,8 @@ type NotificationPolicyService struct {
log log.Logger
}
-func NewNotificationPolicyService(am AMConfigStore, prov ProvisioningStore, xact TransactionManager, log log.Logger) *NotificationPolicyService {
+func NewNotificationPolicyService(am AMConfigStore, prov ProvisioningStore,
+ xact TransactionManager, log log.Logger) *NotificationPolicyService {
return &NotificationPolicyService{
amStore: am,
provenanceStore: prov,
@@ -63,11 +64,27 @@ func (nps *NotificationPolicyService) UpdatePolicyTree(ctx context.Context, orgI
if err != nil {
return fmt.Errorf("%w: %s", ErrValidation, err.Error())
}
+
revision, err := getLastConfiguration(ctx, orgID, nps.amStore)
if err != nil {
return err
}
+ receivers, err := nps.receiversToMap(revision.cfg.AlertmanagerConfig.Receivers)
+ err = tree.ValidateReceivers(receivers)
+ if err != nil {
+ return fmt.Errorf("%w: %s", ErrValidation, err.Error())
+ }
+
+ muteTimes := map[string]struct{}{}
+ for _, mt := range revision.cfg.AlertmanagerConfig.MuteTimeIntervals {
+ muteTimes[mt.Name] = struct{}{}
+ }
+ err = tree.ValidateMuteTimes(muteTimes)
+ if err != nil {
+ return fmt.Errorf("%w: %s", ErrValidation, err.Error())
+ }
+
revision.cfg.AlertmanagerConfig.Config.Route = &tree
serialized, err := serializeAlertmanagerConfig(*revision.cfg)
@@ -98,3 +115,11 @@ func (nps *NotificationPolicyService) UpdatePolicyTree(ctx context.Context, orgI
return nil
}
+
+func (nps *NotificationPolicyService) receiversToMap(records []*definitions.PostableApiReceiver) (map[string]struct{}, error) {
+ receivers := map[string]struct{}{}
+ for _, receiver := range records {
+ receivers[receiver.Name] = struct{}{}
+ }
+ return receivers, nil
+}
diff --git a/pkg/services/ngalert/provisioning/notification_policies_test.go b/pkg/services/ngalert/provisioning/notification_policies_test.go
index df98eb4f7c6..cff09e8899a 100644
--- a/pkg/services/ngalert/provisioning/notification_policies_test.go
+++ b/pkg/services/ngalert/provisioning/notification_policies_test.go
@@ -7,7 +7,10 @@ import (
"github.com/grafana/grafana/pkg/infra/log"
"github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions"
"github.com/grafana/grafana/pkg/services/ngalert/models"
+ "github.com/prometheus/alertmanager/config"
+ "github.com/prometheus/alertmanager/timeinterval"
"github.com/prometheus/common/model"
+ "github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
)
@@ -21,8 +24,85 @@ func TestNotificationPolicyService(t *testing.T) {
require.Equal(t, "grafana-default-email", tree.Receiver)
})
+ t.Run("error if referenced mute time interval is not existing", func(t *testing.T) {
+ sut := createNotificationPolicyServiceSut()
+ sut.amStore = &MockAMConfigStore{}
+ sut.amStore.(*MockAMConfigStore).On("GetLatestAlertmanagerConfiguration", mock.Anything, mock.Anything).
+ Return(
+ func(ctx context.Context, query *models.GetLatestAlertmanagerConfigurationQuery) error {
+ cfg, _ := deserializeAlertmanagerConfig([]byte(defaultConfig))
+ mti := config.MuteTimeInterval{
+ Name: "not-the-one-we-need",
+ TimeIntervals: []timeinterval.TimeInterval{},
+ }
+ cfg.AlertmanagerConfig.MuteTimeIntervals = append(cfg.AlertmanagerConfig.MuteTimeIntervals, mti)
+ cfg.AlertmanagerConfig.Receivers = append(cfg.AlertmanagerConfig.Receivers,
+ &definitions.PostableApiReceiver{
+ Receiver: config.Receiver{
+ // default one from createTestRoutingTree()
+ Name: "a new receiver",
+ },
+ })
+ data, _ := serializeAlertmanagerConfig(*cfg)
+ query.Result = &models.AlertConfiguration{
+ AlertmanagerConfiguration: string(data),
+ }
+ return nil
+ })
+ sut.amStore.(*MockAMConfigStore).EXPECT().
+ UpdateAlertmanagerConfiguration(mock.Anything, mock.Anything).
+ Return(nil)
+ newRoute := createTestRoutingTree()
+ newRoute.Routes = append(newRoute.Routes, &definitions.Route{
+ Receiver: "a new receiver",
+ MuteTimeIntervals: []string{"not-existing"},
+ })
+
+ err := sut.UpdatePolicyTree(context.Background(), 1, newRoute, models.ProvenanceNone)
+ require.Error(t, err)
+ })
+
+ t.Run("pass if referenced mute time interval is existing", func(t *testing.T) {
+ sut := createNotificationPolicyServiceSut()
+ sut.amStore = &MockAMConfigStore{}
+ sut.amStore.(*MockAMConfigStore).On("GetLatestAlertmanagerConfiguration", mock.Anything, mock.Anything).
+ Return(
+ func(ctx context.Context, query *models.GetLatestAlertmanagerConfigurationQuery) error {
+ cfg, _ := deserializeAlertmanagerConfig([]byte(defaultConfig))
+ mti := config.MuteTimeInterval{
+ Name: "existing",
+ TimeIntervals: []timeinterval.TimeInterval{},
+ }
+ cfg.AlertmanagerConfig.MuteTimeIntervals = append(cfg.AlertmanagerConfig.MuteTimeIntervals, mti)
+ cfg.AlertmanagerConfig.Receivers = append(cfg.AlertmanagerConfig.Receivers,
+ &definitions.PostableApiReceiver{
+ Receiver: config.Receiver{
+ // default one from createTestRoutingTree()
+ Name: "a new receiver",
+ },
+ })
+ data, _ := serializeAlertmanagerConfig(*cfg)
+ query.Result = &models.AlertConfiguration{
+ AlertmanagerConfiguration: string(data),
+ }
+ return nil
+ })
+ sut.amStore.(*MockAMConfigStore).EXPECT().
+ UpdateAlertmanagerConfiguration(mock.Anything, mock.Anything).
+ Return(nil)
+ newRoute := createTestRoutingTree()
+ newRoute.Routes = append(newRoute.Routes, &definitions.Route{
+ Receiver: "a new receiver",
+ MuteTimeIntervals: []string{"existing"},
+ })
+
+ err := sut.UpdatePolicyTree(context.Background(), 1, newRoute, models.ProvenanceNone)
+ require.NoError(t, err)
+ })
+
t.Run("service stitches policy tree into org's AM config", func(t *testing.T) {
sut := createNotificationPolicyServiceSut()
+
newRoute := createTestRoutingTree()
err := sut.UpdatePolicyTree(context.Background(), 1, newRoute, models.ProvenanceNone)
@@ -33,6 +113,56 @@ func TestNotificationPolicyService(t *testing.T) {
require.Equal(t, "a new receiver", updated.Receiver)
})
+ t.Run("not existing receiver reference will error", func(t *testing.T) {
+ sut := createNotificationPolicyServiceSut()
+
+ newRoute := createTestRoutingTree()
+ newRoute.Routes = append(newRoute.Routes, &definitions.Route{
+ Receiver: "not-existing",
+ })
+
+ err := sut.UpdatePolicyTree(context.Background(), 1, newRoute, models.ProvenanceNone)
+ require.Error(t, err)
+ })
+
+ t.Run("existing receiver reference will pass", func(t *testing.T) {
+ sut := createNotificationPolicyServiceSut()
+ sut.amStore = &MockAMConfigStore{}
+ sut.amStore.(*MockAMConfigStore).On("GetLatestAlertmanagerConfiguration", mock.Anything, mock.Anything).
+ Return(
+ func(ctx context.Context, query *models.GetLatestAlertmanagerConfigurationQuery) error {
+ cfg, _ := deserializeAlertmanagerConfig([]byte(defaultConfig))
+ cfg.AlertmanagerConfig.Receivers = append(cfg.AlertmanagerConfig.Receivers,
+ &definitions.PostableApiReceiver{
+ Receiver: config.Receiver{
+ // default one from createTestRoutingTree()
+ Name: "a new receiver",
+ },
+ })
+ cfg.AlertmanagerConfig.Receivers = append(cfg.AlertmanagerConfig.Receivers,
+ &definitions.PostableApiReceiver{
+ Receiver: config.Receiver{
+ Name: "existing",
+ },
+ })
+ data, _ := serializeAlertmanagerConfig(*cfg)
+ query.Result = &models.AlertConfiguration{
+ AlertmanagerConfiguration: string(data),
+ }
+ return nil
+ })
+ sut.amStore.(*MockAMConfigStore).EXPECT().
+ UpdateAlertmanagerConfiguration(mock.Anything, mock.Anything).
+ Return(nil)
+ newRoute := createTestRoutingTree()
+ newRoute.Routes = append(newRoute.Routes, &definitions.Route{
+ Receiver: "existing",
+ })
+
+ err := sut.UpdatePolicyTree(context.Background(), 1, newRoute, models.ProvenanceNone)
+ require.NoError(t, err)
+ })
+
t.Run("default provenance of records is none", func(t *testing.T) {
sut := createNotificationPolicyServiceSut()
diff --git a/pkg/services/publicdashboards/api/api.go b/pkg/services/publicdashboards/api/api.go
new file mode 100644
index 00000000000..65d87fc6568
--- /dev/null
+++ b/pkg/services/publicdashboards/api/api.go
@@ -0,0 +1,234 @@
+package api
+
+import (
+ "errors"
+ "net/http"
+ "strconv"
+
+ "github.com/grafana/grafana-plugin-sdk-go/backend"
+ "github.com/grafana/grafana/pkg/api/dtos"
+ "github.com/grafana/grafana/pkg/api/response"
+ "github.com/grafana/grafana/pkg/api/routing"
+ "github.com/grafana/grafana/pkg/middleware"
+ "github.com/grafana/grafana/pkg/models"
+ "github.com/grafana/grafana/pkg/plugins/backendplugin"
+ "github.com/grafana/grafana/pkg/services/accesscontrol"
+ "github.com/grafana/grafana/pkg/services/dashboards"
+ "github.com/grafana/grafana/pkg/services/datasources"
+ "github.com/grafana/grafana/pkg/services/featuremgmt"
+ "github.com/grafana/grafana/pkg/services/publicdashboards"
+ . "github.com/grafana/grafana/pkg/services/publicdashboards/models"
+ "github.com/grafana/grafana/pkg/services/query"
+ "github.com/grafana/grafana/pkg/util"
+ "github.com/grafana/grafana/pkg/web"
+)
+
+type Api struct {
+ PublicDashboardService publicdashboards.Service
+ RouteRegister routing.RouteRegister
+ AccessControl accesscontrol.AccessControl
+ QueryDataService *query.Service
+ Features *featuremgmt.FeatureManager
+}
+
+func ProvideApi(
+ pd publicdashboards.Service,
+ rr routing.RouteRegister,
+ ac accesscontrol.AccessControl,
+ qds *query.Service,
+ features *featuremgmt.FeatureManager,
+) *Api {
+ api := &Api{
+ PublicDashboardService: pd,
+ RouteRegister: rr,
+ AccessControl: ac,
+ QueryDataService: qds,
+ Features: features,
+ }
+
+ // attach api if PublicDashboards feature flag is enabled
+ if features.IsEnabled(featuremgmt.FlagPublicDashboards) {
+ api.RegisterAPIEndpoints()
+ }
+
+ return api
+}
+
+func (api *Api) RegisterAPIEndpoints() {
+ auth := accesscontrol.Middleware(api.AccessControl)
+ reqSignedIn := middleware.ReqSignedIn
+
+ // Anonymous access to public dashboard route is configured in pkg/api/api.go
+ // because it is deeply dependent on the HTTPServer.Index() method and would result in a
+ // circular dependency
+
+ api.RouteRegister.Get("/api/public/dashboards/:accessToken", routing.Wrap(api.GetPublicDashboard))
+ api.RouteRegister.Post("/api/public/dashboards/:accessToken/panels/:panelId/query", routing.Wrap(api.QueryPublicDashboard))
+
+ // Create/Update Public Dashboard
+ api.RouteRegister.Get("/api/dashboards/uid/:uid/public-config", auth(reqSignedIn, accesscontrol.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(api.GetPublicDashboardConfig))
+ api.RouteRegister.Post("/api/dashboards/uid/:uid/public-config", auth(reqSignedIn, accesscontrol.EvalPermission(dashboards.ActionDashboardsWrite)), routing.Wrap(api.SavePublicDashboardConfig))
+}
+
+// gets public dashboard
+func (api *Api) GetPublicDashboard(c *models.ReqContext) response.Response {
+ accessToken := web.Params(c.Req)[":accessToken"]
+
+ dash, err := api.PublicDashboardService.GetPublicDashboard(c.Req.Context(), accessToken)
+ if err != nil {
+ return handleDashboardErr(http.StatusInternalServerError, "Failed to get public dashboard", err)
+ }
+
+ meta := dtos.DashboardMeta{
+ Slug: dash.Slug,
+ Type: models.DashTypeDB,
+ CanStar: false,
+ CanSave: false,
+ CanEdit: false,
+ CanAdmin: false,
+ CanDelete: false,
+ Created: dash.Created,
+ Updated: dash.Updated,
+ Version: dash.Version,
+ IsFolder: false,
+ FolderId: dash.FolderId,
+ PublicDashboardAccessToken: accessToken,
+ }
+
+ dto := dtos.DashboardFullWithMeta{Meta: meta, Dashboard: dash.Data}
+
+ return response.JSON(http.StatusOK, dto)
+}
+
+// gets public dashboard configuration for dashboard
+func (api *Api) GetPublicDashboardConfig(c *models.ReqContext) response.Response {
+ pdc, err := api.PublicDashboardService.GetPublicDashboardConfig(c.Req.Context(), c.OrgId, web.Params(c.Req)[":uid"])
+ if err != nil {
+ return handleDashboardErr(http.StatusInternalServerError, "Failed to get public dashboard config", err)
+ }
+ return response.JSON(http.StatusOK, pdc)
+}
+
+// sets public dashboard configuration for dashboard
+func (api *Api) SavePublicDashboardConfig(c *models.ReqContext) response.Response {
+ pubdash := &PublicDashboard{}
+ if err := web.Bind(c.Req, pubdash); err != nil {
+ return response.Error(http.StatusBadRequest, "bad request data", err)
+ }
+
+ // Always set the org id to the current auth session orgId
+ pubdash.OrgId = c.OrgId
+
+ dto := SavePublicDashboardConfigDTO{
+ OrgId: c.OrgId,
+ DashboardUid: web.Params(c.Req)[":uid"],
+ UserId: c.UserId,
+ PublicDashboard: pubdash,
+ }
+
+ pubdash, err := api.PublicDashboardService.SavePublicDashboardConfig(c.Req.Context(), &dto)
+ if err != nil {
+ return handleDashboardErr(http.StatusInternalServerError, "Failed to save public dashboard configuration", err)
+ }
+
+ return response.JSON(http.StatusOK, pubdash)
+}
+
+// QueryPublicDashboard returns all results for a given panel on a public dashboard
+// POST /api/public/dashboard/:accessToken/panels/:panelId/query
+func (api *Api) QueryPublicDashboard(c *models.ReqContext) response.Response {
+ panelId, err := strconv.ParseInt(web.Params(c.Req)[":panelId"], 10, 64)
+ if err != nil {
+ return response.Error(http.StatusBadRequest, "invalid panel ID", err)
+ }
+
+ dashboard, err := api.PublicDashboardService.GetPublicDashboard(c.Req.Context(), web.Params(c.Req)[":accessToken"])
+ if err != nil {
+ return response.Error(http.StatusInternalServerError, "could not fetch dashboard", err)
+ }
+
+ publicDashboard, err := api.PublicDashboardService.GetPublicDashboardConfig(c.Req.Context(), dashboard.OrgId, dashboard.Uid)
+ if err != nil {
+ return response.Error(http.StatusInternalServerError, "could not fetch public dashboard", err)
+ }
+
+ reqDTO, err := api.PublicDashboardService.BuildPublicDashboardMetricRequest(
+ c.Req.Context(),
+ dashboard,
+ publicDashboard,
+ panelId,
+ )
+ if err != nil {
+ return handleDashboardErr(http.StatusInternalServerError, "Failed to get queries for public dashboard", err)
+ }
+
+ anonymousUser, err := api.PublicDashboardService.BuildAnonymousUser(c.Req.Context(), dashboard)
+
+ if err != nil {
+ return response.Error(http.StatusInternalServerError, "could not create anonymous user", err)
+ }
+
+ resp, err := api.QueryDataService.QueryDataMultipleSources(c.Req.Context(), anonymousUser, c.SkipCache, reqDTO, true)
+
+ if err != nil {
+ return handleQueryMetricsError(err)
+ }
+ return toJsonStreamingResponse(api.Features, resp)
+}
+
+// util to help us unpack dashboard and publicdashboard errors or use default http code and message
+// we should look to do some future refactoring of these errors as publicdashboard err is the same as a dashboarderr, just defined in a
+// different package.
+func handleDashboardErr(defaultCode int, defaultMsg string, err error) response.Response {
+ var publicDashboardErr PublicDashboardErr
+
+ // handle public dashboard er
+ if ok := errors.As(err, &publicDashboardErr); ok {
+ return response.Error(publicDashboardErr.StatusCode, publicDashboardErr.Error(), publicDashboardErr)
+ }
+
+ // handle dashboard errors as well
+ var dashboardErr dashboards.DashboardErr
+ if ok := errors.As(err, &dashboardErr); ok {
+ return response.Error(dashboardErr.StatusCode, dashboardErr.Error(), dashboardErr)
+ }
+
+ return response.Error(defaultCode, defaultMsg, err)
+}
+
+// Copied from pkg/api/metrics.go
+func handleQueryMetricsError(err error) *response.NormalResponse {
+ if errors.Is(err, datasources.ErrDataSourceAccessDenied) {
+ return response.Error(http.StatusForbidden, "Access denied to data source", err)
+ }
+ if errors.Is(err, datasources.ErrDataSourceNotFound) {
+ return response.Error(http.StatusNotFound, "Data source not found", err)
+ }
+ var badQuery *query.ErrBadQuery
+ if errors.As(err, &badQuery) {
+ return response.Error(http.StatusBadRequest, util.Capitalize(badQuery.Message), err)
+ }
+
+ if errors.Is(err, backendplugin.ErrPluginNotRegistered) {
+ return response.Error(http.StatusNotFound, "Plugin not found", err)
+ }
+
+ return response.Error(http.StatusInternalServerError, "Query data error", err)
+}
+
+// Copied from pkg/api/metrics.go
+func toJsonStreamingResponse(features *featuremgmt.FeatureManager, qdr *backend.QueryDataResponse) response.Response {
+ statusWhenError := http.StatusBadRequest
+ if features.IsEnabled(featuremgmt.FlagDatasourceQueryMultiStatus) {
+ statusWhenError = http.StatusMultiStatus
+ }
+
+ statusCode := http.StatusOK
+ for _, res := range qdr.Responses {
+ if res.Error != nil {
+ statusCode = statusWhenError
+ }
+ }
+
+ return response.JSONStreaming(statusCode, qdr)
+}
diff --git a/pkg/services/publicdashboards/api/api_test.go b/pkg/services/publicdashboards/api/api_test.go
new file mode 100644
index 00000000000..4eb0ea1ad4e
--- /dev/null
+++ b/pkg/services/publicdashboards/api/api_test.go
@@ -0,0 +1,589 @@
+package api
+
+import (
+ "context"
+ "encoding/json"
+ "errors"
+ "fmt"
+ "net/http"
+ "strings"
+ "testing"
+
+ "github.com/google/uuid"
+ "github.com/stretchr/testify/assert"
+ "github.com/stretchr/testify/mock"
+ "github.com/stretchr/testify/require"
+
+ "github.com/grafana/grafana-plugin-sdk-go/backend"
+ "github.com/grafana/grafana-plugin-sdk-go/data"
+ "github.com/grafana/grafana/pkg/api/dtos"
+ "github.com/grafana/grafana/pkg/components/simplejson"
+ "github.com/grafana/grafana/pkg/infra/localcache"
+ "github.com/grafana/grafana/pkg/models"
+ "github.com/grafana/grafana/pkg/services/dashboards"
+ dashboardStore "github.com/grafana/grafana/pkg/services/dashboards/database"
+ "github.com/grafana/grafana/pkg/services/datasources"
+ fakeDatasources "github.com/grafana/grafana/pkg/services/datasources/fakes"
+ "github.com/grafana/grafana/pkg/services/datasources/service"
+ "github.com/grafana/grafana/pkg/services/featuremgmt"
+ "github.com/grafana/grafana/pkg/services/publicdashboards"
+ publicdashboardsStore "github.com/grafana/grafana/pkg/services/publicdashboards/database"
+ . "github.com/grafana/grafana/pkg/services/publicdashboards/models"
+ publicdashboardsService "github.com/grafana/grafana/pkg/services/publicdashboards/service"
+ "github.com/grafana/grafana/pkg/services/sqlstore"
+ "github.com/grafana/grafana/pkg/setting"
+ "github.com/grafana/grafana/pkg/web"
+)
+
+func TestAPIGetPublicDashboard(t *testing.T) {
+ t.Run("It should 404 if featureflag is not enabled", func(t *testing.T) {
+ cfg := setting.NewCfg()
+ qs := buildQueryDataService(t, nil, nil, nil)
+ service := publicdashboards.NewFakePublicDashboardService(t)
+ service.On("GetPublicDashboard", mock.Anything, mock.AnythingOfType("string")).
+ Return(&models.Dashboard{}, nil).Maybe()
+
+ testServer := setupTestServer(t, cfg, qs, featuremgmt.WithFeatures(), service, nil)
+
+ response := callAPI(testServer, http.MethodGet, "/api/public/dashboards", nil, t)
+ assert.Equal(t, http.StatusNotFound, response.Code)
+
+ response = callAPI(testServer, http.MethodGet, "/api/public/dashboards/asdf", nil, t)
+ assert.Equal(t, http.StatusNotFound, response.Code)
+
+ // control set. make sure routes are mounted
+ testServer = setupTestServer(t, cfg, qs, featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards), service, nil)
+ response = callAPI(testServer, http.MethodGet, "/api/public/dashboards/asdf", nil, t)
+ assert.NotEqual(t, http.StatusNotFound, response.Code)
+ })
+
+ DashboardUid := "dashboard-abcd1234"
+ token, err := uuid.NewRandom()
+ require.NoError(t, err)
+ accessToken := fmt.Sprintf("%x", token)
+
+ testCases := []struct {
+ Name string
+ AccessToken string
+ ExpectedHttpResponse int
+ PublicDashboardResult *models.Dashboard
+ PublicDashboardErr error
+ }{
+ {
+ Name: "It gets a public dashboard",
+ AccessToken: accessToken,
+ ExpectedHttpResponse: http.StatusOK,
+ PublicDashboardResult: &models.Dashboard{
+ Data: simplejson.NewFromAny(map[string]interface{}{
+ "Uid": DashboardUid,
+ }),
+ },
+ PublicDashboardErr: nil,
+ },
+ {
+ Name: "It should return 404 if no public dashboard",
+ AccessToken: accessToken,
+ ExpectedHttpResponse: http.StatusNotFound,
+ PublicDashboardResult: nil,
+ PublicDashboardErr: ErrPublicDashboardNotFound,
+ },
+ }
+
+ for _, test := range testCases {
+ t.Run(test.Name, func(t *testing.T) {
+ service := publicdashboards.NewFakePublicDashboardService(t)
+ service.On("GetPublicDashboard", mock.Anything, mock.AnythingOfType("string")).
+ Return(test.PublicDashboardResult, test.PublicDashboardErr).Maybe()
+
+ testServer := setupTestServer(
+ t,
+ setting.NewCfg(),
+ buildQueryDataService(t, nil, nil, nil),
+ featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards),
+ service,
+ nil,
+ )
+
+ response := callAPI(testServer, http.MethodGet,
+ fmt.Sprintf("/api/public/dashboards/%s", test.AccessToken),
+ nil,
+ t,
+ )
+
+ assert.Equal(t, test.ExpectedHttpResponse, response.Code)
+
+ if test.PublicDashboardErr == nil {
+ var dashResp dtos.DashboardFullWithMeta
+ err := json.Unmarshal(response.Body.Bytes(), &dashResp)
+ require.NoError(t, err)
+
+ assert.Equal(t, DashboardUid, dashResp.Dashboard.Get("Uid").MustString())
+ assert.Equal(t, false, dashResp.Meta.CanEdit)
+ assert.Equal(t, false, dashResp.Meta.CanDelete)
+ assert.Equal(t, false, dashResp.Meta.CanSave)
+ } else {
+ var errResp struct {
+ Error string `json:"error"`
+ }
+ err := json.Unmarshal(response.Body.Bytes(), &errResp)
+ require.NoError(t, err)
+ assert.Equal(t, test.PublicDashboardErr.Error(), errResp.Error)
+ }
+ })
+ }
+}
+
+func TestAPIGetPublicDashboardConfig(t *testing.T) {
+ pubdash := &PublicDashboard{IsEnabled: true}
+
+ testCases := []struct {
+ Name string
+ DashboardUid string
+ ExpectedHttpResponse int
+ PublicDashboardResult *PublicDashboard
+ PublicDashboardErr error
+ }{
+ {
+ Name: "retrieves public dashboard config when dashboard is found",
+ DashboardUid: "1",
+ ExpectedHttpResponse: http.StatusOK,
+ PublicDashboardResult: pubdash,
+ PublicDashboardErr: nil,
+ },
+ {
+ Name: "returns 404 when dashboard not found",
+ DashboardUid: "77777",
+ ExpectedHttpResponse: http.StatusNotFound,
+ PublicDashboardResult: nil,
+ PublicDashboardErr: dashboards.ErrDashboardNotFound,
+ },
+ {
+ Name: "returns 500 when internal server error",
+ DashboardUid: "1",
+ ExpectedHttpResponse: http.StatusInternalServerError,
+ PublicDashboardResult: nil,
+ PublicDashboardErr: errors.New("database broken"),
+ },
+ }
+
+ for _, test := range testCases {
+ t.Run(test.Name, func(t *testing.T) {
+ service := publicdashboards.NewFakePublicDashboardService(t)
+ service.On("GetPublicDashboardConfig", mock.Anything, mock.AnythingOfType("int64"), mock.AnythingOfType("string")).
+ Return(test.PublicDashboardResult, test.PublicDashboardErr)
+
+ testServer := setupTestServer(
+ t,
+ setting.NewCfg(),
+ buildQueryDataService(t, nil, nil, nil),
+ featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards),
+ service,
+ nil,
+ )
+
+ response := callAPI(
+ testServer,
+ http.MethodGet,
+ "/api/dashboards/uid/1/public-config",
+ nil,
+ t,
+ )
+
+ assert.Equal(t, test.ExpectedHttpResponse, response.Code)
+
+ if response.Code == http.StatusOK {
+ var pdcResp PublicDashboard
+ err := json.Unmarshal(response.Body.Bytes(), &pdcResp)
+ require.NoError(t, err)
+ assert.Equal(t, test.PublicDashboardResult, &pdcResp)
+ }
+ })
+ }
+}
+
+func TestApiSavePublicDashboardConfig(t *testing.T) {
+ testCases := []struct {
+ Name string
+ DashboardUid string
+ publicDashboardConfig *PublicDashboard
+ ExpectedHttpResponse int
+ SaveDashboardErr error
+ }{
+ {
+ Name: "returns 200 when update persists",
+ DashboardUid: "1",
+ publicDashboardConfig: &PublicDashboard{IsEnabled: true},
+ ExpectedHttpResponse: http.StatusOK,
+ SaveDashboardErr: nil,
+ },
+ {
+ Name: "returns 500 when not persisted",
+ ExpectedHttpResponse: http.StatusInternalServerError,
+ publicDashboardConfig: &PublicDashboard{},
+ SaveDashboardErr: errors.New("backend failed to save"),
+ },
+ {
+ Name: "returns 404 when dashboard not found",
+ ExpectedHttpResponse: http.StatusNotFound,
+ publicDashboardConfig: &PublicDashboard{},
+ SaveDashboardErr: dashboards.ErrDashboardNotFound,
+ },
+ }
+
+ for _, test := range testCases {
+ t.Run(test.Name, func(t *testing.T) {
+ service := publicdashboards.NewFakePublicDashboardService(t)
+ service.On("SavePublicDashboardConfig", mock.Anything, mock.AnythingOfType("*models.SavePublicDashboardConfigDTO")).
+ Return(&PublicDashboard{IsEnabled: true}, test.SaveDashboardErr)
+
+ testServer := setupTestServer(
+ t,
+ setting.NewCfg(),
+ buildQueryDataService(t, nil, nil, nil),
+ featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards),
+ service,
+ nil,
+ )
+
+ response := callAPI(
+ testServer,
+ http.MethodPost,
+ "/api/dashboards/uid/1/public-config",
+ strings.NewReader(`{ "isPublic": true }`),
+ t,
+ )
+
+ assert.Equal(t, test.ExpectedHttpResponse, response.Code)
+
+ //check the result if it's a 200
+ if response.Code == http.StatusOK {
+ val, err := json.Marshal(test.publicDashboardConfig)
+ require.NoError(t, err)
+ assert.Equal(t, string(val), response.Body.String())
+ }
+ })
+ }
+}
+
+// `/public/dashboards/:uid/query`` endpoint test
+func TestAPIQueryPublicDashboard(t *testing.T) {
+ cacheService := &fakeDatasources.FakeCacheService{
+ DataSources: []*datasources.DataSource{
+ {Uid: "mysqlds"},
+ {Uid: "promds"},
+ {Uid: "promds2"},
+ },
+ }
+
+ // used to determine whether fakePluginClient returns an error
+ queryReturnsError := false
+
+ fakePluginClient := &fakePluginClient{
+ QueryDataHandlerFunc: func(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
+ if queryReturnsError {
+ return nil, errors.New("error")
+ }
+
+ resp := backend.Responses{}
+
+ for _, query := range req.Queries {
+ resp[query.RefID] = backend.DataResponse{
+ Frames: []*data.Frame{
+ {
+ RefID: query.RefID,
+ Name: "query-" + query.RefID,
+ },
+ },
+ }
+ }
+ return &backend.QueryDataResponse{Responses: resp}, nil
+ },
+ }
+
+ qds := buildQueryDataService(t, cacheService, fakePluginClient, nil)
+
+ setup := func(enabled bool) (*web.Mux, *publicdashboards.FakePublicDashboardService) {
+ service := publicdashboards.NewFakePublicDashboardService(t)
+
+ testServer := setupTestServer(
+ t,
+ setting.NewCfg(),
+ qds,
+ featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards, enabled),
+ service,
+ nil,
+ )
+
+ return testServer, service
+ }
+
+ t.Run("Status code is 404 when feature toggle is disabled", func(t *testing.T) {
+ server, _ := setup(false)
+ resp := callAPI(server, http.MethodPost, "/api/public/dashboards/abc123/panels/2/query", strings.NewReader("{}"), t)
+ require.Equal(t, http.StatusNotFound, resp.Code)
+ })
+
+ t.Run("Status code is 400 when the panel ID is invalid", func(t *testing.T) {
+ server, _ := setup(true)
+ resp := callAPI(server, http.MethodPost, "/api/public/dashboards/abc123/panels/notanumber/query", strings.NewReader("{}"), t)
+ require.Equal(t, http.StatusBadRequest, resp.Code)
+ })
+
+ t.Run("Returns query data when feature toggle is enabled", func(t *testing.T) {
+ server, fakeDashboardService := setup(true)
+
+ fakeDashboardService.On("GetPublicDashboard", mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil)
+ fakeDashboardService.On("GetPublicDashboardConfig", mock.Anything, mock.Anything, mock.Anything).Return(&PublicDashboard{}, nil)
+ fakeDashboardService.On("BuildAnonymousUser", mock.Anything, mock.Anything, mock.Anything).Return(&models.SignedInUser{}, nil)
+ fakeDashboardService.On("BuildPublicDashboardMetricRequest", mock.Anything, mock.Anything, mock.Anything, int64(2)).Return(dtos.MetricRequest{
+ Queries: []*simplejson.Json{
+ simplejson.MustJson([]byte(`
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "promds"
+ },
+ "exemplar": true,
+ "expr": "query_2_A",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ `)),
+ },
+ }, nil)
+
+ resp := callAPI(server, http.MethodPost, "/api/public/dashboards/abc123/panels/2/query", strings.NewReader("{}"), t)
+
+ require.JSONEq(
+ t,
+ `{
+ "results": {
+ "A": {
+ "frames": [
+ {
+ "data": {
+ "values": []
+ },
+ "schema": {
+ "fields": [],
+ "refId": "A",
+ "name": "query-A"
+ }
+ }
+ ]
+ }
+ }
+ }`,
+ resp.Body.String(),
+ )
+ require.Equal(t, http.StatusOK, resp.Code)
+ })
+
+ t.Run("Status code is 500 when the query fails", func(t *testing.T) {
+ server, fakeDashboardService := setup(true)
+
+ fakeDashboardService.On("GetPublicDashboard", mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil)
+ fakeDashboardService.On("GetPublicDashboardConfig", mock.Anything, mock.Anything, mock.Anything).Return(&PublicDashboard{}, nil)
+ fakeDashboardService.On("BuildAnonymousUser", mock.Anything, mock.Anything, mock.Anything).Return(&models.SignedInUser{}, nil)
+ fakeDashboardService.On("BuildPublicDashboardMetricRequest", mock.Anything, mock.Anything, mock.Anything, int64(2)).Return(dtos.MetricRequest{
+ Queries: []*simplejson.Json{
+ simplejson.MustJson([]byte(`
+ {
+ "datasource": {
+ "type": "prometheus",
+ "uid": "promds"
+ },
+ "exemplar": true,
+ "expr": "query_2_A",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ `)),
+ },
+ }, nil)
+
+ queryReturnsError = true
+ resp := callAPI(server, http.MethodPost, "/api/public/dashboards/abc123/panels/2/query", strings.NewReader("{}"), t)
+ require.Equal(t, http.StatusInternalServerError, resp.Code)
+ queryReturnsError = false
+ })
+
+ t.Run("Status code is 200 when a panel has queries from multiple datasources", func(t *testing.T) {
+ server, fakeDashboardService := setup(true)
+
+ fakeDashboardService.On("GetPublicDashboard", mock.Anything, mock.Anything).Return(&models.Dashboard{}, nil)
+ fakeDashboardService.On("GetPublicDashboardConfig", mock.Anything, mock.Anything, mock.Anything).Return(&PublicDashboard{}, nil)
+ fakeDashboardService.On("BuildAnonymousUser", mock.Anything, mock.Anything, mock.Anything).Return(&models.SignedInUser{}, nil)
+ fakeDashboardService.On("BuildPublicDashboardMetricRequest", mock.Anything, mock.Anything, mock.Anything, int64(2)).Return(dtos.MetricRequest{
+ Queries: []*simplejson.Json{
+ simplejson.MustJson([]byte(`
+{
+ "datasource": {
+ "type": "prometheus",
+ "uid": "promds"
+ },
+ "exemplar": true,
+ "expr": "query_2_A",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "A"
+ }
+ `)),
+ simplejson.MustJson([]byte(`
+{
+ "datasource": {
+ "type": "prometheus",
+ "uid": "promds2"
+ },
+ "exemplar": true,
+ "expr": "query_2_B",
+ "interval": "",
+ "legendFormat": "",
+ "refId": "B"
+ }
+ `)),
+ },
+ }, nil)
+
+ resp := callAPI(server, http.MethodPost, "/api/public/dashboards/abc123/panels/2/query", strings.NewReader("{}"), t)
+ require.JSONEq(
+ t,
+ `{
+ "results": {
+ "A": {
+ "frames": [
+ {
+ "data": {
+ "values": []
+ },
+ "schema": {
+ "fields": [],
+ "refId": "A",
+ "name": "query-A"
+ }
+ }
+ ]
+ },
+ "B": {
+ "frames": [
+ {
+ "data": {
+ "values": []
+ },
+ "schema": {
+ "fields": [],
+ "refId": "B",
+ "name": "query-B"
+ }
+ }
+ ]
+ }
+ }
+ }`,
+ resp.Body.String(),
+ )
+ require.Equal(t, http.StatusOK, resp.Code)
+ })
+}
+
+func TestIntegrationUnauthenticatedUserCanGetPubdashPanelQueryData(t *testing.T) {
+ db := sqlstore.InitTestDB(t)
+
+ cacheService := service.ProvideCacheService(localcache.ProvideService(), db)
+ qds := buildQueryDataService(t, cacheService, nil, db)
+
+ _ = db.AddDataSource(context.Background(), &datasources.AddDataSourceCommand{
+ Uid: "ds1",
+ OrgId: 1,
+ Name: "laban",
+ Type: datasources.DS_MYSQL,
+ Access: datasources.DS_ACCESS_DIRECT,
+ Url: "http://test",
+ Database: "site",
+ ReadOnly: true,
+ })
+
+ // Create Dashboard
+ saveDashboardCmd := models.SaveDashboardCommand{
+ OrgId: 1,
+ FolderId: 1,
+ IsFolder: false,
+ Dashboard: simplejson.NewFromAny(map[string]interface{}{
+ "id": nil,
+ "title": "test",
+ "panels": []map[string]interface{}{
+ {
+ "id": 1,
+ "targets": []map[string]interface{}{
+ {
+ "datasource": map[string]string{
+ "type": "mysql",
+ "uid": "ds1",
+ },
+ "refId": "A",
+ },
+ },
+ },
+ },
+ }),
+ }
+
+ // create dashboard
+ dashboardStore := dashboardStore.ProvideDashboardStore(db)
+ dashboard, err := dashboardStore.SaveDashboard(saveDashboardCmd)
+ require.NoError(t, err)
+
+ // Create public dashboard
+ savePubDashboardCmd := &SavePublicDashboardConfigDTO{
+ DashboardUid: dashboard.Uid,
+ OrgId: dashboard.OrgId,
+ PublicDashboard: &PublicDashboard{
+ IsEnabled: true,
+ },
+ }
+
+ // create public dashboard
+ store := publicdashboardsStore.ProvideStore(db)
+ service := publicdashboardsService.ProvideService(setting.NewCfg(), store)
+ pubdash, err := service.SavePublicDashboardConfig(context.Background(), savePubDashboardCmd)
+ require.NoError(t, err)
+
+ // setup test server
+ server := setupTestServer(t,
+ setting.NewCfg(),
+ qds,
+ featuremgmt.WithFeatures(featuremgmt.FlagPublicDashboards),
+ service,
+ db,
+ )
+
+ resp := callAPI(server, http.MethodPost,
+ fmt.Sprintf("/api/public/dashboards/%s/panels/1/query", pubdash.AccessToken),
+ strings.NewReader(`{}`),
+ t,
+ )
+ require.Equal(t, http.StatusOK, resp.Code)
+ require.NoError(t, err)
+ require.JSONEq(
+ t,
+ `{
+ "results": {
+ "A": {
+ "frames": [
+ {
+ "data": {
+ "values": []
+ },
+ "schema": {
+ "fields": []
+ }
+ }
+ ]
+ }
+ }
+ }`,
+ resp.Body.String(),
+ )
+}
diff --git a/pkg/services/publicdashboards/api/common_test.go b/pkg/services/publicdashboards/api/common_test.go
new file mode 100644
index 00000000000..d500c8d6e90
--- /dev/null
+++ b/pkg/services/publicdashboards/api/common_test.go
@@ -0,0 +1,174 @@
+package api
+
+import (
+ "context"
+ "io"
+ "net/http"
+ "net/http/httptest"
+ "testing"
+
+ "golang.org/x/oauth2"
+
+ "github.com/grafana/grafana-plugin-sdk-go/backend"
+ "github.com/grafana/grafana-plugin-sdk-go/data"
+ "github.com/grafana/grafana/pkg/api/routing"
+ "github.com/grafana/grafana/pkg/infra/localcache"
+ "github.com/grafana/grafana/pkg/infra/log"
+ "github.com/grafana/grafana/pkg/models"
+ "github.com/grafana/grafana/pkg/plugins"
+ "github.com/grafana/grafana/pkg/services/accesscontrol/database"
+ "github.com/grafana/grafana/pkg/services/accesscontrol/ossaccesscontrol"
+ "github.com/grafana/grafana/pkg/services/contexthandler/ctxkey"
+ "github.com/grafana/grafana/pkg/services/datasources"
+ "github.com/grafana/grafana/pkg/services/featuremgmt"
+ "github.com/grafana/grafana/pkg/services/publicdashboards"
+ "github.com/grafana/grafana/pkg/services/sqlstore"
+
+ fakeDatasources "github.com/grafana/grafana/pkg/services/datasources/fakes"
+ datasourceService "github.com/grafana/grafana/pkg/services/datasources/service"
+ "github.com/grafana/grafana/pkg/services/query"
+ "github.com/grafana/grafana/pkg/setting"
+ "github.com/grafana/grafana/pkg/web"
+ "github.com/stretchr/testify/require"
+)
+
+type Server struct {
+ Mux *web.Mux
+ RouteRegister routing.RouteRegister
+ TestServer *httptest.Server
+}
+
+func setupTestServer(
+ t *testing.T,
+ cfg *setting.Cfg,
+ qs *query.Service,
+ features *featuremgmt.FeatureManager,
+ service publicdashboards.Service,
+ db *sqlstore.SQLStore,
+) *web.Mux {
+ // build router to register routes
+ rr := routing.NewRouteRegister()
+
+ // build access control - FIXME we should be able to mock this, but to get
+ // tests going, we're going to instantiate full accesscontrol
+ //ac := accesscontrolmock.New()
+ //ac.WithDisabled()
+
+ // create a sqlstore for access control.
+ if db == nil {
+ db = sqlstore.InitTestDB(t)
+ }
+
+ var err error
+ ac, err := ossaccesscontrol.ProvideService(features, cfg, database.ProvideService(db), rr)
+ require.NoError(t, err)
+
+ // build mux
+ m := web.New()
+
+ // set initial context
+ m.Use(func(c *web.Context) {
+ ctx := &models.ReqContext{
+ Context: c,
+ IsSignedIn: true, // FIXME need to be able to change this for tests
+ SkipCache: true, // hardcoded to make sure query service doesnt hit the cache
+ Logger: log.New("publicdashboards-test"),
+
+ // Set signed in user. We might not actually need to do this.
+ SignedInUser: &models.SignedInUser{UserId: 1, OrgId: 1, OrgRole: models.ROLE_ADMIN, Login: "testUser"},
+ }
+ c.Req = c.Req.WithContext(ctxkey.Set(c.Req.Context(), ctx))
+ })
+
+ // build api, this will mount the routes at the same time if
+ // featuremgmt.FlagPublicDashboard is enabled
+ ProvideApi(service, rr, ac, qs, features)
+
+ // connect routes to mux
+ rr.Register(m.Router)
+
+ return m
+}
+
+func callAPI(server *web.Mux, method, path string, body io.Reader, t *testing.T) *httptest.ResponseRecorder {
+ req, err := http.NewRequest(method, path, body)
+ require.NoError(t, err)
+ req.Header.Set("Content-Type", "application/json")
+ recorder := httptest.NewRecorder()
+ server.ServeHTTP(recorder, req)
+ return recorder
+}
+
+// helper to query.Service
+// allows us to stub the cache and plugin clients
+func buildQueryDataService(t *testing.T, cs datasources.CacheService, fpc *fakePluginClient, store *sqlstore.SQLStore) *query.Service {
+ // build database if we need one
+ if store == nil {
+ store = sqlstore.InitTestDB(t)
+ }
+
+ // default cache service
+ if cs == nil {
+ cs = datasourceService.ProvideCacheService(localcache.ProvideService(), store)
+ }
+
+ // default fakePluginClient
+ if fpc == nil {
+ fpc = &fakePluginClient{
+ QueryDataHandlerFunc: func(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
+ resp := backend.Responses{
+ "A": backend.DataResponse{
+ Frames: []*data.Frame{{}},
+ },
+ }
+ return &backend.QueryDataResponse{Responses: resp}, nil
+ },
+ }
+ }
+
+ return query.ProvideService(
+ nil,
+ cs,
+ nil,
+ &fakePluginRequestValidator{},
+ &fakeDatasources.FakeDataSourceService{},
+ fpc,
+ &fakeOAuthTokenService{},
+ )
+}
+
+//copied from pkg/api/metrics_test.go
+type fakePluginRequestValidator struct {
+ err error
+}
+
+func (rv *fakePluginRequestValidator) Validate(dsURL string, req *http.Request) error {
+ return rv.err
+}
+
+type fakeOAuthTokenService struct {
+ passThruEnabled bool
+ token *oauth2.Token
+}
+
+func (ts *fakeOAuthTokenService) GetCurrentOAuthToken(context.Context, *models.SignedInUser) *oauth2.Token {
+ return ts.token
+}
+
+func (ts *fakeOAuthTokenService) IsOAuthPassThruEnabled(*datasources.DataSource) bool {
+ return ts.passThruEnabled
+}
+
+// copied from pkg/api/plugins_test.go
+type fakePluginClient struct {
+ plugins.Client
+ backend.QueryDataHandlerFunc
+}
+
+func (c *fakePluginClient) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
+ if c.QueryDataHandlerFunc != nil {
+ return c.QueryDataHandlerFunc.QueryData(ctx, req)
+ }
+
+ return backend.NewQueryDataResponse(), nil
+}
diff --git a/pkg/middleware/dashboard_public.go b/pkg/services/publicdashboards/api/middleware.go
similarity index 65%
rename from pkg/middleware/dashboard_public.go
rename to pkg/services/publicdashboards/api/middleware.go
index 3c89e8ac566..f7ba59d587a 100644
--- a/pkg/middleware/dashboard_public.go
+++ b/pkg/services/publicdashboards/api/middleware.go
@@ -1,8 +1,6 @@
-package middleware
+package api
-import (
- "github.com/grafana/grafana/pkg/models"
-)
+import "github.com/grafana/grafana/pkg/models"
func SetPublicDashboardFlag() func(c *models.ReqContext) {
return func(c *models.ReqContext) {
diff --git a/pkg/services/dashboards/database/database_dashboard_public.go b/pkg/services/publicdashboards/database/database.go
similarity index 53%
rename from pkg/services/dashboards/database/database_dashboard_public.go
rename to pkg/services/publicdashboards/database/database.go
index e1ae039b1ab..d89687c1526 100644
--- a/pkg/services/dashboards/database/database_dashboard_public.go
+++ b/pkg/services/publicdashboards/database/database.go
@@ -3,27 +3,52 @@ package database
import (
"context"
+ "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/services/publicdashboards"
+ . "github.com/grafana/grafana/pkg/services/publicdashboards/models"
"github.com/grafana/grafana/pkg/services/sqlstore"
+ "github.com/grafana/grafana/pkg/services/sqlstore/migrator"
"github.com/grafana/grafana/pkg/util"
)
-// retrieves public dashboard configuration
-func (d *DashboardStore) GetPublicDashboard(ctx context.Context, accessToken string) (*models.PublicDashboard, *models.Dashboard, error) {
+// Define the storage implementation. We're generating the mock implementation
+// automatically
+type PublicDashboardStoreImpl struct {
+ sqlStore *sqlstore.SQLStore
+ log log.Logger
+ dialect migrator.Dialect
+}
+
+// Gives us a compile time error if our database does not adhere to contract of
+// the interface
+var _ publicdashboards.Store = (*PublicDashboardStoreImpl)(nil)
+
+// Factory used by wire to dependency injection
+func ProvideStore(sqlStore *sqlstore.SQLStore) *PublicDashboardStoreImpl {
+ return &PublicDashboardStoreImpl{
+ sqlStore: sqlStore,
+ log: log.New("publicdashboards.store"),
+ dialect: sqlStore.Dialect,
+ }
+}
+
+// Retrieves public dashboard configuration
+func (d *PublicDashboardStoreImpl) GetPublicDashboard(ctx context.Context, accessToken string) (*PublicDashboard, *models.Dashboard, error) {
if accessToken == "" {
- return nil, nil, dashboards.ErrPublicDashboardIdentifierNotSet
+ return nil, nil, ErrPublicDashboardIdentifierNotSet
}
// get public dashboard
- pdRes := &models.PublicDashboard{AccessToken: accessToken}
+ pdRes := &PublicDashboard{AccessToken: accessToken}
err := d.sqlStore.WithTransactionalDbSession(ctx, func(sess *sqlstore.DBSession) error {
has, err := sess.Get(pdRes)
if err != nil {
return err
}
if !has {
- return dashboards.ErrPublicDashboardNotFound
+ return ErrPublicDashboardNotFound
}
return nil
})
@@ -40,7 +65,7 @@ func (d *DashboardStore) GetPublicDashboard(ctx context.Context, accessToken str
return err
}
if !has {
- return dashboards.ErrPublicDashboardNotFound
+ return ErrPublicDashboardNotFound
}
return nil
})
@@ -52,15 +77,15 @@ func (d *DashboardStore) GetPublicDashboard(ctx context.Context, accessToken str
return pdRes, dashRes, err
}
-// generates a new unique uid to retrieve a public dashboard
-func (d *DashboardStore) GenerateNewPublicDashboardUid(ctx context.Context) (string, error) {
+// Generates a new unique uid to retrieve a public dashboard
+func (d *PublicDashboardStoreImpl) GenerateNewPublicDashboardUid(ctx context.Context) (string, error) {
var uid string
err := d.sqlStore.WithDbSession(ctx, func(sess *sqlstore.DBSession) error {
for i := 0; i < 3; i++ {
uid = util.GenerateShortUID()
- exists, err := sess.Get(&models.PublicDashboard{Uid: uid})
+ exists, err := sess.Get(&PublicDashboard{Uid: uid})
if err != nil {
return err
}
@@ -70,7 +95,7 @@ func (d *DashboardStore) GenerateNewPublicDashboardUid(ctx context.Context) (str
}
}
- return dashboards.ErrPublicDashboardFailedGenerateUniqueUid
+ return ErrPublicDashboardFailedGenerateUniqueUid
})
if err != nil {
@@ -80,13 +105,13 @@ func (d *DashboardStore) GenerateNewPublicDashboardUid(ctx context.Context) (str
return uid, nil
}
-// retrieves public dashboard configuration
-func (d *DashboardStore) GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*models.PublicDashboard, error) {
+// Retrieves public dashboard configuration
+func (d *PublicDashboardStoreImpl) GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*PublicDashboard, error) {
if dashboardUid == "" {
return nil, dashboards.ErrDashboardIdentifierNotSet
}
- pdRes := &models.PublicDashboard{OrgId: orgId, DashboardUid: dashboardUid}
+ pdRes := &PublicDashboard{OrgId: orgId, DashboardUid: dashboardUid}
err := d.sqlStore.WithTransactionalDbSession(ctx, func(sess *sqlstore.DBSession) error {
// publicDashboard
_, err := sess.Get(pdRes)
@@ -104,8 +129,8 @@ func (d *DashboardStore) GetPublicDashboardConfig(ctx context.Context, orgId int
return pdRes, err
}
-// persists public dashboard configuration
-func (d *DashboardStore) SavePublicDashboardConfig(ctx context.Context, cmd models.SavePublicDashboardConfigCommand) (*models.PublicDashboard, error) {
+// Persists public dashboard configuration
+func (d *PublicDashboardStoreImpl) SavePublicDashboardConfig(ctx context.Context, cmd SavePublicDashboardConfigCommand) (*PublicDashboard, error) {
err := d.sqlStore.WithTransactionalDbSession(ctx, func(sess *sqlstore.DBSession) error {
_, err := sess.UseBool("is_enabled").Insert(&cmd.PublicDashboard)
if err != nil {
@@ -123,7 +148,7 @@ func (d *DashboardStore) SavePublicDashboardConfig(ctx context.Context, cmd mode
}
// updates existing public dashboard configuration
-func (d *DashboardStore) UpdatePublicDashboardConfig(ctx context.Context, cmd models.SavePublicDashboardConfigCommand) error {
+func (d *PublicDashboardStoreImpl) UpdatePublicDashboardConfig(ctx context.Context, cmd SavePublicDashboardConfigCommand) error {
err := d.sqlStore.WithTransactionalDbSession(ctx, func(sess *sqlstore.DBSession) error {
timeSettingsJSON, err := cmd.PublicDashboard.TimeSettings.MarshalJSON()
if err != nil {
diff --git a/pkg/services/dashboards/database/database_dashboard_public_test.go b/pkg/services/publicdashboards/database/database_test.go
similarity index 62%
rename from pkg/services/dashboards/database/database_dashboard_public_test.go
rename to pkg/services/publicdashboards/database/database_test.go
index 6462b9bf50a..ec335f13714 100644
--- a/pkg/services/dashboards/database/database_dashboard_public_test.go
+++ b/pkg/services/publicdashboards/database/database_test.go
@@ -10,8 +10,10 @@ import (
"github.com/grafana/grafana/pkg/components/simplejson"
"github.com/grafana/grafana/pkg/models"
- "github.com/grafana/grafana/pkg/services/dashboards"
+ dashboards "github.com/grafana/grafana/pkg/services/dashboards"
+ dashboardsDB "github.com/grafana/grafana/pkg/services/dashboards/database"
"github.com/grafana/grafana/pkg/services/featuremgmt"
+ . "github.com/grafana/grafana/pkg/services/publicdashboards/models"
"github.com/grafana/grafana/pkg/services/sqlstore"
"github.com/grafana/grafana/pkg/util"
)
@@ -25,19 +27,21 @@ var DefaultTime = time.Now().UTC().Round(time.Second)
// GetPublicDashboard
func TestIntegrationGetPublicDashboard(t *testing.T) {
var sqlStore *sqlstore.SQLStore
- var dashboardStore *DashboardStore
+ var dashboardStore *dashboardsDB.DashboardStore
+ var publicdashboardStore *PublicDashboardStoreImpl
var savedDashboard *models.Dashboard
setup := func() {
sqlStore = sqlstore.InitTestDB(t)
- dashboardStore = ProvideDashboardStore(sqlStore)
+ dashboardStore = dashboardsDB.ProvideDashboardStore(sqlStore)
+ publicdashboardStore = ProvideStore(sqlStore)
savedDashboard = insertTestDashboard(t, dashboardStore, "testDashie", 1, 0, true)
}
t.Run("returns PublicDashboard and Dashboard", func(t *testing.T) {
setup()
- pubdash, err := dashboardStore.SavePublicDashboardConfig(context.Background(), models.SavePublicDashboardConfigCommand{
- PublicDashboard: models.PublicDashboard{
+ pubdash, err := publicdashboardStore.SavePublicDashboardConfig(context.Background(), SavePublicDashboardConfigCommand{
+ PublicDashboard: PublicDashboard{
IsEnabled: true,
Uid: "abc1234",
DashboardUid: savedDashboard.Uid,
@@ -50,7 +54,7 @@ func TestIntegrationGetPublicDashboard(t *testing.T) {
})
require.NoError(t, err)
- pd, d, err := dashboardStore.GetPublicDashboard(context.Background(), "NOTAREALUUID")
+ pd, d, err := publicdashboardStore.GetPublicDashboard(context.Background(), "NOTAREALUUID")
require.NoError(t, err)
assert.Equal(t, pd, pubdash)
@@ -59,22 +63,22 @@ func TestIntegrationGetPublicDashboard(t *testing.T) {
t.Run("returns ErrPublicDashboardNotFound with empty uid", func(t *testing.T) {
setup()
- _, _, err := dashboardStore.GetPublicDashboard(context.Background(), "")
- require.Error(t, dashboards.ErrPublicDashboardIdentifierNotSet, err)
+ _, _, err := publicdashboardStore.GetPublicDashboard(context.Background(), "")
+ require.Error(t, ErrPublicDashboardIdentifierNotSet, err)
})
t.Run("returns ErrPublicDashboardNotFound when PublicDashboard not found", func(t *testing.T) {
setup()
- _, _, err := dashboardStore.GetPublicDashboard(context.Background(), "zzzzzz")
- require.Error(t, dashboards.ErrPublicDashboardNotFound, err)
+ _, _, err := publicdashboardStore.GetPublicDashboard(context.Background(), "zzzzzz")
+ require.Error(t, ErrPublicDashboardNotFound, err)
})
t.Run("returns ErrDashboardNotFound when Dashboard not found", func(t *testing.T) {
setup()
- _, err := dashboardStore.SavePublicDashboardConfig(context.Background(), models.SavePublicDashboardConfigCommand{
+ _, err := publicdashboardStore.SavePublicDashboardConfig(context.Background(), SavePublicDashboardConfigCommand{
DashboardUid: savedDashboard.Uid,
OrgId: savedDashboard.OrgId,
- PublicDashboard: models.PublicDashboard{
+ PublicDashboard: PublicDashboard{
IsEnabled: true,
Uid: "abc1234",
DashboardUid: "nevergonnafindme",
@@ -84,7 +88,7 @@ func TestIntegrationGetPublicDashboard(t *testing.T) {
},
})
require.NoError(t, err)
- _, _, err = dashboardStore.GetPublicDashboard(context.Background(), "abc1234")
+ _, _, err = publicdashboardStore.GetPublicDashboard(context.Background(), "abc1234")
require.Error(t, dashboards.ErrDashboardNotFound, err)
})
}
@@ -92,35 +96,37 @@ func TestIntegrationGetPublicDashboard(t *testing.T) {
// GetPublicDashboardConfig
func TestIntegrationGetPublicDashboardConfig(t *testing.T) {
var sqlStore *sqlstore.SQLStore
- var dashboardStore *DashboardStore
+ var dashboardStore *dashboardsDB.DashboardStore
+ var publicdashboardStore *PublicDashboardStoreImpl
var savedDashboard *models.Dashboard
setup := func() {
sqlStore = sqlstore.InitTestDB(t)
- dashboardStore = ProvideDashboardStore(sqlStore)
+ dashboardStore = dashboardsDB.ProvideDashboardStore(sqlStore)
+ publicdashboardStore = ProvideStore(sqlStore)
savedDashboard = insertTestDashboard(t, dashboardStore, "testDashie", 1, 0, true)
}
t.Run("returns isPublic and set dashboardUid and orgId", func(t *testing.T) {
setup()
- pubdash, err := dashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard.OrgId, savedDashboard.Uid)
+ pubdash, err := publicdashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard.OrgId, savedDashboard.Uid)
require.NoError(t, err)
- assert.Equal(t, &models.PublicDashboard{IsEnabled: false, DashboardUid: savedDashboard.Uid, OrgId: savedDashboard.OrgId}, pubdash)
+ assert.Equal(t, &PublicDashboard{IsEnabled: false, DashboardUid: savedDashboard.Uid, OrgId: savedDashboard.OrgId}, pubdash)
})
t.Run("returns dashboard errDashboardIdentifierNotSet", func(t *testing.T) {
setup()
- _, err := dashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard.OrgId, "")
+ _, err := publicdashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard.OrgId, "")
require.Error(t, dashboards.ErrDashboardIdentifierNotSet, err)
})
t.Run("returns isPublic along with public dashboard when exists", func(t *testing.T) {
setup()
// insert test public dashboard
- resp, err := dashboardStore.SavePublicDashboardConfig(context.Background(), models.SavePublicDashboardConfigCommand{
+ resp, err := publicdashboardStore.SavePublicDashboardConfig(context.Background(), SavePublicDashboardConfigCommand{
DashboardUid: savedDashboard.Uid,
OrgId: savedDashboard.OrgId,
- PublicDashboard: models.PublicDashboard{
+ PublicDashboard: PublicDashboard{
IsEnabled: true,
Uid: "pubdash-uid",
DashboardUid: savedDashboard.Uid,
@@ -132,7 +138,7 @@ func TestIntegrationGetPublicDashboardConfig(t *testing.T) {
})
require.NoError(t, err)
- pubdash, err := dashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard.OrgId, savedDashboard.Uid)
+ pubdash, err := publicdashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard.OrgId, savedDashboard.Uid)
require.NoError(t, err)
assert.True(t, assert.ObjectsAreEqualValues(resp, pubdash))
@@ -143,23 +149,25 @@ func TestIntegrationGetPublicDashboardConfig(t *testing.T) {
// SavePublicDashboardConfig
func TestIntegrationSavePublicDashboardConfig(t *testing.T) {
var sqlStore *sqlstore.SQLStore
- var dashboardStore *DashboardStore
+ var dashboardStore *dashboardsDB.DashboardStore
+ var publicdashboardStore *PublicDashboardStoreImpl
var savedDashboard *models.Dashboard
var savedDashboard2 *models.Dashboard
setup := func() {
sqlStore = sqlstore.InitTestDB(t, sqlstore.InitTestDBOpt{FeatureFlags: []string{featuremgmt.FlagPublicDashboards}})
- dashboardStore = ProvideDashboardStore(sqlStore)
+ dashboardStore = dashboardsDB.ProvideDashboardStore(sqlStore)
+ publicdashboardStore = ProvideStore(sqlStore)
savedDashboard = insertTestDashboard(t, dashboardStore, "testDashie", 1, 0, true)
savedDashboard2 = insertTestDashboard(t, dashboardStore, "testDashie2", 1, 0, true)
}
t.Run("saves new public dashboard", func(t *testing.T) {
setup()
- resp, err := dashboardStore.SavePublicDashboardConfig(context.Background(), models.SavePublicDashboardConfigCommand{
+ resp, err := publicdashboardStore.SavePublicDashboardConfig(context.Background(), SavePublicDashboardConfigCommand{
DashboardUid: savedDashboard.Uid,
OrgId: savedDashboard.OrgId,
- PublicDashboard: models.PublicDashboard{
+ PublicDashboard: PublicDashboard{
IsEnabled: true,
Uid: "pubdash-uid",
DashboardUid: savedDashboard.Uid,
@@ -172,7 +180,7 @@ func TestIntegrationSavePublicDashboardConfig(t *testing.T) {
})
require.NoError(t, err)
- pubdash, err := dashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard.OrgId, savedDashboard.Uid)
+ pubdash, err := publicdashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard.OrgId, savedDashboard.Uid)
require.NoError(t, err)
//verify saved response and queried response are the same
@@ -182,7 +190,7 @@ func TestIntegrationSavePublicDashboardConfig(t *testing.T) {
assert.True(t, util.IsValidShortUID(pubdash.Uid))
// verify we didn't update all dashboards
- pubdash2, err := dashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard2.OrgId, savedDashboard2.Uid)
+ pubdash2, err := publicdashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard2.OrgId, savedDashboard2.Uid)
require.NoError(t, err)
assert.False(t, pubdash2.IsEnabled)
})
@@ -190,13 +198,15 @@ func TestIntegrationSavePublicDashboardConfig(t *testing.T) {
func TestIntegrationUpdatePublicDashboard(t *testing.T) {
var sqlStore *sqlstore.SQLStore
- var dashboardStore *DashboardStore
+ var dashboardStore *dashboardsDB.DashboardStore
+ var publicdashboardStore *PublicDashboardStoreImpl
var savedDashboard *models.Dashboard
var anotherSavedDashboard *models.Dashboard
setup := func() {
sqlStore = sqlstore.InitTestDB(t, sqlstore.InitTestDBOpt{FeatureFlags: []string{featuremgmt.FlagPublicDashboards}})
- dashboardStore = ProvideDashboardStore(sqlStore)
+ dashboardStore = dashboardsDB.ProvideDashboardStore(sqlStore)
+ publicdashboardStore = ProvideStore(sqlStore)
savedDashboard = insertTestDashboard(t, dashboardStore, "testDashie", 1, 0, true)
anotherSavedDashboard = insertTestDashboard(t, dashboardStore, "test another Dashie", 1, 0, true)
}
@@ -204,28 +214,11 @@ func TestIntegrationUpdatePublicDashboard(t *testing.T) {
t.Run("updates an existing dashboard", func(t *testing.T) {
setup()
- // inserting two different public dashboards to test update works and only affect the desired pd by uid
- anotherPdUid := "anotherUid"
- _, err := dashboardStore.SavePublicDashboardConfig(context.Background(), models.SavePublicDashboardConfigCommand{
- DashboardUid: anotherSavedDashboard.Uid,
- OrgId: anotherSavedDashboard.OrgId,
- PublicDashboard: models.PublicDashboard{
- Uid: anotherPdUid,
- DashboardUid: anotherSavedDashboard.Uid,
- OrgId: anotherSavedDashboard.OrgId,
- IsEnabled: true,
- CreatedAt: DefaultTime,
- CreatedBy: 7,
- AccessToken: "fakeaccesstoken",
- },
- })
- require.NoError(t, err)
-
pdUid := "asdf1234"
- _, err = dashboardStore.SavePublicDashboardConfig(context.Background(), models.SavePublicDashboardConfigCommand{
+ _, err := publicdashboardStore.SavePublicDashboardConfig(context.Background(), SavePublicDashboardConfigCommand{
DashboardUid: savedDashboard.Uid,
OrgId: savedDashboard.OrgId,
- PublicDashboard: models.PublicDashboard{
+ PublicDashboard: PublicDashboard{
Uid: pdUid,
DashboardUid: savedDashboard.Uid,
OrgId: savedDashboard.OrgId,
@@ -237,7 +230,24 @@ func TestIntegrationUpdatePublicDashboard(t *testing.T) {
})
require.NoError(t, err)
- updatedPublicDashboard := models.PublicDashboard{
+ // inserting two different public dashboards to test update works and only affect the desired pd by uid
+ anotherPdUid := "anotherUid"
+ _, err = publicdashboardStore.SavePublicDashboardConfig(context.Background(), SavePublicDashboardConfigCommand{
+ DashboardUid: anotherSavedDashboard.Uid,
+ OrgId: anotherSavedDashboard.OrgId,
+ PublicDashboard: PublicDashboard{
+ Uid: anotherPdUid,
+ DashboardUid: anotherSavedDashboard.Uid,
+ OrgId: anotherSavedDashboard.OrgId,
+ IsEnabled: true,
+ CreatedAt: DefaultTime,
+ CreatedBy: 7,
+ AccessToken: "fakeaccesstoken",
+ },
+ })
+ require.NoError(t, err)
+
+ updatedPublicDashboard := PublicDashboard{
Uid: pdUid,
DashboardUid: savedDashboard.Uid,
OrgId: savedDashboard.OrgId,
@@ -247,7 +257,7 @@ func TestIntegrationUpdatePublicDashboard(t *testing.T) {
UpdatedBy: 8,
}
// update initial record
- err = dashboardStore.UpdatePublicDashboardConfig(context.Background(), models.SavePublicDashboardConfigCommand{
+ err = publicdashboardStore.UpdatePublicDashboardConfig(context.Background(), SavePublicDashboardConfigCommand{
DashboardUid: savedDashboard.Uid,
OrgId: savedDashboard.OrgId,
PublicDashboard: updatedPublicDashboard,
@@ -255,7 +265,7 @@ func TestIntegrationUpdatePublicDashboard(t *testing.T) {
require.NoError(t, err)
// updated dashboard should have changed
- pdRetrieved, err := dashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard.OrgId, savedDashboard.Uid)
+ pdRetrieved, err := publicdashboardStore.GetPublicDashboardConfig(context.Background(), savedDashboard.OrgId, savedDashboard.Uid)
require.NoError(t, err)
assert.Equal(t, updatedPublicDashboard.UpdatedAt, pdRetrieved.UpdatedAt)
@@ -264,10 +274,30 @@ func TestIntegrationUpdatePublicDashboard(t *testing.T) {
assert.Equal(t, updatedPublicDashboard.IsEnabled, pdRetrieved.IsEnabled)
// not updated dashboard shouldn't have changed
- pdNotUpdatedRetrieved, err := dashboardStore.GetPublicDashboardConfig(context.Background(), anotherSavedDashboard.OrgId, anotherSavedDashboard.Uid)
+ pdNotUpdatedRetrieved, err := publicdashboardStore.GetPublicDashboardConfig(context.Background(), anotherSavedDashboard.OrgId, anotherSavedDashboard.Uid)
require.NoError(t, err)
assert.NotEqual(t, updatedPublicDashboard.UpdatedAt, pdNotUpdatedRetrieved.UpdatedAt)
assert.NotEqual(t, updatedPublicDashboard.IsEnabled, pdNotUpdatedRetrieved.IsEnabled)
})
}
+func insertTestDashboard(t *testing.T, dashboardStore *dashboardsDB.DashboardStore, title string, orgId int64,
+ folderId int64, isFolder bool, tags ...interface{}) *models.Dashboard {
+ t.Helper()
+ cmd := models.SaveDashboardCommand{
+ OrgId: orgId,
+ FolderId: folderId,
+ IsFolder: isFolder,
+ Dashboard: simplejson.NewFromAny(map[string]interface{}{
+ "id": nil,
+ "title": title,
+ "tags": tags,
+ }),
+ }
+ dash, err := dashboardStore.SaveDashboard(cmd)
+ require.NoError(t, err)
+ require.NotNil(t, dash)
+ dash.Data.Set("id", dash.Id)
+ dash.Data.Set("uid", dash.Uid)
+ return dash
+}
diff --git a/pkg/models/dashboards_public.go b/pkg/services/publicdashboards/models/models.go
similarity index 54%
rename from pkg/models/dashboards_public.go
rename to pkg/services/publicdashboards/models/models.go
index a05492c6ea8..31983d53088 100644
--- a/pkg/models/dashboards_public.go
+++ b/pkg/services/publicdashboards/models/models.go
@@ -4,6 +4,47 @@ import (
"time"
"github.com/grafana/grafana/pkg/components/simplejson"
+ "github.com/grafana/grafana/pkg/models"
+)
+
+// PublicDashboardErr represents a dashboard error.
+type PublicDashboardErr struct {
+ StatusCode int
+ Status string
+ Reason string
+}
+
+// Error returns the error message.
+func (e PublicDashboardErr) Error() string {
+ if e.Reason != "" {
+ return e.Reason
+ }
+ return "Dashboard Error"
+}
+
+var (
+ ErrPublicDashboardFailedGenerateUniqueUid = PublicDashboardErr{
+ Reason: "Failed to generate unique public dashboard id",
+ StatusCode: 500,
+ }
+ ErrPublicDashboardFailedGenerateAccesstoken = PublicDashboardErr{
+ Reason: "Failed to public dashboard access token",
+ StatusCode: 500,
+ }
+ ErrPublicDashboardNotFound = PublicDashboardErr{
+ Reason: "Public dashboard not found",
+ StatusCode: 404,
+ Status: "not-found",
+ }
+ ErrPublicDashboardPanelNotFound = PublicDashboardErr{
+ Reason: "Panel not found in dashboard",
+ StatusCode: 404,
+ Status: "not-found",
+ }
+ ErrPublicDashboardIdentifierNotSet = PublicDashboardErr{
+ Reason: "No Uid for public dashboard specified",
+ StatusCode: 400,
+ }
)
type PublicDashboard struct {
@@ -32,7 +73,7 @@ type TimeSettings struct {
// build time settings object from json on public dashboard. If empty, use
// defaults on the dashboard
-func (pd PublicDashboard) BuildTimeSettings(dashboard *Dashboard) *TimeSettings {
+func (pd PublicDashboard) BuildTimeSettings(dashboard *models.Dashboard) *TimeSettings {
ts := &TimeSettings{
From: dashboard.Data.GetPath("time", "from").MustString(),
To: dashboard.Data.GetPath("time", "to").MustString(),
@@ -53,6 +94,16 @@ func (pd PublicDashboard) BuildTimeSettings(dashboard *Dashboard) *TimeSettings
return ts
}
+//
+// DTO for transforming user input in the api
+//
+type SavePublicDashboardConfigDTO struct {
+ DashboardUid string
+ OrgId int64
+ UserId int64
+ PublicDashboard *PublicDashboard
+}
+
//
// COMMANDS
//
diff --git a/pkg/models/dashboards_public_test.go b/pkg/services/publicdashboards/models/models_test.go
similarity index 84%
rename from pkg/models/dashboards_public_test.go
rename to pkg/services/publicdashboards/models/models_test.go
index f9b18b0b1cd..b5278c247d8 100644
--- a/pkg/models/dashboards_public_test.go
+++ b/pkg/services/publicdashboards/models/models_test.go
@@ -4,6 +4,7 @@ import (
"testing"
"github.com/grafana/grafana/pkg/components/simplejson"
+ "github.com/grafana/grafana/pkg/models"
"github.com/stretchr/testify/assert"
)
@@ -15,13 +16,13 @@ func TestBuildTimeSettings(t *testing.T) {
var dashboardData = simplejson.NewFromAny(map[string]interface{}{"time": map[string]interface{}{"from": "now-8", "to": "now"}})
testCases := []struct {
name string
- dashboard *Dashboard
+ dashboard *models.Dashboard
pubdash *PublicDashboard
timeResult *TimeSettings
}{
{
name: "should use dashboard time if pubdash time empty",
- dashboard: &Dashboard{Data: dashboardData},
+ dashboard: &models.Dashboard{Data: dashboardData},
pubdash: &PublicDashboard{},
timeResult: &TimeSettings{
From: "now-8",
@@ -30,7 +31,7 @@ func TestBuildTimeSettings(t *testing.T) {
},
{
name: "should use dashboard time if pubdash to/from empty",
- dashboard: &Dashboard{Data: dashboardData},
+ dashboard: &models.Dashboard{Data: dashboardData},
pubdash: &PublicDashboard{},
timeResult: &TimeSettings{
From: "now-8",
@@ -39,7 +40,7 @@ func TestBuildTimeSettings(t *testing.T) {
},
{
name: "should use pubdash time",
- dashboard: &Dashboard{Data: dashboardData},
+ dashboard: &models.Dashboard{Data: dashboardData},
pubdash: &PublicDashboard{TimeSettings: simplejson.NewFromAny(map[string]interface{}{"from": "now-12", "to": "now"})},
timeResult: &TimeSettings{
From: "now-12",
diff --git a/pkg/services/publicdashboards/public_dashboard_service_mock.go b/pkg/services/publicdashboards/public_dashboard_service_mock.go
new file mode 100644
index 00000000000..1eb14f6c5ce
--- /dev/null
+++ b/pkg/services/publicdashboards/public_dashboard_service_mock.go
@@ -0,0 +1,144 @@
+// Code generated by mockery v2.12.2. DO NOT EDIT.
+
+package publicdashboards
+
+import (
+ context "context"
+
+ dtos "github.com/grafana/grafana/pkg/api/dtos"
+ mock "github.com/stretchr/testify/mock"
+
+ models "github.com/grafana/grafana/pkg/models"
+
+ publicdashboardsmodels "github.com/grafana/grafana/pkg/services/publicdashboards/models"
+
+ testing "testing"
+)
+
+// FakePublicDashboardService is an autogenerated mock type for the Service type
+type FakePublicDashboardService struct {
+ mock.Mock
+}
+
+// BuildAnonymousUser provides a mock function with given fields: ctx, dashboard
+func (_m *FakePublicDashboardService) BuildAnonymousUser(ctx context.Context, dashboard *models.Dashboard) (*models.SignedInUser, error) {
+ ret := _m.Called(ctx, dashboard)
+
+ var r0 *models.SignedInUser
+ if rf, ok := ret.Get(0).(func(context.Context, *models.Dashboard) *models.SignedInUser); ok {
+ r0 = rf(ctx, dashboard)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*models.SignedInUser)
+ }
+ }
+
+ var r1 error
+ if rf, ok := ret.Get(1).(func(context.Context, *models.Dashboard) error); ok {
+ r1 = rf(ctx, dashboard)
+ } else {
+ r1 = ret.Error(1)
+ }
+
+ return r0, r1
+}
+
+// BuildPublicDashboardMetricRequest provides a mock function with given fields: ctx, dashboard, publicDashboard, panelId
+func (_m *FakePublicDashboardService) BuildPublicDashboardMetricRequest(ctx context.Context, dashboard *models.Dashboard, publicDashboard *publicdashboardsmodels.PublicDashboard, panelId int64) (dtos.MetricRequest, error) {
+ ret := _m.Called(ctx, dashboard, publicDashboard, panelId)
+
+ var r0 dtos.MetricRequest
+ if rf, ok := ret.Get(0).(func(context.Context, *models.Dashboard, *publicdashboardsmodels.PublicDashboard, int64) dtos.MetricRequest); ok {
+ r0 = rf(ctx, dashboard, publicDashboard, panelId)
+ } else {
+ r0 = ret.Get(0).(dtos.MetricRequest)
+ }
+
+ var r1 error
+ if rf, ok := ret.Get(1).(func(context.Context, *models.Dashboard, *publicdashboardsmodels.PublicDashboard, int64) error); ok {
+ r1 = rf(ctx, dashboard, publicDashboard, panelId)
+ } else {
+ r1 = ret.Error(1)
+ }
+
+ return r0, r1
+}
+
+// GetPublicDashboard provides a mock function with given fields: ctx, accessToken
+func (_m *FakePublicDashboardService) GetPublicDashboard(ctx context.Context, accessToken string) (*models.Dashboard, error) {
+ ret := _m.Called(ctx, accessToken)
+
+ var r0 *models.Dashboard
+ if rf, ok := ret.Get(0).(func(context.Context, string) *models.Dashboard); ok {
+ r0 = rf(ctx, accessToken)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*models.Dashboard)
+ }
+ }
+
+ var r1 error
+ if rf, ok := ret.Get(1).(func(context.Context, string) error); ok {
+ r1 = rf(ctx, accessToken)
+ } else {
+ r1 = ret.Error(1)
+ }
+
+ return r0, r1
+}
+
+// GetPublicDashboardConfig provides a mock function with given fields: ctx, orgId, dashboardUid
+func (_m *FakePublicDashboardService) GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*publicdashboardsmodels.PublicDashboard, error) {
+ ret := _m.Called(ctx, orgId, dashboardUid)
+
+ var r0 *publicdashboardsmodels.PublicDashboard
+ if rf, ok := ret.Get(0).(func(context.Context, int64, string) *publicdashboardsmodels.PublicDashboard); ok {
+ r0 = rf(ctx, orgId, dashboardUid)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*publicdashboardsmodels.PublicDashboard)
+ }
+ }
+
+ var r1 error
+ if rf, ok := ret.Get(1).(func(context.Context, int64, string) error); ok {
+ r1 = rf(ctx, orgId, dashboardUid)
+ } else {
+ r1 = ret.Error(1)
+ }
+
+ return r0, r1
+}
+
+// SavePublicDashboardConfig provides a mock function with given fields: ctx, dto
+func (_m *FakePublicDashboardService) SavePublicDashboardConfig(ctx context.Context, dto *publicdashboardsmodels.SavePublicDashboardConfigDTO) (*publicdashboardsmodels.PublicDashboard, error) {
+ ret := _m.Called(ctx, dto)
+
+ var r0 *publicdashboardsmodels.PublicDashboard
+ if rf, ok := ret.Get(0).(func(context.Context, *publicdashboardsmodels.SavePublicDashboardConfigDTO) *publicdashboardsmodels.PublicDashboard); ok {
+ r0 = rf(ctx, dto)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*publicdashboardsmodels.PublicDashboard)
+ }
+ }
+
+ var r1 error
+ if rf, ok := ret.Get(1).(func(context.Context, *publicdashboardsmodels.SavePublicDashboardConfigDTO) error); ok {
+ r1 = rf(ctx, dto)
+ } else {
+ r1 = ret.Error(1)
+ }
+
+ return r0, r1
+}
+
+// NewFakePublicDashboardService creates a new instance of FakePublicDashboardService. It also registers the testing.TB interface on the mock and a cleanup function to assert the mocks expectations.
+func NewFakePublicDashboardService(t testing.TB) *FakePublicDashboardService {
+ mock := &FakePublicDashboardService{}
+ mock.Mock.Test(t)
+
+ t.Cleanup(func() { mock.AssertExpectations(t) })
+
+ return mock
+}
diff --git a/pkg/services/publicdashboards/public_dashboard_store_mock.go b/pkg/services/publicdashboards/public_dashboard_store_mock.go
new file mode 100644
index 00000000000..20102fc1179
--- /dev/null
+++ b/pkg/services/publicdashboards/public_dashboard_store_mock.go
@@ -0,0 +1,142 @@
+// Code generated by mockery v2.12.2. DO NOT EDIT.
+
+package publicdashboards
+
+import (
+ context "context"
+
+ models "github.com/grafana/grafana/pkg/services/publicdashboards/models"
+ mock "github.com/stretchr/testify/mock"
+
+ pkgmodels "github.com/grafana/grafana/pkg/models"
+
+ testing "testing"
+)
+
+// FakePublicDashboardStore is an autogenerated mock type for the Store type
+type FakePublicDashboardStore struct {
+ mock.Mock
+}
+
+// GenerateNewPublicDashboardUid provides a mock function with given fields: ctx
+func (_m *FakePublicDashboardStore) GenerateNewPublicDashboardUid(ctx context.Context) (string, error) {
+ ret := _m.Called(ctx)
+
+ var r0 string
+ if rf, ok := ret.Get(0).(func(context.Context) string); ok {
+ r0 = rf(ctx)
+ } else {
+ r0 = ret.Get(0).(string)
+ }
+
+ var r1 error
+ if rf, ok := ret.Get(1).(func(context.Context) error); ok {
+ r1 = rf(ctx)
+ } else {
+ r1 = ret.Error(1)
+ }
+
+ return r0, r1
+}
+
+// GetPublicDashboard provides a mock function with given fields: ctx, accessToken
+func (_m *FakePublicDashboardStore) GetPublicDashboard(ctx context.Context, accessToken string) (*models.PublicDashboard, *pkgmodels.Dashboard, error) {
+ ret := _m.Called(ctx, accessToken)
+
+ var r0 *models.PublicDashboard
+ if rf, ok := ret.Get(0).(func(context.Context, string) *models.PublicDashboard); ok {
+ r0 = rf(ctx, accessToken)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*models.PublicDashboard)
+ }
+ }
+
+ var r1 *pkgmodels.Dashboard
+ if rf, ok := ret.Get(1).(func(context.Context, string) *pkgmodels.Dashboard); ok {
+ r1 = rf(ctx, accessToken)
+ } else {
+ if ret.Get(1) != nil {
+ r1 = ret.Get(1).(*pkgmodels.Dashboard)
+ }
+ }
+
+ var r2 error
+ if rf, ok := ret.Get(2).(func(context.Context, string) error); ok {
+ r2 = rf(ctx, accessToken)
+ } else {
+ r2 = ret.Error(2)
+ }
+
+ return r0, r1, r2
+}
+
+// GetPublicDashboardConfig provides a mock function with given fields: ctx, orgId, dashboardUid
+func (_m *FakePublicDashboardStore) GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*models.PublicDashboard, error) {
+ ret := _m.Called(ctx, orgId, dashboardUid)
+
+ var r0 *models.PublicDashboard
+ if rf, ok := ret.Get(0).(func(context.Context, int64, string) *models.PublicDashboard); ok {
+ r0 = rf(ctx, orgId, dashboardUid)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*models.PublicDashboard)
+ }
+ }
+
+ var r1 error
+ if rf, ok := ret.Get(1).(func(context.Context, int64, string) error); ok {
+ r1 = rf(ctx, orgId, dashboardUid)
+ } else {
+ r1 = ret.Error(1)
+ }
+
+ return r0, r1
+}
+
+// SavePublicDashboardConfig provides a mock function with given fields: ctx, cmd
+func (_m *FakePublicDashboardStore) SavePublicDashboardConfig(ctx context.Context, cmd models.SavePublicDashboardConfigCommand) (*models.PublicDashboard, error) {
+ ret := _m.Called(ctx, cmd)
+
+ var r0 *models.PublicDashboard
+ if rf, ok := ret.Get(0).(func(context.Context, models.SavePublicDashboardConfigCommand) *models.PublicDashboard); ok {
+ r0 = rf(ctx, cmd)
+ } else {
+ if ret.Get(0) != nil {
+ r0 = ret.Get(0).(*models.PublicDashboard)
+ }
+ }
+
+ var r1 error
+ if rf, ok := ret.Get(1).(func(context.Context, models.SavePublicDashboardConfigCommand) error); ok {
+ r1 = rf(ctx, cmd)
+ } else {
+ r1 = ret.Error(1)
+ }
+
+ return r0, r1
+}
+
+// UpdatePublicDashboardConfig provides a mock function with given fields: ctx, cmd
+func (_m *FakePublicDashboardStore) UpdatePublicDashboardConfig(ctx context.Context, cmd models.SavePublicDashboardConfigCommand) error {
+ ret := _m.Called(ctx, cmd)
+
+ var r0 error
+ if rf, ok := ret.Get(0).(func(context.Context, models.SavePublicDashboardConfigCommand) error); ok {
+ r0 = rf(ctx, cmd)
+ } else {
+ r0 = ret.Error(0)
+ }
+
+ return r0
+}
+
+// NewFakePublicDashboardStore creates a new instance of FakePublicDashboardStore. It also registers the testing.TB interface on the mock and a cleanup function to assert the mocks expectations.
+func NewFakePublicDashboardStore(t testing.TB) *FakePublicDashboardStore {
+ mock := &FakePublicDashboardStore{}
+ mock.Mock.Test(t)
+
+ t.Cleanup(func() { mock.AssertExpectations(t) })
+
+ return mock
+}
diff --git a/pkg/services/publicdashboards/publicdashboard.go b/pkg/services/publicdashboards/publicdashboard.go
new file mode 100644
index 00000000000..4d3be2b3fa7
--- /dev/null
+++ b/pkg/services/publicdashboards/publicdashboard.go
@@ -0,0 +1,29 @@
+package publicdashboards
+
+import (
+ "context"
+
+ "github.com/grafana/grafana/pkg/api/dtos"
+ "github.com/grafana/grafana/pkg/models"
+ . "github.com/grafana/grafana/pkg/services/publicdashboards/models"
+)
+
+// These are the api contracts. The API should match the underlying service and store
+
+//go:generate mockery --name Service --structname FakePublicDashboardService --inpackage --filename public_dashboard_service_mock.go
+type Service interface {
+ BuildAnonymousUser(ctx context.Context, dashboard *models.Dashboard) (*models.SignedInUser, error)
+ GetPublicDashboard(ctx context.Context, accessToken string) (*models.Dashboard, error)
+ GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*PublicDashboard, error)
+ SavePublicDashboardConfig(ctx context.Context, dto *SavePublicDashboardConfigDTO) (*PublicDashboard, error)
+ BuildPublicDashboardMetricRequest(ctx context.Context, dashboard *models.Dashboard, publicDashboard *PublicDashboard, panelId int64) (dtos.MetricRequest, error)
+}
+
+//go:generate mockery --name Store --structname FakePublicDashboardStore --inpackage --filename public_dashboard_store_mock.go
+type Store interface {
+ GetPublicDashboard(ctx context.Context, accessToken string) (*PublicDashboard, *models.Dashboard, error)
+ GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*PublicDashboard, error)
+ GenerateNewPublicDashboardUid(ctx context.Context) (string, error)
+ SavePublicDashboardConfig(ctx context.Context, cmd SavePublicDashboardConfigCommand) (*PublicDashboard, error)
+ UpdatePublicDashboardConfig(ctx context.Context, cmd SavePublicDashboardConfigCommand) error
+}
diff --git a/pkg/services/publicdashboards/service/service.go b/pkg/services/publicdashboards/service/service.go
new file mode 100644
index 00000000000..c1f69db5463
--- /dev/null
+++ b/pkg/services/publicdashboards/service/service.go
@@ -0,0 +1,200 @@
+package service
+
+import (
+ "context"
+ "fmt"
+ "time"
+
+ "github.com/google/uuid"
+ "github.com/grafana/grafana/pkg/api/dtos"
+ "github.com/grafana/grafana/pkg/components/simplejson"
+ "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/services/datasources"
+ "github.com/grafana/grafana/pkg/services/publicdashboards"
+ . "github.com/grafana/grafana/pkg/services/publicdashboards/models"
+ "github.com/grafana/grafana/pkg/setting"
+)
+
+// Define the Service Implementation. We're generating mock implementation
+// automatically
+type PublicDashboardServiceImpl struct {
+ log log.Logger
+ cfg *setting.Cfg
+ store publicdashboards.Store
+}
+
+// Gives us compile time error if the service does not adhere to the contract of
+// the interface
+var _ publicdashboards.Service = (*PublicDashboardServiceImpl)(nil)
+
+// Factory for method used by wire to inject dependencies.
+// builds the service, and api, and configures routes
+func ProvideService(
+ cfg *setting.Cfg,
+ store publicdashboards.Store,
+) *PublicDashboardServiceImpl {
+ return &PublicDashboardServiceImpl{
+ log: log.New("publicdashboards"),
+ cfg: cfg,
+ store: store,
+ }
+}
+
+// Gets public dashboard via access token
+func (pd *PublicDashboardServiceImpl) GetPublicDashboard(ctx context.Context, accessToken string) (*models.Dashboard, error) {
+ pubdash, d, err := pd.store.GetPublicDashboard(ctx, accessToken)
+
+ if err != nil {
+ return nil, err
+ }
+
+ if pubdash == nil || d == nil {
+ return nil, ErrPublicDashboardNotFound
+ }
+
+ if !pubdash.IsEnabled {
+ return nil, ErrPublicDashboardNotFound
+ }
+
+ ts := pubdash.BuildTimeSettings(d)
+ d.Data.SetPath([]string{"time", "from"}, ts.From)
+ d.Data.SetPath([]string{"time", "to"}, ts.To)
+
+ return d, nil
+}
+
+// GetPublicDashboardConfig is a helper method to retrieve the public dashboard configuration for a given dashboard from the database
+func (pd *PublicDashboardServiceImpl) GetPublicDashboardConfig(ctx context.Context, orgId int64, dashboardUid string) (*PublicDashboard, error) {
+ pdc, err := pd.store.GetPublicDashboardConfig(ctx, orgId, dashboardUid)
+ if err != nil {
+ return nil, err
+ }
+
+ return pdc, nil
+}
+
+// SavePublicDashboardConfig is a helper method to persist the sharing config
+// to the database. It handles validations for sharing config and persistence
+func (pd *PublicDashboardServiceImpl) SavePublicDashboardConfig(ctx context.Context, dto *SavePublicDashboardConfigDTO) (*PublicDashboard, error) {
+ if len(dto.DashboardUid) == 0 {
+ return nil, dashboards.ErrDashboardIdentifierNotSet
+ }
+
+ // set default value for time settings
+ if dto.PublicDashboard.TimeSettings == nil {
+ dto.PublicDashboard.TimeSettings = simplejson.New()
+ }
+
+ if dto.PublicDashboard.Uid == "" {
+ return pd.savePublicDashboardConfig(ctx, dto)
+ }
+
+ return pd.updatePublicDashboardConfig(ctx, dto)
+}
+
+func (pd *PublicDashboardServiceImpl) savePublicDashboardConfig(ctx context.Context, dto *SavePublicDashboardConfigDTO) (*PublicDashboard, error) {
+ uid, err := pd.store.GenerateNewPublicDashboardUid(ctx)
+ if err != nil {
+ return nil, err
+ }
+
+ accessToken, err := GenerateAccessToken()
+ if err != nil {
+ return nil, err
+ }
+
+ cmd := SavePublicDashboardConfigCommand{
+ DashboardUid: dto.DashboardUid,
+ OrgId: dto.OrgId,
+ PublicDashboard: PublicDashboard{
+ Uid: uid,
+ DashboardUid: dto.DashboardUid,
+ OrgId: dto.OrgId,
+ IsEnabled: dto.PublicDashboard.IsEnabled,
+ TimeSettings: dto.PublicDashboard.TimeSettings,
+ CreatedBy: dto.UserId,
+ CreatedAt: time.Now(),
+ AccessToken: accessToken,
+ },
+ }
+
+ return pd.store.SavePublicDashboardConfig(ctx, cmd)
+}
+
+func (pd *PublicDashboardServiceImpl) updatePublicDashboardConfig(ctx context.Context, dto *SavePublicDashboardConfigDTO) (*PublicDashboard, error) {
+ cmd := SavePublicDashboardConfigCommand{
+ PublicDashboard: PublicDashboard{
+ Uid: dto.PublicDashboard.Uid,
+ IsEnabled: dto.PublicDashboard.IsEnabled,
+ TimeSettings: dto.PublicDashboard.TimeSettings,
+ UpdatedBy: dto.UserId,
+ UpdatedAt: time.Now(),
+ },
+ }
+
+ err := pd.store.UpdatePublicDashboardConfig(ctx, cmd)
+ if err != nil {
+ return nil, err
+ }
+
+ publicDashboard, err := pd.store.GetPublicDashboardConfig(ctx, dto.OrgId, dto.DashboardUid)
+ if err != nil {
+ return nil, err
+ }
+
+ return publicDashboard, nil
+}
+
+// BuildPublicDashboardMetricRequest merges public dashboard parameters with
+// dashboard and returns a metrics request to be sent to query backend
+func (pd *PublicDashboardServiceImpl) BuildPublicDashboardMetricRequest(ctx context.Context, dashboard *models.Dashboard, publicDashboard *PublicDashboard, panelId int64) (dtos.MetricRequest, error) {
+ if !publicDashboard.IsEnabled {
+ return dtos.MetricRequest{}, ErrPublicDashboardNotFound
+ }
+
+ queriesByPanel := models.GroupQueriesByPanelId(dashboard.Data)
+
+ if _, ok := queriesByPanel[panelId]; !ok {
+ return dtos.MetricRequest{}, ErrPublicDashboardPanelNotFound
+ }
+
+ ts := publicDashboard.BuildTimeSettings(dashboard)
+
+ return dtos.MetricRequest{
+ From: ts.From,
+ To: ts.To,
+ Queries: queriesByPanel[panelId],
+ }, nil
+}
+
+// BuildAnonymousUser creates a user with permissions to read from all datasources used in the dashboard
+func (pd *PublicDashboardServiceImpl) BuildAnonymousUser(ctx context.Context, dashboard *models.Dashboard) (*models.SignedInUser, error) {
+ datasourceUids := models.GetUniqueDashboardDatasourceUids(dashboard.Data)
+
+ // Create a temp user with read-only datasource permissions
+ anonymousUser := &models.SignedInUser{OrgId: dashboard.OrgId, Permissions: make(map[int64]map[string][]string)}
+ permissions := make(map[string][]string)
+ queryScopes := make([]string, 0)
+ readScopes := make([]string, 0)
+ for _, uid := range datasourceUids {
+ queryScopes = append(queryScopes, fmt.Sprintf("datasources:uid:%s", uid))
+ readScopes = append(readScopes, fmt.Sprintf("datasources:uid:%s", uid))
+ }
+ permissions[datasources.ActionQuery] = queryScopes
+ permissions[datasources.ActionRead] = readScopes
+ anonymousUser.Permissions[dashboard.OrgId] = permissions
+
+ return anonymousUser, nil
+}
+
+// generates a uuid formatted without dashes to use as access token
+func GenerateAccessToken() (string, error) {
+ token, err := uuid.NewRandom()
+ if err != nil {
+ return "", err
+ }
+
+ return fmt.Sprintf("%x", token[:]), nil
+}
diff --git a/pkg/services/dashboards/service/dashboard_public_test.go b/pkg/services/publicdashboards/service/service_test.go
similarity index 75%
rename from pkg/services/dashboards/service/dashboard_public_test.go
rename to pkg/services/publicdashboards/service/service_test.go
index 74e2efd62f3..8198d41f4fa 100644
--- a/pkg/services/dashboards/service/dashboard_public_test.go
+++ b/pkg/services/publicdashboards/service/service_test.go
@@ -13,8 +13,10 @@ import (
"github.com/grafana/grafana/pkg/components/simplejson"
"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/services/dashboards/database"
+ dashboardsDB "github.com/grafana/grafana/pkg/services/dashboards/database"
+ . "github.com/grafana/grafana/pkg/services/publicdashboards"
+ database "github.com/grafana/grafana/pkg/services/publicdashboards/database"
+ . "github.com/grafana/grafana/pkg/services/publicdashboards/models"
"github.com/grafana/grafana/pkg/services/sqlstore"
)
@@ -25,7 +27,7 @@ var mergedDashboardData = simplejson.NewFromAny(map[string]interface{}{"time": m
func TestGetPublicDashboard(t *testing.T) {
type storeResp struct {
- pd *models.PublicDashboard
+ pd *PublicDashboard
d *models.Dashboard
err error
}
@@ -41,7 +43,7 @@ func TestGetPublicDashboard(t *testing.T) {
Name: "returns a dashboard",
AccessToken: "abc123",
StoreResp: &storeResp{
- pd: &models.PublicDashboard{IsEnabled: true},
+ pd: &PublicDashboard{IsEnabled: true},
d: &models.Dashboard{Uid: "mydashboard", Data: dashboardData},
err: nil,
},
@@ -52,7 +54,7 @@ func TestGetPublicDashboard(t *testing.T) {
Name: "puts pubdash time settings into dashboard",
AccessToken: "abc123",
StoreResp: &storeResp{
- pd: &models.PublicDashboard{IsEnabled: true, TimeSettings: timeSettings},
+ pd: &PublicDashboard{IsEnabled: true, TimeSettings: timeSettings},
d: &models.Dashboard{Data: dashboardData},
err: nil,
},
@@ -63,35 +65,35 @@ func TestGetPublicDashboard(t *testing.T) {
Name: "returns ErrPublicDashboardNotFound when isEnabled is false",
AccessToken: "abc123",
StoreResp: &storeResp{
- pd: &models.PublicDashboard{IsEnabled: false},
+ pd: &PublicDashboard{IsEnabled: false},
d: &models.Dashboard{Uid: "mydashboard"},
err: nil,
},
- ErrResp: dashboards.ErrPublicDashboardNotFound,
+ ErrResp: ErrPublicDashboardNotFound,
DashResp: nil,
},
{
Name: "returns ErrPublicDashboardNotFound if PublicDashboard missing",
AccessToken: "abc123",
StoreResp: &storeResp{pd: nil, d: nil, err: nil},
- ErrResp: dashboards.ErrPublicDashboardNotFound,
+ ErrResp: ErrPublicDashboardNotFound,
DashResp: nil,
},
{
Name: "returns ErrPublicDashboardNotFound if Dashboard missing",
AccessToken: "abc123",
StoreResp: &storeResp{pd: nil, d: nil, err: nil},
- ErrResp: dashboards.ErrPublicDashboardNotFound,
+ ErrResp: ErrPublicDashboardNotFound,
DashResp: nil,
},
}
for _, test := range testCases {
t.Run(test.Name, func(t *testing.T) {
- fakeStore := dashboards.FakeDashboardStore{}
- service := &DashboardServiceImpl{
- log: log.New("test.logger"),
- dashboardStore: &fakeStore,
+ fakeStore := FakePublicDashboardStore{}
+ service := &PublicDashboardServiceImpl{
+ log: log.New("test.logger"),
+ store: &fakeStore,
}
fakeStore.On("GetPublicDashboard", mock.Anything, mock.Anything).
@@ -116,19 +118,20 @@ func TestGetPublicDashboard(t *testing.T) {
func TestSavePublicDashboard(t *testing.T) {
t.Run("Saving public dashboard", func(t *testing.T) {
sqlStore := sqlstore.InitTestDB(t)
- dashboardStore := database.ProvideDashboardStore(sqlStore)
+ dashboardStore := dashboardsDB.ProvideDashboardStore(sqlStore)
+ publicdashboardStore := database.ProvideStore(sqlStore)
dashboard := insertTestDashboard(t, dashboardStore, "testDashie", 1, 0, true)
- service := &DashboardServiceImpl{
- log: log.New("test.logger"),
- dashboardStore: dashboardStore,
+ service := &PublicDashboardServiceImpl{
+ log: log.New("test.logger"),
+ store: publicdashboardStore,
}
- dto := &dashboards.SavePublicDashboardConfigDTO{
+ dto := &SavePublicDashboardConfigDTO{
DashboardUid: dashboard.Uid,
OrgId: dashboard.OrgId,
UserId: 7,
- PublicDashboard: &models.PublicDashboard{
+ PublicDashboard: &PublicDashboard{
IsEnabled: true,
DashboardUid: "NOTTHESAME",
OrgId: 9999999,
@@ -159,19 +162,20 @@ func TestSavePublicDashboard(t *testing.T) {
t.Run("Validate pubdash has default time setting value", func(t *testing.T) {
sqlStore := sqlstore.InitTestDB(t)
- dashboardStore := database.ProvideDashboardStore(sqlStore)
+ dashboardStore := dashboardsDB.ProvideDashboardStore(sqlStore)
+ publicdashboardStore := database.ProvideStore(sqlStore)
dashboard := insertTestDashboard(t, dashboardStore, "testDashie", 1, 0, true)
- service := &DashboardServiceImpl{
- log: log.New("test.logger"),
- dashboardStore: dashboardStore,
+ service := &PublicDashboardServiceImpl{
+ log: log.New("test.logger"),
+ store: publicdashboardStore,
}
- dto := &dashboards.SavePublicDashboardConfigDTO{
+ dto := &SavePublicDashboardConfigDTO{
DashboardUid: dashboard.Uid,
OrgId: dashboard.OrgId,
UserId: 7,
- PublicDashboard: &models.PublicDashboard{
+ PublicDashboard: &PublicDashboard{
IsEnabled: true,
DashboardUid: "NOTTHESAME",
OrgId: 9999999,
@@ -192,19 +196,20 @@ func TestSavePublicDashboard(t *testing.T) {
func TestUpdatePublicDashboard(t *testing.T) {
t.Run("Updating public dashboard", func(t *testing.T) {
sqlStore := sqlstore.InitTestDB(t)
- dashboardStore := database.ProvideDashboardStore(sqlStore)
+ dashboardStore := dashboardsDB.ProvideDashboardStore(sqlStore)
+ publicdashboardStore := database.ProvideStore(sqlStore)
dashboard := insertTestDashboard(t, dashboardStore, "testDashie", 1, 0, true)
- service := &DashboardServiceImpl{
- log: log.New("test.logger"),
- dashboardStore: dashboardStore,
+ service := &PublicDashboardServiceImpl{
+ log: log.New("test.logger"),
+ store: publicdashboardStore,
}
- dto := &dashboards.SavePublicDashboardConfigDTO{
+ dto := &SavePublicDashboardConfigDTO{
DashboardUid: dashboard.Uid,
OrgId: dashboard.OrgId,
UserId: 7,
- PublicDashboard: &models.PublicDashboard{
+ PublicDashboard: &PublicDashboard{
IsEnabled: true,
TimeSettings: timeSettings,
},
@@ -217,11 +222,11 @@ func TestUpdatePublicDashboard(t *testing.T) {
require.NoError(t, err)
// attempt to overwrite settings
- dto = &dashboards.SavePublicDashboardConfigDTO{
+ dto = &SavePublicDashboardConfigDTO{
DashboardUid: dashboard.Uid,
OrgId: dashboard.OrgId,
UserId: 8,
- PublicDashboard: &models.PublicDashboard{
+ PublicDashboard: &PublicDashboard{
Uid: savedPubdash.Uid,
OrgId: 9,
DashboardUid: "abc1234",
@@ -258,19 +263,20 @@ func TestUpdatePublicDashboard(t *testing.T) {
t.Run("Updating set empty time settings", func(t *testing.T) {
sqlStore := sqlstore.InitTestDB(t)
- dashboardStore := database.ProvideDashboardStore(sqlStore)
+ dashboardStore := dashboardsDB.ProvideDashboardStore(sqlStore)
+ publicdashboardStore := database.ProvideStore(sqlStore)
dashboard := insertTestDashboard(t, dashboardStore, "testDashie", 1, 0, true)
- service := &DashboardServiceImpl{
- log: log.New("test.logger"),
- dashboardStore: dashboardStore,
+ service := &PublicDashboardServiceImpl{
+ log: log.New("test.logger"),
+ store: publicdashboardStore,
}
- dto := &dashboards.SavePublicDashboardConfigDTO{
+ dto := &SavePublicDashboardConfigDTO{
DashboardUid: dashboard.Uid,
OrgId: dashboard.OrgId,
UserId: 7,
- PublicDashboard: &models.PublicDashboard{
+ PublicDashboard: &PublicDashboard{
IsEnabled: true,
TimeSettings: timeSettings,
},
@@ -285,11 +291,11 @@ func TestUpdatePublicDashboard(t *testing.T) {
require.NoError(t, err)
// attempt to overwrite settings
- dto = &dashboards.SavePublicDashboardConfigDTO{
+ dto = &SavePublicDashboardConfigDTO{
DashboardUid: dashboard.Uid,
OrgId: dashboard.OrgId,
UserId: 8,
- PublicDashboard: &models.PublicDashboard{
+ PublicDashboard: &PublicDashboard{
Uid: savedPubdash.Uid,
OrgId: 9,
DashboardUid: "abc1234",
@@ -314,21 +320,44 @@ func TestUpdatePublicDashboard(t *testing.T) {
})
}
+func TestBuildAnonymousUser(t *testing.T) {
+ sqlStore := sqlstore.InitTestDB(t)
+ dashboardStore := dashboardsDB.ProvideDashboardStore(sqlStore)
+ dashboard := insertTestDashboard(t, dashboardStore, "testDashie", 1, 0, true)
+ publicdashboardStore := database.ProvideStore(sqlStore)
+ service := &PublicDashboardServiceImpl{
+ log: log.New("test.logger"),
+ store: publicdashboardStore,
+ }
+
+ t.Run("will add datasource read and query permissions to user for each datasource in dashboard", func(t *testing.T) {
+ user, err := service.BuildAnonymousUser(context.Background(), dashboard)
+ require.NoError(t, err)
+ require.Equal(t, dashboard.OrgId, user.OrgId)
+ require.Equal(t, "datasources:uid:ds1", user.Permissions[user.OrgId]["datasources:query"][0])
+ require.Equal(t, "datasources:uid:ds3", user.Permissions[user.OrgId]["datasources:query"][1])
+ require.Equal(t, "datasources:uid:ds1", user.Permissions[user.OrgId]["datasources:read"][0])
+ require.Equal(t, "datasources:uid:ds3", user.Permissions[user.OrgId]["datasources:read"][1])
+ })
+}
+
func TestBuildPublicDashboardMetricRequest(t *testing.T) {
sqlStore := sqlstore.InitTestDB(t)
- dashboardStore := database.ProvideDashboardStore(sqlStore)
+ dashboardStore := dashboardsDB.ProvideDashboardStore(sqlStore)
+ publicdashboardStore := database.ProvideStore(sqlStore)
+
publicDashboard := insertTestDashboard(t, dashboardStore, "testDashie", 1, 0, true)
nonPublicDashboard := insertTestDashboard(t, dashboardStore, "testNonPublicDashie", 1, 0, true)
- service := &DashboardServiceImpl{
- log: log.New("test.logger"),
- dashboardStore: dashboardStore,
+ service := &PublicDashboardServiceImpl{
+ log: log.New("test.logger"),
+ store: publicdashboardStore,
}
- dto := &dashboards.SavePublicDashboardConfigDTO{
+ dto := &SavePublicDashboardConfigDTO{
DashboardUid: publicDashboard.Uid,
OrgId: publicDashboard.OrgId,
- PublicDashboard: &models.PublicDashboard{
+ PublicDashboard: &PublicDashboard{
IsEnabled: true,
DashboardUid: "NOTTHESAME",
OrgId: 9999999,
@@ -339,10 +368,10 @@ func TestBuildPublicDashboardMetricRequest(t *testing.T) {
publicDashboardPD, err := service.SavePublicDashboardConfig(context.Background(), dto)
require.NoError(t, err)
- nonPublicDto := &dashboards.SavePublicDashboardConfigDTO{
+ nonPublicDto := &SavePublicDashboardConfigDTO{
DashboardUid: nonPublicDashboard.Uid,
OrgId: nonPublicDashboard.OrgId,
- PublicDashboard: &models.PublicDashboard{
+ PublicDashboard: &PublicDashboard{
IsEnabled: false,
DashboardUid: "NOTTHESAME",
OrgId: 9999999,
@@ -411,7 +440,7 @@ func TestBuildPublicDashboardMetricRequest(t *testing.T) {
})
}
-func insertTestDashboard(t *testing.T, dashboardStore *database.DashboardStore, title string, orgId int64,
+func insertTestDashboard(t *testing.T, dashboardStore *dashboardsDB.DashboardStore, title string, orgId int64,
folderId int64, isFolder bool, tags ...interface{}) *models.Dashboard {
t.Helper()
cmd := models.SaveDashboardCommand{
@@ -425,6 +454,9 @@ func insertTestDashboard(t *testing.T, dashboardStore *database.DashboardStore,
"panels": []interface{}{
map[string]interface{}{
"id": 1,
+ "datasource": map[string]interface{}{
+ "uid": "ds1",
+ },
"targets": []interface{}{
map[string]interface{}{
"datasource": map[string]interface{}{
@@ -444,6 +476,9 @@ func insertTestDashboard(t *testing.T, dashboardStore *database.DashboardStore,
},
map[string]interface{}{
"id": 2,
+ "datasource": map[string]interface{}{
+ "uid": "ds3",
+ },
"targets": []interface{}{
map[string]interface{}{
"datasource": map[string]interface{}{
diff --git a/pkg/services/searchV2/extract/types.go b/pkg/services/searchV2/extract/types.go
index 71ff5545bb1..9b084cd2409 100644
--- a/pkg/services/searchV2/extract/types.go
+++ b/pkg/services/searchV2/extract/types.go
@@ -22,6 +22,7 @@ type PanelInfo struct {
}
type DashboardInfo struct {
+ UID string `json:"uid,omitempty"`
ID int64 `json:"id,omitempty"` // internal ID
Title string `json:"title"`
Description string `json:"description,omitempty"`
diff --git a/pkg/services/secrets/manager/manager.go b/pkg/services/secrets/manager/manager.go
index 03cb18ede29..1c3c391f01e 100644
--- a/pkg/services/secrets/manager/manager.go
+++ b/pkg/services/secrets/manager/manager.go
@@ -34,7 +34,10 @@ type SecretsService struct {
mtx sync.Mutex
dataKeyCache *dataKeyCache
- providers map[secrets.ProviderID]secrets.Provider
+ pOnce sync.Once
+ providers map[secrets.ProviderID]secrets.Provider
+ kmsProvidersService kmsproviders.Service
+
currentProviderID secrets.ProviderID
log log.Logger
@@ -48,46 +51,56 @@ func ProvideSecretsService(
features featuremgmt.FeatureToggles,
usageStats usagestats.Service,
) (*SecretsService, error) {
- providers, err := kmsProvidersService.Provide()
- if err != nil {
- return nil, err
- }
+ ttl := settings.KeyValue("security.encryption", "data_keys_cache_ttl").MustDuration(15 * time.Minute)
- logger := log.New("secrets")
- enabled := !features.IsEnabled(featuremgmt.FlagDisableEnvelopeEncryption)
currentProviderID := kmsproviders.NormalizeProviderID(secrets.ProviderID(
settings.KeyValue("security", "encryption_provider").MustString(kmsproviders.Default),
))
- if _, ok := providers[currentProviderID]; enabled && !ok {
+ s := &SecretsService{
+ store: store,
+ enc: enc,
+ settings: settings,
+ usageStats: usageStats,
+ kmsProvidersService: kmsProvidersService,
+ dataKeyCache: newDataKeyCache(ttl),
+ currentProviderID: currentProviderID,
+ features: features,
+ log: log.New("secrets"),
+ }
+
+ enabled := !features.IsEnabled(featuremgmt.FlagDisableEnvelopeEncryption)
+
+ if enabled {
+ err := s.InitProviders()
+ if err != nil {
+ return nil, err
+ }
+ }
+
+ if _, ok := s.providers[currentProviderID]; enabled && !ok {
return nil, fmt.Errorf("missing configuration for current encryption provider %s", currentProviderID)
}
if !enabled && currentProviderID != kmsproviders.Default {
- logger.Warn("Changing encryption provider requires enabling envelope encryption feature")
+ s.log.Warn("Changing encryption provider requires enabling envelope encryption feature")
}
- logger.Info("Envelope encryption state", "enabled", enabled, "current provider", currentProviderID)
-
- ttl := settings.KeyValue("security.encryption", "data_keys_cache_ttl").MustDuration(15 * time.Minute)
-
- s := &SecretsService{
- store: store,
- enc: enc,
- settings: settings,
- usageStats: usageStats,
- providers: providers,
- dataKeyCache: newDataKeyCache(ttl),
- currentProviderID: currentProviderID,
- features: features,
- log: logger,
- }
+ s.log.Info("Envelope encryption state", "enabled", enabled, "current provider", currentProviderID)
s.registerUsageMetrics()
return s, nil
}
+func (s *SecretsService) InitProviders() (err error) {
+ s.pOnce.Do(func() {
+ s.providers, err = s.kmsProvidersService.Provide()
+ })
+
+ return
+}
+
func (s *SecretsService) registerUsageMetrics() {
s.usageStats.RegisterMetricsFunc(func(context.Context) (map[string]interface{}, error) {
usageMetrics := make(map[string]interface{})
diff --git a/pkg/services/sqlstore/team.go b/pkg/services/sqlstore/team.go
index b303b031a51..dce533502c5 100644
--- a/pkg/services/sqlstore/team.go
+++ b/pkg/services/sqlstore/team.go
@@ -9,6 +9,7 @@ import (
"github.com/grafana/grafana/pkg/models"
ac "github.com/grafana/grafana/pkg/services/accesscontrol"
+ "github.com/grafana/grafana/pkg/services/serviceaccounts"
)
type TeamStore interface {
@@ -528,17 +529,25 @@ func (ss *SQLStore) GetTeamMembers(ctx context.Context, query *models.GetTeamMem
// If the signed in user is not set no member will be returned
if !ac.IsDisabled(ss.Cfg) {
sqlID := fmt.Sprintf("%s.%s", ss.engine.Dialect().Quote("user"), ss.engine.Dialect().Quote("id"))
+ var filter ac.SQLFilter
*acFilter, err = ac.Filter(query.SignedInUser, sqlID, "users:id:", ac.ActionOrgUsersRead)
if err != nil {
return err
}
+
+ filter, err = ac.Filter(query.SignedInUser, sqlID, "serviceaccounts:id:", serviceaccounts.ActionRead)
+ if err != nil {
+ return err
+ }
+ acFilter.Where = fmt.Sprintf("(%s OR %s)", acFilter.Where, filter.Where)
+ acFilter.Args = append(acFilter.Args, filter.Args...)
}
return ss.getTeamMembers(ctx, query, acFilter)
}
// getTeamMembers return a list of members for the specified team
-func (ss *SQLStore) getTeamMembers(ctx context.Context, query *models.GetTeamMembersQuery, acUserFilter *ac.SQLFilter) error {
+func (ss *SQLStore) getTeamMembers(ctx context.Context, query *models.GetTeamMembersQuery, acFilter *ac.SQLFilter) error {
return ss.WithDbSession(ctx, func(dbSess *DBSession) error {
query.Result = make([]*models.TeamMemberDTO, 0)
sess := dbSess.Table("team_member")
@@ -546,11 +555,8 @@ func (ss *SQLStore) getTeamMembers(ctx context.Context, query *models.GetTeamMem
fmt.Sprintf("team_member.user_id=%s.%s", ss.Dialect.Quote("user"), ss.Dialect.Quote("id")),
)
- // explicitly check for serviceaccounts
- sess.Where(fmt.Sprintf("%s.is_service_account=?", ss.Dialect.Quote("user")), ss.Dialect.BooleanStr(false))
-
- if acUserFilter != nil {
- sess.Where(acUserFilter.Where, acUserFilter.Args...)
+ if acFilter != nil {
+ sess.Where(acFilter.Where, acFilter.Args...)
}
// Join with only most recent auth module
diff --git a/pkg/services/sqlstore/team_test.go b/pkg/services/sqlstore/team_test.go
index 845b0fddf3d..2726ad0e2ef 100644
--- a/pkg/services/sqlstore/team_test.go
+++ b/pkg/services/sqlstore/team_test.go
@@ -24,9 +24,8 @@ func TestIntegrationTeamCommandsAndQueries(t *testing.T) {
OrgId: 1,
Permissions: map[int64]map[string][]string{
1: {
- ac.ActionTeamsRead: []string{ac.ScopeTeamsAll},
- ac.ActionOrgUsersRead: []string{ac.ScopeUsersAll},
- serviceaccounts.ActionRead: []string{serviceaccounts.ScopeAll},
+ ac.ActionTeamsRead: []string{ac.ScopeTeamsAll},
+ ac.ActionOrgUsersRead: []string{ac.ScopeUsersAll},
},
},
}
@@ -373,9 +372,21 @@ func TestIntegrationTeamCommandsAndQueries(t *testing.T) {
require.EqualValues(t, getTeamQuery.Result.MemberCount, 2)
})
- t.Run("Should be able to exclude service accounts from teamembers", func(t *testing.T) {
+ t.Run("Should be able to add service accounts to teams, list it as a team member and remove it from team", func(t *testing.T) {
sqlStore = InitTestDB(t)
setup()
+
+ signedInUser := &models.SignedInUser{
+ Login: "loginuser0",
+ OrgId: testOrgID,
+ Permissions: map[int64]map[string][]string{
+ testOrgID: {
+ ac.ActionTeamsRead: []string{ac.ScopeTeamsAll},
+ ac.ActionOrgUsersRead: []string{ac.ScopeUsersAll},
+ },
+ },
+ }
+
userCmd = user.CreateUserCommand{
Email: fmt.Sprint("sa", 1, "@test.com"),
Name: fmt.Sprint("sa", 1),
@@ -385,24 +396,23 @@ func TestIntegrationTeamCommandsAndQueries(t *testing.T) {
serviceAccount, err := sqlStore.CreateUser(context.Background(), userCmd)
require.NoError(t, err)
- groupId := team2.Id
- // add service account to team
- err = sqlStore.AddTeamMember(serviceAccount.ID, testOrgID, groupId, false, 0)
+ teamId := team1.Id
+ err = sqlStore.AddTeamMember(serviceAccount.ID, testOrgID, teamId, false, 0)
require.NoError(t, err)
- // add user to team
- err = sqlStore.AddTeamMember(userIds[0], testOrgID, groupId, false, 0)
+ getTeamMembersQuery := &models.GetTeamMembersQuery{OrgId: testOrgID, TeamId: teamId, SignedInUser: signedInUser}
+ err = sqlStore.GetTeamMembers(context.Background(), getTeamMembersQuery)
+ require.NoError(t, err)
+ require.EqualValues(t, 1, len(getTeamMembersQuery.Result))
+ require.EqualValues(t, serviceAccount.ID, getTeamMembersQuery.Result[0].UserId)
+
+ removeTeamMemberCmd := &models.RemoveTeamMemberCommand{OrgId: testOrgID, TeamId: teamId, UserId: serviceAccount.ID}
+ err = sqlStore.RemoveTeamMember(context.Background(), removeTeamMemberCmd)
require.NoError(t, err)
- teamMembersQuery := &models.GetTeamMembersQuery{
- OrgId: testOrgID,
- SignedInUser: testUser,
- TeamId: groupId,
- }
- err = sqlStore.GetTeamMembers(context.Background(), teamMembersQuery)
+ err = sqlStore.GetTeamMembers(context.Background(), getTeamMembersQuery)
require.NoError(t, err)
- // should not receive service account from query
- require.Equal(t, len(teamMembersQuery.Result), 1)
+ require.EqualValues(t, 0, len(getTeamMembersQuery.Result))
})
})
})
@@ -489,7 +499,7 @@ func TestIntegrationSQLStore_GetTeamMembers_ACFilter(t *testing.T) {
t.Skip("skipping integration test")
}
testOrgID := int64(2)
- userIds := make([]int64, 4)
+ userIds := make([]int64, 5)
// Seed 2 teams with 2 members
setup := func(store *SQLStore) {
@@ -498,12 +508,15 @@ func TestIntegrationSQLStore_GetTeamMembers_ACFilter(t *testing.T) {
team2, errCreateTeam := store.CreateTeam("group2 name", "test2@example.org", testOrgID)
require.NoError(t, errCreateTeam)
- for i := 0; i < 4; i++ {
+ for i := 0; i < 5; i++ {
userCmd := user.CreateUserCommand{
Email: fmt.Sprint("user", i, "@example.org"),
Name: fmt.Sprint("user", i),
Login: fmt.Sprint("loginuser", i),
}
+ if i >= 3 {
+ userCmd.IsServiceAccount = true
+ }
user, errCreateUser := store.CreateUser(context.Background(), userCmd)
require.NoError(t, errCreateUser)
userIds[i] = user.ID
@@ -517,6 +530,8 @@ func TestIntegrationSQLStore_GetTeamMembers_ACFilter(t *testing.T) {
require.NoError(t, errAddMember)
errAddMember = store.AddTeamMember(userIds[3], testOrgID, team2.Id, false, 0)
require.NoError(t, errAddMember)
+ errAddMember = store.AddTeamMember(userIds[4], testOrgID, team2.Id, false, 0)
+ require.NoError(t, errAddMember)
}
store := InitTestDB(t, InitTestDBOpt{})
@@ -534,11 +549,14 @@ func TestIntegrationSQLStore_GetTeamMembers_ACFilter(t *testing.T) {
query: &models.GetTeamMembersQuery{
OrgId: testOrgID,
SignedInUser: &models.SignedInUser{
- OrgId: testOrgID,
- Permissions: map[int64]map[string][]string{testOrgID: {ac.ActionOrgUsersRead: {ac.ScopeUsersAll}}},
+ OrgId: testOrgID,
+ Permissions: map[int64]map[string][]string{testOrgID: {
+ ac.ActionOrgUsersRead: {ac.ScopeUsersAll},
+ serviceaccounts.ActionRead: {serviceaccounts.ScopeAll},
+ }},
},
},
- expectedNumUsers: 4,
+ expectedNumUsers: 5,
},
{
desc: "should return no team members",
@@ -558,11 +576,15 @@ func TestIntegrationSQLStore_GetTeamMembers_ACFilter(t *testing.T) {
OrgId: testOrgID,
SignedInUser: &models.SignedInUser{
OrgId: testOrgID,
- Permissions: map[int64]map[string][]string{testOrgID: {ac.ActionOrgUsersRead: {
- ac.Scope("users", "id", fmt.Sprintf("%d", userIds[0])),
- ac.Scope("users", "id", fmt.Sprintf("%d", userIds[2])),
- ac.Scope("users", "id", fmt.Sprintf("%d", userIds[3])),
- }}},
+ Permissions: map[int64]map[string][]string{testOrgID: {
+ ac.ActionOrgUsersRead: {
+ ac.Scope("users", "id", fmt.Sprintf("%d", userIds[0])),
+ ac.Scope("users", "id", fmt.Sprintf("%d", userIds[2])),
+ },
+ serviceaccounts.ActionRead: {
+ ac.Scope("serviceaccounts", "id", fmt.Sprintf("%d", userIds[3])),
+ },
+ }},
},
},
expectedNumUsers: 3,
@@ -576,10 +598,20 @@ func TestIntegrationSQLStore_GetTeamMembers_ACFilter(t *testing.T) {
if !hasWildcardScope(tt.query.SignedInUser, ac.ActionOrgUsersRead) {
for _, member := range tt.query.Result {
- assert.Contains(t,
- tt.query.SignedInUser.Permissions[tt.query.SignedInUser.OrgId][ac.ActionOrgUsersRead],
- ac.Scope("users", "id", fmt.Sprintf("%d", member.UserId)),
- )
+ hasPermission := false
+ for _, scope := range tt.query.SignedInUser.Permissions[tt.query.SignedInUser.OrgId][ac.ActionOrgUsersRead] {
+ if scope == ac.Scope("users", "id", fmt.Sprintf("%d", member.UserId)) {
+ hasPermission = true
+ break
+ }
+ }
+ for _, scope := range tt.query.SignedInUser.Permissions[tt.query.SignedInUser.OrgId][serviceaccounts.ActionRead] {
+ if scope == ac.Scope("serviceaccounts", "id", fmt.Sprintf("%d", member.UserId)) {
+ hasPermission = true
+ break
+ }
+ }
+ assert.True(t, hasPermission)
}
}
})
diff --git a/pkg/services/store/config.go b/pkg/services/store/config.go
index cc65c201b69..3864397674d 100644
--- a/pkg/services/store/config.go
+++ b/pkg/services/store/config.go
@@ -1,9 +1,10 @@
package store
type RootStorageConfig struct {
- Type string `json:"type"`
- Prefix string `json:"prefix"`
- Name string `json:"name"`
+ Type string `json:"type"`
+ Prefix string `json:"prefix"`
+ Name string `json:"name"`
+ Description string `json:"description"`
// Depending on type, these will be configured
Disk *StorageLocalDiskConfig `json:"disk,omitempty"`
diff --git a/pkg/services/store/http.go b/pkg/services/store/http.go
index 413d5aa6fed..bdbb634a161 100644
--- a/pkg/services/store/http.go
+++ b/pkg/services/store/http.go
@@ -2,12 +2,14 @@ package store
import (
"errors"
+ "fmt"
"io/ioutil"
"net/http"
"strings"
"github.com/grafana/grafana/pkg/api/response"
"github.com/grafana/grafana/pkg/models"
+ "github.com/grafana/grafana/pkg/util"
"github.com/grafana/grafana/pkg/web"
)
@@ -57,7 +59,8 @@ func (s *httpStorage) Upload(c *models.ReqContext) response.Response {
}
c.Req.Body = http.MaxBytesReader(c.Resp, c.Req.Body, MAX_UPLOAD_SIZE)
if err := c.Req.ParseMultipartForm(MAX_UPLOAD_SIZE); err != nil {
- return response.Error(400, "Please limit file uploaded under 1MB", err)
+ msg := fmt.Sprintf("Please limit file uploaded under %s", util.ByteCountSI(MAX_UPLOAD_SIZE))
+ return response.Error(400, msg, err)
}
files := c.Req.MultipartForm.File["file"]
@@ -92,7 +95,7 @@ func (s *httpStorage) Upload(c *models.ReqContext) response.Response {
return errFileTooBig
}
- path := RootUpload + "/" + fileHeader.Filename
+ path := RootResources + "/" + fileHeader.Filename
mimeType := http.DetectContentType(data)
diff --git a/pkg/services/store/service.go b/pkg/services/store/service.go
index 8be2bddb2a8..be879f00133 100644
--- a/pkg/services/store/service.go
+++ b/pkg/services/store/service.go
@@ -6,7 +6,6 @@ import (
"fmt"
"strings"
- "github.com/grafana/grafana-plugin-sdk-go/data"
"github.com/grafana/grafana/pkg/infra/filestorage"
"github.com/grafana/grafana/pkg/infra/log"
"github.com/grafana/grafana/pkg/models"
@@ -26,15 +25,15 @@ var ErrValidationFailed = errors.New("request validation failed")
var ErrFileAlreadyExists = errors.New("file exists")
const RootPublicStatic = "public-static"
-const RootUpload = "upload"
+const RootResources = "resources"
-const MAX_UPLOAD_SIZE = 1024 * 1024 // 1MB
+const MAX_UPLOAD_SIZE = 3 * 1024 * 1024 // 3MB
type StorageService interface {
registry.BackgroundService
// List folder contents
- List(ctx context.Context, user *models.SignedInUser, path string) (*data.Frame, error)
+ List(ctx context.Context, user *models.SignedInUser, path string) (*StorageListFrame, error)
// Read raw file contents out of the store
Read(ctx context.Context, user *models.SignedInUser, path string) (*filestorage.File, error)
@@ -60,21 +59,25 @@ func ProvideService(sql *sqlstore.SQLStore, features featuremgmt.FeatureToggles,
Path: cfg.StaticRootPath,
Roots: []string{
"/testdata/",
- // "/img/icons/",
- // "/img/bg/",
"/img/",
"/gazetteer/",
"/maps/",
},
- }).setReadOnly(true).setBuiltin(true),
+ }).setReadOnly(true).setBuiltin(true).
+ setDescription("Access files from the static public files"),
}
initializeOrgStorages := func(orgId int64) []storageRuntime {
storages := make([]storageRuntime, 0)
if features.IsEnabled(featuremgmt.FlagStorageLocalUpload) {
- config := &StorageSQLConfig{orgId: orgId}
- storages = append(storages, newSQLStorage(RootUpload, "Local file upload", config, sql).setBuiltin(true))
+ storages = append(storages,
+ newSQLStorage(RootResources,
+ "Resources",
+ &StorageSQLConfig{orgId: orgId}, sql).
+ setBuiltin(true).
+ setDescription("Upload custom resource files"))
}
+
return storages
}
@@ -110,7 +113,7 @@ func getOrgId(user *models.SignedInUser) int64 {
return user.OrgId
}
-func (s *standardStorageService) List(ctx context.Context, user *models.SignedInUser, path string) (*data.Frame, error) {
+func (s *standardStorageService) List(ctx context.Context, user *models.SignedInUser, path string) (*StorageListFrame, error) {
// apply access control here
return s.tree.ListFolder(ctx, getOrgId(user), path)
}
@@ -133,16 +136,16 @@ type UploadRequest struct {
}
func (s *standardStorageService) Upload(ctx context.Context, user *models.SignedInUser, req *UploadRequest) error {
- upload, _ := s.tree.getRoot(getOrgId(user), RootUpload)
+ upload, _ := s.tree.getRoot(getOrgId(user), RootResources)
if upload == nil {
return ErrUploadFeatureDisabled
}
- if !strings.HasPrefix(req.Path, RootUpload+"/") {
+ if !strings.HasPrefix(req.Path, RootResources+"/") {
return ErrUnsupportedStorage
}
- storagePath := strings.TrimPrefix(req.Path, RootUpload)
+ storagePath := strings.TrimPrefix(req.Path, RootResources)
validationResult := s.validateUploadRequest(ctx, user, req, storagePath)
if !validationResult.ok {
grafanaStorageLogger.Warn("file upload validation failed", "filetype", req.MimeType, "path", req.Path, "reason", validationResult.reason)
@@ -178,7 +181,7 @@ func (s *standardStorageService) Upload(ctx context.Context, user *models.Signed
}
func (s *standardStorageService) Delete(ctx context.Context, user *models.SignedInUser, path string) error {
- upload, _ := s.tree.getRoot(getOrgId(user), RootUpload)
+ upload, _ := s.tree.getRoot(getOrgId(user), RootResources)
if upload == nil {
return fmt.Errorf("upload feature is not enabled")
}
diff --git a/pkg/services/store/service_test.go b/pkg/services/store/service_test.go
index 073f135cb3b..9dba7282639 100644
--- a/pkg/services/store/service_test.go
+++ b/pkg/services/store/service_test.go
@@ -43,15 +43,15 @@ func TestListFiles(t *testing.T) {
frame, err := store.List(context.Background(), dummyUser, "public/testdata")
require.NoError(t, err)
- experimental.CheckGoldenJSONFrame(t, "testdata", "public_testdata.golden", frame, true)
+ experimental.CheckGoldenJSONFrame(t, "testdata", "public_testdata.golden", frame.Frame, true)
file, err := store.Read(context.Background(), dummyUser, "public/testdata/js_libraries.csv")
require.NoError(t, err)
require.NotNil(t, file)
- frame, err = testdatasource.LoadCsvContent(bytes.NewReader(file.Contents), file.Name)
+ testDsFrame, err := testdatasource.LoadCsvContent(bytes.NewReader(file.Contents), file.Name)
require.NoError(t, err)
- experimental.CheckGoldenJSONFrame(t, "testdata", "public_testdata_js_libraries.golden", frame, true)
+ experimental.CheckGoldenJSONFrame(t, "testdata", "public_testdata_js_libraries.golden", testDsFrame, true)
}
func TestUpload(t *testing.T) {
@@ -63,7 +63,7 @@ func TestUpload(t *testing.T) {
request := UploadRequest{
EntityType: EntityTypeImage,
Contents: make([]byte, 0),
- Path: "upload/myFile.jpg",
+ Path: "resources/myFile.jpg",
MimeType: "image/jpg",
}
err = s.Upload(context.Background(), dummyUser, &request)
diff --git a/pkg/services/store/testdata/example_list_frame.json b/pkg/services/store/testdata/example_list_frame.json
new file mode 100644
index 00000000000..92814399aa8
--- /dev/null
+++ b/pkg/services/store/testdata/example_list_frame.json
@@ -0,0 +1,73 @@
+{
+ "schema": {
+ "meta": {
+ "type": "directory-listing",
+ "custom": {
+ "HasMore": false
+ }
+ },
+ "fields": [
+ {
+ "name": "name",
+ "type": "string",
+ "typeInfo": {
+ "frame": "string"
+ }
+ },
+ {
+ "name": "mediaType",
+ "type": "string",
+ "typeInfo": {
+ "frame": "string"
+ }
+ },
+ {
+ "name": "size",
+ "type": "number",
+ "typeInfo": {
+ "frame": "int64"
+ },
+ "config": {
+ "unit": "bytes"
+ }
+ }
+ ]
+ },
+ "data": {
+ "values": [
+ [
+ "DL_1.jpg",
+ "Screen Shot 2022-06-23 at 9.05.39 PM.png",
+ "Screen Shot 2022-06-24 at 11.58.32 AM.png",
+ "Screen Shot 2022-06-30 at 3.45.03 PM.png",
+ "Screen Shot 2022-07-05 at 3.24.27 PM.png",
+ "image.png",
+ "rocket_1f680.png",
+ "test-folder",
+ "topcoder12.png"
+ ],
+ [
+ "image/jpeg",
+ "image/png",
+ "image/png",
+ "image/png",
+ "image/png",
+ "image/png",
+ "image/png",
+ "directory",
+ "image/png"
+ ],
+ [
+ 943004,
+ 684257,
+ 256396,
+ 8796,
+ 388290,
+ 182568,
+ 29066,
+ 0,
+ 90563
+ ]
+ ]
+ }
+}
diff --git a/pkg/services/store/testdata/example_root_level_list.json b/pkg/services/store/testdata/example_root_level_list.json
new file mode 100644
index 00000000000..1846b25b29e
--- /dev/null
+++ b/pkg/services/store/testdata/example_root_level_list.json
@@ -0,0 +1,90 @@
+{
+ "schema": {
+ "meta": {
+ "type": "directory-listing"
+ },
+ "fields": [
+ {
+ "name": "name",
+ "type": "string",
+ "typeInfo": {
+ "frame": "string"
+ }
+ },
+ {
+ "name": "title",
+ "type": "string",
+ "typeInfo": {
+ "frame": "string"
+ }
+ },
+ {
+ "name": "description",
+ "type": "string",
+ "typeInfo": {
+ "frame": "string"
+ }
+ },
+ {
+ "name": "mediaType",
+ "type": "string",
+ "typeInfo": {
+ "frame": "string"
+ }
+ },
+ {
+ "name": "storageType",
+ "type": "string",
+ "typeInfo": {
+ "frame": "string"
+ }
+ },
+ {
+ "name": "readOnly",
+ "type": "boolean",
+ "typeInfo": {
+ "frame": "bool"
+ }
+ },
+ {
+ "name": "builtIn",
+ "type": "boolean",
+ "typeInfo": {
+ "frame": "bool"
+ }
+ }
+ ]
+ },
+ "data": {
+ "values": [
+ [
+ "public-static",
+ "resources"
+ ],
+ [
+ "Public static files",
+ "Resources"
+ ],
+ [
+ "Access files from the static public files",
+ "Upload custom resource files"
+ ],
+ [
+ "directory",
+ "directory"
+ ],
+ [
+ "disk",
+ "sql"
+ ],
+ [
+ true,
+ false
+ ],
+ [
+ true,
+ true
+ ]
+ ]
+ }
+}
diff --git a/pkg/services/store/tree.go b/pkg/services/store/tree.go
index 47ebf5ab9e5..24f32377dbd 100644
--- a/pkg/services/store/tree.go
+++ b/pkg/services/store/tree.go
@@ -85,39 +85,60 @@ func (t *nestedTree) GetFile(ctx context.Context, orgId int64, path string) (*fi
return root.Get(ctx, path)
}
-func (t *nestedTree) ListFolder(ctx context.Context, orgId int64, path string) (*data.Frame, error) {
+func (t *nestedTree) ListFolder(ctx context.Context, orgId int64, path string) (*StorageListFrame, error) {
if path == "" || path == "/" {
t.assureOrgIsInitialized(orgId)
+ idx := 0
count := len(t.rootsByOrgId[ac.GlobalOrgID])
if orgId != ac.GlobalOrgID {
count += len(t.rootsByOrgId[orgId])
}
- title := data.NewFieldFromFieldType(data.FieldTypeString, count)
names := data.NewFieldFromFieldType(data.FieldTypeString, count)
+ title := data.NewFieldFromFieldType(data.FieldTypeString, count)
+ descr := data.NewFieldFromFieldType(data.FieldTypeString, count)
+ types := data.NewFieldFromFieldType(data.FieldTypeString, count)
+ readOnly := data.NewFieldFromFieldType(data.FieldTypeBool, count)
+ builtIn := data.NewFieldFromFieldType(data.FieldTypeBool, count)
mtype := data.NewFieldFromFieldType(data.FieldTypeString, count)
- title.Name = "title"
- names.Name = "name"
- mtype.Name = "mediaType"
- for i, f := range t.rootsByOrgId[ac.GlobalOrgID] {
- names.Set(i, f.Meta().Config.Prefix)
- title.Set(i, f.Meta().Config.Name)
- mtype.Set(i, "directory")
+ title.Name = titleListFrameField
+ names.Name = nameListFrameField
+ descr.Name = descriptionListFrameField
+ mtype.Name = mediaTypeListFrameField
+ types.Name = storageTypeListFrameField
+ readOnly.Name = readOnlyListFrameField
+ builtIn.Name = builtInListFrameField
+ for _, f := range t.rootsByOrgId[ac.GlobalOrgID] {
+ meta := f.Meta()
+ names.Set(idx, meta.Config.Prefix)
+ title.Set(idx, meta.Config.Name)
+ descr.Set(idx, meta.Config.Description)
+ mtype.Set(idx, "directory")
+ types.Set(idx, meta.Config.Type)
+ readOnly.Set(idx, meta.ReadOnly)
+ builtIn.Set(idx, meta.Builtin)
+ idx++
}
if orgId != ac.GlobalOrgID {
- for i, f := range t.rootsByOrgId[orgId] {
- names.Set(i, f.Meta().Config.Prefix)
- title.Set(i, f.Meta().Config.Name)
- mtype.Set(i, "directory")
+ for _, f := range t.rootsByOrgId[orgId] {
+ meta := f.Meta()
+ names.Set(idx, meta.Config.Prefix)
+ title.Set(idx, meta.Config.Name)
+ descr.Set(idx, meta.Config.Description)
+ mtype.Set(idx, "directory")
+ types.Set(idx, meta.Config.Type)
+ readOnly.Set(idx, meta.ReadOnly)
+ builtIn.Set(idx, meta.Builtin)
+ idx++
}
}
- frame := data.NewFrame("", names, title, mtype)
+ frame := data.NewFrame("", names, title, descr, mtype, types, readOnly, builtIn)
frame.SetMeta(&data.FrameMeta{
Type: data.FrameTypeDirectoryListing,
})
- return frame, nil
+ return &StorageListFrame{frame}, nil
}
root, path := t.getRoot(orgId, path)
@@ -125,7 +146,11 @@ func (t *nestedTree) ListFolder(ctx context.Context, orgId int64, path string) (
return nil, nil // not found (or not ready)
}
- listResponse, err := root.List(ctx, path, nil, &filestorage.ListOptions{Recursive: false, WithFolders: true, WithFiles: true})
+ listResponse, err := root.List(ctx, path, nil, &filestorage.ListOptions{
+ Recursive: false,
+ WithFolders: true,
+ WithFiles: true,
+ })
if err != nil {
return nil, err
@@ -135,9 +160,9 @@ func (t *nestedTree) ListFolder(ctx context.Context, orgId int64, path string) (
names := data.NewFieldFromFieldType(data.FieldTypeString, count)
mtype := data.NewFieldFromFieldType(data.FieldTypeString, count)
fsize := data.NewFieldFromFieldType(data.FieldTypeInt64, count)
- names.Name = "name"
- mtype.Name = "mediaType"
- fsize.Name = "size"
+ names.Name = nameListFrameField
+ mtype.Name = mediaTypeListFrameField
+ fsize.Name = sizeListFrameField
fsize.Config = &data.FieldConfig{
Unit: "bytes",
}
@@ -153,5 +178,5 @@ func (t *nestedTree) ListFolder(ctx context.Context, orgId int64, path string) (
"HasMore": listResponse.HasMore,
},
})
- return frame, nil
+ return &StorageListFrame{frame}, nil
}
diff --git a/pkg/services/store/types.go b/pkg/services/store/types.go
index 6acd3ad7e65..db9cdfa8202 100644
--- a/pkg/services/store/types.go
+++ b/pkg/services/store/types.go
@@ -30,7 +30,7 @@ type WriteValueResponse struct {
type storageTree interface {
GetFile(ctx context.Context, orgId int64, path string) (*filestorage.File, error)
- ListFolder(ctx context.Context, orgId int64, path string) (*data.Frame, error)
+ ListFolder(ctx context.Context, orgId int64, path string) (*StorageListFrame, error)
}
//-------------------------------------------
@@ -82,6 +82,11 @@ func (t *baseStorageRuntime) setBuiltin(val bool) *baseStorageRuntime {
return t
}
+func (t *baseStorageRuntime) setDescription(v string) *baseStorageRuntime {
+ t.meta.Config.Description = v
+ return t
+}
+
type RootStorageMeta struct {
ReadOnly bool `json:"editable,omitempty"`
Builtin bool `json:"builtin,omitempty"`
@@ -90,3 +95,38 @@ type RootStorageMeta struct {
Config RootStorageConfig `json:"config"`
}
+
+type StorageListFrame struct {
+ *data.Frame
+}
+
+const (
+ titleListFrameField = "title"
+ nameListFrameField = "name"
+ descriptionListFrameField = "description"
+ mediaTypeListFrameField = "mediaType"
+ storageTypeListFrameField = "storageType"
+ readOnlyListFrameField = "readOnly"
+ builtInListFrameField = "builtIn"
+ sizeListFrameField = "size"
+)
+
+func (s *StorageListFrame) GetFileNames() []string {
+ var fileNames []string
+ if s == nil {
+ return fileNames
+ }
+
+ field, idx := s.FieldByName(nameListFrameField)
+ if field.Len() == 0 || idx == -1 {
+ return fileNames
+ }
+
+ for i := 0; i < field.Len(); i++ {
+ if stringValue, ok := field.At(i).(string); ok {
+ fileNames = append(fileNames, stringValue)
+ }
+ }
+
+ return fileNames
+}
diff --git a/pkg/services/store/types_test.go b/pkg/services/store/types_test.go
new file mode 100644
index 00000000000..3374c04aed8
--- /dev/null
+++ b/pkg/services/store/types_test.go
@@ -0,0 +1,47 @@
+package store
+
+import (
+ _ "embed"
+ "testing"
+
+ "github.com/grafana/grafana-plugin-sdk-go/data"
+ "github.com/stretchr/testify/require"
+)
+
+var (
+ //go:embed testdata/example_list_frame.json
+ exampleListFrameJSON string
+
+ //go:embed testdata/example_root_level_list.json
+ exampleRootLevelListJSON string
+)
+
+func TestGetFileNames(t *testing.T) {
+ frame := &data.Frame{}
+ err := frame.UnmarshalJSON([]byte(exampleListFrameJSON))
+ require.NoError(t, err)
+
+ listFrame := StorageListFrame{frame}
+ require.Equal(t, []string{
+ "DL_1.jpg",
+ "Screen Shot 2022-06-23 at 9.05.39 PM.png",
+ "Screen Shot 2022-06-24 at 11.58.32 AM.png",
+ "Screen Shot 2022-06-30 at 3.45.03 PM.png",
+ "Screen Shot 2022-07-05 at 3.24.27 PM.png",
+ "image.png", "rocket_1f680.png",
+ "test-folder",
+ "topcoder12.png",
+ }, listFrame.GetFileNames())
+}
+
+func TestGetFileNamesRootLevel(t *testing.T) {
+ frame := &data.Frame{}
+ err := frame.UnmarshalJSON([]byte(exampleRootLevelListJSON))
+ require.NoError(t, err)
+
+ listFrame := StorageListFrame{frame}
+ require.Equal(t, []string{
+ "public-static",
+ "resources",
+ }, listFrame.GetFileNames())
+}
diff --git a/pkg/tests/api/alerting/api_provisioning_test.go b/pkg/tests/api/alerting/api_provisioning_test.go
index fb1a02df474..f4d78dde729 100644
--- a/pkg/tests/api/alerting/api_provisioning_test.go
+++ b/pkg/tests/api/alerting/api_provisioning_test.go
@@ -44,13 +44,32 @@ func TestProvisioning(t *testing.T) {
url := fmt.Sprintf("http://%s/api/v1/provisioning/policies", grafanaListedAddr)
body := `
{
- "receiver": "grafana-default-email",
+ "receiver": "test-receiver",
"group_by": [
"..."
],
"routes": []
}`
+ // As we check if the receiver exists that is referenced in the policy,
+ // we first need to create it, so the tests passes correctly.
+ urlReceiver := fmt.Sprintf("http://%s/api/v1/provisioning/contact-points", grafanaListedAddr)
+ bodyReceiver := `
+ {
+ "name": "test-receiver",
+ "type": "slack",
+ "settings": {
+ "recipient": "value_recipient",
+ "token": "value_token"
+ }
+ }`
+
+ req := createTestRequest("POST", urlReceiver, "admin", bodyReceiver)
+ resp, err := http.DefaultClient.Do(req)
+ require.NoError(t, err)
+ require.NoError(t, resp.Body.Close())
+ require.Equal(t, 202, resp.StatusCode)
+
t.Run("un-authenticated GET should 401", func(t *testing.T) {
req := createTestRequest("GET", url, "", "")
@@ -127,7 +146,6 @@ func TestProvisioning(t *testing.T) {
resp, err := http.DefaultClient.Do(req)
require.NoError(t, err)
require.NoError(t, resp.Body.Close())
-
require.Equal(t, 202, resp.StatusCode)
})
})
diff --git a/pkg/tests/testinfra/testinfra.go b/pkg/tests/testinfra/testinfra.go
index 1213bf8bba5..cae8ee96d75 100644
--- a/pkg/tests/testinfra/testinfra.go
+++ b/pkg/tests/testinfra/testinfra.go
@@ -267,6 +267,12 @@ func CreateGrafDir(t *testing.T, opts ...GrafanaOpts) (string, string) {
_, err = anonSect.NewKey("plugin_admin_enabled", "true")
require.NoError(t, err)
}
+ if o.PluginAdminExternalManageEnabled {
+ anonSect, err := cfg.NewSection("plugins")
+ require.NoError(t, err)
+ _, err = anonSect.NewKey("plugin_admin_external_manage_enabled", "true")
+ require.NoError(t, err)
+ }
if o.ViewersCanEdit {
usersSection, err := cfg.NewSection("users")
require.NoError(t, err)
@@ -322,6 +328,7 @@ type GrafanaOpts struct {
CatalogAppEnabled bool
ViewersCanEdit bool
PluginAdminEnabled bool
+ PluginAdminExternalManageEnabled bool
AppModeProduction bool
DisableLegacyAlerting bool
EnableUnifiedAlerting bool
diff --git a/pkg/tsdb/grafanads/grafana.go b/pkg/tsdb/grafanads/grafana.go
index 129f3ea875d..a1011f39962 100644
--- a/pkg/tsdb/grafanads/grafana.go
+++ b/pkg/tsdb/grafanads/grafana.go
@@ -109,10 +109,10 @@ func (s *Service) doListQuery(ctx context.Context, query backend.DataQuery) back
}
path := store.RootPublicStatic + "/" + q.Path
- frame, err := s.store.List(ctx, nil, path)
+ listFrame, err := s.store.List(ctx, nil, path)
response.Error = err
- if frame != nil {
- response.Frames = data.Frames{frame}
+ if listFrame != nil {
+ response.Frames = data.Frames{listFrame.Frame}
}
return response
}
diff --git a/pkg/util/strings.go b/pkg/util/strings.go
index e066ca5c2bf..1cacce669ef 100644
--- a/pkg/util/strings.go
+++ b/pkg/util/strings.go
@@ -117,3 +117,17 @@ func Capitalize(s string) string {
r[0] = unicode.ToUpper(r[0])
return string(r)
}
+
+func ByteCountSI(b int64) string {
+ const unit = 1000
+ if b < unit {
+ return fmt.Sprintf("%d B", b)
+ }
+ div, exp := int64(unit), 0
+ for n := b / unit; n >= unit; n /= unit {
+ div *= unit
+ exp++
+ }
+ return fmt.Sprintf("%.1f %cB",
+ float64(b)/float64(div), "kMGTPE"[exp])
+}
diff --git a/public/app/AppWrapper.tsx b/public/app/AppWrapper.tsx
index 2b8efc69b88..14ade91ddf7 100644
--- a/public/app/AppWrapper.tsx
+++ b/public/app/AppWrapper.tsx
@@ -12,6 +12,7 @@ import { store } from 'app/store/store';
import { AngularRoot } from './angular/AngularRoot';
import { loadAndInitAngularIfEnabled } from './angular/loadAndInitAngularIfEnabled';
import { GrafanaApp } from './app';
+import { AppChrome } from './core/components/AppChrome/AppChrome';
import { AppNotificationList } from './core/components/AppNotifications/AppNotificationList';
import { NavBar } from './core/components/NavBar/NavBar';
import { I18nProvider } from './core/localisation';
@@ -125,7 +126,7 @@ export class AppWrapper extends React.ComponentSpan bar label
+
+ Span bar label lets you add additional info to the span bar row.
+
+
+
+ {megaMenuOpen &&
{!searchBarHidden &&
{children}
-
-
-
{actions}
diff --git a/public/app/core/components/TopNav/TopSearchBar.tsx b/public/app/core/components/AppChrome/TopSearchBar.tsx
similarity index 100%
rename from public/app/core/components/TopNav/TopSearchBar.tsx
rename to public/app/core/components/AppChrome/TopSearchBar.tsx
diff --git a/public/app/core/components/AppChrome/types.ts b/public/app/core/components/AppChrome/types.ts
new file mode 100644
index 00000000000..654334fdea6
--- /dev/null
+++ b/public/app/core/components/AppChrome/types.ts
@@ -0,0 +1,8 @@
+import { NavModelItem } from '@grafana/data';
+
+export const TOP_BAR_LEVEL_HEIGHT = 40;
+
+export interface ToolbarUpdateProps {
+ pageNav?: NavModelItem;
+ actions?: React.ReactNode;
+}
diff --git a/public/app/core/components/ErrorPage/ErrorPage.tsx b/public/app/core/components/ErrorPage/ErrorPage.tsx
index 8fe3e4c645e..25e77912f6c 100644
--- a/public/app/core/components/ErrorPage/ErrorPage.tsx
+++ b/public/app/core/components/ErrorPage/ErrorPage.tsx
@@ -7,7 +7,7 @@ import { Icon } from '@grafana/ui';
import { getNavModel } from 'app/core/selectors/navModel';
import { StoreState } from 'app/types';
-import Page from '../Page/Page';
+import { Page } from '../Page/Page';
interface ConnectedProps {
navModel: NavModel;
diff --git a/public/app/core/components/MegaMenu/MegaMenu.test.tsx b/public/app/core/components/MegaMenu/MegaMenu.test.tsx
new file mode 100644
index 00000000000..04283424de5
--- /dev/null
+++ b/public/app/core/components/MegaMenu/MegaMenu.test.tsx
@@ -0,0 +1,61 @@
+import { render, screen } from '@testing-library/react';
+import React from 'react';
+import { Provider } from 'react-redux';
+import { Router } from 'react-router-dom';
+
+import { NavModelItem, NavSection } from '@grafana/data';
+import { locationService } from '@grafana/runtime';
+import { configureStore } from 'app/store/configureStore';
+
+import TestProvider from '../../../../test/helpers/TestProvider';
+
+import { MegaMenu } from './MegaMenu';
+
+const setup = () => {
+ const navBarTree: NavModelItem[] = [
+ {
+ text: 'Section name',
+ section: NavSection.Core,
+ id: 'section',
+ url: 'section',
+ children: [
+ { text: 'Child1', id: 'child1', url: 'section/child1' },
+ { text: 'Child2', id: 'child2', url: 'section/child2' },
+ ],
+ },
+ {
+ text: 'Profile',
+ id: 'profile',
+ section: NavSection.Config,
+ url: 'profile',
+ },
+ ];
+
+ const store = configureStore({ navBarTree });
+
+ return render(
+
+
+ );
+});
+
+MegaMenu.displayName = 'MegaMenu';
+
+const getStyles = (theme: GrafanaTheme2) => ({
+ menuWrapper: css({
+ position: 'fixed',
+ display: 'grid',
+ gridAutoFlow: 'column',
+ height: '100%',
+ zIndex: theme.zIndex.sidemenu,
+ }),
+});
diff --git a/public/app/core/components/MegaMenu/NavBarMenu.tsx b/public/app/core/components/MegaMenu/NavBarMenu.tsx
new file mode 100644
index 00000000000..2b2df363de4
--- /dev/null
+++ b/public/app/core/components/MegaMenu/NavBarMenu.tsx
@@ -0,0 +1,211 @@
+import { css } from '@emotion/css';
+import { useDialog } from '@react-aria/dialog';
+import { FocusScope } from '@react-aria/focus';
+import { OverlayContainer, useOverlay } from '@react-aria/overlays';
+import React, { useRef } from 'react';
+import CSSTransition from 'react-transition-group/CSSTransition';
+
+import { GrafanaTheme2, NavModelItem } from '@grafana/data';
+import { reportInteraction } from '@grafana/runtime';
+import { CustomScrollbar, Icon, IconButton, useTheme2 } from '@grafana/ui';
+
+import { TOP_BAR_LEVEL_HEIGHT } from '../AppChrome/types';
+import { NavItem } from '../NavBar/NavBarMenu';
+import { NavBarToggle } from '../NavBar/NavBarToggle';
+
+const MENU_WIDTH = '350px';
+
+export interface Props {
+ activeItem?: NavModelItem;
+ navItems: NavModelItem[];
+ searchBarHidden?: boolean;
+ onClose: () => void;
+}
+
+export function NavBarMenu({ activeItem, navItems, searchBarHidden, onClose }: Props) {
+ const theme = useTheme2();
+ const styles = getStyles(theme, searchBarHidden);
+ const animationSpeed = theme.transitions.duration.shortest;
+ const animStyles = getAnimStyles(theme, animationSpeed);
+ const ref = useRef(null);
+ const { dialogProps } = useDialog({}, ref);
+
+ const { overlayProps, underlayProps } = useOverlay(
+ {
+ isDismissable: true,
+ isOpen: true,
+ onClose,
+ },
+ ref
+ );
+
+ return (
+
+
+
+
+ Children
+
-
+
`;
diff --git a/public/app/features/folders/components/NewDashboardsFolder.tsx b/public/app/features/folders/components/NewDashboardsFolder.tsx
index 72617c8fbfe..cd387a79817 100644
--- a/public/app/features/folders/components/NewDashboardsFolder.tsx
+++ b/public/app/features/folders/components/NewDashboardsFolder.tsx
@@ -2,7 +2,7 @@ import React, { PureComponent } from 'react';
import { connect, ConnectedProps } from 'react-redux';
import { Button, Input, Form, Field } from '@grafana/ui';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { getNavModel } from 'app/core/selectors/navModel';
import { StoreState } from 'app/types';
diff --git a/public/app/features/invites/SignupInvited.tsx b/public/app/features/invites/SignupInvited.tsx
index 4d862d6377d..d12da280e07 100644
--- a/public/app/features/invites/SignupInvited.tsx
+++ b/public/app/features/invites/SignupInvited.tsx
@@ -3,7 +3,7 @@ import { useAsync } from 'react-use';
import { getBackendSrv } from '@grafana/runtime';
import { Button, Field, Form, Input } from '@grafana/ui';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { getConfig } from 'app/core/config';
import { contextSrv } from 'app/core/core';
import { GrafanaRouteComponentProps } from 'app/core/navigation/types';
diff --git a/public/app/features/library-panels/LibraryPanelsPage.tsx b/public/app/features/library-panels/LibraryPanelsPage.tsx
index 09342b0e5cf..af435231e7a 100644
--- a/public/app/features/library-panels/LibraryPanelsPage.tsx
+++ b/public/app/features/library-panels/LibraryPanelsPage.tsx
@@ -1,7 +1,8 @@
import React, { FC, useState } from 'react';
import { connect, ConnectedProps } from 'react-redux';
-import Page from '../../core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
+
import { GrafanaRouteComponentProps } from '../../core/navigation/types';
import { getNavModel } from '../../core/selectors/navModel';
import { StoreState } from '../../types';
diff --git a/public/app/features/live/pages/CloudAdminPage.tsx b/public/app/features/live/pages/CloudAdminPage.tsx
index fe3face9db2..449c4c06c33 100644
--- a/public/app/features/live/pages/CloudAdminPage.tsx
+++ b/public/app/features/live/pages/CloudAdminPage.tsx
@@ -4,7 +4,7 @@ import React, { useEffect, useState } from 'react';
import { GrafanaTheme } from '@grafana/data';
import { getBackendSrv } from '@grafana/runtime';
import { useStyles } from '@grafana/ui';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { useNavModel } from 'app/core/hooks/useNavModel';
import { GrafanaCloudBackend } from './types';
diff --git a/public/app/features/live/pages/FeatureTogglePage.tsx b/public/app/features/live/pages/FeatureTogglePage.tsx
index a1d3e635c5a..35b19509a05 100644
--- a/public/app/features/live/pages/FeatureTogglePage.tsx
+++ b/public/app/features/live/pages/FeatureTogglePage.tsx
@@ -1,6 +1,6 @@
import React from 'react';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { useNavModel } from 'app/core/hooks/useNavModel';
export default function FeatureTogglePage() {
diff --git a/public/app/features/live/pages/LiveStatusPage.tsx b/public/app/features/live/pages/LiveStatusPage.tsx
index 569853591af..485aacfe8d5 100644
--- a/public/app/features/live/pages/LiveStatusPage.tsx
+++ b/public/app/features/live/pages/LiveStatusPage.tsx
@@ -1,6 +1,6 @@
import React from 'react';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { useNavModel } from 'app/core/hooks/useNavModel';
export default function CloudAdminPage() {
diff --git a/public/app/features/live/pages/PipelineAdminPage.tsx b/public/app/features/live/pages/PipelineAdminPage.tsx
index 2face908dc6..7d33b38b595 100644
--- a/public/app/features/live/pages/PipelineAdminPage.tsx
+++ b/public/app/features/live/pages/PipelineAdminPage.tsx
@@ -2,7 +2,7 @@ import React, { useEffect, useState, ChangeEvent } from 'react';
import { getBackendSrv } from '@grafana/runtime';
import { Input } from '@grafana/ui';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { useNavModel } from 'app/core/hooks/useNavModel';
import { AddNewRule } from './AddNewRule';
diff --git a/public/app/features/manage-dashboards/DashboardImportPage.tsx b/public/app/features/manage-dashboards/DashboardImportPage.tsx
index 1085441536a..365a7eabd1b 100644
--- a/public/app/features/manage-dashboards/DashboardImportPage.tsx
+++ b/public/app/features/manage-dashboards/DashboardImportPage.tsx
@@ -20,7 +20,7 @@ import {
withTheme2,
} from '@grafana/ui';
import appEvents from 'app/core/app_events';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { GrafanaRouteComponentProps } from 'app/core/navigation/types';
import { getNavModel } from 'app/core/selectors/navModel';
import { StoreState } from 'app/types';
diff --git a/public/app/features/manage-dashboards/SnapshotListPage.tsx b/public/app/features/manage-dashboards/SnapshotListPage.tsx
index 5aa91777a34..ae16793ca0f 100644
--- a/public/app/features/manage-dashboards/SnapshotListPage.tsx
+++ b/public/app/features/manage-dashboards/SnapshotListPage.tsx
@@ -2,7 +2,7 @@ import React, { FC } from 'react';
import { MapStateToProps, connect } from 'react-redux';
import { NavModel } from '@grafana/data';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { getNavModel } from 'app/core/selectors/navModel';
import { StoreState } from 'app/types';
diff --git a/public/app/features/notifications/NotificationsPage.tsx b/public/app/features/notifications/NotificationsPage.tsx
index 04b6b192a23..22c64301384 100644
--- a/public/app/features/notifications/NotificationsPage.tsx
+++ b/public/app/features/notifications/NotificationsPage.tsx
@@ -1,7 +1,8 @@
import React from 'react';
import { connect, ConnectedProps } from 'react-redux';
-import Page from '../../core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
+
import { GrafanaRouteComponentProps } from '../../core/navigation/types';
import { getNavModel } from '../../core/selectors/navModel';
import { StoreState } from '../../types';
diff --git a/public/app/features/org/NewOrgPage.tsx b/public/app/features/org/NewOrgPage.tsx
index 34d2619110b..6a4fc75a490 100644
--- a/public/app/features/org/NewOrgPage.tsx
+++ b/public/app/features/org/NewOrgPage.tsx
@@ -2,7 +2,7 @@ import React, { FC } from 'react';
import { connect, ConnectedProps } from 'react-redux';
import { Button, Input, Field, Form } from '@grafana/ui';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { getConfig } from 'app/core/config';
import { StoreState } from 'app/types';
diff --git a/public/app/features/org/OrgDetailsPage.tsx b/public/app/features/org/OrgDetailsPage.tsx
index 5059ad5dd25..57c21a83a63 100644
--- a/public/app/features/org/OrgDetailsPage.tsx
+++ b/public/app/features/org/OrgDetailsPage.tsx
@@ -3,7 +3,7 @@ import { connect } from 'react-redux';
import { NavModel } from '@grafana/data';
import { VerticalGroup } from '@grafana/ui';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import SharedPreferences from 'app/core/components/SharedPreferences/SharedPreferences';
import { contextSrv } from 'app/core/core';
import { getNavModel } from 'app/core/selectors/navModel';
diff --git a/public/app/features/org/SelectOrgPage.tsx b/public/app/features/org/SelectOrgPage.tsx
index 273f699cc65..2d39f619074 100644
--- a/public/app/features/org/SelectOrgPage.tsx
+++ b/public/app/features/org/SelectOrgPage.tsx
@@ -4,7 +4,7 @@ import { useEffectOnce } from 'react-use';
import { config } from '@grafana/runtime';
import { Button, HorizontalGroup } from '@grafana/ui';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { StoreState, UserOrg } from 'app/types';
import { getUserOrganizations, setUserOrganization } from './state/actions';
diff --git a/public/app/features/org/UserInvitePage.tsx b/public/app/features/org/UserInvitePage.tsx
index 8afa065a0b7..097ead15a32 100644
--- a/public/app/features/org/UserInvitePage.tsx
+++ b/public/app/features/org/UserInvitePage.tsx
@@ -2,7 +2,7 @@ import React, { FC } from 'react';
import { connect } from 'react-redux';
import { NavModel } from '@grafana/data';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { contextSrv } from 'app/core/core';
import { getNavModel } from 'app/core/selectors/navModel';
import { StoreState } from 'app/types/store';
diff --git a/public/app/features/playlist/PlaylistEditPage.tsx b/public/app/features/playlist/PlaylistEditPage.tsx
index c98ba7ee00d..24eb413ef12 100644
--- a/public/app/features/playlist/PlaylistEditPage.tsx
+++ b/public/app/features/playlist/PlaylistEditPage.tsx
@@ -4,7 +4,7 @@ import { connect, MapStateToProps } from 'react-redux';
import { NavModel } from '@grafana/data';
import { locationService } from '@grafana/runtime';
import { useStyles2 } from '@grafana/ui';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { getNavModel } from 'app/core/selectors/navModel';
import { StoreState } from 'app/types';
diff --git a/public/app/features/playlist/PlaylistNewPage.tsx b/public/app/features/playlist/PlaylistNewPage.tsx
index c08d288ec99..e7ef84960b8 100644
--- a/public/app/features/playlist/PlaylistNewPage.tsx
+++ b/public/app/features/playlist/PlaylistNewPage.tsx
@@ -4,7 +4,7 @@ import { connect, MapStateToProps } from 'react-redux';
import { NavModel } from '@grafana/data';
import { locationService } from '@grafana/runtime';
import { useStyles2 } from '@grafana/ui';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import { getNavModel } from 'app/core/selectors/navModel';
import { StoreState } from 'app/types';
diff --git a/public/app/features/playlist/PlaylistPage.tsx b/public/app/features/playlist/PlaylistPage.tsx
index 62e85085d2f..e8a997f0232 100644
--- a/public/app/features/playlist/PlaylistPage.tsx
+++ b/public/app/features/playlist/PlaylistPage.tsx
@@ -4,7 +4,7 @@ import { useDebounce } from 'react-use';
import { NavModel } from '@grafana/data';
import { ConfirmModal } from '@grafana/ui';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import PageActionBar from 'app/core/components/PageActionBar/PageActionBar';
import { getNavModel } from 'app/core/selectors/navModel';
import { contextSrv } from 'app/core/services/context_srv';
diff --git a/public/app/features/plugins/admin/routes.ts b/public/app/features/plugins/admin/routes.ts
index 02a54c1c6c8..53a573ccbf4 100644
--- a/public/app/features/plugins/admin/routes.ts
+++ b/public/app/features/plugins/admin/routes.ts
@@ -7,16 +7,19 @@ import { PluginAdminRoutes } from './types';
const DEFAULT_ROUTES = [
{
path: '/plugins',
+ navId: 'plugins',
routeName: PluginAdminRoutes.Home,
component: SafeDynamicImport(() => import(/* webpackChunkName: "PluginListPage" */ './pages/Browse')),
},
{
path: '/plugins/browse',
+ navId: 'plugins',
routeName: PluginAdminRoutes.Browse,
component: SafeDynamicImport(() => import(/* webpackChunkName: "PluginListPage" */ './pages/Browse')),
},
{
path: '/plugins/:pluginId/',
+ navId: 'plugins',
routeName: PluginAdminRoutes.Details,
component: SafeDynamicImport(() => import(/* webpackChunkName: "PluginPage" */ './pages/PluginDetails')),
},
@@ -25,16 +28,19 @@ const DEFAULT_ROUTES = [
const ADMIN_ROUTES = [
{
path: '/admin/plugins',
+ navId: 'admin-plugins',
routeName: PluginAdminRoutes.HomeAdmin,
component: SafeDynamicImport(() => import(/* webpackChunkName: "PluginListPage" */ './pages/Browse')),
},
{
path: '/admin/plugins/browse',
+ navId: 'admin-plugins',
routeName: PluginAdminRoutes.BrowseAdmin,
component: SafeDynamicImport(() => import(/* webpackChunkName: "PluginListPage" */ './pages/Browse')),
},
{
path: '/admin/plugins/:pluginId/',
+ navId: 'admin-plugins',
routeName: PluginAdminRoutes.DetailsAdmin,
component: SafeDynamicImport(() => import(/* webpackChunkName: "PluginPage" */ './pages/PluginDetails')),
},
diff --git a/public/app/features/plugins/components/AppPluginLoader.tsx b/public/app/features/plugins/components/AppPluginLoader.tsx
index fe263276930..37516513f1a 100644
--- a/public/app/features/plugins/components/AppPluginLoader.tsx
+++ b/public/app/features/plugins/components/AppPluginLoader.tsx
@@ -3,7 +3,7 @@ import { useLocation, useParams } from 'react-router-dom';
import { NavModel } from '@grafana/data';
import { getWarningNav } from 'app/angular/services/nav_model_srv';
-import Page from 'app/core/components/Page/Page';
+import { Page } from 'app/core/components/Page/Page';
import PageLoader from 'app/core/components/PageLoader/PageLoader';
import { useImportAppPlugin } from '../hooks/useImportAppPlugin';
@@ -23,13 +23,13 @@ export const AppPluginLoader = ({ id, basePath }: AppPluginLoaderProps) => {
const { pathname } = useLocation();
if (error) {
- return
- {navModel &&
@@ -48,12 +36,12 @@ export const Page: PageType = ({ navModel, children, className, ...otherProps })
);
};
-Page.Header = PageHeader;
-Page.Contents = PageContents;
+OldPage.Header = PageHeader;
+OldPage.Contents = PageContents;
-export default Page;
+export const Page: PageType = config.featureToggles.topnav ? NewPage : OldPage;
-const getStyles = (theme: GrafanaTheme2) => ({
+const getStyles = (_: GrafanaTheme2) => ({
wrapper: css`
width: 100%;
flex-grow: 1;
diff --git a/public/app/core/components/Page/types.ts b/public/app/core/components/Page/types.ts
new file mode 100644
index 00000000000..bc8340f22fc
--- /dev/null
+++ b/public/app/core/components/Page/types.ts
@@ -0,0 +1,19 @@
+import { FC, HTMLAttributes } from 'react';
+
+import { NavModel, NavModelItem } from '@grafana/data';
+
+import { PageHeader } from '../PageHeader/PageHeader';
+
+import { PageContents } from './PageContents';
+
+export interface PageProps extends HTMLAttributes
@@ -157,5 +155,3 @@ const getStyles = (theme: GrafanaTheme2) => ({
background: ${theme.colors.background.canvas};
`,
});
-
-export default PageHeader;
diff --git a/public/app/core/components/PageNew/Page.test.tsx b/public/app/core/components/PageNew/Page.test.tsx
new file mode 100644
index 00000000000..a28ecec2b7d
--- /dev/null
+++ b/public/app/core/components/PageNew/Page.test.tsx
@@ -0,0 +1,79 @@
+import { render, screen } from '@testing-library/react';
+import React from 'react';
+import { Provider } from 'react-redux';
+
+import { NavModelItem } from '@grafana/data';
+import { config } from '@grafana/runtime';
+import { configureStore } from 'app/store/configureStore';
+
+import { PageProps } from '../Page/types';
+
+import { Page } from './Page';
+
+const pageNav: NavModelItem = {
+ text: 'pageNav title',
+ children: [
+ { text: 'pageNav child1', url: '1', active: true },
+ { text: 'pageNav child2', url: '2' },
+ ],
+};
+
+const setup = (props: Partial
- {renderHeaderTitle(main)}
- {children && children.length &&
Children
+
+
+ );
+};
+
+Page.Header = PageHeader;
+Page.Contents = PageContents;
+
+const getStyles = (theme: GrafanaTheme2) => {
+ const shadow = theme.isDark
+ ? `0 0.6px 1.5px -1px rgb(0 0 0),0 2px 4px -1px rgb(0 0 0 / 40%),0 5px 10px -1px rgb(0 0 0 / 23%)`
+ : '0 0.6px 1.5px -1px rgb(0 0 0 / 8%),0 2px 4px rgb(0 0 0 / 6%),0 5px 10px -1px rgb(0 0 0 / 5%)';
+
+ return {
+ wrapper: css`
+ height: 100%;
+ display: flex;
+ flex: 1 1 0;
+ flex-direction: column;
+ min-height: 0;
+ `,
+ panes: css({
+ display: 'flex',
+ height: '100%',
+ width: '100%',
+ flexGrow: 1,
+ minHeight: 0,
+ flexDirection: 'column',
+ [theme.breakpoints.up('md')]: {
+ flexDirection: 'row',
+ },
+ }),
+ pageContent: css({
+ flexGrow: 1,
+ }),
+ pageInner: css({
+ padding: theme.spacing(3),
+ boxShadow: shadow,
+ background: theme.colors.background.primary,
+ margin: theme.spacing(2, 2, 2, 1),
+ display: 'flex',
+ flexDirection: 'column',
+ flexGrow: 1,
+ }),
+ };
+};
diff --git a/public/app/core/components/PageNew/PageContents.tsx b/public/app/core/components/PageNew/PageContents.tsx
new file mode 100644
index 00000000000..85a04fa295a
--- /dev/null
+++ b/public/app/core/components/PageNew/PageContents.tsx
@@ -0,0 +1,14 @@
+// Libraries
+import React, { FC } from 'react';
+
+import PageLoader from '../PageLoader/PageLoader';
+
+interface Props {
+ isLoading?: boolean;
+ children: React.ReactNode;
+ className?: string;
+}
+
+export const PageContents: FC
+ {navModel && navModel.main.children &&
+
+
+
+ {pageHeaderNav &&
+
+
+ {navItem.img &&
+ {navItem.subTitle && }
+ {navItem.text}
+
{navItem.subTitle}}
+
+ );
+}
+
+const getStyles = (theme: GrafanaTheme2) => {
+ return {
+ pageTitle: css({
+ display: 'flex',
+ marginBottom: theme.spacing(3),
+ }),
+ pageSubTitle: css({
+ marginBottom: theme.spacing(2),
+ position: 'relative',
+ top: theme.spacing(-1),
+ color: theme.colors.text.secondary,
+ }),
+ pageImg: css({
+ width: '32px',
+ height: '32px',
+ marginRight: theme.spacing(2),
+ }),
+ };
+};
diff --git a/public/app/core/components/PageNew/PageTabs.tsx b/public/app/core/components/PageNew/PageTabs.tsx
new file mode 100644
index 00000000000..d3fb3a73c9b
--- /dev/null
+++ b/public/app/core/components/PageNew/PageTabs.tsx
@@ -0,0 +1,42 @@
+import { css } from '@emotion/css';
+import React from 'react';
+
+import { NavModelItem, GrafanaTheme2 } from '@grafana/data';
+import { IconName, useStyles2, TabsBar, Tab } from '@grafana/ui';
+
+export interface Props {
+ navItem: NavModelItem;
+}
+
+export function PageTabs({ navItem }: Props) {
+ const styles = useStyles2(getStyles);
+
+ return (
+
+
+ );
+}
+
+const getStyles = (theme: GrafanaTheme2) => {
+ return {
+ tabsWrapper: css({
+ paddingBottom: theme.spacing(3),
+ }),
+ };
+};
diff --git a/public/app/core/components/PageNew/SectionNav.tsx b/public/app/core/components/PageNew/SectionNav.tsx
new file mode 100644
index 00000000000..3570de4294f
--- /dev/null
+++ b/public/app/core/components/PageNew/SectionNav.tsx
@@ -0,0 +1,92 @@
+import { css } from '@emotion/css';
+import React from 'react';
+
+import { NavModel, GrafanaTheme2 } from '@grafana/data';
+import { IconName, useStyles2, Icon, VerticalTab } from '@grafana/ui';
+
+export interface Props {
+ model: NavModel;
+}
+
+export function SectionNav(props: Props) {
+ const styles = useStyles2(getStyles);
+
+ const main = props.model.main;
+ const directChildren = props.model.main.children!.filter((x) => !x.hideFromTabs && !x.children);
+ const nestedItems = props.model.main.children!.filter((x) => x.children && x.children.length);
+
+ return (
+
+ );
+}
+
+const getStyles = (theme: GrafanaTheme2) => {
+ return {
+ nav: css({
+ display: 'flex',
+ flexDirection: 'column',
+ background: theme.colors.background.canvas,
+ padding: theme.spacing(3, 2),
+ flexShrink: 0,
+ [theme.breakpoints.up('md')]: {
+ width: '250px',
+ },
+ }),
+ sectionName: css({
+ display: 'flex',
+ gap: theme.spacing(1),
+ padding: theme.spacing(0.5, 0, 3, 0.25),
+ fontSize: theme.typography.h4.fontSize,
+ margin: 0,
+ }),
+ items: css({
+ // paddingLeft: '9px',
+ }),
+ subSection: css({
+ padding: theme.spacing(3, 0, 1, 1),
+ fontWeight: 500,
+ fontSize: '16px',
+ }),
+ };
+};
diff --git a/public/app/core/components/QueryOperationRow/QueryOperationRow.test.tsx b/public/app/core/components/QueryOperationRow/QueryOperationRow.test.tsx
index b046539d99f..2efdd6a2729 100644
--- a/public/app/core/components/QueryOperationRow/QueryOperationRow.test.tsx
+++ b/public/app/core/components/QueryOperationRow/QueryOperationRow.test.tsx
@@ -1,56 +1,44 @@
-import { mount, shallow } from 'enzyme';
+import { render, screen } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
import React from 'react';
-import { act } from 'react-dom/test-utils';
-import { QueryOperationRow } from './QueryOperationRow';
+import { QueryOperationRow, QueryOperationRowProps } from './QueryOperationRow';
+
+const setup = (propOverrides?: Partialchildren,
+ ...propOverrides,
+ };
+ return render(Test
- Test
- Test
- Test;
- const wrapper = mount(
- Test
- test-header-element;
+ setup({ headerElement: title, id: 'test-id', index: 0 });
- const titleEl = wrapper.find({ 'aria-label': 'test title' });
- expect(titleEl).toHaveLength(1);
+ expect(screen.getByText(/^test-header-element$/)).toBeInTheDocument();
});
it('should render headerElement provided as function', () => {
- const title = () => Test;
- const wrapper = mount(
- Test
- test-function-header;
+ setup({ headerElement: title, id: 'test-id', index: 0 });
- const titleEl = wrapper.find({ 'aria-label': 'test title' });
- expect(titleEl).toHaveLength(1);
+ expect(screen.getByText(/^test-function-header$/)).toBeInTheDocument();
});
it('should expose api to headerElement rendered as function', () => {
const propsSpy = jest.fn();
- const title = (props: any) => {
+ const title = (props: PartialTest;
};
- shallow(
- Test
- Test;
- const wrapper = mount(
- Test
- test-actions;
+ setup({ actions: actions, id: 'test-id', index: 0 });
- const actionsEl = wrapper.find({ 'aria-label': 'test actions' });
- expect(actionsEl).toHaveLength(1);
+ expect(screen.getByText(/^test-actions$/)).toBeInTheDocument();
});
it('should render actions provided as function', () => {
- const actions = () => Test;
- const wrapper = mount(
- Test
- test-actions;
+ setup({ actions: actions, id: 'test-id', index: 0 });
- const actionsEl = wrapper.find({ 'aria-label': 'test actions' });
- expect(actionsEl).toHaveLength(1);
+ expect(screen.getByText(/^test-actions$/)).toBeInTheDocument();
});
it('should expose api to title rendered as function', () => {
const propsSpy = jest.fn();
- const actions = (props: any) => {
+ const actions = (props: PartialTest;
+ return test-actions;
};
- shallow(
- Test
-
-
-
-
- );
- }
-
- return (
-
-
- );
-};
-
-const getStyles = (theme: GrafanaTheme2) => {
- return {
- wrap: css`
- border: 4px solid red;
- `,
- running: css`
- border: 4px solid green;
- `,
- };
-};
diff --git a/public/app/features/admin/ServerStats.tsx b/public/app/features/admin/ServerStats.tsx
index 1b3cf7799d6..672d1ba2746 100644
--- a/public/app/features/admin/ServerStats.tsx
+++ b/public/app/features/admin/ServerStats.tsx
@@ -10,7 +10,6 @@ import { contextSrv } from '../../core/services/context_srv';
import { Loader } from '../plugins/admin/components/Loader';
import { CrawlerStatus } from './CrawlerStatus';
-import { ExportStatus } from './ExportStatus';
import { getServerStats, ServerStat } from './state/apis';
export const ServerStats = () => {
@@ -99,7 +98,6 @@ export const ServerStats = () => {
)}
{config.featureToggles.dashboardPreviews && config.featureToggles.dashboardPreviewsAdmin && {JSON.stringify(status, null, 2)}
- {Boolean(!status.running) &&
-
+
`;
exports[`Render should render component 1`] = `
-
- {!publicDashboardPersisted(publicDashboard) && (
-
- Before you click Save, please acknowledge the following information:
)}
diff --git a/public/app/features/dashboard/containers/DashboardPage.tsx b/public/app/features/dashboard/containers/DashboardPage.tsx
index d32eb5c1817..017e6adc8a1 100644
--- a/public/app/features/dashboard/containers/DashboardPage.tsx
+++ b/public/app/features/dashboard/containers/DashboardPage.tsx
@@ -5,7 +5,7 @@ import { connect, ConnectedProps } from 'react-redux';
import { GrafanaTheme2, TimeRange } from '@grafana/data';
import { selectors } from '@grafana/e2e-selectors';
-import { locationService } from '@grafana/runtime';
+import { config, locationService } from '@grafana/runtime';
import { CustomScrollbar, stylesFactory, Themeable2, withTheme2 } from '@grafana/ui';
import { notifyApp } from 'app/core/actions';
import { Branding } from 'app/core/components/Branding/Branding';
@@ -387,7 +387,8 @@ export class UnthemedDashboardPage extends PureComponent
-
+
+
-
+
);
}}
{title}
- {!dashboard.meta.publicDashboardAccessToken && (
-
-
+ ) : null}
+
+
- )}
- {data.request && data.request.timeInfo && (
-
- {title}
+ {!dashboard.meta.publicDashboardAccessToken && (
+
+
+ )}
+ {data.request && data.request.timeInfo && (
+
+ Scene not found
;
+ }
+
+ return (
+
+
+ );
+};
+
+export default ScenePage;
diff --git a/public/app/features/scenes/components/Scene.test.tsx b/public/app/features/scenes/components/Scene.test.tsx
new file mode 100644
index 00000000000..6c616ff70f6
--- /dev/null
+++ b/public/app/features/scenes/components/Scene.test.tsx
@@ -0,0 +1,15 @@
+import { Scene } from './Scene';
+import { SceneFlexLayout } from './SceneFlexLayout';
+
+describe('Scene', () => {
+ it('Simple scene', () => {
+ const scene = new Scene({
+ title: 'Hello',
+ layout: new SceneFlexLayout({
+ children: [],
+ }),
+ });
+
+ expect(scene.state.title).toBe('Hello');
+ });
+});
diff --git a/public/app/features/scenes/components/Scene.tsx b/public/app/features/scenes/components/Scene.tsx
new file mode 100644
index 00000000000..7bf37c758b5
--- /dev/null
+++ b/public/app/features/scenes/components/Scene.tsx
@@ -0,0 +1,56 @@
+import React from 'react';
+
+import { PageToolbar, ToolbarButton } from '@grafana/ui';
+
+import { SceneObjectBase } from '../core/SceneObjectBase';
+import { SceneComponentProps, SceneObjectState, SceneObject } from '../core/types';
+import { UrlSyncManager } from '../services/UrlSyncManager';
+
+interface SceneState extends SceneObjectState {
+ title: string;
+ layout: SceneObject;
+ actions?: SceneObject[];
+ isEditing?: boolean;
+}
+
+export class Scene extends SceneObjectBase
+
+ );
+}
diff --git a/public/app/features/scenes/components/SceneCanvasText.tsx b/public/app/features/scenes/components/SceneCanvasText.tsx
new file mode 100644
index 00000000000..042c86312e7
--- /dev/null
+++ b/public/app/features/scenes/components/SceneCanvasText.tsx
@@ -0,0 +1,44 @@
+import React, { CSSProperties } from 'react';
+
+import { Field, Input } from '@grafana/ui';
+
+import { SceneObjectBase } from '../core/SceneObjectBase';
+import { SceneComponentProps, SceneObjectState } from '../core/types';
+
+export interface SceneCanvasTextState extends SceneObjectState {
+ text: string;
+ fontSize?: number;
+ align?: 'left' | 'center' | 'right';
+}
+
+export class SceneCanvasText extends SceneObjectBase
+
+ {text};
+ };
+}
+
+function Editor({ model }: SceneComponentProps
+ {children.map((item) => (
+
+ );
+}
+
+function FlexLayoutChildComponent({
+ item,
+ direction,
+ isEditing,
+}: {
+ item: SceneObject
+
+ );
+}
+
+function getItemStyles(direction: FlexLayoutDirection, sizing: SceneObjectSize = {}) {
+ const { xSizing = 'fill', ySizing = 'fill' } = sizing;
+
+ const style: CSSProperties = {
+ display: 'flex',
+ flexDirection: direction,
+ minWidth: sizing.minWidth,
+ minHeight: sizing.minHeight,
+ };
+
+ if (direction === 'column') {
+ if (sizing.height) {
+ style.height = sizing.height;
+ } else {
+ style.flexGrow = ySizing === 'fill' ? 1 : 0;
+ }
+
+ if (sizing.width) {
+ style.width = sizing.width;
+ } else {
+ style.alignSelf = xSizing === 'fill' ? 'stretch' : 'flex-start';
+ }
+ } else {
+ if (sizing.height) {
+ style.height = sizing.height;
+ } else {
+ style.alignSelf = ySizing === 'fill' ? 'stretch' : 'flex-start';
+ }
+
+ if (sizing.width) {
+ style.width = sizing.width;
+ } else {
+ style.flexGrow = xSizing === 'fill' ? 1 : 0;
+ }
+ }
+
+ return style;
+}
+
+function FlexLayoutEditor({ model }: SceneComponentProps
+ {children}
+
+ );
+}
+
+const getStyles = (theme: GrafanaTheme2) => {
+ return {
+ wrapper: css({
+ display: 'flex',
+ flexGrow: 1,
+ padding: 8,
+ border: `1px dashed ${theme.colors.primary.main}`,
+ cursor: 'pointer',
+ }),
+ hover: css({
+ border: `1px solid ${theme.colors.primary.border}`,
+ }),
+ selected: css({
+ border: `1px solid ${theme.colors.error.border}`,
+ }),
+ };
+};
+
+function EmptyRenderer
+
+ );
+}
+
+const getStyles = (theme: GrafanaTheme2) => {
+ return {
+ container: css({
+ display: 'flex',
+ flexGrow: 0,
+ border: `1px solid ${theme.colors.border.weak}`,
+ background: theme.colors.background.primary,
+ width: theme.spacing(40),
+ cursor: 'pointer',
+ flexDirection: 'column',
+ }),
+ tree: css({
+ padding: theme.spacing(0.25, 1),
+ }),
+ };
+};
diff --git a/public/app/features/scenes/editor/SceneObjectEditor.tsx b/public/app/features/scenes/editor/SceneObjectEditor.tsx
new file mode 100644
index 00000000000..269303bd9a7
--- /dev/null
+++ b/public/app/features/scenes/editor/SceneObjectEditor.tsx
@@ -0,0 +1,17 @@
+import React from 'react';
+
+import { OptionsPaneCategory } from 'app/features/dashboard/components/PanelEditor/OptionsPaneCategory';
+
+import { SceneObject } from '../core/types';
+
+export interface Props {
+ model: SceneObject;
+}
+
+export function SceneObjectEditor({ model }: Props) {
+ return (
+
+
+ {selectedObject &&
+
+ );
+}
+
+const getStyles = (theme: GrafanaTheme2) => {
+ return {
+ node: css({
+ display: 'flex',
+ flexGrow: 0,
+ cursor: 'pointer',
+ flexDirection: 'column',
+ padding: '2px 4px',
+ }),
+ header: css({
+ display: 'flex',
+ fontWeight: 500,
+ }),
+ name: css({}),
+ selected: css({
+ color: theme.colors.error.text,
+ }),
+ icon: css({
+ width: theme.spacing(3),
+ color: theme.colors.text.secondary,
+ }),
+ children: css({
+ display: 'flex',
+ flexDirection: 'column',
+ paddingLeft: 8,
+ }),
+ };
+};
diff --git a/public/app/features/scenes/querying/SceneQueryRunner.ts b/public/app/features/scenes/querying/SceneQueryRunner.ts
new file mode 100644
index 00000000000..fb76b1c5088
--- /dev/null
+++ b/public/app/features/scenes/querying/SceneQueryRunner.ts
@@ -0,0 +1,133 @@
+import { cloneDeep } from 'lodash';
+import { Unsubscribable } from 'rxjs';
+
+import {
+ CoreApp,
+ DataQuery,
+ DataQueryRequest,
+ DataSourceApi,
+ DataSourceRef,
+ PanelData,
+ rangeUtil,
+ ScopedVars,
+ TimeRange,
+} from '@grafana/data';
+import { getDatasourceSrv } from 'app/features/plugins/datasource_srv';
+import { getNextRequestId } from 'app/features/query/state/PanelQueryRunner';
+import { runRequest } from 'app/features/query/state/runRequest';
+
+import { SceneObjectBase } from '../core/SceneObjectBase';
+import { SceneObjectState } from '../core/types';
+
+export interface QueryRunnerState extends SceneObjectState {
+ data?: PanelData;
+ queries: DataQueryExtended[];
+}
+
+export interface DataQueryExtended extends DataQuery {
+ [key: string]: any;
+}
+
+export class SceneQueryRunner extends SceneObjectBase
+
+ {children.length > 0 && (
+ {children.length > 0 &&
+ {name}
+
+ {children.map((child) => (
+
+ )}
+ Create service account