Lets you control Xvfb virtual frame buffer X11 server with each build. It starts Xvfb before the build starts, and stops it with the build. This is very useful if your build requires X11 access, for instance runs tests that require GUI.
The plugin starts and stops the Xvfb virtual framebuffer X11 server so your jobs can use X11 displays in headless environments such as servers, or when dedicated X11 display is required for each job.
Start by going to Manage Jenkins / Configure System and setup your Xvfb installation. You need to give it a arbitrary name like default Xvfb and directory in which the Xvfb executable is located like /usr/X11R6/bin. Unfortunately there is no support for automatic installation of Xvfb. As of version 1.1.0 you can define a single Xvfb tool installation or have a installation named "default" and the jobs are going to run even if you don't define what installation to use in the job configuration.
Typically you would use the defaults, which are that display numbers, a unique number that is used to identify each X11 display (you might see them shown as :0, :1 or such), are based on the current Jenkins executor number (the number you see next to the running job in the Build Executor Status box). This is fine if display numbers corresponding to the executor numbers are available for Jenkins to use. If they're not you have several options:
On the job configuration page, enable the "Start Xvfb before the build, and shut it down after." under the Build Environment.
If you want to customize defaults click on Advanced... button.
Jenkins administrator needs to define the Xvfb tool installation.
The directory in which to find Xvfb executable can be left blank, then PATH is searched to find the executable.
Jenkins Workflow support
JENKINS-26848 Does not actually randomize DISPLAY
Thanks to Jo Shields for reporting and testing.
JENKINS-26504 Cannot run low numbered builds with xvfb in Jenkins 1.597
Thanks to Jonathan Price and mturra for reporting the issue.
Thanks to Aleksandr Zhuikov for the pull request.
Thanks to Alexander Clausen, Jarosław Strzelecki & elygre for reporting and suggesting fix.
Thanks to cowwoc for reporting and testing!
Thanks to Zoltan Nagy and Dmitry Katsubo for reporting and testing!
Thanks to Marc Günther, Richard Cross and Jonathan Rogers for reporting and beta testing!
Thanks to Aleksey Alekseev for reporting and testing!
Thanks to Yves Langisch for reporting the feature request!
Thanks to Fredrik Vihlborg for re-reporting issues!
Thanks to Fredrik Vihlborg for reporting issues!
Thanks to Thorsten Kahler for reporting the issue and exemplary patience in testing, JeroenVanHab for the pull request and Fredrik Vihlborg for reporting the issue!
Thanks to Brian Sipos and Daniel Piorkowski for reporting issues!
Skip to end of metadata Go to start of metadata