Fix test isolation of accordion component tests #2301
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
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-2301
The unit tests for the accordion component can interfere with each
other, because within a test suite Puppeteer browser instances are
shared, and the accordion component has state stored in the browser
session storage. This is especially a problem for any tests after
`it('should maintain the expanded state after a page refresh')`, which
leaves all the accordion sections opened.
This commit adds a simple teardown function to clear the session storage
after each test. It just so happens that our current tests behave the
same and still pass with the teardown function, but we should fix this
problem now, to prevent any future tests from being affected by the
state of our current tests, such as for the accordion design refresh in
PR #2257.
lfdebrux
force-pushed
the
ldeb-fix-accordion-test-isolation
branch
from
b754b2d to
1198bda
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-2301
vanitabarrett
approved these changes
Aug 10, 2021
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.
The unit tests for the accordion component can interfere with each other, because within a test suite Puppeteer browser instances are shared, and the accordion component has state stored in the browser session storage. This is especially a problem for any tests after
it('should maintain the expanded state after a page refresh'), which leaves all the accordion sections opened.This PR adds a simple teardown function to clear the session storage after each test. It just so happens that our current tests behave the same and still pass with the teardown function, but we should fix this problem now, to prevent any future tests from being affected by the state of our current tests, such as for the accordion design refresh in PR #2257 (which is how this problem was discovered in the first place).
We should look at test isolation in general for this repo, but that is a bigger task for a different day; this PR is just to make sure we fix the thing we know to be an active issue.