[Security Solution] Adds tests for coverage overview page

.buildkite/ftr_configs.yml

@@ -460,10 +460,7 @@ enabled:
   - x-pack/test/security_solution_api_integration/test_suites/detections_response/default_license/rule_creation/configs/ess.config.ts
   - x-pack/test/security_solution_api_integration/test_suites/detections_response/default_license/actions/configs/serverless.config.ts
   - x-pack/test/security_solution_api_integration/test_suites/detections_response/default_license/actions/configs/ess.config.ts
+  - x-pack/test/security_solution_api_integration/test_suites/detections_response/basic_license/rule_management/configs/serverless.config.ts
+  - x-pack/test/security_solution_api_integration/test_suites/detections_response/basic_license/rule_management/configs/ess.config.ts
   - x-pack/test/security_solution_api_integration/test_suites/detections_response/default_license/alerts/configs/serverless.config.ts
   - x-pack/test/security_solution_api_integration/test_suites/detections_response/default_license/alerts/configs/ess.config.ts
-
-
-
-
-

x-pack/plugins/security_solution/docs/testing/test_plans/detection_response/rule_management/coverage_overview_dashboard.md

@@ -24,9 +24,9 @@ Status: `in progress`. The current test plan matches `Milestone 1 - MVP` of the
 
 - **Rule Source**: The filter type defining rule type, current options are `prebuilt`(from elastic prebuilt rules package) and `custom`(created by user)
 
--**Initial filter state**: The filters present on initial page load. Rule activity will be set to `enabled`, rule source will be set to `prebuilt` and `custom` simultaneously.
+- **Initial filter state**: The filters present on initial page load. Rule activity will be set to `enabled`, rule source will be set to `prebuilt` and `custom` simultaneously.
 
--**Dashboard containing the rule data**: The normal render of the coverage overview dashboard. Any returned rule data mapped correctly to the tile layout of all the MITRE data in a colored grid
+- **Dashboard containing the rule data**: The normal render of the coverage overview dashboard. Any returned rule data mapped correctly to the tile layout of all the MITRE data in a colored grid
 
 ### Assumptions
 

x-pack/plugins/security_solution/public/detection_engine/rule_management/api/hooks/use_fetch_coverage_overview_query.ts

@@ -8,12 +8,14 @@
 import type { UseQueryOptions } from '@tanstack/react-query';
 import { useQuery, useQueryClient } from '@tanstack/react-query';
 import { useCallback } from 'react';
+import * as i18n from '../../../rule_management_ui/pages/coverage_overview/translations';
 import type { CoverageOverviewFilter } from '../../../../../common/api/detection_engine';
 import { RULE_MANAGEMENT_COVERAGE_OVERVIEW_URL } from '../../../../../common/api/detection_engine';
 import { fetchCoverageOverview } from '../api';
 import { buildCoverageOverviewDashboardModel } from '../../logic/coverage_overview/build_coverage_overview_dashboard_model';
 import type { CoverageOverviewDashboard } from '../../model/coverage_overview/dashboard';
 import { DEFAULT_QUERY_OPTIONS } from './constants';
+import { useAppToasts } from '../../../../common/hooks/use_app_toasts';
 
 const COVERAGE_OVERVIEW_QUERY_KEY = ['POST', RULE_MANAGEMENT_COVERAGE_OVERVIEW_URL];
 
@@ -29,6 +31,8 @@ export const useFetchCoverageOverviewQuery = (
   filter: CoverageOverviewFilter = {},
   options?: UseQueryOptions<CoverageOverviewDashboard>
 ) => {
+  const { addError } = useAppToasts();
+
   return useQuery<CoverageOverviewDashboard>(
     [...COVERAGE_OVERVIEW_QUERY_KEY, filter],
     async ({ signal }) => {
@@ -39,6 +43,11 @@ export const useFetchCoverageOverviewQuery = (
     {
       ...DEFAULT_QUERY_OPTIONS,
       ...options,
+      onError: (error) => {
+        addError(error, {
+          title: i18n.COVERAGE_OVERVIEW_FETCH_ERROR_TITLE,
+        });
+      },
     }
   );
 };

x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/pages/coverage_overview/rule_source_filter.tsx

@@ -87,7 +87,7 @@ const RuleSourceFilterComponent = ({
       `}
     >
       <EuiPopover
-        id="ruleActivityFilterPopover"
+        id="ruleSourceFilterPopover"
         button={button}
         isOpen={isPopoverOpen}
         closePopover={closePopover}

x-pack/plugins/security_solution/public/detection_engine/rule_management_ui/pages/coverage_overview/translations.ts

@@ -177,3 +177,10 @@ export const CoverageOverviewDashboardInformation = i18n.translate(
       "Your current coverage of MITRE ATT&CK\u00AE tactics and techniques, based on installed rules. Click a cell to view and enable a technique's rules. Rules must be mapped to the MITRE ATT&CK\u00AE framework to be displayed.",
   }
 );
+
+export const COVERAGE_OVERVIEW_FETCH_ERROR_TITLE = i18n.translate(
+  'xpack.securitySolution.coverageOverviewDashboard.fetchErrorTitle',
+  {
+    defaultMessage: 'Failed to fetch coverage overview data',
+  }
+);

x-pack/test/detection_engine_api_integration/basic/tests/coverage_overview.ts

@@ -19,6 +19,7 @@ import {
   deleteAllRules,
   getSimpleRule,
   installPrebuiltRulesAndTimelines,
+  installPrebuiltRules,
 } from '../../utils';
 import { createNonSecurityRule } from '../../utils/create_non_security_rule';
 
@@ -471,6 +472,119 @@ export default ({ getService }: FtrProviderContext): void => {
             },
           });
         });
+
+        it('returns response filtered by prebuilt rules', async () => {
+          await createPrebuiltRuleAssetSavedObjects(es, [
+            createRuleAssetSavedObject({
+              rule_id: 'prebuilt-rule-1',
+              threat: generateThreatArray(1),
+            }),
+          ]);
+          const {
+            results: { created },
+          } = await installPrebuiltRules(es, supertest);
+          const expectedRule = created[0];
+
+          await createRule(supertest, log, {
+            ...getSimpleRule('rule-1'),
+            threat: generateThreatArray(2),
+          });
+
+          const { body } = await supertest
+            .post(RULE_MANAGEMENT_COVERAGE_OVERVIEW_URL)
+            .set('kbn-xsrf', 'true')
+            .set('elastic-api-version', '1')
+            .send({
+              filter: {
+                source: ['prebuilt'],
+              },
+            })
+            .expect(200);
+
+          expect(body).to.eql({
+            coverage: {
+              T001: [expectedRule.id],
+              TA001: [expectedRule.id],
+              'T001.001': [expectedRule.id],
+            },
+            unmapped_rule_ids: [],
+            rules_data: {
+              [expectedRule.id]: {
+                activity: 'disabled',
+                name: 'Query with a rule id',
+              },
+            },
+          });
+        });
+
+        it('returns all rules if both custom and prebuilt filters are specified in the request', async () => {
+          await createPrebuiltRuleAssetSavedObjects(es, [
+            createRuleAssetSavedObject({
+              rule_id: 'prebuilt-rule-1',
+              threat: generateThreatArray(1),
+            }),
+          ]);
+          const {
+            results: { created },
+          } = await installPrebuiltRules(es, supertest);
+          const expectedPrebuiltRule = created[0];
+
+          const expectedCustomRule = await createRule(supertest, log, {
+            ...getSimpleRule('rule-1'),
+            threat: generateThreatArray(2),
+          });
+
+          const { body } = await supertest
+            .post(RULE_MANAGEMENT_COVERAGE_OVERVIEW_URL)
+            .set('kbn-xsrf', 'true')
+            .set('elastic-api-version', '1')
+            .send({
+              filter: {
+                source: ['prebuilt', 'custom'],
+              },
+            })
+            .expect(200);
+
+          expect(body).to.eql({
+            coverage: {
+              T001: [expectedPrebuiltRule.id],
+              TA001: [expectedPrebuiltRule.id],
+              'T001.001': [expectedPrebuiltRule.id],
+              T002: [expectedCustomRule.id],
+              TA002: [expectedCustomRule.id],
+              'T002.002': [expectedCustomRule.id],
+            },
+            unmapped_rule_ids: [],
+            rules_data: {
+              [expectedPrebuiltRule.id]: {
+                activity: 'disabled',
+                name: 'Query with a rule id',
+              },
+              [expectedCustomRule.id]: {
+                activity: 'disabled',
+                name: 'Simple Rule Query',
+              },
+            },
+          });
+        });
+      });
+    });
+
+    describe('error cases', async () => {
+      it('throws error when request body is not valid', async () => {
+        const { body } = await supertest
+          .post(RULE_MANAGEMENT_COVERAGE_OVERVIEW_URL)
+          .set('kbn-xsrf', 'true')
+          .set('elastic-api-version', '1')
+          .send({ filter: { source: ['give me all the rules'] } })
+          .expect(400);
+
+        expect(body).to.eql({
+          statusCode: 400,
+          error: 'Bad Request',
+          message:
+            '[request body]: Invalid value "give me all the rules" supplied to "filter,source"',
+        });
       });
     });
   });

x-pack/test/security_solution_api_integration/config/ess/config.base.basic.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { createTestConfig } from './config.base';
+
+export default createTestConfig({
+  license: 'basic',
+  ssl: true,
+});

x-pack/test/security_solution_api_integration/package.json

@@ -6,7 +6,9 @@
   "license": "Elastic License 2.0",
   "scripts": {
     "initialize-server:dr:default": "node ./scripts/index.js server detections_response default_license",
+    "initialize-server:dr:basic": "node ./scripts/index.js server detections_response basic_license",
     "run-tests:dr:default": "node ./scripts/index.js runner detections_response default_license",
+    "run-tests:dr:basic": "node ./scripts/index.js runner detections_response basic_license",
     "exception_workflows:server:serverless": "npm run initialize-server:dr:default exceptions/workflows serverless",
     "exception_workflows:runner:serverless": "npm run run-tests:dr:default exceptions/workflows serverless serverlessEnv",
     "exception_workflows:qa:serverless": "npm run run-tests:dr:default exceptions/workflows serverless qaEnv",
@@ -41,6 +43,11 @@
     "alerts:runner:serverless": "npm run run-tests:dr:default alerts serverless serverlessEnv",
     "alerts:qa:serverless": "npm run run-tests:dr:default alerts serverless qaEnv",
     "alerts:server:ess": "npm run initialize-server:dr:default alerts ess",
-    "alerts:runner:ess": "npm run run-tests:dr:default alerts ess essEnv"
+    "alerts:runner:ess": "npm run run-tests:dr:default alerts ess essEnv",
+    "rule_management:server:serverless": "npm run initialize-server:dr:basic rule_management serverless",
+    "rule_management:runner:serverless": "npm run run-tests:dr:basic rule_management serverless serverlessEnv",
+    "rule_management:qa:serverless": "npm run run-tests:dr:basic rule_management serverless qaEnv",
+    "rule_management:server:ess": "npm run initialize-server:dr:basic rule_management ess",
+    "rule_management:runner:ess": "npm run run-tests:dr:basic rule_management ess essEnv"
   }
 }

x-pack/test/security_solution_api_integration/test_suites/detections_response/basic_license/rule_management/configs/ess.config.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { FtrConfigProviderContext } from '@kbn/test';
+
+export default async function ({ readConfigFile }: FtrConfigProviderContext) {
+  const functionalConfig = await readConfigFile(
+    require.resolve('../../../../../config/ess/config.base.basic')
+  );
+
+  return {
+    ...functionalConfig.getAll(),
+    testFiles: [require.resolve('..')],
+    junit: {
+      reportName: 'Detection Engine ESS/ Rule management API Integration Tests',
+    },
+  };
+}

x-pack/test/security_solution_api_integration/test_suites/detections_response/basic_license/rule_management/configs/serverless.config.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { createTestConfig } from '../../../../../config/serverless/config.base';
+
+export default createTestConfig({
+  testFiles: [require.resolve('..')],
+  junit: {
+    reportName: 'Detection Engine Serverless/ Rule management API Integration Tests',
+  },
+});