[MOB-10402] Fix Tests #876

sumeruchat · 2024-12-13T11:58:53Z

🔹 Jira Ticket(s)

MOB-10402

✏️ Description

Add nice reports for tests

Example https://github.com/Iterable/iterable-swift-sdk/actions/runs/12316457995

joaodordio · 2024-12-16T18:27:26Z

@sumeruchat should we remove the other changes other than the part that add the report?

sumeruchat · 2024-12-16T19:21:23Z

@joaodordio Yeah sure I can undo those but those make sense rite? Should i add that in a seperate PR?

joaodordio · 2024-12-16T19:31:51Z

@joaodordio Yeah sure I can undo those but those make sense rite? Should i add that in a seperate PR?

absolutely, I've added those here: #872

sumeruchat · 2024-12-16T19:34:20Z

yeah once you merge your branch i will rebase

sumeruchat · 2025-03-03T16:28:25Z

@joaodordio @evantk91 @Ayyanchira Please note that the following tests are disabled

    "AuthTests\/testAsyncAuthTokenRetrieval()",
    "AuthTests\/testAuthTokenChangeWithSameEmail()",
    "AuthTests\/testAuthTokenChangeWithSameUserId()",
    "AuthTests\/testAuthTokenDeletedOnLogout()",
    "AuthTests\/testAuthTokenRetrievalFailureReset()",
    "AuthTests\/testEmailWithTokenPersistence()",
    "AuthTests\/testLogoutUser()",
    "AuthTests\/testNewEmailAndThenChangeToken()",
    "AuthTests\/testNewUserIdAndThenChangeToken()",
    "AuthTests\/testOnNewAuthTokenCallbackCalled()",
    "AuthTests\/testPushRegistrationAfterAuthTokenRetrieval()",
    "AuthTests\/testRefreshTimerQueueRejection()",
    "AuthTests\/testRetryJwtFailure()",
    "AuthTests\/testUpdateEmailAndThenChangeToken()",
    "AuthTests\/testUpdateEmailWithTokenParam()",
    "AuthTests\/testUserIdWithTokenPersistence()",
    "AutoRegistrationTests\/testCallDisableAndEnable()",
    "RequestCreatorTests\/testRegisterTokenRequestPrefersUserId()"
    
    We need to make a ticket to investigate why these are failing.

joaodordio · 2025-03-04T16:51:16Z

@joaodordio @evantk91 @Ayyanchira Please note that the following tests are disabled

    "AuthTests\/testAsyncAuthTokenRetrieval()",
    "AuthTests\/testAuthTokenChangeWithSameEmail()",
    "AuthTests\/testAuthTokenChangeWithSameUserId()",
    "AuthTests\/testAuthTokenDeletedOnLogout()",
    "AuthTests\/testAuthTokenRetrievalFailureReset()",
    "AuthTests\/testEmailWithTokenPersistence()",
    "AuthTests\/testLogoutUser()",
    "AuthTests\/testNewEmailAndThenChangeToken()",
    "AuthTests\/testNewUserIdAndThenChangeToken()",
    "AuthTests\/testOnNewAuthTokenCallbackCalled()",
    "AuthTests\/testPushRegistrationAfterAuthTokenRetrieval()",
    "AuthTests\/testRefreshTimerQueueRejection()",
    "AuthTests\/testRetryJwtFailure()",
    "AuthTests\/testUpdateEmailAndThenChangeToken()",
    "AuthTests\/testUpdateEmailWithTokenParam()",
    "AuthTests\/testUserIdWithTokenPersistence()",
    "AutoRegistrationTests\/testCallDisableAndEnable()",
    "RequestCreatorTests\/testRegisterTokenRequestPrefersUserId()"
    
    We need to make a ticket to investigate why these are failing.

Some of these seem rather important to be skipping right? They also look like simple tests — meaning they shouldn't be failing right?

Do we know what's behind the failure before we commit to skipping them?

Also, should we remove the codecov.io step? We are not using that anymore.

Ayyanchira · 2025-03-05T18:03:00Z

Yes Code cov may be worked on when working on reporting tools. But I agree its important to document why those are failing before skipping them

sumeruchat · 2025-03-06T19:33:47Z

I fixed some more tests the final list of skipped tests is now

From unit-tests:
AuthTests.testOnNewAuthTokenCallbackCalled()
AuthTests.testRetryJwtFailure()
InAppTests.testMultipleMesssagesInShortTime()
IterableAPIResponseTests.testRetryOnInvalidJwtPayload()
From offline-events-tests:
HealthMonitorTests.testDeleteAllTasksException()
RequestHandlerTests.testDeleteAllTasksOnLogout()
TaskSchedulerTests.testScheduleTask()

sumeruchat · 2025-03-06T19:34:37Z

Lets look at code coverage in the CI reporting task. Here lets focus on fixing tests. It would be awesome if you guys can help fixing the remaining tests. @Ayyanchira @joaodordio @evantk91

Ayyanchira

Looking good. Authmanager change does make sense. There will not be success handle called if auth decode fails. But at the same time, scheduleing the next auth token is fired.
Looks good to me.

Ayyanchira · 2025-03-13T15:54:56Z

swift-sdk/Internal/AuthManager.swift

+        // Set the new token first
+        authToken = retrievedAuthToken
+        storeAuthToken()
+
        if retrievedAuthToken != nil {
            let isRefreshQueued = queueAuthTokenExpirationRefresh(retrievedAuthToken, onSuccess: onSuccess)
            if !isRefreshQueued {
-                onSuccess?(authToken)
+                onSuccess?(retrievedAuthToken)  // Use retrievedAuthToken instead of authToken
            }
        } else {
            handleAuthFailure(failedAuthToken: nil, reason: .authTokenNull)
            scheduleAuthTokenRefreshTimer(interval: getNextRetryInterval(), successCallback: onSuccess)
        }
-
-        authToken = retrievedAuthToken
-
-        storeAuthToken()
    }


This actually makes sense. Might have to match this one in Android later too if thats not happening..

Agree. We should add to Android.

Ayyanchira · 2025-03-13T17:34:41Z

tests/offline-events-tests/RequestHandlerTests.swift

+            // Compare each field individually for better error messages
+            let requestDevice = requestBody["device"] as! [String: Any]
+            let requestDataFields = requestDevice["dataFields"] as! [String: Any]
+            let expectedDevice = deviceDict
+            let expectedDataFields = dataFields
+
+            XCTAssertEqual(requestDevice["token"] as? String, expectedDevice["token"] as? String, "token mismatch")
+            XCTAssertEqual(requestDevice["applicationName"] as? String, expectedDevice["applicationName"] as? String, "applicationName mismatch")
+            XCTAssertEqual(requestDevice["platform"] as? String, expectedDevice["platform"] as? String, "platform mismatch")
+
+            for (key, value) in expectedDataFields {
+                XCTAssertEqual(requestDataFields[key] as? String, value as? String, "\(key) mismatch")
+            }


Like this refactor for being able to tell in detail which exact detail is problematic

Looks like body dict is never used and can be removed due to this refactor.

Ayyanchira · 2025-03-13T17:52:51Z

tests/unit-tests/IterableAPIResponseTests.swift

+        let xpectation = expectation(description: "retry on 401 with invalidJWTPayload")
+
+        // Mock the dependencies and requestProvider for your test
+        let authManager = MockAuthManager()
+
+        let networkErrorSession = MockNetworkSession() { _ in
+            MockNetworkSession.MockResponse(statusCode: 401,
+                                            data: ["code":"InvalidJwtPayload"].toJsonData(),
+                                            delay: 1)
+        }
+
+        let networkSuccessSession = MockNetworkSession() { _ in
+            MockNetworkSession.MockResponse(statusCode: 200,
+                                            data: ["msg": "success"].toJsonData(),
+                                            delay: 1)
+        }
+
+        let urlErrorRequest = createApiClient(networkSession: networkErrorSession).convertToURLRequest(iterableRequest: IterableRequest.post(PostRequest(path: "", args: nil, body: [:])))!
+
+
+        let urlSuccessRequest = createApiClient(networkSession: networkSuccessSession).convertToURLRequest(iterableRequest: IterableRequest.post(PostRequest(path: "", args: nil, body: [:])))!
+
+        let requestProvider: () -> Pending<SendRequestValue, SendRequestError> = {
+            if authManager.retryWasRequested {
+                return RequestSender.sendRequest(urlSuccessRequest, usingSession: networkSuccessSession)
+            }
+            return RequestSender.sendRequest(urlErrorRequest, usingSession: networkErrorSession)
+        }
+
+        let result = RequestProcessorUtil.sendRequest(
+            requestProvider: requestProvider,
+            authManager: authManager,
+            requestIdentifier: "TestIdentifier"
+        )
+
+        result.onSuccess { value in
+            xpectation.fulfill()
+            XCTAssert(true)
+        }.onError { error in
+            if authManager.retryWasRequested {
+                xpectation.fulfill()
+            }
+        }
+
+        waitForExpectations(timeout: testExpectationTimeout)
+    }


Amazing test case for JWT retry!

evantk91 · 2025-03-13T21:09:10Z

swift-sdk/Internal/AuthManager.swift

@@ -180,13 +180,13 @@ class AuthManager: IterableAuthManagerProtocol {
            /// schedule a default timer of 10 seconds if we fall into this case
            scheduleAuthTokenRefreshTimer(interval: getNextRetryInterval(), successCallback: onSuccess)

-            return true
+            return false  // Return false since we couldn't queue a valid refresh


Nice catch!

evantk91

Let some clarifying comments.

evantk91 · 2025-03-13T21:31:06Z

tests/offline-events-tests/NetworkConnectivityManagerTests.swift

@@ -50,46 +77,46 @@ class NetworkConnectivityManagerTests: XCTestCase {
    func testPollingNetworkMonitor() throws {
        let expectation1 = expectation(description: "do not fulfill before start")
        expectation1.isInverted = true
-        let monitor = NetworkMonitor()
+        let monitor = MockNetworkMonitor()


I believe testNetworkMonitor is missing the MockNetworkMonitor

Also the time out period needs to be updated to align with other tests

evantk91 · 2025-03-13T22:17:50Z

tests/offline-events-tests/RequestHandlerTests.swift

+            // Compare each field individually for better error messages
+            let requestDevice = requestBody["device"] as! [String: Any]
+            let requestDataFields = requestDevice["dataFields"] as! [String: Any]
+            let expectedDevice = deviceDict
+            let expectedDataFields = dataFields
+
+            XCTAssertEqual(requestDevice["token"] as? String, expectedDevice["token"] as? String, "token mismatch")
+            XCTAssertEqual(requestDevice["applicationName"] as? String, expectedDevice["applicationName"] as? String, "applicationName mismatch")
+            XCTAssertEqual(requestDevice["platform"] as? String, expectedDevice["platform"] as? String, "platform mismatch")
+
+            for (key, value) in expectedDataFields {
+                XCTAssertEqual(requestDataFields[key] as? String, value as? String, "\(key) mismatch")
+            }


Looks like body dict is never used and can be removed due to this refactor.

evantk91 · 2025-03-13T22:32:16Z

tests/offline-events-tests/TaskRunnerTests.swift

@@ -185,12 +185,14 @@ class TaskRunnerTests: XCTestCase {
    func testResumeWhenNetworkIsBackOnline() throws {
        let networkSession = MockNetworkSession(statusCode: 401, json: [:], error: IterableError.general(description: "Mock error"))
        let checker = NetworkConnectivityChecker(networkSession: networkSession)
-        let monitor = NetworkMonitor()
+        let monitor = MockNetworkMonitor()


Are only specific monitors the MockNetworkMonitor?

evantk91 · 2025-03-13T23:27:39Z

tests/unit-tests/AutoRegistrationTests.swift


        wait(for: [expectation1, expectation2, expectation3], timeout: testExpectationTimeout)
+
+        XCTAssertEqual(registerCallCount, 2, "Should have exactly 2 register calls")
+        XCTAssertTrue(disableCallMade, "Should have made exactly 1 disable call")
    }


Nice updates! I like the testing the disable can only be called after register and only once.

evantk91 · 2025-03-13T23:38:45Z

tests/unit-tests/RequestCreatorTests.swift

                              value: "native", 
                              inDictionary: body)
-        TestUtils.validateMatch(keyPath: KeyPath(string: "mobileFrameworkInfo.iterableSdkVersion"), 
+        TestUtils.validateMatch(keyPath: KeyPath(keys: JsonKey.device, JsonKey.dataFields, JsonKey.mobileFrameworkInfo, JsonKey.iterableSdkVersion), 
                              value: testSdkVersion, 


Nice addition.

sumeruchat requested review from joaodordio, Ayyanchira and evantk91 December 13, 2024 13:53

sumeruchat added 3 commits December 19, 2024 14:56

[MOB-10402] Add test reports

d2620a3

[MOB-10402] Add test reports

69f5241

[MOB-10402] Add test reports

7b8e280

sumeruchat force-pushed the feature/MOB-10402-add-tests branch from 3bb2f30 to 7b8e280 Compare December 19, 2024 14:57

sumeruchat added 19 commits December 19, 2024 14:58

[MOB-10402] Fix

b706ad3

[MOB-10402] Fix

4fc091c

[MOB-10402] Fix

0cd2f26

[MOB-10402] Fix

f42781d

[MOB-10402] Fix

7ed554b

[MOB-10402] fix

568ebe9

Merge branch 'master' into feature/MOB-10402-add-tests

7579563

[MOB-9233] Some work on in-app json only

22343ea

[MOB-9233] add a test

d9c3230

[MOB-9233] Fixes

6a97003

[MOB-9233] Fixes

474b3ce

[MOB-9233] Fixes

a2c02b4

[MOB-9233] Fixes

a3662cc

[MOB-9233] Fixes

54af23a

[MOB-9233] Fixes

a9ba3bd

[MOB-9233] Fixes

2a5b58c

[MOB-9233] Fixes

c75ddc6

[MOB-9233] Fixes

e1c66c3

[MOB-9233] Fixes

1085d80

sumeruchat added 16 commits March 3, 2025 15:35

[MOB-10402] Update macOS version in CI workflow

1340898

[MOB-10402] Update CI to use macOS-latest and iPhone 16 Pro

575e19e

[MOB-10402] Update CI to run on macOS 15

76b5ba6

[MOB-10402] Rename test plan to swift-sdk.xctestplan

74f146e

[MOB-10402] Merge master into feature/MOB-10402-add-tests

2a6b6ff

[MOB-10402] Remove unused test plans from project files

b7e0b04

[MOB-10402] Remove obsolete xctestplan files

d0c0098

[MOB-10402] Update e2e workflow to macOS 15

c2a253a

[MOB-10402] Fix build output formatting with xcpretty

de5318d

[MOB-10402] Add result bundle path to xcodebuild command

5ed6479

[MOB-10402] Add test report generation to e2e workflow

e1d9fa7

[MOB-10402] Remove redundant test report steps

f115f78

[MOB-10402] Add swift-sdk.xctestplan to project config

4603070

[MOB-10402] Add endpoint-tests.xctestplan to project

e6ca2db

[MOB-10402] Fix xctestplan paths in project config

2123eb7

[MOB-10402] Fix test plan path in xcscheme files

c42691e

sumeruchat changed the title ~~[MOB-10402] Add test reports~~ [MOB-10402] Fix Tests Mar 3, 2025

MOB-10998 Actually Fix Tests (#904)

73af51f

[MOB-10402] Add skipped tests to xctestplan

18eeca2

Ayyanchira approved these changes Mar 13, 2025

View reviewed changes

Merge branch 'master' into feature/MOB-10402-add-tests

68d68a6

evantk91 reviewed Mar 13, 2025

View reviewed changes

evantk91 approved these changes Mar 13, 2025

View reviewed changes

sumeruchat merged commit 31f8629 into master Mar 14, 2025
2 checks passed

sumeruchat deleted the feature/MOB-10402-add-tests branch March 14, 2025 10:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MOB-10402] Fix Tests #876

[MOB-10402] Fix Tests #876

sumeruchat commented Dec 13, 2024 •

edited

Loading

joaodordio commented Dec 16, 2024

sumeruchat commented Dec 16, 2024

joaodordio commented Dec 16, 2024

sumeruchat commented Dec 16, 2024

sumeruchat commented Mar 3, 2025

joaodordio commented Mar 4, 2025

Ayyanchira commented Mar 5, 2025

sumeruchat commented Mar 6, 2025

sumeruchat commented Mar 6, 2025

Ayyanchira left a comment

Ayyanchira Mar 13, 2025

evantk91 Mar 13, 2025

Ayyanchira Mar 13, 2025

evantk91 Mar 13, 2025

Ayyanchira Mar 13, 2025

evantk91 Mar 13, 2025

evantk91 left a comment

evantk91 Mar 13, 2025

evantk91 Mar 13, 2025

evantk91 Mar 13, 2025

evantk91 Mar 13, 2025

evantk91 Mar 13, 2025

evantk91 Mar 13, 2025

[MOB-10402] Fix Tests #876

[MOB-10402] Fix Tests #876

Conversation

sumeruchat commented Dec 13, 2024 • edited Loading

🔹 Jira Ticket(s)

✏️ Description

joaodordio commented Dec 16, 2024

sumeruchat commented Dec 16, 2024

joaodordio commented Dec 16, 2024

sumeruchat commented Dec 16, 2024

sumeruchat commented Mar 3, 2025

joaodordio commented Mar 4, 2025

Ayyanchira commented Mar 5, 2025

sumeruchat commented Mar 6, 2025

sumeruchat commented Mar 6, 2025

Ayyanchira left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evantk91 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sumeruchat commented Dec 13, 2024 •

edited

Loading