IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

DashboardScene serialization: Handle variables and library panels (#76117)

Browse Source 
* DashboardScene serialization: Library panels

* DashboardScene serialization: Variables

* TS fix

* Review

* betetrer -u
This commit is contained in:
Dominik Prokop
2023-10-06 14:32:29 +02:00
committed by GitHub
parent 1a96f3742f
commit 2cfbe087fc
8 changed files with 497 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

258
public/app/features/dashboard-scene/serialization/sceneVariablesSetToVariables.test.ts Normal file
View File

@@ -0,0 +1,258 @@
import { of } from 'rxjs';
import {
DataSourceApi,
FieldType,
getDefaultTimeRange,
LoadingState,
PanelData,
PluginType,
ScopedVars,
toDataFrame,
VariableSupportType,
} from '@grafana/data';
import { setRunRequest } from '@grafana/runtime';
import { ConstantVariable, CustomVariable, DataSourceVariable, QueryVariable, SceneVariableSet } from '@grafana/scenes';
import { DataSourceRef } from '@grafana/schema';
import { sceneVariablesSetToVariables } from './sceneVariablesSetToVariables';
const runRequestMock = jest.fn().mockReturnValue(
of<PanelData>({
state: LoadingState.Done,
series: [
toDataFrame({
fields: [{ name: 'text', type: FieldType.string, values: ['val1', 'val2', 'val11'] }],
}),
],
timeRange: getDefaultTimeRange(),
})
);
setRunRequest(runRequestMock);
const getDataSourceMock = jest.fn();
const fakeDsMock: DataSourceApi = {
name: 'fake-std',
type: 'fake-std',
getRef: () => ({ type: 'fake-std', uid: 'fake-std' }),
query: () =>
Promise.resolve({
data: [],
}),
testDatasource: () => Promise.resolve({ status: 'success', message: 'abc' }),
meta: {
id: 'fake-std',
type: PluginType.datasource,
module: 'fake-std',
baseUrl: '',
name: 'fake-std',
info: {
author: { name: '' },
description: '',
links: [],
logos: { large: '', small: '' },
updated: '',
version: '',
screenshots: [],
},
},
// Standard variable support
variables: {
getType: () => VariableSupportType.Standard,
toDataQuery: (q) => ({ ...q, refId: 'FakeDataSource-refId' }),
},
id: 1,
uid: 'fake-std',
};
jest.mock('@grafana/runtime', () => ({
...jest.requireActual('@grafana/runtime'),
getDataSourceSrv: () => ({
get: (ds: DataSourceRef, vars: ScopedVars): Promise<DataSourceApi> => {
getDataSourceMock(ds, vars);
return Promise.resolve(fakeDsMock);
},
}),
}));
describe('sceneVariablesSetToVariables', () => {
it('should handle QueryVariable', () => {
const variable = new QueryVariable({
name: 'test',
label: 'test-label',
description: 'test-desc',
value: ['selected-value'],
text: ['selected-value-text'],
datasource: { uid: 'fake-std', type: 'fake-std' },
query: 'query',
includeAll: true,
allValue: 'test-all',
isMulti: true,
});
const set = new SceneVariableSet({
variables: [variable],
});
const result = sceneVariablesSetToVariables(set);
expect(result).toHaveLength(1);
expect(result[0]).toMatchInlineSnapshot(`
{
"allValue": "test-all",
"current": {
"text": [
"selected-value-text",
],
"value": [
"selected-value",
],
},
"datasource": {
"type": "fake-std",
"uid": "fake-std",
},
"description": "test-desc",
"hide": 0,
"includeAll": true,
"label": "test-label",
"multi": true,
"name": "test",
"options": [],
"query": "query",
"refresh": 1,
"regex": "",
"skipUrlSync": false,
"sort": 1,
}
`);
});
it('should handle DatasourceVariable', () => {
const variable = new DataSourceVariable({
name: 'test',
label: 'test-label',
description: 'test-desc',
value: ['selected-ds-1', 'selected-ds-2'],
text: ['selected-ds-1-text', 'selected-ds-2-text'],
pluginId: 'fake-std',
includeAll: true,
allValue: 'test-all',
isMulti: true,
});
const set = new SceneVariableSet({
variables: [variable],
});
const result = sceneVariablesSetToVariables(set);
expect(result).toHaveLength(1);
expect(result[0]).toMatchInlineSnapshot(`
{
"allValue": "test-all",
"current": {
"text": [
"selected-ds-1-text",
"selected-ds-2-text",
],
"value": [
"selected-ds-1",
"selected-ds-2",
],
},
"description": "test-desc",
"hide": 0,
"includeAll": true,
"label": "test-label",
"multi": true,
"name": "test",
"options": [],
"query": "fake-std",
"regex": "",
"skipUrlSync": false,
}
`);
});
it('should handle CustomVariable', () => {
const variable = new CustomVariable({
name: 'test',
label: 'test-label',
description: 'test-desc',
value: ['test', 'test2'],
text: ['test', 'test2'],
query: 'test,test1,test2',
options: [
{ label: 'test', value: 'test' },
{ label: 'test1', value: 'test1' },
{ label: 'test2', value: 'test2' },
],
includeAll: true,
allValue: 'test-all',
isMulti: true,
});
const set = new SceneVariableSet({
variables: [variable],
});
const result = sceneVariablesSetToVariables(set);
expect(result).toHaveLength(1);
expect(result[0]).toMatchInlineSnapshot(`
{
"allValue": "test-all",
"current": {
"text": [
"test",
"test2",
],
"value": [
"test",
"test2",
],
},
"description": "test-desc",
"hide": 0,
"includeAll": true,
"label": "test-label",
"multi": true,
"name": "test",
"options": [],
"query": "test,test1,test2",
"skipUrlSync": false,
}
`);
});
it('should handle ConstantVariable', () => {
const variable = new ConstantVariable({
name: 'test',
label: 'test-label',
description: 'test-desc',
value: 'constant value',
skipUrlSync: true,
});
const set = new SceneVariableSet({
variables: [variable],
});
const result = sceneVariablesSetToVariables(set);
expect(result).toHaveLength(1);
expect(result[0]).toMatchInlineSnapshot(`
{
"current": {
"text": "constant value",
"value": "constant value",
},
"description": "test-desc",
"hide": 2,
"label": "test-label",
"name": "test",
"query": "constant value",
"skipUrlSync": true,
}
`);
});
});