Run Playwright visual regression tests in Jenkins on a consistent Linux environment, using a version-matched Playwright Docker image and the project’s lockfile. Add await expect(page).toHaveScreenshot() to a Playwright Test, review and commit its baseline, then run npm ci and npx playwright test in the pipeline. For India-facing behavior, set the browser locale and timezone to match the product requirements; set TZ separately if the test runner process also needs a specific timezone.
How to run Playwright screenshot tests in Jenkins
Playwright’s CI guide recommends using its Docker image for Jenkins. The image provides browsers and system dependencies, but your job still needs to install the project’s Playwright package and other dependencies. Keep the image and package versions compatible so the browser executables expected by Playwright are available. See Playwright’s Continuous Integration guide and browser installation guidance.
1. Add a screenshot assertion
Use Playwright Test’s toHaveScreenshot() assertion after navigating the page to the state you want to compare. Playwright waits for two consecutive screenshots to match before it compares the result with the expected image. The assertion and its options are documented in Visual comparisons.
import { test, expect } from '@playwright/test';
test('home page visual regression', async ({ page }) => {
await page.goto('https://example.com');
await expect(page).toHaveScreenshot();
});Replace the example URL with your application and establish any required login, data, viewport, or UI state in the test before taking the screenshot. The screenshot assertion checks the rendered result; it does not itself ensure that the page is showing the correct application state.
The Tool Desk
Outbyte Driver Updater FREEScan for outdated or missing drivers - takes under a minuteDriver Scan →Outbyte PC Repair FREEClear out junk files and repair common Windows errorsFree Scan →#1 Best Overall
- CRISP CLARITY: This 23.8″ Philips V line monitor delivers crisp Full HD 1920x1080 visuals. Enjoy movies, shows and videos with remarkable detail
- INCREDIBLE CONTRAST: The VA panel produces brighter whites and deeper blacks. You get true-to-life images and more gradients with 16.7 million colors
- THE PERFECT VIEW: The 178/178 degree extra wide viewing angle prevents the shifting of colors when viewed from an offset angle, so you always get consistent colors
- WORK SEAMLESSLY: This sleek monitor is virtually bezel-free on three sides, so the screen looks even bigger for the viewer. This minimalistic design also allows for seamless multi-monitor setups that enhance your workflow and boost productivity
- A BETTER READING EXPERIENCE: For busy office workers, EasyRead mode provides a more paper-like experience for when viewing lengthy documents
2. Create and commit a reviewed baseline
If no reference image exists, a run can create one. Inspect the generated image before committing it. Keep approved screenshot snapshots in version control so reviewers can see intended visual changes alongside code changes. Use Playwright’s snapshot-update mechanism only when you have confirmed that the change is intentional; do not update baselines just to make a failing build pass.
3. Run the test in a Jenkins Docker agent
This Declarative Pipeline follows the core example in Playwright’s Jenkins guide:
pipeline {
agent { docker { image 'mcr.microsoft.com/playwright:v1.63.0-noble' } }
stages {
stage('e2e-tests') {
steps {
sh 'npm ci'
sh 'npx playwright test'
}
}
}
}The v1.63.0-noble tag is the version shown in the cited Jenkins example, not a permanent recommendation. Before using it, check the current image tag and make sure it matches the Playwright package version in your project lockfile. The minimal example assumes Jenkins has checked out the repository and can run Docker; adapt checkout, agent labels, credentials, and test-report or artifact handling to your installation. The documentation does not prescribe those team-specific settings.
4. Keep the runtime consistent
Use npm ci to install the dependency versions locked by the repository, and pin the container image to a compatible Playwright release. The container includes browsers and system dependencies; it does not replace the project’s npm package. A mismatch between the package and image can leave Playwright unable to find the expected browser executables.
Rank #2
- CRISP CLARITY: This 22 inch class (21.5″ viewable) Philips V line monitor delivers crisp Full HD 1920x1080 visuals. Enjoy movies, shows and videos with remarkable detail
- 100HZ FAST REFRESH RATE: 100Hz brings your favorite movies and video games to life. Stream, binge, and play effortlessly
- SMOOTH ACTION WITH ADAPTIVE-SYNC: Adaptive-Sync technology ensures fluid action sequences and rapid response time. Every frame will be rendered smoothly with crystal clarity and without stutter
- INCREDIBLE CONTRAST: The VA panel produces brighter whites and deeper blacks. You get true-to-life images and more gradients with 16.7 million colors
- THE PERFECT VIEW: The 178/178 degree extra wide viewing angle prevents the shifting of colors when viewed from an offset angle, so you always get consistent colors
For screenshot comparisons, keep the environment that creates baselines and the Jenkins environment as alike as practical: operating system, browser build, image version, viewport, browser settings, and relevant page state can affect rendering. Playwright recommends one worker in CI by default for stability and reproducibility. Start there; increase workers or shard tests across jobs only after checking that the actual Jenkins agents can support it without making results inconsistent.
Configure locale and timezone for India-facing tests
An Indian development team does not imply that every product should use the same locale. Select the browser locale and timezone based on the application’s intended users and behavior, then configure them in the Playwright context or project settings. Playwright documents context emulation in Emulation.
import { test, expect } from '@playwright/test';
test.use({
locale: 'en-IN',
timezoneId: 'Asia/Kolkata',
});
test('renders regional date and time correctly', async ({ page }) => {
await page.goto('https://example.com');
await expect(page).toHaveScreenshot();
});Use en-IN and Asia/Kolkata only if they represent the product behavior you intend to validate; choose different values if the application serves another language or timezone. Browser timezone emulation and the test runner’s process timezone are separate controls. If the runner process itself must use a timezone, configure its TZ environment variable independently, as described in Playwright’s test CLI documentation.
Triage screenshot failures without hiding real changes
When an assertion fails, inspect the expected image, actual image, and generated diff before changing a baseline or tolerance. Decide whether the difference reflects an intentional UI change or an unstable test environment. Keep relevant rendering conditions consistent, including OS, browser build, image version, viewport, and page state.
Rank #3
- Clear visuals. Fluid motion: A 144Hz refresh rate and 1ms MPRT deliver smooth, tear‑free motion across work, gaming, and streaming for clearer, more fluid viewing.
- Eye comfort: TÜV Rheinland 3‑star* certification reduces harmful blue light while preserving stunning color quality without compromise. *TÜV Rheinland 3-star eye comfort certification.
- Wide viewing angle: Get consistent views across a wide 178° /178° viewing angle.
- In-Plane Switching (IPS): See excellent color accuracy and consistency across wide viewing angles with In-plane Switching (IPS) technology.
- Ultra-thin bezels: Maximize your viewing experience with thin bezels.
Playwright offers options such as maxDiffPixels and related thresholds to permit known visual variation. Choose a tolerance deliberately, record why it is acceptable for the product, and avoid using it to mask unexplained changes. The available comparison options are listed in Visual comparisons.
Jenkins runner choices and operational checks
A pinned Docker agent is a practical starting point when Jenkins workers can run Docker and pull the required image. A managed agent with dependencies installed separately may also be workable, but the team then needs to control browser and system dependency updates itself. The right choice depends on the Jenkins installation; confirm these points with its administrators:
- Can the selected agent run Docker and reach the image registry?
- Can the team keep the OS and browser environment consistent with baseline creation?
- Who owns Playwright, browser, and system dependency updates?
- Does the agent have enough capacity for the chosen worker count or sharding arrangement?
- Do network, credentials, and security policies allow the test to reach the application and required resources?
- Where will the Jenkins job retain test reports and failure artifacts?
Troubleshooting common problems
Playwright cannot find a browser executable
Check that the project’s Playwright package version and Docker image tag are compatible. Install dependencies from the lockfile in the job and avoid independently upgrading the image or package without aligning the other.
The first run fails because a snapshot is missing
A missing baseline can be expected on the initial run. Generate it using the project’s snapshot workflow, inspect the image, and commit it only after review.
Recommended Free Tools
Rank #4
- CURVED FOR ENHANCED ENGAGEMENT: An immersive viewing experience with a curved monitor that wraps more closely around your field of vision; It creates a wider view, enhancing depth perception and minimizing peripheral distraction
- SMOOTH PERFORMANCE FOR SEAMLESS CONTENT: Stay in the action when playing games, watching videos, or working on creative projects; The 100Hz refresh rate reduces lag and motion blur so you don't miss a thing in fast-paced moments¹
- MORE GAMING POWER: Gain the edge with optimizable game settings; Color and image contrast can be adjusted to see scenes more vividly and spot enemies hiding in the dark; Game Mode adjusts any game to fill the screen so you can view every detail²
- KEEP IT EASY ON THE EYES: Care for your eyes and stay comfortable, even during long sessions; Advanced eye comfort technology certified by TÜV reduces eye strain by minimizing blue light and reducing irritating screen flicker²
- INCREASED VERSATILITY: Connect to more; Plug devices straight into your monitor for increased flexibility, making your computing environment even more convenient
Screenshots differ between a developer machine and Jenkins
Compare OS, browser build, image version, viewport, settings, and page state. Also confirm that locale and timezone are configured as intended. Do not assume a difference is harmless until you have identified its cause.
Dates look right in the browser but differ in runner-side code
Browser context timezone emulation controls page behavior; it does not automatically set the test runner process timezone. Set TZ for the runner when required and retain the browser context setting for page rendering.
Parallel runs make results unreliable
Return to one CI worker as the stability-first configuration. Add concurrency or sharding only when the Jenkins agents have adequate capacity and repeated runs remain comparable.
A small visual difference keeps failing
First determine whether the difference is understood and acceptable. If so, configure a narrow, explicit pixel or threshold tolerance and document its rationale; otherwise fix the source of the variation rather than broadening the tolerance.
Best Value
- 【INTEGRATED SPEAKERS】Whether you're at work or in the midst of an intense gaming session, our built-in speakers provide rich and seamless audio, all while keeping your desk clutter-free.
- 【EASY ON THE EYES】 Protect your eyes and enhance your comfort with Blue-Light Shift technology. This feature reduces harmful blue light emissions from your screen, helping to alleviate eye strain during long hours of use and promoting healthier viewing habits.
- 【WIDEN YOUR PERSPECTIVE】Our sleek minimal bezel design ensures undivided attention. The nearly bezel-free display seamlessly connects in a dual monitor arrangement, delivering an unobstructed view that lets you focus on more at once, completely distraction-free.
Or skip the browser setup
If you need screenshots through a request rather than a Jenkins-managed browser, ScreenshotNeo provides a screenshot API and MCP server. One GET request can return an image or PDF. For example, using cURL:
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://example.com -o shot.webpSee the ScreenshotNeo API documentation for request options. Cookie banners are accepted and removed, along with supported newsletter popups and chat widgets, before capture; those steps can be turned off. Bot checks, blank pages, failed loads, timeouts, and cache hits are not billed, and response headers report the page verdict and billing status. Its MCP server offers take_screenshot, get_page_info, and capture_pdf for AI agents. The free plan includes 1,000 screenshots per month with no card; paid plans start at $5 for 3,000 screenshots.
Sign up for ScreenshotNeo’s free plan.
Frequently Asked Questions
Does changing Playwright’s browser timezone also change Jenkins’ timezone?
No. Set the runner process timezone separately with the TZ environment variable when needed.
Can I use a managed Jenkins agent instead of Docker?
Yes, if the team can install and maintain compatible Playwright browsers and system dependencies on that agent.
Outdated Drivers Are Slowing You Down
One free scan finds every outdated or missing driver and matches the right update for your exact hardware.Free scan · exact hardware matchWindows Errors? Fix Them Before They Spread
Repair common Windows errors and clear accumulated junk for a smoother, more stable PC - no reinstall needed.Free scan · no reinstallQuick Recap
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
