chore(tests): Add in app messaging testing infrastructure and tests (#1615)

* chore(tests): Add Swift `IAMIntegrationTests` file

Add Swift `IAMIntegrationTests` test file and check for accessibility of `OSMessagingController` from the test file

* nit: remove unused methods `getTriggerValueForKey`

* no longer used, dead code

* nit: remove methods from OSMessagingController header

* Aren't called by anything so no need to be on the interface, these are called by the class itself.

* Add description to `OSRequestGetInAppMessages`

* Without a description, the object will return something like `<OSRequestGetInAppMessages: 0x600001798bc0>`. By adding a predictable description, we can operate on the object.

* chore(tests): Add framework for OneSignalInAppMessagesMocks

* Re-usable test helpers and mock functionality
* Include own swiftlint file
* ❗️ After `OneSignalInAppMessagesMocks` was created, I had to then manually "convert to group" or else the CI had build errors about the following:

xcodebuild: error: Unable to read project 'OneSignal.xcodeproj'
Reason: The project ‘OneSignal’ is damaged and cannot be opened. Examine the project file for invalid edits or unresolved source control conflicts.
Exception: didn't find classname for 'isa' key

* chore(tests): move `UIApplication+OneSignal` from OneSIgnal > OneSignalInAppMessages

* This extension on `UIApplication` is only used in the `OneSignalInAppMessages` framework, so there is no need to keep it in the umbrella `OneSignalFramework` framework, which causes errors if only `OneSignalInAppMessages` is tested (without also importing OneSignalFramework).

* chore(tests): Add ConsistencyManagerTestHelpers to tests

* Has helper methods for repeating functionality

* Add / migrate some existing IAM integration tests

* Attempt to migrate `testDisablingIAMs_stillCreatesMessageQueue_butPreventsMessageDisplay` to new tests, but behavior has changed. It becomes `testPausingIAMs_doesNotCreateMessageQueue`
* Migrate `testPreviewIAMIsDisplayedOnPause`

* address PR feedback

* `messageViewImpressionRequest` was removed from the `OSMessagingController` header file, so update `OSMessagingControllerOverrider` to expose it for internal usage.
* Delete old tests that have been migrated

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -49,19 +49,13 @@ NS_ASSUME_NONNULL_BEGIN
 
 + (OSMessagingController *)sharedInstance;
 + (void)start;
-+ (void)removeInstance;
-- (void)presentInAppMessage:(OSInAppMessageInternal *)message;
 - (void)getInAppMessagesFromServer:(NSString * _Nullable)subscriptionId;
-- (void)messageViewImpressionRequest:(OSInAppMessageInternal *)message;
-- (void)messageViewPageImpressionRequest:(OSInAppMessageInternal *)message withPageId:(NSString *)pageId;
 
 - (BOOL)isInAppMessagingPaused;
 - (void)setInAppMessagingPaused:(BOOL)pause;
 - (void)addTriggers:(NSDictionary<NSString *, id> *)triggers;
 - (void)removeTriggersForKeys:(NSArray<NSString *> *)keys;
 - (void)clearTriggers;
-- (NSDictionary<NSString *, id> *)getTriggers;
-- (id)getTriggerValueForKey:(NSString *)key;
 
 - (void)addInAppMessageClickListener:(NSObject<OSInAppMessageClickListener> *_Nullable)listener;
 - (void)removeInAppMessageClickListener:(NSObject<OSInAppMessageClickListener> *_Nullable)listener;

iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSMessagingController.h

@@ -26,8 +26,8 @@
  */
 
 #import "OSMessagingController.h"
-#import "UIApplication+OneSignal.h" // Previously imported via "OneSignalHelper.h"
-#import "NSDateFormatter+OneSignal.h" // Previously imported via "OneSignalHelper.h"
+#import "UIApplication+OneSignal.h"
+#import "NSDateFormatter+OneSignal.h"
 #import <OneSignalCore/OneSignalCore.h>
 #import "OSInAppMessageClickResult.h"
 #import "OSInAppMessageClickEvent.h"
@@ -165,6 +165,7 @@ + (OSMessagingController *)sharedInstance {
     return sharedInstance;
 }
 
+/// Note: This method is used in tests only.
 + (void)removeInstance {
     sharedInstance = nil;
     once = 0;
@@ -815,10 +816,6 @@ - (void)clearTriggers {
     return self.triggerController.getTriggers;
 }
 
-- (id)getTriggerValueForKey:(NSString *)key {
-    return [self.triggerController getTriggerValueForKey:key];
-}
-
 #pragma mark OSInAppMessageViewControllerDelegate Methods
 - (void)messageViewControllerDidDisplay:(OSInAppMessageInternal *)message {
     [self onDidDisplayInAppMessage:message];
@@ -1227,7 +1224,6 @@ - (void)addTriggers:(NSDictionary<NSString *, id> *)triggers {}
 - (void)removeTriggersForKeys:(NSArray<NSString *> *)keys {}
 - (void)clearTriggers {}
 - (NSDictionary<NSString *, id> *)getTriggers { return @{}; }
-- (id)getTriggerValueForKey:(NSString *)key { return 0; }
 #pragma mark OSInAppMessageViewControllerDelegate Methods
 - (void)messageViewControllerWasDismissed {}
 - (void)messageViewDidSelectAction:(OSInAppMessageInternal *)message withAction:(OSInAppMessageClickResult *)action {}

iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSMessagingController.m

@@ -52,7 +52,6 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)addTriggers:(NSDictionary<NSString *, id> *)triggers;
 - (void)removeTriggersForKeys:(NSArray<NSString *> *)keys;
 - (NSDictionary<NSString *, id> *)getTriggers;
-- (id)getTriggerValueForKey:(NSString *)key;
 - (void)timeSinceLastMessage:(NSDate *)date;
 
 @end

iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSTriggerController.h

@@ -69,12 +69,6 @@ - (void)removeTriggersForKeys:(NSArray<NSString *> *)keys {
     }
 }
 
-- (id)getTriggerValueForKey:(NSString *)key {
-    @synchronized (self.triggers) {
-        return self.triggers[key];
-    }
-}
-
 /*
  * Part of redisplay logic
  *

iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSTriggerController.m

@@ -28,6 +28,10 @@ of this software and associated documentation files (the "Software"), to deal
 #import "OSInAppMessagingRequests.h"
 
 @implementation OSRequestGetInAppMessages
+- (NSString *)description {
+    return [NSString stringWithFormat:@"<OSRequestGetInAppMessages from %@>", self.path];
+}
+
 + (instancetype _Nonnull)   withSubscriptionId:(NSString * _Nonnull)subscriptionId
                             withSessionDuration:(NSNumber * _Nonnull)sessionDuration
                             withRetryCount:(NSNumber *)retryCount

iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Requests/OSInAppMessagingRequests.m

@@ -0,0 +1,2 @@
+disabled_rules:
+  - identifier_name

…gnalSDK/Source/UIApplication+OneSignal.h …lInAppMessages/UIApplication+OneSignal.hiOS_SDK/OneSignalSDK/Source/UIApplication+OneSignal.h renamed to iOS_SDK/OneSignalSDK/OneSignalInAppMessages/UIApplication+OneSignal.h iOS_SDK/OneSignalSDK/Source/UIApplication+OneSignal.h renamed to iOS_SDK/OneSignalSDK/OneSignalInAppMessages/UIApplication+OneSignal.h

@@ -0,0 +1,112 @@
+/*
+ Modified MIT License
+
+ Copyright 2025 OneSignal
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ 1. The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ 2. All copies of substantial portions of the Software may only be used in connection
+ with services provided by OneSignal.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+ */
+
+import Foundation
+import OneSignalInAppMessages
+
+let OS_TEST_MESSAGE_ID = "a4b3gj7f-d8cc-11e4-bed1-df8f05be55ba"
+let OS_TEST_MESSAGE_VARIANT_ID = "m8dh7234f-d8cc-11e4-bed1-df8f05be55ba"
+let OS_TEST_ENGLISH_VARIANT_ID = "11e4-bed1-df8f05be55ba-m8dh7234f-d8cc"
+
+let OS_DUMMY_HTML = "<html><h1>Hello World</h1></html>"
+
+@objc
+public class IAMTestHelpers: NSObject {
+
+    nonisolated(unsafe) static var messageIdIncrementer = 0
+
+    /// Convert OSTriggerOperatorType enum to string
+    private static func OS_OPERATOR_TO_STRING(_ type: Int32) -> String {
+        // Trigger operator strings
+        let OS_OPERATOR_STRINGS: [String] = [
+            "greater",
+            "less",
+            "equal",
+            "not_equal",
+            "less_or_equal",
+            "greater_or_equal",
+            "exists",
+            "not_exists",
+            "in"
+        ]
+
+        return OS_OPERATOR_STRINGS[Int(type)]
+    }
+
+    /// Returns the JSON of a minimal in-app message that can be used as a building block.
+    @objc
+    public static func testDefaultMessageJson() -> [String: Any] {
+        messageIdIncrementer += 1
+        return [
+            "id": String(format: "%@_%i", OS_TEST_MESSAGE_ID, messageIdIncrementer),
+            "variants": [
+                "ios": [
+                    "default": OS_TEST_MESSAGE_VARIANT_ID,
+                    "en": OS_TEST_ENGLISH_VARIANT_ID
+                ],
+                "all": [
+                    "default": "should_never_be_used_by_any_test"
+                ]
+            ],
+            "triggers": []
+        ]
+    }
+
+    /// Returns the JSON of an in-app message with trigger.
+    @objc
+    public static func testMessageJsonWithTrigger(property: String, triggerId: String, type: Int32, value: Any) -> [String: Any] {
+        var testMessage = self.testDefaultMessageJson()
+
+        testMessage["triggers"] = [
+            [
+                [
+                    "kind": property,
+                    "property": property,
+                    "operator": OS_OPERATOR_TO_STRING(type),
+                    "value": value,
+                    "id": triggerId
+                ]
+            ]
+        ]
+        return testMessage
+    }
+
+    @objc
+    public static func testFetchMessagesResponse(messages: [[String: Any]]) -> [String: Any] {
+        return [
+            "in_app_messages": messages
+        ]
+    }
+
+    /// Returns the JSON of a preview or test in-app message.
+    @objc
+    public static func testMessagePreviewJson() -> [String: Any] {
+        var message = self.testDefaultMessageJson()
+        message["is_preview"] = true
+        return message
+    }
+}