playwright/tests/config/testModeFixtures.ts

/**
 * Copyright (c) Microsoft Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { test } from '@playwright/test';
import type { TestModeName } from './testMode';
import { DefaultTestMode, DriverTestMode } from './testMode';
import * as playwrightLibrary from 'playwright-core';

export type TestModeWorkerOptions = {
  mode: TestModeName;
  codegenMode: 'trace-events' | 'actions';
};

export type TestModeTestFixtures = {
  toImpl: (rpcObject?: any) => any;
};

export type TestModeWorkerFixtures = {
  toImplInWorkerScope: (rpcObject?: any) => any;
  playwright: typeof import('@playwright/test');
};

export const testModeTest = test.extend<TestModeTestFixtures, TestModeWorkerOptions & TestModeWorkerFixtures>({
  mode: ['default', { scope: 'worker', option: true }],
  playwright: [async ({ mode }, run) => {
    const testMode = {
      'default': new DefaultTestMode(),
      'service': new DefaultTestMode(),
      'service2': new DefaultTestMode(),
      'service-grid': new DefaultTestMode(),
      'driver': new DriverTestMode(),
    }[mode];
    require('playwright-core/lib/utils').setUnderTest();
    const playwright = await testMode.setup();
    playwright._setSelectors(playwrightLibrary.selectors);
    await run(playwright);
    await testMode.teardown();
  }, { scope: 'worker' }],
  codegenMode: ['actions', { scope: 'worker', option: true }],

  toImplInWorkerScope: [async ({ playwright }, use) => {
    await use((playwright as any)._toImpl);
  }, { scope: 'worker' }],

  toImpl: async ({ toImplInWorkerScope: toImplWorker, mode }, use, testInfo) => {
    if (mode !== 'default' || process.env.PW_TEST_REUSE_CONTEXT)
      testInfo.skip();
    await use(toImplWorker);
  },
});