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.

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

fix: enzyme testing replaced by react tester #36301

Closed
wants to merge 5 commits into from

Conversation

jciasenza
Copy link
Contributor

@jciasenza jciasenza commented Feb 25, 2025

Main changes between the first test and the second
Enzyme (used in the first test) is replaced by @testing-library/react, which is the library
currently recommended for testing React components.
Shallow and renderer.create() are removed and RTL render() is used to render components.
Screen, waitFor, and userEvent are used to interact with elements and check their status.
Using userEvent to Simulate Interactions
In the first test, Enzyme's .simulate('click') was used.
In the second test, userEvent.click() is used, which more realistically simulates the interaction of the
user.
Management of Asynchronous States
WaitFor() and act(async () => {}) are added to wait for changes to the DOM, which improves the
test reliability.
Change in Interface Validation
Instead of component.toJSON() and expect(tree).toMatchSnapshot(), now use
expect(container).toMatchSnapshot().
screen.queryByTestId() and screen.getByTestId() are used to check the existence of elements.
Added the following dependencies:
"@testing-library/react": "^12.1.5":
"@testing-library/jest-dom": "^6.6.3":
"@testing-library/user-event": "^12.8.3",
Enzyme dependencies were uninstalled:
"enzyme": "3.11.0",
"enzyme-adapter-react-16": "1.15.8",
"jest-enzyme": "7.1.2",

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 25, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @jciasenza!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.

@jciasenza jciasenza closed this Feb 25, 2025
@jciasenza jciasenza deleted the jci/issue branch February 25, 2025 23:57
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.

2 participants