selenium:xvfb

Full name:

org.codehaus.mojo:selenium-maven-plugin:2.2:xvfb

Description:

Starts an Xvfb instance suitable for handling X11 displays for headless systems. Use this in combonation with the start-server goal to allow browsers to be launched on headless unix systems.

Optionally uses 'xauth' to setup authentication for the Xvfb instance to allow running tests using the frame buffer server when another X server is already running.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.0-beta-2.

Required Parameters

Name Type Since Description
displayPropertiesFile File 1.0-beta-2 The location of the file to write the display properties which will be picked up by the start-server goal.
Default value is: ${project.build.directory}/selenium/display.properties.
xvfbExecutable String 1.0-beta-2 The 'Xvfb' command to execute.
Default value is: Xvfb.

Optional Parameters

Name Type Since Description
authenticationFile File 1.0-beta-2 The file where X authentication data is stored for the Xvfb session. Default is to generate a temporary file.
background boolean 1.0-beta-2 Flag to control if we background the process or block Maven execution.
Default value is: true.
display String 1.0-beta-2 The X11 display to use. Default value is :20.
logFile File 1.0-beta-2 The file that Xvfb output will be written to.
Default value is: ${project.build.directory}/selenium/xvfb.log.
logOutput boolean 1.0-beta-2 Enable logging mode.
Default value is: true.
options String[] 1.0-beta-2 A list of additional options to pass to the Xvfb process.
reuse boolean 1.1 Reuse Xvfb process
Default value is: false.
skip boolean 1.0-beta-2 Skip goal execution
Default value is: false.
xauthEnabled boolean 1.0-beta-2 Use 'xauth' to setup permissions for the Xvfb server. This requires 'xauth' be installed and may be required when an X server is already running.
Default value is: true.
xauthExecutable String 1.0-beta-2 The 'xauth' command to execute.
Default value is: xauth.
xauthProtocol String 1.0-beta-2 The 'xauth' protocol.
Default value is: ..

Parameter Details

authenticationFile:

The file where X authentication data is stored for the Xvfb session. Default is to generate a temporary file.
  • Type: java.io.File
  • Since: 1.0-beta-2
  • Required: No

background:

Flag to control if we background the process or block Maven execution.
  • Type: boolean
  • Since: 1.0-beta-2
  • Required: No
  • Default: true

display:

The X11 display to use. Default value is :20.
  • Type: java.lang.String
  • Since: 1.0-beta-2
  • Required: No

displayPropertiesFile:

The location of the file to write the display properties which will be picked up by the start-server goal.
  • Type: java.io.File
  • Since: 1.0-beta-2
  • Required: Yes
  • Default: ${project.build.directory}/selenium/display.properties

logFile:

The file that Xvfb output will be written to.
  • Type: java.io.File
  • Since: 1.0-beta-2
  • Required: No
  • Default: ${project.build.directory}/selenium/xvfb.log

logOutput:

Enable logging mode.
  • Type: boolean
  • Since: 1.0-beta-2
  • Required: No
  • Default: true

options:

A list of additional options to pass to the Xvfb process.
  • Type: java.lang.String[]
  • Since: 1.0-beta-2
  • Required: No

reuse:

Reuse Xvfb process
  • Type: boolean
  • Since: 1.1
  • Required: No
  • Expression: ${xvfb.reuse}
  • Default: false

skip:

Skip goal execution
  • Type: boolean
  • Since: 1.0-beta-2
  • Required: No
  • Expression: ${maven.test.skip}
  • Default: false

xauthEnabled:

Use 'xauth' to setup permissions for the Xvfb server. This requires 'xauth' be installed and may be required when an X server is already running.
  • Type: boolean
  • Since: 1.0-beta-2
  • Required: No
  • Default: true

xauthExecutable:

The 'xauth' command to execute.
  • Type: java.lang.String
  • Since: 1.0-beta-2
  • Required: No
  • Default: xauth

xauthProtocol:

The 'xauth' protocol.
  • Type: java.lang.String
  • Since: 1.0-beta-2
  • Required: No
  • Default: .

xvfbExecutable:

The 'Xvfb' command to execute.
  • Type: java.lang.String
  • Since: 1.0-beta-2
  • Required: Yes
  • Default: Xvfb