[7.x] [Security Solutions][Detection Engine] Adds a warning banner when the alerts data has not been migrated yet. (#90258)

x-pack/plugins/security_solution/common/utility_types.ts

@@ -36,6 +36,12 @@ export const stringEnum = <T>(enumObj: T, enumName = 'enum') =>
  *
  * Optionally you can avoid the use of this by using early returns and TypeScript will clear your type checking without complaints
  * but there are situations and times where this function might still be needed.
+ *
+ * If you see an error, DO NOT cast "as never" such as:
+ * assertUnreachable(x as never) // BUG IN YOUR CODE NOW AND IT WILL THROW DURING RUNTIME
+ * If you see code like that remove it, as that deactivates the intent of this utility.
+ * If you need to do that, then you should remove assertUnreachable from your code and
+ * use a default at the end of the switch instead.
  * @param x Unreachable field
  * @param message Message of error thrown
  */

x-pack/plugins/security_solution/cypress/integration/detection_alerts/alerts_detection_callouts_index_outdated.spec.ts

@@ -0,0 +1,196 @@
+/*
+ * 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 { ROLES } from '../../../common/test';
+import { DETECTIONS_RULE_MANAGEMENT_URL, DETECTIONS_URL } from '../../urls/navigation';
+import { newRule } from '../../objects/rule';
+import { PAGE_TITLE } from '../../screens/common/page';
+
+import {
+  login,
+  loginAndWaitForPageWithoutDateRange,
+  waitForPageWithoutDateRange,
+} from '../../tasks/login';
+import { waitForAlertsIndexToBeCreated } from '../../tasks/alerts';
+import { goToRuleDetails } from '../../tasks/alerts_detection_rules';
+import { createCustomRule, deleteCustomRule } from '../../tasks/api_calls/rules';
+import { getCallOut, waitForCallOutToBeShown } from '../../tasks/common/callouts';
+import { cleanKibana } from '../../tasks/common';
+
+const loadPageAsPlatformEngineerUser = (url: string) => {
+  waitForPageWithoutDateRange(url, ROLES.soc_manager);
+  waitForPageTitleToBeShown();
+};
+
+const waitForPageTitleToBeShown = () => {
+  cy.get(PAGE_TITLE).should('be.visible');
+};
+
+describe('Detections > Need Admin Callouts indicating an admin is needed to migrate the alert data set', () => {
+  const NEED_ADMIN_FOR_UPDATE_CALLOUT = 'need-admin-for-update-rules';
+
+  before(() => {
+    // First, we have to open the app on behalf of a privileged user in order to initialize it.
+    // Otherwise the app will be disabled and show a "welcome"-like page.
+    cleanKibana();
+    loginAndWaitForPageWithoutDateRange(DETECTIONS_URL, ROLES.platform_engineer);
+    waitForAlertsIndexToBeCreated();
+
+    // After that we can login as a soc manager.
+    login(ROLES.soc_manager);
+  });
+
+  context(
+    'The users index_mapping_outdated is "true" and their admin callouts should show up',
+    () => {
+      beforeEach(() => {
+        // Index mapping outdated is forced to return true as being outdated so that we get the
+        // need admin callouts being shown.
+        cy.intercept('GET', '/api/detection_engine/index', {
+          index_mapping_outdated: true,
+          name: '.siem-signals-default',
+        });
+      });
+      context('On Detections home page', () => {
+        beforeEach(() => {
+          loadPageAsPlatformEngineerUser(DETECTIONS_URL);
+        });
+
+        it('We show the need admin primary callout', () => {
+          waitForCallOutToBeShown(NEED_ADMIN_FOR_UPDATE_CALLOUT, 'primary');
+        });
+      });
+
+      context('On Rules Management page', () => {
+        beforeEach(() => {
+          loadPageAsPlatformEngineerUser(DETECTIONS_RULE_MANAGEMENT_URL);
+        });
+
+        it('We show 1 primary callout of need admin', () => {
+          waitForCallOutToBeShown(NEED_ADMIN_FOR_UPDATE_CALLOUT, 'primary');
+        });
+      });
+
+      context('On Rule Details page', () => {
+        beforeEach(() => {
+          createCustomRule(newRule);
+          loadPageAsPlatformEngineerUser(DETECTIONS_RULE_MANAGEMENT_URL);
+          waitForPageTitleToBeShown();
+          goToRuleDetails();
+        });
+
+        afterEach(() => {
+          deleteCustomRule();
+        });
+
+        it('We show 1 primary callout', () => {
+          waitForCallOutToBeShown(NEED_ADMIN_FOR_UPDATE_CALLOUT, 'primary');
+        });
+      });
+    }
+  );
+
+  context(
+    'The users index_mapping_outdated is "false" and their admin callouts should not show up ',
+    () => {
+      beforeEach(() => {
+        // Index mapping outdated is forced to return true as being outdated so that we get the
+        // need admin callouts being shown.
+        cy.intercept('GET', '/api/detection_engine/index', {
+          index_mapping_outdated: false,
+          name: '.siem-signals-default',
+        });
+      });
+      context('On Detections home page', () => {
+        beforeEach(() => {
+          loadPageAsPlatformEngineerUser(DETECTIONS_URL);
+        });
+
+        it('We show the need admin primary callout', () => {
+          getCallOut(NEED_ADMIN_FOR_UPDATE_CALLOUT).should('not.exist');
+        });
+      });
+
+      context('On Rules Management page', () => {
+        beforeEach(() => {
+          loadPageAsPlatformEngineerUser(DETECTIONS_RULE_MANAGEMENT_URL);
+        });
+
+        it('We show 1 primary callout of need admin', () => {
+          getCallOut(NEED_ADMIN_FOR_UPDATE_CALLOUT).should('not.exist');
+        });
+      });
+
+      context('On Rule Details page', () => {
+        beforeEach(() => {
+          createCustomRule(newRule);
+          loadPageAsPlatformEngineerUser(DETECTIONS_RULE_MANAGEMENT_URL);
+          waitForPageTitleToBeShown();
+          goToRuleDetails();
+        });
+
+        afterEach(() => {
+          deleteCustomRule();
+        });
+
+        it('We show 1 primary callout', () => {
+          getCallOut(NEED_ADMIN_FOR_UPDATE_CALLOUT).should('not.exist');
+        });
+      });
+    }
+  );
+
+  context(
+    'The users index_mapping_outdated is "null" and their admin callouts should not show up ',
+    () => {
+      beforeEach(() => {
+        // Index mapping outdated is forced to return true as being outdated so that we get the
+        // need admin callouts being shown.
+        cy.intercept('GET', '/api/detection_engine/index', {
+          index_mapping_outdated: null,
+          name: '.siem-signals-default',
+        });
+      });
+      context('On Detections home page', () => {
+        beforeEach(() => {
+          loadPageAsPlatformEngineerUser(DETECTIONS_URL);
+        });
+
+        it('We show the need admin primary callout', () => {
+          getCallOut(NEED_ADMIN_FOR_UPDATE_CALLOUT).should('not.exist');
+        });
+      });
+
+      context('On Rules Management page', () => {
+        beforeEach(() => {
+          loadPageAsPlatformEngineerUser(DETECTIONS_RULE_MANAGEMENT_URL);
+        });
+
+        it('We show 1 primary callout of need admin', () => {
+          getCallOut(NEED_ADMIN_FOR_UPDATE_CALLOUT).should('not.exist');
+        });
+      });
+
+      context('On Rule Details page', () => {
+        beforeEach(() => {
+          createCustomRule(newRule);
+          loadPageAsPlatformEngineerUser(DETECTIONS_RULE_MANAGEMENT_URL);
+          waitForPageTitleToBeShown();
+          goToRuleDetails();
+        });
+
+        afterEach(() => {
+          deleteCustomRule();
+        });
+
+        it('We show 1 primary callout', () => {
+          getCallOut(NEED_ADMIN_FOR_UPDATE_CALLOUT).should('not.exist');
+        });
+      });
+    }
+  );
+});

x-pack/plugins/security_solution/cypress/integration/detection_alerts/alerts_detection_callouts_readonly.spec.ts

@@ -26,6 +26,11 @@ const loadPageAsReadOnlyUser = (url: string) => {
   waitForPageTitleToBeShown();
 };
 
+const loadPageAsPlatformEngineer = (url: string) => {
+  waitForPageWithoutDateRange(url, ROLES.platform_engineer);
+  waitForPageTitleToBeShown();
+};
+
 const reloadPage = () => {
   cy.reload();
   waitForPageTitleToBeShown();
@@ -35,7 +40,7 @@ const waitForPageTitleToBeShown = () => {
   cy.get(PAGE_TITLE).should('be.visible');
 };
 
-describe('Detections > Callouts indicating read-only access to resources', () => {
+describe('Detections > Callouts', () => {
   const ALERTS_CALLOUT = 'read-only-access-to-alerts';
   const RULES_CALLOUT = 'read-only-access-to-rules';
 
@@ -50,75 +55,119 @@ describe('Detections > Callouts indicating read-only access to resources', () =>
     login(ROLES.reader);
   });
 
-  context('On Detections home page', () => {
-    beforeEach(() => {
-      loadPageAsReadOnlyUser(DETECTIONS_URL);
-    });
-
-    it('We show one primary callout', () => {
-      waitForCallOutToBeShown(ALERTS_CALLOUT, 'primary');
-    });
+  context('indicating read-only access to resources', () => {
+    context('On Detections home page', () => {
+      beforeEach(() => {
+        loadPageAsReadOnlyUser(DETECTIONS_URL);
+      });
 
-    context('When a user clicks Dismiss on the callout', () => {
-      it('We hide it and persist the dismissal', () => {
+      it('We show one primary callout', () => {
         waitForCallOutToBeShown(ALERTS_CALLOUT, 'primary');
-        dismissCallOut(ALERTS_CALLOUT);
-        reloadPage();
-        getCallOut(ALERTS_CALLOUT).should('not.exist');
       });
-    });
-  });
 
-  context('On Rules Management page', () => {
-    beforeEach(() => {
-      loadPageAsReadOnlyUser(DETECTIONS_RULE_MANAGEMENT_URL);
+      context('When a user clicks Dismiss on the callout', () => {
+        it('We hide it and persist the dismissal', () => {
+          waitForCallOutToBeShown(ALERTS_CALLOUT, 'primary');
+          dismissCallOut(ALERTS_CALLOUT);
+          reloadPage();
+          getCallOut(ALERTS_CALLOUT).should('not.exist');
+        });
+      });
     });
 
-    it('We show one primary callout', () => {
-      waitForCallOutToBeShown(RULES_CALLOUT, 'primary');
-    });
+    context('On Rules Management page', () => {
+      beforeEach(() => {
+        loadPageAsReadOnlyUser(DETECTIONS_RULE_MANAGEMENT_URL);
+      });
 
-    context('When a user clicks Dismiss on the callout', () => {
-      it('We hide it and persist the dismissal', () => {
+      it('We show one primary callout', () => {
         waitForCallOutToBeShown(RULES_CALLOUT, 'primary');
-        dismissCallOut(RULES_CALLOUT);
-        reloadPage();
-        getCallOut(RULES_CALLOUT).should('not.exist');
       });
-    });
-  });
 
-  context('On Rule Details page', () => {
-    beforeEach(() => {
-      createCustomRule(newRule);
-      loadPageAsReadOnlyUser(DETECTIONS_RULE_MANAGEMENT_URL);
-      waitForPageTitleToBeShown();
-      goToRuleDetails();
+      context('When a user clicks Dismiss on the callout', () => {
+        it('We hide it and persist the dismissal', () => {
+          waitForCallOutToBeShown(RULES_CALLOUT, 'primary');
+          dismissCallOut(RULES_CALLOUT);
+          reloadPage();
+          getCallOut(RULES_CALLOUT).should('not.exist');
+        });
+      });
     });
 
-    afterEach(() => {
-      deleteCustomRule();
-    });
+    context('On Rule Details page', () => {
+      beforeEach(() => {
+        createCustomRule(newRule);
+        loadPageAsReadOnlyUser(DETECTIONS_RULE_MANAGEMENT_URL);
+        waitForPageTitleToBeShown();
+        goToRuleDetails();
+      });
 
-    it('We show two primary callouts', () => {
-      waitForCallOutToBeShown(ALERTS_CALLOUT, 'primary');
-      waitForCallOutToBeShown(RULES_CALLOUT, 'primary');
-    });
+      afterEach(() => {
+        deleteCustomRule();
+      });
 
-    context('When a user clicks Dismiss on the callouts', () => {
-      it('We hide them and persist the dismissal', () => {
+      it('We show two primary callouts', () => {
         waitForCallOutToBeShown(ALERTS_CALLOUT, 'primary');
         waitForCallOutToBeShown(RULES_CALLOUT, 'primary');
+      });
 
-        dismissCallOut(ALERTS_CALLOUT);
-        reloadPage();
+      context('When a user clicks Dismiss on the callouts', () => {
+        it('We hide them and persist the dismissal', () => {
+          waitForCallOutToBeShown(ALERTS_CALLOUT, 'primary');
+          waitForCallOutToBeShown(RULES_CALLOUT, 'primary');
 
+          dismissCallOut(ALERTS_CALLOUT);
+          reloadPage();
+
+          getCallOut(ALERTS_CALLOUT).should('not.exist');
+          getCallOut(RULES_CALLOUT).should('be.visible');
+
+          dismissCallOut(RULES_CALLOUT);
+          reloadPage();
+
+          getCallOut(ALERTS_CALLOUT).should('not.exist');
+          getCallOut(RULES_CALLOUT).should('not.exist');
+        });
+      });
+    });
+  });
+
+  context('indicating read-write access to resources', () => {
+    context('On Detections home page', () => {
+      beforeEach(() => {
+        loadPageAsPlatformEngineer(DETECTIONS_URL);
+      });
+
+      it('We show no callout', () => {
+        getCallOut(ALERTS_CALLOUT).should('not.exist');
+        getCallOut(RULES_CALLOUT).should('not.exist');
+      });
+    });
+
+    context('On Rules Management page', () => {
+      beforeEach(() => {
+        loadPageAsPlatformEngineer(DETECTIONS_RULE_MANAGEMENT_URL);
+      });
+
+      it('We show no callout', () => {
         getCallOut(ALERTS_CALLOUT).should('not.exist');
-        getCallOut(RULES_CALLOUT).should('be.visible');
+        getCallOut(RULES_CALLOUT).should('not.exist');
+      });
+    });
 
-        dismissCallOut(RULES_CALLOUT);
-        reloadPage();
+    context('On Rule Details page', () => {
+      beforeEach(() => {
+        createCustomRule(newRule);
+        loadPageAsPlatformEngineer(DETECTIONS_RULE_MANAGEMENT_URL);
+        waitForPageTitleToBeShown();
+        goToRuleDetails();
+      });
+
+      afterEach(() => {
+        deleteCustomRule();
+      });
 
+      it('We show no callouts', () => {
         getCallOut(ALERTS_CALLOUT).should('not.exist');
         getCallOut(RULES_CALLOUT).should('not.exist');
       });