Update tests to remove reliance on UserDefaults (#156)

### 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`.

### Checklist
- [x] Update `CHANGELOG`

### Screenshots

| 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"> |

CHANGELOG.md

@@ -8,6 +8,10 @@ Guide: https://keepachangelog.com/en/1.0.0/
 
 <!-- Add changes for active work here -->
 
+- [Unit Tests] Update and correct tests for iOS 17 using all mocked data.
+- [UI Tests] Update and correct tests for iOS 17 using all mocked data.
+- [Search] Rename `SearchEngine.reverseGeocoding` function to `SearchEngine.reverse`.
+- [Core] Stop reading "MapboxAPIBaseURL" from UserDefaults in `ServiceProvider.createEngine`. (Providing a value in Info.plist is still supported).
 - [Core] Remove Swifter library dependency from MapboxSearch target (only used in Test targets)
 - [Core] Change AbstractSearchEngine.init `supportSBS: Bool = false` parameter to `apiType: ApiType = .SBS`. This changes the default API engine for discover/category and other API requests to SBS. Add ApiType enum to represent non-Autofill and non-PlaceAutocomplete SearchEngine API types.
 

Sources/Demo/AppDelegate.swift

@@ -12,7 +12,6 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         if ProcessInfo.processInfo.arguments.contains("--uitesting") {
             ServiceProvider.shared.localFavoritesProvider.deleteAll()
             ServiceProvider.shared.localHistoryProvider.deleteAll()
-            UserDefaults.resetStandardUserDefaults()
         }
 
         return true

Sources/MapboxSearch/PublicAPI/Engine/SearchEngine.swift

@@ -450,7 +450,7 @@ extension SearchEngine {
     /// - Parameters:
     ///   - options: Options with coordinates, mode, limits and query types for reverse geocoding.
     ///   - completion: completion handler with either reverse geocoding Resuts or Error.
-    public func reverseGeocoding(
+    public func reverse(
         options: ReverseGeocodingOptions,
         completion: @escaping (Result<[SearchResult], SearchError>) -> Void
     ) {

Sources/MapboxSearch/PublicAPI/ServiceProvider.swift

@@ -27,11 +27,21 @@ public typealias FavoritesProvider = LocalDataProvider<FavoriteRecord>
 /// Built-in local data provider for ``HistoryRecord`` data.
 public typealias HistoryProvider = LocalDataProvider<HistoryRecord>
 
+// MARK: - ServiceProvider
+
 /// Services provider for SearchEngine
 public class ServiceProvider: ServiceProviderProtocol {
-    /// Customize API host URL
+    /// Customize API host URL with a value from the Info.plist
+    /// Also supports reading a process argument when in non-Release UITest builds
     public static var customBaseURL: String? {
-        Bundle.main.object(forInfoDictionaryKey: baseURLPlistKey) as? String
+#if !RELEASE
+        if ProcessInfo.processInfo.arguments.contains(where: { $0 == "--uitesting" }) {
+            let testingBaseUrl = ProcessInfo.processInfo.environment["search_endpoint"]
+            return testingBaseUrl
+        }
+#endif
+
+        return Bundle.main.object(forInfoDictionaryKey: baseURLPlistKey) as? String
     }
 
     /// LocalDataProvider for favorites records
@@ -60,15 +70,10 @@ extension ServiceProvider: EngineProviderProtocol {
         accessToken: String,
         locationProvider: CoreLocationProvider?
     ) -> CoreSearchEngineProtocol {
-        // UserDefaults can be used to setup base url in runtime (e.g. UI tests)
-        // UserDefaults can be used to setup base url in runtime (e.g. UI tests)
-        let defaultsBaseURL = UserDefaults.standard.value(forKey: baseURLPlistKey) as? String
-        let bundleBaseURL = Bundle.main.object(forInfoDictionaryKey: baseURLPlistKey) as? String
-
         MapboxOptions.accessToken = accessToken
 
         let engineOptions = CoreSearchEngine.Options(
-            baseUrl: bundleBaseURL ?? defaultsBaseURL,
+            baseUrl: Self.customBaseURL,
             apiType: NSNumber(value: apiType.rawValue),
             sdkInformation: SdkInformation.defaultInfo,
             eventsUrl: nil

Sources/MapboxSearchUI/MapboxSearchController.swift

@@ -643,7 +643,7 @@ extension MapboxSearchController: SearchCategoriesRootViewDelegate {
             case .success(let items):
                 self.delegate?.categorySearchResultsReceived(category: category, results: items)
             case .failure(let searchError):
-                print("Failed search; error=\(searchError)")
+                _Logger.searchSDK.error("Failed search; error=\(searchError)")
                 self.presentSearchError(searchError)
             }
             self.mapboxPanelController?.setState(.collapsed, animated: true)

Tests/CI-dev.xctestplan

@@ -32,7 +32,6 @@
   "testTargets" : [
     {
       "skippedTests" : [
-        "MockServerTestCase",
         "OfflineIntegrationTests"
       ],
       "target" : {
@@ -43,7 +42,6 @@
     },
     {
       "skippedTests" : [
-        "MockServerTestCase"
       ],
       "target" : {
         "containerPath" : "container:MapboxSearch.xcodeproj",
@@ -55,7 +53,6 @@
       "enabled" : false,
       "skippedTests" : [
         "BaseTestCase",
-        "MockServerTestCase"
       ],
       "target" : {
         "containerPath" : "container:MapboxSearch.xcodeproj",

Tests/Demo.xctestplan

@@ -35,7 +35,7 @@
   "testTargets" : [
     {
       "skippedTests" : [
-        "MockServerTestCase"
+        "MockServerIntegrationTestCase"
       ],
       "target" : {
         "containerPath" : "container:MapboxSearch.xcodeproj",
@@ -44,9 +44,6 @@
       }
     },
     {
-      "skippedTests" : [
-        "MockServerTestCase"
-      ],
       "target" : {
         "containerPath" : "container:MapboxSearch.xcodeproj",
         "identifier" : "3A0D7E54233522D4006D81BB",
@@ -56,7 +53,7 @@
     {
       "skippedTests" : [
         "BaseTestCase",
-        "MockServerTestCase"
+        "MockServerUITestCase"
       ],
       "target" : {
         "containerPath" : "container:MapboxSearch.xcodeproj",

Tests/MapboxSearchIntegrationTests/AddressAutofillIntegrationTests.swift

@@ -2,15 +2,30 @@ import CoreLocation
 @testable import MapboxSearch
 import XCTest
 
-final class AddressAutofillIntegrationTests: MockServerTestCase {
+final class AddressAutofillIntegrationTests: MockServerIntegrationTestCase {
     private var addressAutofill: AddressAutofill!
+    private let locationProvider = WrapperLocationProvider(wrapping: DefaultLocationProvider())
 
     override func setUp() {
         super.setUp()
 
-        addressAutofill = AddressAutofill(
+        let reporter = CoreUserActivityReporter.getOrCreate(
+            for: CoreUserActivityReporterOptions(
+                sdkInformation:
+                SdkInformation.defaultInfo,
+                eventsUrl: nil
+            )
+        )
+
+        let engine = LocalhostMockServiceProvider.shared.createEngine(
+            apiType: CoreSearchEngine.ApiType.autofill,
             accessToken: "access-token",
-            locationProvider: DefaultLocationProvider()
+            locationProvider: locationProvider
+        )
+
+        addressAutofill = AddressAutofill(
+            searchEngine: engine,
+            userActivityReporter: reporter
         )
     }
 

Tests/MapboxSearchIntegrationTests/CategorySearchEngineIntegrationTests.swift

@@ -2,18 +2,24 @@ import CoreLocation
 @testable import MapboxSearch
 import XCTest
 
-class CategorySearchEngineIntegrationTests: MockServerTestCase {
-    lazy var searchEngine = CategorySearchEngine(
-        accessToken: "access-token",
-        locationProvider: DefaultLocationProvider(),
-        apiType: .SBS
-    )
+final class CategorySearchEngineIntegrationTests: MockServerIntegrationTestCase {
+    private var searchEngine: CategorySearchEngine!
+
+    override func setUp() {
+        super.setUp()
+
+        searchEngine = CategorySearchEngine(
+            accessToken: "access-token",
+            serviceProvider: LocalhostMockServiceProvider.shared,
+            apiType: .SBS
+        )
+    }
 
     func testCategorySearch() throws {
         try server.setResponse(.categoryCafe)
 
         let expectation = XCTestExpectation(description: "Expecting results")
-        searchEngine.search(categoryName: "ATM") { result in
+        searchEngine.search(categoryName: "cafe") { result in
             switch result {
             case .success(let searchResults):
                 XCTAssertFalse(searchResults.isEmpty)
@@ -30,7 +36,7 @@ class CategorySearchEngineIntegrationTests: MockServerTestCase {
         try server.setResponse(.categoryCafe, statusCode: 500)
 
         let expectation = XCTestExpectation(description: "Expecting failure")
-        searchEngine.search(categoryName: "ATM") { result in
+        searchEngine.search(categoryName: "cafe") { result in
             switch result {
             case .success:
                 XCTFail("Not expected")

Tests/MapboxSearchIntegrationTests/LocalhostMockServiceProvider.swift

@@ -0,0 +1,47 @@
+@testable import MapboxSearch
+import XCTest
+
+class LocalhostMockServiceProvider: ServiceProviderProtocol {
+    public static var customBaseURL: String?
+
+    /// LocalDataProvider for favorites records
+    public let localFavoritesProvider = FavoritesProvider()
+    /// LocalDataProvider for history records
+    public let localHistoryProvider = HistoryProvider()
+    /// MapboxMobileEvents manager for analytics usage
+    public let eventsManager = EventsManager()
+
+    /// Responsible for sending feedback related events.
+    public private(set) lazy var feedbackManager = FeedbackManager(eventsManager: eventsManager)
+
+    /// Shared instance of ServiceProvider
+    public static let shared = LocalhostMockServiceProvider()
+
+    var dataLayerProviders: [IndexableDataProvider] { [localHistoryProvider, localFavoritesProvider] }
+}
+
+extension LocalhostMockServiceProvider: EngineProviderProtocol {
+    func getStoredAccessToken() -> String? {
+        Bundle.main.object(forInfoDictionaryKey: accessTokenPlistKey) as? String
+    }
+
+    func createEngine(
+        apiType: CoreSearchEngine.ApiType,
+        accessToken: String,
+        locationProvider: CoreLocationProvider?
+    ) -> CoreSearchEngineProtocol {
+        MapboxOptions.accessToken = accessToken
+
+        let engineOptions = CoreSearchEngine.Options(
+            baseUrl: Self.customBaseURL,
+            apiType: NSNumber(value: apiType.rawValue),
+            sdkInformation: SdkInformation.defaultInfo,
+            eventsUrl: nil
+        )
+
+        return CoreSearchEngine(
+            options: engineOptions,
+            location: locationProvider
+        )
+    }
+}

Tests/MapboxSearchIntegrationTests/MockServerTestCase.swift → Tests/MapboxSearchIntegrationTests/MockServerIntegrationTestCase.swift

@@ -2,7 +2,7 @@ import CoreLocation
 @testable import MapboxSearch
 import XCTest
 
-class MockServerTestCase: XCTestCase {
+class MockServerIntegrationTestCase: XCTestCase {
     let server = MockWebServer()
 
     func setServerResponse(_ response: MockResponse, query: String? = nil) throws {
@@ -12,7 +12,7 @@ class MockServerTestCase: XCTestCase {
     override func setUpWithError() throws {
         try super.setUpWithError()
 
-        UserDefaults.standard.setValue(server.endpoint, forKey: "MapboxAPIBaseURL")
+        LocalhostMockServiceProvider.customBaseURL = server.endpoint
 
         try server.start()
     }

Tests/MapboxSearchIntegrationTests/OfflineIntegrationTests.swift

@@ -6,7 +6,7 @@ import MapboxCommon
 @testable import MapboxSearch
 import XCTest
 
-class OfflineIntegrationTests: MockServerTestCase {
+class OfflineIntegrationTests: MockServerIntegrationTestCase {
     let delegate = SearchEngineDelegateStub()
     let searchEngine = SearchEngine()
 

Tests/MapboxSearchIntegrationTests/PlaceAutocompleteIntegrationTests.swift

@@ -2,15 +2,29 @@ import CoreLocation
 @testable import MapboxSearch
 import XCTest
 
-final class PlaceAutocompleteIntegrationTests: MockServerTestCase {
+final class PlaceAutocompleteIntegrationTests: MockServerIntegrationTestCase {
     private var placeAutocomplete: PlaceAutocomplete!
 
     override func setUp() {
         super.setUp()
 
-        placeAutocomplete = PlaceAutocomplete(
+        let reporter = CoreUserActivityReporter.getOrCreate(
+            for: CoreUserActivityReporterOptions(
+                sdkInformation:
+                SdkInformation.defaultInfo,
+                eventsUrl: nil
+            )
+        )
+
+        let engine = LocalhostMockServiceProvider.shared.createEngine(
+            apiType: CoreSearchEngine.ApiType.SBS,
             accessToken: "access-token",
-            locationProvider: DefaultLocationProvider()
+            locationProvider: WrapperLocationProvider(wrapping: DefaultLocationProvider())
+        )
+
+        placeAutocomplete = PlaceAutocomplete(
+            searchEngine: engine,
+            userActivityReporter: reporter
         )
     }
 
@@ -21,7 +35,7 @@ final class PlaceAutocompleteIntegrationTests: MockServerTestCase {
         try server.setResponse(.retrieveSanFrancisco)
 
         var suggestion: PlaceAutocomplete.Suggestion?
-        placeAutocomplete.suggestions(for: "query") { result in
+        placeAutocomplete.suggestions(for: "San Francisco") { result in
             switch result {
             case .success(let suggestions):
                 XCTAssertEqual(suggestions.count, 10)

Tests/MapboxSearchIntegrationTests/SearchEngineGeocodingIntegrationTests.swift

@@ -0,0 +1,54 @@
+import CoreLocation
+@testable import MapboxSearch
+import XCTest
+
+class SearchEngineGeocodingIntegrationTests: MockServerIntegrationTestCase {
+    let delegate = SearchEngineDelegateStub()
+    var searchEngine: SearchEngine!
+
+    override func setUp() {
+        super.setUp()
+
+        searchEngine = SearchEngine(
+            accessToken: "access-token",
+            serviceProvider: LocalhostMockServiceProvider.shared,
+            locationProvider: DefaultLocationProvider(),
+            apiType: .geocoding
+        )
+
+        searchEngine.delegate = delegate
+    }
+
+    func testReverseGeocodingSearch() throws {
+        try server.setResponse(.reverseGeocoding)
+
+        let expectation = XCTestExpectation()
+        let options = ReverseGeocodingOptions(point: CLLocationCoordinate2D(latitude: 12.0, longitude: 12.0))
+
+        // Search engine is a SBS type!
+        searchEngine.reverse(options: options) { result in
+            if case .success(let reverseGeocodingResults) = result {
+                XCTAssertFalse(reverseGeocodingResults.isEmpty)
+            } else {
+                XCTFail("No resolved result")
+            }
+            expectation.fulfill()
+        }
+
+        wait(for: [expectation], timeout: 10)
+    }
+
+    func testReverseGeocodingSearchFailed() throws {
+        try server.setResponse(.reverseGeocoding, statusCode: 500)
+
+        let expectation = XCTestExpectation()
+        let options = ReverseGeocodingOptions(point: CLLocationCoordinate2D(latitude: 12.0, longitude: 12.0))
+        searchEngine.reverse(options: options) { result in
+            if case .failure(.reverseGeocodingFailed(let reasonError as NSError, _)) = result {
+                XCTAssert(reasonError.code == 500)
+                expectation.fulfill()
+            }
+        }
+        wait(for: [expectation], timeout: 10)
+    }
+}