[Remove IID] Move some token unit tests from IID to Messaging (#7294)

Author: charlotteliang

Firebase/CoreDiagnostics/FIRCDLibrary/FIRCoreDiagnostics.m

@@ -37,7 +37,7 @@
 
 #ifdef FIREBASE_BUILD_ZIP_FILE
 static BOOL kUsingZipFile = YES;
-#else  // FIREBASE_BUILD_ZIP_FILE
+#else   // FIREBASE_BUILD_ZIP_FILE
 static BOOL kUsingZipFile = NO;
 #endif  // FIREBASE_BUILD_ZIP_FILE
 

FirebaseDynamicLinks/Sources/Logging/FDLLogging.m

@@ -29,7 +29,7 @@
 
 #if __LP64__  // 64-bit
 NSString *const FDLMessageCodeIntegerFormat = @"%06ld";
-#else  // 32-bit
+#else   // 32-bit
 NSString *const FDLMessageCodeIntegerFormat = @"%06d";
 #endif  // #if __LP64__
 

FirebaseMessaging/Sources/Token/FIRMessagingAuthKeyChain.h renamed to FirebaseMessaging/Sources/Token/FIRMessagingAuthKeychain.h

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-#import "FirebaseMessaging/Sources/Token/FIRMessagingAuthKeyChain.h"
+#import "FirebaseMessaging/Sources/Token/FIRMessagingAuthKeychain.h"
 #import "FirebaseMessaging/Sources/FIRMessagingLogger.h"
 #import "FirebaseMessaging/Sources/Token/FIRMessagingKeychain.h"
 

FirebaseMessaging/Sources/Token/FIRMessagingAuthKeyChain.m renamed to FirebaseMessaging/Sources/Token/FIRMessagingAuthKeychain.m

@@ -28,32 +28,6 @@ extern NSString *const kFIRMessagingCheckinKeychainService;
  */
 @interface FIRMessagingCheckinStore : NSObject
 
-/**
- *  Designated Initializer. Initialize a checkin store with the given backup excluded
- *  plist filename.
- *
- *  @param checkinFilename                The backup excluded plist filename to persist checkin
- *                                        preferences.
- *
- *  @param subDirectoryName               Sub-directory in standard directory where we write
- *                                        InstanceID plist.
- *
- *  @return Store to persist checkin preferences.
- */
-- (instancetype)initWithCheckinPlistFileName:(NSString *)checkinFilename
-                            subDirectoryName:(NSString *)subDirectoryName;
-
-/**
- *  Initialize a checkin store with the given backup excluded  plist and keychain.
- *
- *  @param plist        The backup excluded plist to persist checkin preferences.
- *  @param keychain     The keychain used to persist checkin auth preferences.
- *
- *  @return Store to persist checkin preferences.
- */
-- (instancetype)initWithCheckinPlist:(FIRMessagingBackupExcludedPlist *)plist
-                            keychain:(FIRMessagingAuthKeychain *)keychain;
-
 /**
  *  Checks whether the backup excluded checkin preferences are present on the disk or not.
  *

FirebaseMessaging/Sources/Token/FIRMessagingCheckinStore.h

@@ -17,16 +17,18 @@
 #import "FirebaseMessaging/Sources/Token/FIRMessagingCheckinStore.h"
 
 #import "FirebaseMessaging/Sources/FIRMessagingCode.h"
+#import "FirebaseMessaging/Sources/FIRMessagingConstants.h"
 #import "FirebaseMessaging/Sources/FIRMessagingLogger.h"
 #import "FirebaseMessaging/Sources/FIRMessagingUtilities.h"
 #import "FirebaseMessaging/Sources/NSError+FIRMessaging.h"
-#import "FirebaseMessaging/Sources/Token/FIRMessagingAuthKeyChain.h"
+#import "FirebaseMessaging/Sources/Token/FIRMessagingAuthKeychain.h"
 #import "FirebaseMessaging/Sources/Token/FIRMessagingBackupExcludedPlist.h"
 #import "FirebaseMessaging/Sources/Token/FIRMessagingCheckinPreferences.h"
 #import "FirebaseMessaging/Sources/Token/FIRMessagingCheckinService.h"
 
+// NOTE: These values should be in sync with what InstanceID saves in as.
+static NSString *const kCheckinFileName = @"g-checkin";
 static NSString *const kFIRMessagingCheckinKeychainGeneric = @"com.google.iid";
-
 NSString *const kFIRMessagingCheckinKeychainService = @"com.google.iid.checkin";
 
 @interface FIRMessagingCheckinStore ()
@@ -42,23 +44,14 @@ @interface FIRMessagingCheckinStore ()
 
 @implementation FIRMessagingCheckinStore
 
-- (instancetype)initWithCheckinPlistFileName:(NSString *)checkinFilename
-                            subDirectoryName:(NSString *)subDirectoryName {
-  FIRMessagingBackupExcludedPlist *plist =
-      [[FIRMessagingBackupExcludedPlist alloc] initWithFileName:checkinFilename
-                                                   subDirectory:subDirectoryName];
-
-  FIRMessagingAuthKeychain *keychain =
-      [[FIRMessagingAuthKeychain alloc] initWithIdentifier:kFIRMessagingCheckinKeychainGeneric];
-  return [self initWithCheckinPlist:plist keychain:keychain];
-}
-
-- (instancetype)initWithCheckinPlist:(FIRMessagingBackupExcludedPlist *)plist
-                            keychain:(FIRMessagingAuthKeychain *)keychain {
+- (instancetype)init {
   self = [super init];
   if (self) {
-    _plist = plist;
-    _keychain = keychain;
+    _plist = [[FIRMessagingBackupExcludedPlist alloc]
+        initWithFileName:kCheckinFileName
+            subDirectory:kFIRMessagingInstanceIDSubDirectoryName];
+    _keychain =
+        [[FIRMessagingAuthKeychain alloc] initWithIdentifier:kFIRMessagingCheckinKeychainGeneric];
   }
   return self;
 }

FirebaseMessaging/Sources/Token/FIRMessagingCheckinStore.m

@@ -21,7 +21,7 @@
 #import "FirebaseMessaging/Sources/FIRMessagingDefines.h"
 #import "FirebaseMessaging/Sources/FIRMessagingLogger.h"
 #import "FirebaseMessaging/Sources/NSError+FIRMessaging.h"
-#import "FirebaseMessaging/Sources/Token/FIRMessagingAuthKeyChain.h"
+#import "FirebaseMessaging/Sources/Token/FIRMessagingAuthKeychain.h"
 #import "FirebaseMessaging/Sources/Token/FIRMessagingAuthService.h"
 #import "FirebaseMessaging/Sources/Token/FIRMessagingCheckinPreferences.h"
 #import "FirebaseMessaging/Sources/Token/FIRMessagingCheckinStore.h"
@@ -31,9 +31,6 @@
 #import "FirebaseMessaging/Sources/Token/FIRMessagingTokenOperation.h"
 #import "FirebaseMessaging/Sources/Token/FIRMessagingTokenStore.h"
 
-// NOTE: These values should be in sync with what InstanceID saves in as.
-static NSString *const kCheckinFileName = @"g-checkin";
-
 @interface FIRMessagingTokenManager () {
   FIRMessagingTokenStore *_tokenStore;
   FIRMessagingCheckinStore *_checkinStore;
@@ -54,9 +51,7 @@ - (instancetype)init {
   self = [super init];
   if (self) {
     _tokenStore = [[FIRMessagingTokenStore alloc] init];
-    _checkinStore = [[FIRMessagingCheckinStore alloc]
-        initWithCheckinPlistFileName:kCheckinFileName
-                    subDirectoryName:kFIRMessagingInstanceIDSubDirectoryName];
+    _checkinStore = [[FIRMessagingCheckinStore alloc] init];
     _authService = [[FIRMessagingAuthService alloc] initWithCheckinStore:_checkinStore];
     [self resetCredentialsIfNeeded];
     [self configureTokenOperations];

FirebaseMessaging/Sources/Token/FIRMessagingTokenManager.m

@@ -19,7 +19,7 @@
 #import "FirebaseMessaging/Sources/FIRMessagingConstants.h"
 #import "FirebaseMessaging/Sources/FIRMessagingLogger.h"
 #import "FirebaseMessaging/Sources/FIRMessagingUtilities.h"
-#import "FirebaseMessaging/Sources/Token/FIRMessagingAuthKeyChain.h"
+#import "FirebaseMessaging/Sources/Token/FIRMessagingAuthKeychain.h"
 #import "FirebaseMessaging/Sources/Token/FIRMessagingTokenInfo.h"
 
 static NSString *const kFIRMessagingTokenKeychainId = @"com.google.iid-tokens";

FirebaseMessaging/Sources/Token/FIRMessagingTokenStore.m

@@ -0,0 +1,88 @@
+/*
+ * Copyright 2019 Google
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#import <XCTest/XCTest.h>
+
+#import "FirebaseMessaging/Sources/FIRMessagingConstants.h"
+#import "FirebaseMessaging/Sources/Token/FIRMessagingAPNSInfo.h"
+
+@interface FIRMessagingAPNSInfoTest : XCTestCase
+
+@end
+
+@implementation FIRMessagingAPNSInfoTest
+
+- (void)testAPNSInfoCreationWithValidDictionary {
+  NSDictionary *validDictionary = @{
+    kFIRMessagingTokenOptionsAPNSKey : [@"tokenData" dataUsingEncoding:NSUTF8StringEncoding],
+    kFIRMessagingTokenOptionsAPNSIsSandboxKey : @(YES)
+  };
+  FIRMessagingAPNSInfo *info =
+      [[FIRMessagingAPNSInfo alloc] initWithTokenOptionsDictionary:validDictionary];
+  XCTAssertNotNil(info);
+  XCTAssertEqualObjects(info.deviceToken, validDictionary[kFIRMessagingTokenOptionsAPNSKey]);
+  XCTAssertEqual(info.sandbox,
+                 [validDictionary[kFIRMessagingTokenOptionsAPNSIsSandboxKey] boolValue]);
+}
+
+- (void)testAPNSInfoCreationWithInvalidDictionary {
+  NSDictionary *validDictionary = @{};
+  FIRMessagingAPNSInfo *info =
+      [[FIRMessagingAPNSInfo alloc] initWithTokenOptionsDictionary:validDictionary];
+  XCTAssertNil(info);
+}
+
+- (void)testAPNSInfoCreationWithInvalidTokenFormat {
+  // Token data stored as NSString instead of NSData
+  NSDictionary *badDictionary = @{
+    kFIRMessagingTokenOptionsAPNSKey : @"tokenDataAsString",
+    kFIRMessagingTokenOptionsAPNSIsSandboxKey : @(YES)
+  };
+  FIRMessagingAPNSInfo *info =
+      [[FIRMessagingAPNSInfo alloc] initWithTokenOptionsDictionary:badDictionary];
+  XCTAssertNil(info);
+}
+
+- (void)testAPNSInfoCreationWithInvalidSandboxFormat {
+  // Sandbox key stored as NSString instead of NSNumber (bool)
+  NSDictionary *validDictionary = @{
+    kFIRMessagingTokenOptionsAPNSKey : [@"tokenData" dataUsingEncoding:NSUTF8StringEncoding],
+    kFIRMessagingTokenOptionsAPNSIsSandboxKey : @"sandboxValueAsString"
+  };
+  FIRMessagingAPNSInfo *info =
+      [[FIRMessagingAPNSInfo alloc] initWithTokenOptionsDictionary:validDictionary];
+  XCTAssertNil(info);
+}
+
+// Test that archiving a FIRMessagingAPNSInfo object and restoring it from the archive
+// yields the same values for all the fields.
+- (void)testAPNSInfoEncodingAndDecoding {
+  NSDictionary *validDictionary = @{
+    kFIRMessagingTokenOptionsAPNSKey : [@"tokenData" dataUsingEncoding:NSUTF8StringEncoding],
+    kFIRMessagingTokenOptionsAPNSIsSandboxKey : @"sandboxValueAsString"
+  };
+  FIRMessagingAPNSInfo *info =
+      [[FIRMessagingAPNSInfo alloc] initWithTokenOptionsDictionary:validDictionary];
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+  NSData *archive = [NSKeyedArchiver archivedDataWithRootObject:info];
+  FIRMessagingAPNSInfo *restoredInfo = [NSKeyedUnarchiver unarchiveObjectWithData:archive];
+#pragma clang diagnostic pop
+  XCTAssertEqualObjects(info.deviceToken, restoredInfo.deviceToken);
+  XCTAssertEqual(info.sandbox, restoredInfo.sandbox);
+}
+
+@end