externalWithSerenityConfig

WebdriverIO configuration object, with Serenity/JS-specific additions.

Integrating WebdriverIO with Serenity/JS

// wdio.conf.ts
import { WithSerenityConfig } from '@serenity-js/webdriverio'

export const config: WebdriverIO.Config & WithSerenityConfig = {

  framework: '@serenity-js/webdriverio',

  serenity: {
    runner: 'cucumber',
    // runner: 'mocha',
    // runner: 'jasmine',

    crew: [
      // Optional, print test execution results to standard output
      '@serenity-js/console-reporter',

      // Optional, produce Serenity BDD reports
      // and living documentation (HTML)
      '@serenity-js/serenity-bdd',
      [ '@serenity-js/core:ArtifactArchiver', {
          outputDirectory: 'target/site/serenity'
      } ],

      // Optional, automatically capture screenshots
      // upon interaction failure
      [ '@serenity-js/web:Photographer', {
          strategy: 'TakePhotosOfFailures'
          // strategy: 'TakePhotosOfInteractions'
      } ],
    ]
  },

  // Configure your Cucumber runner
  cucumberOpts: {
    // see Cucumber configuration options below
  },

  // ... or Jasmine runner
  jasmineOpts: {
    // see Jasmine configuration options below
  },

  // ... or Mocha runner
  mochaOpts: {
     // see Mocha configuration options below
  },

  runner: 'local',

  specs: [
    './features/*.feature',

    // or for Mocha/Jasmine
    // './*.spec.ts'
  ],

  // Any other WebdriverIO configuration
}

Learn more

Index

Properties

serenity

Properties

externaloptionalserenity

serenity?: SerenityConfig & { runner?: string }

Serenity/JS configuration with an additional runner entry allowing to specify the test runner, such as cucumber, mocha, or jasmine.