|
| 1 | +/* |
| 2 | + * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one |
| 3 | + * or more contributor license agreements. Licensed under the Elastic License |
| 4 | + * 2.0; you may not use this file except in compliance with the Elastic License |
| 5 | + * 2.0. |
| 6 | + */ |
| 7 | + |
| 8 | +import { rulesClientMock } from '@kbn/alerting-plugin/server/mocks'; |
| 9 | +import type { ActionsClient } from '@kbn/actions-plugin/server'; |
| 10 | +import { savedObjectsClientMock } from '@kbn/core/server/mocks'; |
| 11 | +import { licenseMock } from '@kbn/licensing-plugin/common/licensing.mock'; |
| 12 | + |
| 13 | +import { SecurityRuleChangeTrackingAction } from '../../../../../../common/detection_engine/rule_management/rule_change_tracking'; |
| 14 | +import { getCreateRulesSchemaMock } from '../../../../../../common/api/detection_engine/model/rule_schema/mocks'; |
| 15 | +import { buildMlAuthz } from '../../../../machine_learning/authz'; |
| 16 | +import { throwAuthzError } from '../../../../machine_learning/validation'; |
| 17 | +import { createDetectionRulesClient } from './detection_rules_client'; |
| 18 | +import type { IDetectionRulesClient } from './detection_rules_client_interface'; |
| 19 | +import { createProductFeaturesServiceMock } from '../../../../product_features_service/mocks'; |
| 20 | +import { getMockRulesAuthz } from '../../__mocks__/authz'; |
| 21 | + |
| 22 | +jest.mock('../../../../machine_learning/authz'); |
| 23 | +jest.mock('../../../../machine_learning/validation'); |
| 24 | + |
| 25 | +describe('DetectionRulesClient.bulkCreatePrebuiltRules', () => { |
| 26 | + let rulesClient: ReturnType<typeof rulesClientMock.create>; |
| 27 | + let detectionRulesClient: IDetectionRulesClient; |
| 28 | + |
| 29 | + const mlAuthz = (buildMlAuthz as jest.Mock)(); |
| 30 | + const rulesAuthz = getMockRulesAuthz(); |
| 31 | + const actionsClient: jest.Mocked<ActionsClient> = { |
| 32 | + isSystemAction: jest.fn(), |
| 33 | + } as unknown as jest.Mocked<ActionsClient>; |
| 34 | + |
| 35 | + beforeEach(() => { |
| 36 | + rulesClient = rulesClientMock.create(); |
| 37 | + (throwAuthzError as jest.Mock).mockReset(); |
| 38 | + detectionRulesClient = createDetectionRulesClient({ |
| 39 | + actionsClient, |
| 40 | + rulesClient, |
| 41 | + mlAuthz, |
| 42 | + rulesAuthz, |
| 43 | + savedObjectsClient: savedObjectsClientMock.create(), |
| 44 | + license: licenseMock.createLicenseMock(), |
| 45 | + productFeaturesService: createProductFeaturesServiceMock(), |
| 46 | + }); |
| 47 | + }); |
| 48 | + |
| 49 | + it('issues a single bulkCreateRules call with disabled, immutable rules and emits { id, rule_id, version } pairs', async () => { |
| 50 | + const asset1 = { ...getCreateRulesSchemaMock(), version: 1, rule_id: 'rule-1' }; |
| 51 | + const asset2 = { ...getCreateRulesSchemaMock(), version: 2, rule_id: 'rule-2' }; |
| 52 | + |
| 53 | + rulesClient.bulkCreateRules.mockImplementationOnce(async (args) => { |
| 54 | + const ids = args.rules.map((r) => (r.options as { id: string }).id); |
| 55 | + return { successfulIds: ids, errors: [], total: ids.length }; |
| 56 | + }); |
| 57 | + |
| 58 | + const { results, errors } = await detectionRulesClient.bulkCreatePrebuiltRules({ |
| 59 | + rules: [asset1, asset2], |
| 60 | + }); |
| 61 | + |
| 62 | + expect(rulesClient.bulkCreateRules).toHaveBeenCalledTimes(1); |
| 63 | + const callArgs = rulesClient.bulkCreateRules.mock.calls[0][0]; |
| 64 | + expect(callArgs.rules).toHaveLength(2); |
| 65 | + expect(callArgs.rules.every((r) => r.data.enabled === false)).toBe(true); |
| 66 | + expect(callArgs.rules.every((r) => r.data.params.immutable === true)).toBe(true); |
| 67 | + expect(errors).toEqual([]); |
| 68 | + expect(results).toHaveLength(2); |
| 69 | + const callIds = callArgs.rules.map((r) => (r.options as { id: string }).id); |
| 70 | + expect(results[0].result).toEqual({ id: callIds[0], rule_id: 'rule-1', version: 1 }); |
| 71 | + expect(results[1].result).toEqual({ id: callIds[1], rule_id: 'rule-2', version: 2 }); |
| 72 | + }); |
| 73 | + |
| 74 | + it('issues a single bulkCreateRules call regardless of input size (alerting batches internally)', async () => { |
| 75 | + const assets = Array.from({ length: 250 }, (_, i) => ({ |
| 76 | + ...getCreateRulesSchemaMock(), |
| 77 | + version: 1, |
| 78 | + rule_id: `rule-${i}`, |
| 79 | + })); |
| 80 | + |
| 81 | + rulesClient.bulkCreateRules.mockImplementationOnce(async (args) => ({ |
| 82 | + successfulIds: args.rules.map((r) => (r.options as { id: string }).id), |
| 83 | + errors: [], |
| 84 | + total: args.rules.length, |
| 85 | + })); |
| 86 | + |
| 87 | + const { results, errors } = await detectionRulesClient.bulkCreatePrebuiltRules({ |
| 88 | + rules: assets, |
| 89 | + }); |
| 90 | + |
| 91 | + expect(rulesClient.bulkCreateRules).toHaveBeenCalledTimes(1); |
| 92 | + expect(results).toHaveLength(250); |
| 93 | + expect(errors).toEqual([]); |
| 94 | + }); |
| 95 | + |
| 96 | + it('reports per-rule errors from the alerting layer', async () => { |
| 97 | + const asset = { ...getCreateRulesSchemaMock(), version: 1, rule_id: 'rule-1' }; |
| 98 | + |
| 99 | + rulesClient.bulkCreateRules.mockImplementationOnce(async (args) => { |
| 100 | + const id = (args.rules[0].options as { id: string }).id; |
| 101 | + return { |
| 102 | + successfulIds: [], |
| 103 | + errors: [{ message: 'boom', status: 500, rule: { id, name: asset.name } }], |
| 104 | + total: 1, |
| 105 | + }; |
| 106 | + }); |
| 107 | + |
| 108 | + const { results, errors } = await detectionRulesClient.bulkCreatePrebuiltRules({ |
| 109 | + rules: [asset], |
| 110 | + }); |
| 111 | + |
| 112 | + expect(results).toEqual([]); |
| 113 | + expect(errors).toHaveLength(1); |
| 114 | + expect(errors[0].item).toBe(asset); |
| 115 | + expect(errors[0].error.message).toBe('boom'); |
| 116 | + }); |
| 117 | + |
| 118 | + it('returns ML-auth failures as per-rule errors without calling bulkCreateRules', async () => { |
| 119 | + const asset = { ...getCreateRulesSchemaMock(), version: 1, rule_id: 'rule-1' }; |
| 120 | + (throwAuthzError as jest.Mock).mockImplementation(() => { |
| 121 | + throw new Error('ML auth denied'); |
| 122 | + }); |
| 123 | + |
| 124 | + const { results, errors } = await detectionRulesClient.bulkCreatePrebuiltRules({ |
| 125 | + rules: [asset], |
| 126 | + }); |
| 127 | + |
| 128 | + expect(rulesClient.bulkCreateRules).not.toHaveBeenCalled(); |
| 129 | + expect(results).toEqual([]); |
| 130 | + expect(errors[0].error.message).toBe('ML auth denied'); |
| 131 | + }); |
| 132 | + |
| 133 | + it('returns empty result for empty input', async () => { |
| 134 | + const result = await detectionRulesClient.bulkCreatePrebuiltRules({ rules: [] }); |
| 135 | + expect(result).toEqual({ results: [], errors: [] }); |
| 136 | + expect(rulesClient.bulkCreateRules).not.toHaveBeenCalled(); |
| 137 | + }); |
| 138 | + |
| 139 | + it('forwards ruleInstall action and rules.length as bulkCount to rulesClient.bulkCreateRules', async () => { |
| 140 | + const assets = Array.from({ length: 3 }, (_, i) => ({ |
| 141 | + ...getCreateRulesSchemaMock(), |
| 142 | + version: 1, |
| 143 | + rule_id: `rule-${i}`, |
| 144 | + })); |
| 145 | + |
| 146 | + rulesClient.bulkCreateRules.mockResolvedValueOnce({ |
| 147 | + successfulIds: [], |
| 148 | + errors: [], |
| 149 | + total: 0, |
| 150 | + }); |
| 151 | + |
| 152 | + await detectionRulesClient.bulkCreatePrebuiltRules({ rules: assets }); |
| 153 | + |
| 154 | + expect(rulesClient.bulkCreateRules).toHaveBeenCalledWith( |
| 155 | + expect.objectContaining({ |
| 156 | + changeTracking: { |
| 157 | + action: SecurityRuleChangeTrackingAction.ruleInstall, |
| 158 | + metadata: { bulkCount: assets.length }, |
| 159 | + }, |
| 160 | + }) |
| 161 | + ); |
| 162 | + }); |
| 163 | +}); |
0 commit comments