Use the Xvfb Wrapper

Xvfb is an X server that implements the X11 display server protocol and can run on machines that don't have physical input devices or a display.

Set Up a VM Build Executor and a Build Executor Template with Xvfb

Before you can use Xvfb in a build step, your organization administrator must first create a build executor template with the minimum required software and then add a VM build executor that uses the build executor template. Your organization administrator can create a new build executor template or use any existing Oracle Linux 7 build executor template.

Note:

To find your organization administrator, click Contacts under your user profile. Your administrator, or a list of administrators, will display.

See Create and Manage Build Executor Templates in Administering Visual Builder Studio.

After the organization administrator adds a VM build executor to the build executor template, you can create and configure a job to use that build executor template and Xvfb.

Configure a Job to Run Xvfb

Create and configure a job that runs Xvfb commands:

  1. Open the job’s configuration page.
    If you're creating a job, in Template in the New Job dialog box, select the Xvfb build executor template. Proceed to step 4.
  2. Click Settings the Gear icon.
  3. In the Software tab, select the Xvfb build executor template or any minimum required build executor template.
  4. Click Configure Configure.
  5. Click the Before Build tab.
  6. From Add Before Build Action, select Xvfb Wrapper.
  7. In Display Number, specify the ordinal number of the display the Xvfb server is running on. The default value is 0. If left empty, a random number is chosen when the build runs.
  8. In Screen offset, specify the offset for display numbers. The default value is 0.
  9. In Screen Size (WxHxD), specify the resolution and color depth of the virtual frame buffer in the WxHxD format. The default value is 1024x758x24.
  10. In Additional options, specify additional Xvfb command line options, if necessary. The default options are -nolisten inet6 +extension RANDR -fp /usr/share/X11/fonts/misc.
  11. In Timeout in seconds, specify the timeout duration for the build to wait before returning control to the job. The default value is 0.
  12. If you don’t want to log the Xvfb output in the build log, deselect the Log Xvfb output check box. The check box is selected by default.
  13. If you don’t want to keep the Xvfb server running for post-build steps, deselect the Shutdown Xvfb with whole job, not just with the main build action check box. The check box is selected by default.
  14. Click Save.