openedx / openedx/paragon

Visual regression testing

Open
#1,291 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #1402 by @peterkulko — closed without merging
  • #1537 by @peterkulko — closed without merging
raccoon-gang
Dominant language
JavaScript
Stars
140
Forks
100
Avg merge
1h 3m
Merged PRs (30d)
30

Description

https://blog.logrocket.com/automated-visual-regression-testing-with-jest/

Explore use of jest-image-snapshot and jsdom-screenshot to automate testing for regressions in visual styles.

Some initial concerns:

  • "Works on my machine". Running tests in a docker container could help mitigate this.

AC

  • Implement prototype of visual regression testing (potentially using above libraries?) for at least 2-3 components.
  • Understand the "noise" thresholds of "works on my machine" issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked LogRocket article and evaluate the proposed jest-image-snapshot and jsdom-screenshot libraries. Prototype visual regression coverage for 2–3 components, investigate whether running tests in Docker reduces machine-specific differences, and document the observed noise thresholds.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
design, frontend, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.