Skip to content

Commit f7a7a0b

Browse files
nan-linan-li
committed
chore(tests): Make a MockMessagingController
* Make a `MockMessagingController` in Objective C to allow us to access internal APIs on the OSMessagingController without needing to make them public. This is needed because Swift code cannot access Objective-C APIs unless they are public. This is a workaround for this limitation.
1 parent 30e46a1 commit f7a7a0b

File tree

4 files changed

+96
-0
lines changed

4 files changed

+96
-0
lines changed

‎iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@
105105
3C7022232ECF124B001768C6 /* OneSignalInAppMessagesMocks.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 3C70221C2ECF124B001768C6 /* OneSignalInAppMessagesMocks.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; };
106106
3C70222B2ECF126B001768C6 /* OneSignalInAppMessagesMocks.h in Headers */ = {isa = PBXBuildFile; fileRef = 3C7022292ECF126B001768C6 /* OneSignalInAppMessagesMocks.h */; settings = {ATTRIBUTES = (Public, ); }; };
107107
3C70222D2ECF12A5001768C6 /* IAMTestHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 3C70222C2ECF12A5001768C6 /* IAMTestHelpers.swift */; };
108+
3C7022302ECF1620001768C6 /* MockMessagingController.m in Sources */ = {isa = PBXBuildFile; fileRef = 3C70222F2ECF1620001768C6 /* MockMessagingController.m */; };
109+
3C7022312ECF1620001768C6 /* MockMessagingController.h in Headers */ = {isa = PBXBuildFile; fileRef = 3C70222E2ECF1620001768C6 /* MockMessagingController.h */; settings = {ATTRIBUTES = (Public, ); }; };
108110
3C70FA672D0B68A100031066 /* OneSignalClientError.h in Headers */ = {isa = PBXBuildFile; fileRef = 3C70FA652D0B68A100031066 /* OneSignalClientError.h */; settings = {ATTRIBUTES = (Public, ); }; };
109111
3C70FA682D0B68A100031066 /* OneSignalClientError.m in Sources */ = {isa = PBXBuildFile; fileRef = 3C70FA662D0B68A100031066 /* OneSignalClientError.m */; };
110112
3C789DBD293C2206004CF83D /* OSFocusInfluenceParam.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A600B432453790700514A53 /* OSFocusInfluenceParam.m */; };
@@ -1324,6 +1326,8 @@
13241326
3C70221C2ECF124B001768C6 /* OneSignalInAppMessagesMocks.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = OneSignalInAppMessagesMocks.framework; sourceTree = BUILT_PRODUCTS_DIR; };
13251327
3C7022292ECF126B001768C6 /* OneSignalInAppMessagesMocks.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalInAppMessagesMocks.h; sourceTree = "<group>"; };
13261328
3C70222C2ECF12A5001768C6 /* IAMTestHelpers.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = IAMTestHelpers.swift; sourceTree = "<group>"; };
1329+
3C70222E2ECF1620001768C6 /* MockMessagingController.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MockMessagingController.h; sourceTree = "<group>"; };
1330+
3C70222F2ECF1620001768C6 /* MockMessagingController.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MockMessagingController.m; sourceTree = "<group>"; };
13271331
3C70FA652D0B68A100031066 /* OneSignalClientError.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalClientError.h; sourceTree = "<group>"; };
13281332
3C70FA662D0B68A100031066 /* OneSignalClientError.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OneSignalClientError.m; sourceTree = "<group>"; };
13291333
3C7A39D42B7C18EE0082665E /* XCTest.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = XCTest.framework; path = Platforms/iPhoneOS.platform/Developer/Library/Frameworks/XCTest.framework; sourceTree = DEVELOPER_DIR; };
@@ -2195,6 +2199,8 @@
21952199
isa = PBXGroup;
21962200
children = (
21972201
3C7022292ECF126B001768C6 /* OneSignalInAppMessagesMocks.h */,
2202+
3C70222E2ECF1620001768C6 /* MockMessagingController.h */,
2203+
3C70222F2ECF1620001768C6 /* MockMessagingController.m */,
21982204
3C70222C2ECF12A5001768C6 /* IAMTestHelpers.swift */,
21992205
);
22002206
path = OneSignalInAppMessagesMocks;
@@ -3156,6 +3162,7 @@
31563162
buildActionMask = 2147483647;
31573163
files = (
31583164
3C70222B2ECF126B001768C6 /* OneSignalInAppMessagesMocks.h in Headers */,
3165+
3C7022312ECF1620001768C6 /* MockMessagingController.h in Headers */,
31593166
);
31603167
runOnlyForDeploymentPostprocessing = 0;
31613168
};
@@ -4329,6 +4336,7 @@
43294336
isa = PBXSourcesBuildPhase;
43304337
buildActionMask = 2147483647;
43314338
files = (
4339+
3C7022302ECF1620001768C6 /* MockMessagingController.m in Sources */,
43324340
3C70222D2ECF12A5001768C6 /* IAMTestHelpers.swift in Sources */,
43334341
);
43344342
runOnlyForDeploymentPostprocessing = 0;

‎iOS_SDK/OneSignalSDK/OneSignalInAppMessagesMocks/MockMessagingController.h‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
Modified MIT License
3+
4+
Copyright 2025 OneSignal
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
1. The above copyright notice and this permission notice shall be included in
14+
all copies or substantial portions of the Software.
15+
16+
2. All copies of substantial portions of the Software may only be used in connection
17+
with services provided by OneSignal.
18+
19+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25+
THE SOFTWARE.
26+
*/
27+
28+
#import <Foundation/Foundation.h>
29+
#import <OneSignalCore/OneSignalCore.h>
30+
31+
NS_ASSUME_NONNULL_BEGIN
32+
33+
@interface MockMessagingController : NSObject
34+
+ (NSArray <OSInAppMessage *> *)messageDisplayQueue; // TODO: NL may need to be changed to return OSInAppMessageInternal
35+
+ (BOOL)isInAppMessageShowing;
36+
@end
37+
38+
NS_ASSUME_NONNULL_END

‎iOS_SDK/OneSignalSDK/OneSignalInAppMessagesMocks/MockMessagingController.m‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/*
2+
Modified MIT License
3+
4+
Copyright 2025 OneSignal
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
1. The above copyright notice and this permission notice shall be included in
14+
all copies or substantial portions of the Software.
15+
16+
2. All copies of substantial portions of the Software may only be used in connection
17+
with services provided by OneSignal.
18+
19+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25+
THE SOFTWARE.
26+
*/
27+
28+
#import "MockMessagingController.h"
29+
#import "OSMessagingController.h"
30+
31+
@interface OSMessagingController ()
32+
@property (strong, nonatomic, nonnull) NSMutableArray <OSInAppMessageInternal *> *messageDisplayQueue;
33+
@end
34+
35+
@implementation MockMessagingController
36+
+ (void)resetState {
37+
// TODO: reseting OSMessagingController state between tests
38+
}
39+
40+
+ (NSArray *)messageDisplayQueue {
41+
return OSMessagingController.sharedInstance.messageDisplayQueue;
42+
}
43+
44+
+ (BOOL)isInAppMessageShowing {
45+
return OSMessagingController.sharedInstance.isInAppMessageShowing;
46+
}
47+
48+
@end

‎iOS_SDK/OneSignalSDK/OneSignalInAppMessagesMocks/OneSignalInAppMessagesMocks.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,5 @@ FOUNDATION_EXPORT double OneSignalInAppMessagesMocksVersionNumber;
3434
FOUNDATION_EXPORT const unsigned char OneSignalInAppMessagesMocksVersionString[];
3535

3636
// In this header, you should import all the public headers of your framework using statements like #import <OneSignalInAppMessagesMocks/PublicHeader.h>
37+
38+
#import <OneSignalInAppMessagesMocks/MockMessagingController.h>

0 commit comments

Comments
 (0)