Skip to content

feat(wdio-xvfb): add xvfbAutoInstall option#14696

Merged
christian-bromann merged 7 commits intowebdriverio:mainfrom
goosewobbler:feat/opt-in-xvfb-install
Aug 12, 2025
Merged

feat(wdio-xvfb): add xvfbAutoInstall option#14696
christian-bromann merged 7 commits intowebdriverio:mainfrom
goosewobbler:feat/opt-in-xvfb-install

Conversation

@goosewobbler
Copy link
Contributor

@goosewobbler goosewobbler commented Aug 11, 2025 •
edited
Loading

Proposed changes

Adding a new option to make auto-installation of xvfb opt-in. This only affects Linux systems where xvfb-run is unavailable.

Types of changes

  • Polish (an improvement for an existing feature)
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improvements to the project's docs)
  • Specification changes (updates to WebDriver command specifications)
  • Internal updates (everything related to internal scripts, governance documentation and CI files)

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added the necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Backport Request

//: # (The current main branch is the development branch for WebdriverIO v9. If your change should be released to the current major version of WebdriverIO (v8), please raise another PR with the same changes against the v8 branch.)

  • This change is solely for v9 and doesn't need to be back-ported
  • Back-ported PR at #XXXXX

Further comments

Reviewers: @webdriverio/project-committers

@pkg-pr-new
Copy link

pkg-pr-new bot commented Aug 11, 2025 •
edited
Loading

Open in StackBlitz

create-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/create-wdio@14696

eslint-plugin-wdio

npm i https://pkg.pr.new/webdriverio/webdriverio/eslint-plugin-wdio@14696

@wdio/allure-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/allure-reporter@14696

@wdio/appium-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/appium-service@14696

@wdio/browser-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browser-runner@14696

@wdio/browserstack-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/browserstack-service@14696

@wdio/cli

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cli@14696

@wdio/concise-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/concise-reporter@14696

@wdio/config

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/config@14696

@wdio/cucumber-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/cucumber-framework@14696

@wdio/dot-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/dot-reporter@14696

@wdio/firefox-profile-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/firefox-profile-service@14696

@wdio/globals

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/globals@14696

@wdio/jasmine-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/jasmine-framework@14696

@wdio/json-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/json-reporter@14696

@wdio/junit-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/junit-reporter@14696

@wdio/lighthouse-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/lighthouse-service@14696

@wdio/local-runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/local-runner@14696

@wdio/logger

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/logger@14696

@wdio/mocha-framework

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/mocha-framework@14696

@wdio/protocols

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/protocols@14696

@wdio/repl

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/repl@14696

@wdio/reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/reporter@14696

@wdio/runner

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/runner@14696

@wdio/sauce-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sauce-service@14696

@wdio/shared-store-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/shared-store-service@14696

@wdio/smoke-test-cjs-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-cjs-service@14696

@wdio/smoke-test-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-reporter@14696

@wdio/smoke-test-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/smoke-test-service@14696

@wdio/spec-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/spec-reporter@14696

@wdio/static-server-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/static-server-service@14696

@wdio/sumologic-reporter

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/sumologic-reporter@14696

@wdio/testingbot-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/testingbot-service@14696

@wdio/types

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/types@14696

@wdio/utils

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/utils@14696

@wdio/webdriver-mock-service

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/webdriver-mock-service@14696

@wdio/xvfb

npm i https://pkg.pr.new/webdriverio/webdriverio/@wdio/xvfb@14696

webdriver

npm i https://pkg.pr.new/webdriverio/webdriverio/webdriver@14696

webdriverio

npm i https://pkg.pr.new/webdriverio/webdriverio@14696

commit: 8f2affe

@goosewobbler goosewobbler force-pushed the feat/opt-in-xvfb-install branch from 0134a35 to 8f2affe Compare August 11, 2025 15:51
@goosewobbler
Copy link
Contributor Author

goosewobbler commented Aug 11, 2025 •
edited
Loading

@christian-bromann This follow-up is to address the concerns raised by @gjvoosten in #14501.

I also think we need to add explicit documentation around this, so far there is just the @wdio/xvfb README and the comments in the config definition. Perhaps a new sub-page in the Testrunner section discussing headless testing concerns?

christian-bromann
christian-bromann approved these changes Aug 12, 2025
View reviewed changes
Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@christian-bromann christian-bromann added the PR: Polish 💅 PRs that contain improvements on existing features label Aug 12, 2025
@christian-bromann christian-bromann merged commit 0bd2378 into webdriverio:main Aug 12, 2025
62 checks passed
This was referenced Aug 12, 2025
Closed
Closed
@goosewobbler goosewobbler mentioned this pull request Aug 12, 2025
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@christian-bromann christian-bromann christian-bromann approved these changes

Assignees

No one assigned

Labels

PR: Polish 💅 PRs that contain improvements on existing features

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@goosewobbler @christian-bromann