mirror of
https://github.com/grafana/grafana.git
synced 2024-12-02 05:29:42 -06:00
1716de88b5
* DashboardService: Consolidate constructors Signed-off-by: Arve Knudsen <arve.knudsen@gmail.com>
899 lines
25 KiB
Go
899 lines
25 KiB
Go
package librarypanels
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"net/http"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/stretchr/testify/require"
|
|
"gopkg.in/macaron.v1"
|
|
|
|
"github.com/grafana/grafana/pkg/api/response"
|
|
"github.com/grafana/grafana/pkg/bus"
|
|
"github.com/grafana/grafana/pkg/components/simplejson"
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/registry"
|
|
"github.com/grafana/grafana/pkg/services/dashboards"
|
|
"github.com/grafana/grafana/pkg/services/sqlstore"
|
|
"github.com/grafana/grafana/pkg/setting"
|
|
)
|
|
|
|
const UserInDbName = "user_in_db"
|
|
const UserInDbAvatar = "/avatar/402d08de060496d6b6874495fe20f5ad"
|
|
|
|
func TestLoadLibraryPanelsForDashboard(t *testing.T) {
|
|
scenarioWithLibraryPanel(t, "When an admin tries to load a dashboard with a library panel, it should copy JSON properties from library panel",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID, ":dashboardId": "1"})
|
|
resp := sc.service.connectHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"libraryPanel": map[string]interface{}{
|
|
"uid": sc.initialResult.Result.UID,
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: 1,
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.LoadLibraryPanelsForDashboard(sc.reqContext, &dash)
|
|
require.NoError(t, err)
|
|
expectedJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"libraryPanel": map[string]interface{}{
|
|
"uid": sc.initialResult.Result.UID,
|
|
"name": sc.initialResult.Result.Name,
|
|
"version": sc.initialResult.Result.Version,
|
|
"meta": map[string]interface{}{
|
|
"canEdit": false,
|
|
"connectedDashboards": int64(1),
|
|
"created": sc.initialResult.Result.Meta.Created,
|
|
"updated": sc.initialResult.Result.Meta.Updated,
|
|
"createdBy": map[string]interface{}{
|
|
"id": sc.initialResult.Result.Meta.CreatedBy.ID,
|
|
"name": UserInDbName,
|
|
"avatarUrl": UserInDbAvatar,
|
|
},
|
|
"updatedBy": map[string]interface{}{
|
|
"id": sc.initialResult.Result.Meta.UpdatedBy.ID,
|
|
"name": UserInDbName,
|
|
"avatarUrl": UserInDbAvatar,
|
|
},
|
|
},
|
|
},
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
},
|
|
}
|
|
expected := simplejson.NewFromAny(expectedJSON)
|
|
if diff := cmp.Diff(expected.Interface(), dash.Data.Interface(), getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to load a dashboard with a library panel without uid, it should fail",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID, ":dashboardId": "1"})
|
|
resp := sc.service.connectHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"libraryPanel": map[string]interface{}{
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: 1,
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.LoadLibraryPanelsForDashboard(sc.reqContext, &dash)
|
|
require.EqualError(t, err, errLibraryPanelHeaderUIDMissing.Error())
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to load a dashboard with a library panel that is not connected, it should set correct JSON and continue",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"libraryPanel": map[string]interface{}{
|
|
"uid": sc.initialResult.Result.UID,
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: 1,
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.LoadLibraryPanelsForDashboard(sc.reqContext, &dash)
|
|
require.NoError(t, err)
|
|
expectedJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"libraryPanel": map[string]interface{}{
|
|
"uid": sc.initialResult.Result.UID,
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
"type": fmt.Sprintf("Name: \"%s\", UID: \"%s\"", sc.initialResult.Result.Name, sc.initialResult.Result.UID),
|
|
},
|
|
},
|
|
}
|
|
expected := simplejson.NewFromAny(expectedJSON)
|
|
if diff := cmp.Diff(expected.Interface(), dash.Data.Interface(), getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestCleanLibraryPanelsForDashboard(t *testing.T) {
|
|
scenarioWithLibraryPanel(t, "When an admin tries to store a dashboard with a library panel, it should just keep the correct JSON properties in library panel",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"libraryPanel": map[string]interface{}{
|
|
"uid": sc.initialResult.Result.UID,
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: 1,
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.CleanLibraryPanelsForDashboard(&dash)
|
|
require.NoError(t, err)
|
|
expectedJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"libraryPanel": map[string]interface{}{
|
|
"uid": sc.initialResult.Result.UID,
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
},
|
|
},
|
|
}
|
|
expected := simplejson.NewFromAny(expectedJSON)
|
|
if diff := cmp.Diff(expected.Interface(), dash.Data.Interface(), getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to store a dashboard with a library panel without uid, it should fail",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"libraryPanel": map[string]interface{}{
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: 1,
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.CleanLibraryPanelsForDashboard(&dash)
|
|
require.EqualError(t, err, errLibraryPanelHeaderUIDMissing.Error())
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to store a dashboard with a library panel without name, it should fail",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"libraryPanel": map[string]interface{}{
|
|
"uid": sc.initialResult.Result.UID,
|
|
},
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: 1,
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.CleanLibraryPanelsForDashboard(&dash)
|
|
require.EqualError(t, err, errLibraryPanelHeaderNameMissing.Error())
|
|
})
|
|
}
|
|
|
|
func TestConnectLibraryPanelsForDashboard(t *testing.T) {
|
|
scenarioWithLibraryPanel(t, "When an admin tries to store a dashboard with a library panel, it should connect the two",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"libraryPanel": map[string]interface{}{
|
|
"uid": sc.initialResult.Result.UID,
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: int64(1),
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.ConnectLibraryPanelsForDashboard(sc.reqContext, &dash)
|
|
require.NoError(t, err)
|
|
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID})
|
|
resp := sc.service.getConnectedDashboardsHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var dashResult libraryPanelDashboardsResult
|
|
err = json.Unmarshal(resp.Body(), &dashResult)
|
|
require.NoError(t, err)
|
|
require.Len(t, dashResult.Result, 1)
|
|
require.Equal(t, int64(1), dashResult.Result[0])
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to store a dashboard with a library panel without uid, it should fail",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"libraryPanel": map[string]interface{}{
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: int64(1),
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.ConnectLibraryPanelsForDashboard(sc.reqContext, &dash)
|
|
require.EqualError(t, err, errLibraryPanelHeaderUIDMissing.Error())
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to store a dashboard with unused/removed library panels, it should disconnect unused/removed library panels",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
command := getCreateCommand(sc.folder.Id, "Unused Libray Panel")
|
|
resp := sc.service.createHandler(sc.reqContext, command)
|
|
var unused = validateAndUnMarshalResponse(t, resp)
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": unused.Result.UID, ":dashboardId": "1"})
|
|
resp = sc.service.connectHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"libraryPanel": map[string]interface{}{
|
|
"uid": sc.initialResult.Result.UID,
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: int64(1),
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.ConnectLibraryPanelsForDashboard(sc.reqContext, &dash)
|
|
require.NoError(t, err)
|
|
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID})
|
|
resp = sc.service.getConnectedDashboardsHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var existingResult libraryPanelDashboardsResult
|
|
err = json.Unmarshal(resp.Body(), &existingResult)
|
|
require.NoError(t, err)
|
|
require.Len(t, existingResult.Result, 1)
|
|
require.Equal(t, int64(1), existingResult.Result[0])
|
|
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": unused.Result.UID})
|
|
resp = sc.service.getConnectedDashboardsHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var unusedResult libraryPanelDashboardsResult
|
|
err = json.Unmarshal(resp.Body(), &unusedResult)
|
|
require.NoError(t, err)
|
|
require.Len(t, unusedResult.Result, 0)
|
|
})
|
|
}
|
|
|
|
func TestDisconnectLibraryPanelsForDashboard(t *testing.T) {
|
|
scenarioWithLibraryPanel(t, "When an admin tries to delete a dashboard with a library panel, it should disconnect the two",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID, ":dashboardId": "1"})
|
|
resp := sc.service.connectHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"libraryPanel": map[string]interface{}{
|
|
"uid": sc.initialResult.Result.UID,
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: int64(1),
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.DisconnectLibraryPanelsForDashboard(sc.reqContext, &dash)
|
|
require.NoError(t, err)
|
|
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID})
|
|
resp = sc.service.getConnectedDashboardsHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var dashResult libraryPanelDashboardsResult
|
|
err = json.Unmarshal(resp.Body(), &dashResult)
|
|
require.NoError(t, err)
|
|
require.Empty(t, dashResult.Result)
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to delete a dashboard with a library panel without uid, it should fail",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID, ":dashboardId": "1"})
|
|
resp := sc.service.connectHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
dashJSON := map[string]interface{}{
|
|
"panels": []interface{}{
|
|
map[string]interface{}{
|
|
"id": int64(1),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 0,
|
|
"y": 0,
|
|
},
|
|
},
|
|
map[string]interface{}{
|
|
"id": int64(2),
|
|
"gridPos": map[string]interface{}{
|
|
"h": 6,
|
|
"w": 6,
|
|
"x": 6,
|
|
"y": 0,
|
|
},
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"libraryPanel": map[string]interface{}{
|
|
"name": sc.initialResult.Result.Name,
|
|
},
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
},
|
|
}
|
|
dash := models.Dashboard{
|
|
Id: int64(1),
|
|
Data: simplejson.NewFromAny(dashJSON),
|
|
}
|
|
|
|
err := sc.service.DisconnectLibraryPanelsForDashboard(sc.reqContext, &dash)
|
|
require.EqualError(t, err, errLibraryPanelHeaderUIDMissing.Error())
|
|
})
|
|
}
|
|
|
|
func TestDeleteLibraryPanelsInFolder(t *testing.T) {
|
|
scenarioWithLibraryPanel(t, "When an admin tries to delete a folder that contains connected library panels, it should fail",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID, ":dashboardId": "1"})
|
|
resp := sc.service.connectHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
err := sc.service.DeleteLibraryPanelsInFolder(sc.reqContext, sc.folder.Uid)
|
|
require.EqualError(t, err, ErrFolderHasConnectedLibraryPanels.Error())
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to delete a folder that contains disconnected library panels, it should delete all disconnected library panels too",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
resp := sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
var result libraryPanelsResult
|
|
err := json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, result.Result)
|
|
require.Equal(t, 1, len(result.Result))
|
|
|
|
err = sc.service.DeleteLibraryPanelsInFolder(sc.reqContext, sc.folder.Uid)
|
|
require.NoError(t, err)
|
|
resp = sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
err = json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, result.Result)
|
|
require.Equal(t, 0, len(result.Result))
|
|
})
|
|
}
|
|
|
|
type libraryPanel struct {
|
|
ID int64 `json:"id"`
|
|
OrgID int64 `json:"orgId"`
|
|
FolderID int64 `json:"folderId"`
|
|
UID string `json:"uid"`
|
|
Name string `json:"name"`
|
|
Model map[string]interface{} `json:"model"`
|
|
Version int64 `json:"version"`
|
|
Meta LibraryPanelDTOMeta `json:"meta"`
|
|
}
|
|
|
|
type libraryPanelResult struct {
|
|
Result libraryPanel `json:"result"`
|
|
}
|
|
|
|
type libraryPanelsResult struct {
|
|
Result []libraryPanel `json:"result"`
|
|
}
|
|
|
|
type libraryPanelDashboardsResult struct {
|
|
Result []int64 `json:"result"`
|
|
}
|
|
|
|
func overrideLibraryPanelServiceInRegistry(cfg *setting.Cfg) LibraryPanelService {
|
|
lps := LibraryPanelService{
|
|
SQLStore: nil,
|
|
Cfg: cfg,
|
|
}
|
|
|
|
overrideServiceFunc := func(d registry.Descriptor) (*registry.Descriptor, bool) {
|
|
descriptor := registry.Descriptor{
|
|
Name: "LibraryPanelService",
|
|
Instance: &lps,
|
|
InitPriority: 0,
|
|
}
|
|
|
|
return &descriptor, true
|
|
}
|
|
|
|
registry.RegisterOverride(overrideServiceFunc)
|
|
|
|
return lps
|
|
}
|
|
|
|
func getCreateCommand(folderID int64, name string) createLibraryPanelCommand {
|
|
command := createLibraryPanelCommand{
|
|
FolderID: folderID,
|
|
Name: name,
|
|
Model: []byte(`
|
|
{
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"id": 1,
|
|
"title": "Text - Library Panel",
|
|
"type": "text"
|
|
}
|
|
`),
|
|
}
|
|
|
|
return command
|
|
}
|
|
|
|
type scenarioContext struct {
|
|
ctx *macaron.Context
|
|
service *LibraryPanelService
|
|
reqContext *models.ReqContext
|
|
user models.SignedInUser
|
|
folder *models.Folder
|
|
initialResult libraryPanelResult
|
|
}
|
|
|
|
type folderACLItem struct {
|
|
roleType models.RoleType
|
|
permission models.PermissionType
|
|
}
|
|
|
|
func createDashboard(t *testing.T, user models.SignedInUser, title string, folderID int64) *models.Dashboard {
|
|
dash := models.NewDashboard(title)
|
|
dash.FolderId = folderID
|
|
dashItem := &dashboards.SaveDashboardDTO{
|
|
Dashboard: dash,
|
|
Message: "",
|
|
OrgId: user.OrgId,
|
|
User: &user,
|
|
Overwrite: false,
|
|
}
|
|
bus.AddHandler("test", func(cmd *models.ValidateDashboardAlertsCommand) error {
|
|
return nil
|
|
})
|
|
bus.AddHandler("test", func(cmd *models.ValidateDashboardBeforeSaveCommand) error {
|
|
cmd.Result = &models.ValidateDashboardBeforeSaveResult{}
|
|
return nil
|
|
})
|
|
bus.AddHandler("test", func(cmd *models.GetProvisionedDashboardDataByIdQuery) error {
|
|
cmd.Result = nil
|
|
return nil
|
|
})
|
|
bus.AddHandler("test", func(cmd *models.UpdateDashboardAlertsCommand) error {
|
|
return nil
|
|
})
|
|
|
|
dashboard, err := dashboards.NewService().SaveDashboard(dashItem, true)
|
|
require.NoError(t, err)
|
|
|
|
return dashboard
|
|
}
|
|
|
|
func createFolderWithACL(t *testing.T, title string, user models.SignedInUser, items []folderACLItem) *models.Folder {
|
|
s := dashboards.NewFolderService(user.OrgId, &user)
|
|
folderCmd := models.CreateFolderCommand{
|
|
Uid: title,
|
|
Title: title,
|
|
}
|
|
err := s.CreateFolder(&folderCmd)
|
|
require.NoError(t, err)
|
|
|
|
updateFolderACL(t, folderCmd.Result.Id, items)
|
|
|
|
return folderCmd.Result
|
|
}
|
|
|
|
func updateFolderACL(t *testing.T, folderID int64, items []folderACLItem) {
|
|
if len(items) == 0 {
|
|
return
|
|
}
|
|
|
|
cmd := models.UpdateDashboardAclCommand{
|
|
DashboardID: folderID,
|
|
}
|
|
for _, item := range items {
|
|
role := item.roleType
|
|
permission := item.permission
|
|
cmd.Items = append(cmd.Items, &models.DashboardAcl{
|
|
DashboardID: folderID,
|
|
Role: &role,
|
|
Permission: permission,
|
|
Created: time.Now(),
|
|
Updated: time.Now(),
|
|
})
|
|
}
|
|
|
|
err := bus.Dispatch(&cmd)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
func validateAndUnMarshalResponse(t *testing.T, resp response.Response) libraryPanelResult {
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var result = libraryPanelResult{}
|
|
err := json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
|
|
return result
|
|
}
|
|
|
|
func scenarioWithLibraryPanel(t *testing.T, desc string, fn func(t *testing.T, sc scenarioContext)) {
|
|
testScenario(t, desc, func(t *testing.T, sc scenarioContext) {
|
|
command := getCreateCommand(sc.folder.Id, "Text - Library Panel")
|
|
resp := sc.service.createHandler(sc.reqContext, command)
|
|
sc.initialResult = validateAndUnMarshalResponse(t, resp)
|
|
|
|
fn(t, sc)
|
|
})
|
|
}
|
|
|
|
// testScenario is a wrapper around t.Run performing common setup for library panel tests.
|
|
// It takes your real test function as a callback.
|
|
func testScenario(t *testing.T, desc string, fn func(t *testing.T, sc scenarioContext)) {
|
|
t.Helper()
|
|
|
|
t.Run(desc, func(t *testing.T) {
|
|
t.Cleanup(registry.ClearOverrides)
|
|
|
|
ctx := macaron.Context{
|
|
Req: macaron.Request{Request: &http.Request{}},
|
|
}
|
|
orgID := int64(1)
|
|
role := models.ROLE_ADMIN
|
|
|
|
cfg := setting.NewCfg()
|
|
// Everything in this service is behind the feature toggle "panelLibrary"
|
|
cfg.FeatureToggles = map[string]bool{"panelLibrary": true}
|
|
// Because the LibraryPanelService is behind a feature toggle, we need to override the service in the registry
|
|
// with a Cfg that contains the feature toggle so migrations are run properly
|
|
service := overrideLibraryPanelServiceInRegistry(cfg)
|
|
|
|
// We need to assign SQLStore after the override and migrations are done
|
|
sqlStore := sqlstore.InitTestDB(t)
|
|
service.SQLStore = sqlStore
|
|
|
|
user := models.SignedInUser{
|
|
UserId: 1,
|
|
Name: "Signed In User",
|
|
Login: "signed_in_user",
|
|
Email: "signed.in.user@test.com",
|
|
OrgId: orgID,
|
|
OrgRole: role,
|
|
LastSeenAt: time.Now(),
|
|
}
|
|
|
|
// deliberate difference between signed in user and user in db to make it crystal clear
|
|
// what to expect in the tests
|
|
// In the real world these are identical
|
|
cmd := &models.CreateUserCommand{
|
|
Email: "user.in.db@test.com",
|
|
Name: "User In DB",
|
|
Login: UserInDbName,
|
|
}
|
|
err := sqlstore.CreateUser(context.Background(), cmd)
|
|
require.NoError(t, err)
|
|
|
|
sc := scenarioContext{
|
|
user: user,
|
|
ctx: &ctx,
|
|
service: &service,
|
|
reqContext: &models.ReqContext{
|
|
Context: &ctx,
|
|
SignedInUser: &user,
|
|
},
|
|
}
|
|
|
|
sc.folder = createFolderWithACL(t, "ScenarioFolder", sc.user, []folderACLItem{})
|
|
|
|
fn(t, sc)
|
|
})
|
|
}
|
|
|
|
func getCompareOptions() []cmp.Option {
|
|
return []cmp.Option{
|
|
cmp.Transformer("Time", func(in time.Time) int64 {
|
|
return in.UTC().Unix()
|
|
}),
|
|
}
|
|
}
|