[scout] use project deps as global hooks for parallel tests

src/platform/packages/private/kbn-scout-reporting/src/helpers/cli_processing.test.ts

@@ -12,10 +12,19 @@ import { getRunTarget, stripRunCommand } from './cli_processing';
 describe('cli_processing', () => {
   describe('stripRunCommand', () => {
     it(`should return the correct run command when started with 'npx'`, () => {
-      const argv = ['npx', 'playwright', 'test', '--config', 'path/to/config', '--grep=@svlSearch'];
+      const argv = [
+        'npx',
+        'playwright',
+        'test',
+        '--config',
+        'path/to/config',
+        '--project',
+        'local',
+        '--grep=@svlSearch',
+      ];
 
       expect(stripRunCommand(argv)).toBe(
-        'npx playwright test --config path/to/config --grep=@svlSearch'
+        'npx playwright test --config path/to/config --project local --grep=@svlSearch'
       );
     });
 
@@ -26,11 +35,13 @@ describe('cli_processing', () => {
         'test',
         '--config',
         'path/to/config',
+        '--project',
+        'local',
         '--grep=@svlSearch',
       ];
 
       expect(stripRunCommand(argv)).toBe(
-        'npx playwright test --config path/to/config --grep=@svlSearch'
+        'npx playwright test --config path/to/config --project local --grep=@svlSearch'
       );
     });
 

src/platform/packages/shared/kbn-scout/README.md

@@ -186,7 +186,7 @@ If the servers are already running, you can execute tests independently using ei
 - Command Line: Use the following command to run tests:
 
 ```bash
-npx playwright test --config <plugin-path>/ui_tests/playwright.config.ts
+npx playwright test --config <plugin-path>/ui_tests/playwright.config.ts --project local
 ```
 
 ### Contributing

src/platform/packages/shared/kbn-scout/index.ts

@@ -12,6 +12,7 @@ export {
   expect,
   test,
   spaceTest,
+  globalSetupHook,
   tags,
   createPlaywrightConfig,
   createLazyPageObject,

src/platform/packages/shared/kbn-scout/src/playwright/config/create_config.test.ts

@@ -48,6 +48,7 @@ describe('createPlaywrightConfig', () => {
     expect(config.fullyParallel).toBe(false);
     expect(config.use).toEqual({
       serversConfigDir: SCOUT_SERVERS_ROOT,
+      configName: 'local',
       [VALID_CONFIG_MARKER]: true,
       screenshot: 'only-on-failure',
       testIdAttribute: 'data-test-subj',
@@ -64,7 +65,8 @@ describe('createPlaywrightConfig', () => {
     expect(config.timeout).toBe(60000);
     expect(config.expect?.timeout).toBe(10000);
     expect(config.outputDir).toBe('./output/test-artifacts');
-    expect(config.projects![0].name).toEqual('chromium');
+    expect(config.projects).toHaveLength(1);
+    expect(config.projects![0].name).toEqual('local');
   });
 
   it('should return a Playwright configuration with Scout reporters', () => {
@@ -96,12 +98,17 @@ describe('createPlaywrightConfig', () => {
     ]);
   });
 
-  it(`should override 'workers' count in Playwright configuration`, () => {
+  it(`should override 'workers' count and add 'setup' project dependency`, () => {
     const testDir = './my_tests';
     const workers = 2;
 
     const config = createPlaywrightConfig({ testDir, workers });
     expect(config.workers).toBe(workers);
+
+    expect(config.projects).toHaveLength(2);
+    expect(config.projects![0].name).toEqual('setup');
+    expect(config.projects![1].name).toEqual('local');
+    expect(config.projects![1]).toHaveProperty('dependencies', ['setup']);
   });
 
   it('should generate and cache runId in process.env.TEST_RUN_ID', () => {

src/platform/packages/shared/kbn-scout/src/playwright/config/create_config.ts

@@ -27,9 +27,31 @@ export function createPlaywrightConfig(options: ScoutPlaywrightOptions): Playwri
     process.env.TEST_RUN_ID = runId;
   }
 
+  const scoutProjects: PlaywrightTestConfig<ScoutTestOptions>['projects'] = [
+    {
+      name: 'local',
+      use: { ...devices['Desktop Chrome'], configName: 'local' },
+    },
+  ];
+
+  /**
+   * For parallel tests, we need to add a setup project that runs before the tests project.
+   */
+  if (options.workers && options.workers > 1) {
+    scoutProjects.unshift({
+      name: 'setup',
+      testMatch: /global.setup\.ts/,
+    });
+
+    scoutProjects.forEach((project) => {
+      if (project.name !== 'setup') {
+        project.dependencies = ['setup'];
+      }
+    });
+  }
+
   return defineConfig<ScoutTestOptions>({
     testDir: options.testDir,
-    globalSetup: options.globalSetup,
     /* Run tests in files in parallel */
     fullyParallel: false,
     /* Fail the build on CI if you accidentally left test.only in the source code. */
@@ -49,6 +71,7 @@ export function createPlaywrightConfig(options: ScoutPlaywrightOptions): Playwri
     use: {
       testIdAttribute: 'data-test-subj',
       serversConfigDir: SCOUT_SERVERS_ROOT,
+      configName: 'local',
       [VALID_CONFIG_MARKER]: true,
       /* Base URL to use in actions like `await page.goto('/')`. */
       // baseURL: 'http://127.0.0.1:3000',
@@ -70,24 +93,6 @@ export function createPlaywrightConfig(options: ScoutPlaywrightOptions): Playwri
 
     outputDir: './output/test-artifacts', // For other test artifacts (screenshots, videos, traces)
 
-    /* Configure projects for major browsers */
-    projects: [
-      {
-        name: 'chromium',
-        use: { ...devices['Desktop Chrome'] },
-      },
-
-      // {
-      //   name: 'firefox',
-      //   use: { ...devices['Desktop Firefox'] },
-      // },
-    ],
-
-    /* Run your local dev server before starting the tests */
-    // webServer: {
-    //   command: 'npm run start',
-    //   url: 'http://127.0.0.1:3000',
-    //   reuseExistingServer: !process.env.CI,
-    // },
+    projects: scoutProjects,
   });
 }

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

@@ -8,7 +8,13 @@
  */
 
 import { mergeTests } from 'playwright/test';
-import { apiFixtures, coreWorkerFixtures, scoutSpaceParallelFixture } from './worker';
+import {
+  apiFixtures,
+  coreWorkerFixtures,
+  esArchiverFixture,
+  scoutSpaceParallelFixture,
+  synthtraceFixture,
+} from './worker';
 import type {
   ApiParallelWorkerFixtures,
   EsClient,
@@ -52,3 +58,10 @@ export interface ScoutParallelWorkerFixtures extends ApiParallelWorkerFixtures {
   esClient: EsClient;
   scoutSpace: ScoutSpaceParallelFixture;
 }
+
+export const globalSetup = mergeTests(
+  coreWorkerFixtures,
+  esArchiverFixture,
+  synthtraceFixture,
+  apiFixtures
+);

src/platform/packages/shared/kbn-scout/src/playwright/fixtures/worker/core_fixtures.ts

@@ -64,10 +64,14 @@ export const coreWorkerFixtures = base.extend<
    */
   config: [
     ({ log }, use, testInfo) => {
-      const configName = 'local';
       const projectUse = testInfo.project.use as ScoutTestOptions;
+      if (!projectUse.configName) {
+        throw new Error(
+          'Invalid Playwright project configuration. Make sure to set "configName" property'
+        );
+      }
       const serversConfigDir = projectUse.serversConfigDir;
-      const configInstance = createScoutConfig(serversConfigDir, configName, log);
+      const configInstance = createScoutConfig(serversConfigDir, projectUse.configName, log);
 
       use(configInstance);
     },

src/platform/packages/shared/kbn-scout/src/playwright/index.ts

@@ -7,14 +7,16 @@
  * License v3.0 only", or the "Server Side Public License, v 1".
  */
 
-import { scoutFixtures, scoutParallelFixtures } from './fixtures';
+import { scoutFixtures, scoutParallelFixtures, globalSetup } from './fixtures';
 
 // Scout core fixtures: worker & test scope
 export const test = scoutFixtures;
 
 // Scout core 'space aware' fixtures: worker & test scope
 export const spaceTest = scoutParallelFixtures;
 
+export const globalSetupHook = globalSetup;
+
 export { createPlaywrightConfig } from './config';
 export { createLazyPageObject } from './page_objects/utils';
 export { expect } from './expect';

src/platform/packages/shared/kbn-scout/src/playwright/runner/flags.test.ts

@@ -72,6 +72,7 @@ describe('parseTestFlags', () => {
     expect(result).toEqual({
       mode: 'serverless=oblt',
       configPath: '/path/to/config',
+      env: 'local',
       headed: false,
       esFrom: undefined,
       installDir: undefined,
@@ -82,6 +83,7 @@ describe('parseTestFlags', () => {
   it(`should parse with correct config and stateful flags`, async () => {
     const flags = new FlagsReader({
       config: '/path/to/config',
+      env: 'local',
       stateful: true,
       logToFile: false,
       headed: true,
@@ -93,6 +95,7 @@ describe('parseTestFlags', () => {
     expect(result).toEqual({
       mode: 'stateful',
       configPath: '/path/to/config',
+      env: 'local',
       headed: true,
       esFrom: 'snapshot',
       installDir: undefined,

src/platform/packages/shared/kbn-scout/src/playwright/runner/flags.ts

@@ -19,6 +19,7 @@ export interface RunTestsOptions {
   configPath: string;
   headed: boolean;
   mode: CliSupportedServerModes;
+  env: 'local' | 'cloud';
   esFrom: 'serverless' | 'source' | 'snapshot' | undefined;
   installDir: string | undefined;
   logsDir: string | undefined;
@@ -28,17 +29,23 @@ export const TEST_FLAG_OPTIONS: FlagOptions = {
   ...SERVER_FLAG_OPTIONS,
   boolean: [...(SERVER_FLAG_OPTIONS.boolean || []), 'headed'],
   string: [...(SERVER_FLAG_OPTIONS.string || []), 'config'],
-  default: { headed: false },
+  default: { headed: false, env: 'local' },
   help: `${SERVER_FLAG_OPTIONS.help}
     --config             Playwright config file path
     --headed             Run Playwright with browser head
+    --env                Run tests agaist locally started servers or Cloud deployment / MKI project 
   `,
 };
 
 export async function parseTestFlags(flags: FlagsReader) {
   const options = parseServerFlags(flags);
   const configPath = flags.string('config');
   const headed = flags.boolean('headed');
+  const env = flags.enum('env', ['local', 'cloud']) || 'local';
+
+  if (env === 'cloud') {
+    throw createFlagError(`Running tests against Cloud / MKI is not supported yet`);
+  }
 
   if (!configPath) {
     throw createFlagError(`Path to playwright config is required: --config <file path>`);
@@ -51,5 +58,6 @@ export async function parseTestFlags(flags: FlagsReader) {
     ...options,
     configPath,
     headed,
+    env,
   };
 }

src/platform/packages/shared/kbn-scout/src/playwright/runner/run_tests.ts

@@ -32,7 +32,12 @@ export async function runTests(log: ToolingLog, options: RunTestsOptions) {
   const playwrightConfigPath = options.configPath;
 
   const cmd = resolve(REPO_ROOT, './node_modules/.bin/playwright');
-  const cmdArgs = ['test', `--config=${playwrightConfigPath}`, `--grep=${playwrightGrepTag}`];
+  const cmdArgs = [
+    'test',
+    `--config=${playwrightConfigPath}`,
+    `--grep=${playwrightGrepTag}`,
+    `--project=${options.env}`,
+  ];
 
   await withProcRunner(log, async (procs) => {
     log.info(`scout: Validate Playwright config has tests`);
@@ -78,7 +83,7 @@ export async function runTests(log: ToolingLog, options: RunTestsOptions) {
       // wait for 5 seconds
       await silence(log, 5000);
 
-      // Running 'npx playwright test --config=${playwrightConfigPath}'
+      // Running 'npx playwright test --config=${playwrightConfigPath} --project local'
       await procs.run(`playwright`, {
         cmd,
         args: [...cmdArgs, ...(options.headed ? ['--headed'] : [])],

src/platform/packages/shared/kbn-scout/src/playwright/types/index.ts

@@ -13,14 +13,15 @@ export type Protocol = 'http' | 'https';
 
 export const VALID_CONFIG_MARKER = Symbol('validConfig');
 
+export type ScoutConfigName = 'local';
+
 export interface ScoutTestOptions extends PlaywrightTestOptions {
   serversConfigDir: string;
+  configName: ScoutConfigName;
   [VALID_CONFIG_MARKER]: boolean;
 }
 
-export interface ScoutPlaywrightOptions
-  extends Pick<PlaywrightTestConfig, 'testDir' | 'workers' | 'globalSetup'> {
+export interface ScoutPlaywrightOptions extends Pick<PlaywrightTestConfig, 'testDir' | 'workers'> {
   testDir: string;
   workers?: 1 | 2 | 3; // to keep performance consistent within test suites
-  globalSetup?: string;
 }

src/platform/packages/shared/kbn-scout/src/servers/start_servers.ts

@@ -52,7 +52,7 @@ export async function startServers(log: ToolingLog, options: StartServerOptions)
       '\n\n' +
         dedent`
           Elasticsearch and Kibana are ready for functional testing.
-          Use 'npx playwright test --config <path_to_Playwright.config.ts>' to run tests'
+          Use 'npx playwright test --config <path_to_Playwright.config.ts> --project local' to run tests'
         ` +
         '\n\n'
     );

x-pack/platform/plugins/private/discover_enhanced/ui_tests/README.md

@@ -13,10 +13,10 @@ Then you can run the tests multiple times in another terminal with:
 
 ```bash
 // ESS
-npx playwright test --config x-pack/platform/plugins/private/discover_enhanced/ui_tests/playwright.config.ts --grep @ess
+npx playwright test --config x-pack/platform/plugins/private/discover_enhanced/ui_tests/playwright.config.ts --project local --grep @ess
 
 // Serverless
-npx playwright test --config x-pack/platform/plugins/private/discover_enhanced/ui_tests/playwright.config.ts --grep @svlSearch
+npx playwright test --config x-pack/platform/plugins/private/discover_enhanced/ui_tests/playwright.config.ts --project local --grep @svlSearch
 
 // @svlOblt, @svlSecurity
 ```

x-pack/platform/plugins/private/discover_enhanced/ui_tests/parallel.playwright.config.ts

@@ -9,7 +9,6 @@ import { createPlaywrightConfig } from '@kbn/scout';
 
 // eslint-disable-next-line import/no-default-export
 export default createPlaywrightConfig({
-  globalSetup: require.resolve('./parallel_tests/global_setup'),
   testDir: './parallel_tests',
   workers: 2,
 });

x-pack/platform/plugins/private/discover_enhanced/ui_tests/parallel_tests/global_setup.ts → x-pack/platform/plugins/private/discover_enhanced/ui_tests/parallel_tests/global.setup.ts

@@ -5,20 +5,19 @@
  * 2.0.
  */
 
-import { ingestTestDataHook } from '@kbn/scout';
-import { type FullConfig } from '@playwright/test';
+import { globalSetupHook } from '@kbn/scout';
 import { testData } from '../fixtures';
 
-async function globalSetup(config: FullConfig) {
+globalSetupHook('Ingest data to Elasticsearch', async ({ esArchiver, log }) => {
   // add archives to load, if needed
   const archives = [
     testData.ES_ARCHIVES.LOGSTASH,
     testData.ES_ARCHIVES.NO_TIME_FIELD,
     testData.ES_ARCHIVES.ECOMMERCE,
   ];
 
-  return ingestTestDataHook(config, archives);
-}
-
-// eslint-disable-next-line import/no-default-export
-export default globalSetup;
+  log.debug('[setup] loading test data (only if indexes do not exist)...');
+  for (const archive of archives) {
+    await esArchiver.loadIfNeeded(archive);
+  }
+});