Skip to content

Conversation

@vmnavarro94
Copy link
Contributor

@vmnavarro94 vmnavarro94 commented Jun 9, 2025

Description

Remove use of 'shallow' (react-unit-test-utils) in following files, when needed we also removed snapshot to create new unit tests:

  • src/components/ConfirmModal.test.jsx
  • src/components/DemoAlert/index.test.jsx
  • src/components/FilePopoverContent/index.test.jsx
  • src/components/FilePreview/FileCard.test.jsx
  • src/components/StatusBadge.test.jsx

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 #425

@openedx-webhooks
Copy link

Thanks for the pull request, @vmnavarro94!

This repository is currently maintained by @codewithemad.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 9, 2025
@vmnavarro94 vmnavarro94 requested a review from Copilot June 9, 2025 19:15
@vmnavarro94 vmnavarro94 self-assigned this Jun 9, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jun 9, 2025
@vmnavarro94 vmnavarro94 changed the title depr: deprecate react-unit-test-utils part-1 test: deprecate react-unit-test-utils part-1 Jun 9, 2025
@codecov
Copy link

codecov bot commented Jun 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (fc7370c) to head (cc4b1c8).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #426   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          107       107           
  Lines         1078      1078           
  Branches       160       160           
=========================================
  Hits          1078      1078           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

This comment was marked as outdated.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR deprecates the use of react-unit-test-utils (and its shallow rendering) in favor of react-testing-library for several component tests. Key changes include removing snapshot tests, updating rendering methods, and unmocking necessary modules for proper testing.

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/components/snapshots/StatusBadge.test.jsx.snap Removed snapshot file
src/components/snapshots/ConfirmModal.test.jsx.snap Removed snapshot file
src/components/StatusBadge.test.jsx Replaced shallow rendering with RTL and updated test logic for status variants
src/components/FilePreview/snapshots/FileCard.test.jsx.snap Removed snapshot file
src/components/FilePreview/FileCard.test.jsx Updated tests to use RTL and proper element queries
src/components/FilePopoverContent/index.test.jsx Replaced shallow rendering with RTL and updated test cases
src/components/FilePopoverContent/snapshots/index.test.jsx.snap Removed snapshot file
src/components/DemoAlert/index.test.jsx Updated RTL tests and added event testing for onClose callback
src/components/DemoAlert/snapshots/index.test.jsx.snap Removed snapshot file
src/components/ConfirmModal.test.jsx Updated tests with RTL and added assertions for modal open/closed states
Comments suppressed due to low confidence (1)

src/components/StatusBadge.test.jsx:16

  • The test uses getByText('FormattedMessage') to find the badge element, which may be too generic and brittle; consider querying for a more specific text or using a test id for reliable selection.
it('`ungraded` shows primary button variant and message', () => {

Co-authored-by: Ayesha Waris <ayesha.waris@192.168.10.31>
@vmnavarro94 vmnavarro94 requested a review from CodeWithEmad June 9, 2025 20:09
@vmnavarro94 vmnavarro94 moved this from Needs Triage to Ready for Review in Contributions Jun 9, 2025
Copy link
Contributor

@arbrandes arbrandes left a comment

Choose a reason for hiding this comment

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

Thank you for starting this refactor! Approved!

@arbrandes arbrandes merged commit 5a38347 into openedx:master Jun 11, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Jun 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Deprecate react-test-utils P-1

5 participants