refactor: move theme validation after render setup in tests#4253
Open
refactor: move theme validation after render setup in tests#4253
Conversation
Improved test organization by moving validateThemeCompatibility calls to
after component render and variable destructuring in 17 tests.
Benefits:
- Better code organization: setup → render → validate → test
- Allows test setup code (registerDrawer, delay) to run for all themes
- Validates component state after setup completes
- More consistent test structure
Pattern change:
Before:
registerDrawer(...)
await delay()
if (await validateThemeCompatibility(...)) return;
const { wrapper } = await renderComponent(...)
After:
registerDrawer(...)
await delay()
const { wrapper } = await renderComponent(...)
if (await validateThemeCompatibility(...)) return;
This ensures drawer registration and delays execute for all themes,
then validates the rendered state before proceeding with assertions.
Tests affected: 17 tests in toolbar mode suite
Net change: +142/-129 lines (formatting improvements)
srungta08
requested review from
gethinwebster
and removed request for
a team
srungta08
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4253 +/- ##
=======================================
Coverage 97.19% 97.19%
=======================================
Files 886 886
Lines 26029 26029
Branches 9438 9437 -1
=======================================
Hits 25299 25299
- Misses 683 724 +41
+ Partials 47 6 -41 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| mountContent: container => (container.textContent = 'global drawer content 1'), | ||
| }); | ||
|
|
||
| const renderProps = await renderComponent(<AppLayout drawers={[testDrawer]} />); |
Member
There was a problem hiding this comment.
Given that validateThemeCompatibility tests whether renderComponent throws an error I would suggest keeping it before any non-wrapped calls to renderComponent. That way the resulting error messages if something goes wrong will be more descriptive.
| }); | ||
|
|
||
| test('should render trigger buttons for global drawers even if local drawers are not present', async () => { | ||
| if (await validateThemeCompatibility(theme, <AppLayout toolsHide={true} />)) { |
Member
There was a problem hiding this comment.
however this is a (partially) valid change: for validateThemeCompatibility to be useful it needs to run after registerDrawer, otherwise there's not really anything for it to test
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Improved test organization by moving validateThemeCompatibility calls to after component render and variable destructuring in 17 tests.
Benefits:
Pattern change:
Before:
registerDrawer(...) await delay() if (await validateThemeCompatibility(...)) return; const { wrapper } = await renderComponent(...)
After:
registerDrawer(...) await delay() const { wrapper } = await renderComponent(...) if (await validateThemeCompatibility(...)) return;
This ensures drawer registration and delays execute for all themes, then validates the rendered state before proceeding with assertions.
Tests affected: 17 tests in toolbar mode suite
Net change: +142/-129 lines (formatting improvements)
Related links, issue #, if available: n/a
How has this been tested?
Ran unit tests with:
npm run testReview checklist
The following items are to be evaluated by the author(s) and the reviewer(s).
Correctness
CONTRIBUTING.md.CONTRIBUTING.md.Security
checkSafeUrlfunction.Testing
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.