FIROptionsTest.m 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578
  1. // Copyright 2017 Google
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. #import "FIRTestCase.h"
  15. #import <FirebaseCore/FIRAppInternal.h>
  16. #import <FirebaseCore/FIRBundleUtil.h>
  17. #import <FirebaseCore/FIROptionsInternal.h>
  18. #import <FirebaseCore/FIRVersion.h>
  19. extern NSString *const kFIRIsMeasurementEnabled;
  20. extern NSString *const kFIRIsAnalyticsCollectionEnabled;
  21. extern NSString *const kFIRIsAnalyticsCollectionDeactivated;
  22. extern NSString *const kFIRLibraryVersionID;
  23. @interface FIROptions (Test)
  24. - (nullable NSDictionary *)analyticsOptionsDictionaryWithInfoDictionary:
  25. (nullable NSDictionary *)infoDictionary;
  26. @end
  27. @interface FIROptionsTest : FIRTestCase
  28. @end
  29. @implementation FIROptionsTest
  30. - (void)setUp {
  31. [super setUp];
  32. [FIROptions resetDefaultOptions];
  33. }
  34. - (void)testInit {
  35. NSDictionary *optionsDictionary = [FIROptions defaultOptionsDictionary];
  36. FIROptions *options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  37. [self assertOptionsMatchDefaults:options andProjectID:YES];
  38. XCTAssertNil(options.deepLinkURLScheme);
  39. XCTAssertTrue(options.usingOptionsFromDefaultPlist);
  40. options.deepLinkURLScheme = kDeepLinkURLScheme;
  41. XCTAssertEqualObjects(options.deepLinkURLScheme, kDeepLinkURLScheme);
  42. }
  43. - (void)testDefaultOptionsDictionaryWithNilFilePath {
  44. id mockBundleUtil = OCMClassMock([FIRBundleUtil class]);
  45. [OCMStub([mockBundleUtil optionsDictionaryPathWithResourceName:kServiceInfoFileName
  46. andFileType:kServiceInfoFileType
  47. inBundles:[FIRBundleUtil relevantBundles]])
  48. andReturn:nil];
  49. XCTAssertNil([FIROptions defaultOptionsDictionary]);
  50. }
  51. - (void)testDefaultOptionsDictionaryWithInvalidSourceFile {
  52. id mockBundleUtil = OCMClassMock([FIRBundleUtil class]);
  53. [OCMStub([mockBundleUtil optionsDictionaryPathWithResourceName:kServiceInfoFileName
  54. andFileType:kServiceInfoFileType
  55. inBundles:[FIRBundleUtil relevantBundles]])
  56. andReturn:@"invalid.plist"];
  57. XCTAssertNil([FIROptions defaultOptionsDictionary]);
  58. }
  59. - (void)testDefaultOptions {
  60. FIROptions *options = [FIROptions defaultOptions];
  61. [self assertOptionsMatchDefaults:options andProjectID:YES];
  62. XCTAssertNil(options.deepLinkURLScheme);
  63. XCTAssertTrue(options.usingOptionsFromDefaultPlist);
  64. options.deepLinkURLScheme = kDeepLinkURLScheme;
  65. XCTAssertEqualObjects(options.deepLinkURLScheme, kDeepLinkURLScheme);
  66. }
  67. - (void)testInitCustomizedOptions {
  68. FIROptions *options =
  69. [[FIROptions alloc] initWithGoogleAppID:kGoogleAppID GCMSenderID:kGCMSenderID];
  70. options.APIKey = kAPIKey;
  71. options.bundleID = kBundleID;
  72. options.clientID = kClientID;
  73. options.databaseURL = kDatabaseURL;
  74. options.deepLinkURLScheme = kDeepLinkURLScheme;
  75. options.projectID = kProjectID;
  76. options.storageBucket = kStorageBucket;
  77. options.trackingID = kTrackingID;
  78. [self assertOptionsMatchDefaults:options andProjectID:YES];
  79. XCTAssertEqualObjects(options.deepLinkURLScheme, kDeepLinkURLScheme);
  80. XCTAssertFalse(options.usingOptionsFromDefaultPlist);
  81. }
  82. - (void)testInitWithContentsOfFile {
  83. NSString *filePath =
  84. [[NSBundle mainBundle] pathForResource:@"GoogleService-Info" ofType:@"plist"];
  85. FIROptions *options = [[FIROptions alloc] initWithContentsOfFile:filePath];
  86. [self assertOptionsMatchDefaults:options andProjectID:YES];
  87. XCTAssertNil(options.deepLinkURLScheme);
  88. XCTAssertFalse(options.usingOptionsFromDefaultPlist);
  89. #pragma clang diagnostic push
  90. #pragma clang diagnostic ignored "-Wnonnull"
  91. FIROptions *emptyOptions = [[FIROptions alloc] initWithContentsOfFile:nil];
  92. #pragma clang diagnostic pop
  93. XCTAssertNil(emptyOptions);
  94. FIROptions *invalidOptions = [[FIROptions alloc] initWithContentsOfFile:@"invalid.plist"];
  95. XCTAssertNil(invalidOptions);
  96. }
  97. - (void)assertOptionsMatchDefaults:(FIROptions *)options andProjectID:(BOOL)matchProjectID {
  98. XCTAssertEqualObjects(options.googleAppID, kGoogleAppID);
  99. XCTAssertEqualObjects(options.APIKey, kAPIKey);
  100. XCTAssertEqualObjects(options.clientID, kClientID);
  101. XCTAssertEqualObjects(options.trackingID, kTrackingID);
  102. XCTAssertEqualObjects(options.GCMSenderID, kGCMSenderID);
  103. XCTAssertNil(options.androidClientID);
  104. XCTAssertEqualObjects(options.libraryVersionID, kFIRLibraryVersionID);
  105. XCTAssertEqualObjects(options.databaseURL, kDatabaseURL);
  106. XCTAssertEqualObjects(options.storageBucket, kStorageBucket);
  107. XCTAssertEqualObjects(options.bundleID, kBundleID);
  108. // Custom `matchProjectID` parameter to be removed once the deprecated `FIROptions` constructor is
  109. // removed.
  110. if (matchProjectID) {
  111. XCTAssertEqualObjects(options.projectID, kProjectID);
  112. }
  113. }
  114. - (void)testCopyingProperties {
  115. NSMutableString *mutableString;
  116. FIROptions *options =
  117. [[FIROptions alloc] initWithGoogleAppID:kGoogleAppID GCMSenderID:kGCMSenderID];
  118. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  119. options.APIKey = mutableString;
  120. [mutableString appendString:@"2"];
  121. XCTAssertEqualObjects(options.APIKey, @"1");
  122. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  123. options.bundleID = mutableString;
  124. [mutableString appendString:@"2"];
  125. XCTAssertEqualObjects(options.bundleID, @"1");
  126. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  127. options.clientID = mutableString;
  128. [mutableString appendString:@"2"];
  129. XCTAssertEqualObjects(options.clientID, @"1");
  130. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  131. options.trackingID = mutableString;
  132. [mutableString appendString:@"2"];
  133. XCTAssertEqualObjects(options.trackingID, @"1");
  134. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  135. options.GCMSenderID = mutableString;
  136. [mutableString appendString:@"2"];
  137. XCTAssertEqualObjects(options.GCMSenderID, @"1");
  138. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  139. options.projectID = mutableString;
  140. [mutableString appendString:@"2"];
  141. XCTAssertEqualObjects(options.projectID, @"1");
  142. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  143. options.androidClientID = mutableString;
  144. [mutableString appendString:@"2"];
  145. XCTAssertEqualObjects(options.androidClientID, @"1");
  146. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  147. options.googleAppID = mutableString;
  148. [mutableString appendString:@"2"];
  149. XCTAssertEqualObjects(options.googleAppID, @"1");
  150. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  151. options.databaseURL = mutableString;
  152. [mutableString appendString:@"2"];
  153. XCTAssertEqualObjects(options.databaseURL, @"1");
  154. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  155. options.deepLinkURLScheme = mutableString;
  156. [mutableString appendString:@"2"];
  157. XCTAssertEqualObjects(options.deepLinkURLScheme, @"1");
  158. mutableString = [[NSMutableString alloc] initWithString:@"1"];
  159. options.storageBucket = mutableString;
  160. [mutableString appendString:@"2"];
  161. XCTAssertEqualObjects(options.storageBucket, @"1");
  162. }
  163. - (void)testCopyWithZone {
  164. // default options
  165. FIROptions *options = [FIROptions defaultOptions];
  166. options.deepLinkURLScheme = kDeepLinkURLScheme;
  167. XCTAssertEqualObjects(options.deepLinkURLScheme, kDeepLinkURLScheme);
  168. FIROptions *newOptions = [options copy];
  169. XCTAssertEqualObjects(newOptions.deepLinkURLScheme, kDeepLinkURLScheme);
  170. [options setDeepLinkURLScheme:kNewDeepLinkURLScheme];
  171. XCTAssertEqualObjects(options.deepLinkURLScheme, kNewDeepLinkURLScheme);
  172. XCTAssertEqualObjects(newOptions.deepLinkURLScheme, kDeepLinkURLScheme);
  173. // customized options
  174. FIROptions *customizedOptions =
  175. [[FIROptions alloc] initWithGoogleAppID:kGoogleAppID GCMSenderID:kGCMSenderID];
  176. customizedOptions.deepLinkURLScheme = kDeepLinkURLScheme;
  177. FIROptions *copyCustomizedOptions = [customizedOptions copy];
  178. [copyCustomizedOptions setDeepLinkURLScheme:kNewDeepLinkURLScheme];
  179. XCTAssertEqualObjects(customizedOptions.deepLinkURLScheme, kDeepLinkURLScheme);
  180. XCTAssertEqualObjects(copyCustomizedOptions.deepLinkURLScheme, kNewDeepLinkURLScheme);
  181. }
  182. - (void)testAnalyticsConstants {
  183. // The keys are public values and should never change.
  184. XCTAssertEqualObjects(kFIRIsMeasurementEnabled, @"IS_MEASUREMENT_ENABLED");
  185. XCTAssertEqualObjects(kFIRIsAnalyticsCollectionEnabled, @"FIREBASE_ANALYTICS_COLLECTION_ENABLED");
  186. XCTAssertEqualObjects(kFIRIsAnalyticsCollectionDeactivated,
  187. @"FIREBASE_ANALYTICS_COLLECTION_DEACTIVATED");
  188. }
  189. - (void)testAnalyticsOptions {
  190. // No keys anywhere.
  191. NSDictionary *optionsDictionary = nil;
  192. FIROptions *options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  193. NSDictionary *mainDictionary = nil;
  194. NSDictionary *expectedAnalyticsOptions = @{};
  195. NSDictionary *analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:nil];
  196. XCTAssertEqualObjects(analyticsOptions, expectedAnalyticsOptions);
  197. optionsDictionary = @{};
  198. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  199. mainDictionary = @{};
  200. expectedAnalyticsOptions = @{};
  201. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:mainDictionary];
  202. XCTAssertEqualObjects(analyticsOptions, expectedAnalyticsOptions);
  203. // Main has no keys.
  204. optionsDictionary = @{
  205. kFIRIsAnalyticsCollectionDeactivated : @YES,
  206. kFIRIsAnalyticsCollectionEnabled : @YES,
  207. kFIRIsMeasurementEnabled : @YES
  208. };
  209. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  210. mainDictionary = @{};
  211. expectedAnalyticsOptions = optionsDictionary;
  212. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:mainDictionary];
  213. XCTAssertEqualObjects(analyticsOptions, expectedAnalyticsOptions);
  214. // Main overrides all the keys.
  215. optionsDictionary = @{
  216. kFIRIsAnalyticsCollectionDeactivated : @YES,
  217. kFIRIsAnalyticsCollectionEnabled : @YES,
  218. kFIRIsMeasurementEnabled : @YES
  219. };
  220. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  221. mainDictionary = @{
  222. kFIRIsAnalyticsCollectionDeactivated : @NO,
  223. kFIRIsAnalyticsCollectionEnabled : @NO,
  224. kFIRIsMeasurementEnabled : @NO
  225. };
  226. expectedAnalyticsOptions = mainDictionary;
  227. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:mainDictionary];
  228. XCTAssertEqualObjects(analyticsOptions, expectedAnalyticsOptions);
  229. // Keys exist only in main.
  230. optionsDictionary = @{};
  231. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  232. mainDictionary = @{
  233. kFIRIsAnalyticsCollectionDeactivated : @YES,
  234. kFIRIsAnalyticsCollectionEnabled : @YES,
  235. kFIRIsMeasurementEnabled : @YES
  236. };
  237. expectedAnalyticsOptions = mainDictionary;
  238. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:mainDictionary];
  239. XCTAssertEqualObjects(analyticsOptions, expectedAnalyticsOptions);
  240. // Main overrides single keys.
  241. optionsDictionary = @{
  242. kFIRIsAnalyticsCollectionDeactivated : @YES,
  243. kFIRIsAnalyticsCollectionEnabled : @YES,
  244. kFIRIsMeasurementEnabled : @YES
  245. };
  246. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  247. mainDictionary = @{kFIRIsAnalyticsCollectionDeactivated : @NO};
  248. expectedAnalyticsOptions = @{
  249. kFIRIsAnalyticsCollectionDeactivated : @NO, // override
  250. kFIRIsAnalyticsCollectionEnabled : @YES,
  251. kFIRIsMeasurementEnabled : @YES
  252. };
  253. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:mainDictionary];
  254. XCTAssertEqualObjects(analyticsOptions, expectedAnalyticsOptions);
  255. optionsDictionary = @{
  256. kFIRIsAnalyticsCollectionDeactivated : @YES,
  257. kFIRIsAnalyticsCollectionEnabled : @YES,
  258. kFIRIsMeasurementEnabled : @YES
  259. };
  260. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  261. mainDictionary = @{kFIRIsAnalyticsCollectionEnabled : @NO};
  262. expectedAnalyticsOptions = @{
  263. kFIRIsAnalyticsCollectionDeactivated : @YES,
  264. kFIRIsAnalyticsCollectionEnabled : @NO, // override
  265. kFIRIsMeasurementEnabled : @YES
  266. };
  267. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:mainDictionary];
  268. XCTAssertEqualObjects(analyticsOptions, expectedAnalyticsOptions);
  269. optionsDictionary = @{
  270. kFIRIsAnalyticsCollectionDeactivated : @YES,
  271. kFIRIsAnalyticsCollectionEnabled : @YES,
  272. kFIRIsMeasurementEnabled : @YES
  273. };
  274. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  275. mainDictionary = @{kFIRIsMeasurementEnabled : @NO};
  276. expectedAnalyticsOptions = @{
  277. kFIRIsAnalyticsCollectionDeactivated : @YES,
  278. kFIRIsAnalyticsCollectionEnabled : @YES,
  279. kFIRIsMeasurementEnabled : @NO // override
  280. };
  281. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:mainDictionary];
  282. XCTAssertEqualObjects(analyticsOptions, expectedAnalyticsOptions);
  283. }
  284. - (void)testAnalyticsOptions_combinatorial {
  285. // Complete combinatorial test.
  286. // Possible values for the flags in the plist, where NSNull means the flag is not present.
  287. NSArray *values = @[ [NSNull null], @NO, @YES ];
  288. // Sanity checks for the combination generation.
  289. int combinationCount = 0;
  290. NSMutableArray *uniqueMainCombinations = [[NSMutableArray alloc] init];
  291. NSMutableArray *uniqueOptionsCombinations = [[NSMutableArray alloc] init];
  292. // Generate all optout flag combinations for { main plist X GoogleService-info options plist }.
  293. // Options present in the main plist should override options of the same key in the service plist.
  294. for (id mainDeactivated in values) {
  295. for (id mainAnalyticsEnabled in values) {
  296. for (id mainMeasurementEnabled in values) {
  297. for (id optionsDeactivated in values) {
  298. for (id optionsAnalyticsEnabled in values) {
  299. for (id optionsMeasurementEnabled in values) {
  300. @autoreleasepool {
  301. // Fill the GoogleService-info options plist dictionary.
  302. NSMutableDictionary *optionsDictionary = [[NSMutableDictionary alloc] init];
  303. if (![optionsDeactivated isEqual:[NSNull null]]) {
  304. optionsDictionary[kFIRIsAnalyticsCollectionDeactivated] = optionsDeactivated;
  305. }
  306. if (![optionsAnalyticsEnabled isEqual:[NSNull null]]) {
  307. optionsDictionary[kFIRIsAnalyticsCollectionEnabled] = optionsAnalyticsEnabled;
  308. }
  309. if (![optionsMeasurementEnabled isEqual:[NSNull null]]) {
  310. optionsDictionary[kFIRIsMeasurementEnabled] = optionsMeasurementEnabled;
  311. }
  312. FIROptions *options =
  313. [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  314. if (![uniqueOptionsCombinations containsObject:optionsDictionary]) {
  315. [uniqueOptionsCombinations addObject:optionsDictionary];
  316. }
  317. // Fill the main plist dictionary.
  318. NSMutableDictionary *mainDictionary = [[NSMutableDictionary alloc] init];
  319. if (![mainDeactivated isEqual:[NSNull null]]) {
  320. mainDictionary[kFIRIsAnalyticsCollectionDeactivated] = mainDeactivated;
  321. }
  322. if (![mainAnalyticsEnabled isEqual:[NSNull null]]) {
  323. mainDictionary[kFIRIsAnalyticsCollectionEnabled] = mainAnalyticsEnabled;
  324. }
  325. if (![mainMeasurementEnabled isEqual:[NSNull null]]) {
  326. mainDictionary[kFIRIsMeasurementEnabled] = mainMeasurementEnabled;
  327. }
  328. // Add mainDictionary to uniqueMainCombinations if it isn't included yet.
  329. if (![uniqueMainCombinations containsObject:mainDictionary]) {
  330. [uniqueMainCombinations addObject:mainDictionary];
  331. }
  332. // Generate the expected options by adding main values on top of the service options
  333. // values. The main values will replace any existing options values with the same
  334. // key. This is a different way of combining the two sets of flags from the actual
  335. // implementation in FIROptions, with equivalent output.
  336. NSMutableDictionary *expectedAnalyticsOptions =
  337. [[NSMutableDictionary alloc] initWithDictionary:optionsDictionary];
  338. [expectedAnalyticsOptions addEntriesFromDictionary:mainDictionary];
  339. NSDictionary *analyticsOptions =
  340. [options analyticsOptionsDictionaryWithInfoDictionary:mainDictionary];
  341. XCTAssertEqualObjects(analyticsOptions, expectedAnalyticsOptions);
  342. combinationCount++;
  343. }
  344. }
  345. }
  346. }
  347. }
  348. }
  349. }
  350. // Verify the sanity checks.
  351. XCTAssertEqual(combinationCount, 729); // = 3^6.
  352. XCTAssertEqual(uniqueOptionsCombinations.count, 27);
  353. int optionsSizeCount[4] = {0};
  354. for (NSDictionary *dictionary in uniqueOptionsCombinations) {
  355. optionsSizeCount[dictionary.count]++;
  356. }
  357. XCTAssertEqual(optionsSizeCount[0], 1);
  358. XCTAssertEqual(optionsSizeCount[1], 6);
  359. XCTAssertEqual(optionsSizeCount[2], 12);
  360. XCTAssertEqual(optionsSizeCount[3], 8);
  361. XCTAssertEqual(uniqueMainCombinations.count, 27);
  362. int mainSizeCount[4] = {0};
  363. for (NSDictionary *dictionary in uniqueMainCombinations) {
  364. mainSizeCount[dictionary.count]++;
  365. }
  366. XCTAssertEqual(mainSizeCount[0], 1);
  367. XCTAssertEqual(mainSizeCount[1], 6);
  368. XCTAssertEqual(mainSizeCount[2], 12);
  369. XCTAssertEqual(mainSizeCount[3], 8);
  370. }
  371. - (void)testAnalyticsCollectionGlobalSwitchEnabled {
  372. // Stub the default app, and set the global switch to YES.
  373. id appMock = OCMClassMock([FIRApp class]);
  374. OCMStub([appMock isDefaultAppConfigured]).andReturn(YES);
  375. OCMStub([appMock defaultApp]).andReturn(appMock);
  376. OCMStub([appMock isDataCollectionDefaultEnabled]).andReturn(YES);
  377. // With no other settings, Analytics collection should default to the app's flag.
  378. FIROptions *options = [[FIROptions alloc] initInternalWithOptionsDictionary:@{}];
  379. XCTAssertTrue(options.isAnalyticsCollectionEnabled);
  380. XCTAssertTrue(options.isMeasurementEnabled);
  381. [appMock stopMocking];
  382. }
  383. - (void)testAnalyticsCollectionGlobalSwitchDisabled {
  384. // Stub the default app, and set the global switch to NO.
  385. id appMock = OCMClassMock([FIRApp class]);
  386. OCMStub([appMock isDefaultAppConfigured]).andReturn(YES);
  387. OCMStub([appMock defaultApp]).andReturn(appMock);
  388. OCMStub([appMock isDataCollectionDefaultEnabled]).andReturn(NO);
  389. // With no other settings, Analytics collection should default to the app's flag.
  390. FIROptions *options = [[FIROptions alloc] initInternalWithOptionsDictionary:@{}];
  391. XCTAssertFalse(options.isAnalyticsCollectionEnabled);
  392. XCTAssertFalse(options.isMeasurementEnabled);
  393. [appMock stopMocking];
  394. }
  395. - (void)testAnalyticsCollectionGlobalSwitchOverrideToDisable {
  396. // Stub the default app, and set the global switch to YES.
  397. id appMock = OCMClassMock([FIRApp class]);
  398. OCMStub([appMock isDefaultAppConfigured]).andReturn(YES);
  399. OCMStub([appMock defaultApp]).andReturn(appMock);
  400. OCMStub([appMock isDataCollectionDefaultEnabled]).andReturn(YES);
  401. // Test the three Analytics flags that override to disable Analytics collection.
  402. FIROptions *collectionEnabledOptions = [[FIROptions alloc] initInternalWithOptionsDictionary:@{
  403. kFIRIsAnalyticsCollectionEnabled : @NO
  404. }];
  405. XCTAssertFalse(collectionEnabledOptions.isAnalyticsCollectionEnabled);
  406. FIROptions *collectionDeactivatedOptions =
  407. [[FIROptions alloc] initInternalWithOptionsDictionary:@{
  408. kFIRIsAnalyticsCollectionDeactivated : @YES
  409. }];
  410. XCTAssertFalse(collectionDeactivatedOptions.isAnalyticsCollectionEnabled);
  411. FIROptions *measurementEnabledOptions = [[FIROptions alloc] initInternalWithOptionsDictionary:@{
  412. kFIRIsMeasurementEnabled : @NO
  413. }];
  414. XCTAssertFalse(measurementEnabledOptions.isAnalyticsCollectionEnabled);
  415. }
  416. - (void)testAnalyticsCollectionGlobalSwitchOverrideToEnable {
  417. // Stub the default app, and set the global switch to YES.
  418. id appMock = OCMClassMock([FIRApp class]);
  419. OCMStub([appMock isDefaultAppConfigured]).andReturn(YES);
  420. OCMStub([appMock defaultApp]).andReturn(appMock);
  421. OCMStub([appMock isDataCollectionDefaultEnabled]).andReturn(NO);
  422. // Test the two Analytics flags that can override and enable collection.
  423. FIROptions *collectionEnabledOptions = [[FIROptions alloc] initInternalWithOptionsDictionary:@{
  424. kFIRIsAnalyticsCollectionEnabled : @YES
  425. }];
  426. XCTAssertTrue(collectionEnabledOptions.isAnalyticsCollectionEnabled);
  427. FIROptions *measurementEnabledOptions = [[FIROptions alloc] initInternalWithOptionsDictionary:@{
  428. kFIRIsMeasurementEnabled : @YES
  429. }];
  430. XCTAssertTrue(measurementEnabledOptions.isAnalyticsCollectionEnabled);
  431. }
  432. - (void)testAnalyticsCollectionExplicitlySet {
  433. NSDictionary *optionsDictionary = @{};
  434. FIROptions *options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  435. NSDictionary *analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:@{}];
  436. XCTAssertFalse([options isAnalyticsCollectionExpicitlySet]);
  437. // Test deactivation flag.
  438. optionsDictionary = @{kFIRIsAnalyticsCollectionDeactivated : @YES};
  439. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  440. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:@{}];
  441. XCTAssertTrue([options isAnalyticsCollectionExpicitlySet]);
  442. // If "deactivated" == NO, that doesn't mean it's explicitly set / enabled so it should be treated
  443. // as if it's not set.
  444. optionsDictionary = @{kFIRIsAnalyticsCollectionDeactivated : @NO};
  445. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  446. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:@{}];
  447. XCTAssertFalse([options isAnalyticsCollectionExpicitlySet]);
  448. // Test the collection enabled flag.
  449. optionsDictionary = @{kFIRIsAnalyticsCollectionEnabled : @YES};
  450. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  451. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:@{}];
  452. XCTAssertTrue([options isAnalyticsCollectionExpicitlySet]);
  453. optionsDictionary = @{kFIRIsAnalyticsCollectionEnabled : @NO};
  454. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  455. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:@{}];
  456. XCTAssertTrue([options isAnalyticsCollectionExpicitlySet]);
  457. // Test the old measurement flag.
  458. options = [[FIROptions alloc] initInternalWithOptionsDictionary:@{}];
  459. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:@{
  460. kFIRIsMeasurementEnabled : @YES
  461. }];
  462. XCTAssertTrue([options isAnalyticsCollectionExpicitlySet]);
  463. options = [[FIROptions alloc] initInternalWithOptionsDictionary:@{}];
  464. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:@{
  465. kFIRIsMeasurementEnabled : @NO
  466. }];
  467. XCTAssertTrue([options isAnalyticsCollectionExpicitlySet]);
  468. // For good measure, a combination of all 3 (even if they conflict).
  469. optionsDictionary =
  470. @{kFIRIsAnalyticsCollectionDeactivated : @YES,
  471. kFIRIsAnalyticsCollectionEnabled : @YES};
  472. options = [[FIROptions alloc] initInternalWithOptionsDictionary:optionsDictionary];
  473. analyticsOptions = [options analyticsOptionsDictionaryWithInfoDictionary:@{
  474. kFIRIsMeasurementEnabled : @NO
  475. }];
  476. XCTAssertTrue([options isAnalyticsCollectionExpicitlySet]);
  477. }
  478. - (void)testVersionFormat {
  479. NSRegularExpression *sLibraryVersionRegex =
  480. [NSRegularExpression regularExpressionWithPattern:@"^[0-9]{8,}$" options:0 error:NULL];
  481. NSUInteger numberOfMatches =
  482. [sLibraryVersionRegex numberOfMatchesInString:kFIRLibraryVersionID
  483. options:0
  484. range:NSMakeRange(0, kFIRLibraryVersionID.length)];
  485. XCTAssertEqual(numberOfMatches, 1, @"Incorrect library version format.");
  486. }
  487. - (void)testVersionConsistency {
  488. const char *versionString = [kFIRLibraryVersionID UTF8String];
  489. int major = versionString[0] - '0';
  490. int minor = (versionString[1] - '0') * 10 + versionString[2] - '0';
  491. int patch = (versionString[3] - '0') * 10 + versionString[4] - '0';
  492. NSString *str = [NSString stringWithFormat:@"%d.%d.%d", major, minor, patch];
  493. XCTAssertEqualObjects(str, [NSString stringWithUTF8String:(const char *)FIRCoreVersionString]);
  494. }
  495. @end