[9.0] initial @kbn/scout-security plugin (#210433)

.buildkite/scout_ci_config.yml

@@ -5,4 +5,5 @@ ui_tests:
     - discover_enhanced
     - maps
     - observability_onboarding
+    - security_solution
   disabled:

.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')
     ) {

.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',

.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

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",

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: ['*']

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';

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(

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<void>;
@@ -28,6 +28,12 @@ export interface BrowserAuthFixture {
    * @returns A Promise that resolves once the cookie in browser is set.
    */
   loginAsPrivilegedUser: () => Promise<void>;
+  /**
+   * 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<void>;
   /**
    * 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,
     });
 

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';

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"],

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 <plugin-path>/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 <plugin-path>/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)

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';

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: ['<rootDir>/x-pack/solutions/security/packages/kbn-scout-security'],
+};