github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

Create unit test for registerBuiltInActionTypes and move common code (#45648) (#45797)

Browse source 
* Create unit test for registerBuiltInActionTypes and move common code
This commit is contained in:
Yuliia Naumenko 2019-09-16 10:59:20 -07:00 • committed by GitHub
parent f110d8ff11
commit 65a9881765
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 82 additions and 162 deletions
Download patch file Download diff file Expand all files Collapse all files

39
x-pack/legacy/plugins/actions/server/builtin_action_types/email.test.ts
View file

@ -9,13 +9,9 @@ jest.mock('./lib/send_email', () => ({
}));
import { ActionType, ActionTypeExecutorOptions } from '../types';
import { ActionsConfigurationUtilities } from '../actions_config';
import { ActionTypeRegistry } from '../action_type_registry';
import { encryptedSavedObjectsMock } from '../../../encrypted_saved_objects/server/plugin.mock';
import { taskManagerMock } from '../../../task_manager/task_manager.mock';
import { validateParams, validateConfig, validateSecrets } from '../lib';
import { validateConfig, validateSecrets, validateParams } from '../lib';
import { SavedObjectsClientMock } from '../../../../../../src/core/server/mocks';
import { registerBuiltInActionTypes } from './index';
import { createActionTypeRegistry } from './index.test';
import { sendEmail } from './lib/send_email';
import { ActionParamsType, ActionTypeConfigType, ActionTypeSecretsType } from './email';
@ -23,12 +19,6 @@ const sendEmailMock = sendEmail as jest.Mock;
const ACTION_TYPE_ID = '.email';
const NO_OP_FN = () => {};
const MOCK_KIBANA_CONFIG_UTILS: ActionsConfigurationUtilities = {
isWhitelistedHostname: _ => true,
isWhitelistedUri: _ => true,
ensureWhitelistedHostname: _ => {},
ensureWhitelistedUri: _ => {},
};
const services = {
log: NO_OP_FN,
@ -36,27 +26,10 @@ const services = {
savedObjectsClient: SavedObjectsClientMock.create(),
};
function getServices() {
return services;
}
let actionTypeRegistry: ActionTypeRegistry;
let actionType: ActionType;
const mockEncryptedSavedObjectsPlugin = encryptedSavedObjectsMock.create();
beforeAll(() => {
actionTypeRegistry = new ActionTypeRegistry({
getServices,
isSecurityEnabled: true,
taskManager: taskManagerMock.create(),
encryptedSavedObjectsPlugin: mockEncryptedSavedObjectsPlugin,
spaceIdToNamespace: jest.fn().mockReturnValue(undefined),
getBasePath: jest.fn().mockReturnValue(undefined),
});
registerBuiltInActionTypes(actionTypeRegistry, MOCK_KIBANA_CONFIG_UTILS);
const actionTypeRegistry = createActionTypeRegistry();
actionType = actionTypeRegistry.get(ACTION_TYPE_ID);
});
@ -64,12 +37,6 @@ beforeEach(() => {
jest.resetAllMocks();
});
describe('action is registered', () => {
test('gets registered with builtin actions', () => {
expect(actionTypeRegistry.has(ACTION_TYPE_ID)).toEqual(true);
});
});
describe('actionTypeRegistry.get() works', () => {
test('action type static data is as expected', () => {
expect(actionType.id).toEqual(ACTION_TYPE_ID);

37
x-pack/legacy/plugins/actions/server/builtin_action_types/es_index.test.ts
View file

@ -9,23 +9,13 @@ jest.mock('./lib/send_email', () => ({
}));
import { ActionType, ActionTypeExecutorOptions } from '../types';
import { ActionsConfigurationUtilities } from '../actions_config';
import { ActionTypeRegistry } from '../action_type_registry';
import { encryptedSavedObjectsMock } from '../../../encrypted_saved_objects/server/plugin.mock';
import { taskManagerMock } from '../../../task_manager/task_manager.mock';
import { validateConfig, validateParams } from '../lib';
import { SavedObjectsClientMock } from '../../../../../../src/core/server/mocks';
import { registerBuiltInActionTypes } from './index';
import { createActionTypeRegistry } from './index.test';
import { ActionParamsType, ActionTypeConfigType } from './es_index';
const ACTION_TYPE_ID = '.index';
const NO_OP_FN = () => {};
const MOCK_KIBANA_CONFIG_UTILS: ActionsConfigurationUtilities = {
isWhitelistedHostname: _ => true,
isWhitelistedUri: _ => true,
ensureWhitelistedHostname: _ => {},
ensureWhitelistedUri: _ => {},
};
const services = {
log: NO_OP_FN,
@ -33,27 +23,10 @@ const services = {
savedObjectsClient: SavedObjectsClientMock.create(),
};
function getServices() {
return services;
}
let actionTypeRegistry: ActionTypeRegistry;
let actionType: ActionType;
const mockEncryptedSavedObjectsPlugin = encryptedSavedObjectsMock.create();
beforeAll(() => {
actionTypeRegistry = new ActionTypeRegistry({
getServices,
isSecurityEnabled: true,
taskManager: taskManagerMock.create(),
encryptedSavedObjectsPlugin: mockEncryptedSavedObjectsPlugin,
spaceIdToNamespace: jest.fn().mockReturnValue(undefined),
getBasePath: jest.fn().mockReturnValue(undefined),
});
registerBuiltInActionTypes(actionTypeRegistry, MOCK_KIBANA_CONFIG_UTILS);
const actionTypeRegistry = createActionTypeRegistry();
actionType = actionTypeRegistry.get(ACTION_TYPE_ID);
});
@ -61,12 +34,6 @@ beforeEach(() => {
jest.resetAllMocks();
});
describe('action is registered', () => {
test('gets registered with builtin actions', () => {
expect(actionTypeRegistry.has(ACTION_TYPE_ID)).toEqual(true);
});
});
describe('actionTypeRegistry.get() works', () => {
test('action type static data is as expected', () => {
expect(actionType.id).toEqual(ACTION_TYPE_ID);

59
x-pack/legacy/plugins/actions/server/builtin_action_types/index.test.ts Normal file
View file

@ -0,0 +1,59 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/
import { ActionsConfigurationUtilities } from '../actions_config';
import { ActionTypeRegistry } from '../action_type_registry';
import { encryptedSavedObjectsMock } from '../../../encrypted_saved_objects/server/plugin.mock';
import { taskManagerMock } from '../../../task_manager/task_manager.mock';
import { SavedObjectsClientMock } from '../../../../../../src/core/server/mocks';
import { registerBuiltInActionTypes } from './index';
const ACTION_TYPE_IDS = ['.index', '.email', '.pagerduty', '.server-log', '.slack', '.webhook'];
const NO_OP_FN = () => {};
const MOCK_KIBANA_CONFIG_UTILS: ActionsConfigurationUtilities = {
isWhitelistedHostname: _ => true,
isWhitelistedUri: _ => true,
ensureWhitelistedHostname: _ => {},
ensureWhitelistedUri: _ => {},
};
const services = {
log: NO_OP_FN,
callCluster: jest.fn(),
savedObjectsClient: SavedObjectsClientMock.create(),
};
function getServices() {
return services;
}
const mockEncryptedSavedObjectsPlugin = encryptedSavedObjectsMock.create();
export function createActionTypeRegistry(): ActionTypeRegistry {
const actionTypeRegistry = new ActionTypeRegistry({
getServices,
isSecurityEnabled: true,
taskManager: taskManagerMock.create(),
encryptedSavedObjectsPlugin: mockEncryptedSavedObjectsPlugin,
spaceIdToNamespace: jest.fn().mockReturnValue(undefined),
getBasePath: jest.fn().mockReturnValue(undefined),
});
registerBuiltInActionTypes(actionTypeRegistry, MOCK_KIBANA_CONFIG_UTILS);
return actionTypeRegistry;
}
beforeEach(() => {
jest.resetAllMocks();
});
describe('action is registered', () => {
test('gets registered with builtin actions', () => {
const actionTypeRegistry = createActionTypeRegistry();
ACTION_TYPE_IDS.forEach(ACTION_TYPE_ID =>
expect(actionTypeRegistry.has(ACTION_TYPE_ID)).toEqual(true)
);
});
});

35
x-pack/legacy/plugins/actions/server/builtin_action_types/pagerduty.test.ts
View file

@ -9,25 +9,15 @@ jest.mock('./lib/post_pagerduty', () => ({
}));
import { ActionType, Services, ActionTypeExecutorOptions } from '../types';
import { ActionsConfigurationUtilities } from '../actions_config';
import { ActionTypeRegistry } from '../action_type_registry';
import { taskManagerMock } from '../../../task_manager/task_manager.mock';
import { encryptedSavedObjectsMock } from '../../../encrypted_saved_objects/server/plugin.mock';
import { validateConfig, validateSecrets, validateParams } from '../lib';
import { SavedObjectsClientMock } from '../../../../../../src/core/server/mocks';
import { postPagerduty } from './lib/post_pagerduty';
import { registerBuiltInActionTypes } from './index';
import { createActionTypeRegistry } from './index.test';
const postPagerdutyMock = postPagerduty as jest.Mock;
const ACTION_TYPE_ID = '.pagerduty';
const NO_OP_FN = () => {};
const MOCK_KIBANA_CONFIG_UTILS: ActionsConfigurationUtilities = {
isWhitelistedHostname: _ => true,
isWhitelistedUri: _ => true,
ensureWhitelistedHostname: _ => {},
ensureWhitelistedUri: _ => {},
};
const services: Services = {
log: NO_OP_FN,
@ -35,25 +25,10 @@ const services: Services = {
savedObjectsClient: SavedObjectsClientMock.create(),
};
function getServices(): Services {
return services;
}
let actionType: ActionType;
let actionTypeRegistry: ActionTypeRegistry;
const mockEncryptedSavedObjectsPlugin = encryptedSavedObjectsMock.create();
beforeAll(() => {
actionTypeRegistry = new ActionTypeRegistry({
getServices,
isSecurityEnabled: true,
taskManager: taskManagerMock.create(),
encryptedSavedObjectsPlugin: mockEncryptedSavedObjectsPlugin,
spaceIdToNamespace: jest.fn().mockReturnValue(undefined),
getBasePath: jest.fn().mockReturnValue(undefined),
});
registerBuiltInActionTypes(actionTypeRegistry, MOCK_KIBANA_CONFIG_UTILS);
const actionTypeRegistry = createActionTypeRegistry();
actionType = actionTypeRegistry.get(ACTION_TYPE_ID);
});
@ -61,12 +36,6 @@ beforeEach(() => {
services.log = NO_OP_FN;
});
describe('action registation', () => {
test('should be successful', () => {
expect(actionTypeRegistry.has(ACTION_TYPE_ID)).toEqual(true);
});
});
describe('get()', () => {
test('should return correct action type', () => {
expect(actionType.id).toEqual(ACTION_TYPE_ID);

48
x-pack/legacy/plugins/actions/server/builtin_action_types/server_log.test.ts
View file

@ -5,23 +5,12 @@
*/
import { ActionType, Services } from '../types';
import { ActionsConfigurationUtilities } from '../actions_config';
import { ActionTypeRegistry } from '../action_type_registry';
import { taskManagerMock } from '../../../task_manager/task_manager.mock';
import { encryptedSavedObjectsMock } from '../../../encrypted_saved_objects/server/plugin.mock';
import { validateParams } from '../lib';
import { SavedObjectsClientMock } from '../../../../../../src/core/server/mocks';
import { registerBuiltInActionTypes } from './index';
import { createActionTypeRegistry } from './index.test';
const ACTION_TYPE_ID = '.server-log';
const NO_OP_FN = () => {};
const MOCK_KIBANA_CONFIG_UTILS: ActionsConfigurationUtilities = {
isWhitelistedHostname: _ => true,
isWhitelistedUri: _ => true,
ensureWhitelistedHostname: _ => {},
ensureWhitelistedUri: _ => {},
};
const services: Services = {
log: NO_OP_FN,
@ -29,52 +18,26 @@ const services: Services = {
savedObjectsClient: SavedObjectsClientMock.create(),
};
function getServices(): Services {
return services;
}
let actionTypeRegistry: ActionTypeRegistry;
const mockEncryptedSavedObjectsPlugin = encryptedSavedObjectsMock.create();
let actionType: ActionType;
beforeAll(() => {
actionTypeRegistry = new ActionTypeRegistry({
getServices,
isSecurityEnabled: true,
taskManager: taskManagerMock.create(),
encryptedSavedObjectsPlugin: mockEncryptedSavedObjectsPlugin,
spaceIdToNamespace: jest.fn().mockReturnValue(undefined),
getBasePath: jest.fn().mockReturnValue(undefined),
});
registerBuiltInActionTypes(actionTypeRegistry, MOCK_KIBANA_CONFIG_UTILS);
const actionTypeRegistry = createActionTypeRegistry();
actionType = actionTypeRegistry.get(ACTION_TYPE_ID);
expect(actionType).toBeTruthy();
});
beforeEach(() => {
services.log = NO_OP_FN;
});
describe('action is registered', () => {
test('gets registered with builtin actions', () => {
expect(actionTypeRegistry.has(ACTION_TYPE_ID)).toEqual(true);
});
});
describe('get()', () => {
test('returns action type', () => {
const actionType = actionTypeRegistry.get(ACTION_TYPE_ID);
expect(actionType.id).toEqual(ACTION_TYPE_ID);
expect(actionType.name).toEqual('server-log');
});
});
describe('validateParams()', () => {
let actionType: ActionType;
beforeAll(() => {
actionType = actionTypeRegistry.get(ACTION_TYPE_ID);
expect(actionType).toBeTruthy();
});
test('should validate and pass when params is valid', () => {
expect(validateParams(actionType, { message: 'a message' })).toEqual({
message: 'a message',
@ -123,7 +86,6 @@ describe('execute()', () => {
const mockLog = jest.fn().mockResolvedValueOnce({ success: true });
services.log = mockLog;
const actionType = actionTypeRegistry.get(ACTION_TYPE_ID);
const id = 'some-id';
await actionType.executor({
id,

26
x-pack/legacy/plugins/actions/server/builtin_action_types/webhook.test.ts
View file

@ -7,7 +7,10 @@
import { getActionType } from './webhook';
import { validateConfig, validateSecrets, validateParams } from '../lib';
import { ActionsConfigurationUtilities } from '../actions_config';
import { ActionType } from '../types';
import { createActionTypeRegistry } from './index.test';
const ACTION_TYPE_ID = '.webhook';
const configUtilsMock: ActionsConfigurationUtilities = {
isWhitelistedHostname: _ => true,
isWhitelistedUri: _ => true,
@ -15,9 +18,15 @@ const configUtilsMock: ActionsConfigurationUtilities = {
ensureWhitelistedUri: _ => {},
};
let actionType: ActionType;
beforeAll(() => {
const actionTypeRegistry = createActionTypeRegistry();
actionType = actionTypeRegistry.get(ACTION_TYPE_ID);
});
describe('actionType', () => {
test('exposes the action as `webhook` on its Id and Name', () => {
const actionType = getActionType(configUtilsMock);
expect(actionType.id).toEqual('.webhook');
expect(actionType.name).toEqual('webhook');
});
@ -25,7 +34,6 @@ describe('actionType', () => {
describe('secrets validation', () => {
test('succeeds when secrets is valid', () => {
const actionType = getActionType(configUtilsMock);
const secrets: Record<string, any> = {
user: 'bob',
password: 'supersecret',
@ -35,7 +43,6 @@ describe('secrets validation', () => {
test('fails when secret password is omitted', () => {
expect(() => {
const actionType = getActionType(configUtilsMock);
validateSecrets(actionType, { user: 'bob' });
}).toThrowErrorMatchingInlineSnapshot(
`"error validating action type secrets: [password]: expected value of type [string] but got [undefined]"`
@ -44,7 +51,6 @@ describe('secrets validation', () => {
test('fails when secret user is omitted', () => {
expect(() => {
const actionType = getActionType(configUtilsMock);
validateSecrets(actionType, {});
}).toThrowErrorMatchingInlineSnapshot(
`"error validating action type secrets: [user]: expected value of type [string] but got [undefined]"`
@ -59,7 +65,6 @@ describe('config validation', () => {
};
test('config validation passes when only required fields are provided', () => {
const actionType = getActionType(configUtilsMock);
const config: Record<string, any> = {
url: 'http://mylisteningserver:9200/endpoint',
};
@ -70,7 +75,6 @@ describe('config validation', () => {
});
test('config validation passes when valid methods are provided', () => {
const actionType = getActionType(configUtilsMock);
['post', 'put'].forEach(method => {
const config: Record<string, any> = {
url: 'http://mylisteningserver:9200/endpoint',
@ -84,7 +88,6 @@ describe('config validation', () => {
});
test('should validate and throw error when method on config is invalid', () => {
const actionType = getActionType(configUtilsMock);
const config: Record<string, any> = {
url: 'http://mylisteningserver:9200/endpoint',
method: 'https',
@ -99,7 +102,6 @@ describe('config validation', () => {
});
test('config validation passes when a url is specified', () => {
const actionType = getActionType(configUtilsMock);
const config: Record<string, any> = {
url: 'http://mylisteningserver:9200/endpoint',
};
@ -110,7 +112,6 @@ describe('config validation', () => {
});
test('config validation passes when valid headers are provided', () => {
const actionType = getActionType(configUtilsMock);
const config: Record<string, any> = {
url: 'http://mylisteningserver:9200/endpoint',
headers: {
@ -124,7 +125,6 @@ describe('config validation', () => {
});
test('should validate and throw error when headers on config is invalid', () => {
const actionType = getActionType(configUtilsMock);
const config: Record<string, any> = {
url: 'http://mylisteningserver:9200/endpoint',
headers: 'application/json',
@ -139,8 +139,6 @@ describe('config validation', () => {
});
test('config validation passes when kibana config whitelists the url', () => {
const actionType = getActionType(configUtilsMock);
const config: Record<string, any> = {
url: 'http://mylisteningserver.com:9200/endpoint',
headers: {
@ -155,7 +153,7 @@ describe('config validation', () => {
});
test('config validation returns an error if the specified URL isnt whitelisted', () => {
const actionType = getActionType({
actionType = getActionType({
...configUtilsMock,
ensureWhitelistedUri: _ => {
throw new Error(`target url is not whitelisted`);
@ -179,13 +177,11 @@ describe('config validation', () => {
describe('params validation', () => {
test('param validation passes when no fields are provided as none are required', () => {
const actionType = getActionType(configUtilsMock);
const params: Record<string, any> = {};
expect(validateParams(actionType, params)).toEqual({});
});
test('params validation passes when a valid body is provided', () => {
const actionType = getActionType(configUtilsMock);
const params: Record<string, any> = {
body: 'count: {{ctx.payload.hits.total}}',
};