Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduce visual testing mechanism to KDS #742

Open
wants to merge 68 commits into
base: nodejs-upgrade
Choose a base branch
from
Open

Introduce visual testing mechanism to KDS #742

wants to merge 68 commits into from

Conversation

KshitijThareja
Copy link
Contributor

@KshitijThareja KshitijThareja commented Aug 21, 2024 •
edited by rtibbles
Loading

Description

This PR aims to merge the work done to integrate the visual testing mechanism to KDS's workflows from the gsoc/visual-testing branch to the nodejs-upgrade branch so as to bring everything together at one place and ensure that the upgrade comes with the new visual testing setup.

Changelog

  • Description: Introduce visual testing mechanism for KDS.
  • Products impact: -
  • Addresses: -
  • Components: -
  • Breaking: -
  • Impacts a11y: -
  • Guidance: -

Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical and brittle code paths are covered by unit tests
  • The change is described in the changelog section above

Reviewer guidance

  • Is the code clean and well-commented?
  • Are there tests for this change?
  • Are all UI components LTR and RTL compliant (if applicable)?
  • Add other things to check for here

After review

  • The changelog item has been pasted to the CHANGELOG.md

Comments

KshitijThareja and others added 30 commits June 19, 2024 19:39
@KshitijThareja
Setup initial configuration
9abf33e
@KshitijThareja
Add and configure percy for visual tests
9b01670
@KshitijThareja
Change server configuration and file names for visual tests
f01b65d
@KshitijThareja
Add component rendering mechanism for visual testing
a538bf2
@KshitijThareja
Remove unused packages
1ffca8e
@KshitijThareja
Add JSDoc for testing playground and modify server script
d9e1d14
@KshitijThareja
Update KImg unit tests and eslint configuration
519dd63
@KshitijThareja
Use concurrently to manage startup and termination of tests
64301f8
@KshitijThareja
Update waitForServer function to use http
759ef28
@KshitijThareja
Remove unused dependencies and separate visual tests from yarn test
1bc6ea1
@KshitijThareja
Separate visual tests from yarn test command
2b06d96
@bjester
Merge pull request learningequality#670 from KshitijThareja/visual-te…
905e770 
…sting

Percy and jest-puppeteer environment setup for visual testing
@KshitijThareja
Introduce abstraction for component rendering functions and support f…
65a08d4 
…or custom describe blocks
@KshitijThareja
Initial workflow config
d2ea3d1
@KshitijThareja
Fix the initial workflow for visual tests job
8ce5fe8
@KshitijThareja
Merge branch 'gsoc/visual-testing' into vt-add-concurrently
fde157f
@bjester
Merge pull request learningequality#677 from KshitijThareja/vt-add-co…
3ef3ee1 
…ncurrently

Replace custom checks from the server script to use concurrently
@KshitijThareja
Add automatic comments job for visual testing workflow
2eaabdb
@KshitijThareja
Fix lint errors
310f75b
@KshitijThareja
Abstraction for page navigation
f6c66f3
@KshitijThareja
Fix lint errors
1eba82f
@KshitijThareja
Merge branch 'gsoc/visual-testing' into vt-abstraction
c37ddd3
@KshitijThareja
Introduce visual testing to the existing Javascript tests workflow
f4373a0
@KshitijThareja
Introduce visual testing to the existing Javascript tests workflow
bdea16d
@KshitijThareja
Introduce visual testing to the existing Javascript tests workflow
eb95513
@KshitijThareja
Replace usage of custom describe blocks with test regex patterns
c0e977f
@KshitijThareja
Merge branch 'vt-abstraction' of github.com:KshitijThareja/kolibri-de…
95228a2 
…sign-system into vt-abstraction
@KshitijThareja
Remove unintentional changes
61c98f9
@KshitijThareja
Add comments for rendering function and make variable names clear
fde97db
@KshitijThareja
Remove run server step
ad6c1d5
AlexVelezLl and others added 27 commits August 7, 2024 09:07
@AlexVelezLl
Checkout pr head
97dbb74
@AlexVelezLl
Update should skip to include style changes
bf8a172
@KshitijThareja
Initial documentation for visual tests
9b4861d
@KshitijThareja
Update comment job to use github-script action
10a1d40
@KshitijThareja
Update visual testing docs with links to mentioned files
6dc4cab
@KshitijThareja
Update documentation
981aab9
@KshitijThareja
Updat comment job to use utils file
0ff28b9
@KshitijThareja
Migrate findComment and generateComment functions to githubUtils.js
d536c84
@KshitijThareja
Add reference to documentation in getting-started doc
cdbf6ca
@AlexVelezLl
Merge pull request learningequality#720 from KshitijThareja/vt-ghaction
1a28076 
[Visual Testing] Update comment job in workflow to use custom script
@AlexVelezLl
Update jsdoc
05809de
@AlexVelezLl
Merge branch 'gsoc/visual-testing' into vt-test
855a5a2
@AlexVelezLl
Merge branch 'gsoc/visual-testing' into vt-test
d1ead28
@KshitijThareja
Modify testing playground to render named and default slots in a sing…
798dd24 
…le template
@KshitijThareja
Add jsdocs for renderComponent and takeSnapshot functions
b84eafa
@KshitijThareja
Fix lint error
384e593
@KshitijThareja
Remove async from describe block
9471e37
@KshitijThareja
Merge branch 'vt-test' of https://github.com/KshitijThareja/kolibri-d…
6f3ab99 
…esign-system into vt-test
@KshitijThareja
Add snapshot options specifying test widths
625cff0
@AlexVelezLl
Merge pull request learningequality#710 from KshitijThareja/vt-test
3bddaab 
Implement visual tests for KButton component
@KshitijThareja
Update test command to work for all test files
5c079b5
@KshitijThareja
Merge branch 'gsoc/visual-testing' into vt-doc
80cceae
@KshitijThareja
Add additional info for rendering complex components
176a971
@KshitijThareja
Add link to percy documentation
6e06337
@KshitijThareja
Update info for usage of test blocks for visual tests
33435a3
@KshitijThareja
Update required node version specification
28e3c40
@AlexVelezLl
Merge pull request learningequality#721 from KshitijThareja/vt-doc
ac305aa 
[Visual Testing] Add documentation for the testing mechanism
@KshitijThareja KshitijThareja changed the base branch from nodejs-upgrade to develop December 17, 2024 15:43
@KshitijThareja KshitijThareja changed the base branch from develop to nodejs-upgrade December 17, 2024 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@KshitijThareja @bjester @AlexVelezLl