[Epic]: Migrate from enzyme to testing-library

[ecraig12345]

Part of CDA - internal deadline for this is May 30th 2023.

if your package currently uses Enzyme based test, we recommend that your/team perform the following actions.

• Use React Testing Library (RTL) for authoring ‘new’ test cases starting today.
• Convert all existing Enzyme based test to RTL by 31th May 2023.

We don't have resources to make it till that time, but we should be able to target end of Q1/2 2024.

Background

We'd like to migrate from enzyme to testing-library since enzyme is effectively unmaintained (over a year and no official React 17 adapter) and testing-library provides a better, more reliable testing experience that more closely resembles user interaction.

This has become a higher priority because we'd like to upgrade our repo to React 17 (#20145) but it's being blocked by the lack of an Enzyme adapter. EDIT: Between testing-library and cypress migrations, and possibly fixes to the unofficial adapter, the unofficial adapter now works with our remaining tests. So this is no longer a blocker for in-repo React 17 adoption. It will block React 18 adoption in-repo, but we probably won't be there for a few months at least.

testing-library has an excellent guide to migrating from enzyme -- it's a bit different way of thinking rather than a 1-1 mapping that could be automated, but overall a much better approach.

Steps

• Requested that v8 core team use testing-library for any new tests
• Remove from converged packages
  • this was mostly already done
  • Remove enzyme test setup from converged packages - Remove enzyme test setup code from converged packages #22245
• Remove from react-conformance Port react-conformance tests to testing-library #22009
• Remove from @fluentui/a11y-testing - Convert a11y-testing package to testing-library #22262
• Ban new usage of enzyme APIs with lint rule or danger check
• Work on migrating v8 component tests to RTL (react testing-library)
  • List of Components that need to be converted List of v8 components that need to be converted to use testing-library #22588
  • Could split this up with people
  • Some tests will be ported to cypress instead as it makes sense Enable cypress for v8 #21662
  • react-conformance (Port react-conformance tests to testing-library #22009)
  • Remove config in places where it's not needed and port a couple simple packages to testing-library (Remove Enzyme usage in places it's not needed #22437)
• Remove from v0? (up to n* team)
• Document best practices in wiki: Wiki
  • link to testing-library docs
  • designate a component for demonstrating testing best practices?
  • don't test every single prop? (perf concerns)

Related issues

• Project: Upgrade v8 to React 17 #20507
• Upgrade our Repo to React 17, tests, VR, examples, etc. #20145
• bug: TypeScript target/lib option doesn't constraint ECMA features on type checking within packages #17101

[msft-fluent-ui-bot]

Because this issue has not had activity for over 150 days, we're automatically closing it for house-keeping purposes.

Still require assistance? Please, create a new issue with up-to date details.

[sr-shifu]

Doing deprecation of Enzyme in my project, I figured out there is a way to make this process more manageable and automated: https://thesametech.com/migrate-away-from-enzyme/
Please check out my article, and let me know what you think!

[microsoft-github-policy-service]

Because this issue has not had activity for over 180 days, we're automatically closing it for house-keeping purposes.

Still require assistance? Please, create a new issue with up-to date details.

[microsoft-github-policy-service]

Because this issue has not had activity for over 180 days, we're automatically closing it for house-keeping purposes.

Still require assistance? Please, create a new issue with up-to date details.