Merge pull request #36 from mparticle-integrations/test/add-unit-tests-for-consent-mapping-logic

test: Add unit tests for consent mapping logic

Author: nickolas-dimitrakas

Package.swift

@@ -28,5 +28,18 @@ let package = Package(
             exclude: ["Info.plist", "dummy.swift"],
             resources: [.process("PrivacyInfo.xcprivacy")],
             publicHeadersPath: "."),
+        
+        .testTarget(
+            name: "mParticle-Google-Analytics-Firebase-Swift-Tests",
+            dependencies: ["mParticle-Google-Analytics-Firebase"],
+            path: "mParticle-Google-Analytics-FirebaseTests/Swift"
+        ),
+
+        .testTarget(
+            name: "mParticle-Google-Analytics-Firebase-Objc-Tests",
+            dependencies: ["mParticle-Google-Analytics-Firebase"],
+            path: "mParticle-Google-Analytics-FirebaseTests/Objc",
+            resources: [.process("GoogleService-Info.plist")]
+        )
     ]
 )

mParticle-Google-Analytics-Firebase/MPKitFirebaseAnalytics.h

@@ -17,6 +17,15 @@
 @property (nonatomic, unsafe_unretained, readonly) BOOL started;
 @property (nonatomic, strong, nullable) MPKitAPI *kitApi;
 
+- (nullable NSNumber *)resolvedConsentForMappingKey:(NSString * _Nonnull)mappingKey
+                                         defaultKey:(NSString * _Nonnull)defaultKey
+                                       gdprConsents:(NSDictionary<NSString *, MPGDPRConsent *> * _Nonnull)gdprConsents
+                                            mapping:(NSDictionary<NSString *, NSString *> * _Nullable)mapping;
+
+- (nullable NSArray<NSDictionary *>*)mappingForKey:(NSString* _Nonnull)key;
+
+- (nonnull NSDictionary*)convertToKeyValuePairs: (NSArray<NSDictionary *> * _Nonnull)mappings;
+
 @end
 
 static NSString * _Nonnull const kMPFIRGoogleAppIDKey = @"firebaseAppId";

mParticle-Google-Analytics-Firebase/MPKitFirebaseAnalytics.m

@@ -13,6 +13,19 @@
     #endif
 #endif
 
+@implementation NSString(PRIVATE)
+
+- (NSNumber*)isGranted {
+    if ([self isEqualToString:@"Granted"]) {
+        return @(YES);
+    } else if ([self isEqualToString:@"Denied"]) {
+        return @(NO);
+    }
+    return nil;
+}
+
+@end
+
 @interface MPKitFirebaseAnalytics () <MPKitProtocol> {
     BOOL forwardRequestsServerSide;
 }
@@ -77,6 +90,11 @@ - (MPKitExecStatus *)execStatus:(MPKitReturnCode)returnCode {
 
 #pragma mark MPKitInstanceProtocol methods
 - (MPKitExecStatus *)didFinishLaunchingWithConfiguration:(NSDictionary *)configuration {
+    MParticleUser *currentUser = [[[MParticle sharedInstance] identity] currentUser];
+    return [self didFinishLaunchingWithConfiguration:configuration withConsentState:currentUser.consentState];
+}
+
+- (MPKitExecStatus *)didFinishLaunchingWithConfiguration:(NSDictionary *)configuration withConsentState: (MPConsentState *)consentState {
     _configuration = configuration;
 
     if ([FIRApp defaultApp] == nil) {
@@ -88,7 +106,7 @@ - (MPKitExecStatus *)didFinishLaunchingWithConfiguration:(NSDictionary *)configu
             [self updateInstanceIDIntegration];
         }
 
-        [self updateConsent];
+        [self updateConsent: consentState];
 
         _started = YES;
 
@@ -356,21 +374,19 @@ - (void)logUserAttributes:(NSDictionary<NSString *, id> *)userAttributes {
 }
 
 - (MPKitExecStatus *)setConsentState:(nullable MPConsentState *)state {
-    [self updateConsent];
+    [self updateConsent: state];
 
     return [self execStatus:MPKitReturnCodeSuccess];
 }
 
-- (void)updateConsent {
+- (void)updateConsent:(MPConsentState *)consentState {
     NSArray<NSDictionary *> *mappings = [self mappingForKey: @"consentMappingSDK"];
     NSDictionary<NSString *, NSString *> *mappingsConfig;
     if (mappings != nil) {
         mappingsConfig = [self convertToKeyValuePairs: mappings];
     }
 
-    
-    MParticleUser *currentUser = [[[MParticle sharedInstance] identity] currentUser];
-    NSDictionary<NSString *, MPGDPRConsent *> *gdprConsents = currentUser.consentState.gdprConsentState;
+    NSDictionary<NSString *, MPGDPRConsent *> *gdprConsents = consentState.gdprConsentState;
 
     NSNumber *adStorage = [self resolvedConsentForMappingKey:kMPFIRGAAdStorageKey
                                                   defaultKey:kMPFIRGA4DefaultAdStorageKey
@@ -650,16 +666,11 @@ - (NSNumber * _Nullable)resolvedConsentForMappingKey:(NSString *)mappingKey
 
     // Fallback to configuration defaults
     NSString *value = self->_configuration[defaultKey];
-    if ([value isEqualToString:@"Granted"]) {
-        return @(YES);
-    } else if ([value isEqualToString:@"Denied"]) {
-        return @(NO);
-    }
-    return nil;
+    return [value isGranted];
 }
 
 - (NSArray<NSDictionary *>*)mappingForKey:(NSString*)key {
-    NSString *mappingJson = _configuration[@"consentMappingSDK"];
+    NSString *mappingJson = _configuration[key];
     if (![mappingJson isKindOfClass:[NSString class]]) {
         return nil;
     }

mParticle-Google-Analytics-FirebaseTests/Info.plist

@@ -20,8 +20,22 @@ @interface mParticle_Firebase_AnalyticsTests : XCTestCase
 @implementation mParticle_Firebase_AnalyticsTests
 
 - (void)setUp {
-    NSString *bundlePath = [[NSBundle bundleForClass:[self class]] resourcePath];
-    NSString *filePath = [bundlePath stringByAppendingPathComponent:@"GoogleService-Info.plist"];
+    [super setUp];
+
+    // 1. Start with the test bundle
+    NSBundle *testBundle = [NSBundle bundleForClass:[self class]];
+
+    // 2. Locate the auto-generated resource bundle for this test target
+    NSURL *resourceBundleURL = [testBundle URLForResource:@"mParticle-Google-Analytics-Firebase_mParticle-Google-Analytics-Firebase-Objc-Tests"
+                                            withExtension:@"bundle"];
+    NSBundle *resourceBundle = [NSBundle bundleWithURL:resourceBundleURL];
+    NSAssert(resourceBundle != nil, @"Resource bundle not found");
+
+    // 3. Fetch the plist inside that resource bundle
+    NSString *filePath = [resourceBundle pathForResource:@"GoogleService-Info" ofType:@"plist"];
+    NSAssert(filePath != nil, @"GoogleService-Info.plist not found in resource bundle");
+    
+    // 4. Configure Firebase
     FIROptions *options = [[FIROptions alloc] initWithContentsOfFile:filePath];
     [FIRApp configureWithOptions:options];
 }

…s-FirebaseTests/GoogleService-Info.plist …ebaseTests/Objc/GoogleService-Info.plistmParticle-Google-Analytics-FirebaseTests/GoogleService-Info.plist renamed to mParticle-Google-Analytics-FirebaseTests/Objc/GoogleService-Info.plist mParticle-Google-Analytics-FirebaseTests/GoogleService-Info.plist renamed to mParticle-Google-Analytics-FirebaseTests/Objc/GoogleService-Info.plist

@@ -0,0 +1,118 @@
+//
+//  File.swift
+//  mParticle-Google-Analytics-Firebase
+//
+//  Created by Nick Dimitrakas on 9/16/25.
+//
+
+import XCTest
+@testable import mParticle_Google_Analytics_Firebase
+
+final class MPKitFirebaseSwiftTests: XCTestCase {
+
+    var kit: MPKitFirebaseAnalytics!
+
+    // MARK: - Lifecycle
+
+    override func setUpWithError() throws {
+        try super.setUpWithError()
+        kit = MPKitFirebaseAnalytics()
+        kit.configuration = [:]
+    }
+
+    override func tearDownWithError() throws {
+        kit = nil
+        try super.tearDownWithError()
+    }
+
+    // MARK: - convertToKeyValuePairs
+
+    func test_convertToKeyValuePairs_createsLowercasedMapping() {
+        let mappings: [[String: String]] = [
+            ["value": "ad_storage", "map": "Advertising"],
+            ["value": "analytics_storage", "map": "Analytics"]
+        ]
+
+        let result = kit.convert(toKeyValuePairs: mappings)
+        XCTAssertEqual(result["ad_storage"] as! String, "advertising")
+        XCTAssertEqual(result["analytics_storage"] as! String, "analytics")
+    }
+
+    // MARK: - mappingForKey
+
+    func test_mappingForKey_withValidJSON_returnsArray() {
+        let jsonString = """
+        [
+          { "value": "ad_storage", "map": "Advertising" },
+          { "value": "analytics_storage", "map": "Analytics" }
+        ]
+        """
+        kit.configuration["consentMappingSDK"] = jsonString
+
+        let result = kit.mapping(forKey: "consentMappingSDK")
+        XCTAssertNotNil(result)
+        XCTAssertEqual(result!.count, 2)
+    }
+
+    func test_mappingForKey_withInvalidJSON_returnsNil() {
+        kit.configuration["consentMappingSDK"] = "{ not valid json }"
+        let result = kit.mapping(forKey: "consentMappingSDK")
+        XCTAssertNil(result)
+    }
+
+    // MARK: - resolvedConsentForMappingKey
+
+    func test_resolvedConsentForMappingKey_withGDPRMapping_returnsTrue() {
+        let consent = MPGDPRConsent()
+        consent.consented = true
+        let gdprConsents = ["advertising": consent]
+
+        let mapping = ["ad_storage": "advertising"]
+
+        let result = kit.resolvedConsent(
+            forMappingKey: "ad_storage",
+            defaultKey: "defaultAdStorageConsentSDK",
+            gdprConsents: gdprConsents,
+            mapping: mapping
+        )
+        XCTAssertEqual(result, true)
+    }
+
+    func test_resolvedConsentForMappingKey_withGDPRMapping_returnsFalse() {
+        let consent = MPGDPRConsent()
+        consent.consented = false
+        let gdprConsents = ["advertising": consent]
+
+        let mapping = ["ad_storage": "advertising"]
+
+        let result = kit.resolvedConsent(
+            forMappingKey: "ad_storage",
+            defaultKey: "defaultAdStorageConsentSDK",
+            gdprConsents: gdprConsents,
+            mapping: mapping
+        )
+        XCTAssertEqual(result, false)
+    }
+
+    func test_resolvedConsentForMappingKey_withDefaultValue_returnsFalse() {
+        kit.configuration["defaultAdStorageConsentSDK"] = "Denied"
+
+        let result = kit.resolvedConsent(
+            forMappingKey: "ad_storage",
+            defaultKey: "defaultAdStorageConsentSDK",
+            gdprConsents: [:],
+            mapping: [:]
+        )
+        XCTAssertEqual(result, false)
+    }
+
+    func test_resolvedConsentForMappingKey_withNoMappingOrDefault_returnsNil() {
+        let result = kit.resolvedConsent(
+            forMappingKey: "ad_storage",
+            defaultKey: "defaultAdStorageConsentSDK",
+            gdprConsents: [:],
+            mapping: [:]
+        )
+        XCTAssertNil(result)
+    }
+}