Skip to content

N
nexpie-grafana-theme
Commit b904e0c6 by Hugo Häggmark Committed by GitHub
Options

Chore: Removes observableTester (#29369)

parent 465735a7
Showing with 80 additions and 242 deletions
packages/grafana-data/src/utils/index.ts
...@@ -17,4 +17,3 @@ export { locationUtil } from './location'; ...@@ -17,4 +17,3 @@ export { locationUtil } from './location';
export { urlUtil, UrlQueryMap, UrlQueryValue } from './url'; export { urlUtil, UrlQueryMap, UrlQueryValue } from './url';
export { DataLinkBuiltInVars, mapInternalLinkToExplore } from './dataLinks'; export { DataLinkBuiltInVars, mapInternalLinkToExplore } from './dataLinks';
export { DocsId } from './docs'; export { DocsId } from './docs';
export { observableTester } from './tests/observableTester';
packages/grafana-data/src/utils/tests/observableTester.ts deleted 100644 → 0
import { Observable } from 'rxjs';
interface ObservableTester<T> {
observable: Observable<T>;
done: {
(...args: any[]): any;
fail(error?: string | { message: string }): any;
};
}
interface SubscribeAndExpectOnNext<T> extends ObservableTester<T> {
expect: (value: T) => void;
}
interface SubscribeAndExpectOnNextAndComplete<T> extends ObservableTester<T> {
expectOnNext: (value: T) => void;
expectOnComplete: () => void;
}
interface SubscribeAndExpectOnComplete<T> extends ObservableTester<T> {
expect: () => void;
}
interface SubscribeAndExpectOnError<T> extends ObservableTester<T> {
expect: (err: any) => void;
}
export const observableTester = () => {
const subscribeAndExpectOnNext = <T>({ observable, expect, done }: SubscribeAndExpectOnNext<T>): void => {
observable.subscribe({
next: value => {
try {
expect(value);
} catch (err) {
done.fail(err);
}
},
error: err => done.fail(err),
complete: () => done(),
});
};
const subscribeAndExpectOnComplete = <T>({ observable, expect, done }: SubscribeAndExpectOnComplete<T>): void => {
observable.subscribe({
next: () => {},
error: err => done.fail(err),
complete: () => {
try {
expect();
done();
} catch (err) {
done.fail(err);
}
},
});
};
const subscribeAndExpectOnNextAndComplete = <T>({
observable,
expectOnComplete,
expectOnNext,
done,
}: SubscribeAndExpectOnNextAndComplete<T>): void => {
observable.subscribe({
next: (value: T) => {
try {
expectOnNext(value);
done();
} catch (err) {
done.fail(err);
}
},
error: err => done.fail(err),
complete: () => {
try {
expectOnComplete();
done();
} catch (err) {
done.fail(err);
}
},
});
};
const subscribeAndExpectOnError = <T>({ observable, expect, done }: SubscribeAndExpectOnError<T>): void => {
observable.subscribe({
next: () => {},
error: err => {
try {
expect(err);
done();
} catch (err) {
done.fail(err);
}
},
complete: () => {
done();
},
});
};
return {
subscribeAndExpectOnNext,
subscribeAndExpectOnComplete,
subscribeAndExpectOnNextAndComplete,
subscribeAndExpectOnError,
};
};
public/app/features/variables/query/queryRunners.test.ts
import { QueryRunners } from './queryRunners'; import { QueryRunners } from './queryRunners';
import { DefaultTimeRange, observableTester, VariableSupportType } from '@grafana/data'; import { DefaultTimeRange, VariableSupportType } from '@grafana/data';
import { VariableRefresh } from '../types'; import { VariableRefresh } from '../types';
import { of } from 'rxjs'; import { of } from 'rxjs';
...@@ -41,17 +41,14 @@ describe('QueryRunners', () => { ...@@ -41,17 +41,14 @@ describe('QueryRunners', () => {
}); });
const observable = runner.runRequest(runnerArgs, request); const observable = runner.runRequest(runnerArgs, request);
it('then it should return correct observable', done => { it('then it should return correct observable', async () => {
observableTester().subscribeAndExpectOnNext({ await expect(observable).toEmitValuesWith(received => {
observable, const value = received[0];
expect: values => { expect(value).toEqual({
expect(values).toEqual({ series: [{ text: 'A', value: 'A' }],
series: [{ text: 'A', value: 'A' }], state: 'Done',
state: 'Done', timeRange: { from: {}, raw: { from: '6h', to: 'now' }, to: {} },
timeRange: { from: {}, raw: { from: '6h', to: 'now' }, to: {} }, });
});
},
done,
}); });
}); });
...@@ -86,17 +83,14 @@ describe('QueryRunners', () => { ...@@ -86,17 +83,14 @@ describe('QueryRunners', () => {
}); });
const observable = runner.runRequest(runnerArgs, request); const observable = runner.runRequest(runnerArgs, request);
it('then it should return correct observable', done => { it('then it should return correct observable', async () => {
observableTester().subscribeAndExpectOnNext({ await expect(observable).toEmitValuesWith(received => {
observable, const values = received[0];
expect: values => { expect(values).toEqual({
expect(values).toEqual({ series: [{ text: 'A', value: 'A' }],
series: [{ text: 'A', value: 'A' }], state: 'Done',
state: 'Done', timeRange: { from: {}, raw: { from: '6h', to: 'now' }, to: {} },
timeRange: { from: {}, raw: { from: '6h', to: 'now' }, to: {} }, });
});
},
done,
}); });
}); });
...@@ -161,13 +155,10 @@ describe('QueryRunners', () => { ...@@ -161,13 +155,10 @@ describe('QueryRunners', () => {
}); });
const observable = runner.runRequest(runnerArgs, request); const observable = runner.runRequest(runnerArgs, request);
it('then it should return correct observable', done => { it('then it should return correct observable', async () => {
observableTester().subscribeAndExpectOnNext({ await expect(observable).toEmitValuesWith(received => {
observable, const value = received[0];
expect: value => { expect(value).toEqual({});
expect(value).toEqual({});
},
done,
}); });
}); });
...@@ -183,13 +174,10 @@ describe('QueryRunners', () => { ...@@ -183,13 +174,10 @@ describe('QueryRunners', () => {
}); });
const observable = runner.runRequest(runnerArgs, request); const observable = runner.runRequest(runnerArgs, request);
it('then it should return correct observable', done => { it('then it should return correct observable', async () => {
observableTester().subscribeAndExpectOnNext({ await expect(observable).toEmitValuesWith(received => {
observable, const value = received[0];
expect: value => { expect(value).toEqual({});
expect(value).toEqual({});
},
done,
}); });
}); });
...@@ -234,13 +222,10 @@ describe('QueryRunners', () => { ...@@ -234,13 +222,10 @@ describe('QueryRunners', () => {
const { runner, request, runnerArgs, runRequest, datasource } = getCustomTestContext(); const { runner, request, runnerArgs, runRequest, datasource } = getCustomTestContext();
const observable = runner.runRequest(runnerArgs, request); const observable = runner.runRequest(runnerArgs, request);
it('then it should return correct observable', done => { it('then it should return correct observable', async () => {
observableTester().subscribeAndExpectOnNext({ await expect(observable).toEmitValuesWith(received => {
observable, const value = received[0];
expect: value => { expect(value).toEqual({});
expect(value).toEqual({});
},
done,
}); });
}); });
...@@ -285,13 +270,10 @@ describe('QueryRunners', () => { ...@@ -285,13 +270,10 @@ describe('QueryRunners', () => {
const { runner, request, runnerArgs, runRequest, datasource } = getDatasourceTestContext(); const { runner, request, runnerArgs, runRequest, datasource } = getDatasourceTestContext();
const observable = runner.runRequest(runnerArgs, request); const observable = runner.runRequest(runnerArgs, request);
it('then it should return correct observable', done => { it('then it should return correct observable', async () => {
observableTester().subscribeAndExpectOnNext({ await expect(observable).toEmitValuesWith(received => {
observable, const value = received[0];
expect: value => { expect(value).toEqual({});
expect(value).toEqual({});
},
done,
}); });
}); });
......
public/app/plugins/datasource/cloud-monitoring/specs/datasource.test.ts
import { of, throwError } from 'rxjs'; import { of, throwError } from 'rxjs';
import { DataSourceInstanceSettings, observableTester, toUtc } from '@grafana/data'; import { DataSourceInstanceSettings, toUtc } from '@grafana/data';
import CloudMonitoringDataSource from '../datasource'; import CloudMonitoringDataSource from '../datasource';
import { metricDescriptors } from './testData'; import { metricDescriptors } from './testData';
...@@ -84,7 +84,7 @@ describe('CloudMonitoringDataSource', () => { ...@@ -84,7 +84,7 @@ describe('CloudMonitoringDataSource', () => {
describe('When performing query', () => { describe('When performing query', () => {
describe('and no time series data is returned', () => { describe('and no time series data is returned', () => {
it('should return a list of datapoints', done => { it('should return a list of datapoints', async () => {
const options = { const options = {
range: { range: {
from: toUtc('2017-08-22T20:00:00Z'), from: toUtc('2017-08-22T20:00:00Z'),
...@@ -116,12 +116,9 @@ describe('CloudMonitoringDataSource', () => { ...@@ -116,12 +116,9 @@ describe('CloudMonitoringDataSource', () => {
const { ds } = getTestcontext({ response }); const { ds } = getTestcontext({ response });
observableTester().subscribeAndExpectOnNext({ await expect(ds.query(options as any)).toEmitValuesWith(received => {
expect: results => { const results = received[0];
expect(results.data.length).toBe(0); expect(results.data.length).toBe(0);
},
observable: ds.query(options as any),
done,
}); });
}); });
}); });
......
public/app/plugins/datasource/cloudwatch/datasource.test.ts
import { of } from 'rxjs'; import { of } from 'rxjs';
import { setBackendSrv } from '@grafana/runtime'; import { setBackendSrv } from '@grafana/runtime';
import { dateTime, DefaultTimeRange, observableTester } from '@grafana/data'; import { dateTime, DefaultTimeRange } from '@grafana/data';
import { TemplateSrv } from '../../../features/templating/template_srv'; import { TemplateSrv } from '../../../features/templating/template_srv';
import { CloudWatchDatasource } from './datasource'; import { CloudWatchDatasource } from './datasource';
describe('datasource', () => { describe('datasource', () => {
describe('query', () => { describe('query', () => {
it('should return error if log query and log groups is not specified', done => { it('should return error if log query and log groups is not specified', async () => {
const { datasource } = setup(); const { datasource } = setup();
const observable = datasource.query({
targets: [
{
queryMode: 'Logs' as 'Logs',
},
],
} as any);
observableTester().subscribeAndExpectOnNext({ await expect(observable).toEmitValuesWith(received => {
observable: datasource.query({ const response = received[0];
targets: [ expect(response.error?.message).toBe('Log group is required');
{
queryMode: 'Logs' as 'Logs',
},
],
} as any),
expect: response => {
expect(response.error?.message).toBe('Log group is required');
},
done,
}); });
}); });
it('should return empty response if queries are hidden', done => { it('should return empty response if queries are hidden', async () => {
const { datasource } = setup(); const { datasource } = setup();
const observable = datasource.query({
targets: [
{
queryMode: 'Logs' as 'Logs',
hide: true,
},
],
} as any);
observableTester().subscribeAndExpectOnNext({ await expect(observable).toEmitValuesWith(received => {
observable: datasource.query({ const response = received[0];
targets: [ expect(response.data).toEqual([]);
{
queryMode: 'Logs' as 'Logs',
hide: true,
},
],
} as any),
expect: response => {
expect(response.data).toEqual([]);
},
done,
}); });
}); });
}); });
describe('performTimeSeriesQuery', () => { describe('performTimeSeriesQuery', () => {
it('should return the same length of data as result', done => { it('should return the same length of data as result', async () => {
const { datasource } = setup({ const { datasource } = setup({
data: { data: {
results: { results: {
...@@ -58,20 +54,19 @@ describe('datasource', () => { ...@@ -58,20 +54,19 @@ describe('datasource', () => {
const buildCloudwatchConsoleUrlMock = jest.spyOn(datasource, 'buildCloudwatchConsoleUrl'); const buildCloudwatchConsoleUrlMock = jest.spyOn(datasource, 'buildCloudwatchConsoleUrl');
buildCloudwatchConsoleUrlMock.mockImplementation(() => ''); buildCloudwatchConsoleUrlMock.mockImplementation(() => '');
observableTester().subscribeAndExpectOnNext({ const observable = datasource.performTimeSeriesQuery(
observable: datasource.performTimeSeriesQuery( {
{ queries: [
queries: [ { datasourceId: 1, refId: 'a' },
{ datasourceId: 1, refId: 'a' }, { datasourceId: 1, refId: 'b' },
{ datasourceId: 1, refId: 'b' }, ],
], } as any,
} as any, { from: dateTime(), to: dateTime() } as any
{ from: dateTime(), to: dateTime() } as any );
),
expect: response => { await expect(observable).toEmitValuesWith(received => {
expect(response.data.length).toEqual(2); const response = received[0];
}, expect(response.data.length).toEqual(2);
done,
}); });
}); });
}); });
......
public/app/plugins/datasource/loki/datasource.test.ts
...@@ -11,6 +11,7 @@ import { backendSrv } from 'app/core/services/backend_srv'; ...@@ -11,6 +11,7 @@ import { backendSrv } from 'app/core/services/backend_srv';
import { CustomVariableModel } from '../../../features/variables/types'; import { CustomVariableModel } from '../../../features/variables/types';
import { initialCustomVariableModelState } from '../../../features/variables/custom/reducer'; import { initialCustomVariableModelState } from '../../../features/variables/custom/reducer';
import { makeMockLokiDatasource } from './mocks'; import { makeMockLokiDatasource } from './mocks';
import { createFetchResponse } from 'test/helpers/createFetchResponse';
jest.mock('@grafana/runtime', () => ({ jest.mock('@grafana/runtime', () => ({
// @ts-ignore // @ts-ignore
...@@ -593,17 +594,3 @@ function makeMetadataAndVersionsMocks() { ...@@ -593,17 +594,3 @@ function makeMetadataAndVersionsMocks() {
} }
return mocks; return mocks;
} }
function createFetchResponse<T>(data: T): FetchResponse<T> {
return {
data,
status: 200,
url: 'http://localhost:3000/api/query',
config: { url: 'http://localhost:3000/api/query' },
type: 'basic',
statusText: 'Ok',
redirected: false,
headers: ({} as unknown) as Headers,
ok: true,
};
}
public/app/plugins/datasource/mssql/specs/datasource.test.ts
...@@ -6,7 +6,7 @@ import { TimeSrvStub } from 'test/specs/helpers'; ...@@ -6,7 +6,7 @@ import { TimeSrvStub } from 'test/specs/helpers';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from 'app/features/templating/template_srv';
import { backendSrv } from 'app/core/services/backend_srv'; import { backendSrv } from 'app/core/services/backend_srv';
import { initialCustomVariableModelState } from '../../../../features/variables/custom/reducer'; import { initialCustomVariableModelState } from '../../../../features/variables/custom/reducer';
import { FetchResponse } from '@grafana/runtime'; // will use the version in __mocks__ import { createFetchResponse } from 'test/helpers/createFetchResponse';
jest.mock('@grafana/runtime', () => ({ jest.mock('@grafana/runtime', () => ({
...((jest.requireActual('@grafana/runtime') as unknown) as object), ...((jest.requireActual('@grafana/runtime') as unknown) as object),
...@@ -334,17 +334,3 @@ describe('MSSQLDatasource', () => { ...@@ -334,17 +334,3 @@ describe('MSSQLDatasource', () => {
}); });
}); });
}); });
function createFetchResponse<T>(data: T): FetchResponse<T> {
return {
data,
status: 200,
url: 'http://localhost:3000/api/query',
config: { url: 'http://localhost:3000/api/query' },
type: 'basic',
statusText: 'Ok',
redirected: false,
headers: ({} as unknown) as Headers,
ok: true,
};
}
public/test/helpers/createFetchResponse.ts
...@@ -4,8 +4,8 @@ export function createFetchResponse<T>(data: T): FetchResponse<T> { ...@@ -4,8 +4,8 @@ export function createFetchResponse<T>(data: T): FetchResponse<T> {
return { return {
data, data,
status: 200, status: 200,
url: 'http://localhost:3000/api/query', url: 'http://localhost:3000/api/tsdb/query',
config: { url: 'http://localhost:3000/api/query' }, config: { url: 'http://localhost:3000/api/tsdb/query' },
type: 'basic', type: 'basic',
statusText: 'Ok', statusText: 'Ok',
redirected: false, redirected: false,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment