License checks for alerts plugin (#85649)

* [Alerts][License] Define minimum license required for each alert type (#84997) * Define minimum license required for each alert type * fixed typechecks * fixed tests * fixed tests * fixed due to comments * fixed due to comments * removed file * removed casting to LicenseType * [Alerts][License] Add license checks to alerts HTTP APIs and execution (#85223) * [Alerts][License] Add license checks to alerts HTTP APIs and execution * fixed typechecks * resolved conflicts * resolved conflicts * added router tests * fixed typechecks * added license check support for alert task running * fixed typechecks * added integration tests * fixed due to comments * fixed due to comments * fixed tests * fixed typechecks * [Alerting UI][License] Disable alert types in UI when the license doesn't support it. (#85496) * [Alerting UI][License] Disable alert types in UI when the license doesn't support it. * fixed typechecks * added licensing for alert list and details page * fixed multy select menu * fixed due to comments * fixed due to comments * fixed due to comments * fixed typechecks * fixed license error message * fixed license error message * fixed typechecks * fixed license error message Co-authored-by: Kibana Machine <[email protected]>
elastic · Dec 15, 2020 · 37525f8 · 37525f8
1 parent 8539c67
commit 37525f8
Show file tree

Hide file tree

Showing 118 changed files with 2,117 additions and 446 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
@@ -49,6 +49,7 @@ export const alertType: AlertType<
     { id: 'large', name: 'Large t-shirt' },
   ],
   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',
   recoveryActionGroup: {
     id: 'hasLandedBackOnEarth',

diff --git a/x-pack/plugins/actions/server/action_type_registry.ts b/x-pack/plugins/actions/server/action_type_registry.ts
@@ -177,7 +177,7 @@ export class ActionTypeRegistry {
       minimumLicenseRequired: actionType.minimumLicenseRequired,
       enabled: this.isActionTypeEnabled(actionTypeId),
       enabledInConfig: this.actionsConfigUtils.isActionTypeEnabled(actionTypeId),
-      enabledInLicense: this.licenseState.isLicenseValidForActionType(actionType).isValid === true,
+      enabledInLicense: !!this.licenseState.isLicenseValidForActionType(actionType).isValid,
     }));
   }
 }
diff --git a/x-pack/plugins/alerts/README.md b/x-pack/plugins/alerts/README.md
@@ -172,6 +172,7 @@ server.newPlatform.setup.plugins.alerts.registerType({
 			{ name: 'cpuUsage', description: 'CPU usage' },
 		],
 	},
+	minimumLicenseRequired: 'basic',
 	async executor({
     alertId,
 		startedAt,
@@ -239,6 +240,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.ts b/x-pack/plugins/alerts/common/alert.ts
@@ -26,6 +26,7 @@ export enum AlertExecutionStatusErrorReasons {
   Decrypt = 'decrypt',
   Execute = 'execute',
   Unknown = 'unknown',
+  License = 'license',
 }
 
 export interface AlertExecutionStatus {

diff --git a/x-pack/plugins/alerts/common/alert_type.ts b/x-pack/plugins/alerts/common/alert_type.ts
@@ -4,6 +4,8 @@
  * 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;
@@ -12,6 +14,7 @@ export interface AlertType {
   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',
         recoveryActionGroup: RecoveredActionGroup,
         producer: 'alerts',
       },
@@ -46,6 +47,7 @@ describe('loadAlertType', () => {
       actionVariables: ['var1'],
       actionGroups: [{ id: 'default', name: 'Default' }],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       recoveryActionGroup: RecoveredActionGroup,
       producer: 'alerts',
     };
@@ -67,6 +69,7 @@ describe('loadAlertType', () => {
       actionVariables: [],
       actionGroups: [{ id: 'default', name: 'Default' }],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       recoveryActionGroup: RecoveredActionGroup,
       producer: 'alerts',
     };
@@ -83,6 +86,7 @@ describe('loadAlertType', () => {
         actionVariables: [],
         actionGroups: [{ id: 'default', name: 'Default' }],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         recoveryActionGroup: RecoveredActionGroup,
         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
@@ -18,6 +18,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.mock.ts b/x-pack/plugins/alerts/server/alert_type_registry.mock.ts
@@ -14,6 +14,7 @@ const createAlertTypeRegistryMock = () => {
     register: jest.fn(),
     get: jest.fn(),
     list: jest.fn(),
+    ensureAlertTypeEnabled: jest.fn(),
   };
   return mocked;
 };

diff --git a/x-pack/plugins/alerts/server/alert_type_registry.test.ts b/x-pack/plugins/alerts/server/alert_type_registry.test.ts
@@ -5,17 +5,27 @@
  */
 
 import { TaskRunnerFactory } from './task_runner';
-import { AlertTypeRegistry } from './alert_type_registry';
+import { AlertTypeRegistry, ConstructorOptions } from './alert_type_registry';
 import { AlertType } from './types';
 import { taskManagerMock } from '../../task_manager/server/mocks';
+import { ILicenseState } from './lib/license_state';
+import { licenseStateMock } from './lib/license_state.mock';
+import { licensingMock } from '../../licensing/server/mocks';
+let mockedLicenseState: jest.Mocked<ILicenseState>;
+let alertTypeRegistryParams: ConstructorOptions;
 
 const taskManager = taskManagerMock.createSetup();
-const alertTypeRegistryParams = {
-  taskManager,
-  taskRunnerFactory: new TaskRunnerFactory(),
-};
 
-beforeEach(() => jest.resetAllMocks());
+beforeEach(() => {
+  jest.resetAllMocks();
+  mockedLicenseState = licenseStateMock.create();
+  alertTypeRegistryParams = {
+    taskManager,
+    taskRunnerFactory: new TaskRunnerFactory(),
+    licenseState: mockedLicenseState,
+    licensing: licensingMock.createSetup(),
+  };
+});
 
 describe('has()', () => {
   test('returns false for unregistered alert types', () => {
@@ -35,6 +45,7 @@ describe('has()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -44,7 +55,7 @@ describe('has()', () => {
 
 describe('register()', () => {
   test('throws if AlertType Id contains invalid characters', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: 'test',
       name: 'Test',
       actionGroups: [
@@ -54,6 +65,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -75,7 +87,7 @@ describe('register()', () => {
   });
 
   test('throws if AlertType Id isnt a string', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: (123 as unknown) as string,
       name: 'Test',
       actionGroups: [
@@ -85,6 +97,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -96,7 +109,7 @@ describe('register()', () => {
   });
 
   test('throws if AlertType action groups contains reserved group id', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: 'test',
       name: 'Test',
       actionGroups: [
@@ -110,6 +123,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -123,7 +137,7 @@ describe('register()', () => {
   });
 
   test('allows an AlertType to specify a custom recovery group', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: 'test',
       name: 'Test',
       actionGroups: [
@@ -139,6 +153,7 @@ describe('register()', () => {
       },
       executor: jest.fn(),
       producer: 'alerts',
+      minimumLicenseRequired: 'basic',
     };
     const registry = new AlertTypeRegistry(alertTypeRegistryParams);
     registry.register(alertType);
@@ -157,7 +172,7 @@ describe('register()', () => {
   });
 
   test('throws if the custom recovery group is contained in the AlertType action groups', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: 'test',
       name: 'Test',
       actionGroups: [
@@ -175,6 +190,7 @@ describe('register()', () => {
         name: 'Back To Awesome',
       },
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -188,7 +204,7 @@ describe('register()', () => {
   });
 
   test('registers the executor with the task manager', () => {
-    const alertType = {
+    const alertType: AlertType = {
       id: 'test',
       name: 'Test',
       actionGroups: [
@@ -198,6 +214,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -227,6 +244,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     };
@@ -248,6 +266,7 @@ describe('register()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -262,6 +281,7 @@ describe('register()', () => {
           },
         ],
         defaultActionGroupId: 'default',
+        minimumLicenseRequired: 'basic',
         executor: jest.fn(),
         producer: 'alerts',
       })
@@ -282,6 +302,7 @@ describe('get()', () => {
         },
       ],
       defaultActionGroupId: 'default',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -306,6 +327,7 @@ describe('get()', () => {
         "defaultActionGroupId": "default",
         "executor": [MockFunction],
         "id": "test",
+        "minimumLicenseRequired": "basic",
         "name": "Test",
         "producer": "alerts",
         "recoveryActionGroup": Object {
@@ -343,6 +365,7 @@ describe('list()', () => {
         },
       ],
       defaultActionGroupId: 'testActionGroup',
+      minimumLicenseRequired: 'basic',
       executor: jest.fn(),
       producer: 'alerts',
     });
@@ -366,7 +389,9 @@ describe('list()', () => {
             "state": Array [],
           },
           "defaultActionGroupId": "testActionGroup",
+          "enabledInLicense": false,
           "id": "test",
+          "minimumLicenseRequired": "basic",
           "name": "Test",
           "producer": "alerts",
           "recoveryActionGroup": Object {
@@ -413,12 +438,50 @@ describe('list()', () => {
   });
 });
 
+describe('ensureAlertTypeEnabled', () => {
+  let alertTypeRegistry: AlertTypeRegistry;
+
+  beforeEach(() => {
+    alertTypeRegistry = new AlertTypeRegistry(alertTypeRegistryParams);
+    alertTypeRegistry.register({
+      id: 'test',
+      name: 'Test',
+      actionGroups: [
+        {
+          id: 'default',
+          name: 'Default',
+        },
+      ],
+      defaultActionGroupId: 'default',
+      executor: jest.fn(),
+      producer: 'alerts',
+      minimumLicenseRequired: 'basic',
+      recoveryActionGroup: { id: 'recovered', name: 'Recovered' },
+    });
+  });
+
+  test('should call ensureLicenseForAlertType on the license state', async () => {
+    alertTypeRegistry.ensureAlertTypeEnabled('test');
+    expect(mockedLicenseState.ensureLicenseForAlertType).toHaveBeenCalled();
+  });
+
+  test('should throw when ensureLicenseForAlertType throws', async () => {
+    mockedLicenseState.ensureLicenseForAlertType.mockImplementation(() => {
+      throw new Error('Fail');
+    });
+    expect(() =>
+      alertTypeRegistry.ensureAlertTypeEnabled('test')
+    ).toThrowErrorMatchingInlineSnapshot(`"Fail"`);
+  });
+});
+
 function alertTypeWithVariables(id: string, context: string, state: string): AlertType {
-  const baseAlert = {
+  const baseAlert: AlertType = {
     id,
     name: `${id}-name`,
     actionGroups: [],
     defaultActionGroupId: id,
+    minimumLicenseRequired: 'basic',
     async executor() {},
     producer: 'alerts',
   };