-
Notifications
You must be signed in to change notification settings - Fork 8.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Cloud Security] Cypress Test for Misconfiguration Preview and Table for Contextual Flyout #193125
Merged
Merged
Changes from 12 commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
f8ed329
initial push: added cypress test for Misconfiguration preview
animehart 80d3a01
[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…
kibanamachine 011fb8f
update cypress
animehart d19bbc2
Merge branch 'csp-cypress-hostname' of github.com:animehart/kibana in…
animehart df19df6
Merge branch 'main' into csp-cypress-hostname
animehart 6e0ae67
added user name contextual flyout cypress
animehart 1888ccd
pr comments
animehart 7c2f468
update notes about cypress
animehart 3964c64
Merge branch 'main' into csp-cypress-hostname
animehart 39e8233
Merge branch 'main' into csp-cypress-hostname
animehart c3879b2
Merge branch 'main' into csp-cypress-hostname
animehart 1b8db59
edit cypress test
animehart ef20875
start making csp cypress test to run on CI the proper way
animehart 519dec9
more cypress settings
animehart a04efbd
fix typo
animehart f21365a
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine 675f1c0
remove console log
animehart a6f95ea
fix conflit 1
animehart 499a692
fix conflict
animehart 5672e82
update readme
animehart 61b251e
fix
animehart bf1f173
Merge branch 'main' into csp-cypress-hostname
animehart 4c328bb
added groups so we can run Cypres on Flaky Test Runner
animehart 9292da7
fix conflict
animehart 602865d
pr Comments
animehart File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Validating CODEOWNERS rules …
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 |
---|---|---|
|
@@ -20,6 +20,7 @@ For general guidelines, read [Kibana Testing Guide](https://www.elastic.co/guide | |
1. [End-to-End Tests](../../test/cloud_security_posture_functional/config.ts) | ||
1. [Serverless API Integration tests](../../test_serverless/api_integration/test_suites/security/config.ts) | ||
1. [Serverless End-to-End Tests](../../test_serverless/functional/test_suites/security/config.ts) | ||
1. [Cypress End-to-End Tests (Temporary location)](../../test/security_solution_cypress/cypress/e2e/explore/hosts) | ||
|
||
|
||
### Tools | ||
|
@@ -73,6 +74,15 @@ yarn test:ftr --config x-pack/test_serverless/api_integration/test_suites/securi | |
yarn test:ftr --config x-pack/test_serverless/functional/test_suites/security/config.cloud_security_posture.ts | ||
``` | ||
|
||
Run [**End-to-End Cypress Tests**](https://github.com/elastic/kibana/tree/main/x-pack/test/security_solution_cypress/cypress): | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The README inside the |
||
> **Note** | ||
> | ||
> Run this from security_solution_cypress folder | ||
```bash | ||
yarn cypress:open:serverless | ||
yarn cypress:open:ess | ||
``` | ||
|
||
#### Run **FTR tests (integration or e2e) for development** | ||
|
||
Functional test runner (FTR) can be used separately with `ftr:runner` and `ftr:server`. This is convenient while developing tests. | ||
|
@@ -107,4 +117,19 @@ run serverless e2e tests: | |
```bash | ||
yarn test:ftr:server --config x-pack/test_serverless/functional/test_suites/security/config.cloud_security_posture.ts | ||
yarn test:ftr:runner ---config x-pack/test_serverless/functional/test_suites/security/config.cloud_security_posture.ts | ||
``` | ||
``` | ||
|
||
#### Run **Cypress tests (e2e) for development** | ||
When developing feature outside our plugin folder, instead of using FTRs for e2e test, we may use Cypress. Before running cypress, make sure you have installed it first. Like FTRs, we can run cypress in different environment, for example: | ||
|
||
run ess e2e tests: | ||
```bash | ||
yarn cypress:open:ess | ||
``` | ||
|
||
run serverless e2e tests: | ||
```bash | ||
yarn cypress:open:serverless | ||
``` | ||
|
||
Unlike FTR where we have to set server and runner separately, Cypress handles everything in 1 go, so just running the above the script is enough to get it running |
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
216 changes: 216 additions & 0 deletions
216
...ress/e2e/investigations/alerts/expandable_flyout/misconfiguration_contextual_flyout.cy.ts
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,216 @@ | ||
/* | ||
* 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 { CDR_LATEST_NATIVE_MISCONFIGURATIONS_INDEX_PATTERN } from '@kbn/cloud-security-posture-common'; | ||
import { createRule } from '../../../../tasks/api_calls/rules'; | ||
import { getNewRule } from '../../../../objects/rule'; | ||
import { getDataTestSubjectSelector } from '../../../../helpers/common'; | ||
|
||
import { rootRequest, deleteAlertsAndRules } from '../../../../tasks/api_calls/common'; | ||
import { | ||
expandFirstAlertHostFlyout, | ||
expandFirstAlertUserFlyout, | ||
} from '../../../../tasks/asset_criticality/common'; | ||
import { waitForAlertsToPopulate } from '../../../../tasks/create_new_rule'; | ||
import { login } from '../../../../tasks/login'; | ||
import { ALERTS_URL } from '../../../../urls/navigation'; | ||
import { visit } from '../../../../tasks/navigation'; | ||
|
||
const CSP_INSIGHT_MISCONFIGURATION_TITLE = getDataTestSubjectSelector( | ||
'securitySolutionFlyoutInsightsMisconfigurationsTitleLink' | ||
); | ||
|
||
const CSP_INSIGHT_TAB_TITLE = getDataTestSubjectSelector('securitySolutionFlyoutInsightInputsTab'); | ||
const CSP_INSIGHT_TABLE = getDataTestSubjectSelector( | ||
'securitySolutionFlyoutMisconfigurationFindingsTable' | ||
); | ||
|
||
const timestamp = Date.now(); | ||
|
||
// Create a Date object using the timestamp | ||
const date = new Date(timestamp); | ||
|
||
// Convert the Date object to ISO 8601 format | ||
const iso8601String = date.toISOString(); | ||
|
||
const mockFindingHostName = (matches: boolean) => { | ||
return { | ||
'@timestamp': iso8601String, | ||
host: { name: matches ? 'siem-kibana' : 'not-siem-kibana' }, | ||
resource: { | ||
id: '1234ABCD', | ||
name: 'kubelet', | ||
sub_type: 'lower case sub type', | ||
}, | ||
result: { evaluation: matches ? 'passed' : 'failed' }, // Adjusting result based on matches | ||
rule: { | ||
name: 'Upper case rule name', | ||
section: 'Upper case section', | ||
benchmark: { | ||
id: 'cis_k8s', | ||
posture_type: 'kspm', | ||
name: 'CIS Kubernetes V1.23', | ||
version: 'v1.0.0', | ||
}, | ||
type: 'process', | ||
}, | ||
cluster_id: 'Upper case cluster id', | ||
data_stream: { | ||
dataset: 'cloud_security_posture.findings', | ||
}, | ||
}; | ||
}; | ||
|
||
const mockFindingUserName = (matches: boolean) => { | ||
return { | ||
'@timestamp': iso8601String, | ||
user: { name: matches ? 'test' : 'not-test' }, | ||
resource: { | ||
id: '1234ABCD', | ||
name: 'kubelet', | ||
sub_type: 'lower case sub type', | ||
}, | ||
result: { evaluation: matches ? 'passed' : 'failed' }, // Adjusting result based on matches | ||
rule: { | ||
name: 'Upper case rule name', | ||
section: 'Upper case section', | ||
benchmark: { | ||
id: 'cis_k8s', | ||
posture_type: 'kspm', | ||
name: 'CIS Kubernetes V1.23', | ||
version: 'v1.0.0', | ||
}, | ||
type: 'process', | ||
}, | ||
cluster_id: 'Upper case cluster id', | ||
data_stream: { | ||
dataset: 'cloud_security_posture.findings', | ||
}, | ||
}; | ||
}; | ||
|
||
const createMockFinding = (isNameMatches: boolean, findingType: 'host.name' | 'user.name') => { | ||
return rootRequest({ | ||
method: 'POST', | ||
url: `${Cypress.env( | ||
'ELASTICSEARCH_URL' | ||
)}/${CDR_LATEST_NATIVE_MISCONFIGURATIONS_INDEX_PATTERN}/_doc`, | ||
body: | ||
findingType === 'host.name' | ||
? mockFindingHostName(isNameMatches) | ||
: mockFindingUserName(isNameMatches), | ||
}); | ||
}; | ||
|
||
const deleteDataStream = () => { | ||
return rootRequest({ | ||
method: 'DELETE', | ||
url: `${Cypress.env( | ||
'ELASTICSEARCH_URL' | ||
)}/_data_stream/${CDR_LATEST_NATIVE_MISCONFIGURATIONS_INDEX_PATTERN}`, | ||
}); | ||
}; | ||
|
||
describe('Alert Host details expandable flyout', { tags: ['@ess', '@serverless'] }, () => { | ||
beforeEach(() => { | ||
deleteAlertsAndRules(); | ||
login(); | ||
createRule(getNewRule()); | ||
visit(ALERTS_URL); | ||
waitForAlertsToPopulate(); | ||
}); | ||
|
||
context('Host name - Has misconfiguration findings', () => { | ||
beforeEach(() => { | ||
createMockFinding(true, 'host.name'); | ||
cy.reload(); | ||
expandFirstAlertHostFlyout(); | ||
}); | ||
|
||
afterEach(() => { | ||
deleteDataStream(); | ||
}); | ||
|
||
it('should display Misconfiguration preview under Insights Entities when it has Misconfiguration Findings', () => { | ||
cy.log('check if Misconfiguration preview title shown'); | ||
cy.get(CSP_INSIGHT_MISCONFIGURATION_TITLE).should('be.visible'); | ||
}); | ||
|
||
it('should display insight tabs and findings table upon clicking on misconfiguration accordion', () => { | ||
cy.get(CSP_INSIGHT_MISCONFIGURATION_TITLE).click(); | ||
cy.get(CSP_INSIGHT_TAB_TITLE).should('be.visible'); | ||
cy.get(CSP_INSIGHT_TABLE).should('be.visible'); | ||
}); | ||
}); | ||
|
||
context( | ||
'Host name - Has misconfiguration findings but host name is not the same as alert host name', | ||
() => { | ||
beforeEach(() => { | ||
createMockFinding(false, 'host.name'); | ||
cy.reload(); | ||
expandFirstAlertHostFlyout(); | ||
}); | ||
|
||
afterEach(() => { | ||
deleteDataStream(); | ||
}); | ||
|
||
it('should display Misconfiguration preview under Insights Entities when it has Misconfiguration Findings', () => { | ||
expandFirstAlertHostFlyout(); | ||
|
||
cy.log('check if Misconfiguration preview title is not shown'); | ||
cy.get(CSP_INSIGHT_MISCONFIGURATION_TITLE).should('not.exist'); | ||
}); | ||
} | ||
); | ||
|
||
context('User name - Has misconfiguration findings', () => { | ||
beforeEach(() => { | ||
createMockFinding(true, 'user.name'); | ||
cy.reload(); | ||
expandFirstAlertUserFlyout(); | ||
}); | ||
|
||
afterEach(() => { | ||
deleteDataStream(); | ||
}); | ||
|
||
it('should display Misconfiguration preview under Insights Entities when it has Misconfiguration Findings', () => { | ||
cy.log('check if Misconfiguration preview title shown'); | ||
cy.get(CSP_INSIGHT_MISCONFIGURATION_TITLE).should('be.visible'); | ||
}); | ||
|
||
it('should display insight tabs and findings table upon clicking on misconfiguration accordion', () => { | ||
cy.get(CSP_INSIGHT_MISCONFIGURATION_TITLE).click(); | ||
cy.get(CSP_INSIGHT_TAB_TITLE).should('be.visible'); | ||
cy.get(CSP_INSIGHT_TABLE).should('be.visible'); | ||
}); | ||
}); | ||
|
||
context( | ||
'User name - Has misconfiguration findings but host name is not the same as alert host name', | ||
() => { | ||
beforeEach(() => { | ||
createMockFinding(false, 'user.name'); | ||
cy.reload(); | ||
expandFirstAlertHostFlyout(); | ||
}); | ||
|
||
afterEach(() => { | ||
deleteDataStream(); | ||
}); | ||
|
||
it('should display Misconfiguration preview under Insights Entities when it has Misconfiguration Findings', () => { | ||
expandFirstAlertUserFlyout(); | ||
|
||
cy.log('check if Misconfiguration preview title is not shown'); | ||
cy.get(CSP_INSIGHT_MISCONFIGURATION_TITLE).should('not.exist'); | ||
}); | ||
} | ||
); | ||
}); |
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.
Is it possible to move this test to your new folder?
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.
oh woops
missed that