Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update tests to remove reliance on UserDefaults #156

Merged
merged 16 commits into from
Feb 8, 2024
Merged

Update tests to remove reliance on UserDefaults #156

merged 16 commits into from
Feb 8, 2024

Conversation

aokj4ck
Copy link
Contributor

@aokj4ck aokj4ck commented Jan 24, 2024 •
edited
Loading

Description

  • Remove all usages of UserDefaults from MapboxSearch and MapboxSearchUI
    • Replaces this with plain dependency injection
  • Add LocalhostMockServiceProvider for integration tests to provide a mocked customBaseURL
  • Add FeedbackIntegrationTestCase back to UI test suite
  • Split MockServerTestCase into UI and Integration variants because it had a namespace collision
  • Utilize customBaseURL for ServiceProvider and LocalhostMockServiceProvider
  • Stop reading from "MapboxAPIBaseURL" from NSUserDefaults in ServiceProvider.createEngine.
    • Providing a value in Info.plist is still supported.
  • Update integration tests to use LocalhostMockServiceProvider
  • This fixes a bug in the Demo app where you building and running the app or tests could use the wrong baseApiURL based on the current value in user defaults.
  • Update and correct tests for iOS 17 using all mocked data for unit and UI tests.
  • Rename SearchEngine.reverseGeocoding function to SearchEngine.reverse.
  • OfflineTests are still failing and will be address later

Checklist

  • Update CHANGELOG

Screenshots

Before After
Screenshot 2024-02-06 at 17 47 49 Screenshot 2024-02-06 at 17 28 38

@aokj4ck
Update tests to remove reliance on UserDefaults
5ae8cb9 
- Remove all usages of UserDefaults from MapboxSearch and MapboxSearchUI
- Add LocalhostMockServiceProvider for integration tests to provide a mocked customBaseURL
- Add FeedbackIntegrationTestCase back to UI test suite
- Split MockServerTestCase into UI and Integration variants because it had a namespace collision
- Utilize customBaseURL for ServiceProvider and LocalhostMockServiceProvider
- Stop reading from NSUserDefaults
- Update integration tests to use LocalhostMockServiceProvider
@aokj4ck aokj4ck marked this pull request as ready for review January 24, 2024 21:39
@aokj4ck aokj4ck requested review from a team as code owners January 24, 2024 21:39
@aokj4ck aokj4ck requested review from Udumft and a user January 24, 2024 21:39
aokj4ck added 13 commits January 30, 2024 16:13
@aokj4ck
Invoke super in UI BaseTestCase setupWithError
fb39170
@aokj4ck
Fix SearchIntegrationTestCase with mock data for forward-geocoding
67cae25
@aokj4ck
Fix Feedback UI test cases
09999d0
@aokj4ck
Remove UI-test-only assert for conflicting with tests
c35774f
@aokj4ck
Fix Visibility UI tests
c38260a
@aokj4ck
Merge branch 'main' of github.com:mapbox/mapbox-search-ios into remov…
e70056d 
…e-userdefaults-from-tests

Conflicts:
	Tests/MapboxSearchIntegrationTests/CategorySearchEngineIntegrationTests.swift
	Tests/MapboxSearchIntegrationTests/SearchEngineIntegrationTests.swift
@aokj4ck
Update Favorites UI tests to work with multiple suggestion mocks by d…
d4f4cb2 
…istinguishing enum cases
@aokj4ck
Flatten MockResponse.endpoint enum into MockResponse and provide path…
0ad5fc1 
…s in MockWebServer

- This moves unit and UI-tested traffic into mocked traffic
@aokj4ck
Fix tests for Category and PlaceAutocomplete queries and mocks
31ab30f
@aokj4ck
Update unit tests
f9c71cb 
- Add more mock data for uncovered cases
- Rename SearchEngine.reverseGeocoding to SearchEngine.reverse
- Fix SearchEngineIntegrationTests to align queries with mock data
@aokj4ck
Update Demo.xctestplan
f1d18e0
@aokj4ck
Accept latest version
1ef42b9
@aokj4ck
Update changelog
bfad92f
azarovalex
azarovalex previously approved these changes Feb 7, 2024
View reviewed changes
@aokj4ck aokj4ck requested a review from azarovalex February 8, 2024 15:41
@aokj4ck aokj4ck merged commit 5188d63 into main Feb 8, 2024
4 checks passed
@aokj4ck aokj4ck deleted the remove-userdefaults-from-tests branch February 8, 2024 16:58
aokj4ck added a commit that referenced this pull request Apr 5, 2024
@aokj4ck
Update tests to remove reliance on UserDefaults (#156)
9fa46a9 
- Remove all usages of UserDefaults from MapboxSearch and MapboxSearchUI
    - Replaces this with plain dependency injection
- Add LocalhostMockServiceProvider for integration tests to provide a mocked customBaseURL
- Add FeedbackIntegrationTestCase back to UI test suite
- Split MockServerTestCase into UI and Integration variants because it had a namespace collision
- Utilize customBaseURL for ServiceProvider and LocalhostMockServiceProvider
- Stop reading from  "MapboxAPIBaseURL" from NSUserDefaults in `ServiceProvider.createEngine`.
    - Providing a value in Info.plist is still supported.
- Update integration tests to use LocalhostMockServiceProvider
- This fixes a bug in the Demo app where you building and running the app or tests could use the wrong baseApiURL based on the current value in user defaults.
- Update and correct tests for iOS 17 using all mocked data for unit and UI tests.
- Rename `SearchEngine.reverseGeocoding` function to `SearchEngine.reverse`.

- [x] Update `CHANGELOG`

| Before | After |
| -- | -- |
| <img width="355" alt="Screenshot 2024-02-06 at 17 47 49" src="https://github.com/mapbox/mapbox-search-ios/assets/384288/f615ad45-efeb-4687-9373-f89d0037c982"> | <img width="356" alt="Screenshot 2024-02-06 at 17 28 38" src="https://github.com/mapbox/mapbox-search-ios/assets/384288/801d518e-c8c2-4403-93f8-1ef2336338c7"> |
Conflicts:
	CHANGELOG.md
	MapboxSearch.xcodeproj/project.pbxproj
	Sources/MapboxSearch/PublicAPI/ServiceProvider.swift
	Tests/MapboxSearchIntegrationTests/CategorySearchEngineIntegrationTests.swift
	Tests/MapboxSearchIntegrationTests/SearchEngineIntegrationTests.swift
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@azarovalex azarovalex azarovalex approved these changes

@Udumft Udumft Awaiting requested review from Udumft Udumft is a code owner automatically assigned from mapbox/search-sdk

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aokj4ck @azarovalex