Skip to content

Cleanup actions plugin #37250

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
merged 8 commits into from
May 30, 2019
Merged

Cleanup actions plugin #37250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4f62bb4
Cleanup actions, move code from alerting plugin PR
mikecote May 28, 2019
b8c007b
Rename service terminology to registry
mikecote May 28, 2019
7d5af75
Use static encryption key for encrypted attributes plugin inside of t…
mikecote May 29, 2019
b35b17d
Empty data after create test is done running
mikecote May 29, 2019
71eb264
Merge with upstream
mikecote May 29, 2019
2248ed7
Fix type checks
mikecote May 29, 2019
0ddcfd9
Fix inconsistent naming
mikecote May 30, 2019
bd82b20
Merge branch 'feature/alerting' of github.com:elastic/kibana into ale…
mikecote May 30, 2019
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
112 changes: 56 additions & 56 deletions ...rver/__jest__/action_type_service.test.ts → ...ver/__jest__/action_type_registry.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,37 @@
*/

import Joi from 'joi';
import { ActionTypeService } from '../action_type_service';
import { ActionTypeRegistry } from '../action_type_registry';

const services = {
log: jest.fn(),
};
const actionTypeServiceParams = {
const actionTypeRegistryParams = {
services,
};

describe('register()', () => {
test('able to register action types', () => {
const executor = jest.fn();
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
executor,
});
expect(actionTypeService.has('my-action-type')).toEqual(true);
expect(actionTypeRegistry.has('my-action-type')).toEqual(true);
});

test('throws error if action type already registered', () => {
const executor = jest.fn();
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
executor,
});
expect(() =>
actionTypeService.register({
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
executor,
Expand All @@ -48,13 +48,13 @@ describe('register()', () => {

describe('get()', () => {
test('returns action type', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
async executor() {},
});
const actionType = actionTypeService.get('my-action-type');
const actionType = actionTypeRegistry.get('my-action-type');
expect(actionType).toMatchInlineSnapshot(`
Object {
"executor": [Function],
Expand All @@ -65,47 +65,47 @@ Object {
});

test(`throws an error when action type doesn't exist`, () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
expect(() => actionTypeService.get('my-action-type')).toThrowErrorMatchingInlineSnapshot(
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
expect(() => actionTypeRegistry.get('my-action-type')).toThrowErrorMatchingInlineSnapshot(
`"Action type \\"my-action-type\\" is not registered."`
);
});
});

describe('getUnencryptedAttributes()', () => {
test('returns empty array when unencryptedAttributes is undefined', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
async executor() {},
});
const result = actionTypeService.getUnencryptedAttributes('my-action-type');
const result = actionTypeRegistry.getUnencryptedAttributes('my-action-type');
expect(result).toEqual([]);
});

test('returns values inside unencryptedAttributes array when it exists', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
unencryptedAttributes: ['a', 'b', 'c'],
async executor() {},
});
const result = actionTypeService.getUnencryptedAttributes('my-action-type');
const result = actionTypeRegistry.getUnencryptedAttributes('my-action-type');
expect(result).toEqual(['a', 'b', 'c']);
});
});

describe('list()', () => {
test('returns list of action types', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
async executor() {},
});
const actionTypes = actionTypeService.list();
const actionTypes = actionTypeRegistry.list();
expect(actionTypes).toEqual([
{
id: 'my-action-type',
Expand All @@ -117,18 +117,18 @@ describe('list()', () => {

describe('validateParams()', () => {
test('should pass when validation not defined', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
async executor() {},
});
actionTypeService.validateParams('my-action-type', {});
actionTypeRegistry.validateParams('my-action-type', {});
});

test('should validate and pass when params is valid', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
validate: {
Expand All @@ -140,12 +140,12 @@ describe('validateParams()', () => {
},
async executor() {},
});
actionTypeService.validateParams('my-action-type', { param1: 'value' });
actionTypeRegistry.validateParams('my-action-type', { param1: 'value' });
});

test('should validate and throw error when params is invalid', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
validate: {
Expand All @@ -158,7 +158,7 @@ describe('validateParams()', () => {
async executor() {},
});
expect(() =>
actionTypeService.validateParams('my-action-type', {})
actionTypeRegistry.validateParams('my-action-type', {})
).toThrowErrorMatchingInlineSnapshot(
`"child \\"param1\\" fails because [\\"param1\\" is required]"`
);
Expand All @@ -167,18 +167,18 @@ describe('validateParams()', () => {

describe('validateActionTypeConfig()', () => {
test('should pass when validation not defined', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
async executor() {},
});
actionTypeService.validateActionTypeConfig('my-action-type', {});
actionTypeRegistry.validateActionTypeConfig('my-action-type', {});
});

test('should validate and pass when actionTypeConfig is valid', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
validate: {
Expand All @@ -190,12 +190,12 @@ describe('validateActionTypeConfig()', () => {
},
async executor() {},
});
actionTypeService.validateActionTypeConfig('my-action-type', { param1: 'value' });
actionTypeRegistry.validateActionTypeConfig('my-action-type', { param1: 'value' });
});

test('should validate and throw error when actionTypeConfig is invalid', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
validate: {
Expand All @@ -208,7 +208,7 @@ describe('validateActionTypeConfig()', () => {
async executor() {},
});
expect(() =>
actionTypeService.validateActionTypeConfig('my-action-type', {})
actionTypeRegistry.validateActionTypeConfig('my-action-type', {})
).toThrowErrorMatchingInlineSnapshot(
`"child \\"param1\\" fails because [\\"param1\\" is required]"`
);
Expand All @@ -217,32 +217,32 @@ describe('validateActionTypeConfig()', () => {

describe('has()', () => {
test('returns false for unregistered action types', () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
expect(actionTypeService.has('my-action-type')).toEqual(false);
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
expect(actionTypeRegistry.has('my-action-type')).toEqual(false);
});

test('returns true after registering an action type', () => {
const executor = jest.fn();
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
executor,
});
expect(actionTypeService.has('my-action-type'));
expect(actionTypeRegistry.has('my-action-type'));
});
});

describe('execute()', () => {
test('calls the executor with proper params', async () => {
const executor = jest.fn().mockResolvedValueOnce({ success: true });
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
executor,
});
await actionTypeService.execute({
await actionTypeRegistry.execute({
id: 'my-action-type',
actionTypeConfig: { foo: true },
params: { bar: false },
Expand Down Expand Up @@ -276,8 +276,8 @@ describe('execute()', () => {

test('validates params', async () => {
const executor = jest.fn().mockResolvedValueOnce({ success: true });
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
executor,
Expand All @@ -290,7 +290,7 @@ describe('execute()', () => {
},
});
await expect(
actionTypeService.execute({
actionTypeRegistry.execute({
id: 'my-action-type',
actionTypeConfig: {},
params: {},
Expand All @@ -302,8 +302,8 @@ describe('execute()', () => {

test('validates actionTypeConfig', async () => {
const executor = jest.fn().mockResolvedValueOnce({ success: true });
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
actionTypeService.register({
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
actionTypeRegistry.register({
id: 'my-action-type',
name: 'My action type',
executor,
Expand All @@ -316,7 +316,7 @@ describe('execute()', () => {
},
});
await expect(
actionTypeService.execute({
actionTypeRegistry.execute({
id: 'my-action-type',
actionTypeConfig: {},
params: {},
Expand All @@ -327,9 +327,9 @@ describe('execute()', () => {
});

test('throws error if action type not registered', async () => {
const actionTypeService = new ActionTypeService(actionTypeServiceParams);
const actionTypeRegistry = new ActionTypeRegistry(actionTypeRegistryParams);
await expect(
actionTypeService.execute({
actionTypeRegistry.execute({
id: 'my-action-type',
actionTypeConfig: { foo: true },
params: { bar: false },
Expand Down
Loading