Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove unnecessary rmq database operations in unit tests. #4236

Merged
merged 21 commits into from Nov 7, 2019
Merged

Remove unnecessary rmq database operations in unit tests. #4236

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
e85c4dc
comment out flaky test
charlotteliang Oct 29, 2019
4bc9d68
fix flaky tests
charlotteliang Oct 29, 2019
274ce67
comment out more tests
charlotteliang Oct 30, 2019
a16d1e5
test with remove one whole test class
charlotteliang Oct 30, 2019
d4380f9
remove another potential flaky test class;
charlotteliang Oct 30, 2019
8f715c5
stop unnecessary rmq manager operations in some of the unit tests
charlotteliang Nov 5, 2019
ddb7148
disable fcm auto init tests
charlotteliang Nov 5, 2019
3aa5361
stub rmqManager in all tests that initialize messaging
charlotteliang Nov 5, 2019
16f7ab4
fix testUtil
charlotteliang Nov 5, 2019
7845119
put back the old tests
charlotteliang Nov 5, 2019
9785f42
fix format;
charlotteliang Nov 5, 2019
5125fc2
fix format
charlotteliang Nov 5, 2019
f454966
fix style
charlotteliang Nov 5, 2019
3441220
remove trailinig space
charlotteliang Nov 5, 2019
b9ab4c5
remove trailing whitespace
charlotteliang Nov 5, 2019
e01be56
remove database in the serial queue
charlotteliang Nov 6, 2019
18298ed
Merge branch 'master' of github.com:firebase/firebase-ios-sdk into fc…
charlotteliang Nov 6, 2019
f21240a
update travis.yml
charlotteliang Nov 6, 2019
4489526
Merge branch 'master' of github.com:firebase/firebase-ios-sdk into fc…
charlotteliang Nov 6, 2019
bf3253e
refactor based on maksym suggestion and to kick a new travis run
charlotteliang Nov 6, 2019
f16b62c
fix missing parameter
charlotteliang Nov 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 13 additions & 16 deletions Example/Messaging/Tests/FIRInstanceIDWithFCMTest.m
View file
Open in desktop
Expand Up @@ -27,55 +27,52 @@
@interface FIRInstanceID (ExposedForTest)
- (BOOL)isFCMAutoInitEnabled;
- (instancetype)initPrivately;
- (void)start;
@end

@interface FIRMessaging ()
+ (FIRMessaging *)messagingForTests;
@end

@interface FIRInstanceIDTest : XCTestCase

@property(nonatomic, readwrite, strong) FIRInstanceID *instanceID;
@property(nonatomic, readwrite, strong) id mockFirebaseApp;
@property(nonatomic, readwrite, strong) FIRMessagingTestUtilities *testUtil;
@property(nonatomic, strong) FIRMessaging *messaging;


@end

@implementation FIRInstanceIDTest

- (void)setUp {
[super setUp];
_instanceID = [[FIRInstanceID alloc] initPrivately];
[_instanceID start];
NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
_testUtil = [[FIRMessagingTestUtilities alloc] initWithUserDefaults:defaults withRMQManager:NO];
_instanceID = _testUtil.instanceID;
_messaging = _testUtil.messaging;
_mockFirebaseApp = OCMClassMock([FIRApp class]);
OCMStub([_mockFirebaseApp defaultApp]).andReturn(_mockFirebaseApp);
}

- (void)tearDown {
self.instanceID = nil;
[_testUtil cleanupAfterTest];
_instanceID = nil;
_messaging = nil;
[_mockFirebaseApp stopMocking];
[super tearDown];
}

- (void)testFCMAutoInitEnabled {
// Use the standardUserDefaults since that's what IID expects and depends on.
NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
FIRMessaging *messaging = [FIRMessagingTestUtilities messagingForTestsWithUserDefaults:defaults];
id classMock = OCMClassMock([FIRMessaging class]);
OCMStub([_mockFirebaseApp isDataCollectionDefaultEnabled]).andReturn(YES);
messaging.autoInitEnabled = YES;
_messaging.autoInitEnabled = YES;
XCTAssertTrue(
[_instanceID isFCMAutoInitEnabled],
@"When FCM is available, FCM Auto Init Enabled should be FCM's autoInitEnable property.");

messaging.autoInitEnabled = NO;
_messaging.autoInitEnabled = NO;
XCTAssertFalse(
[_instanceID isFCMAutoInitEnabled],
@"When FCM is available, FCM Auto Init Enabled should be FCM's autoInitEnable property.");

messaging.autoInitEnabled = YES;
_messaging.autoInitEnabled = YES;
XCTAssertTrue([_instanceID isFCMAutoInitEnabled]);
[classMock stopMocking];
}

@end
24 changes: 9 additions & 15 deletions Example/Messaging/Tests/FIRMessagingHandlingTest.m
View file
Open in desktop
Expand Up @@ -38,7 +38,6 @@ @interface FIRMessaging ()

@property(nonatomic, readwrite, strong) NSString *defaultFcmToken;
@property(nonatomic, readwrite, strong) FIRInstanceID *instanceID;
@property(nonatomic, readwrite, strong) FIRMessagingRmqManager *rmq2Manager;

- (BOOL)handleContextManagerMessage:(NSDictionary *)message;
- (void)handleIncomingLinkIfNeededFromMessage:(NSDictionary *)message;
Expand All @@ -52,12 +51,13 @@ - (void)handleIncomingLinkIfNeededFromMessage:(NSDictionary *)message;
*/
@interface FIRMessagingHandlingTest : XCTestCase

@property(nonatomic, readonly, strong) FIRMessaging *messaging;
@property(nonatomic, strong) FIRMessagingAnalytics *messageAnalytics;
@property(nonatomic, strong) FIRMessaging *messaging;
@property(nonatomic, strong) id mockMessaging;
@property(nonatomic, strong) id mockInstanceID;
@property(nonatomic, strong) id mockFirebaseApp;
@property(nonatomic, strong) id mockMessagingAnalytics;
@property(nonatomic, strong) FIRMessagingTestUtilities *testUtil;

@end

Expand All @@ -69,23 +69,20 @@ - (void)setUp {
// Create the messaging instance with all the necessary dependencies.
NSUserDefaults *defaults =
[[NSUserDefaults alloc] initWithSuiteName:kFIRMessagingDefaultsTestDomain];
_messaging = [FIRMessagingTestUtilities messagingForTestsWithUserDefaults:defaults];
_testUtil = [[FIRMessagingTestUtilities alloc] initWithUserDefaults:defaults withRMQManager:YES];
_mockMessaging = _testUtil.mockMessaging;
_mockInstanceID = _testUtil.mockInstanceID;
_messaging = _testUtil.messaging;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just remove _mockMessaging, _mockInstanceID, etc. and refer to _testUtil directly to avoid potential confusion in the future?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this gonna be a big refactor, will probably do it in another CL.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is done in this PR.

_mockFirebaseApp = OCMClassMock([FIRApp class]);
OCMStub([_mockFirebaseApp defaultApp]).andReturn(_mockFirebaseApp);
_mockInstanceID = OCMPartialMock(self.messaging.instanceID);
[[NSUserDefaults standardUserDefaults]
removePersistentDomainForName:[NSBundle mainBundle].bundleIdentifier];
_mockMessaging = OCMPartialMock(_messaging);
_mockMessagingAnalytics = OCMClassMock([FIRMessagingAnalytics class]);
}

- (void)tearDown {
[self.messaging.messagingUserDefaults removePersistentDomainForName:kFIRMessagingDefaultsTestDomain];
self.messaging.shouldEstablishDirectChannel = NO;
self.messaging.defaultFcmToken = nil;
[_testUtil cleanupAfterTest];
[_mockMessagingAnalytics stopMocking];
[_mockMessaging stopMocking];
[_mockInstanceID stopMocking];
[_mockFirebaseApp stopMocking];
_messaging = nil;
[super tearDown];
Expand Down Expand Up @@ -124,8 +121,7 @@ -(void)testAPNSDisplayNotification {
XCTAssertEqualObjects(@(FIRMessagingMessageStatusNew),
@([_messaging appDidReceiveMessage:notificationPayload].status));
OCMVerifyAll(_mockMessaging);
// Clear database
[_messaging.rmq2Manager deleteSyncMessageWithRmqID:@"1566515013484879"];

}

-(void)testAPNSContentAvailableNotification {
Expand All @@ -151,11 +147,11 @@ -(void)testAPNSContentAvailableNotification {
XCTAssertEqualObjects(@(FIRMessagingMessageStatusNew),
@([_messaging appDidReceiveMessage:notificationPayload].status));
OCMVerifyAll(_mockMessaging);
[_messaging.rmq2Manager deleteSyncMessageWithRmqID:@"1566513591299872"];

}

-(void)testAPNSContentAvailableContextualNotification {

NSDictionary *notificationPayload = @{
@"aps" : @{
@"content-available": @1
Expand Down Expand Up @@ -187,7 +183,6 @@ -(void)testAPNSContentAvailableContextualNotification {
XCTAssertEqualObjects(@(FIRMessagingMessageStatusNew),
@([_messaging appDidReceiveMessage:notificationPayload].status));
OCMVerifyAll(_mockMessaging);
[_messaging.rmq2Manager deleteSyncMessageWithRmqID:@"1566515531287827"];

}

Expand Down Expand Up @@ -217,7 +212,6 @@ -(void)testContextualLocalNotification {
XCTAssertEqualObjects(@(FIRMessagingMessageStatusNew),
@([_messaging appDidReceiveMessage:notificationPayload].status));
OCMVerifyAll(_mockMessaging);
[_messaging.rmq2Manager deleteSyncMessageWithRmqID:@"1566515531281975"];
}

-(void)testMCSNotification {
Expand Down
17 changes: 10 additions & 7 deletions Example/Messaging/Tests/FIRMessagingLinkHandlingTest.m
View file
Open in desktop
Expand Up @@ -35,6 +35,8 @@ - (NSURL *)linkURLFromMessage:(NSDictionary *)message;
@interface FIRMessagingLinkHandlingTest : XCTestCase

@property(nonatomic, readonly, strong) FIRMessaging *messaging;
@property(nonatomic, strong) FIRMessagingTestUtilities * testUtil;


@end

Expand All @@ -44,11 +46,12 @@ - (void)setUp {
[super setUp];

NSUserDefaults *defaults = [[NSUserDefaults alloc] initWithSuiteName:kFIRMessagingTestsLinkHandlingSuiteName];
_messaging = [FIRMessagingTestUtilities messagingForTestsWithUserDefaults:defaults];
_testUtil = [[FIRMessagingTestUtilities alloc] initWithUserDefaults:defaults withRMQManager:NO];
_messaging = _testUtil.messaging;
}

- (void)tearDown {
[self.messaging.messagingUserDefaults removePersistentDomainForName:kFIRMessagingTestsLinkHandlingSuiteName];
[_testUtil cleanupAfterTest];
_messaging = nil;
[super tearDown];
}
Expand All @@ -58,39 +61,39 @@ - (void)tearDown {
- (void)testNonExistentLinkInMessage {
NSMutableDictionary *notification =
[FIRMessagingTestNotificationUtilities createBasicNotificationWithUniqueMessageID];
NSURL *url = [self.messaging linkURLFromMessage:notification];
NSURL *url = [_messaging linkURLFromMessage:notification];
XCTAssertNil(url);
}

- (void)testEmptyLinkInMessage {
NSMutableDictionary *notification =
[FIRMessagingTestNotificationUtilities createBasicNotificationWithUniqueMessageID];
notification[kFIRMessagingMessageLinkKey] = @"";
NSURL *url = [self.messaging linkURLFromMessage:notification];
NSURL *url = [_messaging linkURLFromMessage:notification];
XCTAssertNil(url);
}

- (void)testNonStringLinkInMessage {
NSMutableDictionary *notification =
[FIRMessagingTestNotificationUtilities createBasicNotificationWithUniqueMessageID];
notification[kFIRMessagingMessageLinkKey] = @(5);
NSURL *url = [self.messaging linkURLFromMessage:notification];
NSURL *url = [_messaging linkURLFromMessage:notification];
XCTAssertNil(url);
}

- (void)testInvalidURLStringLinkInMessage {
NSMutableDictionary *notification =
[FIRMessagingTestNotificationUtilities createBasicNotificationWithUniqueMessageID];
notification[kFIRMessagingMessageLinkKey] = @"This is not a valid url string";
NSURL *url = [self.messaging linkURLFromMessage:notification];
NSURL *url = [_messaging linkURLFromMessage:notification];
XCTAssertNil(url);
}

- (void)testValidURLStringLinkInMessage {
NSMutableDictionary *notification =
[FIRMessagingTestNotificationUtilities createBasicNotificationWithUniqueMessageID];
notification[kFIRMessagingMessageLinkKey] = @"https://www.google.com/";
NSURL *url = [self.messaging linkURLFromMessage:notification];
NSURL *url = [_messaging linkURLFromMessage:notification];
XCTAssertTrue([url.absoluteString isEqualToString:@"https://www.google.com/"]);
}

Expand Down
18 changes: 9 additions & 9 deletions Example/Messaging/Tests/FIRMessagingServiceTest.m
View file
Open in desktop
Expand Up @@ -59,7 +59,9 @@ @interface FIRMessagingServiceTest : XCTestCase {
FIRMessaging *_messaging;
FIRInstanceIDResult *_result;
id _mockInstanceID;
id _mockMessaging;
id _mockPubSub;
FIRMessagingTestUtilities *_testUtil;
}

@end
Expand All @@ -69,21 +71,20 @@ @implementation FIRMessagingServiceTest
- (void)setUp {
[super setUp];
NSUserDefaults *defaults = [[NSUserDefaults alloc] initWithSuiteName:kFIRMessagingTestsServiceSuiteName];
_messaging = [FIRMessagingTestUtilities messagingForTestsWithUserDefaults:defaults];
_messaging.defaultFcmToken = kFakeToken;
_mockPubSub = OCMPartialMock(_messaging.pubsub);
_testUtil = [[FIRMessagingTestUtilities alloc] initWithUserDefaults:defaults withRMQManager:NO];
_mockMessaging = _testUtil.mockMessaging;
_messaging = _testUtil.messaging;
OCMStub([_mockMessaging defaultFcmToken]).andReturn(kFakeToken);
_mockPubSub = _testUtil.mockPubsub;
[_mockPubSub setClient:nil];

_mockInstanceID = OCMPartialMock(_messaging.instanceID);
_mockInstanceID = _testUtil.mockInstanceID;
_result = [[FIRInstanceIDResult alloc] init];
_result.token = kFakeToken;
_result.instanceID = kFakeID;
}

- (void)tearDown {
[_mockInstanceID stopMocking];
[_mockPubSub stopMocking];
[_messaging.messagingUserDefaults removePersistentDomainForName:kFIRMessagingTestsServiceSuiteName];
[_testUtil cleanupAfterTest];
_messaging = nil;
[super tearDown];
}
Expand Down Expand Up @@ -152,7 +153,6 @@ - (void)testUnsubscribe {
topic:topic
options:nil
handler:^(NSError *error){

}];

// should call updateSubscription
Expand Down
15 changes: 7 additions & 8 deletions Example/Messaging/Tests/FIRMessagingTest.m
View file
Open in desktop
Expand Up @@ -52,6 +52,7 @@ @interface FIRMessagingTest : XCTestCase
@property(nonatomic, readwrite, strong) id mockMessaging;
@property(nonatomic, readwrite, strong) id mockInstanceID;
@property(nonatomic, readwrite, strong) id mockFirebaseApp;
@property(nonatomic, strong) FIRMessagingTestUtilities *testUtil;

@end

Expand All @@ -63,21 +64,19 @@ - (void)setUp {
// Create the messaging instance with all the necessary dependencies.
NSUserDefaults *defaults =
[[NSUserDefaults alloc] initWithSuiteName:kFIRMessagingDefaultsTestDomain];
_messaging = [FIRMessagingTestUtilities messagingForTestsWithUserDefaults:defaults];
_testUtil = [[FIRMessagingTestUtilities alloc] initWithUserDefaults:defaults withRMQManager:NO];
_mockMessaging = _testUtil.mockMessaging;
_messaging = _testUtil.messaging;

_mockFirebaseApp = OCMClassMock([FIRApp class]);
OCMStub([_mockFirebaseApp defaultApp]).andReturn(_mockFirebaseApp);
_mockInstanceID = OCMPartialMock(self.messaging.instanceID);
_mockInstanceID = _testUtil.mockInstanceID;
[[NSUserDefaults standardUserDefaults]
removePersistentDomainForName:[NSBundle mainBundle].bundleIdentifier];
}

- (void)tearDown {
[self.messaging.messagingUserDefaults removePersistentDomainForName:kFIRMessagingDefaultsTestDomain];
self.messaging.shouldEstablishDirectChannel = NO;
self.messaging.defaultFcmToken = nil;
self.messaging.apnsTokenData = nil;
[_mockMessaging stopMocking];
[_mockInstanceID stopMocking];
[_testUtil cleanupAfterTest];
[_mockFirebaseApp stopMocking];
_messaging = nil;
[super tearDown];
Expand Down
19 changes: 10 additions & 9 deletions Example/Messaging/Tests/FIRMessagingTestUtilities.h
View file
Open in desktop
Expand Up @@ -17,27 +17,28 @@
#import <Foundation/Foundation.h>

#import <FirebaseMessaging/FIRMessaging.h>
#import <FirebaseInstanceID/FIRInstanceID.h>

NS_ASSUME_NONNULL_BEGIN

@interface FIRMessaging (TestUtilities)
// Surface the user defaults instance to clean up after tests.
@property(nonatomic, strong) NSUserDefaults *messagingUserDefaults;

@end

@interface FIRMessagingTestUtilities : NSObject

/**
Creates an instance of FIRMessaging to use with tests, and will instantiate a new instance of
InstanceID.
@property(nonatomic, strong) id mockInstanceID;
@property(nonatomic, strong) id mockPubsub;
@property(nonatomic, strong) id mockMessaging;
@property(nonatomic, readonly, strong) FIRMessaging *messaging;
@property(nonatomic, readonly, strong) FIRInstanceID *instanceID;

Note: This does not create a FIRApp instance and call `configureWithApp:`. If required, it's up to
each test to do so.

@param userDefaults The user defaults to be used for Messaging.
@return An instance of FIRMessaging with everything initialized.
*/
+ (FIRMessaging *)messagingForTestsWithUserDefaults:(NSUserDefaults *)userDefaults;
- (instancetype)initWithUserDefaults:(NSUserDefaults *)userDefaults withRMQManager:(BOOL)withRMQManager;

- (void)cleanupAfterTest;

@end

Expand Down