fix breakage in FM tests (#7823)

charlotteliang · web-flow · commit 267fc6d25f9a · 2021-04-02T12:24:54.000-07:00
diff --git a/FirebaseMessaging/Sources/FIRMessagingUtilities.m b/FirebaseMessaging/Sources/FIRMessagingUtilities.m
@@ -18,7 +18,7 @@
 
 #import <GoogleUtilities/GULAppEnvironmentUtil.h>
 #import <GoogleUtilities/GULUserDefaults.h>
-#import "FirebaseCore/Sources/Public/FirebaseCore/FIROptions.h"
+#import "FirebaseCore/Sources/Private/FirebaseCoreInternal.h"
 #import "FirebaseMessaging/Sources/FIRMessagingLogger.h"
 
 static const uint64_t kBytesToMegabytesDivisor = 1024 * 1024LL;
diff --git a/FirebaseMessaging/Tests/UnitTests/FIRMessagingCheckinStoreTest.m b/FirebaseMessaging/Tests/UnitTests/FIRMessagingCheckinStoreTest.m
@@ -40,6 +40,10 @@ @interface FIRMessaging (ExposedForTest)
 + (BOOL)createSubDirectory:(NSString *)subDirectoryName;
 @end
 
+@interface FIRMessagingBackupExcludedPlist (ExposedForTest)
+- (BOOL)deleteFile:(NSError **)error;
+@end
+
 // Testing constants
 static NSString *const kFakeCheckinPlistName = @"com.google.test.TestCheckin";
 static NSString *const kSubDirectoryName = @"FirebaseInstanceIDCheckinTest";
@@ -53,21 +57,23 @@ + (BOOL)createSubDirectory:(NSString *)subDirectoryName;
 
 @interface FIRMessagingCheckinStoreTest : XCTestCase
 
+@property(nonatomic, strong) FIRMessagingCheckinStore *checkinStore;
+@property(nonatomic, strong) FIRMessagingBackupExcludedPlist *plist;
 @end
 
 @implementation FIRMessagingCheckinStoreTest
 
 - (void)setUp {
   [super setUp];
   [FIRMessaging createSubDirectory:kSubDirectoryName];
+  self.checkinStore = [[FIRMessagingCheckinStore alloc] init];
+  self.plist = [[FIRMessagingBackupExcludedPlist alloc] initWithFileName:kFakeCheckinPlistName
+                                                            subDirectory:kSubDirectoryName];
+  self.checkinStore.plist = self.plist;
 }
 
 - (void)tearDown {
-  NSString *path = [self pathForCheckinPlist];
-  if ([[NSFileManager defaultManager] fileExistsAtPath:path]) {
-    NSError *error;
-    [[NSFileManager defaultManager] removeItemAtPath:path error:&error];
-  }
+  [self.plist deleteFile:nil];
   [super tearDown];
 }
 
@@ -79,23 +85,22 @@ - (void)testInvalidCheckinPreferencesOnKeychainFail {
       expectationWithDescription:@"Checkin preference should be invalid after keychain failure"];
 
   FIRMessagingFakeKeychain *fakeKeychain = [[FIRMessagingFakeKeychain alloc] init];
-  FIRMessagingCheckinStore *checkinStore = [[FIRMessagingCheckinStore alloc] init];
-  checkinStore.keychain = fakeKeychain;
+  self.checkinStore.keychain = fakeKeychain;
   __block FIRMessagingCheckinPreferences *preferences =
       [[FIRMessagingCheckinPreferences alloc] initWithDeviceID:kAuthID secretToken:kSecret];
   [preferences updateWithCheckinPlistContents:[[self class] newCheckinPlistPreferences]];
-  [checkinStore saveCheckinPreferences:preferences
-                               handler:^(NSError *error) {
-                                 XCTAssertNil(error);
-                                 fakeKeychain.cannotReadFromKeychain = YES;
-                                 preferences = [checkinStore cachedCheckinPreferences];
-
-                                 XCTAssertNil(preferences.deviceID);
-                                 XCTAssertNil(preferences.secretToken);
-                                 XCTAssertFalse([preferences hasValidCheckinInfo]);
-
-                                 [checkinInvalidExpectation fulfill];
-                               }];
+  [self.checkinStore saveCheckinPreferences:preferences
+                                    handler:^(NSError *error) {
+                                      XCTAssertNil(error);
+                                      fakeKeychain.cannotReadFromKeychain = YES;
+                                      preferences = [self->_checkinStore cachedCheckinPreferences];
+
+                                      XCTAssertNil(preferences.deviceID);
+                                      XCTAssertNil(preferences.secretToken);
+                                      XCTAssertFalse([preferences hasValidCheckinInfo]);
+
+                                      [checkinInvalidExpectation fulfill];
+                                    }];
   [self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];
 }
 
@@ -108,56 +113,49 @@ - (void)testCheckinSaveFailsOnKeychainWriteFailure {
       [self expectationWithDescription:@"Checkin save should fail after keychain write failure"];
   FIRMessagingFakeKeychain *fakeKeychain = [[FIRMessagingFakeKeychain alloc] init];
   fakeKeychain.cannotWriteToKeychain = YES;
-
-  FIRMessagingCheckinStore *checkinStore = [[FIRMessagingCheckinStore alloc] init];
-  checkinStore.keychain = fakeKeychain;
+  self.checkinStore.keychain = fakeKeychain;
 
   __block FIRMessagingCheckinPreferences *preferences =
       [[FIRMessagingCheckinPreferences alloc] initWithDeviceID:kAuthID secretToken:kSecret];
   [preferences updateWithCheckinPlistContents:[[self class] newCheckinPlistPreferences]];
-  [checkinStore saveCheckinPreferences:preferences
-                               handler:^(NSError *error) {
-                                 XCTAssertNotNil(error);
-
-                                 preferences = [checkinStore cachedCheckinPreferences];
-                                 XCTAssertNil(preferences.deviceID);
-                                 XCTAssertNil(preferences.secretToken);
-                                 XCTAssertFalse([preferences hasValidCheckinInfo]);
-                                 [checkinSaveFailsExpectation fulfill];
-                               }];
+  [self.checkinStore saveCheckinPreferences:preferences
+                                    handler:^(NSError *error) {
+                                      XCTAssertNotNil(error);
+
+                                      preferences = [self->_checkinStore cachedCheckinPreferences];
+                                      XCTAssertNil(preferences.deviceID);
+                                      XCTAssertNil(preferences.secretToken);
+                                      XCTAssertFalse([preferences hasValidCheckinInfo]);
+                                      [checkinSaveFailsExpectation fulfill];
+                                    }];
   [self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];
 }
 
 - (void)testCheckinSaveFailsOnPlistWriteFailure {
   XCTestExpectation *checkinSaveFailsExpectation =
       [self expectationWithDescription:@"Checkin save should fail after plist write failure"];
-  FIRMessagingBackupExcludedPlist *checkinPlist =
-      [[FIRMessagingBackupExcludedPlist alloc] initWithFileName:kFakeCheckinPlistName
-                                                   subDirectory:kSubDirectoryName];
-  id plistMock = OCMPartialMock(checkinPlist);
+
+  id plistMock = OCMPartialMock(self.plist);
   NSError *error = [NSError errorWithDomain:kFakeErrorDomain code:kFakeErrorCode userInfo:nil];
   OCMStub([plistMock writeDictionary:[OCMArg any] error:[OCMArg setTo:error]]).andReturn(NO);
 
   FIRMessagingFakeKeychain *fakeKeychain = [[FIRMessagingFakeKeychain alloc] init];
-
-  FIRMessagingCheckinStore *checkinStore = [[FIRMessagingCheckinStore alloc] init];
-  checkinStore.keychain = fakeKeychain;
-  checkinStore.plist = checkinPlist;
+  self.checkinStore.keychain = fakeKeychain;
 
   __block FIRMessagingCheckinPreferences *preferences =
       [[FIRMessagingCheckinPreferences alloc] initWithDeviceID:kAuthID secretToken:kSecret];
   [preferences updateWithCheckinPlistContents:[[self class] newCheckinPlistPreferences]];
-  [checkinStore saveCheckinPreferences:preferences
-                               handler:^(NSError *error) {
-                                 XCTAssertNotNil(error);
-                                 XCTAssertEqual(error.code, kFakeErrorCode);
-
-                                 preferences = [checkinStore cachedCheckinPreferences];
-                                 XCTAssertNil(preferences.deviceID);
-                                 XCTAssertNil(preferences.secretToken);
-                                 XCTAssertFalse([preferences hasValidCheckinInfo]);
-                                 [checkinSaveFailsExpectation fulfill];
-                               }];
+  [self.checkinStore saveCheckinPreferences:preferences
+                                    handler:^(NSError *error) {
+                                      XCTAssertNotNil(error);
+                                      XCTAssertEqual(error.code, kFakeErrorCode);
+
+                                      preferences = [self->_checkinStore cachedCheckinPreferences];
+                                      XCTAssertNil(preferences.deviceID);
+                                      XCTAssertNil(preferences.secretToken);
+                                      XCTAssertFalse([preferences hasValidCheckinInfo]);
+                                      [checkinSaveFailsExpectation fulfill];
+                                    }];
   [self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];
 }
 
@@ -166,38 +164,25 @@ - (void)testCheckinSaveSuccess {
       [self expectationWithDescription:@"Checkin save should succeed"];
 
   FIRMessagingFakeKeychain *fakeKeychain = [[FIRMessagingFakeKeychain alloc] init];
-  FIRMessagingCheckinStore *checkinStore = [[FIRMessagingCheckinStore alloc] init];
-  checkinStore.keychain = fakeKeychain;
+  self.checkinStore.keychain = fakeKeychain;
 
   __block FIRMessagingCheckinPreferences *preferences =
       [[FIRMessagingCheckinPreferences alloc] initWithDeviceID:kAuthID secretToken:kSecret];
   [preferences updateWithCheckinPlistContents:[[self class] newCheckinPlistPreferences]];
-  [checkinStore saveCheckinPreferences:preferences
-                               handler:^(NSError *error) {
-                                 XCTAssertNil(error);
-
-                                 preferences = [checkinStore cachedCheckinPreferences];
-                                 XCTAssertEqualObjects(preferences.deviceID, kAuthID);
-                                 XCTAssertEqualObjects(preferences.secretToken, kSecret);
-                                 [checkinSaveSuccessExpectation fulfill];
-                               }];
+  [self.checkinStore saveCheckinPreferences:preferences
+                                    handler:^(NSError *error) {
+                                      XCTAssertNil(error);
+
+                                      preferences = [self->_checkinStore cachedCheckinPreferences];
+                                      XCTAssertEqualObjects(preferences.deviceID, kAuthID);
+                                      XCTAssertEqualObjects(preferences.secretToken, kSecret);
+                                      [checkinSaveSuccessExpectation fulfill];
+                                    }];
   [self waitForExpectationsWithTimeout:kExpectationTimeout handler:nil];
 }
 
 #pragma mark - Private Helpers
 
-- (BOOL)savePreferencesToPlist:(NSDictionary *)preferences {
-  NSString *path = [self pathForCheckinPlist];
-  return [preferences writeToFile:path atomically:YES];
-}
-
-- (NSString *)pathForCheckinPlist {
-  NSArray *paths =
-      NSSearchPathForDirectoriesInDomains(NSApplicationDirectory, NSUserDomainMask, YES);
-  NSString *plistNameWithExtension = [NSString stringWithFormat:@"%@.plist", kFakeCheckinPlistName];
-  return [paths[0] stringByAppendingPathComponent:plistNameWithExtension];
-}
-
 + (NSDictionary *)checkinPreferences {
   return @{
     kFIRMessagingDeviceAuthIdKey : kAuthID,
diff --git a/FirebaseMessaging/Tests/UnitTests/FIRMessagingTokenOperationsTest.m b/FirebaseMessaging/Tests/UnitTests/FIRMessagingTokenOperationsTest.m
@@ -114,13 +114,12 @@ - (void)setUp {
 }
 
 - (void)tearDown {
-  [_mockInstallations stopMocking];
-  _mockInstallations = nil;
   _authService = nil;
   [_mockCheckinService stopMocking];
   _mockCheckinService = nil;
   _checkinService = nil;
   _mockTokenStore = nil;
+  [_mockInstallations stopMocking];
 }
 
 - (void)testThatTokenOperationsAuthHeaderStringMatchesCheckin {
diff --git a/FirebaseMessaging/Tests/UnitTests/FIRMessagingTokenStoreTest.m b/FirebaseMessaging/Tests/UnitTests/FIRMessagingTokenStoreTest.m
@@ -52,6 +52,12 @@ @interface FIRMessagingTokenStore ()
 
 @end
 
+@interface FIRMessagingBackupExcludedPlist (ExposedForTest)
+
+- (BOOL)deleteFile:(NSError **)error;
+
+@end
+
 @interface FIRMessagingTokenStoreTest : XCTestCase
 
 @property(strong, nonatomic) FIRMessagingBackupExcludedPlist *checkinPlist;
@@ -86,11 +92,7 @@ - (void)setUp {
 }
 
 - (void)tearDown {
-  NSString *path = [self pathForCheckinPlist];
-  if ([[NSFileManager defaultManager] fileExistsAtPath:path]) {
-    NSError *error;
-    [[NSFileManager defaultManager] removeItemAtPath:path error:&error];
-  }
+  [self.checkinPlist deleteFile:nil];
   [_tokenStore removeAllTokensWithHandler:nil];
   [_mockCheckinStore stopMocking];
   [_mockTokenStore stopMocking];

Original file line number	Diff line number	Diff line change
`@@ -114,13 +114,12 @@ - (void)setUp {`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`- (void)tearDown {`
`117`		`- [_mockInstallations stopMocking];`
`118`		`- _mockInstallations = nil;`
`119`	`117`	`_authService = nil;`
`120`	`118`	`[_mockCheckinService stopMocking];`
`121`	`119`	`_mockCheckinService = nil;`
`122`	`120`	`_checkinService = nil;`
`123`	`121`	`_mockTokenStore = nil;`
	`122`	`+ [_mockInstallations stopMocking];`
`124`	`123`	`}`
`125`	`124`
`126`	`125`	`- (void)testThatTokenOperationsAuthHeaderStringMatchesCheckin {`