mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
3c433dc36d
* refactor(Plugins/Admin): add a type for version coming back from the API * refactor(Plugins/Admin): only add necessary version information to the state * test(Plugins/Admin): add a mock for a CatalogPlugin * test(Plugins/ADmin): add a mock for a LocalPlugin * test(Plugins/Admin): add a test for a RemotePlugin * test(Plugins/Admin): add helpers for mocking plugin states * refactor(Plugins/Admin): mock the Redux state instead of the API responses This makes it simpler to add new test cases and also makes the tests easier to reason about. * refactor(Plugins/Admin): mock the Redux state instead of the API responses
83 lines
3.1 KiB
TypeScript
83 lines
3.1 KiB
TypeScript
import { setBackendSrv } from '@grafana/runtime';
|
|
import { PluginsState } from 'app/types';
|
|
import { API_ROOT, GRAFANA_API_ROOT } from '../constants';
|
|
import { CatalogPlugin, LocalPlugin, RemotePlugin, Version } from '../types';
|
|
import remotePluginMock from './remotePlugin.mock';
|
|
import localPluginMock from './localPlugin.mock';
|
|
import catalogPluginMock from './catalogPlugin.mock';
|
|
|
|
// Returns a sample mock for a CatalogPlugin plugin with the possibility to extend it
|
|
export const getCatalogPluginMock = (overrides?: Partial<CatalogPlugin>) => ({ ...catalogPluginMock, ...overrides });
|
|
|
|
// Returns a sample mock for a local (installed) plugin with the possibility to extend it
|
|
export const getLocalPluginMock = (overrides?: Partial<LocalPlugin>) => ({ ...localPluginMock, ...overrides });
|
|
|
|
// Returns a sample mock for a remote plugin with the possibility to extend it
|
|
export const getRemotePluginMock = (overrides?: Partial<RemotePlugin>) => ({ ...remotePluginMock, ...overrides });
|
|
|
|
// Returns a mock for the Redux store state of plugins
|
|
export const getPluginsStateMock = (plugins: CatalogPlugin[] = []): PluginsState => ({
|
|
// @ts-ignore - We don't need the rest of the properties here as we are using the "new" reducer (public/app/features/plugins/admin/state/reducer.ts)
|
|
items: {
|
|
ids: plugins.map(({ id }) => id),
|
|
entities: plugins.reduce((prev, current) => ({ ...prev, [current.id]: current }), {}),
|
|
},
|
|
requests: {
|
|
'plugins/fetchAll': {
|
|
status: 'Fulfilled',
|
|
},
|
|
'plugins/fetchDetails': {
|
|
status: 'Fulfilled',
|
|
},
|
|
},
|
|
});
|
|
|
|
// Mocks a plugin by considering what needs to be mocked from GCOM and what needs to be mocked locally (local Grafana API)
|
|
export const mockPluginApis = ({
|
|
remote: remoteOverride,
|
|
local: localOverride,
|
|
versions,
|
|
}: {
|
|
remote?: Partial<RemotePlugin>;
|
|
local?: Partial<LocalPlugin>;
|
|
versions?: Version[];
|
|
}) => {
|
|
const remote = getRemotePluginMock(remoteOverride);
|
|
const local = getLocalPluginMock(localOverride);
|
|
const original = jest.requireActual('@grafana/runtime');
|
|
const originalBackendSrv = original.getBackendSrv();
|
|
|
|
setBackendSrv({
|
|
...originalBackendSrv,
|
|
get: (path: string) => {
|
|
// Mock GCOM plugins (remote) if necessary
|
|
if (remote && path === `${GRAFANA_API_ROOT}/plugins`) {
|
|
return Promise.resolve({ items: [remote] });
|
|
}
|
|
|
|
// Mock GCOM single plugin page (remote) if necessary
|
|
if (remote && path === `${GRAFANA_API_ROOT}/plugins/${remote.slug}`) {
|
|
return Promise.resolve(remote);
|
|
}
|
|
|
|
// Mock versions
|
|
if (versions && path === `${GRAFANA_API_ROOT}/plugins/${remote.slug}/versions`) {
|
|
return Promise.resolve({ items: versions });
|
|
}
|
|
|
|
// Mock local plugin settings (installed) if necessary
|
|
if (local && path === `${API_ROOT}/${local.id}/settings`) {
|
|
return Promise.resolve(local);
|
|
}
|
|
|
|
// Mock local plugin listing (of necessary)
|
|
if (local && path === API_ROOT) {
|
|
return Promise.resolve([local]);
|
|
}
|
|
|
|
// Fall back to the original .get() in other cases
|
|
return originalBackendSrv.get(path);
|
|
},
|
|
});
|
|
};
|