Define minimum license required for each alert type

elastic · Dec 4, 2020 · f426a70 · f426a70
1 parent 3b92fa2
commit f426a70
Show file tree

Hide file tree

Showing 52 changed files with 213 additions and 17 deletions.
diff --git a/x-pack/examples/alerting_example/server/alert_types/always_firing.ts b/x-pack/examples/alerting_example/server/alert_types/always_firing.ts
@@ -41,6 +41,7 @@ export const alertType: AlertType<AlwaysFiringParams> = {
   name: 'Always firing',
   actionGroups: ACTION_GROUPS,
   defaultActionGroupId: DEFAULT_ACTION_GROUP,
+  minimumLicenseRequired: 'basic',
   async executor({
     services,
     params: { instances = DEFAULT_INSTANCES_TO_GENERATE, thresholds },

diff --git a/x-pack/examples/alerting_example/server/alert_types/astros.ts b/x-pack/examples/alerting_example/server/alert_types/astros.ts
@@ -42,6 +42,7 @@ export const alertType: AlertType = {
   id: 'example.people-in-space',
   name: 'People In Space Right Now',
   actionGroups: [{ id: 'default', name: 'default' }],
+  minimumLicenseRequired: 'basic',
   defaultActionGroupId: 'default',
   async executor({ services, params }) {
     const { outerSpaceCapacity, craft: craftToTriggerBy, op } = params;

diff --git a/x-pack/plugins/alerts/README.md b/x-pack/plugins/alerts/README.md
@@ -171,6 +171,7 @@ server.newPlatform.setup.plugins.alerts.registerType({
 			{ name: 'cpuUsage', description: 'CPU usage' },
 		],
 	},
+	minimumLicenseRequired: 'basic',
 	async executor({
     alertId,
 		startedAt,
@@ -238,6 +239,7 @@ server.newPlatform.setup.plugins.alerts.registerType({
 		},
 	],
 	defaultActionGroupId: 'default',
+	minimumLicenseRequired: 'basic',
 	actionVariables: {
 		context: [
 			{ name: 'server', description: 'the server' },

diff --git a/x-pack/plugins/alerts/common/alert_type.ts b/x-pack/plugins/alerts/common/alert_type.ts
@@ -4,13 +4,16 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
+import { LicenseType } from '../../licensing/common/types';
+
 export interface AlertType {
   id: string;
   name: string;
   actionGroups: ActionGroup[];
   actionVariables: string[];
   defaultActionGroupId: ActionGroup['id'];
   producer: string;
+  minimumLicenseRequired: LicenseType;
 }
 
 export interface ActionGroup {

diff --git a/x-pack/plugins/alerts/public/alert_api.test.ts b/x-pack/plugins/alerts/public/alert_api.test.ts
@@ -22,6 +22,7 @@ describe('loadAlertTypes', () => {
         actionVariables: ['var1'],
         actionGroups: [{ id: 'default', name: 'Default' }],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         producer: 'alerts',
       },
     ];
@@ -45,6 +46,7 @@ describe('loadAlertType', () => {
       actionVariables: ['var1'],
       actionGroups: [{ id: 'default', name: 'Default' }],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       producer: 'alerts',
     };
     http.get.mockResolvedValueOnce([alertType]);
@@ -65,6 +67,7 @@ describe('loadAlertType', () => {
       actionVariables: [],
       actionGroups: [{ id: 'default', name: 'Default' }],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       producer: 'alerts',
     };
     http.get.mockResolvedValueOnce([alertType]);
@@ -80,6 +83,7 @@ describe('loadAlertType', () => {
         actionVariables: [],
         actionGroups: [{ id: 'default', name: 'Default' }],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         producer: 'alerts',
       },
     ]);

diff --git a/x-pack/plugins/alerts/public/alert_navigation_registry/alert_navigation_registry.test.ts b/x-pack/plugins/alerts/public/alert_navigation_registry/alert_navigation_registry.test.ts
@@ -17,6 +17,7 @@ const mockAlertType = (id: string): AlertType => ({
   actionVariables: [],
   defaultActionGroupId: 'default',
   producer: 'alerts',
+  minimumLicenseRequired: 'basic',
 });
 
 describe('AlertNavigationRegistry', () => {

diff --git a/x-pack/plugins/alerts/server/alert_type_registry.test.ts b/x-pack/plugins/alerts/server/alert_type_registry.test.ts
@@ -8,6 +8,7 @@ import { TaskRunnerFactory } from './task_runner';
 import { AlertTypeRegistry } from './alert_type_registry';
 import { AlertType } from './types';
 import { taskManagerMock } from '../../task_manager/server/mocks';
+import { LicenseType } from '../../licensing/server';
 
 const taskManager = taskManagerMock.createSetup();
 const alertTypeRegistryParams = {
@@ -35,6 +36,7 @@ describe('has()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -54,6 +56,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic' as LicenseType,
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -85,6 +88,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic' as LicenseType,
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -110,6 +114,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic' as LicenseType,
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -133,6 +138,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic' as LicenseType,
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -162,6 +168,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic' as LicenseType,
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -183,6 +190,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -197,6 +205,7 @@ describe('register()', () => {
           },
         ],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         executor: jest.fn(),
         producer: 'alerts',
       })
@@ -217,6 +226,7 @@ describe('get()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -274,6 +284,7 @@ describe('list()', () => {
         },
       ],
       defaultActionGroupId: 'testActionGroup',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -346,6 +357,7 @@ function alertTypeWithVariables(id: string, context: string, state: string): Ale
     name: `${id}-name`,
     actionGroups: [],
     defaultActionGroupId: id,
+    minimumLicenseRequired: 'basic' as LicenseType,
     async executor() {},
     producer: 'alerts',
   };

diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/aggregate.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/aggregate.test.ts
@@ -53,6 +53,7 @@ describe('aggregate()', () => {
       actionGroups: [],
       actionVariables: undefined,
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       id: 'myType',
       name: 'myType',
       producer: 'myApp',
@@ -102,6 +103,7 @@ describe('aggregate()', () => {
           name: 'Test',
           actionGroups: [{ id: 'default', name: 'Default' }],
           defaultActionGroupId: 'default',
+          minimumLicenseRequired: 'basic',
           producer: 'alerts',
           authorizedConsumers: {
             myApp: { read: true, all: true },

diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/create.test.ts
@@ -689,6 +689,7 @@ describe('create()', () => {
           threshold: schema.number({ min: 0, max: 1 }),
         }),
       },
+      minimumLicenseRequired: 'basic',
       async executor() {},
       producer: 'alerts',
     });

diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/find.test.ts
@@ -54,6 +54,7 @@ describe('find()', () => {
       actionGroups: [],
       actionVariables: undefined,
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       id: 'myType',
       name: 'myType',
       producer: 'myApp',
@@ -109,6 +110,7 @@ describe('find()', () => {
           name: 'Test',
           actionGroups: [{ id: 'default', name: 'Default' }],
           defaultActionGroupId: 'default',
+          minimumLicenseRequired: 'basic',
           producer: 'alerts',
           authorizedConsumers: {
             myApp: { read: true, all: true },

diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/lib.ts b/x-pack/plugins/alerts/server/alerts_client/tests/lib.ts
@@ -83,6 +83,7 @@ export function getBeforeSetup(
     name: 'Test',
     actionGroups: [{ id: 'default', name: 'Default' }],
     defaultActionGroupId: 'default',
+    minimumLicenseRequired: 'basic',
     async executor() {},
     producer: 'alerts',
   }));

diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/list_alert_types.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/list_alert_types.test.ts
@@ -50,6 +50,7 @@ describe('listAlertTypes', () => {
     actionGroups: [],
     actionVariables: undefined,
     defaultActionGroupId: 'default',
+    minimumLicenseRequired: 'basic',
     id: 'alertingAlertType',
     name: 'alertingAlertType',
     producer: 'alerts',
@@ -58,6 +59,7 @@ describe('listAlertTypes', () => {
     actionGroups: [],
     actionVariables: undefined,
     defaultActionGroupId: 'default',
+    minimumLicenseRequired: 'basic',
     id: 'myAppAlertType',
     name: 'myAppAlertType',
     producer: 'myApp',
@@ -96,6 +98,7 @@ describe('listAlertTypes', () => {
         actionGroups: [],
         actionVariables: undefined,
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         id: 'myType',
         name: 'myType',
         producer: 'myApp',
@@ -105,6 +108,7 @@ describe('listAlertTypes', () => {
         name: 'Test',
         actionGroups: [{ id: 'default', name: 'Default' }],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         producer: 'alerts',
       },
     ]);
@@ -119,6 +123,7 @@ describe('listAlertTypes', () => {
           name: 'Test',
           actionGroups: [{ id: 'default', name: 'Default' }],
           defaultActionGroupId: 'default',
+          minimumLicenseRequired: 'basic',
           producer: 'alerts',
           authorizedConsumers: {
             myApp: { read: true, all: true },

diff --git a/x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts b/x-pack/plugins/alerts/server/alerts_client/tests/update.test.ts
@@ -97,6 +97,7 @@ describe('update()', () => {
       name: 'Test',
       actionGroups: [{ id: 'default', name: 'Default' }],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       async executor() {},
       producer: 'alerts',
     });
@@ -676,6 +677,7 @@ describe('update()', () => {
       name: 'Test',
       actionGroups: [{ id: 'default', name: 'Default' }],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       validate: {
         params: schema.object({
           param1: schema.string(),
@@ -1021,6 +1023,7 @@ describe('update()', () => {
         name: 'Test',
         actionGroups: [{ id: 'default', name: 'Default' }],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         async executor() {},
         producer: 'alerts',
       });

diff --git a/x-pack/plugins/alerts/server/alerts_client_conflict_retries.test.ts b/x-pack/plugins/alerts/server/alerts_client_conflict_retries.test.ts
@@ -331,6 +331,7 @@ beforeEach(() => {
     name: 'Test',
     actionGroups: [{ id: 'default', name: 'Default' }],
     defaultActionGroupId: 'default',
+    minimumLicenseRequired: 'basic',
     async executor() {},
     producer: 'alerts',
   }));
@@ -340,6 +341,7 @@ beforeEach(() => {
     name: 'Test',
     actionGroups: [{ id: 'default', name: 'Default' }],
     defaultActionGroupId: 'default',
+    minimumLicenseRequired: 'basic',
     async executor() {},
     producer: 'alerts',
   });

diff --git a/x-pack/plugins/alerts/server/authorization/alerts_authorization.test.ts b/x-pack/plugins/alerts/server/authorization/alerts_authorization.test.ts
@@ -172,6 +172,7 @@ beforeEach(() => {
     name: 'My Alert Type',
     actionGroups: [{ id: 'default', name: 'Default' }],
     defaultActionGroupId: 'default',
+    minimumLicenseRequired: 'basic',
     async executor() {},
     producer: 'myApp',
   }));
@@ -534,6 +535,7 @@ describe('AlertsAuthorization', () => {
       actionGroups: [],
       actionVariables: undefined,
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       id: 'myOtherAppAlertType',
       name: 'myOtherAppAlertType',
       producer: 'alerts',
@@ -542,6 +544,7 @@ describe('AlertsAuthorization', () => {
       actionGroups: [],
       actionVariables: undefined,
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       id: 'myAppAlertType',
       name: 'myAppAlertType',
       producer: 'myApp',
@@ -550,6 +553,7 @@ describe('AlertsAuthorization', () => {
       actionGroups: [],
       actionVariables: undefined,
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       id: 'mySecondAppAlertType',
       name: 'mySecondAppAlertType',
       producer: 'myApp',
@@ -824,6 +828,7 @@ describe('AlertsAuthorization', () => {
       actionGroups: [],
       actionVariables: undefined,
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       id: 'myOtherAppAlertType',
       name: 'myOtherAppAlertType',
       producer: 'myOtherApp',
@@ -832,6 +837,7 @@ describe('AlertsAuthorization', () => {
       actionGroups: [],
       actionVariables: undefined,
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       id: 'myAppAlertType',
       name: 'myAppAlertType',
       producer: 'myApp',