Skip to content

[IM] Remove axios dependency in tests #128171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sabarasaba merged 14 commits into from
Mar 24, 2022
Merged

[IM] Remove axios dependency in tests #128171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
809c581
wip: remove axios and start setup refactoring
sabarasaba Mar 21, 2022
ec80ba5
fix more tests
sabarasaba Mar 22, 2022
dd405c1
Fix index templates tab tests
sabarasaba Mar 22, 2022
ae9c3c9
Fix last issues with ds tests
sabarasaba Mar 22, 2022
8afc145
Start refactoring index_template_wizard
sabarasaba Mar 22, 2022
ba71517
wip working on template create tests
sabarasaba Mar 22, 2022
eee9c7c
commit using @elastic.co
sabarasaba Mar 23, 2022
500a75e
Finish fixing and refactoring all the tests
sabarasaba Mar 23, 2022
e8a291c
Finish refactoring rest of all tests
sabarasaba Mar 23, 2022
455a328
Finx linter issues
sabarasaba Mar 23, 2022
4bdcb26
Remove unused imports
sabarasaba Mar 23, 2022
ea7e7c5
Merge branch 'main' into im/remove_axios
kibanamachine Mar 23, 2022
feac4c0
Address CR changes
sabarasaba Mar 24, 2022
73d3108
Merge branch 'main' into im/remove_axios
kibanamachine Mar 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
249 changes: 105 additions & 144 deletions x-pack/plugins/index_management/__jest__/client_integration/helpers/http_requests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@
* 2.0.
*/

import sinon, { SinonFakeServer } from 'sinon';
import { httpServiceMock } from '../../../../../../src/core/public/mocks';
import { API_BASE_PATH } from '../../../common/constants';

type HttpResponse = Record<string, any> | any[];
type HttpMethod = 'GET' | 'PUT' | 'DELETE' | 'POST';

export interface ResponseError {
statusCode: number;
Expand All @@ -17,139 +18,105 @@ export interface ResponseError {
}

// Register helpers to mock HTTP Requests
const registerHttpRequestMockHelpers = (server: SinonFakeServer) => {
const setLoadTemplatesResponse = (response: HttpResponse = []) => {
server.respondWith('GET', `${API_BASE_PATH}/index_templates`, [
200,
{ 'Content-Type': 'application/json' },
JSON.stringify(response),
]);
};

const setLoadIndicesResponse = (response: HttpResponse = []) => {
server.respondWith('GET', `${API_BASE_PATH}/indices`, [
200,
{ 'Content-Type': 'application/json' },
JSON.stringify(response),
]);
};

const setReloadIndicesResponse = (response: HttpResponse = []) => {
server.respondWith('POST', `${API_BASE_PATH}/indices/reload`, [
200,
{ 'Content-Type': 'application/json' },
JSON.stringify(response),
]);
};

const setLoadDataStreamsResponse = (response: HttpResponse = []) => {
server.respondWith('GET', `${API_BASE_PATH}/data_streams`, [
200,
{ 'Content-Type': 'application/json' },
JSON.stringify(response),
]);
};

const setLoadDataStreamResponse = (response: HttpResponse = []) => {
server.respondWith('GET', `${API_BASE_PATH}/data_streams/:id`, [
200,
{ 'Content-Type': 'application/json' },
JSON.stringify(response),
]);
};

const setDeleteDataStreamResponse = (response: HttpResponse = []) => {
server.respondWith('POST', `${API_BASE_PATH}/delete_data_streams`, [
200,
{ 'Content-Type': 'application/json' },
JSON.stringify(response),
]);
};

const setDeleteTemplateResponse = (response: HttpResponse = []) => {
server.respondWith('POST', `${API_BASE_PATH}/delete_index_templates`, [
200,
{ 'Content-Type': 'application/json' },
JSON.stringify(response),
]);
};

const setLoadTemplateResponse = (response?: HttpResponse, error?: any) => {
const status = error ? error.status || 400 : 200;
const body = error ? error.body : response;

server.respondWith('GET', `${API_BASE_PATH}/index_templates/:id`, [
Copy link
Copy Markdown
Member Author

@sabarasaba sabarasaba Mar 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With sinon fake server we could use wildcards for url params, that is no longer allowed with HttpSetup mock. So we need to directly specify the full url when mocking api endpoints. For this particular case would look something like:

  const setLoadTemplateResponse = (
    templateId: string,
    response?: HttpResponse,
    error?: ResponseError
  ) => mockResponse('GET', `${API_BASE_PATH}/index_templates/${templateId}`, response, error);

status,
{ 'Content-Type': 'application/json' },
JSON.stringify(body),
]);
};

const setCreateTemplateResponse = (response?: HttpResponse, error?: any) => {
const status = error ? error.body.status || 400 : 200;
const body = error ? JSON.stringify(error.body) : JSON.stringify(response);

server.respondWith('POST', `${API_BASE_PATH}/index_templates`, [
status,
{ 'Content-Type': 'application/json' },
body,
]);
};

const setUpdateTemplateResponse = (response?: HttpResponse, error?: any) => {
const status = error ? error.status || 400 : 200;
const body = error ? JSON.stringify(error.body) : JSON.stringify(response);

server.respondWith('PUT', `${API_BASE_PATH}/index_templates/:name`, [
status,
{ 'Content-Type': 'application/json' },
body,
]);
};

const setUpdateIndexSettingsResponse = (response?: HttpResponse, error?: ResponseError) => {
const status = error ? error.statusCode || 400 : 200;
const body = error ?? response;

server.respondWith('PUT', `${API_BASE_PATH}/settings/:name`, [
status,
{ 'Content-Type': 'application/json' },
JSON.stringify(body),
]);
};

const setSimulateTemplateResponse = (response?: HttpResponse, error?: any) => {
const status = error ? error.status || 400 : 200;
const body = error ? JSON.stringify(error.body) : JSON.stringify(response);

server.respondWith('POST', `${API_BASE_PATH}/index_templates/simulate`, [
status,
{ 'Content-Type': 'application/json' },
body,
]);
};

const setLoadComponentTemplatesResponse = (response?: HttpResponse, error?: any) => {
const status = error ? error.status || 400 : 200;
const body = error ? error.body : response;

server.respondWith('GET', `${API_BASE_PATH}/component_templates`, [
status,
{ 'Content-Type': 'application/json' },
JSON.stringify(body),
]);
};

const setLoadNodesPluginsResponse = (response?: HttpResponse, error?: any) => {
const status = error ? error.status || 400 : 200;
const body = error ? error.body : response;

server.respondWith('GET', `${API_BASE_PATH}/nodes/plugins`, [
status,
{ 'Content-Type': 'application/json' },
JSON.stringify(body),
]);
};
const registerHttpRequestMockHelpers = (
Copy link
Copy Markdown
Contributor

@alisonelizabeth alisonelizabeth Mar 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Starting here to L56 seems to be the same code across the test refactoring PRs. Does it make sense to try to centralize it somewhere so it can be reused?

Copy link
Copy Markdown
Contributor

@alisonelizabeth alisonelizabeth Mar 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you agree, I think this can be done as a separate PR

Copy link
Copy Markdown
Member Author

@sabarasaba sabarasaba Mar 24, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've suggested also to put this somewhere in kbn-test (see this thread), but we ended up agreeing on keeping separate implementations per app for now. I'll create a new issue after on our side to update this later on after I finish updating all the tests.

httpSetup: ReturnType<typeof httpServiceMock.createStartContract>
) => {
const mockResponses = new Map<HttpMethod, Map<string, Promise<unknown>>>(
['GET', 'PUT', 'DELETE', 'POST'].map(
(method) => [method, new Map()] as [HttpMethod, Map<string, Promise<unknown>>]
)
);

const mockMethodImplementation = (method: HttpMethod, path: string) => {
return mockResponses.get(method)?.get(path) ?? Promise.resolve({});
};

httpSetup.get.mockImplementation((path) =>
mockMethodImplementation('GET', path as unknown as string)
);
httpSetup.delete.mockImplementation((path) =>
mockMethodImplementation('DELETE', path as unknown as string)
);
httpSetup.post.mockImplementation((path) =>
mockMethodImplementation('POST', path as unknown as string)
);
httpSetup.put.mockImplementation((path) =>
mockMethodImplementation('PUT', path as unknown as string)
);

const mockResponse = (method: HttpMethod, path: string, response?: unknown, error?: unknown) => {
const defuse = (promise: Promise<unknown>) => {
promise.catch(() => {});
return promise;
};

return mockResponses
.get(method)!
.set(path, error ? defuse(Promise.reject({ body: error })) : Promise.resolve(response));
};

const setLoadTemplatesResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('GET', `${API_BASE_PATH}/index_templates`, response, error);

const setLoadIndicesResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('GET', `${API_BASE_PATH}/indices`, response, error);

const setReloadIndicesResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('POST', `${API_BASE_PATH}/indices/reload`, response, error);

const setLoadDataStreamsResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('GET', `${API_BASE_PATH}/data_streams`, response, error);

const setLoadDataStreamResponse = (
dataStreamId: string,
response?: HttpResponse,
error?: ResponseError
) =>
mockResponse(
'GET',
`${API_BASE_PATH}/data_streams/${encodeURIComponent(dataStreamId)}`,
response,
error
);

const setDeleteDataStreamResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('POST', `${API_BASE_PATH}/delete_data_streams`, response, error);

const setDeleteTemplateResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('POST', `${API_BASE_PATH}/delete_index_templates`, response, error);

const setLoadTemplateResponse = (
templateId: string,
response?: HttpResponse,
error?: ResponseError
) => mockResponse('GET', `${API_BASE_PATH}/index_templates/${templateId}`, response, error);

const setCreateTemplateResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('POST', `${API_BASE_PATH}/index_templates`, response, error);

const setUpdateTemplateResponse = (
templateId: string,
response?: HttpResponse,
error?: ResponseError
) => mockResponse('PUT', `${API_BASE_PATH}/index_templates/${templateId}`, response, error);

const setUpdateIndexSettingsResponse = (
indexName: string,
response?: HttpResponse,
error?: ResponseError
) => mockResponse('PUT', `${API_BASE_PATH}/settings/${indexName}`, response, error);

const setSimulateTemplateResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('POST', `${API_BASE_PATH}/index_templates/simulate`, response, error);

const setLoadComponentTemplatesResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('GET', `${API_BASE_PATH}/component_templates`, response, error);

const setLoadNodesPluginsResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('GET', `${API_BASE_PATH}/nodes/plugins`, response, error);

const setLoadTelemetryResponse = (response?: HttpResponse, error?: ResponseError) =>
mockResponse('GET', '/api/ui_counters/_report', response, error);

return {
setLoadTemplatesResponse,
Expand All @@ -166,22 +133,16 @@ const registerHttpRequestMockHelpers = (server: SinonFakeServer) => {
setSimulateTemplateResponse,
setLoadComponentTemplatesResponse,
setLoadNodesPluginsResponse,
setLoadTelemetryResponse,
};
};

export const init = () => {
const server = sinon.fakeServer.create();
server.respondImmediately = true;

// Define default response for unhandled requests.
// We make requests to APIs which don't impact the component under test, e.g. UI metric telemetry,
// and we can mock them all with a 200 instead of mocking each one individually.
server.respondWith([200, {}, 'DefaultSinonMockServerResponse']);

const httpRequestsMockHelpers = registerHttpRequestMockHelpers(server);
const httpSetup = httpServiceMock.createSetupContract();
const httpRequestsMockHelpers = registerHttpRequestMockHelpers(httpSetup);

return {
server,
httpSetup,
httpRequestsMockHelpers,
};
};
20 changes: 6 additions & 14 deletions x-pack/plugins/index_management/__jest__/client_integration/helpers/setup_environment.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@
*/

import React from 'react';
import axios from 'axios';
import axiosXhrAdapter from 'axios/lib/adapters/xhr';
import { merge } from 'lodash';
import SemVer from 'semver/classes/semver';

import { HttpSetup } from 'src/core/public';
import {
notificationServiceMock,
docLinksServiceMock,
Expand All @@ -36,7 +35,6 @@ import {
import { componentTemplatesMockDependencies } from '../../../public/application/components/component_templates/__jest__';
import { init as initHttpRequests } from './http_requests';

const mockHttpClient = axios.create({ adapter: axiosXhrAdapter });
const { GlobalFlyoutProvider } = GlobalFlyout;

export const services = {
Expand Down Expand Up @@ -64,30 +62,24 @@ const { Provider: KibanaReactContextProvider } = createKibanaReactContext({
});

export const setupEnvironment = () => {
// Mock initialization of services
// @ts-ignore
httpService.setup(mockHttpClient);
breadcrumbService.setup(() => undefined);
documentationService.setup(docLinksServiceMock.createStartContract());
notificationService.setup(notificationServiceMock.createSetupContract());

const { server, httpRequestsMockHelpers } = initHttpRequests();

return {
server,
httpRequestsMockHelpers,
};
return initHttpRequests();
};

export const WithAppDependencies =
(Comp: any, overridingDependencies: any = {}) =>
(Comp: any, httpSetup: HttpSetup, overridingDependencies: any = {}) =>
(props: any) => {
httpService.setup(httpSetup);
const mergedDependencies = merge({}, appDependencies, overridingDependencies);

return (
<KibanaReactContextProvider>
<AppContextProvider value={mergedDependencies}>
<MappingsEditorProvider>
<ComponentTemplatesProvider value={componentTemplatesMockDependencies}>
<ComponentTemplatesProvider value={componentTemplatesMockDependencies(httpSetup)}>
<GlobalFlyoutProvider>
<Comp {...props} />
</GlobalFlyoutProvider>
Expand Down
8 changes: 6 additions & 2 deletions x-pack/plugins/index_management/__jest__/client_integration/home/data_streams_tab.helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
AsyncTestBedConfig,
findTestSubject,
} from '@kbn/test-jest-helpers';
import { HttpSetup } from 'src/core/public';
import { DataStream } from '../../../common';
import { IndexManagementHome } from '../../../public/application/sections/home';
import { indexManagementStore } from '../../../public/application/store';
Expand Down Expand Up @@ -46,7 +47,10 @@ export interface DataStreamsTabTestBed extends TestBed<TestSubjects> {
findDetailPanelIndexTemplateLink: () => ReactWrapper;
}

export const setup = async (overridingDependencies: any = {}): Promise<DataStreamsTabTestBed> => {
export const setup = async (
httpSetup: HttpSetup,
overridingDependencies: any = {}
): Promise<DataStreamsTabTestBed> => {
const testBedConfig: AsyncTestBedConfig = {
store: () => indexManagementStore(services as any),
memoryRouter: {
Expand All @@ -57,7 +61,7 @@ export const setup = async (overridingDependencies: any = {}): Promise<DataStrea
};

const initTestBed = registerTestBed(
WithAppDependencies(IndexManagementHome, overridingDependencies),
WithAppDependencies(IndexManagementHome, httpSetup, overridingDependencies),
testBedConfig
);
const testBed = await initTestBed();
Expand Down
Loading