-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
Add FXIOS-10094 [Unit Tests] Add store utility for tests #22172
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
34 changes: 34 additions & 0 deletions
34
firefox-ios/firefox-ios-tests/Tests/ClientTests/Utils/StoreTestUtility.swift
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| // This Source Code Form is subject to the terms of the Mozilla Public | ||
| // License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| // file, You can obtain one at http://mozilla.org/MPL/2.0/ | ||
|
|
||
| import Foundation | ||
| import Redux | ||
| @testable import Client | ||
|
|
||
| protocol StoreTestUtility { | ||
| func setupAppState() -> AppState | ||
| func setupTestingStore() | ||
| func resetTestingStore() | ||
| } | ||
|
|
||
| /// Utility class used when replacing the global store for testing purposes | ||
| class StoreTestUtilityHelper { | ||
| func setupTestingStore(with appState: AppState, middlewares: [Middleware<AppState>]) { | ||
| store = Store( | ||
| state: appState, | ||
| reducer: AppState.reducer, | ||
| middlewares: middlewares | ||
| ) | ||
| } | ||
|
|
||
| /// In order to avoid flaky tests, we should reset the store | ||
| /// similar to production | ||
| func resetTestingStore() { | ||
cyndichin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| store = Store( | ||
| state: AppState(), | ||
| reducer: AppState.reducer, | ||
| middlewares: middlewares | ||
| ) | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my opinion i think we might not need this protocol, i'd just add the
StoreTestUtilityHelperdirectly as property of the Tester class. Let me know what you think! thanks @cyndichin 😃There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the comment! Hmm, I wanted a way to ensure that any test that uses the store will conform to the protocol, which will throw compiler errors if the user does not have the setup or reset methods and then can use the
StoreTestUtilityHelperfor convenience. Happy to remove if you don't think it's useful though.Does it seem unnecessary extra code for you? Do you think we should open up to the team?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah ok Thank you for clarifying @cyndichin yes that makes sense to me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great, thanks! I'll also present this to the team tomorrow as well so can keep this PR open until then.