test: deprecate react-unit-test-utils part-2 #428
Conversation
|
Thanks for the pull request, @vmnavarro94! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
openedx-webhooks
added
the
open-source-contribution
vmnavarro94
requested review from
diana-villalvazo-wgu,
jacobo-dominguez-wgu and
wgu-jesse-stewart
There was a problem hiding this comment.
Pull Request Overview
This PR deprecates the use of react-unit-test-utils’ shallow rendering and snapshots, replacing them with @testing-library/react calls to improve test reliability and consistency. Key changes include:
- Removal of snapshot files and shallow renderings.
- Replacement of shallow tests with render, screen, and fireEvent calls.
- Unmocking of @openedx/paragon and react modules to avoid interference in tests.
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| snapshots files | Removed outdated snapshot files for FileRenderer, FileInfo, ImageRenderer, LoadingBanner, and ErrorBanner tests |
| FileRenderer.test.jsx | Updated tests with render/screen and improved assertions for loading and error states |
| FileInfo.test.jsx | Replaced shallow rendering with testing-library rendering and added click handlers |
| ImageRenderer.test.jsx | Revised tests to simulate image load/error events using dispatchEvent |
| Banners tests | Updated tests for LoadingBanner and ErrorBanner using testing-library and unmocking modules |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #428 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 107 107
Lines 1078 1078
Branches 158 158
=========================================
Hits 1078 1078 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
3 participants
Description
Remove use of 'shallow' (react-unit-test-utils) in following files, when needed we also removed snapshot to create new unit tests:
Note: As part of this work we find out paragon components were mocked on src/setupTest.jsx causing testing library unit tests to fail, since we are doing this work in multiple PRs and in order to not break other existing snapshot tests, we will unmock paragon or needed things on new tests and by end of react-unit-test-utils removal we will remove paragon mocks and unmock lines accordingly.
Support Information
Closes #427