ESLint: Enable testing-library/no-container rule
#46160
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tyxla
requested review from
Mamaduka,
mirka,
jsnajdr,
ciampo,
flootr,
ntsekouras and
brookewp
tyxla
commented
Nov 29, 2022
| @@ -369,7 +369,6 @@ module.exports = { | |||
| 'plugin:testing-library/react', | |||
| ], | |||
| rules: { | |||
| 'testing-library/no-container': 'off', | |||
There was a problem hiding this comment.
This rule is automatically enabled when we include the testing-library/react plugin above.
Comment on lines
+411
to
+420
| const searchResults = within( | ||
| screen.getByRole( 'listbox', { | ||
| name: /Search results for.*/, | ||
| } ) | ||
| ).getAllByRole( 'option' ); | ||
|
|
||
| const searchResultTextHighlightElements = Array.from( searchResults ) | ||
| .map( ( result ) => result.querySelector( 'mark' ) ) | ||
| .flat() | ||
| .filter( Boolean ); |
There was a problem hiding this comment.
We're changing the way we query for those mark elements to use screen queries.
| @@ -48,9 +48,11 @@ describe( 'RangeControl', () => { | |||
| /> | |||
| ); | |||
|
|
|||
| // eslint-disable-next-line testing-library/no-container | |||
There was a problem hiding this comment.
There's no better way to query for this with a screen query.
| const beforeIcon = container.querySelector( | ||
| '.dashicons-format-image' | ||
| ); | ||
| // eslint-disable-next-line testing-library/no-container |
There was a problem hiding this comment.
There's no better way to query for this with a screen query.
| expect( | ||
| container.querySelector( '.has-left-divider button' ) | ||
| ).toBe( buttons[ 1 ] ); | ||
| expect( buttons[ 0 ].parentElement ).not.toHaveClass( |
There was a problem hiding this comment.
Fixing it that way will create a no-node-access violation, but we'll take care of that separately by either ignoring it or fixing it. One step at a time!
| @@ -184,6 +184,7 @@ describe( 'Tooltip', () => { | |||
| // Note: this is testing for implementation details, | |||
| // but couldn't find a better way. | |||
| const buttonRect = button.getBoundingClientRect(); | |||
| // eslint-disable-next-line testing-library/no-container | |||
There was a problem hiding this comment.
This element is not accessible by design, so querying it that way makes sense.
| const eventCatcher = | ||
| container.getElementsByClassName( 'event-catcher' )[ 0 ]; | ||
| // eslint-disable-next-line testing-library/no-container | ||
| const eventCatcher = container.querySelector( '.event-catcher' ); |
There was a problem hiding this comment.
Using the same query as above. This element is not accessible by design, so querying it that way makes sense.
| @@ -115,6 +115,7 @@ describe( 'UnitControl', () => { | |||
| withoutClassName.querySelector( '.components-unit-control' ) | |||
| ).not.toHaveClass( 'hello' ); | |||
| expect( | |||
| // eslint-disable-next-line testing-library/no-container | |||
There was a problem hiding this comment.
There's no better way to access this wrapper element. Alternatively, we could use .parentElement to traverse to it, but it wouldn't be better since it would introduce a no-node-access violation.
There was a problem hiding this comment.
Sometimes in these scenarios I like to use toMatchDiffSnapshot, and I would expect to see as the only line in the snapshot the one showing the hello classname
There was a problem hiding this comment.
Why not! Done in 3d7d8a9. There's one more line difference, but that's expected since the two unit controls have different IDs.
There was a problem hiding this comment.
Reverted. This may generate additional differences so it's not suitable for a snapshot test.
There was a problem hiding this comment.
Good to know, thanks for testing that approach!
|
Size Change: +1.41 kB (0%) Total Size: 1.32 MB
ℹ️ View Unchanged
|
This reverts commit 3d7d8a9.
mpkelly
pushed a commit
to mpkelly/gutenberg
that referenced
this pull request
Dec 7, 2022
* ESLint: Enable testing-library/no-container rule * Use toMatchDiffSnapshot * Revert "Use toMatchDiffSnapshot" This reverts commit 3d7d8a9.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Back when we enabled the
testing-library/reactESLint plugin, we disabled some rules that needed fixing. We fixed a bunch of them and now it's time to re-enabletesting-library/no-container.Why?
Our end goal is to follow the best practices of the
@testing-library/reactlibrary for writing tests.How?
We're fixing some violations at the last minute, and for others, we're disabling inline, because they can't be fixed without a solid component refactor.
I'm leaving a self-review to clarify each instance separately.
Testing Instructions
Verify all checks are green - tests pass and there are no new ESLint errors.