context

An application and supported platforms.

If no contexts are specified but a context is required by one or more tests, Doc Detective attempts to identify a supported context in the current environment and run tests against it. For browsers, context priority is Firefox > Chrome > Chromium.

Fields

Field	Type	Description	Default
app	object	Required. The application to run.
app.name	string	Required. Name of the application. Accepted values: chrome, firefox, safari, edge
app.path	string	Optional. Absolute path or command for the application. If not specified, defaults to typical install paths per platform. If specified but the path is invalid, the context is skipped.
app.options	object	Optional. Options to pass to the app. Only works when name is firefox or chrome.
app.options.width	integer	Optional. Width of the window in pixels.
app.options.height	integer	Optional. Height of the window in pixels.
app.options.viewport_height	integer	Optional. Height of the viewport in pixels. Overrides height.
app.options.viewport_width	integer	Optional. Width of the viewport in pixels. Overrides width.
app.options.headless	boolean	Optional. If true, runs the browser in headless mode. Not supported by Safari.
app.options.driverPath	string	Optional. Path to the browser driver. If not specified, defaults to internally managed dependencies.
platforms	array of strings	Required. Supported platforms for the application.

Examples

{
  "app": {
    "name": "chrome"
  },
  "platforms": [
    "linux"
  ]
}

{
  "app": {
    "name": "chrome",
    "options": {
      "viewport_width": 800,
      "viewport_height": 600
    }
  },
  "platforms": [
    "linux"
  ]
}

{
  "app": {
    "name": "firefox",
    "options": {
      "width": 800,
      "height": 600,
      "headless": false,
      "driverPath": "/usr/bin/geckodriver"
    }
  },
  "platforms": [
    "linux",
    "windows",
    "mac"
  ]
}

{
  "app": {
    "name": "safari"
  },
  "platforms": [
    "mac"
  ]
}

{
  "app": {
    "name": "firefox",
    "path": "/usr/bin/firefox"
  },
  "platforms": [
    "linux"
  ]
}