Set AppId and Dev or Prod keys from a plist (#383)

nzagorchev · web-flow · commit 114e5010646c · 2020-07-10T11:24:10.000+03:00
* Set AppId and Dev or Prod keys from a plist

* Moved setting the keys to Leanplum load method. Introduced environment setting to control prod/dev mode

* Fix Leanplum throwError to rethrow exceptions in unit tests.
diff --git a/Example/Leanplum-SDK.xcodeproj/project.pbxproj b/Example/Leanplum-SDK.xcodeproj/project.pbxproj
@@ -117,6 +117,7 @@
 		A8F4479E2449769000F6978A /* LPNetworkOperationTest.m in Sources */ = {isa = PBXBuildFile; fileRef = A8F4479D2449769000F6978A /* LPNetworkOperationTest.m */; };
 		B449EB2A21F27AB2005C93B6 /* TiedPrioritiesDifferentDelay.json in Resources */ = {isa = PBXBuildFile; fileRef = B449EB2921F27AB2005C93B6 /* TiedPrioritiesDifferentDelay.json */; };
 		B449EB2B21F27B0B005C93B6 /* TiedPrioritiesDifferentDelay.json in Resources */ = {isa = PBXBuildFile; fileRef = B449EB2921F27AB2005C93B6 /* TiedPrioritiesDifferentDelay.json */; };
+		E773031E24AB871E00EDF983 /* Leanplum-Info.plist in Resources */ = {isa = PBXBuildFile; fileRef = E773031D24AB871E00EDF983 /* Leanplum-Info.plist */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -241,6 +242,7 @@
 		B5CCCA371D74B64D005ADEE1 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
 		B5CCCA391D74B64D005ADEE1 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		D2BDBCD86C8BEA8BF5B15B99 /* Pods-Leanplum-SDK_Example.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Leanplum-SDK_Example.debug.xcconfig"; path = "Pods/Target Support Files/Pods-Leanplum-SDK_Example/Pods-Leanplum-SDK_Example.debug.xcconfig"; sourceTree = "<group>"; };
+		E773031D24AB871E00EDF983 /* Leanplum-Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = "Leanplum-Info.plist"; sourceTree = "<group>"; };
 		ED67DCDB70EA6598AF12284A /* Pods-Leanplum-SDK_Example.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Leanplum-SDK_Example.release.xcconfig"; path = "Pods/Target Support Files/Pods-Leanplum-SDK_Example/Pods-Leanplum-SDK_Example.release.xcconfig"; sourceTree = "<group>"; };
 		F5CF859C9DD307380E6F9A30 /* LICENSE */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text; name = LICENSE; path = ../LICENSE; sourceTree = "<group>"; };
 /* End PBXFileReference section */
@@ -476,6 +478,7 @@
 		6003F5B6195388D20070C39A /* Supporting Files */ = {
 			isa = PBXGroup;
 			children = (
+				E773031D24AB871E00EDF983 /* Leanplum-Info.plist */,
 				6003F5B7195388D20070C39A /* Tests-Info.plist */,
 				6003F5B8195388D20070C39A /* InfoPlist.strings */,
 				606FC2411953D9B200FFA9A0 /* Tests-Prefix.pch */,
@@ -646,6 +649,7 @@
 				07E5C8F01F052DD000A4B092 /* DifferentPrioritiesWithMissingValues.json in Resources */,
 				6003F5A9195388D20070C39A /* Images.xcassets in Resources */,
 				07E5C8EB1F052DCC00A4B092 /* test.file in Resources */,
+				E773031E24AB871E00EDF983 /* Leanplum-Info.plist in Resources */,
 				07E5C8E81F052DC700A4B092 /* malformed_track_event_response.json in Resources */,
 				07E5C8F31F052DD000A4B092 /* sample_action_notification.json in Resources */,
 				07E5C8E51F052DC400A4B092 /* track_event_response.json in Resources */,
diff --git a/Example/Tests/Classes/LeanplumTest.m b/Example/Tests/Classes/LeanplumTest.m
@@ -40,6 +40,9 @@
 #import "LPRegisterDevice.h"
 #import "Leanplum.h"
 #import "LPOperationQueue.h"
+#import "LPAPIConfig.h"
+
+#import <OCMock/OCMArg.h>
 
 /**
  * Tests leanplum public methods, we seed predefined response that comes from backend
@@ -75,6 +78,10 @@ + (void)setUp
 
 - (void)setUp {
     [super setUp];
+    
+    // Clear the set keys, required for plist testing
+    [[LPAPIConfig sharedConfig] setAppId:nil withAccessKey:nil];
+    [[LPConstantsState sharedState] setIsDevelopmentModeEnabled:NO];
 }
 
 - (void)tearDown {
@@ -84,6 +91,142 @@ - (void)tearDown {
     [HTTPStubs removeAllStubs];
 }
 
+/**
+ * Tests setting the environment in the plist to production.
+ */
+- (void) test_leanplum_load_plist_env_key_prod
+{
+    id mockLeanplum = OCMClassMock([Leanplum class]);
+    NSMutableDictionary *plistDict = [[NSMutableDictionary alloc] initWithDictionary:[Leanplum getDefaultAppKeysPlist] copyItems:YES];
+    plistDict[kEnvKey] = kEnvProduction;
+    [[[mockLeanplum stub] andReturn:plistDict] getDefaultAppKeysPlist];
+    // Force reload
+    [Leanplum load];
+
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] appId], APPLICATION_ID);
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] accessKey], PRODUCTION_KEY);
+    XCTAssertFalse([[LPConstantsState sharedState] isDevelopmentModeEnabled]);
+}
+
+/**
+ * Tests setting the environment in the plist to development.
+ */
+- (void) test_leanplum_load_plist_env_key_dev
+{
+    id mockLeanplum = OCMClassMock([Leanplum class]);
+    NSMutableDictionary *plistDict = [[NSMutableDictionary alloc] initWithDictionary:[Leanplum getDefaultAppKeysPlist] copyItems:YES];
+    plistDict[kEnvKey] = kEnvDevelopment;
+    [[[mockLeanplum stub] andReturn:plistDict] getDefaultAppKeysPlist];
+    // Force reload
+    [Leanplum load];
+    
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] appId], APPLICATION_ID);
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] accessKey], DEVELOPMENT_KEY);
+    XCTAssertTrue([[LPConstantsState sharedState] isDevelopmentModeEnabled]);
+}
+
+/**
+ * Tests setting explicitly the environment to development.
+ */
+- (void) test_set_app_environment_dev
+{
+    [Leanplum setAppEnvironment:kEnvDevelopment];
+    
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] appId], APPLICATION_ID);
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] accessKey], DEVELOPMENT_KEY);
+    XCTAssertTrue([[LPConstantsState sharedState] isDevelopmentModeEnabled]);
+}
+
+/**
+ * Tests setting explicitly the environment to production.
+ */
+- (void) test_set_app_environment_prod
+{
+    [Leanplum setAppEnvironment:kEnvProduction];
+    
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] appId], APPLICATION_ID);
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] accessKey], PRODUCTION_KEY);
+    XCTAssertFalse([[LPConstantsState sharedState] isDevelopmentModeEnabled]);
+}
+
+/**
+ * Tests environment cannot be set with incorrect value.
+ */
+- (void) test_set_app_environment_incorrect
+{
+    [LeanplumHelper mockThrowErrorToThrow];
+    XCTAssertThrows([Leanplum setAppEnvironment:@"staging"], @"Incorrect environment.");
+    XCTAssertTrue([LeanplumHelper.lastErrorMessage containsString:@"Incorrect env parameter."]);
+}
+
+/**
+ * Tests environment cannot be set after Leanplum has started.
+ */
+- (void) test_set_app_environment_after_start
+{
+    [LeanplumHelper mockThrowErrorToThrow];
+    
+    [Leanplum load];
+    // Set Leanplum start was executed.
+    [[LPInternalState sharedState] setCalledStart:YES];
+    
+    XCTAssertThrows([Leanplum setAppEnvironment:kEnvProduction], @"Already called start.");
+    XCTAssertTrue([LeanplumHelper.lastErrorMessage containsString:@"Leanplum already started. Call this method before [Leanplum start]."]);
+}
+
+/**
+ * Tests app keys remain unset if plist is nil.
+ */
+- (void) test_leanplum_load_plist_with_nil
+{
+    id mockLeanplum = OCMClassMock([Leanplum class]);
+    [[[mockLeanplum stub] andReturn:nil] getDefaultAppKeysPlist];
+    // Force reload
+    [Leanplum load];
+    
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] appId], nil);
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] accessKey], nil);
+    XCTAssertFalse([[LPConstantsState sharedState] isDevelopmentModeEnabled]);
+}
+
+/**
+ * Tests setting the app keys with Leanplum load method using plist.
+ */
+- (void) test_leanplum_load_plist
+{
+    [Leanplum load];
+    #if DEBUG
+        XCTAssertEqualObjects([[LPAPIConfig sharedConfig] accessKey], DEVELOPMENT_KEY);
+        XCTAssertTrue([[LPConstantsState sharedState] isDevelopmentModeEnabled]);
+    #else
+        XCTAssertEqualObjects([[LPAPIConfig sharedConfig] accessKey], PRODUCTION_KEY);
+        XCTAssertFalse([[LPConstantsState sharedState] isDevelopmentModeEnabled]);
+    #endif
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] appId], APPLICATION_ID);
+}
+
+/**
+ * Tests setting the app for development using plist.
+ */
+- (void) test_set_development_from_plist
+{
+    [Leanplum setAppUsingPlist:[Leanplum getDefaultAppKeysPlist] forEnvironment:kEnvDevelopment];
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] appId], APPLICATION_ID);
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] accessKey], DEVELOPMENT_KEY);
+    XCTAssertTrue([[LPConstantsState sharedState] isDevelopmentModeEnabled]);
+}
+
+/**
+ * Tests setting the app for production using plist.
+ */
+- (void) test_set_production_from_plist
+{
+    [Leanplum setAppUsingPlist:[Leanplum getDefaultAppKeysPlist] forEnvironment:kEnvProduction];
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] appId], APPLICATION_ID);
+    XCTAssertEqualObjects([[LPAPIConfig sharedConfig] accessKey], PRODUCTION_KEY);
+    XCTAssertFalse([[LPConstantsState sharedState] isDevelopmentModeEnabled]);
+}
+
 /**
  * Tests a simple development start.
  */
diff --git a/Example/Tests/Classes/Utilities/LeanplumHelper.h b/Example/Tests/Classes/Utilities/LeanplumHelper.h
@@ -43,6 +43,8 @@ static BOOL recordSnapshots = NO;
 
 @interface LeanplumHelper : NSObject
 
+@property (class) NSString *lastErrorMessage;
+
 /// called before starting any test, to swizzle methods
 + (void)setup_method_swizzling;
 
@@ -70,4 +72,6 @@ static BOOL recordSnapshots = NO;
 
 + (void)dismissPresentedViewControllers;
 
++ (void)mockThrowErrorToThrow;
+
 @end
diff --git a/Example/Tests/Classes/Utilities/LeanplumHelper.m b/Example/Tests/Classes/Utilities/LeanplumHelper.m
@@ -27,6 +27,7 @@
 #import <XCTest/XCTest.h>
 #import <OHHTTPStubs/HTTPStubs.h>
 #import <OHHTTPStubs/HTTPStubsPathHelpers.h>
+#import <OCMock/OCMock.h>
 #import "LeanplumHelper.h"
 #import "LeanplumRequest+Categories.h"
 #import "LPVarCache+Extensions.h"
@@ -38,6 +39,7 @@
 #import "LPAPIConfig.h"
 #import "LPOperationQueue.h"
 
+// Keys also used in Leanplum-Info.plist file
 NSString *APPLICATION_ID = @"app_nLiaLr3lXvCjXhsztS1Gw8j281cPLO6sZetTDxYnaSk";
 NSString *DEVELOPMENT_KEY = @"dev_2bbeWLmVJyNrqI8F21Kn9nqyUPRkVCUoLddBkHEyzmk";
 NSString *PRODUCTION_KEY = @"prod_XYpURdwPAaxJyYLclXNfACe9Y8hs084dBx2pB8wOnqU";
@@ -48,6 +50,17 @@
 
 @implementation LeanplumHelper
 
+static NSString *_lastErrorMessage = nil;
+
++ (NSString *)lastErrorMessage {
+  return _lastErrorMessage;
+}
+
++ (void)setLastErrorMessage:(NSString *)lastErrorMessage {
+    NSLog(@"Exception: %@", lastErrorMessage);
+    _lastErrorMessage = lastErrorMessage;
+}
+
 static BOOL swizzled = NO;
 
 + (void)setup_method_swizzling {
@@ -164,4 +177,16 @@ + (void)dismissPresentedViewControllers
     [[UIApplication sharedApplication].keyWindow.rootViewController dismissViewControllerAnimated:false completion:nil];
 }
 
++ (void) throwError:(NSString *) err
+{
+    [LeanplumHelper setLastErrorMessage:err];
+    @throw([NSException exceptionWithName:err reason:nil userInfo:nil]);
+}
+
++ (void) mockThrowErrorToThrow
+{
+    id mockLeanplumClass = OCMClassMock([Leanplum class]);
+    [OCMStub(ClassMethod([mockLeanplumClass throwError:[OCMArg any]])) andCall:@selector(throwError:) onObject:self];
+}
+
 @end
diff --git a/Example/Tests/Leanplum-Info.plist b/Example/Tests/Leanplum-Info.plist
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>APP_ID</key>
+	<string>app_nLiaLr3lXvCjXhsztS1Gw8j281cPLO6sZetTDxYnaSk</string>
+	<key>DEV_KEY</key>
+	<string>dev_2bbeWLmVJyNrqI8F21Kn9nqyUPRkVCUoLddBkHEyzmk</string>
+	<key>PROD_KEY</key>
+	<string>prod_XYpURdwPAaxJyYLclXNfACe9Y8hs084dBx2pB8wOnqU</string>
+</dict>
+</plist>
diff --git a/Leanplum-SDK/Classes/Internal/Leanplum.m b/Leanplum-SDK/Classes/Internal/Leanplum.m
@@ -51,6 +51,16 @@
 #import "LPOperationQueue.h"
 #include <sys/sysctl.h>
 
+NSString *const kAppKeysFileName = @"Leanplum-Info";
+NSString *const kAppKeysFileType = @"plist";
+
+NSString *const kAppIdKey = @"APP_ID";
+NSString *const kDevKey = @"DEV_KEY";
+NSString *const kProdKey = @"PROD_KEY";
+NSString *const kEnvKey = @"ENV";
+NSString *const kEnvDevelopment = @"development";
+NSString *const kEnvProduction = @"production";
+
 static NSString *leanplum_deviceId = nil;
 static NSString *registrationEmail = nil;
 __weak static NSExtensionContext *_extensionContext = nil;
@@ -81,6 +91,24 @@ - (void)leanplum_cancelRequestWithError:(NSError *)error
 
 @implementation Leanplum
 
++(void)load
+{
+    NSDictionary *appKeysDictionary = [self getDefaultAppKeysPlist];
+    if (appKeysDictionary == nil) {
+        return;
+    }
+    NSString *env = appKeysDictionary[kEnvKey];
+    if ([self setAppUsingPlist:appKeysDictionary forEnvironment:env]) {
+        return;
+    }
+
+#if DEBUG
+    [self setAppUsingPlist:appKeysDictionary forEnvironment:kEnvDevelopment];
+#else
+    [self setAppUsingPlist:appKeysDictionary forEnvironment:kEnvProduction];
+#endif
+}
+
 + (void)throwError:(NSString *)reason
 {
     if ([LPConstantsState sharedState].isDevelopmentModeEnabled) {
@@ -236,6 +264,50 @@ + (void)setInAppPurchaseEventName:(NSString *)event
     LP_END_TRY
 }
 
++ (NSDictionary *) getDefaultAppKeysPlist
+{
+    NSString *plistFilePath = [[NSBundle mainBundle] pathForResource:kAppKeysFileName ofType:kAppKeysFileType];
+    NSString *ignoreMessage = @"Ignore if not using Leanplum with plist configuration.";
+    if (plistFilePath == nil) {
+        NSLog(@"%@", [NSString stringWithFormat:@"[Leanplum getDefaultAppKeysPlist] Could not locate configuration file: '%@.%@'. %@", kAppKeysFileName, kAppKeysFileType, ignoreMessage]);
+        return nil;
+    }
+    
+    NSDictionary *appKeysDictionary = [NSDictionary dictionaryWithContentsOfFile:plistFilePath];
+    if (appKeysDictionary == nil) {
+        NSLog(@"%@", [NSString stringWithFormat:@"[Leanplum getDefaultAppKeysPlist] The configuration file is not a dictionary: '%@.%@'. %@", kAppKeysFileName, kAppKeysFileType, ignoreMessage]);
+    }
+    
+    return appKeysDictionary;
+}
+
++ (BOOL)setAppUsingPlist:(NSDictionary *)appKeysDictionary forEnvironment:(NSString *)env {
+    if ([[env lowercaseString] isEqualToString:kEnvDevelopment]) {
+        [self setAppId:appKeysDictionary[kAppIdKey] withDevelopmentKey:appKeysDictionary[kDevKey]];
+        NSLog(@"%@", [NSString stringWithFormat:@"Leanplum configured for '%@' using configuration file: '%@.%@'.", kEnvDevelopment, kAppKeysFileName, kAppKeysFileType]);
+        return YES;
+    } else if ([[env lowercaseString] isEqualToString:kEnvProduction]) {
+        [self setAppId:appKeysDictionary[kAppIdKey] withProductionKey:appKeysDictionary[kProdKey]];
+        NSLog(@"%@", [NSString stringWithFormat:@"Leanplum configured for '%@' using configuration file: '%@.%@'.", kEnvProduction, kAppKeysFileName, kAppKeysFileType]);
+        return YES;
+    }
+    return NO;
+}
+
++ (void)setAppEnvironment:(NSString *)env
+{
+    if (![[env lowercaseString] isEqualToString:kEnvProduction] && ![[env lowercaseString] isEqualToString:kEnvDevelopment]) {
+        [self throwError:@"[Leanplum setAppEnvironment:] Incorrect env parameter. Use \"development\" or \"production\"."];
+        return;
+    }
+    if ([LPInternalState sharedState].calledStart) {
+        [self throwError:@"[Leanplum setAppEnvironment:] Leanplum already started. Call this method before [Leanplum start]."];
+        return;
+    }
+
+    [self setAppUsingPlist:[Leanplum getDefaultAppKeysPlist] forEnvironment:env];
+}
+
 + (void)setAppId:(NSString *)appId withDevelopmentKey:(NSString *)accessKey
 {
     if ([LPUtils isNullOrEmpty:appId]) {
diff --git a/Leanplum-SDK/Classes/Internal/LeanplumInternal.h b/Leanplum-SDK/Classes/Internal/LeanplumInternal.h
@@ -36,6 +36,20 @@ NS_ASSUME_NONNULL_BEGIN
 @class LeanplumSocket;
 @class LPRegisterDevice;
 
+/**
+ * Keys for the plist file name
+ */
+extern NSString *const kAppKeysFileName;
+extern NSString *const kAppKeysFileType;
+
+/**
+ * Keys for the strings in the plist file.
+ */
+extern NSString *const kAppIdKey;
+extern NSString *const kDevKey;
+extern NSString *const kProdKey;
+extern NSString *const kEnvKey;
+
 @interface Leanplum ()
 
 typedef void (^LeanplumStartIssuedBlock)(void);
@@ -58,6 +72,9 @@ typedef NS_ENUM(NSUInteger, LPLogType) {
 + (void)pause;
 + (void)resume;
 
++ (BOOL)setAppUsingPlist:(NSDictionary *)appKeysDictionary forEnvironment:(NSString *)env;
++ (NSDictionary *) getDefaultAppKeysPlist;
+
 + (void)track:(nullable NSString *)event
     withValue:(double)value
       andArgs:(nullable NSDictionary<NSString *, id> *)args
diff --git a/Leanplum-SDK/Classes/Leanplum.h b/Leanplum-SDK/Classes/Leanplum.h
