[Profiling] Migrate cypress tests to scout (elastic#239964)

Closes elastic#210183 

## Summary

This PR creates the initial setup for the e2e Profiling tests in Scout,
migrating from Cypress.

⚠️ The Cypress tests will be fully migrated and removed in follow-up
PRs, including the removal of the data fixture from Cypress (currently
duplicated here)

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Dzmitry Lemechko <[email protected]>

Author: 3 people

.buildkite/scout_ci_config.yml

@@ -7,6 +7,7 @@ plugins:
     - observability
     - observability_onboarding
     - painless_lab
+    - profiling
     - security_solution
     - streams_app
     - slo

src/platform/packages/shared/kbn-scout/src/config/stateful/base.config.ts

@@ -10,17 +10,17 @@
 import { join, resolve } from 'path';
 import { format as formatUrl } from 'url';
 
+import { STATEFUL_ROLES_ROOT_PATH } from '@kbn/es';
 import {
-  MOCK_IDP_ENTITY_ID,
-  MOCK_IDP_ATTRIBUTE_PRINCIPAL,
-  MOCK_IDP_ATTRIBUTE_ROLES,
   MOCK_IDP_ATTRIBUTE_EMAIL,
   MOCK_IDP_ATTRIBUTE_NAME,
+  MOCK_IDP_ATTRIBUTE_PRINCIPAL,
+  MOCK_IDP_ATTRIBUTE_ROLES,
+  MOCK_IDP_ENTITY_ID,
+  MOCK_IDP_REALM_NAME,
 } from '@kbn/mock-idp-utils';
-import { fleetPackageRegistryDockerImage, defineDockerServersConfig } from '@kbn/test';
-import { MOCK_IDP_REALM_NAME } from '@kbn/mock-idp-utils';
 import { REPO_ROOT } from '@kbn/repo-info';
-import { STATEFUL_ROLES_ROOT_PATH } from '@kbn/es';
+import { defineDockerServersConfig, fleetPackageRegistryDockerImage } from '@kbn/test';
 import type { ScoutServerConfig } from '../../types';
 import { SAML_IDP_PLUGIN_PATH, STATEFUL_IDP_METADATA_PATH } from '../constants';
 
@@ -178,6 +178,27 @@ export const defaultConfig: ScoutServerConfig = {
       '--xpack.ruleRegistry.write.enabled=true',
       '--xpack.ruleRegistry.write.cache.enabled=false',
       '--monitoring_collection.opentelemetry.metrics.prometheus.enabled=true',
+      '--xpack.profiling.enabled=true',
+      // Fleet configuration
+      `--xpack.fleet.fleetServerHosts=${JSON.stringify([
+        {
+          id: 'default-fleet-server',
+          name: 'Default Fleet Server',
+          is_default: true,
+          host_urls: ['https://localhost:8220'],
+        },
+      ])}`,
+      `--xpack.fleet.outputs=${JSON.stringify([
+        {
+          id: 'es-default-output',
+          name: 'Default Output',
+          type: 'elasticsearch',
+          is_default: true,
+          is_default_monitoring: true,
+          hosts: ['https://localhost:9200'],
+        },
+      ])}`,
+      // Agent policies are now created via Fleet API using the helper function from @kbn-scout
       // SAML configuration
       ...(isRunOnCI ? [] : ['--mockIdpPlugin.enabled=true']),
       // This ensures that we register the Security SAML API endpoints.

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

@@ -18,6 +18,9 @@ import type {
 } from './types';
 
 export interface FleetApiService {
+  internal: {
+    setup: () => Promise<any>;
+  };
   integration: {
     install: (name: string) => Promise<any>;
     delete: (name: string) => Promise<any>;
@@ -73,6 +76,16 @@ export interface FleetApiService {
 
 export const getFleetApiHelper = (log: ScoutLogger, kbnClient: KbnClient): FleetApiService => {
   return {
+    internal: {
+      setup: async () => {
+        return await measurePerformanceAsync(log, `fleetApi.internal.setup`, async () => {
+          return await kbnClient.request({
+            method: 'POST',
+            path: '/api/fleet/setup',
+          });
+        });
+      },
+    },
     integration: {
       install: async (name: string) => {
         return await measurePerformanceAsync(

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

@@ -9,7 +9,10 @@
 export { test, spaceTest } from './src/playwright';
 
 // re-exported test framework from @kbn/scout
-export { expect, lighthouseTest, apiTest, globalSetupHook, tags } from '@kbn/scout';
+export { expect, lighthouseTest, apiTest, tags } from '@kbn/scout';
+
+// Custom global setup hook with profiling support
+export { globalSetupHook } from './src/playwright/global_hooks/profiling_setup';
 
 // re-exported fixtures & configuration from @kbn/scout
 export {

x-pack/solutions/observability/packages/kbn-scout-oblt/src/playwright/fixtures/parallel_run_fixtures.ts

@@ -5,20 +5,18 @@
  * 2.0.
  */
 
-import { spaceTest as spaceBase } from '@kbn/scout';
+import { spaceTest as spaceBase, mergeTests } from '@kbn/scout';
 import type { ApiServicesFixture, KbnClient } from '@kbn/scout';
 import { extendPageObjects } from '../page_objects';
+import { profilingSetupFixture } from './worker';
 
 import type {
   ObltApiServicesFixture,
   ObltParallelTestFixtures,
   ObltParallelWorkerFixtures,
 } from './types';
 
-/**
- * Should be used test spec files, running in parallel in isolated spaces against the same Kibana instance.
- */
-export const spaceTest = spaceBase.extend<ObltParallelTestFixtures, ObltParallelWorkerFixtures>({
+const baseFixture = spaceBase.extend<ObltParallelTestFixtures, ObltParallelWorkerFixtures>({
   pageObjects: async (
     {
       pageObjects,
@@ -46,3 +44,8 @@ export const spaceTest = spaceBase.extend<ObltParallelTestFixtures, ObltParallel
     { scope: 'worker' },
   ],
 });
+
+/**
+ * Should be used test spec files, running in parallel in isolated spaces against the same Kibana instance.
+ */
+export const spaceTest = mergeTests(baseFixture, profilingSetupFixture);

x-pack/solutions/observability/packages/kbn-scout-oblt/src/playwright/fixtures/single_thread_fixtures.ts

@@ -10,7 +10,7 @@ import type { ApiServicesFixture, KbnClient } from '@kbn/scout';
 
 import { extendPageObjects } from '../page_objects';
 import type { ObltApiServicesFixture, ObltTestFixtures, ObltWorkerFixtures } from './types';
-import { sloDataFixture } from './worker';
+import { sloDataFixture, profilingSetupFixture } from './worker';
 
 const baseFixture = base.extend<ObltTestFixtures, ObltWorkerFixtures>({
   pageObjects: async (
@@ -43,4 +43,4 @@ const baseFixture = base.extend<ObltTestFixtures, ObltWorkerFixtures>({
 /**
  * Should be used for the test spec files executed sequentially.
  */
-export const test = mergeTests(baseFixture, sloDataFixture);
+export const test = mergeTests(baseFixture, sloDataFixture, profilingSetupFixture);

x-pack/solutions/observability/packages/kbn-scout-oblt/src/playwright/fixtures/types.ts

@@ -13,7 +13,7 @@ import type {
   ScoutWorkerFixtures,
 } from '@kbn/scout';
 import type { ObltPageObjects } from '../page_objects';
-import type { SloDataFixture } from './worker';
+import type { SloDataFixture, ProfilingSetupFixture } from './worker';
 
 export interface ObltTestFixtures extends ScoutTestFixtures {
   pageObjects: ObltPageObjects;
@@ -24,6 +24,7 @@ export type ObltApiServicesFixture = ApiServicesFixture;
 export interface ObltWorkerFixtures extends ScoutWorkerFixtures {
   apiServices: ObltApiServicesFixture;
   sloData: SloDataFixture;
+  profilingSetup: ProfilingSetupFixture;
 }
 
 export interface ObltParallelTestFixtures extends ScoutParallelTestFixtures {
@@ -32,4 +33,5 @@ export interface ObltParallelTestFixtures extends ScoutParallelTestFixtures {
 
 export interface ObltParallelWorkerFixtures extends ScoutParallelWorkerFixtures {
   apiServices: ObltApiServicesFixture;
+  profilingSetup: ProfilingSetupFixture;
 }

x-pack/solutions/observability/packages/kbn-scout-oblt/src/playwright/fixtures/worker/index.ts

@@ -7,3 +7,6 @@
 
 export { sloDataFixture } from './slo_data';
 export type { SloDataFixture } from './slo_data';
+
+export { profilingSetupFixture } from './profiling';
+export type { ProfilingSetupFixture } from './profiling';

x-pack/solutions/observability/packages/kbn-scout-oblt/src/playwright/fixtures/worker/profiling/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 { profilingSetupFixture } from './profiling_setup_fixture';
+export type { ProfilingSetupFixture } from './profiling_setup_fixture';

x-pack/solutions/observability/packages/kbn-scout-oblt/src/playwright/fixtures/worker/profiling/profiling_setup_fixture.ts

@@ -0,0 +1,100 @@
+/*
+ * 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 base } from '@kbn/scout';
+import path from 'path';
+import fs from 'fs';
+
+export interface ProfilingSetupFixture {
+  checkStatus: () => Promise<{ has_setup: boolean; has_data: boolean }>;
+  setupResources: () => Promise<void>;
+  loadData: () => Promise<void>;
+}
+
+// This fixture should be used only in the global setup hook
+// because it needs to be run before any other test
+// and it needs to be run only once
+export const profilingSetupFixture = base.extend<{}, { profilingSetup: ProfilingSetupFixture }>({
+  profilingSetup: [
+    async ({ kbnClient, esClient, log }, use) => {
+      const checkStatus = async (): Promise<{ has_setup: boolean; has_data: boolean }> => {
+        try {
+          const response = await kbnClient.request({
+            description: 'Check profiling status',
+            path: '/api/profiling/setup/es_resources',
+            method: 'GET',
+          });
+          return response.data as { has_setup: boolean; has_data: boolean };
+        } catch (error: any) {
+          log.error(`Error checking profiling status: ${error}`);
+          return { has_setup: false, has_data: false };
+        }
+      };
+
+      const setupResources = async (): Promise<void> => {
+        try {
+          log.info('Setting up profiling resources');
+          await kbnClient.request({
+            description: 'Setup profiling resources',
+            path: '/api/profiling/setup/es_resources',
+            method: 'POST',
+            body: {},
+          });
+          log.info('Profiling resources set up successfully');
+        } catch (error) {
+          log.error(`Error setting up profiling resources: ${error}`);
+          throw error;
+        }
+      };
+
+      const loadData = async (): Promise<void> => {
+        try {
+          log.info('Loading profiling data');
+
+          const PROFILING_DATA_PATH = path.join(
+            __dirname,
+            './test_data/profiling_data_anonymized.json'
+          );
+
+          if (!fs.existsSync(PROFILING_DATA_PATH)) {
+            log.info('Profiling data file not found, skipping data loading');
+            return;
+          }
+
+          const profilingData = fs.readFileSync(PROFILING_DATA_PATH, 'utf8');
+          const operations = profilingData.split('\n').filter((line: string) => line.trim());
+
+          // Use esClient for bulk operations
+          const response = await esClient.bulk({
+            body: operations.join('\n') + '\n',
+            refresh: 'wait_for',
+            timeout: '1m',
+          });
+
+          if (response.errors) {
+            const erroredItems = response.items?.filter((item: any) => item?.index?.error);
+            log.error(
+              `Some errors occurred during bulk indexing: ${JSON.stringify(erroredItems, null, 2)}`
+            );
+          } else {
+            log.info(`Successfully indexed ${response.items?.length || 0} profiling documents`);
+          }
+        } catch (error) {
+          log.error(`Error loading profiling data: ${error}`);
+          throw error;
+        }
+      };
+
+      await use({
+        checkStatus,
+        setupResources,
+        loadData,
+      });
+    },
+    { scope: 'worker' },
+  ],
+});