Adds NSSecureCoding unit tests for FIRUser (#74)

* Adds unit tests for NSSecureCoding for FIRUser

Author: protocol86

Example/Auth/Tests/FIRUserTests.m

@@ -26,7 +26,7 @@
 #import "FIRAuth.h"
 #import "FIRAuthErrorUtils.h"
 #import "FIRAuthGlobalWorkQueue.h"
-#import "FIRUser.h"
+#import "FIRUser_Internal.h"
 #import "FIRUserInfo.h"
 #import "FIRAuthBackend.h"
 #import "FIRGetAccountInfoRequest.h"
@@ -209,6 +209,11 @@
  */
 static NSString *const kVerificationID = @"55432";
 
+/** @var kUserArchiverKey
+    @brief The key used to archive and unarchive the user object for test NSSecureCoding.
+ */
+static NSString *const kUserArchiverKey = @"userArchiverKey";
+
 /** @var kExpectationTimeout
     @brief The maximum time waiting for expectations to fulfill.
  */
@@ -257,10 +262,11 @@ - (void)tearDown {
 
 #pragma mark - Tests
 
-/** @fn testUserProperties
-    @brief Tests properties of the @c FIRUser instance.
+/** @fn testUserPropertiesAndNSSecureCoding
+    @brief Tests properties of the @c FIRUser instance before and after being
+        serialized/deserialized.
  */
-- (void)testUserProperties {
+- (void)testUserPropertiesAndNSSecureCoding {
   // Mock auth provider user info for email/password for GetAccountInfo.
   id mockPasswordUserInfo = OCMClassMock([FIRGetAccountInfoResponseProviderUserInfo class]);
   OCMStub([mockPasswordUserInfo providerID]).andReturn(FIREmailAuthProviderID);
@@ -327,23 +333,20 @@ - (void)testUserProperties {
 
     // Verify FIRUserInfo properties from email/password.
     id<FIRUserInfo> passwordUserInfo = providerMap[FIREmailAuthProviderID];
-    XCTAssertNotNil(passwordUserInfo);
     XCTAssertEqualObjects(passwordUserInfo.uid, kEmail);
     XCTAssertNil(passwordUserInfo.displayName);
     XCTAssertNil(passwordUserInfo.photoURL);
     XCTAssertEqualObjects(passwordUserInfo.email, kEmail);
 
     // Verify FIRUserInfo properties from the Google auth provider.
     id<FIRUserInfo> googleUserInfo = providerMap[FIRGoogleAuthProviderID];
-    XCTAssertNotNil(googleUserInfo);
     XCTAssertEqualObjects(googleUserInfo.uid, kGoogleID);
     XCTAssertEqualObjects(googleUserInfo.displayName, kGoogleDisplayName);
     XCTAssertEqualObjects(googleUserInfo.photoURL, [NSURL URLWithString:kGooglePhotoURL]);
     XCTAssertEqualObjects(googleUserInfo.email, kGoogleEmail);
 
     // Verify FIRUserInfo properties from the Facebook auth provider.
     id<FIRUserInfo> facebookUserInfo = providerMap[FIRFacebookAuthProviderID];
-    XCTAssertNotNil(facebookUserInfo);
     XCTAssertEqualObjects(facebookUserInfo.uid, kFacebookID);
     XCTAssertNil(facebookUserInfo.displayName);
     XCTAssertNil(facebookUserInfo.photoURL);
@@ -352,10 +355,62 @@ - (void)testUserProperties {
     #if TARGET_OS_IOS
     // Verify FIRUserInfo properties from the phone auth provider.
     id<FIRUserInfo> phoneUserInfo = providerMap[FIRPhoneAuthProviderID];
-    XCTAssertNotNil(phoneUserInfo);
     XCTAssertEqualObjects(phoneUserInfo.phoneNumber, kPhoneNumber);
     #endif
 
+    // Test NSSecureCoding
+    XCTAssertTrue([FIRUser supportsSecureCoding]);
+    NSMutableData *data = [NSMutableData data];
+    NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:data];
+    [archiver encodeObject:user forKey:kUserArchiverKey];
+    [archiver finishEncoding];
+
+    NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:data];
+    FIRUser *unarchivedUser = [unarchiver decodeObjectForKey:kUserArchiverKey];
+
+    // Verify NSSecureCoding for FIRUser
+    XCTAssertEqualObjects(unarchivedUser.providerID, user.providerID);
+    XCTAssertEqualObjects(unarchivedUser.uid, user.uid);
+    XCTAssertEqualObjects(unarchivedUser.email, user.email);
+    XCTAssertEqualObjects(unarchivedUser.photoURL, user.photoURL);
+    XCTAssertEqualObjects(unarchivedUser.displayName, user.displayName);
+
+    // Verify NSSecureCoding properties besides providerData contents.
+    XCTAssertEqual(unarchivedUser.anonymous, user.anonymous);
+    XCTAssertEqual(unarchivedUser.emailVerified, user.emailVerified);
+    XCTAssertEqualObjects(unarchivedUser.refreshToken, user.refreshToken);
+    XCTAssertEqual(unarchivedUser.providerData.count, user.providerData.count);
+
+    NSDictionary<NSString *, id<FIRUserInfo>> *unarchivedProviderMap =
+        [self dictionaryWithUserInfoArray:unarchivedUser.providerData];
+
+    // Verify NSSecureCoding properties from email/password.
+    id<FIRUserInfo> unarchivedPasswordUserInfo = unarchivedProviderMap[FIREmailAuthProviderID];
+    XCTAssertEqualObjects(unarchivedPasswordUserInfo.uid, passwordUserInfo.uid);
+    XCTAssertEqualObjects(unarchivedPasswordUserInfo.displayName, passwordUserInfo.displayName);
+    XCTAssertEqualObjects(unarchivedPasswordUserInfo.photoURL, passwordUserInfo.photoURL);
+    XCTAssertEqualObjects(unarchivedPasswordUserInfo.email, passwordUserInfo.email);
+
+    // Verify NSSecureCoding properties from the Google auth provider.
+    id<FIRUserInfo> unarchivedGoogleUserInfo = unarchivedProviderMap[FIRGoogleAuthProviderID];
+    XCTAssertEqualObjects(unarchivedGoogleUserInfo.uid, googleUserInfo.uid);
+    XCTAssertEqualObjects(unarchivedGoogleUserInfo.displayName, googleUserInfo.displayName);
+    XCTAssertEqualObjects(unarchivedGoogleUserInfo.photoURL, googleUserInfo.photoURL);
+    XCTAssertEqualObjects(unarchivedGoogleUserInfo.email, googleUserInfo.email);
+
+    // Verify NSSecureCoding properties from the Facebook auth provider.
+    id<FIRUserInfo> unarchivedFacebookUserInfo = unarchivedProviderMap[FIRFacebookAuthProviderID];
+    XCTAssertEqualObjects(unarchivedFacebookUserInfo.uid, facebookUserInfo.uid);
+    XCTAssertEqualObjects(unarchivedFacebookUserInfo.displayName, facebookUserInfo.displayName);
+    XCTAssertEqualObjects(unarchivedFacebookUserInfo.photoURL, facebookUserInfo.photoURL);
+    XCTAssertEqualObjects(unarchivedFacebookUserInfo.email, facebookUserInfo.email);
+
+    #if TARGET_OS_IOS
+    // Verify FIRUserInfo properties from the phone auth provider.
+    id<FIRUserInfo> unarchivedPhoneUserInfo = unarchivedProviderMap[FIRPhoneAuthProviderID];
+    XCTAssertEqualObjects(unarchivedPhoneUserInfo.phoneNumber, phoneUserInfo.phoneNumber);
+    #endif
+
     [expectation fulfill];
   }];
   [self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];
@@ -1540,7 +1595,6 @@ - (void)testlinkPhoneAuthCredentialFailure {
                                  completion:^(FIRAuthDataResult *_Nullable
                                               linkAuthResult,
                                               NSError *_Nullable error) {
-      XCTAssertNotNil(error);
       XCTAssertEqual(error.code, FIRAuthErrorCodeProviderAlreadyLinked);
       [expectation fulfill];
     }];