[9.0] [scout] adding test helper `@kbn/scout-oblt` package and uptate onboarding tests (#209761)

.buildkite/scripts/steps/functional/scout_ui_tests.sh

@@ -33,7 +33,9 @@ done
 
 # Observability Onboarding
 for run_mode in "--stateful" "--serverless=oblt"; do
-  run_tests "Observability Onboarding" "x-pack/solutions/observability/plugins/observability_onboarding/ui_tests/playwright.config.ts" "$run_mode"
+  run_tests "Observability Onboarding: Parallel Workers" "x-pack/solutions/observability/plugins/observability_onboarding/ui_tests/parallel.playwright.config.ts" "$run_mode"
+  # Disabled while we don't have any tests under the config
+  # run_tests "Observability Onboarding" "x-pack/solutions/observability/plugins/observability_onboarding/ui_tests/playwright.config.ts" "$run_mode"
 done
 
 

.github/CODEOWNERS

@@ -918,6 +918,7 @@ x-pack/solutions/observability/packages/get_padded_alert_time_range_util @elasti
 x-pack/solutions/observability/packages/kbn-alerts-grouping @elastic/response-ops
 x-pack/solutions/observability/packages/kbn-custom-integrations @elastic/obs-ux-logs-team
 x-pack/solutions/observability/packages/kbn-investigation-shared @elastic/obs-ux-management-team
+x-pack/solutions/observability/packages/kbn-scout-oblt @elastic/appex-qa
 x-pack/solutions/observability/packages/kbn-streams-schema @elastic/streams-program-team
 x-pack/solutions/observability/packages/observability_ai/observability_ai_common @elastic/obs-ai-assistant
 x-pack/solutions/observability/packages/observability_ai/observability_ai_server @elastic/obs-ai-assistant

package.json

@@ -1488,6 +1488,7 @@
     "@kbn/reporting-mocks-server": "link:src/platform/packages/private/kbn-reporting/mocks_server",
     "@kbn/scout": "link:packages/kbn-scout",
     "@kbn/scout-info": "link:packages/kbn-scout-info",
+    "@kbn/scout-oblt": "link:x-pack/solutions/observability/packages/kbn-scout-oblt",
     "@kbn/scout-reporting": "link:packages/kbn-scout-reporting",
     "@kbn/security-api-integration-helpers": "link:x-pack/test/security_api_integration/packages/helpers",
     "@kbn/serverless-storybook-config": "link:packages/serverless/storybook/config",

packages/kbn-scout/index.ts

@@ -36,3 +36,8 @@ export type {
   ScoutServerConfig,
   ScoutTestConfig,
 } from './src/types';
+
+// re-export from Playwright
+export type { Locator } from 'playwright/test';
+
+export { measurePerformance, measurePerformanceAsync } from './src/common';

packages/kbn-scout/src/playwright/fixtures/parallel_run_fixtures.ts

@@ -8,8 +8,9 @@
  */
 
 import { mergeTests } from 'playwright/test';
-import { coreWorkerFixtures, scoutSpaceParallelFixture } from './worker';
+import { apiFixtures, coreWorkerFixtures, scoutSpaceParallelFixture } from './worker';
 import type {
+  ApiParallelWorkerFixtures,
   EsClient,
   KbnClient,
   KibanaUrl,
@@ -29,6 +30,7 @@ export const scoutParallelFixtures = mergeTests(
   // worker scope fixtures
   coreWorkerFixtures,
   scoutSpaceParallelFixture,
+  apiFixtures,
   // test scope fixtures
   browserAuthFixture,
   scoutPageParallelFixture,
@@ -42,7 +44,7 @@ export interface ScoutParallelTestFixtures {
   pageObjects: PageObjects;
 }
 
-export interface ScoutParallelWorkerFixtures {
+export interface ScoutParallelWorkerFixtures extends ApiParallelWorkerFixtures {
   log: ScoutLogger;
   config: ScoutTestConfig;
   kbnUrl: KibanaUrl;

packages/kbn-scout/src/playwright/fixtures/single_thread_fixtures.ts

@@ -8,7 +8,13 @@
  */
 
 import { mergeTests } from 'playwright/test';
-import { coreWorkerFixtures, esArchiverFixture, uiSettingsFixture } from './worker';
+import {
+  ApiFixtures,
+  apiFixtures,
+  coreWorkerFixtures,
+  esArchiverFixture,
+  uiSettingsFixture,
+} from './worker';
 import type {
   EsArchiverFixture,
   EsClient,
@@ -34,6 +40,8 @@ export const scoutFixtures = mergeTests(
   coreWorkerFixtures,
   esArchiverFixture,
   uiSettingsFixture,
+  // api fixtures
+  apiFixtures,
   // test scope fixtures
   browserAuthFixture,
   scoutPageFixture,
@@ -47,7 +55,7 @@ export interface ScoutTestFixtures {
   pageObjects: PageObjects;
 }
 
-export interface ScoutWorkerFixtures {
+export interface ScoutWorkerFixtures extends ApiFixtures {
   log: ScoutLogger;
   config: ScoutTestConfig;
   kbnUrl: KibanaUrl;

packages/kbn-scout/src/playwright/fixtures/test/scout_page/index.ts

@@ -8,6 +8,7 @@
  */
 
 import { Page } from '@playwright/test';
+import { PathOptions } from '../../../../common/services/kibana_url';
 
 /**
  * Extends the Playwright 'Page' interface with methods specific to Kibana.
@@ -24,7 +25,7 @@ export type ScoutPage = Page & {
    * @param options - Additional navigation options, passed directly to Playwright's `goto` method.
    * @returns A Promise resolving to a Playwright `Response` or `null`.
    */
-  gotoApp: (appName: string, options?: Parameters<Page['goto']>[1]) => ReturnType<Page['goto']>;
+  gotoApp: (appName: string, pathOptions?: PathOptions) => ReturnType<Page['goto']>;
   /**
    * Waits for the Kibana loading spinner indicator to disappear.
    * @returns A Promise resolving when the indicator is hidden.

packages/kbn-scout/src/playwright/fixtures/test/scout_page/parallel.ts

@@ -8,6 +8,7 @@
  */
 
 import { Page, test as base } from '@playwright/test';
+import { PathOptions } from '../../../../common/services/kibana_url';
 import { ScoutPage } from '.';
 import { KibanaUrl, ScoutLogger } from '../../worker';
 import { ScoutSpaceParallelFixture } from '../../worker/scout_space';
@@ -29,8 +30,8 @@ export const scoutPageParallelFixture = base.extend<
     const extendedPage = extendPlaywrightPage({ page, kbnUrl });
 
     // Overriding navigation to specific Kibana apps: url should respect the Kibana Space id
-    extendedPage.gotoApp = (appName: string) =>
-      page.goto(kbnUrl.app(appName, { space: scoutSpace.id }));
+    extendedPage.gotoApp = (appName: string, pathOptions?: PathOptions) =>
+      page.goto(kbnUrl.app(appName, { space: scoutSpace.id, pathOptions }));
 
     log.serviceLoaded(`scoutPage:${scoutSpace.id}`);
     await use(extendedPage);

packages/kbn-scout/src/playwright/fixtures/test/scout_page/single_thread.ts

@@ -9,6 +9,7 @@
 
 import { Page } from '@playwright/test';
 import { subj } from '@kbn/test-subj-selector';
+import { PathOptions } from '../../../../common/services/kibana_url';
 import { KibanaUrl, ScoutLogger, coreWorkerFixtures } from '../../worker';
 import { ScoutPage } from '.';
 
@@ -81,7 +82,8 @@ export function extendPlaywrightPage({
   // Extend page with '@kbn/test-subj-selector' support
   extendedPage.testSubj = extendPageWithTestSubject(page);
   // Method to navigate to specific Kibana apps
-  extendedPage.gotoApp = (appName: string) => page.goto(kbnUrl.app(appName));
+  extendedPage.gotoApp = (appName: string, pathOptions?: PathOptions) =>
+    page.goto(kbnUrl.app(appName, { pathOptions }));
   // Method to wait for global loading indicator to be hidden
   extendedPage.waitForLoadingIndicatorHidden = () =>
     extendedPage.testSubj.waitForSelector('globalLoadingIndicator-hidden', {

packages/kbn-scout/src/playwright/fixtures/worker/apis/fleet/index.ts

@@ -0,0 +1,71 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { measurePerformanceAsync } from '../../../../../common';
+import { coreWorkerFixtures } from '../../core_fixtures';
+
+export interface FleetApiFixture {
+  integration: {
+    install: (name: string) => Promise<void>;
+    delete: (name: string) => Promise<void>;
+  };
+}
+
+/**
+ * This fixture provides a helper to interact with the Fleet API.
+ */
+export const fleetApiFixture = coreWorkerFixtures.extend<{}, { fleetApi: FleetApiFixture }>({
+  fleetApi: [
+    async ({ kbnClient, log }, use) => {
+      const fleetApiHelper = {
+        integration: {
+          install: async (name: string) => {
+            await measurePerformanceAsync(
+              log,
+              `fleetApi.integration.install [${name}]`,
+              async () => {
+                await kbnClient.request({
+                  method: 'POST',
+                  path: `/api/fleet/epm/custom_integrations`,
+                  body: {
+                    force: true,
+                    integrationName: name,
+                    datasets: [
+                      { name: `${name}.access`, type: 'logs' },
+                      { name: `${name}.error`, type: 'metrics' },
+                      { name: `${name}.warning`, type: 'logs' },
+                    ],
+                  },
+                });
+              }
+            );
+          },
+
+          delete: async (name: string) => {
+            await measurePerformanceAsync(
+              log,
+              `fleetApi.integration.delete [${name}]`,
+              async () => {
+                await kbnClient.request({
+                  method: 'DELETE',
+                  path: `/api/fleet/epm/packages/${name}`,
+                  ignoreErrors: [400],
+                });
+              }
+            );
+          },
+        },
+      };
+
+      log.serviceLoaded('fleetApi');
+      await use(fleetApiHelper);
+    },
+    { scope: 'worker' },
+  ],
+});

packages/kbn-scout/src/playwright/fixtures/worker/apis/index.ts

@@ -0,0 +1,21 @@
+/*
+ * 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", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+import { mergeTests } from 'playwright/test';
+import { FleetApiFixture, fleetApiFixture } from './fleet';
+
+export const apiFixtures = mergeTests(fleetApiFixture);
+
+export interface ApiFixtures {
+  fleetApi: FleetApiFixture;
+}
+
+export interface ApiParallelWorkerFixtures {
+  fleetApi: FleetApiFixture;
+}

packages/kbn-scout/src/playwright/fixtures/worker/index.ts

@@ -25,3 +25,6 @@ export type { UiSettingsFixture } from './ui_settings';
 
 export { scoutSpaceParallelFixture } from './scout_space';
 export type { ScoutSpaceParallelFixture } from './scout_space';
+
+export { apiFixtures } from './apis';
+export type { ApiFixtures, ApiParallelWorkerFixtures } from './apis';

tsconfig.base.json

@@ -1566,6 +1566,8 @@
       "@kbn/scout/*": ["packages/kbn-scout/*"],
       "@kbn/scout-info": ["packages/kbn-scout-info"],
       "@kbn/scout-info/*": ["packages/kbn-scout-info/*"],
+      "@kbn/scout-oblt": ["x-pack/solutions/observability/packages/kbn-scout-oblt"],
+      "@kbn/scout-oblt/*": ["x-pack/solutions/observability/packages/kbn-scout-oblt/*"],
       "@kbn/scout-reporting": ["packages/kbn-scout-reporting"],
       "@kbn/scout-reporting/*": ["packages/kbn-scout-reporting/*"],
       "@kbn/screenshot-mode-example-plugin": ["examples/screenshot_mode_example"],

x-pack/solutions/observability/packages/kbn-scout-oblt/README.md

@@ -0,0 +1,45 @@
+# @kbn/scout-oblt
+
+`@kbn/scout-oblt` is a test library that extends `@kbn/scout` with test helpers specifically designed for `Observability` products in Kibana.
+
+Its primary goal is to simplify the test development experience for teams working on `Observability` plugins by providing custom Playwright fixtures, page objects, and utilities tailored for Observability-related testing scenarios.
+
+### Table of Contents
+
+1. Folder Structure
+2. How to Use
+3. Contributing
+
+### Folder Structure
+
+The `@kbn/scout-oblt` structure includes the following key directories and files:
+
+```
+x-pack/solutions/observability/packages/kbn-scout-oblt/
+├── src/
+│   ├── playwright/
+│   │   └── fixtures
+│   │   │   └── test/
+│   │   │   │   └── // Observability test-scope fixtures
+│   │   │   └── worker/
+│   │   │   │   └── // Observability worker-scope fixtures
+│   │   │   └── single_thread_fixtures.ts
+│   │   │   └── parallel_run_fixtures.ts
+│   │   │   └── index.ts
+│   │   └── page_objects/
+│   │   │   └── // Observability pages
+│   └── index.ts
+├── package.json
+├── tsconfig.json
+```
+
+### How to use
+
+```
+import { test } from '@kbn/scout-oblt';
+
+test('verifies Observability Home loads', async ({ page, pageObjects }) => {
+  await pageObjects.onboardingHome.goto();
+  expect(await page.title()).toContain('Observability');
+});
+```

x-pack/solutions/observability/packages/kbn-scout-oblt/index.ts

@@ -0,0 +1,38 @@
+/*
+ * 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';
+export type {
+  ObltPageObjects,
+  ObltTestFixtures,
+  ObltWorkerFixtures,
+  ObltParallelTestFixtures,
+  ObltParallelWorkerFixtures,
+} from './src/playwright';
+
+// re-export from @kbn/scout
+export {
+  expect,
+  tags,
+  createPlaywrightConfig,
+  createLazyPageObject,
+  ingestTestDataHook,
+} from '@kbn/scout';
+
+export type {
+  EsClient,
+  KbnClient,
+  KibanaUrl,
+  ScoutLogger,
+  ScoutPage,
+  PageObjects,
+  ScoutServerConfig,
+  ScoutTestConfig,
+  ScoutPlaywrightOptions,
+  ScoutTestOptions,
+  Locator,
+} from '@kbn/scout';

x-pack/solutions/observability/packages/kbn-scout-oblt/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/observability/packages/kbn-scout-oblt'],
+};

x-pack/solutions/observability/packages/kbn-scout-oblt/kibana.jsonc

@@ -0,0 +1,6 @@
+{
+  "type": "test-helper",
+  "id": "@kbn/scout-oblt",
+  "owner": "@elastic/appex-qa",
+  "devOnly": true
+}

x-pack/solutions/observability/packages/kbn-scout-oblt/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@kbn/scout-oblt",
+  "private": true,
+  "version": "1.0.0",
+  "license": "Elastic License 2.0"
+}

x-pack/solutions/observability/packages/kbn-scout-oblt/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';