Skip to content
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 25 commits into from
Oct 19, 2024
Merged
Show file tree
Hide file tree
Changes from 10 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 Sep 17, 2024
80d3a01
[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…
kibanamachine Sep 17, 2024
011fb8f
update cypress
animehart Sep 18, 2024
d19bbc2
Merge branch 'csp-cypress-hostname' of github.com:animehart/kibana in…
animehart Sep 18, 2024
df19df6
Merge branch 'main' into csp-cypress-hostname
animehart Sep 18, 2024
6e0ae67
added user name contextual flyout cypress
animehart Sep 18, 2024
1888ccd
pr comments
animehart Sep 23, 2024
7c2f468
update notes about cypress
animehart Sep 23, 2024
3964c64
Merge branch 'main' into csp-cypress-hostname
animehart Sep 23, 2024
39e8233
Merge branch 'main' into csp-cypress-hostname
animehart Oct 1, 2024
c3879b2
Merge branch 'main' into csp-cypress-hostname
animehart Oct 9, 2024
1b8db59
edit cypress test
animehart Oct 9, 2024
ef20875
start making csp cypress test to run on CI the proper way
animehart Oct 14, 2024
519dec9
more cypress settings
animehart Oct 16, 2024
a04efbd
fix typo
animehart Oct 16, 2024
f21365a
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Oct 16, 2024
675f1c0
remove console log
animehart Oct 17, 2024
a6f95ea
fix conflit 1
animehart Oct 17, 2024
499a692
fix conflict
animehart Oct 17, 2024
5672e82
update readme
animehart Oct 17, 2024
61b251e
fix
animehart Oct 17, 2024
bf1f173
Merge branch 'main' into csp-cypress-hostname
animehart Oct 17, 2024
4c328bb
added groups so we can run Cypres on Flaky Test Runner
animehart Oct 18, 2024
9292da7
fix conflict
animehart Oct 18, 2024
602865d
pr Comments
animehart Oct 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -1765,6 +1765,7 @@ x-pack/plugins/osquery @elastic/security-defend-workflows
/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/single_page_layout/components/cloud_security_posture @elastic/fleet @elastic/kibana-cloud-security-posture
/x-pack/plugins/fleet/public/applications/fleet/sections/agent_policy/create_package_policy_page/single_page_layout/hooks/setup_technology.* @elastic/fleet @elastic/kibana-cloud-security-posture
/x-pack/plugins/security_solution/public/cloud_security_posture @elastic/kibana-cloud-security-posture
/x-pack/test/security_solution_cypress/cypress/e2e/explore/hosts/misconfiguration_contextual_flyout.cy.ts @elastic/kibana-cloud-security-posture

# Security Solution onboarding tour
/x-pack/plugins/security_solution/public/common/components/guided_onboarding @elastic/security-threat-hunting-explore
Expand Down
27 changes: 26 additions & 1 deletion x-pack/plugins/cloud_security_posture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The README inside the security_solution_cypress folder should be updated as well.

> **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.
Expand Down Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ export const MisconfigurationFindingsDetailsTable = memo(
columns={columns}
pagination={pagination}
onChange={onTableChange}
data-test-subj={'securitySolutionFlyoutMisconfigurationFindingsTable'}
/>
</EuiPanel>
</>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@ export const MisconfigurationsPreview = ({
title: (
<EuiText
size="xs"
data-test-subj={'securitySolutionFlyoutInsightsMisconfigurationsTitleText'}
css={css`
font-weight: ${euiTheme.font.weight.semiBold};
`}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
/*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the test. Looks like it's interacting with alerts page and the flyout, shall we move it to x-pack/test/security_solution_cypress/cypress/e2e/investigations/alerts/expandable_flyout?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah kk
So I placed that test in the current folder because @machadoum suggested to put it here
would it be better if i move it to x-pack/test/security_solution_cypress/cypress/e2e/investigations/alerts/expandable_flyout instead ? @machadoum

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@animehart If the tested feature is only displayed inside the expandable flyout, placing the test where @angorayc suggested might make sense. But that is up to the @elastic/security-threat-hunting-investigations team to decide since they own the cypress/e2e/investigations folder. I strongly suggest you create a folder for your team (cloud_security_posture?) so you don't depend on other teams for code reviews.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@machadoum
As discussed before, we were planning to add our own folder later, the reason being is because adding a specific folder for our team now will involve further steps to to make the new test to be ran on CI and because of this time constraint we think its better for us to put our test in existing folder for now

* 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(
'securitySolutionFlyoutInsightsMisconfigurationsTitleText'
);

const CSP_INSIGHT_TAB_TITLE = getDataTestSubjectSelector('securitySolutionFlyoutInsightInputsTab');
const CSP_INSIGHT_TABLE = getDataTestSubjectSelector(
'securitySolutionFlyoutMisconfigurationFindingsTable'
);
const NO_FINDINGS_TEXT = getDataTestSubjectSelector('noFindingsDataTestSubj');
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({
seanrathier marked this conversation as resolved.
Show resolved Hide resolved
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('No Misconfiguration Findings', () => {
it('should not display Misconfiguration preview under Insights Entities when it does not have Misconfiguration Findings', () => {
expandFirstAlertHostFlyout();

cy.log('check if Misconfiguration preview title is not shown');
cy.get(CSP_INSIGHT_MISCONFIGURATION_TITLE).should('not.exist');
});

it('should not display Misconfiguration preview under Insights Entities when it does not have Misconfiguration Findings', () => {
expandFirstAlertUserFlyout();

cy.log('check if Misconfiguration preview title is not shown');
cy.get(CSP_INSIGHT_MISCONFIGURATION_TITLE).should('not.exist');
});
});

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.contains('Failed findings', { timeout: 3000 });
cy.contains('Misconfigurations').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', () => {
cy.log('check if Misconfiguration preview title shown');
cy.get(CSP_INSIGHT_MISCONFIGURATION_TITLE).should('be.visible');
cy.get(NO_FINDINGS_TEXT).should('be.visible');
});
}
);

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.contains('Failed findings', { timeout: 3000 });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 Whenever I see a time-out in a test, it concerns me that we have a performance issue with the UI (sometimes the test runner).

Have we had to do the same in the Selenium tests for the Findings?

I would have expected with mock data that we should be showing the table in under 3 seconds.

cy.contains('Misconfigurations').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', () => {
cy.log('check if Misconfiguration preview title shown');
cy.get(CSP_INSIGHT_MISCONFIGURATION_TITLE).should('be.visible');
cy.get(NO_FINDINGS_TEXT).should('be.visible');
});
}
);
});
Original file line number Diff line number Diff line change
Expand Up @@ -44,5 +44,6 @@
"@kbn/securitysolution-endpoint-exceptions-common",
"@kbn/repo-info",
"@kbn/elastic-assistant-common",
"@kbn/cloud-security-posture-common",
]
}