Configuration

Cucumber and Playwright provide massive amount of configuration and customization and we take advantage of this by using:

Custom world: FryWorld
Single configuration file: cucumber.mjs
Implementing Cucumber hooks putting everything together: cucumber-hooks.ts

Configuration file `cucumber.mjs`

Each consumer repository contains cucumber.mjs file which is used to configure both Cucumber and Playwright (with help of the FryWorld).

You will see that it contains test suite specific configuration and consumes the Environment variables to create single configuration object.

This configuration object is consumed by the Cucumber infrastructure and used to configure Cucumber, Playwright and the FryWorld. FryWorld allows access to the configuration in the runtime.

Configuration profiles

We use Cucumber configuration profiles to provide different settings on different environments.

You can use {@link FryWorldParams.profile} to access the profile name in runtime.

The file defines default configuration profile for daily/local use.

npm run test

Profiles cionlybugs and ciexcludebugs are profiles to be used on Jenkins.

npm run test -- --profile cionlybugs

World parameters

Cucumber and more importantly FryWorld knows about the configuration from the cucumber.mjs because Cucumber will set the {@link FryWorld#parameters} property (of type {@link FryWorldParams}) to the contents of the worldParameters key in the cucumber.mjs.

createPlaywrightBrowser(options: LaunchOptions = {}): Promise<Browser> {
  // Return Browser if we already have one
  if (FryWorld.browser) { return FryWorld.browser; }

  const launchOptions = {
    ...this.parameters.browserOptions,              // <- consuming cucumber.mjs
    ...options
  };

  let browser: Browser;
  switch (this.parameters.browser) {                // <- consuming cucumber.mjs
    case firefox.name():
      browser = await firefox.launch(launchOptions);
      break;
    case webkit.name():
      browser = await this.page.goto(path);
});

Environment variables

We use environment variables to quickly configure the test suite from the command line. The cucumber.mjs expects following configuration options, all have some default in the file.

PW_BASE_URL=string

Provides base URL for the test suite eg. https://booking.fox.dev.kaizenep.com all urls will be relative to it. Default is specified on the cucumber.mjs.