feat: SDKE-64 Improve mParticle.m test coverage in swift 2 (#407)

* - add executor mock
* - update nullability
* - add tests

Author: denischilik

UnitTests/MParticle+PrivateMethods.h

@@ -30,13 +30,17 @@
 - (void)handleWebviewCommand:(NSString *)command dictionary:(NSDictionary *)dictionary;
 - (void)sessionDidBegin:(MPSession *)session;
 - (void)sessionDidEnd:(nonnull MPSession *)session;
+- (void)setExecutor: (id<ExecutorProtocol>)newExecutor;
+- (void)setBackendController: (id<MPBackendControllerProtocol>)backendController;
+- (void)setKitContainer:(id<MPKitContainerProtocol>) kitContainer;
+- (void)forwardLogInstall;
+- (void)forwardLogUpdate;
 
 @property (nonatomic, strong, nonnull) id<MPBackendControllerProtocol> backendController;
 @property (nonatomic, strong) id<SettingsProviderProtocol> settingsProvider;
 @property (nonatomic, strong, nullable) id<MPDataPlanFilterProtocol> dataPlanFilter;
 @property (nonatomic, strong, nonnull) id<MPListenerControllerProtocol> listenerController;
 @property (nonatomic, strong) id<MPStateMachineProtocol> stateMachine;
-@property (nonatomic, strong) id<MPKitContainerProtocol> kitContainer;
 @property (nonatomic, strong) id<MPPersistenceControllerProtocol> persistenceController;
 @end
 

UnitTests/MParticleTestsSwift.swift

@@ -637,7 +637,7 @@ class MParticleTestsSwift: XCTestCase {
     func testSessionDidBegin() {
         let kitContainer = MPKitContainerMock()
         kitContainer.forwardSDKCallExpectation = XCTestExpectation()
-        mparticle.kitContainer = kitContainer
+        mparticle.setKitContainer(kitContainer)
         mparticle.sessionDidBegin(MPSession())
 
 
@@ -654,7 +654,7 @@ class MParticleTestsSwift: XCTestCase {
     func testSessionDidEnd() {
         let kitContainer = MPKitContainerMock()
         kitContainer.forwardSDKCallExpectation = XCTestExpectation()
-        mparticle.kitContainer = kitContainer
+        mparticle.setKitContainer(kitContainer)
         mparticle.sessionDidEnd(MPSession())
 
 
@@ -677,7 +677,7 @@ class MParticleTestsSwift: XCTestCase {
 
         let backendController = MPBackendControllerMock()
 
-        mparticle.kitContainer = kitContainer
+        mparticle.setKitContainer(kitContainer)
         mparticle.persistenceController = persistenceController
         mparticle.backendController = backendController
 
@@ -692,5 +692,90 @@ class MParticleTestsSwift: XCTestCase {
         XCTAssertEqual(persistenceController.resetDatabaseCalled, true)
         XCTAssertTrue(backendController.unproxyOriginalAppDelegateCalled)
     }
+    
+    func testBeginSessionTempSessionAvailableSessionTempSessionShouldNotBeCreated() {
+        let backendController = MPBackendControllerMock()
+        backendController.session = nil
+        backendController.tempSessionReturnValue = MParticleSession()
+        mparticle.backendController = backendController
+        mparticle.beginSession()
+        XCTAssertFalse(backendController.createTempSessionCalled)
+    }
+    
+    func testBeginSessionSessionAvailableSessionTempSessionShouldNotBeCreated() {
+        let backendController = MPBackendControllerMock()
+        backendController.session = MPSession()
+        backendController.tempSessionReturnValue = nil
+        mparticle.backendController = backendController
+        mparticle.beginSession()
+        XCTAssertFalse(backendController.createTempSessionCalled)
+    }
+    
+    func testBeginSessionSessionUnavailable() {
+        let backendController = MPBackendControllerMock()
+        backendController.session = nil
+        backendController.tempSessionReturnValue = nil
+        let executor = ExecutorMock()
+        mparticle.setExecutor(executor)
+        mparticle.backendController = backendController
+        mparticle.beginSession()
+        XCTAssertTrue(executor.executeOnMessageQueueAsync)
+        XCTAssertTrue(backendController.createTempSessionCalled)
+        XCTAssertTrue(backendController.beginSessionCalled)
+        XCTAssertEqual(backendController.beginSessionIsManualParam, true)
+        XCTAssertNotNil(backendController.beginSessionDateParam)
+    }
+    
+    func testEndSessionNoSession() {
+        let backendController = MPBackendControllerMock()
+        backendController.session = nil
+        let executor = ExecutorMock()
+        mparticle.setExecutor(executor)
+        mparticle.backendController = backendController
+        mparticle.endSession()
+        XCTAssertEqual(executor.executeOnMessageQueueAsync, true)
+        XCTAssertFalse(backendController.endSessionWithIsManualCalled)
+    }
+    
+    func testEndSessionWithSession() {
+        let backendController = MPBackendControllerMock()
+        backendController.session = MPSession()
+        let executor = ExecutorMock()
+        mparticle.setExecutor(executor)
+        mparticle.backendController = backendController
+        mparticle.endSession()
+        XCTAssertEqual(executor.executeOnMessageQueueAsync, true)
+        XCTAssertTrue(backendController.endSessionWithIsManualCalled)
+        XCTAssertEqual(backendController.endSessionIsManualParam, true)
+    }
+    
+    func testForwardLogInstall() {
+        let executor = ExecutorMock()
+        mparticle.setExecutor(executor)
+        let kitContainer = MPKitContainerMock()
+        mparticle.setKitContainer(kitContainer)
+        mparticle.forwardLogInstall()
+        XCTAssertEqual(executor.executeOnMainAsync, true)
+        XCTAssertTrue(kitContainer.forwardSDKCallCalled)
+        XCTAssertEqual(kitContainer.forwardSDKCallSelectorParam?.description, "forwardLogInstall")
+        XCTAssertEqual(kitContainer.forwardSDKCallMessageTypeParam, .unknown)
+        XCTAssertNil(kitContainer.forwardSDKCallEventParam)
+        XCTAssertNil(kitContainer.forwardSDKCallParametersParam)
+        XCTAssertNil(kitContainer.forwardSDKCallUserInfoParam)
+    }
+    
+    func testForwardLogUpdate() {
+        let executor = ExecutorMock()
+        mparticle.setExecutor(executor)
+        let kitContainer = MPKitContainerMock()
+        mparticle.setKitContainer(kitContainer)
+        mparticle.forwardLogUpdate()
+        XCTAssertEqual(executor.executeOnMainAsync, true)
+        XCTAssertTrue(kitContainer.forwardSDKCallCalled)
+        XCTAssertEqual(kitContainer.forwardSDKCallSelectorParam?.description, "forwardLogUpdate")
+        XCTAssertEqual(kitContainer.forwardSDKCallMessageTypeParam, .unknown)
+        XCTAssertNil(kitContainer.forwardSDKCallEventParam)
+        XCTAssertNil(kitContainer.forwardSDKCallParametersParam)
+        XCTAssertNil(kitContainer.forwardSDKCallUserInfoParam)
+    }
 }
-

UnitTests/Mocks/ExecutorMock.swift

@@ -0,0 +1,45 @@
+//
+//  ExecutorMock.swift
+//  mParticle-Apple-SDK
+//
+//  Created by Denis Chilik on 9/9/25.
+//
+
+
+class ExecutorMock: ExecutorProtocol {
+    func messageQueue() -> dispatch_queue_t {
+        return DispatchQueue.main
+    }
+    
+    func isMessageQueue() -> Bool {
+        return false
+    }
+    
+    var executeOnMessageQueueAsync: Bool = false
+    
+    func execute(onMessage block: (() -> Void)!) {
+        executeOnMessageQueueAsync = true
+        block()
+    }
+    
+    var executeOnMessageQueueSync = false
+    
+    func execute(onMessageSync block: (() -> Void)!) {
+        executeOnMessageQueueSync = true
+        block()
+    }
+    
+    var executeOnMainAsync = false
+    
+    func execute(onMain block: (() -> Void)!) {
+        executeOnMainAsync = true
+        block()
+    }
+    
+    var executeOnMainSync = false
+    
+    func execute(onMainSync block: (() -> Void)!) {
+        executeOnMainSync = true
+        block()
+    }
+}

UnitTests/Mocks/MPBackendControllerMock.swift

@@ -69,9 +69,9 @@ class MPBackendControllerMock: NSObject, MPBackendControllerProtocol {
 
     // MARK: - Temp session
     var tempSessionCalled = false
-    var tempSessionReturnValue: MParticleSession = MParticleSession()
+    var tempSessionReturnValue: MParticleSession?
 
-    func tempSession() -> MParticleSession {
+    func tempSession() -> MParticleSession? {
         tempSessionCalled = true
         return tempSessionReturnValue
     }

UnitTests/mParticle_iOS_SDKTests-Bridging-Header.h

@@ -1,6 +1,7 @@
 //
 //  Use this file to import your target's public headers that you would like to expose to Swift.
 //
+#import "Executor.h"
 #import "MPAttributionResult+MParticlePrivate.h"
 #import "MParticleSession+MParticlePrivate.h"
 #import "MParticleOptions+MParticlePrivate.h"

mParticle-Apple-SDK.xcodeproj/project.pbxproj

@@ -15,6 +15,8 @@
 		351308422E6B28F5002A3AD6 /* Executor.m in Sources */ = {isa = PBXBuildFile; fileRef = 351308402E6B28F5002A3AD6 /* Executor.m */; };
 		351308432E6B28F5002A3AD6 /* Executor.h in Headers */ = {isa = PBXBuildFile; fileRef = 3513083F2E6B28F5002A3AD6 /* Executor.h */; };
 		351308442E6B28F5002A3AD6 /* Executor.m in Sources */ = {isa = PBXBuildFile; fileRef = 351308402E6B28F5002A3AD6 /* Executor.m */; };
+		3517794F2E706BF8004BF05E /* ExecutorMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3517794C2E706BE4004BF05E /* ExecutorMock.swift */; };
+		351779502E706BF8004BF05E /* ExecutorMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3517794C2E706BE4004BF05E /* ExecutorMock.swift */; };
 		35329FE92E54C38C009AC4FD /* MPNetworkOptions+MParticlePrivate.m in Sources */ = {isa = PBXBuildFile; fileRef = 35329FE82E54C38C009AC4FD /* MPNetworkOptions+MParticlePrivate.m */; };
 		35329FEA2E54C38C009AC4FD /* MPNetworkOptions+MParticlePrivate.m in Sources */ = {isa = PBXBuildFile; fileRef = 35329FE82E54C38C009AC4FD /* MPNetworkOptions+MParticlePrivate.m */; };
 		35329FEC2E54C483009AC4FD /* MPNetworkOptions+MParticlePrivateTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 35329FEB2E54C480009AC4FD /* MPNetworkOptions+MParticlePrivateTests.swift */; };
@@ -577,6 +579,7 @@
 		351308232E676F12002A3AD6 /* MPPersistenceControllerMock.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MPPersistenceControllerMock.swift; sourceTree = "<group>"; };
 		3513083F2E6B28F5002A3AD6 /* Executor.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = Executor.h; sourceTree = "<group>"; };
 		351308402E6B28F5002A3AD6 /* Executor.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = Executor.m; sourceTree = "<group>"; };
+		3517794C2E706BE4004BF05E /* ExecutorMock.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExecutorMock.swift; sourceTree = "<group>"; };
 		35329FE82E54C38C009AC4FD /* MPNetworkOptions+MParticlePrivate.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "MPNetworkOptions+MParticlePrivate.m"; sourceTree = "<group>"; };
 		35329FEB2E54C480009AC4FD /* MPNetworkOptions+MParticlePrivateTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "MPNetworkOptions+MParticlePrivateTests.swift"; sourceTree = "<group>"; };
 		35329FEE2E54CA49009AC4FD /* MParticleOptions+MParticlePrivate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "MParticleOptions+MParticlePrivate.h"; sourceTree = "<group>"; };
@@ -904,6 +907,7 @@
 		356D4A572E58B01100CB69FE /* Mocks */ = {
 			isa = PBXGroup;
 			children = (
+				3517794C2E706BE4004BF05E /* ExecutorMock.swift */,
 				351308232E676F12002A3AD6 /* MPPersistenceControllerMock.swift */,
 				3513081E2E6729D0002A3AD6 /* MPKitContainerMock.swift */,
 				356752922E60928500DEEE23 /* MPStateMachineMock.swift */,
@@ -1436,13 +1440,13 @@
 				53A79BE929CDFB2000E7489F /* MPApplication.h in Headers */,
 				D30CD0CB2CFF5FB100F5148A /* MPStateMachine.h in Headers */,
 				53A79BF329CDFB2000E7489F /* MPCustomModulePreference.h in Headers */,
-				351308412E6B28F5002A3AD6 /* Executor.h in Headers */,
 				53A79B8C29CDFB2000E7489F /* MPDataModelProtocol.h in Headers */,
 				53A79BFB29CDFB2100E7489F /* MPAppDelegateProxy.h in Headers */,
 				359BAFFA2E56330200A8A704 /* SettingsProvider.h in Headers */,
 				53A79B9929CDFB2000E7489F /* MPIConstants.h in Headers */,
 				53A79B7129CDFB2000E7489F /* MPBackendController.h in Headers */,
 				35E3FCCC2E54975C00DB5B18 /* MParticleSession+MParticlePrivate.h in Headers */,
+				351308412E6B28F5002A3AD6 /* Executor.h in Headers */,
 				53A79B7929CDFB2000E7489F /* MPConnectorResponseProtocol.h in Headers */,
 				7E0387832DB913D2003B7D5E /* MPRokt.h in Headers */,
 				53A79B7C29CDFB2000E7489F /* MPConnectorFactoryProtocol.h in Headers */,
@@ -1532,12 +1536,12 @@
 				53A79D2729CE23F700E7489F /* MPApplication.h in Headers */,
 				53A79D2829CE23F700E7489F /* MPCustomModulePreference.h in Headers */,
 				53A79D2929CE23F700E7489F /* MPDataModelProtocol.h in Headers */,
-				351308432E6B28F5002A3AD6 /* Executor.h in Headers */,
 				53A79D2A29CE23F700E7489F /* MPAppDelegateProxy.h in Headers */,
 				53A79D2C29CE23F700E7489F /* MPIConstants.h in Headers */,
 				359BAFF92E56330200A8A704 /* SettingsProvider.h in Headers */,
 				53A79D2E29CE23F700E7489F /* MPBackendController.h in Headers */,
 				7E0387812DB913D2003B7D5E /* MPRokt.h in Headers */,
+				351308432E6B28F5002A3AD6 /* Executor.h in Headers */,
 				35E3FCCD2E54975C00DB5B18 /* MParticleSession+MParticlePrivate.h in Headers */,
 				53A79D3029CE23F700E7489F /* MPConnectorResponseProtocol.h in Headers */,
 				53A79D3229CE23F700E7489F /* MPConnectorFactoryProtocol.h in Headers */,
@@ -1803,6 +1807,7 @@
 				356752932E60928B00DEEE23 /* MPStateMachineMock.swift in Sources */,
 				534CD27D29CE2CE1008452B3 /* MPDataModelTests.m in Sources */,
 				534CD27F29CE2CE1008452B3 /* NSNumber+MPFormatterTests.m in Sources */,
+				351779502E706BF8004BF05E /* ExecutorMock.swift in Sources */,
 				351308202E6729DA002A3AD6 /* MPKitContainerMock.swift in Sources */,
 				534CD28029CE2CE1008452B3 /* MPResponseEventsTest.m in Sources */,
 				534CD28129CE2CE1008452B3 /* MPConsentStateTests.m in Sources */,
@@ -1996,6 +2001,7 @@
 				356752942E60928B00DEEE23 /* MPStateMachineMock.swift in Sources */,
 				53A79CCC29CE019F00E7489F /* MPIntegrationAttributesTest.m in Sources */,
 				53A79CBD29CE019F00E7489F /* MPDataModelTests.m in Sources */,
+				3517794F2E706BF8004BF05E /* ExecutorMock.swift in Sources */,
 				3513081F2E6729DA002A3AD6 /* MPKitContainerMock.swift in Sources */,
 				53A79CEE29CE019F00E7489F /* NSNumber+MPFormatterTests.m in Sources */,
 				53A79CD929CE019F00E7489F /* MPResponseEventsTest.m in Sources */,

mParticle-Apple-SDK/Include/MPBackendController.h

@@ -61,7 +61,7 @@ extern const NSInteger kInvalidKey;
 - (nonnull NSMutableDictionary<NSString *, id> *)userAttributesForUserId:(nonnull NSNumber *)userId;
 - (void)startWithKey:(nonnull NSString *)apiKey secret:(nonnull NSString *)secret networkOptions:(nullable MPNetworkOptions *)networkOptions firstRun:(BOOL)firstRun installationType:(MPInstallationType)installationType proxyAppDelegate:(BOOL)proxyAppDelegate startKitsAsync:(BOOL)startKitsAsync consentState:(MPConsentState *_Nullable)consentState completionHandler:(dispatch_block_t _Nonnull)completionHandler;
 - (void)prepareBatchesForUpload:(nonnull MPUploadSettings *)uploadSettings;
-- (nonnull MParticleSession *)tempSession;
+- (MParticleSession* _Nullable)tempSession;
 - (void)unproxyOriginalAppDelegate;
 - (void)endSession;
 - (void)beginTimedEvent:(nonnull MPEvent *)event completionHandler:(void (^ _Nonnull)(MPEvent * _Nonnull event, MPExecStatus execStatus))completionHandler;

mParticle-Apple-SDK/mParticle.m

@@ -151,6 +151,10 @@ - (instancetype)init {
     return self;
 }
 
+- (void)setExecutor: (id<ExecutorProtocol>)newExecutor {
+    executor = newExecutor;
+}
+
 - (void)setKitContainer_PRIVATE:(MPKitContainer_PRIVATE*) kitContainer_PRIVATE {
     _kitContainer_PRIVATE = kitContainer_PRIVATE;
     _kitContainer = kitContainer_PRIVATE;