[Security Solutions][Detection Engine] Adds a warning banner when the alerts data has not been migrated yet. #90258
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /* | ||
| * 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 { | ||
| 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 } from '../../tasks/common/callouts'; | ||
| import { cleanKibana } from '../../tasks/common'; | ||
|
|
||
| const loadPageAsPlatformEngineerUser = (url: string) => { | ||
| waitForPageWithoutDateRange(url, ROLES.platform_engineer); | ||
| 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'; | ||
| const ALERTS_CALLOUT = 'read-only-access-to-alerts'; | ||
| const RULES_CALLOUT = 'read-only-access-to-rules'; | ||
|
|
||
| before(() => { | ||
| cleanKibana(); | ||
| loginAndWaitForPageWithoutDateRange(DETECTIONS_URL, ROLES.platform_engineer); | ||
| waitForAlertsIndexToBeCreated(); | ||
| }); | ||
|
|
||
| context('On Detections home page', () => { | ||
| beforeEach(() => { | ||
| loadPageAsPlatformEngineerUser(DETECTIONS_URL); | ||
| }); | ||
|
|
||
| it('We show no callouts', () => { | ||
| getCallOut(ALERTS_CALLOUT).should('not.exist'); | ||
| getCallOut(RULES_CALLOUT).should('not.exist'); | ||
| getCallOut(NEED_ADMIN_FOR_UPDATE_CALLOUT).should('not.exist'); | ||
| }); | ||
| }); | ||
|
|
||
| context('On Rules Management page', () => { | ||
| beforeEach(() => { | ||
| loadPageAsPlatformEngineerUser(DETECTIONS_RULE_MANAGEMENT_URL); | ||
| }); | ||
|
|
||
| it('We show no callouts', () => { | ||
| getCallOut(ALERTS_CALLOUT).should('not.exist'); | ||
| getCallOut(RULES_CALLOUT).should('not.exist'); | ||
| 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 no callouts', () => { | ||
| getCallOut(ALERTS_CALLOUT).should('not.exist'); | ||
| getCallOut(RULES_CALLOUT).should('not.exist'); | ||
| getCallOut(NEED_ADMIN_FOR_UPDATE_CALLOUT).should('not.exist'); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| /* | ||
| * 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 { | ||
| 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 } from '../../tasks/common/callouts'; | ||
| import { cleanKibana } from '../../tasks/common'; | ||
|
|
||
| const loadPageAsPlatformEngineerUser = (url: string) => { | ||
| waitForPageWithoutDateRange(url, ROLES.platform_engineer); | ||
| 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'; | ||
| const ALERTS_CALLOUT = 'read-only-access-to-alerts'; | ||
| const RULES_CALLOUT = 'read-only-access-to-rules'; | ||
|
|
||
| before(() => { | ||
| cleanKibana(); | ||
| loginAndWaitForPageWithoutDateRange(DETECTIONS_URL, ROLES.platform_engineer); | ||
| waitForAlertsIndexToBeCreated(); | ||
| }); | ||
|
|
||
| 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', () => { | ||
| getCallOut(ALERTS_CALLOUT).should('not.exist'); | ||
| getCallOut(RULES_CALLOUT).should('not.exist'); | ||
| 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(ALERTS_CALLOUT).should('not.exist'); | ||
| getCallOut(RULES_CALLOUT).should('not.exist'); | ||
| 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(ALERTS_CALLOUT).should('not.exist'); | ||
| getCallOut(RULES_CALLOUT).should('not.exist'); | ||
| getCallOut(NEED_ADMIN_FOR_UPDATE_CALLOUT).should('not.exist'); | ||
| }); | ||
| }); | ||
| }); | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /* | ||
| * 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, dismissCallOut } from '../../tasks/common/callouts'; | ||
| import { cleanKibana } from '../../tasks/common'; | ||
|
|
||
| const loadPageAsReadOnlyUser = (url: string) => { | ||
| waitForPageWithoutDateRange(url, ROLES.reader); | ||
| waitForPageTitleToBeShown(); | ||
| }; | ||
|
|
||
| const reloadPage = () => { | ||
| cy.reload(); | ||
| 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 ALERTS_CALLOUT = 'read-only-access-to-alerts'; | ||
| const RULES_CALLOUT = 'read-only-access-to-rules'; | ||
| 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 read-only user. | ||
| login(ROLES.reader); | ||
| }); | ||
|
|
||
| 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(() => { | ||
| loadPageAsReadOnlyUser(DETECTIONS_URL); | ||
| }); | ||
|
|
||
| it('We show the alerts and admin primary callout', () => { | ||
| waitForCallOutToBeShown(ALERTS_CALLOUT, 'primary'); | ||
| waitForCallOutToBeShown(NEED_ADMIN_FOR_UPDATE_CALLOUT, 'primary'); | ||
| }); | ||
|
|
||
| context('When a user clicks Dismiss on the callout', () => { | ||
| it('We hide it and persist the dismissal but still show the admin callout', () => { | ||
| waitForCallOutToBeShown(ALERTS_CALLOUT, 'primary'); | ||
| dismissCallOut(ALERTS_CALLOUT); | ||
| reloadPage(); | ||
| getCallOut(ALERTS_CALLOUT).should('not.exist'); | ||
| waitForCallOutToBeShown(NEED_ADMIN_FOR_UPDATE_CALLOUT, 'primary'); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| context('On Rules Management page', () => { | ||
| beforeEach(() => { | ||
| loadPageAsReadOnlyUser(DETECTIONS_RULE_MANAGEMENT_URL); | ||
| }); | ||
|
|
||
| it('We show two primary callouts of the alert and the admin', () => { | ||
| waitForCallOutToBeShown(RULES_CALLOUT, 'primary'); | ||
| waitForCallOutToBeShown(NEED_ADMIN_FOR_UPDATE_CALLOUT, 'primary'); | ||
| }); | ||
|
|
||
| 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'); | ||
| waitForCallOutToBeShown(NEED_ADMIN_FOR_UPDATE_CALLOUT, 'primary'); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| context('On Rule Details page', () => { | ||
| beforeEach(() => { | ||
| createCustomRule(newRule); | ||
| loadPageAsReadOnlyUser(DETECTIONS_RULE_MANAGEMENT_URL); | ||
| waitForPageTitleToBeShown(); | ||
| goToRuleDetails(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| deleteCustomRule(); | ||
| }); | ||
|
|
||
| it('We show three primary callouts', () => { | ||
| waitForCallOutToBeShown(ALERTS_CALLOUT, 'primary'); | ||
| waitForCallOutToBeShown(RULES_CALLOUT, 'primary'); | ||
| waitForCallOutToBeShown(NEED_ADMIN_FOR_UPDATE_CALLOUT, 'primary'); | ||
| }); | ||
|
|
||
| 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'); | ||
| waitForCallOutToBeShown(NEED_ADMIN_FOR_UPDATE_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'); | ||
| waitForCallOutToBeShown(NEED_ADMIN_FOR_UPDATE_CALLOUT, 'primary'); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we could omit checking these guys in all tests which check the behaviour of
NEED_ADMIN_FOR_UPDATE_CALLOUT?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think these are missing tests for the callouts since so far what we have been testing is that callouts will appear when they're supposed to appear based on a lack of permissions. However, the other flip side is that we need tests based on when the user has sufficient permissions and some if not all the callouts should not appear.
So, without tests that are checking for the non-existence of callouts when users have sufficient privileges we could introduce bugs where callouts show up on pages when users have sufficient privileges and we wouldn't catch it. With these additional tests in place we should hopefully catch all if not most of the test cases where:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a great point, I agree! However after re-reading all my comments, and the answers, and checking the code I think I just failed to explain what I meant. Would you have some time to chat on that stuff specifically?