Skip to content

Integration tests should wait until the room is ready #1516

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

Merged
merged 2 commits into from
Jul 8, 2022
Merged

Integration tests should wait until the room is ready #1516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
741929d
Integration tests should wait until the room is ready
Anderas Jul 8, 2022
9802f02
Add changelog and fix indentation
Anderas Jul 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 76 additions & 11 deletions MatrixSDKTests/MXCryptoTests.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,8 @@ - (void)testCryptoPersistenceInStore
}];
}

- (void)testMultipleDownloadKeys
// TODO: Test currently broken
- (void)xtestMultipleDownloadKeys
{
[matrixSDKTestsE2EData doE2ETestWithBobAndAlice:self readyToTest:^(MXSession *bobSession, MXSession *aliceSession, XCTestExpectation *expectation) {

Expand Down Expand Up @@ -595,14 +596,14 @@ - (void)testAliceInACryptedRoomAfterInitialSync

[aliceSession2 setStore:[[MXMemoryStore alloc] init] success:^{

[aliceSession2 start:^{
[self restartSession:aliceSession2
waitingForRoomId:roomId
success:^(MXRoom *roomFromAlicePOV) {

XCTAssert(aliceSession2.crypto, @"MXSession must recall that it has crypto engaged");

NSString *message = @"Hello myself!";

MXRoom *roomFromAlicePOV = [aliceSession2 roomWithRoomId:roomId];

XCTAssert(roomFromAlicePOV.summary.isEncrypted);

// Check the echo from hs of a post message is correct
Expand Down Expand Up @@ -751,13 +752,13 @@ - (void)testAliceAndBobInACryptedRoomFromInitialSync
[bobSession setStore:[[MXMemoryStore alloc] init] success:^{

XCTAssert(bobSession.crypto, @"MXSession must recall that it has crypto engaged");

[bobSession start:^{

[self restartSession:bobSession
waitingForRoomId:roomId
success:^(MXRoom * roomFromBobPOV) {

__block NSUInteger paginatedMessagesCount = 0;

MXRoom *roomFromBobPOV = [bobSession roomWithRoomId:roomId];

[roomFromBobPOV liveTimeline:^(id<MXEventTimeline> liveTimeline) {

[liveTimeline resetPagination];
Expand Down Expand Up @@ -879,7 +880,8 @@ - (void)testAliceAndBobInACryptedRoomBackPaginationFromMemoryStore
}];
}

- (void)testAliceAndBobInACryptedRoomBackPaginationFromHomeServer
// TODO: Test currently broken
- (void)xtestAliceAndBobInACryptedRoomBackPaginationFromHomeServer
{
[matrixSDKTestsE2EData doE2ETestWithAliceAndBobInARoomWithCryptedMessages:self cryptedBob:YES readyToTest:^(MXSession *aliceSession, MXSession *bobSession, NSString *roomId, XCTestExpectation *expectation) {

Expand Down Expand Up @@ -1318,7 +1320,9 @@ - (void)testAliceAndBlockedBob
// Alice unblacklists the unverified devices in the current room
// Alice sends a message #5
// Check that the message can be decrypted by the Bob's device and the Sam's device
- (void)testBlackListUnverifiedDevices

// TODO: Test currently broken
- (void)xtestBlackListUnverifiedDevices
{
NSArray *aliceMessages = @[
@"0",
Expand Down Expand Up @@ -2123,7 +2127,9 @@ - (void)testLateRoomKey
// -> No issue with the 2 first messages
// -> The third event must fail to decrypt at first because Bob the olm session is wedged
// -> This is automatically fixed after SDKs restarted the olm session
- (void)testOlmSessionUnwedging

// TODO: Test currently broken
- (void)xtestOlmSessionUnwedging
{
// - Alice & Bob have messages in a room
[matrixSDKTestsE2EData doE2ETestWithAliceAndBobInARoom:self cryptedBob:YES warnOnUnknowDevices:NO aliceStore:[[MXFileStore alloc] init] bobStore:[[MXFileStore alloc] init] readyToTest:^(MXSession *aliceSession, MXSession *bobSession, NSString *roomId, XCTestExpectation *expectation) {
Expand Down Expand Up @@ -3422,6 +3428,65 @@ - (void)testIsRoomSharingHistory
}];
}

#pragma mark Helpers

/**
Manually restart the session and wait until a given room has finished syncing all state

Note: there is a lot of state update and sync going on when the session is started,
and integration tests often assume given state before it has finished updating. To solve
that this helper method makes the best guesses by observing global notifications
and adding small delays to ensure all updates have really completed.
*/
- (void)restartSession:(MXSession *)session
waitingForRoomId:(NSString *)roomId
success:(void (^)(MXRoom *))success
failure:(void (^)(NSError *))failure
{
__block id observer;

// First start the session
[session start:^{

// Wait until we know that the room has actually been created
observer = [[NSNotificationCenter defaultCenter] addObserverForName:kMXSessionNewRoomNotification
object:nil
queue:[NSOperationQueue mainQueue]
usingBlock:^(NSNotification * notification) {
if ([notification.userInfo[kMXSessionNotificationRoomIdKey] isEqualToString:roomId])
{
[[NSNotificationCenter defaultCenter] removeObserver:observer];

MXRoom *room = [session roomWithRoomId:roomId];
if (room)
{
// Now wait until this room reports sync completion
observer = [[NSNotificationCenter defaultCenter] addObserverForName:kMXRoomInitialSyncNotification
object:nil
queue:[NSOperationQueue mainQueue]
usingBlock:^(NSNotification * notification) {
[[NSNotificationCenter defaultCenter] removeObserver:observer];

// Even when sync completed, there are actually still a few async updates that happen (i.e. the notification
// fires too early), so have to add some small arbitrary delay.
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, 1 * NSEC_PER_SEC), dispatch_get_main_queue(), ^{
Copy link
Member

Choose a reason for hiding this comment

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

Kind of annoying to have to stall for a whole second, but can see why it is needed 🙁

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea it is indeed. I would fix the notification, but then have no test to proove that I did not break something else, so this should be passing first before any changes to production code.

success(room);
});
}];
}
else
{
NSError *error = [NSError errorWithDomain:@"MatrixSDKTestsData" code:0 userInfo:@{
@"reason": @"Missing room"
}];
failure(error);
}
}

}];
} failure:failure];
}

@end

#pragma clang diagnostic pop
Expand Down
47 changes: 1 addition & 46 deletions MatrixSDKTests/TestPlans/CryptoTests.xctestplan
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,52 +31,7 @@
"selectedTests" : [
"MXCryptoShareTests\/testShareHistoryKeysWithInvitedUser",
"MXCryptoShareTests\/testSharedHistoryPreservedWhenForwardingKeys",
"MXCryptoTests\/testAliceAndBlockedBob",
"MXCryptoTests\/testAliceAndBobInACryptedRoom",
"MXCryptoTests\/testAliceAndBobInACryptedRoom2",
"MXCryptoTests\/testAliceAndBobInACryptedRoomBackPaginationFromMemoryStore",
"MXCryptoTests\/testAliceAndBobInACryptedRoomFromInitialSync",
"MXCryptoTests\/testAliceAndBobWithNewDevice",
"MXCryptoTests\/testAliceAndNotCryptedBobInACryptedRoom",
"MXCryptoTests\/testAliceDecryptOldMessageWithANewDeviceInACryptedRoom",
"MXCryptoTests\/testAliceInACryptedRoom",
"MXCryptoTests\/testAliceInACryptedRoomAfterInitialSync",
"MXCryptoTests\/testAliceWithNewDeviceAndBob",
"MXCryptoTests\/testAliceWithNewDeviceAndBobWithNewDevice",
"MXCryptoTests\/testBadSummaryIsEncryptedState",
"MXCryptoTests\/testCryptoNoDeviceId",
"MXCryptoTests\/testCryptoPersistenceInStore",
"MXCryptoTests\/testDeviceInvalidationWhileSending",
"MXCryptoTests\/testDiscardAndRestoreOlmOutboundKey",
"MXCryptoTests\/testDownloadKeysForUserWithNoDevice",
"MXCryptoTests\/testDownloadKeysWithUnreachableHS",
"MXCryptoTests\/testEnableCrypto",
"MXCryptoTests\/testEnableEncryptionAfterNonCryptedMessages",
"MXCryptoTests\/testEncryptionAlgorithmChange",
"MXCryptoTests\/testEnsureSingleOlmSession",
"MXCryptoTests\/testExportImportRoomKeysWithPassword",
"MXCryptoTests\/testExportRoomKeys",
"MXCryptoTests\/testFallbackKeySignatures",
"MXCryptoTests\/testFirstMessageSentWhileSessionWasPaused",
"MXCryptoTests\/testHasKeysToDecryptEvent",
"MXCryptoTests\/testImportRoomKeys",
"MXCryptoTests\/testImportRoomKeysWithWrongPassword",
"MXCryptoTests\/testIncomingRoomKeyRequest",
"MXCryptoTests\/testInvitedMemberInACryptedRoom",
"MXCryptoTests\/testInvitedMemberInACryptedRoom2",
"MXCryptoTests\/testIsRoomSharingHistory",
"MXCryptoTests\/testLateRoomKey",
"MXCryptoTests\/testLeftAndJoinedBob",
"MXCryptoTests\/testLeftBobAndAliceWithNewDevice",
"MXCryptoTests\/testMXDeviceListDidUpdateUsersDevicesNotification",
"MXCryptoTests\/testMXSDKOptionsEnableCryptoWhenOpeningMXSession",
"MXCryptoTests\/testMXSessionEventWithEventId",
"MXCryptoTests\/testReplayAttack",
"MXCryptoTests\/testReplayAttackForEventEdits",
"MXCryptoTests\/testRestoreOlmOutboundKey",
"MXCryptoTests\/testRoomIsEncrypted",
"MXCryptoTests\/testRoomKeyReshare",
"MXCryptoTests\/testSendReplyToTextMessage",
"MXCryptoTests",
"MXMegolmEncryptionTests"
],
"target" : {
Expand Down
1 change: 1 addition & 0 deletions changelog.d/pr-1516.misc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Integration tests should wait until the room is ready