mirror of https://github.com/grafana/grafana.git
294 lines
10 KiB
TypeScript
294 lines
10 KiB
TypeScript
import { cloneDeep } from 'lodash';
|
|
|
|
import { config } from '@grafana/runtime';
|
|
import {
|
|
behaviors,
|
|
ConstantVariable,
|
|
CustomVariable,
|
|
DataSourceVariable,
|
|
IntervalVariable,
|
|
QueryVariable,
|
|
TextBoxVariable,
|
|
sceneGraph,
|
|
GroupByVariable,
|
|
AdHocFiltersVariable,
|
|
} from '@grafana/scenes';
|
|
import {
|
|
AdhocVariableKind,
|
|
ConstantVariableKind,
|
|
CustomVariableKind,
|
|
DashboardV2Spec,
|
|
DatasourceVariableKind,
|
|
GroupByVariableKind,
|
|
IntervalVariableKind,
|
|
QueryVariableKind,
|
|
TextVariableKind,
|
|
} from '@grafana/schema/dist/esm/schema/dashboard/v2alpha0/dashboard.gen';
|
|
import { handyTestingSchema } from '@grafana/schema/dist/esm/schema/dashboard/v2alpha0/examples';
|
|
import { DashboardWithAccessInfo } from 'app/features/dashboard/api/dashboard_api';
|
|
import { MIXED_DATASOURCE_NAME } from 'app/plugins/datasource/mixed/MixedDataSource';
|
|
|
|
import { DashboardDataLayerSet } from '../scene/DashboardDataLayerSet';
|
|
import { DashboardLayoutManager } from '../scene/types';
|
|
import { dashboardSceneGraph } from '../utils/dashboardSceneGraph';
|
|
import { getQueryRunnerFor } from '../utils/utils';
|
|
import { validateVariable, validateVizPanel } from '../v2schema/test-helpers';
|
|
|
|
import { transformSaveModelSchemaV2ToScene } from './transformSaveModelSchemaV2ToScene';
|
|
import { transformCursorSynctoEnum } from './transformToV2TypesUtils';
|
|
|
|
const defaultDashboard: DashboardWithAccessInfo<DashboardV2Spec> = {
|
|
kind: 'DashboardWithAccessInfo',
|
|
metadata: {
|
|
name: 'dashboard-uid',
|
|
namespace: 'default',
|
|
labels: {},
|
|
resourceVersion: '',
|
|
creationTimestamp: '',
|
|
},
|
|
spec: handyTestingSchema,
|
|
access: {},
|
|
apiVersion: 'v2',
|
|
};
|
|
|
|
jest.mock('@grafana/runtime', () => ({
|
|
...jest.requireActual('@grafana/runtime'),
|
|
getDataSourceSrv: () => ({
|
|
getInstanceSettings: jest.fn(),
|
|
}),
|
|
}));
|
|
|
|
describe('transformSaveModelSchemaV2ToScene', () => {
|
|
beforeAll(() => {
|
|
config.featureToggles.groupByVariable = true;
|
|
});
|
|
|
|
afterAll(() => {
|
|
config.featureToggles.groupByVariable = false;
|
|
});
|
|
|
|
it('should initialize the DashboardScene with the model state', () => {
|
|
const scene = transformSaveModelSchemaV2ToScene(defaultDashboard);
|
|
const dashboardControls = scene.state.controls!;
|
|
const dash = defaultDashboard.spec;
|
|
|
|
expect(scene.state.uid).toEqual(defaultDashboard.metadata.name);
|
|
expect(scene.state.title).toEqual(dash.title);
|
|
expect(scene.state.description).toEqual(dash.description);
|
|
expect(scene.state.editable).toEqual(dash.editable);
|
|
expect(scene.state.preload).toEqual(false);
|
|
expect(scene.state.version).toEqual(dash.schemaVersion);
|
|
expect(scene.state.tags).toEqual(dash.tags);
|
|
|
|
const liveNow = scene.state.$behaviors?.find((b) => b instanceof behaviors.LiveNowTimer);
|
|
expect(liveNow?.state.enabled).toEqual(dash.liveNow);
|
|
|
|
const cursorSync = scene.state.$behaviors?.find((b) => b instanceof behaviors.CursorSync);
|
|
expect(transformCursorSynctoEnum(cursorSync?.state.sync)).toEqual(dash.cursorSync);
|
|
|
|
// Dashboard links
|
|
expect(scene.state.links).toHaveLength(dash.links.length);
|
|
expect(scene.state.links![0].title).toBe(dash.links[0].title);
|
|
|
|
// Time settings
|
|
const time = dash.timeSettings;
|
|
const refreshPicker = dashboardSceneGraph.getRefreshPicker(scene)!;
|
|
const timeRange = sceneGraph.getTimeRange(scene)!;
|
|
|
|
// Time settings
|
|
expect(refreshPicker.state.refresh).toEqual(time.autoRefresh);
|
|
expect(refreshPicker.state.intervals).toEqual(time.autoRefreshIntervals);
|
|
expect(timeRange?.state.fiscalYearStartMonth).toEqual(dash.timeSettings.fiscalYearStartMonth);
|
|
expect(timeRange?.state.value.raw).toEqual({ from: dash.timeSettings.from, to: dash.timeSettings.to });
|
|
expect(dashboardControls.state.hideTimeControls).toEqual(dash.timeSettings.hideTimepicker);
|
|
expect(timeRange?.state.UNSAFE_nowDelay).toEqual(dash.timeSettings.nowDelay);
|
|
expect(timeRange?.state.timeZone).toEqual(dash.timeSettings.timezone);
|
|
expect(timeRange?.state.weekStart).toEqual(dash.timeSettings.weekStart);
|
|
expect(dashboardControls).toBeDefined();
|
|
expect(dashboardControls.state.refreshPicker.state.intervals).toEqual(time.autoRefreshIntervals);
|
|
expect(dashboardControls.state.hideTimeControls).toBe(time.hideTimepicker);
|
|
|
|
// Variables
|
|
const variables = scene.state?.$variables;
|
|
expect(variables?.state.variables).toHaveLength(dash.variables.length);
|
|
validateVariable({
|
|
sceneVariable: variables?.state.variables[0],
|
|
variableKind: dash.variables[0] as QueryVariableKind,
|
|
scene: scene,
|
|
dashSpec: dash,
|
|
sceneVariableClass: QueryVariable,
|
|
index: 0,
|
|
});
|
|
validateVariable({
|
|
sceneVariable: variables?.state.variables[1],
|
|
variableKind: dash.variables[1] as CustomVariableKind,
|
|
scene: scene,
|
|
dashSpec: dash,
|
|
sceneVariableClass: CustomVariable,
|
|
index: 1,
|
|
});
|
|
validateVariable({
|
|
sceneVariable: variables?.state.variables[2],
|
|
variableKind: dash.variables[2] as DatasourceVariableKind,
|
|
scene: scene,
|
|
dashSpec: dash,
|
|
sceneVariableClass: DataSourceVariable,
|
|
index: 2,
|
|
});
|
|
validateVariable({
|
|
sceneVariable: variables?.state.variables[3],
|
|
variableKind: dash.variables[3] as ConstantVariableKind,
|
|
scene: scene,
|
|
dashSpec: dash,
|
|
sceneVariableClass: ConstantVariable,
|
|
index: 3,
|
|
});
|
|
validateVariable({
|
|
sceneVariable: variables?.state.variables[4],
|
|
variableKind: dash.variables[4] as IntervalVariableKind,
|
|
scene: scene,
|
|
dashSpec: dash,
|
|
sceneVariableClass: IntervalVariable,
|
|
index: 4,
|
|
});
|
|
validateVariable({
|
|
sceneVariable: variables?.state.variables[5],
|
|
variableKind: dash.variables[5] as TextVariableKind,
|
|
scene: scene,
|
|
dashSpec: dash,
|
|
sceneVariableClass: TextBoxVariable,
|
|
index: 5,
|
|
});
|
|
validateVariable({
|
|
sceneVariable: variables?.state.variables[6],
|
|
variableKind: dash.variables[6] as GroupByVariableKind,
|
|
scene: scene,
|
|
dashSpec: dash,
|
|
sceneVariableClass: GroupByVariable,
|
|
index: 6,
|
|
});
|
|
validateVariable({
|
|
sceneVariable: variables?.state.variables[7],
|
|
variableKind: dash.variables[7] as AdhocVariableKind,
|
|
scene: scene,
|
|
dashSpec: dash,
|
|
sceneVariableClass: AdHocFiltersVariable,
|
|
index: 7,
|
|
});
|
|
|
|
// Annotations
|
|
expect(scene.state.$data).toBeInstanceOf(DashboardDataLayerSet);
|
|
const dataLayers = scene.state.$data as DashboardDataLayerSet;
|
|
expect(dataLayers.state.annotationLayers).toHaveLength(dash.annotations.length);
|
|
expect(dataLayers.state.annotationLayers[0].state.name).toBe(dash.annotations[0].spec.name);
|
|
expect(dataLayers.state.annotationLayers[0].state.isEnabled).toBe(dash.annotations[0].spec.enable);
|
|
expect(dataLayers.state.annotationLayers[0].state.isHidden).toBe(dash.annotations[0].spec.hide);
|
|
|
|
// Enabled
|
|
expect(dataLayers.state.annotationLayers[1].state.name).toBe(dash.annotations[1].spec.name);
|
|
expect(dataLayers.state.annotationLayers[1].state.isEnabled).toBe(dash.annotations[1].spec.enable);
|
|
expect(dataLayers.state.annotationLayers[1].state.isHidden).toBe(dash.annotations[1].spec.hide);
|
|
|
|
// Disabled
|
|
expect(dataLayers.state.annotationLayers[2].state.name).toBe(dash.annotations[2].spec.name);
|
|
expect(dataLayers.state.annotationLayers[2].state.isEnabled).toBe(dash.annotations[2].spec.enable);
|
|
expect(dataLayers.state.annotationLayers[2].state.isHidden).toBe(dash.annotations[2].spec.hide);
|
|
|
|
// Hidden
|
|
expect(dataLayers.state.annotationLayers[3].state.name).toBe(dash.annotations[3].spec.name);
|
|
expect(dataLayers.state.annotationLayers[3].state.isEnabled).toBe(dash.annotations[3].spec.enable);
|
|
expect(dataLayers.state.annotationLayers[3].state.isHidden).toBe(dash.annotations[3].spec.hide);
|
|
|
|
// To be implemented
|
|
// expect(timePicker.state.ranges).toEqual(dash.timeSettings.quickRanges);
|
|
|
|
// VizPanel
|
|
const vizPanels = (scene.state.body as DashboardLayoutManager).getVizPanels();
|
|
expect(vizPanels).toHaveLength(1);
|
|
const vizPanel = vizPanels[0];
|
|
validateVizPanel(vizPanel, dash);
|
|
|
|
// FIXME: Tests for layout
|
|
});
|
|
|
|
it('should set panel ds if it is mixed DS', () => {
|
|
const dashboard = cloneDeep(defaultDashboard);
|
|
dashboard.spec.elements['test-panel-uid'].spec.data.spec.queries.push({
|
|
kind: 'PanelQuery',
|
|
spec: {
|
|
refId: 'A',
|
|
datasource: {
|
|
type: 'graphite',
|
|
uid: 'datasource1',
|
|
},
|
|
hidden: false,
|
|
query: {
|
|
kind: 'prometheus',
|
|
spec: {
|
|
expr: 'test-query',
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
const scene = transformSaveModelSchemaV2ToScene(dashboard);
|
|
|
|
const vizPanels = (scene.state.body as DashboardLayoutManager).getVizPanels();
|
|
expect(vizPanels.length).toBe(1);
|
|
expect(getQueryRunnerFor(vizPanels[0])?.state.datasource?.type).toBe('mixed');
|
|
expect(getQueryRunnerFor(vizPanels[0])?.state.datasource?.uid).toBe(MIXED_DATASOURCE_NAME);
|
|
});
|
|
|
|
it('should set panel ds as undefined if it is not mixed DS', () => {
|
|
const dashboard = cloneDeep(defaultDashboard);
|
|
dashboard.spec.elements['test-panel-uid'].spec.data.spec.queries.push({
|
|
kind: 'PanelQuery',
|
|
spec: {
|
|
refId: 'A',
|
|
datasource: {
|
|
type: 'prometheus',
|
|
uid: 'datasource1',
|
|
},
|
|
hidden: false,
|
|
query: {
|
|
kind: 'prometheus',
|
|
spec: {
|
|
expr: 'test-query',
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
const scene = transformSaveModelSchemaV2ToScene(dashboard);
|
|
|
|
const vizPanels = (scene.state.body as DashboardLayoutManager).getVizPanels();
|
|
expect(vizPanels.length).toBe(1);
|
|
expect(getQueryRunnerFor(vizPanels[0])?.state.datasource).toBeUndefined();
|
|
});
|
|
|
|
it('should set panel ds as mixed if one ds is undefined', () => {
|
|
const dashboard = cloneDeep(defaultDashboard);
|
|
|
|
dashboard.spec.elements['test-panel-uid'].spec.data.spec.queries.push({
|
|
kind: 'PanelQuery',
|
|
spec: {
|
|
refId: 'A',
|
|
hidden: false,
|
|
query: {
|
|
kind: 'prometheus',
|
|
spec: {
|
|
expr: 'test-query',
|
|
},
|
|
},
|
|
},
|
|
});
|
|
|
|
const scene = transformSaveModelSchemaV2ToScene(dashboard);
|
|
|
|
const vizPanels = (scene.state.body as DashboardLayoutManager).getVizPanels();
|
|
expect(vizPanels.length).toBe(1);
|
|
expect(getQueryRunnerFor(vizPanels[0])?.state.datasource?.type).toBe('mixed');
|
|
expect(getQueryRunnerFor(vizPanels[0])?.state.datasource?.uid).toBe(MIXED_DATASOURCE_NAME);
|
|
});
|
|
});
|