mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
7f5487a461
* Refactor: adds description to getCreateCommand * Refactor: Adds type and description fields * Chore: Updates FrontEnd * Update pkg/services/librarypanels/database.go Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> * Update pkg/services/librarypanels/database.go Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com> * Chore: fixes backend linting error Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
495 lines
17 KiB
Go
495 lines
17 KiB
Go
package librarypanels
|
|
|
|
import (
|
|
"encoding/json"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/grafana/grafana/pkg/models"
|
|
)
|
|
|
|
func TestGetAllLibraryPanels(t *testing.T) {
|
|
testScenario(t, "When an admin tries to get all library panels and none exists, it should return none",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
resp := sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var result libraryPanelsSearch
|
|
err := json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
var expected = libraryPanelsSearch{
|
|
Result: libraryPanelsSearchResult{
|
|
TotalCount: 0,
|
|
LibraryPanels: []libraryPanel{},
|
|
Page: 1,
|
|
PerPage: 100,
|
|
},
|
|
}
|
|
if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist, it should succeed",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
|
|
resp := sc.service.createHandler(sc.reqContext, command)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
resp = sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var result libraryPanelsSearch
|
|
err := json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
var expected = libraryPanelsSearch{
|
|
Result: libraryPanelsSearchResult{
|
|
TotalCount: 2,
|
|
Page: 1,
|
|
PerPage: 100,
|
|
LibraryPanels: []libraryPanel{
|
|
{
|
|
ID: 1,
|
|
OrgID: 1,
|
|
FolderID: 1,
|
|
UID: result.Result.LibraryPanels[0].UID,
|
|
Name: "Text - Library Panel",
|
|
Type: "text",
|
|
Description: "A description",
|
|
Model: map[string]interface{}{
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"description": "A description",
|
|
"id": float64(1),
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
Version: 1,
|
|
Meta: LibraryPanelDTOMeta{
|
|
CanEdit: true,
|
|
ConnectedDashboards: 0,
|
|
Created: result.Result.LibraryPanels[0].Meta.Created,
|
|
Updated: result.Result.LibraryPanels[0].Meta.Updated,
|
|
CreatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
UpdatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
ID: 2,
|
|
OrgID: 1,
|
|
FolderID: 1,
|
|
UID: result.Result.LibraryPanels[1].UID,
|
|
Name: "Text - Library Panel2",
|
|
Type: "text",
|
|
Description: "A description",
|
|
Model: map[string]interface{}{
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"description": "A description",
|
|
"id": float64(1),
|
|
"title": "Text - Library Panel2",
|
|
"type": "text",
|
|
},
|
|
Version: 1,
|
|
Meta: LibraryPanelDTOMeta{
|
|
CanEdit: true,
|
|
ConnectedDashboards: 0,
|
|
Created: result.Result.LibraryPanels[1].Meta.Created,
|
|
Updated: result.Result.LibraryPanels[1].Meta.Updated,
|
|
CreatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
UpdatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and excludeUID is set, it should succeed and the result should be correct",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
|
|
resp := sc.service.createHandler(sc.reqContext, command)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
err := sc.reqContext.Req.ParseForm()
|
|
require.NoError(t, err)
|
|
sc.reqContext.Req.Form.Add("excludeUid", sc.initialResult.Result.UID)
|
|
resp = sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var result libraryPanelsSearch
|
|
err = json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
var expected = libraryPanelsSearch{
|
|
Result: libraryPanelsSearchResult{
|
|
TotalCount: 1,
|
|
Page: 1,
|
|
PerPage: 100,
|
|
LibraryPanels: []libraryPanel{
|
|
{
|
|
ID: 2,
|
|
OrgID: 1,
|
|
FolderID: 1,
|
|
UID: result.Result.LibraryPanels[0].UID,
|
|
Name: "Text - Library Panel2",
|
|
Type: "text",
|
|
Description: "A description",
|
|
Model: map[string]interface{}{
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"description": "A description",
|
|
"id": float64(1),
|
|
"title": "Text - Library Panel2",
|
|
"type": "text",
|
|
},
|
|
Version: 1,
|
|
Meta: LibraryPanelDTOMeta{
|
|
CanEdit: true,
|
|
ConnectedDashboards: 0,
|
|
Created: result.Result.LibraryPanels[0].Meta.Created,
|
|
Updated: result.Result.LibraryPanels[0].Meta.Updated,
|
|
CreatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
UpdatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and perPage is 1, it should succeed and the result should be correct",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
|
|
resp := sc.service.createHandler(sc.reqContext, command)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
err := sc.reqContext.Req.ParseForm()
|
|
require.NoError(t, err)
|
|
sc.reqContext.Req.Form.Add("perPage", "1")
|
|
resp = sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var result libraryPanelsSearch
|
|
err = json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
var expected = libraryPanelsSearch{
|
|
Result: libraryPanelsSearchResult{
|
|
TotalCount: 2,
|
|
Page: 1,
|
|
PerPage: 1,
|
|
LibraryPanels: []libraryPanel{
|
|
{
|
|
ID: 1,
|
|
OrgID: 1,
|
|
FolderID: 1,
|
|
UID: result.Result.LibraryPanels[0].UID,
|
|
Name: "Text - Library Panel",
|
|
Type: "text",
|
|
Description: "A description",
|
|
Model: map[string]interface{}{
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"description": "A description",
|
|
"id": float64(1),
|
|
"title": "Text - Library Panel",
|
|
"type": "text",
|
|
},
|
|
Version: 1,
|
|
Meta: LibraryPanelDTOMeta{
|
|
CanEdit: true,
|
|
ConnectedDashboards: 0,
|
|
Created: result.Result.LibraryPanels[0].Meta.Created,
|
|
Updated: result.Result.LibraryPanels[0].Meta.Updated,
|
|
CreatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
UpdatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and perPage is 1 and page is 2, it should succeed and the result should be correct",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
|
|
resp := sc.service.createHandler(sc.reqContext, command)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
err := sc.reqContext.Req.ParseForm()
|
|
require.NoError(t, err)
|
|
sc.reqContext.Req.Form.Add("perPage", "1")
|
|
sc.reqContext.Req.Form.Add("page", "2")
|
|
resp = sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var result libraryPanelsSearch
|
|
err = json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
var expected = libraryPanelsSearch{
|
|
Result: libraryPanelsSearchResult{
|
|
TotalCount: 2,
|
|
Page: 2,
|
|
PerPage: 1,
|
|
LibraryPanels: []libraryPanel{
|
|
{
|
|
ID: 2,
|
|
OrgID: 1,
|
|
FolderID: 1,
|
|
UID: result.Result.LibraryPanels[0].UID,
|
|
Name: "Text - Library Panel2",
|
|
Type: "text",
|
|
Description: "A description",
|
|
Model: map[string]interface{}{
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"description": "A description",
|
|
"id": float64(1),
|
|
"title": "Text - Library Panel2",
|
|
"type": "text",
|
|
},
|
|
Version: 1,
|
|
Meta: LibraryPanelDTOMeta{
|
|
CanEdit: true,
|
|
ConnectedDashboards: 0,
|
|
Created: result.Result.LibraryPanels[0].Meta.Created,
|
|
Updated: result.Result.LibraryPanels[0].Meta.Updated,
|
|
CreatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
UpdatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and perPage is 1 and page is 1 and name is panel2, it should succeed and the result should be correct",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
|
|
resp := sc.service.createHandler(sc.reqContext, command)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
err := sc.reqContext.Req.ParseForm()
|
|
require.NoError(t, err)
|
|
sc.reqContext.Req.Form.Add("perPage", "1")
|
|
sc.reqContext.Req.Form.Add("page", "1")
|
|
sc.reqContext.Req.Form.Add("name", "panel2")
|
|
resp = sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var result libraryPanelsSearch
|
|
err = json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
var expected = libraryPanelsSearch{
|
|
Result: libraryPanelsSearchResult{
|
|
TotalCount: 1,
|
|
Page: 1,
|
|
PerPage: 1,
|
|
LibraryPanels: []libraryPanel{
|
|
{
|
|
ID: 2,
|
|
OrgID: 1,
|
|
FolderID: 1,
|
|
UID: result.Result.LibraryPanels[0].UID,
|
|
Name: "Text - Library Panel2",
|
|
Type: "text",
|
|
Description: "A description",
|
|
Model: map[string]interface{}{
|
|
"datasource": "${DS_GDEV-TESTDATA}",
|
|
"description": "A description",
|
|
"id": float64(1),
|
|
"title": "Text - Library Panel2",
|
|
"type": "text",
|
|
},
|
|
Version: 1,
|
|
Meta: LibraryPanelDTOMeta{
|
|
CanEdit: true,
|
|
ConnectedDashboards: 0,
|
|
Created: result.Result.LibraryPanels[0].Meta.Created,
|
|
Updated: result.Result.LibraryPanels[0].Meta.Updated,
|
|
CreatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
UpdatedBy: LibraryPanelDTOMetaUser{
|
|
ID: 1,
|
|
Name: UserInDbName,
|
|
AvatarUrl: UserInDbAvatar,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and perPage is 1 and page is 3 and name is panel, it should succeed and the result should be correct",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
|
|
resp := sc.service.createHandler(sc.reqContext, command)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
err := sc.reqContext.Req.ParseForm()
|
|
require.NoError(t, err)
|
|
sc.reqContext.Req.Form.Add("perPage", "1")
|
|
sc.reqContext.Req.Form.Add("page", "3")
|
|
sc.reqContext.Req.Form.Add("name", "panel")
|
|
resp = sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var result libraryPanelsSearch
|
|
err = json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
var expected = libraryPanelsSearch{
|
|
Result: libraryPanelsSearchResult{
|
|
TotalCount: 2,
|
|
Page: 3,
|
|
PerPage: 1,
|
|
LibraryPanels: []libraryPanel{},
|
|
},
|
|
}
|
|
if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and perPage is 1 and page is 3 and name does not exist, it should succeed and the result should be correct",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
|
|
resp := sc.service.createHandler(sc.reqContext, command)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
err := sc.reqContext.Req.ParseForm()
|
|
require.NoError(t, err)
|
|
sc.reqContext.Req.Form.Add("perPage", "1")
|
|
sc.reqContext.Req.Form.Add("page", "3")
|
|
sc.reqContext.Req.Form.Add("name", "monkey")
|
|
resp = sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var result libraryPanelsSearch
|
|
err = json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
var expected = libraryPanelsSearch{
|
|
Result: libraryPanelsSearchResult{
|
|
TotalCount: 0,
|
|
Page: 3,
|
|
PerPage: 1,
|
|
LibraryPanels: []libraryPanel{},
|
|
},
|
|
}
|
|
if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist but only one is connected, it should succeed and return correct connected dashboards",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
|
|
resp := sc.service.createHandler(sc.reqContext, command)
|
|
require.Equal(t, 200, resp.Status())
|
|
var result = validateAndUnMarshalResponse(t, resp)
|
|
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": result.Result.UID, ":dashboardId": "1"})
|
|
resp = sc.service.connectHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
sc.reqContext.ReplaceAllParams(map[string]string{":uid": result.Result.UID, ":dashboardId": "2"})
|
|
resp = sc.service.connectHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
resp = sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var results libraryPanelsSearch
|
|
err := json.Unmarshal(resp.Body(), &results)
|
|
require.NoError(t, err)
|
|
require.Equal(t, int64(0), results.Result.LibraryPanels[0].Meta.ConnectedDashboards)
|
|
require.Equal(t, int64(2), results.Result.LibraryPanels[1].Meta.ConnectedDashboards)
|
|
})
|
|
|
|
scenarioWithLibraryPanel(t, "When an admin tries to get all library panels in a different org, none should be returned",
|
|
func(t *testing.T, sc scenarioContext) {
|
|
resp := sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
var result libraryPanelsSearch
|
|
err := json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
require.Equal(t, 1, len(result.Result.LibraryPanels))
|
|
require.Equal(t, int64(1), result.Result.LibraryPanels[0].FolderID)
|
|
require.Equal(t, "Text - Library Panel", result.Result.LibraryPanels[0].Name)
|
|
|
|
sc.reqContext.SignedInUser.OrgId = 2
|
|
sc.reqContext.SignedInUser.OrgRole = models.ROLE_ADMIN
|
|
resp = sc.service.getAllHandler(sc.reqContext)
|
|
require.Equal(t, 200, resp.Status())
|
|
|
|
result = libraryPanelsSearch{}
|
|
err = json.Unmarshal(resp.Body(), &result)
|
|
require.NoError(t, err)
|
|
var expected = libraryPanelsSearch{
|
|
Result: libraryPanelsSearchResult{
|
|
TotalCount: 0,
|
|
LibraryPanels: []libraryPanel{},
|
|
Page: 1,
|
|
PerPage: 100,
|
|
},
|
|
}
|
|
if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
|
|
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|