apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Typed variables pt2: Use type-accurate mock variables in tests (#52987)

Browse Source 
* wip

* make diff easier to read

* Update template_srv getVariables to return new TypedVariableModel

* update VariableType to use the type from TypedVariableModel

* tidy things up

* Chore: Use type-accurate mock variables in tests

* make createBaseVariableModel take the variable type
pull/52983/head
Josh Hunt 3 years ago committed by GitHub
parent 718620c197
commit 1a683e53c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 149 additions and 260 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 5
      public/app/features/variables/adhoc/actions.test.ts
  2. 83
      public/app/features/variables/state/__tests__/fixtures.ts
  3. 38
      public/app/features/variables/state/helpers.ts
  4. 77
      public/app/features/variables/state/reducers.test.ts
  5. 192
      public/app/features/variables/state/sharedReducer.test.ts
  6. 8
      public/app/features/variables/state/templateVarsChangedInUrl.test.ts
  7. 6
      public/app/features/variables/state/upgradeLegacyQueries.test.ts

5
public/app/features/variables/adhoc/actions.test.ts
Unescape View File

@ -1,6 +1,5 @@
import { DataSourceInstanceSettings, DataSourcePluginMeta } from '@grafana/data';
import { DataSourceInstanceSettings, DataSourcePluginMeta, TypedVariableModel } from '@grafana/data';
import { locationService } from '@grafana/runtime';
import { VariableModel } from 'app/features/variables/types';
import { reduxTester } from '../../../../test/core/redux/reduxTester';
import { variableAdapters } from '../adapters';
@ -499,7 +498,7 @@ describe('adhoc actions', () => {
});
});
function createAddVariableAction(variable: VariableModel, index = 0) {
function createAddVariableAction(variable: TypedVariableModel, index = 0) {
const identifier = toKeyedVariableIdentifier(variable);
const global = false;
const data = { global, index, model: { ...variable, index: -1, global } };

83
public/app/features/variables/state/__tests__/fixtures.ts
Unescape View File

@ -0,0 +1,83 @@
import {
BaseVariableModel,
ConstantVariableModel,
CustomVariableModel,
LoadingState,
QueryVariableModel,
VariableHide,
VariableOption,
VariableRefresh,
VariableSort,
VariableType,
} from '@grafana/data';
function createBaseVariableModel<T extends VariableType>(type: T): BaseVariableModel & { type: T } {
return {
name: 'myVariableName',
id: '0',
rootStateKey: 'key',
global: false,
hide: VariableHide.dontHide,
skipUrlSync: false,
index: 0,
state: LoadingState.NotStarted,
error: null,
description: null,
type,
};
}
export function createVariableOption(value: string, rest: Partial<Omit<VariableOption, 'value'>> = {}): VariableOption {
return {
value,
text: rest.text ?? value,
selected: rest.selected ?? false,
};
}
export function createQueryVariable(input: Partial<QueryVariableModel> = {}): QueryVariableModel {
return {
...createBaseVariableModel('query'),
label: 'DefaultLabel',
datasource: {
uid: 'abc-123',
type: 'prometheus',
},
definition: 'def',
sort: VariableSort.alphabeticalAsc,
query: 'label_values(job)',
regex: '',
refresh: VariableRefresh.onDashboardLoad,
multi: false,
includeAll: false,
current: createVariableOption('prom-prod', { text: 'Prometheus (main)', selected: true }),
options: [
createVariableOption('prom-prod', { text: 'Prometheus (main)', selected: true }),
createVariableOption('prom-dev'),
],
...input,
};
}
export function createConstantVariable(input: Partial<ConstantVariableModel>): ConstantVariableModel {
return {
...createBaseVariableModel('constant'),
query: '',
current: createVariableOption('database'),
options: [],
hide: VariableHide.hideVariable,
...input,
};
}
export function createCustomVariable(input: Partial<CustomVariableModel>): CustomVariableModel {
return {
...createBaseVariableModel('custom'),
multi: false,
includeAll: false,
current: createVariableOption('prom-prod', { text: 'Prometheus (main)', selected: true }),
options: [],
query: '',
...input,
};
}

38
public/app/features/variables/state/helpers.ts
Unescape View File

@ -1,6 +1,6 @@
import { combineReducers } from '@reduxjs/toolkit';
import { LoadingState } from '@grafana/data';
import { TypedVariableModel } from '@grafana/data';
import { dashboardReducer } from 'app/features/dashboard/state/reducers';
import { DashboardState, StoreState } from '../../../types';
@ -15,6 +15,7 @@ import {
VariableModel,
} from '../types';
import { createQueryVariable } from './__tests__/fixtures';
import { keyedVariablesReducer, KeyedVariablesState } from './keyedVariablesReducer';
import { getInitialTemplatingState, TemplatingState } from './reducers';
import { VariablesState } from './types';
@ -24,8 +25,8 @@ export const getVariableState = (
inEditorIndex = -1,
includeEmpty = false,
includeSystem = false
): Record<string, VariableModel> => {
const variables: Record<string, VariableModel> = {};
): VariablesState => {
const variables: Record<string, TypedVariableModel> = {};
if (includeSystem) {
const dashboardModel: DashboardVariableModel = {
@ -86,43 +87,27 @@ export const getVariableState = (
}
for (let index = 0; index < noOfVariables; index++) {
variables[index] = {
variables[index] = createQueryVariable({
id: index.toString(),
rootStateKey: 'key',
type: 'query',
name: `Name-${index}`,
hide: VariableHide.dontHide,
index,
label: `Label-${index}`,
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
};
index,
});
}
if (includeEmpty) {
variables[NEW_VARIABLE_ID] = {
variables[NEW_VARIABLE_ID] = createQueryVariable({
id: NEW_VARIABLE_ID,
rootStateKey: 'key',
type: 'query',
name: `Name-${NEW_VARIABLE_ID}`,
hide: VariableHide.dontHide,
index: noOfVariables,
label: `Label-${NEW_VARIABLE_ID}`,
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
};
index: noOfVariables,
});
}
return variables;
};
export const getVariableTestContext = <Model extends VariableModel>(
export const getVariableTestContext = <Model extends TypedVariableModel>(
adapter: VariableAdapter<Model>,
variableOverrides: Partial<Model> = {}
) => {
@ -132,6 +117,7 @@ export const getVariableTestContext = <Model extends VariableModel>(
index: 0,
name: '0',
};
const defaultVariable = {
...adapter.initialState,
...defaults,

77
public/app/features/variables/state/reducers.test.ts
Unescape View File

@ -4,9 +4,10 @@ import { VariableType } from '@grafana/data';
import { reducerTester } from '../../../../test/core/redux/reducerTester';
import { VariableAdapter, variableAdapters } from '../adapters';
import { initialVariableModelState, QueryVariableModel } from '../types';
import { QueryVariableModel } from '../types';
import { toVariablePayload } from '../utils';
import { createQueryVariable } from './__tests__/fixtures';
import { VariablePayload, VariablesState } from './types';
import { cleanVariables, variablesReducer } from './variablesReducer';
@ -32,64 +33,43 @@ describe('variablesReducer', () => {
describe('when cleanUpDashboard is dispatched', () => {
it('then all variables except global variables should be removed', () => {
const initialState: VariablesState = {
'0': {
...initialVariableModelState,
'0': createQueryVariable({
id: '0',
index: 0,
type: 'query',
name: 'Name-0',
label: 'Label-0',
},
'1': {
...initialVariableModelState,
}),
'1': createQueryVariable({
id: '1',
index: 1,
type: 'query',
name: 'Name-1',
label: 'Label-1',
global: true,
},
'2': {
...initialVariableModelState,
}),
'2': createQueryVariable({
id: '2',
index: 2,
type: 'query',
name: 'Name-2',
label: 'Label-2',
},
'3': {
...initialVariableModelState,
}),
'3': createQueryVariable({
id: '3',
index: 3,
type: 'query',
name: 'Name-3',
label: 'Label-3',
global: true,
},
}),
};
reducerTester<VariablesState>()
.givenReducer(variablesReducer, initialState)
.whenActionIsDispatched(cleanVariables())
.thenStateShouldEqual({
'1': {
...initialVariableModelState,
id: '1',
index: 1,
type: 'query',
name: 'Name-1',
label: 'Label-1',
global: true,
},
'3': {
...initialVariableModelState,
id: '3',
index: 3,
type: 'query',
name: 'Name-3',
label: 'Label-3',
global: true,
},
'1': initialState['1'],
'3': initialState['3'],
});
});
});
@ -97,14 +77,7 @@ describe('variablesReducer', () => {
describe('when any action is dispatched with a type prop that is registered in variableAdapters', () => {
it('then the reducer for that variableAdapter should be invoked', () => {
const initialState: VariablesState = {
'0': {
...initialVariableModelState,
id: '0',
index: 0,
type: 'query',
name: 'Name-0',
label: 'Label-0',
},
'0': createQueryVariable({ id: '0' }),
};
variableAdapters.get('mock').reducer = jest.fn().mockReturnValue(initialState);
const mockAction = createAction<VariablePayload>('mockAction');
@ -123,14 +96,7 @@ describe('variablesReducer', () => {
describe('when any action is dispatched with a type prop that is not registered in variableAdapters', () => {
it('then the reducer for that variableAdapter should be invoked', () => {
const initialState: VariablesState = {
'0': {
...initialVariableModelState,
id: '0',
index: 0,
type: 'query',
name: 'Name-0',
label: 'Label-0',
},
'0': createQueryVariable({ id: '0' }),
};
variableAdapters.get('mock').reducer = jest.fn().mockReturnValue(initialState);
const mockAction = createAction<VariablePayload>('mockAction');
@ -145,14 +111,7 @@ describe('variablesReducer', () => {
describe('when any action is dispatched missing type prop', () => {
it('then the reducer for that variableAdapter should be invoked', () => {
const initialState: VariablesState = {
'0': {
...initialVariableModelState,
id: '0',
index: 0,
type: 'query',
name: 'Name-0',
label: 'Label-0',
},
'0': createQueryVariable({ id: '0' }),
};
variableAdapters.get('mock').reducer = jest.fn().mockReturnValue(initialState);
const mockAction = createAction<string>('mockAction');

192
public/app/features/variables/state/sharedReducer.test.ts
Unescape View File

@ -10,9 +10,10 @@ import { ALL_VARIABLE_TEXT, ALL_VARIABLE_VALUE } from '../constants';
import { changeVariableNameSucceeded } from '../editor/reducer';
import { createQueryVariableAdapter } from '../query/adapter';
import { initialQueryVariableModelState } from '../query/reducer';
import { ConstantVariableModel, QueryVariableModel, VariableHide, VariableOption } from '../types';
import { ConstantVariableModel, QueryVariableModel, VariableOption } from '../types';
import { toVariablePayload } from '../utils';
import { createConstantVariable } from './__tests__/fixtures';
import { getVariableState, getVariableTestContext } from './helpers';
import {
addVariable,
@ -97,39 +98,20 @@ describe('sharedReducer', () => {
describe('when removeVariable is dispatched and reIndex is true', () => {
it('then state should be correct', () => {
const initialState: VariablesState = getVariableState(3);
const initialState = getVariableState(3);
const payload = toVariablePayload({ id: '1', type: 'query' }, { reIndex: true });
reducerTester<VariablesState>()
.givenReducer(sharedReducer, initialState)
.whenActionIsDispatched(removeVariable(payload))
.thenStateShouldEqual({
'0': {
id: '0',
rootStateKey: 'key',
type: 'query',
name: 'Name-0',
hide: VariableHide.dontHide,
...initialState['0'],
index: 0,
label: 'Label-0',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
'2': {
id: '2',
rootStateKey: 'key',
type: 'query',
name: 'Name-2',
hide: VariableHide.dontHide,
...initialState['2'],
index: 1,
label: 'Label-2',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
});
});
@ -139,38 +121,13 @@ describe('sharedReducer', () => {
it('then state should be correct', () => {
const initialState: VariablesState = getVariableState(3);
const payload = toVariablePayload({ id: '1', type: 'query' }, { reIndex: false });
reducerTester<VariablesState>()
.givenReducer(sharedReducer, initialState)
.whenActionIsDispatched(removeVariable(payload))
.thenStateShouldEqual({
'0': {
id: '0',
rootStateKey: 'key',
type: 'query',
name: 'Name-0',
hide: VariableHide.dontHide,
index: 0,
label: 'Label-0',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
'2': {
id: '2',
rootStateKey: 'key',
type: 'query',
name: 'Name-2',
hide: VariableHide.dontHide,
index: 2,
label: 'Label-2',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
'0': initialState['0'],
'2': initialState['2'],
});
});
});
@ -184,55 +141,12 @@ describe('sharedReducer', () => {
.whenActionIsDispatched(duplicateVariable(payload))
.thenStateShouldEqual({
...initialState,
'0': {
id: '0',
rootStateKey: 'key',
type: 'query',
name: 'Name-0',
hide: VariableHide.dontHide,
index: 0,
label: 'Label-0',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
'1': {
id: '1',
rootStateKey: 'key',
type: 'query',
name: 'Name-1',
hide: VariableHide.dontHide,
index: 1,
label: 'Label-1',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
'2': {
id: '2',
rootStateKey: 'key',
type: 'query',
name: 'Name-2',
hide: VariableHide.dontHide,
index: 2,
label: 'Label-2',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
'11': {
...initialQueryVariableModelState,
...initialState['1'],
id: '11',
rootStateKey: 'key',
name: 'copy_of_Name-1',
index: 3,
label: 'Label-1',
},
});
});
@ -247,46 +161,16 @@ describe('sharedReducer', () => {
.whenActionIsDispatched(changeVariableOrder(payload))
.thenStateShouldEqual({
'0': {
id: '0',
rootStateKey: 'key',
type: 'query',
name: 'Name-0',
hide: VariableHide.dontHide,
...initialState['0'],
index: 1,
label: 'Label-0',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
'1': {
id: '1',
rootStateKey: 'key',
type: 'query',
name: 'Name-1',
hide: VariableHide.dontHide,
...initialState['1'],
index: 2,
label: 'Label-1',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
'2': {
id: '2',
rootStateKey: 'key',
type: 'query',
name: 'Name-2',
hide: VariableHide.dontHide,
...initialState['2'],
index: 0,
label: 'Label-2',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
});
});
@ -299,46 +183,16 @@ describe('sharedReducer', () => {
.whenActionIsDispatched(changeVariableOrder(payload))
.thenStateShouldEqual({
'0': {
id: '0',
rootStateKey: 'key',
type: 'query',
name: 'Name-0',
hide: VariableHide.dontHide,
...initialState['0'],
index: 2,
label: 'Label-0',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
'1': {
id: '1',
rootStateKey: 'key',
type: 'query',
name: 'Name-1',
hide: VariableHide.dontHide,
...initialState['1'],
index: 0,
label: 'Label-1',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
'2': {
id: '2',
rootStateKey: 'key',
type: 'query',
name: 'Name-2',
hide: VariableHide.dontHide,
...initialState['2'],
index: 1,
label: 'Label-2',
skipUrlSync: false,
global: false,
state: LoadingState.NotStarted,
error: null,
description: null,
},
});
});
@ -567,6 +421,7 @@ describe('sharedReducer', () => {
const newType = 'constant' as VariableType;
const identifier: KeyedVariableIdentifier = { id: '0', type: 'query', rootStateKey: 'key' };
const payload = toVariablePayload(identifier, { newType });
reducerTester<VariablesState>()
.givenReducer(sharedReducer, cloneDeep(queryAdapterState))
.whenActionIsDispatched(changeVariableNameSucceeded(toVariablePayload(identifier, { newName: 'test' })))
@ -581,11 +436,14 @@ describe('sharedReducer', () => {
...constantAdapterState,
'0': {
...constantAdapterState[0],
rootStateKey: 'key',
name: 'test',
description: 'new description',
label: 'new label',
type: 'constant',
...createConstantVariable({
type: 'constant',
rootStateKey: 'key',
name: 'test',
description: 'new description',
label: 'new label',
current: {} as VariableOption,
}),
},
});
});

8
public/app/features/variables/state/templateVarsChangedInUrl.test.ts
Unescape View File

@ -1,3 +1,5 @@
import { TypedVariableModel } from '@grafana/data';
import { DashboardState, StoreState } from '../../../types';
import { DashboardModel, PanelModel } from '../../dashboard/state';
import { initialState } from '../../dashboard/state/reducers';
@ -5,7 +7,6 @@ import { variableAdapters } from '../adapters';
import { createConstantVariableAdapter } from '../constant/adapter';
import { createCustomVariableAdapter } from '../custom/adapter';
import { constantBuilder, customBuilder } from '../shared/testing/builders';
import { VariableModel } from '../types';
import { ExtendedUrlQueryMap } from '../utils';
import { templateVarsChangedInUrl } from './actions';
@ -16,7 +17,10 @@ const dashboardModel = new DashboardModel({});
variableAdapters.setInit(() => [createCustomVariableAdapter(), createConstantVariableAdapter()]);
async function getTestContext(urlQueryMap: ExtendedUrlQueryMap = {}, variable: VariableModel | undefined = undefined) {
async function getTestContext(
urlQueryMap: ExtendedUrlQueryMap = {},
variable: TypedVariableModel | undefined = undefined
) {
jest.clearAllMocks();
const key = 'key';

6
public/app/features/variables/state/upgradeLegacyQueries.test.ts
Unescape View File

@ -1,8 +1,8 @@
import { VariableSupportType } from '@grafana/data';
import { TypedVariableModel, VariableSupportType } from '@grafana/data';
import { thunkTester } from '../../../../test/core/thunk/thunkTester';
import { customBuilder, queryBuilder } from '../shared/testing/builders';
import { TransactionStatus, VariableModel } from '../types';
import { TransactionStatus } from '../types';
import { toKeyedVariableIdentifier } from '../utils';
import { upgradeLegacyQueries } from './actions';
@ -12,7 +12,7 @@ import { changeVariableProp } from './sharedReducer';
interface Args {
query?: any;
variable?: VariableModel;
variable?: TypedVariableModel;
datasource?: any;
transactionStatus?: TransactionStatus;
}

Write Preview
Loading…
Cancel
Save