playwright-bdd/src/runtime/bddTestFixturesAuto.ts

BDD Testing with Playwright runner

/**
 * Auto-inject fixtures are automatically injected into every step/hook call
 * without explicitly passing them in the last argument of Given() / When() / Then().
 * These fixtures are instantiated, although not enumerated in PW test signature,
 * b/c all of them are used in bddContext, that is always created for BDD tests.
 *
 * We still define them in test.extend() to have correct typings and allow these fixtures
 * to be used in user's custom fixtures.
 *
 * The main goal of auto-fixtures is to have cleaner generated code.
 */

import { BddContext } from './bddContext';
import { BddTestFixtures } from './bddTestFixtures';

export type BddAutoInjectFixtures = Pick<
  BddTestFixtures,
  '$test' | '$tags' | '$step' | '$testInfo' | '$bddContext'
>;

const BDD_AUTO_INJECT_FIXTURES: Record<keyof BddAutoInjectFixtures, null> = {
  $tags: null,
  $test: null,
  $step: null,
  $testInfo: null,
  $bddContext: null,
};

export function isBddAutoInjectFixture(name: string) {
  return Object.hasOwn(BDD_AUTO_INJECT_FIXTURES, name as keyof BddAutoInjectFixtures);
}

export function getBddAutoInjectFixtures(bddContext: BddContext): BddAutoInjectFixtures {
  return {
    $testInfo: bddContext.testInfo,
    $tags: bddContext.tags,
    $test: bddContext.test,
    $step: bddContext.step,
    $bddContext: bddContext,
  };
}