From 4695a7822ac95cc71407725c6cc139a3f7937602 Mon Sep 17 00:00:00 2001 From: Gloria Hornero Date: Fri, 21 Mar 2025 22:46:49 +0100 Subject: [PATCH] [9.0] initial @kbn/scout-security plugin (#210433) (#215528) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Backport This will backport the following commits from `main` to `9.0`: - [initial @kbn/scout-security plugin (#210433)](https://github.com/elastic/kibana/pull/210433) ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) --------- Co-authored-by: Dzmitry Lemechko --- .buildkite/scout_ci_config.yml | 1 + .../pipelines/pull_request/pipeline.ts | 2 + .eslintrc.js | 1 + .github/CODEOWNERS | 1 + package.json | 1 + .../kbn-es/src/stateful_resources/roles.yml | 3 +- .../packages/shared/kbn-scout/index.ts | 4 + .../fixtures/single_thread_fixtures.ts | 2 +- .../fixtures/test/browser_auth/index.ts | 11 +- .../shared/kbn-scout/src/playwright/index.ts | 6 + tsconfig.base.json | 2 + .../packages/kbn-scout-security/README.md | 201 ++++++++++++++++++ .../packages/kbn-scout-security/index.ts | 31 +++ .../kbn-scout-security/jest.config.js | 12 ++ .../packages/kbn-scout-security/kibana.jsonc | 6 + .../packages/kbn-scout-security/package.json | 6 + .../src/playwright/constants/archives.ts | 10 + .../playwright/constants/detection_rules.ts | 44 ++++ .../src/playwright/constants/index.ts | 9 + .../src/playwright/fixtures/index.ts | 10 + .../fixtures/parallel_run_fixtures.ts | 65 ++++++ .../fixtures/single_thread_fixtures.ts | 49 +++++ .../fixtures/test/browser_auth/index.ts | 84 ++++++++ .../src/playwright/fixtures/test/index.ts | 12 ++ .../page_objects/alert_details_right_panel.ts | 24 +++ .../test/page_objects/alerts_table.ts | 52 +++++ .../fixtures/test/page_objects/index.ts | 23 ++ .../src/playwright/fixtures/types.ts | 42 ++++ .../fixtures/worker/apis/detection_rule.ts | 63 ++++++ .../playwright/fixtures/worker/apis/index.ts | 9 + .../src/playwright/fixtures/worker/index.ts | 12 ++ .../worker/roles_descriptors/index.ts | 39 ++++ .../src/playwright/index.ts | 9 + .../packages/kbn-scout-security/tsconfig.json | 20 ++ .../plugins/security_solution/tsconfig.json | 4 +- .../ui_tests/parallel.playwright.config.ts | 14 ++ .../flyout/alert_details_url_sync.spec.ts | 44 ++++ .../ui_tests/parallel_tests/global_setup.ts | 18 ++ yarn.lock | 4 + 39 files changed, 944 insertions(+), 6 deletions(-) create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/README.md create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/index.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/jest.config.js create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/kibana.jsonc create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/package.json create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/archives.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/detection_rules.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/index.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/index.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/parallel_run_fixtures.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/single_thread_fixtures.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/browser_auth/index.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/index.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/alert_details_right_panel.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/alerts_table.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/index.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/types.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/apis/detection_rule.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/apis/index.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/index.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/roles_descriptors/index.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/src/playwright/index.ts create mode 100644 x-pack/solutions/security/packages/kbn-scout-security/tsconfig.json create mode 100644 x-pack/solutions/security/plugins/security_solution/ui_tests/parallel.playwright.config.ts create mode 100644 x-pack/solutions/security/plugins/security_solution/ui_tests/parallel_tests/flyout/alert_details_url_sync.spec.ts create mode 100644 x-pack/solutions/security/plugins/security_solution/ui_tests/parallel_tests/global_setup.ts diff --git a/.buildkite/scout_ci_config.yml b/.buildkite/scout_ci_config.yml index 5d9a32c9a208..c1bad5ea3181 100644 --- a/.buildkite/scout_ci_config.yml +++ b/.buildkite/scout_ci_config.yml @@ -5,4 +5,5 @@ ui_tests: - discover_enhanced - maps - observability_onboarding + - security_solution disabled: diff --git a/.buildkite/scripts/pipelines/pull_request/pipeline.ts b/.buildkite/scripts/pipelines/pull_request/pipeline.ts index e2223d61fd8a..b43aa00dd22d 100644 --- a/.buildkite/scripts/pipelines/pull_request/pipeline.ts +++ b/.buildkite/scripts/pipelines/pull_request/pipeline.ts @@ -467,6 +467,8 @@ const getPipeline = (filename: string, removeSteps = true) => { /^x-pack\/solutions\/observability\/packages\/kbn-scout-oblt/, /^x-pack\/solutions\/observability\/plugins\/apm/, /^x-pack\/solutions\/observability\/plugins\/observability_onboarding/, + /^x-pack\/solutions\/security\/packages\/kbn-scout-security/, + /^x-pack\/solutions\/security\/plugins\/security_solution/, ])) || GITHUB_PR_LABELS.includes('ci:scout-ui-tests') ) { diff --git a/.eslintrc.js b/.eslintrc.js index e4250f3506dc..ec32e13df826 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1447,6 +1447,7 @@ module.exports = { files: [ 'src/platform/packages/shared/kbn-scout/src/playwright/**/*.ts', 'x-pack/solutions/observability/packages/kbn-scout-oblt/src/playwright/**/*.ts', + 'x-pack/solutions/security/packages/kbn-scout-security/src/playwright/**/*.ts', 'src/platform/plugins/**/ui_tests/**/*.ts', 'x-pack/platform/plugins/**/ui_tests/**/*.ts', 'x-pack/solutions/**/plugins/**/ui_tests/**/*.ts', diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 29a79d0b3e87..9cb1c60555ef 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -984,6 +984,7 @@ x-pack/solutions/security/packages/features @elastic/security-threat-hunting-exp x-pack/solutions/security/packages/index-adapter @elastic/security-threat-hunting x-pack/solutions/security/packages/kbn-cloud-security-posture/graph @elastic/kibana-cloud-security-posture x-pack/solutions/security/packages/kbn-cloud-security-posture/public @elastic/kibana-cloud-security-posture +x-pack/solutions/security/packages/kbn-scout-security @elastic/appex-qa x-pack/solutions/security/packages/kbn-securitysolution-autocomplete @elastic/security-detection-engine x-pack/solutions/security/packages/kbn-securitysolution-endpoint-exceptions-common @elastic/security-detection-engine x-pack/solutions/security/packages/kbn-securitysolution-exception-list-components @elastic/security-detection-engine diff --git a/package.json b/package.json index a170897bdabf..71bfefe77617 100644 --- a/package.json +++ b/package.json @@ -1494,6 +1494,7 @@ "@kbn/scout-info": "link:src/platform/packages/private/kbn-scout-info", "@kbn/scout-oblt": "link:x-pack/solutions/observability/packages/kbn-scout-oblt", "@kbn/scout-reporting": "link:src/platform/packages/private/kbn-scout-reporting", + "@kbn/scout-security": "link:x-pack/solutions/security/packages/kbn-scout-security", "@kbn/security-api-integration-helpers": "link:x-pack/test/security_api_integration/packages/helpers", "@kbn/serverless-storybook-config": "link:src/platform/packages/shared/serverless/storybook/config", "@kbn/set-map": "link:packages/kbn-set-map", diff --git a/src/platform/packages/shared/kbn-es/src/stateful_resources/roles.yml b/src/platform/packages/shared/kbn-es/src/stateful_resources/roles.yml index 2bf66f99859d..bbb76a9d3156 100644 --- a/src/platform/packages/shared/kbn-es/src/stateful_resources/roles.yml +++ b/src/platform/packages/shared/kbn-es/src/stateful_resources/roles.yml @@ -127,5 +127,4 @@ system_indices_superuser: - application: '*' privileges: ['*'] resources: ['*'] - run_as: ['*'] - + run_as: ['*'] \ No newline at end of file diff --git a/src/platform/packages/shared/kbn-scout/index.ts b/src/platform/packages/shared/kbn-scout/index.ts index f75ab5328c8d..826ff3318f76 100644 --- a/src/platform/packages/shared/kbn-scout/index.ts +++ b/src/platform/packages/shared/kbn-scout/index.ts @@ -15,6 +15,7 @@ export { lighthouseTest, globalSetupHook, tags, + browserAuthFixture, createPlaywrightConfig, createLazyPageObject, } from './src/playwright'; @@ -24,6 +25,8 @@ export type { ScoutPage, PageObjects, ApiServicesFixture, + BrowserAuthFixture, + SamlAuth, ScoutTestFixtures, ScoutWorkerFixtures, ScoutParallelTestFixtures, @@ -43,5 +46,6 @@ export type { // re-export from Playwright export type { Locator, CDPSession } from 'playwright/test'; +export { mergeTests, test as playwrightTest } from 'playwright/test'; export { measurePerformance, measurePerformanceAsync } from './src/common'; diff --git a/src/platform/packages/shared/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts b/src/platform/packages/shared/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts index 16242494961b..e2267b07daff 100644 --- a/src/platform/packages/shared/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts +++ b/src/platform/packages/shared/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts @@ -36,7 +36,7 @@ import { perfTrackerFixture, } from './test'; import type { BrowserAuthFixture, ScoutPage, PageObjects, PerfTrackerFixture } from './test'; -export type { ScoutPage, PageObjects } from './test'; +export type { ScoutPage, PageObjects, BrowserAuthFixture } from './test'; export type { ApiServicesFixture, LighthouseAuditOptions } from './worker'; export const scoutFixtures = mergeTests( diff --git a/src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts b/src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts index 5f11c8d4892f..2d57899f7d5f 100644 --- a/src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts +++ b/src/platform/packages/shared/kbn-scout/src/playwright/fixtures/test/browser_auth/index.ts @@ -7,7 +7,7 @@ * License v3.0 only", or the "Server Side Public License, v 1". */ -import { ElasticsearchRoleDescriptor, KibanaRole, PROJECT_DEFAULT_ROLES } from '../../../../common'; +import { KibanaRole, PROJECT_DEFAULT_ROLES } from '../../../../common'; import { coreWorkerFixtures } from '../../worker'; export type LoginFunction = (role: string) => Promise; @@ -28,6 +28,12 @@ export interface BrowserAuthFixture { * @returns A Promise that resolves once the cookie in browser is set. */ loginAsPrivilegedUser: () => Promise; + /** + * Logs in as a user with a role. + * @param role - A role object that defines the Kibana and ES previleges. + * @returns A Promise that resolves once the cookie in browser is set. + */ + loginAs: (role: string) => Promise; /** * Logs in as a user with a custom role. * @param role - A role object that defines the Kibana and ES previleges. Role will re-created if it doesn't exist. @@ -62,7 +68,7 @@ export const browserAuthFixture = coreWorkerFixtures.extend<{ browserAuth: Brows await setSessionCookie(cookie); }; - const loginWithCustomRole = async (role: KibanaRole | ElasticsearchRoleDescriptor) => { + const loginWithCustomRole = async (role: KibanaRole) => { await samlAuth.setCustomRole(role); isCustomRoleCreated = true; return loginAs(samlAuth.customRoleName); @@ -82,6 +88,7 @@ export const browserAuthFixture = coreWorkerFixtures.extend<{ browserAuth: Brows loginAsAdmin, loginAsViewer, loginAsPrivilegedUser, + loginAs, loginWithCustomRole, }); diff --git a/src/platform/packages/shared/kbn-scout/src/playwright/index.ts b/src/platform/packages/shared/kbn-scout/src/playwright/index.ts index 6dd726c5ddb4..287fb0995223 100644 --- a/src/platform/packages/shared/kbn-scout/src/playwright/index.ts +++ b/src/platform/packages/shared/kbn-scout/src/playwright/index.ts @@ -25,6 +25,7 @@ export { expect } from './expect'; export type { ScoutPlaywrightOptions, ScoutTestOptions } from './types'; export type { + BrowserAuthFixture, ScoutPage, // can be extended with solution specific fixtures ScoutTestFixtures, @@ -37,5 +38,10 @@ export type { PageObjects, } from './fixtures'; +// can be extended with solution specific logic +export { browserAuthFixture } from './fixtures/test'; + +export type { SamlAuth } from './fixtures/worker'; + // use to tag tests export { tags } from './tags'; diff --git a/tsconfig.base.json b/tsconfig.base.json index 9abb2216f0a6..dc47b25f6806 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -1574,6 +1574,8 @@ "@kbn/scout-oblt/*": ["x-pack/solutions/observability/packages/kbn-scout-oblt/*"], "@kbn/scout-reporting": ["src/platform/packages/private/kbn-scout-reporting"], "@kbn/scout-reporting/*": ["src/platform/packages/private/kbn-scout-reporting/*"], + "@kbn/scout-security": ["x-pack/solutions/security/packages/kbn-scout-security"], + "@kbn/scout-security/*": ["x-pack/solutions/security/packages/kbn-scout-security/*"], "@kbn/screenshot-mode-example-plugin": ["examples/screenshot_mode_example"], "@kbn/screenshot-mode-example-plugin/*": ["examples/screenshot_mode_example/*"], "@kbn/screenshot-mode-plugin": ["src/platform/plugins/shared/screenshot_mode"], diff --git a/x-pack/solutions/security/packages/kbn-scout-security/README.md b/x-pack/solutions/security/packages/kbn-scout-security/README.md new file mode 100644 index 000000000000..6ee4e03d926b --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/README.md @@ -0,0 +1,201 @@ +# ⚠️ @kbn/scout-security IS NOT PRODUCTION READY, SO PLEASE DON'T USE YET + +`kbn/scout-security` is a test library that extends [`kbn/scout`](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-scout/README.md) with test helpers specifically designed for `Security Solution` features in Kibana. + +Its primary goal is to simplify the test development experience for teams working on `Security Solution` plugins by providing custom Playwright fixtures, page objects, and utilities tailored for Security Solution related testing scenarios. + +### Table of Contents +1. Overview +2. Folder Structure +3. Config +4. Fixtures +5. Page Objects +6. Starting Servers Onlu +7. Running Servers and Tests +8. Running Tests Separately +9. Adding A New Test +10. Adding Page Objects +11. Adding Fixtures +12. Best Practices + + +### Overview + +`kbn-scout-security` extends from `kbn-scout` framework providing the same advantages: + +- **Ease of integration:** a simplified mechanism to write and run tests closer to plugins. +- **Deployment-agnostic tests:** enables the testing of Kibana features across different environments (e.g., Stateful, Serverless). +- **Fixture-based design:** built on Playwright's fixture model to modularize and standardize test setup. +- **Focus on Developer Productivity:** faster test execution and minimal boilerplate for writing tests. + +### Folder Structure + +The `@kbn/scout-security` structure includes the following key directories and files: + +``` +x-pack/solutions/security/packages/kbn-scout-security/ +├── src/ +│ ├── playwright/ +│ │ └── constants/ +│ │ └── fixtures/ +│ │ │ └── test/ +│ │ │ │ └── // Security Solution test-scope fixtures +| | | | └── page_objects/ +| | | | └── // Security Solution pages that can be reused through the different plugins +│ │ │ └── worker/ +│ │ │ │ └── // Security Solution worker-scope fixtures +│ │ │ └── single_thread_fixtures.ts +│ │ │ └── parallel_run_fixtures.ts +│ │ │ └── index.ts +| | | └── types.ts +│ └── index.ts +├── README.mk +├── index.ts +├── jest.config.js +├── kibana.jsonc +├── package.json +├── tsconfig.json +``` + +### Config + +`playwright` directory manages the default Playwright configuration. It exports the `createPlaywrightConfig` function, which is used by Kibana plugins to define Scout playwright configurations and serves as the entry point to run tests. + +```ts +import { createPlaywrightConfig } from '@kbn/scout'; + +// eslint-disable-next-line import/no-default-export +export default createPlaywrightConfig({ + testDir: './tests', + workers: 2, +}); +``` + +Scout relies on configuration to determine the test files and opt-in [parallel test execution](https://playwright.dev/docs/test-parallel) against the single Elastic cluster. + +The Playwright configuration should only be created this way to ensure compatibility with Scout functionality. Note that config files should be used inside the plugin we want to test. + +### Fixtures + +The `fixtures` directory contains core Security Scout capabilities required for testing the majority of Security Solution functionalities. [Fixtures](https://playwright.dev/docs/test-fixtures) can be scoped to either `test` or `worker`. Scope decides when to init a new fixture instance: once per worker or for every test function. It is important to choose the correct scope to keep test execution optimally fast: if **a new instance is not needed for every test**, the fixture should be scoped to **worker**. Otherwise, it should be scoped to **test**. + +**Security Solution `worker` scoped fixtures:** +- `detectionRuleApi` + +```ts + test.beforeAll(async ({ detectionRuleApi }) => { + await detectionRuleApi.createCustomQueryRule(CUSTOM_QUERY_RULE); + }); +``` + +**Security Solution `test` scoped fixtures:** +- `browserAuth` +- `pageObjects` + +```ts + test.beforeEach(async ({ browserAuth }) => { + await browserAuth.loginAsPlatformEngineer(); + }); +``` + +If a new fixture depends on a fixture with a `test` scope, it must also be `test` scoped. + +### Page Objects + +The `page_objects` directory contains all the Page Objects that represent Security Solution core functionality that can be reused through different Security Solution plugins. + +If a Page Object is likely to be used in more than one plugin, it should be added here. This allows other teams to reuse it, improving collaboration across teams, reducing code duplication, and simplifying support and adoption. + +If a Page Object can be used outside Security Solution, it should be created in `@kbn-scout`. + +Page Objects must be registered with the `createLazyPageObject` function, which guarantees its instance is lazy-initialized. This way, we can have all the page objects available in the test context, but only the ones that are called will be actually initialized: + +```ts +export function extendPageObjects(pageObjects: PageObjects, page: ScoutPage): SecurityPageObjects { + return { + ...pageObjects, + alertsTablePage: createLazyPageObject(AlertsTablePage, page), + alertDetailsRightPanelPage: createLazyPageObject(AlertDetailsRightPanelPage, page), + }; +} +``` + +All registered Page Objects are available via the `pageObjects` fixture: + +```ts +test.beforeEach(async ({ pageObjects }) => { + await pageObjects.alertsTablePage.navigate(); +}); +``` + +### Starting Servers Only + +To start the servers without running tests, use the following command: + +```bash +node scripts/scout.js start-server [--stateful|--serverless=security] +``` + +This is useful for manual testing or running tests via an IDE. + +### Running Servers and Tests + +To start the servers and run tests, use: + +```bash +node scripts/scout.js run-tests [--stateful|--serverless=security] --config /ui_tests/[playwright.config.ts|parallel.playwright.config.ts] +``` + +This command starts the required servers and then automatically executes the tests using Playwright. + +### Running Tests Separately + +If the servers are already running, you can execute tests independently using either: + +- Playwright Plugin in IDE: Run tests directly within your IDE using Playwright's integration. +- Command Line: Use the following command to run tests: + +```bash +npx playwright test --config /ui_tests/[playwright.config.ts|parallel.playwright.config.ts] --project local +``` + +We use `project` flag to define test target, where tests to be run: local servers or Elastic Cloud. Currently we only support local servers. + +### Adding A New Test +Any new test should be added in the `x-pack/solutions/security/plugins/security_solution/ui_tests` folder. + +You have an example in: `x-pack/solutions/security/plugins/security_solution/ui_tests/parallel_tests/flyout/alert_details_url_sync.spec.ts` + +### Adding Page Objects +1. **Create a New Page Object:** Add your Page Object to the src/playwright/fixtures/test/page_objects directory. For instance: + +```ts +export class NewPage { + constructor(private readonly page: ScoutPage) {} + + // implementation +} +``` +2. **Register the Page Object:** Update the index file to include the new Page Object: +```ts +export function createCorePageObjects(page: ScoutPage): PageObjects { + return { + ... + newPage: createLazyPageObject(NewPage, page), + }; +} +``` + +### Adding Fixtures +1. **Determine Fixture Scope:** Decide if your fixture should apply to the `test` (per-test) or `worker` (per-worker) scope. + +2. **Implement the Fixture:** Add the implementation to `src/playwright/fixtures/test` or `src/playwright/fixtures/worker`. + +You can use the existing fixtures as a guide. + +3. **Register the Fixture:** Add the fixture to the appropriate scope in `src/playwright/fixtures/parallel_run_fixtures.ts` and/or ``src/playwright/fixtures/single_thread_fixture.ts`` + +### Best Practices +- **Reusable Code:** When creating Page Objects or Fixtures that apply to more than one plugin, ensure they are added to the kbn-scout package. +- **Adhere to Existing Structure:** Maintain consistency with the project's architecture. +- **Playwright documentation:** [Official best practices](https://playwright.dev/docs/best-practices) diff --git a/x-pack/solutions/security/packages/kbn-scout-security/index.ts b/x-pack/solutions/security/packages/kbn-scout-security/index.ts new file mode 100644 index 000000000000..8fb5403d6490 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/index.ts @@ -0,0 +1,31 @@ +/* + * 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 { test, spaceTest } from './src/playwright'; + +// re-export from @kbn/scout +export { + expect, + tags, + createPlaywrightConfig, + createLazyPageObject, + globalSetupHook, +} from '@kbn/scout'; + +export type { + EsClient, + KbnClient, + KibanaUrl, + ScoutLogger, + ScoutPage, + PageObjects, + ScoutServerConfig, + ScoutTestConfig, + ScoutPlaywrightOptions, + ScoutTestOptions, + Locator, +} from '@kbn/scout'; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/jest.config.js b/x-pack/solutions/security/packages/kbn-scout-security/jest.config.js new file mode 100644 index 000000000000..0028d86dd0d7 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/jest.config.js @@ -0,0 +1,12 @@ +/* + * 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. + */ + +module.exports = { + preset: '@kbn/test/jest_node', + rootDir: '../../../../..', + roots: ['/x-pack/solutions/security/packages/kbn-scout-security'], +}; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/kibana.jsonc b/x-pack/solutions/security/packages/kbn-scout-security/kibana.jsonc new file mode 100644 index 000000000000..1c41bc4357ca --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/kibana.jsonc @@ -0,0 +1,6 @@ +{ + "type": "test-helper", + "id": "@kbn/scout-security", + "owner": "@elastic/appex-qa", + "devOnly": true +} diff --git a/x-pack/solutions/security/packages/kbn-scout-security/package.json b/x-pack/solutions/security/packages/kbn-scout-security/package.json new file mode 100644 index 000000000000..70d0e26d30c7 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/package.json @@ -0,0 +1,6 @@ +{ + "name": "@kbn/scout-security", + "private": true, + "version": "1.0.0", + "license": "Elastic License 2.0" +} \ No newline at end of file diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/archives.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/archives.ts new file mode 100644 index 000000000000..435ef5fba478 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/archives.ts @@ -0,0 +1,10 @@ +/* + * 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 ES = { + AUDITBEAT: 'x-pack/test/security_solution_cypress/es_archives/auditbeat_single', +}; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/detection_rules.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/detection_rules.ts new file mode 100644 index 000000000000..1aa96a51ca70 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/detection_rules.ts @@ -0,0 +1,44 @@ +/* + * 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 interface CustomQueryRule { + index: string[]; + enabled: boolean; + name: string; + description: string; + risk_score: number; + rule_id: string; + severity: 'low' | 'medium' | 'high' | 'critical'; + type: 'query'; + query: string; + from: string; +} + +export const DEFAULT_SECURITY_SOLUTION_INDEXES = [ + 'apm-*-transaction*', + 'auditbeat-*', + 'endgame-*', + 'filebeat-*', + 'logs-*', + 'packetbeat-*', + 'traces-apm*', + 'winlogbeat-*', + '-*elastic-cloud-logs-*', +]; + +export const CUSTOM_QUERY_RULE: CustomQueryRule = { + index: DEFAULT_SECURITY_SOLUTION_INDEXES, + enabled: true, + name: 'Alert Testing Query', + description: 'Tests a simple query', + risk_score: 1, + rule_id: 'rule-1', + severity: 'high', + type: 'query', + query: '*:*', + from: '2019-01-01T00:00:00.000Z', +}; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/index.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/index.ts new file mode 100644 index 000000000000..2e91a6d46340 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/constants/index.ts @@ -0,0 +1,9 @@ +/* + * 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 * as archives from './archives'; +export * as detection_rules from './detection_rules'; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/index.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/index.ts new file mode 100644 index 000000000000..b05e86d128a2 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/index.ts @@ -0,0 +1,10 @@ +/* + * 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 { test } from './single_thread_fixtures'; +export { spaceTest } from './parallel_run_fixtures'; +export * from './types'; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/parallel_run_fixtures.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/parallel_run_fixtures.ts new file mode 100644 index 000000000000..f5108a2bc959 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/parallel_run_fixtures.ts @@ -0,0 +1,65 @@ +/* + * 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 { spaceTest as baseTest, mergeTests, ApiServicesFixture } from '@kbn/scout'; +import { + SecurityApiServicesFixture, + SecurityParallelTestFixtures, + SecurityParallelWorkerFixtures, +} from './types'; +import { getDetectionRuleApiService } from './worker'; +import { extendPageObjects, securityBrowserAuthFixture } from './test'; + +const securityParallelFixtures = mergeTests(baseTest, securityBrowserAuthFixture); + +/** + * Should be used test spec files, running in parallel in isolated spaces agaist the same Kibana instance. + */ +export const spaceTest = securityParallelFixtures.extend< + SecurityParallelTestFixtures, + SecurityParallelWorkerFixtures +>({ + pageObjects: async ( + { + pageObjects, + page, + }: { + pageObjects: SecurityParallelTestFixtures['pageObjects']; + page: SecurityParallelTestFixtures['page']; + }, + use: (pageObjects: SecurityParallelTestFixtures['pageObjects']) => Promise + ) => { + const extendedPageObjects = extendPageObjects(pageObjects, page); + await use(extendedPageObjects); + }, + apiServices: [ + async ( + { + apiServices, + kbnClient, + log, + scoutSpace, + }: { + apiServices: ApiServicesFixture; + kbnClient: SecurityParallelWorkerFixtures['kbnClient']; + log: SecurityParallelWorkerFixtures['log']; + scoutSpace: SecurityParallelWorkerFixtures['scoutSpace']; + }, + use: (extendedApiServices: SecurityApiServicesFixture) => Promise + ) => { + const extendedApiServices = apiServices as SecurityApiServicesFixture; + extendedApiServices.detectionRule = getDetectionRuleApiService({ + kbnClient, + log, + scoutSpace, + }); + + await use(extendedApiServices); + }, + { scope: 'worker' }, + ], +}); diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/single_thread_fixtures.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/single_thread_fixtures.ts new file mode 100644 index 000000000000..62a6c7b23f7a --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/single_thread_fixtures.ts @@ -0,0 +1,49 @@ +/* + * 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 { test as baseTest, mergeTests, ApiServicesFixture } from '@kbn/scout'; +import { SecurityApiServicesFixture, SecurityTestFixtures, SecurityWorkerFixtures } from './types'; +import { getDetectionRuleApiService } from './worker'; +import { extendPageObjects, securityBrowserAuthFixture } from './test'; + +const securityFixtures = mergeTests(baseTest, securityBrowserAuthFixture); + +export const test = securityFixtures.extend({ + pageObjects: async ( + { + pageObjects, + page, + }: { pageObjects: SecurityTestFixtures['pageObjects']; page: SecurityTestFixtures['page'] }, + use: (pageObjects: SecurityTestFixtures['pageObjects']) => Promise + ) => { + const extendedPageObjects = extendPageObjects(pageObjects, page); + await use(extendedPageObjects); + }, + apiServices: [ + async ( + { + apiServices, + kbnClient, + log, + }: { + apiServices: ApiServicesFixture; + kbnClient: SecurityWorkerFixtures['kbnClient']; + log: SecurityWorkerFixtures['log']; + }, + use: (extendedApiServices: SecurityApiServicesFixture) => Promise + ) => { + const extendedApiServices = apiServices as SecurityApiServicesFixture; + extendedApiServices.detectionRule = getDetectionRuleApiService({ + kbnClient, + log, + }); + + await use(extendedApiServices); + }, + { scope: 'worker' }, + ], +}); diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/browser_auth/index.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/browser_auth/index.ts new file mode 100644 index 000000000000..cd5f41519cbe --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/browser_auth/index.ts @@ -0,0 +1,84 @@ +/* + * 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 { browserAuthFixture, mergeTests } from '@kbn/scout'; +import type { + ElasticsearchRoleDescriptor, + KibanaRole, + ScoutTestConfig, + BrowserAuthFixture, + SamlAuth, + ScoutLogger, + EsClient, +} from '@kbn/scout'; +import { roleDescriptorsFixture, RoleDescriptorsFixture } from '../../worker'; + +export interface SecurityBrowserAuthFixture extends BrowserAuthFixture { + loginAsPlatformEngineer: () => Promise; +} + +export const securityBrowserAuthFixture = mergeTests( + browserAuthFixture, + roleDescriptorsFixture +).extend<{ + browserAuth: SecurityBrowserAuthFixture; +}>({ + browserAuth: async ( + { + browserAuth, + config, + esClient, + roleDescriptors, + samlAuth, + log, + }: { + browserAuth: BrowserAuthFixture; + config: ScoutTestConfig; + esClient: EsClient; + roleDescriptors: RoleDescriptorsFixture; + samlAuth: SamlAuth; + log: ScoutLogger; + }, + use: (extendedBrowserAuth: SecurityBrowserAuthFixture) => Promise + ) => { + let isCustomRoleCreated = false; + + // explicitly overriding to update 'isCustomRoleCreated' flag and pass descriptor to the login method + const loginWithCustomRole = async (role: KibanaRole | ElasticsearchRoleDescriptor) => { + await samlAuth.setCustomRole(role); + isCustomRoleCreated = true; + return browserAuth.loginAs(samlAuth.customRoleName); + }; + + const loginAsPlatformEngineer = async () => { + const roleName = 'platform_engineer'; + if (!config.serverless) { + const roleDesciptor = roleDescriptors.serverless?.get( + roleName + ) as ElasticsearchRoleDescriptor; + if (!roleDesciptor) { + throw new Error(`No role descriptors found for ${roleName}`); + } + log.debug(`Using "${roleName}" role to execute the test`); + return loginWithCustomRole(roleDesciptor); + } else { + return browserAuth.loginAs(roleName); + } + }; + + await use({ + ...browserAuth, + loginWithCustomRole, + loginAsPlatformEngineer, + }); + + if (isCustomRoleCreated) { + log.debug(`Deleting custom role with name ${samlAuth.customRoleName}`); + await esClient.security.deleteRole({ name: samlAuth.customRoleName }); + } + }, +}); diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/index.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/index.ts new file mode 100644 index 000000000000..777f7ec2a3af --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/index.ts @@ -0,0 +1,12 @@ +/* + * 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 { securityBrowserAuthFixture } from './browser_auth'; +export type { SecurityBrowserAuthFixture } from './browser_auth'; + +export { extendPageObjects } from './page_objects'; +export type { SecurityPageObjects } from './page_objects'; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/alert_details_right_panel.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/alert_details_right_panel.ts new file mode 100644 index 000000000000..47baf58a3b71 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/alert_details_right_panel.ts @@ -0,0 +1,24 @@ +/* + * 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 { ScoutPage, Locator } from '@kbn/scout'; + +export class AlertDetailsRightPanelPage { + public detailsFlyoutCloseIcon: Locator; + public detailsFlyoutHeaderTitle: Locator; + + constructor(private readonly page: ScoutPage) { + this.detailsFlyoutHeaderTitle = this.page.testSubj.locator( + 'securitySolutionFlyoutAlertTitleText' + ); + this.detailsFlyoutCloseIcon = this.page.testSubj.locator('euiFlyoutCloseButton'); + } + + async closeFlyout() { + await this.detailsFlyoutCloseIcon.click(); + } +} diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/alerts_table.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/alerts_table.ts new file mode 100644 index 000000000000..e07c45445028 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/alerts_table.ts @@ -0,0 +1,52 @@ +/* + * 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 { ScoutPage, Locator } from '@kbn/scout'; + +const PAGE_URL = 'security/alerts'; +const EXPAND_EVENT = 'expand-event'; + +export class AlertsTablePage { + public expandAlertBtn: Locator; + + constructor(private readonly page: ScoutPage) { + this.expandAlertBtn = this.page.testSubj.locator(EXPAND_EVENT); + } + + async navigate() { + await this.page.gotoApp(PAGE_URL); + } + + async expandFirstAlertDetailsFlyout() { + const maxAttempts = 100; + let attempts = 0; + + while ((await this.expandAlertBtn.count()) === 0) { + if (attempts >= maxAttempts) { + throw new Error('Timed out waiting for alert buttons to appear'); + } + await this.page.waitForTimeout(100); + attempts++; + } + const buttons = await this.expandAlertBtn.all(); + + if (buttons.length > 0) { + await buttons[0].click(); + } else { + throw new Error('No expand alert details buttons found'); + } + } + + async getCurrentUrl() { + const url = this.page.url(); + return url; + } + + async reload() { + return this.page.reload(); + } +} diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/index.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/index.ts new file mode 100644 index 000000000000..a4a4767f3d30 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/test/page_objects/index.ts @@ -0,0 +1,23 @@ +/* + * 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 { PageObjects, ScoutPage, createLazyPageObject } from '@kbn/scout'; +import { AlertsTablePage } from './alerts_table'; +import { AlertDetailsRightPanelPage } from './alert_details_right_panel'; + +export interface SecurityPageObjects extends PageObjects { + alertsTablePage: AlertsTablePage; + alertDetailsRightPanelPage: AlertDetailsRightPanelPage; +} + +export function extendPageObjects(pageObjects: PageObjects, page: ScoutPage): SecurityPageObjects { + return { + ...pageObjects, + alertsTablePage: createLazyPageObject(AlertsTablePage, page), + alertDetailsRightPanelPage: createLazyPageObject(AlertDetailsRightPanelPage, page), + }; +} diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/types.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/types.ts new file mode 100644 index 000000000000..71deb3c78285 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/types.ts @@ -0,0 +1,42 @@ +/* + * 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 { + ApiServicesFixture, + ScoutParallelTestFixtures, + ScoutParallelWorkerFixtures, + ScoutTestFixtures, + ScoutWorkerFixtures, +} from '@kbn/scout'; +import { SecurityPageObjects, SecurityBrowserAuthFixture } from './test'; +import { DetectionRuleApiService } from './worker'; + +export interface SecurityApiServicesFixture extends ApiServicesFixture { + detectionRule: DetectionRuleApiService; +} + +export interface SecurityTestFixtures extends ScoutTestFixtures { + browserAuth: SecurityBrowserAuthFixture; + pageObjects: SecurityPageObjects; +} + +export interface SecurityWorkerFixtures extends ScoutWorkerFixtures { + apiServices: SecurityApiServicesFixture; +} + +export interface SecurityParallelTestFixtures extends ScoutParallelTestFixtures { + browserAuth: SecurityBrowserAuthFixture; + pageObjects: SecurityPageObjects; +} + +export interface SecurityParallelApiServicesFixture extends ApiServicesFixture { + detectionRule: DetectionRuleApiService; +} + +export interface SecurityParallelWorkerFixtures extends ScoutParallelWorkerFixtures { + apiServices: SecurityApiServicesFixture; +} diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/apis/detection_rule.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/apis/detection_rule.ts new file mode 100644 index 000000000000..7ebcd9490255 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/apis/detection_rule.ts @@ -0,0 +1,63 @@ +/* + * 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 { + KbnClient, + measurePerformanceAsync, + ScoutLogger, + ScoutParallelWorkerFixtures, +} from '@kbn/scout'; +import { CUSTOM_QUERY_RULE, CustomQueryRule } from '../../../constants/detection_rules'; + +const DETECTION_ENGINE_RULES_URL = '/api/detection_engine/rules'; +const DETECTION_ENGINE_RULES_BULK_ACTION = '/api/detection_engine/rules/_bulk_action'; + +export interface DetectionRuleApiService { + createCustomQueryRule: (body: CustomQueryRule) => Promise; + deleteAll: () => Promise; +} + +export const getDetectionRuleApiService = ({ + kbnClient, + log, + scoutSpace, +}: { + kbnClient: KbnClient; + log: ScoutLogger; + scoutSpace?: ScoutParallelWorkerFixtures['scoutSpace']; +}): DetectionRuleApiService => { + const basePath = scoutSpace?.id ? `/s/${scoutSpace?.id}` : ''; + + return { + createCustomQueryRule: async (body = CUSTOM_QUERY_RULE) => { + await measurePerformanceAsync( + log, + 'security.detectionRule.createCustomQueryRule', + async () => { + await kbnClient.request({ + method: 'POST', + path: `${basePath}${DETECTION_ENGINE_RULES_URL}`, + body, + }); + } + ); + }, + + deleteAll: async () => { + await measurePerformanceAsync(log, 'security.detectionRule.deleteAll', async () => { + await kbnClient.request({ + method: 'POST', + path: `${basePath}${DETECTION_ENGINE_RULES_BULK_ACTION}`, + body: { + query: '', + action: 'delete', + }, + }); + }); + }, + }; +}; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/apis/index.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/apis/index.ts new file mode 100644 index 000000000000..79ddea5f1d7c --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/apis/index.ts @@ -0,0 +1,9 @@ +/* + * 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 { getDetectionRuleApiService } from './detection_rule'; +export type { DetectionRuleApiService } from './detection_rule'; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/index.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/index.ts new file mode 100644 index 000000000000..2d8930f6e311 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/index.ts @@ -0,0 +1,12 @@ +/* + * 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 { roleDescriptorsFixture } from './roles_descriptors'; +export type { RoleDescriptorsFixture } from './roles_descriptors'; + +export { getDetectionRuleApiService } from './apis'; +export type { DetectionRuleApiService } from './apis'; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/roles_descriptors/index.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/roles_descriptors/index.ts new file mode 100644 index 000000000000..6cd37f4c2a86 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/fixtures/worker/roles_descriptors/index.ts @@ -0,0 +1,39 @@ +/* + * 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 { readRolesDescriptorsFromResource, SERVERLESS_ROLES_ROOT_PATH } from '@kbn/es'; +import { ElasticsearchRoleDescriptor, ScoutLogger, playwrightTest as base } from '@kbn/scout'; + +export interface RoleDescriptorsFixture { + serverless: Map; +} + +/** + * Fixture that provides the role descriptors for the serverless prebuilt roles. + * Using worker scope to avoid reading the file for each test. + */ +export const roleDescriptorsFixture = base.extend< + {}, + { roleDescriptors: RoleDescriptorsFixture; log: ScoutLogger } +>({ + roleDescriptors: [ + ({ log }, use) => { + const resourcePath = `${SERVERLESS_ROLES_ROOT_PATH}/security/roles.yml`; + const serverless = new Map( + Object.entries( + readRolesDescriptorsFromResource(resourcePath) as Record< + string, + ElasticsearchRoleDescriptor + > + ) + ); + log.serviceLoaded('roleDescriptors'); + use({ serverless }); + }, + { scope: 'worker' }, + ], +}); diff --git a/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/index.ts b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/index.ts new file mode 100644 index 000000000000..d6a2ae06b78b --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/src/playwright/index.ts @@ -0,0 +1,9 @@ +/* + * 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 * from './fixtures'; +export type { SecurityPageObjects } from './fixtures/test/page_objects'; diff --git a/x-pack/solutions/security/packages/kbn-scout-security/tsconfig.json b/x-pack/solutions/security/packages/kbn-scout-security/tsconfig.json new file mode 100644 index 000000000000..eafbcd250577 --- /dev/null +++ b/x-pack/solutions/security/packages/kbn-scout-security/tsconfig.json @@ -0,0 +1,20 @@ +{ + "extends": "../../../../../tsconfig.base.json", + "compilerOptions": { + "outDir": "target/types", + "types": [ + "jest", + "node" + ] + }, + "include": [ + "**/*.ts", + ], + "exclude": [ + "target/**/*", + ], + "kbn_references": [ + "@kbn/scout", + "@kbn/es", + ] +} diff --git a/x-pack/solutions/security/plugins/security_solution/tsconfig.json b/x-pack/solutions/security/plugins/security_solution/tsconfig.json index a36a0a022f26..48ad69d719e0 100644 --- a/x-pack/solutions/security/plugins/security_solution/tsconfig.json +++ b/x-pack/solutions/security/plugins/security_solution/tsconfig.json @@ -8,6 +8,7 @@ "public/**/*", "server/**/*", "scripts/**/*", + "ui_tests/**/*", // have to declare *.json explicitly due to https://github.com/microsoft/TypeScript/issues/25636 "common/**/*.json", "server/**/*.json", @@ -237,6 +238,7 @@ "@kbn/charts-theme", "@kbn/product-doc-base-plugin", "@kbn/shared-ux-error-boundary", - "@kbn/security-ai-prompts" + "@kbn/security-ai-prompts", + "@kbn/scout-security", ] } diff --git a/x-pack/solutions/security/plugins/security_solution/ui_tests/parallel.playwright.config.ts b/x-pack/solutions/security/plugins/security_solution/ui_tests/parallel.playwright.config.ts new file mode 100644 index 000000000000..acda7de0e477 --- /dev/null +++ b/x-pack/solutions/security/plugins/security_solution/ui_tests/parallel.playwright.config.ts @@ -0,0 +1,14 @@ +/* + * 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 { createPlaywrightConfig } from '@kbn/scout-security'; + +// eslint-disable-next-line import/no-default-export +export default createPlaywrightConfig({ + testDir: './parallel_tests/', + workers: 2, +}); diff --git a/x-pack/solutions/security/plugins/security_solution/ui_tests/parallel_tests/flyout/alert_details_url_sync.spec.ts b/x-pack/solutions/security/plugins/security_solution/ui_tests/parallel_tests/flyout/alert_details_url_sync.spec.ts new file mode 100644 index 000000000000..e67e7986374e --- /dev/null +++ b/x-pack/solutions/security/plugins/security_solution/ui_tests/parallel_tests/flyout/alert_details_url_sync.spec.ts @@ -0,0 +1,44 @@ +/* + * 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 { expect, spaceTest } from '@kbn/scout-security'; +import { CUSTOM_QUERY_RULE } from '@kbn/scout-security/src/playwright/constants/detection_rules'; + +const RIGHT = 'right'; + +spaceTest.describe('Expandable flyout state sync', { tag: ['@ess', '@svlSecurity '] }, () => { + spaceTest.beforeEach(async ({ browserAuth, apiServices }) => { + await apiServices.detectionRule.deleteAll(); + await apiServices.detectionRule.createCustomQueryRule(CUSTOM_QUERY_RULE); + await browserAuth.loginAsPlatformEngineer(); + }); + + spaceTest('should test flyout url sync', async ({ pageObjects }) => { + await pageObjects.alertsTablePage.navigate(); + + const urlBeforeAlertDetails = await pageObjects.alertsTablePage.getCurrentUrl(); + expect(urlBeforeAlertDetails).not.toContain(RIGHT); + + await pageObjects.alertsTablePage.expandFirstAlertDetailsFlyout(); + + const urlAfterAlertDetails = await pageObjects.alertsTablePage.getCurrentUrl(); + expect(urlAfterAlertDetails).toContain(RIGHT); + + const headerTitle = pageObjects.alertDetailsRightPanelPage.detailsFlyoutHeaderTitle; + await expect(headerTitle).toHaveText(CUSTOM_QUERY_RULE.name); + + await pageObjects.alertsTablePage.reload(); + + const urlAfterReload = await pageObjects.alertsTablePage.getCurrentUrl(); + expect(urlAfterReload).toContain(RIGHT); + + await pageObjects.alertDetailsRightPanelPage.closeFlyout(); + + const urlAfterClosingFlyout = await pageObjects.alertsTablePage.getCurrentUrl(); + expect(urlAfterClosingFlyout).not.toContain(RIGHT); + }); +}); diff --git a/x-pack/solutions/security/plugins/security_solution/ui_tests/parallel_tests/global_setup.ts b/x-pack/solutions/security/plugins/security_solution/ui_tests/parallel_tests/global_setup.ts new file mode 100644 index 000000000000..3f01f8b71dc9 --- /dev/null +++ b/x-pack/solutions/security/plugins/security_solution/ui_tests/parallel_tests/global_setup.ts @@ -0,0 +1,18 @@ +/* + * 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 { globalSetupHook } from '@kbn/scout-security'; +import { archives } from '@kbn/scout-security/src/playwright/constants'; + +globalSetupHook('Ingest archives to Elasticsearch', async ({ esArchiver, log }) => { + const archivesToIngest = [archives.ES.AUDITBEAT]; + + log.debug('[setup] loading archives test data (only if indexes do not exist)...'); + for (const archive of archivesToIngest) { + await esArchiver.loadIfNeeded(archive); + } +}); diff --git a/yarn.lock b/yarn.lock index a1636164ed00..bb5d486a6d9d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6798,6 +6798,10 @@ version "0.0.0" uid "" +"@kbn/scout-security@link:x-pack/solutions/security/packages/kbn-scout-security": + version "0.0.0" + uid "" + "@kbn/scout@link:src/platform/packages/shared/kbn-scout": version "0.0.0" uid ""