[Security Solution] Add snooze rule tests (#158195)

**Addresses:** #158196

## Summary

This PR mostly implements a test plan to cover rule snoozing functionality by automation tests.

x-pack/plugins/alerting/common/index.ts

@@ -61,8 +61,11 @@ export interface AlertingFrameworkHealth {
 
 export const LEGACY_BASE_ALERT_API_PATH = '/api/alerts';
 export const BASE_ALERTING_API_PATH = '/api/alerting';
-export const INTERNAL_BASE_ALERTING_API_PATH = '/internal/alerting';
-export const INTERNAL_ALERTING_API_FIND_RULES_PATH = `${INTERNAL_BASE_ALERTING_API_PATH}/rules/_find`;
+export const INTERNAL_BASE_ALERTING_API_PATH = '/internal/alerting' as const;
+export const INTERNAL_ALERTING_SNOOZE_RULE =
+  `${INTERNAL_BASE_ALERTING_API_PATH}/rule/{id}/_snooze` as const;
+export const INTERNAL_ALERTING_API_FIND_RULES_PATH =
+  `${INTERNAL_BASE_ALERTING_API_PATH}/rules/_find` as const;
 
 export const INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH =
   `${INTERNAL_BASE_ALERTING_API_PATH}/rules/maintenance_window` as const;

x-pack/plugins/alerting/server/routes/snooze_rule.ts

@@ -10,7 +10,7 @@ import { schema } from '@kbn/config-schema';
 import { ILicenseState, RuleMutedError } from '../lib';
 import { verifyAccessAndContext, rRuleSchema } from './lib';
 import { SnoozeOptions } from '../rules_client';
-import { AlertingRequestHandlerContext, INTERNAL_BASE_ALERTING_API_PATH } from '../types';
+import { AlertingRequestHandlerContext, INTERNAL_ALERTING_SNOOZE_RULE } from '../types';
 import { validateSnoozeSchedule } from '../lib/validate_snooze_schedule';
 
 const paramSchema = schema.object({
@@ -42,7 +42,7 @@ export const snoozeRuleRoute = (
 ) => {
   router.post(
     {
-      path: `${INTERNAL_BASE_ALERTING_API_PATH}/rule/{id}/_snooze`,
+      path: INTERNAL_ALERTING_SNOOZE_RULE,
       validate: {
         params: paramSchema,
         body: bodySchema,

x-pack/plugins/security_solution/cypress/e2e/detection_rules/bulk_duplicate_rules.cy.ts

@@ -61,40 +61,40 @@ describe('Detection rules, bulk duplicate', () => {
     resetRulesTableState();
     deleteAlertsAndRules();
     esArchiverResetKibana();
-    createRule<{ id: string }>(
-      getNewRule({ name: RULE_NAME, ...defaultRuleData, rule_id: '1' })
-    ).then((response) => {
-      createRuleExceptionItem(response.body.id, [
-        {
-          description: 'Exception item for rule default exception list',
-          entries: [
-            {
-              field: 'user.name',
-              operator: 'included',
-              type: 'match',
-              value: 'some value',
-            },
-          ],
-          name: EXPIRED_EXCEPTION_ITEM_NAME,
-          type: 'simple',
-          expire_time: expiredDate,
-        },
-        {
-          description: 'Exception item for rule default exception list',
-          entries: [
-            {
-              field: 'user.name',
-              operator: 'included',
-              type: 'match',
-              value: 'some value',
-            },
-          ],
-          name: NON_EXPIRED_EXCEPTION_ITEM_NAME,
-          type: 'simple',
-          expire_time: futureDate,
-        },
-      ]);
-    });
+    createRule(getNewRule({ name: RULE_NAME, ...defaultRuleData, rule_id: '1' })).then(
+      (response) => {
+        createRuleExceptionItem(response.body.id, [
+          {
+            description: 'Exception item for rule default exception list',
+            entries: [
+              {
+                field: 'user.name',
+                operator: 'included',
+                type: 'match',
+                value: 'some value',
+              },
+            ],
+            name: EXPIRED_EXCEPTION_ITEM_NAME,
+            type: 'simple',
+            expire_time: expiredDate,
+          },
+          {
+            description: 'Exception item for rule default exception list',
+            entries: [
+              {
+                field: 'user.name',
+                operator: 'included',
+                type: 'match',
+                value: 'some value',
+              },
+            ],
+            name: NON_EXPIRED_EXCEPTION_ITEM_NAME,
+            type: 'simple',
+            expire_time: futureDate,
+          },
+        ]);
+      }
+    );
 
     visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL);
 

x-pack/plugins/security_solution/cypress/e2e/detection_rules/rule_snoozing.cy.ts

@@ -0,0 +1,278 @@
+/*
+ * 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 { INTERNAL_ALERTING_API_FIND_RULES_PATH } from '@kbn/alerting-plugin/common';
+import type { RuleResponse } from '../../../common/detection_engine/rule_schema';
+import { createRule, snoozeRule as snoozeRuleViaAPI } from '../../tasks/api_calls/rules';
+import { cleanKibana, deleteAlertsAndRules, deleteConnectors } from '../../tasks/common';
+import { login, visitWithoutDateRange } from '../../tasks/login';
+import { getNewRule } from '../../objects/rule';
+import { ruleDetailsUrl, ruleEditUrl, SECURITY_DETECTIONS_RULES_URL } from '../../urls/navigation';
+import { internalAlertingSnoozeRule } from '../../urls/routes';
+import { RULES_MANAGEMENT_TABLE, RULE_NAME } from '../../screens/alerts_detection_rules';
+import {
+  expectRuleSnoozed,
+  expectRuleSnoozedInTable,
+  expectRuleUnsnoozed,
+  expectRuleUnsnoozedInTable,
+  expectSnoozeErrorToast,
+  expectSnoozeSuccessToast,
+  expectUnsnoozeSuccessToast,
+  snoozeRule,
+  snoozeRuleInTable,
+  unsnoozeRuleInTable,
+} from '../../tasks/rule_snoozing';
+import { createSlackConnector } from '../../tasks/api_calls/connectors';
+import { duplicateFirstRule, importRules } from '../../tasks/alerts_detection_rules';
+import { goToActionsStepTab } from '../../tasks/create_new_rule';
+import { goToRuleEditSettings } from '../../tasks/rule_details';
+import { actionFormSelector } from '../../screens/common/rule_actions';
+import { RULE_INDICES } from '../../screens/create_new_rule';
+import { addEmailConnectorAndRuleAction } from '../../tasks/common/rule_actions';
+import { saveEditedRule } from '../../tasks/edit_rule';
+import { DISABLED_SNOOZE_BADGE } from '../../screens/rule_snoozing';
+import { TOOLTIP } from '../../screens/common';
+
+const RULES_TO_IMPORT_FILENAME = 'cypress/fixtures/7_16_rules.ndjson';
+
+describe('rule snoozing', () => {
+  before(() => {
+    cleanKibana();
+  });
+
+  beforeEach(() => {
+    login();
+    deleteAlertsAndRules();
+  });
+
+  it('ensures the rule is snoozed on the rules management page, rule details page and rule editing page', () => {
+    createRule(getNewRule({ name: 'Test on all pages' }));
+
+    visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL);
+
+    snoozeRuleInTable({
+      tableSelector: RULES_MANAGEMENT_TABLE,
+      ruleName: 'Test on all pages',
+      duration: '1 hours',
+    });
+
+    // Open rule detail page
+    cy.get(RULE_NAME).contains('Test on all pages').click();
+
+    expectRuleSnoozed('1 hours');
+
+    // Open rule editing page actions tab
+    goToRuleEditSettings();
+    goToActionsStepTab();
+
+    expectRuleSnoozed('1 hours');
+  });
+
+  describe('Rules management table', () => {
+    it('snoozes a rule without actions for 3 hours', () => {
+      createRule(getNewRule({ name: 'Test rule without actions' }));
+
+      visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL);
+
+      snoozeRuleInTable({
+        tableSelector: RULES_MANAGEMENT_TABLE,
+        ruleName: 'Test rule without actions',
+        duration: '3 hours',
+      });
+
+      expectSnoozeSuccessToast();
+      expectRuleSnoozedInTable({
+        tableSelector: RULES_MANAGEMENT_TABLE,
+        ruleName: 'Test rule without actions',
+        duration: '3 hours',
+      });
+    });
+
+    it('snoozes a rule with actions for 2 days', () => {
+      createRuleWithActions({ name: 'Test rule with actions' }, createRule);
+
+      visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL);
+
+      snoozeRuleInTable({
+        tableSelector: RULES_MANAGEMENT_TABLE,
+        ruleName: 'Test rule with actions',
+        duration: '2 days',
+      });
+
+      expectSnoozeSuccessToast();
+      expectRuleSnoozedInTable({
+        tableSelector: RULES_MANAGEMENT_TABLE,
+        ruleName: 'Test rule with actions',
+        duration: '2 days',
+      });
+    });
+
+    it('unsnoozes a rule with actions', () => {
+      createSnoozedRule(getNewRule({ name: 'Snoozed rule' }));
+
+      visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL);
+
+      unsnoozeRuleInTable({
+        tableSelector: RULES_MANAGEMENT_TABLE,
+        ruleName: 'Snoozed rule',
+      });
+
+      expectUnsnoozeSuccessToast();
+      expectRuleUnsnoozedInTable({
+        tableSelector: RULES_MANAGEMENT_TABLE,
+        ruleName: 'Snoozed rule',
+      });
+    });
+
+    it('ensures snooze settings persist after page reload', () => {
+      createRule(getNewRule({ name: 'Test persistence' }));
+
+      visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL);
+
+      snoozeRuleInTable({
+        tableSelector: RULES_MANAGEMENT_TABLE,
+        ruleName: 'Test persistence',
+        duration: '3 days',
+      });
+
+      cy.reload();
+
+      expectRuleSnoozedInTable({
+        tableSelector: RULES_MANAGEMENT_TABLE,
+        ruleName: 'Test persistence',
+        duration: '3 days',
+      });
+    });
+
+    it('ensures a duplicated rule is not snoozed', () => {
+      createRule(getNewRule({ name: 'Test rule' }));
+
+      visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL);
+
+      duplicateFirstRule();
+
+      // Make sure rules table is shown as it navigates to rule editing page after successful duplication
+      visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL);
+
+      expectRuleUnsnoozedInTable({
+        tableSelector: RULES_MANAGEMENT_TABLE,
+        ruleName: 'Test rule',
+      });
+    });
+  });
+
+  describe('Rule editing page / actions tab', () => {
+    beforeEach(() => {
+      deleteConnectors();
+    });
+
+    it('adds an action to a snoozed rule', () => {
+      createSnoozedRule(getNewRule({ name: 'Snoozed rule' })).then(({ body: rule }) => {
+        visitWithoutDateRange(ruleEditUrl(rule.id));
+        // Wait for rule data being loaded
+        cy.get(RULE_INDICES).should('be.visible');
+        goToActionsStepTab();
+
+        addEmailConnectorAndRuleAction('[email protected]', 'Test action');
+        saveEditedRule();
+
+        goToRuleEditSettings();
+        goToActionsStepTab();
+
+        cy.get(actionFormSelector(0)).should('be.visible');
+      });
+    });
+  });
+
+  describe('importing rules', () => {
+    beforeEach(() => {
+      cy.intercept('POST', '/api/detection_engine/rules/_import*').as('import');
+    });
+
+    it('ensures imported rules are unsnoozed', () => {
+      visitWithoutDateRange(SECURITY_DETECTIONS_RULES_URL);
+
+      importRules(RULES_TO_IMPORT_FILENAME);
+
+      cy.wait('@import').then(({ response }) => {
+        cy.wrap(response?.statusCode).should('eql', 200);
+
+        expectRuleUnsnoozedInTable({
+          tableSelector: RULES_MANAGEMENT_TABLE,
+          ruleName: 'Test Custom Rule',
+        });
+      });
+    });
+  });
+
+  describe('Handling errors', () => {
+    it('shows an error if unable to load snooze settings', () => {
+      createRule(getNewRule({ name: 'Test rule' })).then(({ body: rule }) => {
+        cy.intercept('GET', `${INTERNAL_ALERTING_API_FIND_RULES_PATH}*`, {
+          statusCode: 500,
+        });
+
+        visitWithoutDateRange(ruleDetailsUrl(rule.id));
+      });
+
+      cy.get(DISABLED_SNOOZE_BADGE).trigger('mouseover');
+
+      cy.get(TOOLTIP).contains('Unable to fetch snooze settings');
+    });
+
+    it('shows an error if unable to save snooze settings', () => {
+      createRule(getNewRule({ name: 'Test rule' })).then(({ body: rule }) => {
+        cy.intercept('POST', internalAlertingSnoozeRule(rule.id), { forceNetworkError: true });
+
+        visitWithoutDateRange(ruleDetailsUrl(rule.id));
+      });
+
+      snoozeRule('3 days');
+
+      expectSnoozeErrorToast();
+      expectRuleUnsnoozed();
+    });
+  });
+});
+
+function createRuleWithActions(
+  ruleParams: Parameters<typeof getNewRule>[0],
+  ruleCreator: (
+    ruleParams: Parameters<typeof createRule>[0]
+  ) => Cypress.Chainable<Cypress.Response<RuleResponse>>
+): Cypress.Chainable<Cypress.Response<RuleResponse>> {
+  return createSlackConnector().then(({ body }) =>
+    ruleCreator(
+      getNewRule({
+        ...ruleParams,
+        actions: [
+          {
+            id: body.id,
+            action_type_id: '.slack',
+            group: 'default',
+            params: {
+              message: 'Some message',
+            },
+          },
+        ],
+      })
+    )
+  );
+}
+
+function createSnoozedRule(
+  ruleParams: Parameters<typeof createRule>[0]
+): Cypress.Chainable<Cypress.Response<RuleResponse>> {
+  return createRule(ruleParams).then((response) => {
+    const createdRule = response.body;
+    const oneDayInMs = 24 * 60 * 60 * 1000;
+
+    snoozeRuleViaAPI(createdRule.id, oneDayInMs);
+
+    return cy.wrap(response);
+  });
+}

x-pack/plugins/security_solution/cypress/screens/common.ts

@@ -0,0 +1,8 @@
+/*
+ * 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.
+ */
+
+export const TOOLTIP = '[role="tooltip"]';