Test Configuration

Run your tests against multiple device configurations

The Appetize session configuration lives under use.config in playwright.config.ts. It accepts the same values you can set per session anywhere else. See the JavaScript SDK configuration reference for the full list.

playwright.config.ts

use: {
    config: {
        buildId: '<your build id>',
        device: 'iphone15pro',
        osVersion: '18.2',
        language: 'fr',
    },
}

buildId was previously called publicKey. Both still work, but buildId is the current name.

Changing configuration for a suite

test.use overrides the config for a file or a describe block. Changing config starts a new session, so keep it at the top of the suite rather than inside individual tests.

import { test, expect } from '@appetize/playwright'

test.use({
  config: {
    device: 'nexus5',
  },
});

test('app works on nexus5', async ({ session }) => {
  // ...
})

Unlike projects, test.use merges onto the config it inherits, so you only need to name what changes.

See the Playwright documentation for more on test.use.

Reading the configuration

The resolved config for the current test is available as an argument:

test('my test', async ({ session, config }) => {
   if (config.osVersion === '7.0') {
      // do os 7.0 specific behaviour
   }
})

You can also use it to skip tests:

test.describe('iOS 16 features', () => {
    // skip suite if osVersion is less than 16
    test.skip(({ config }) => parseInt(config.osVersion) < 16);

    test('some feature', async ({ session }) => { /* ... */ })
})

Running against several configurations

To run your suite against more than one device, OS version or app, see Projects.