Update Unit test for AppRTCMobile app

webrtc/examples/objc/AppRTCMobile/tests/ARDAppClientTest.mm

 /*
  *  Copyright 2014 The WebRTC Project Authors. All rights reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
@@ skipping 64 matching lines @@
 - (ARDTestExpectation *)expectationWithDescription:(NSString *)description {
   ARDTestExpectation *expectation =
       [[ARDTestExpectation alloc] initWithDescription:description];
   [_expectations addObject:expectation];
   return expectation;
 }
 
 - (void)waitForExpectationsWithTimeout:(NSTimeInterval)timeout
                                handler:(void (^)(NSError *error))handler {
   NSDate *startDate = [NSDate date];
+  NSError *error = nil;
   while (![self areExpectationsFulfilled]) {
     NSTimeInterval duration = [[NSDate date] timeIntervalSinceDate:startDate];
     if (duration > timeout) {
-      NSAssert(NO, @"Expectation timed out.");

[daniela-webrtc, 2016/10/17 11:33:31]

By removing the NSAssert here you'll break the `testSession` test. So either
bring back the assertion here or make sure to add asserts to all the places
where this method is called (i.e line 298)
I personally, like this approach better where the validation responsibility is
moved to the caller of the method. 

+      error = [NSError errorWithDomain:@"ARDAppClient"

[daniela-webrtc, 2016/10/17 11:33:31]

I think you can use:
  error = [[NSError alloc] init];

I doubt that there will be any need in validating the actual error down the
line.

+                                  code:101
+                              userInfo:@{NSLocalizedDescriptionKey : @"Expectation timed out"}];
       break;
     }
     [[NSRunLoop currentRunLoop]
         runUntilDate:[NSDate dateWithTimeIntervalSinceNow:1]];
   }
-  handler(nil);
+  handler(error);
 }
 
 - (BOOL)areExpectationsFulfilled {
   for (ARDTestExpectation *expectation in _expectations) {
     if (!expectation.isFulfilled) {
       return NO;
     }
   }
   return YES;
 }
@@ skipping 25 matching lines @@
   joinResponse.messages = messages;
 
   // Successful message response.
   ARDMessageResponse *messageResponse = [[ARDMessageResponse alloc] init];
   messageResponse.result = kARDMessageResultTypeSuccess;
 
   // Return join response from above on join.
   [[[mockRoomServerClient stub] andDo:^(NSInvocation *invocation) {
     __unsafe_unretained void (^completionHandler)(ARDJoinResponse *response,
                                                   NSError *error);
-    [invocation getArgument:&completionHandler atIndex:3];
+    [invocation getArgument:&completionHandler atIndex:4];
     completionHandler(joinResponse, nil);
   }] joinRoomWithRoomId:roomId isLoopback:NO completionHandler:[OCMArg any]];
 
   // Return message response from above on join.
   [[[mockRoomServerClient stub] andDo:^(NSInvocation *invocation) {
     __unsafe_unretained ARDSignalingMessage *message;
     __unsafe_unretained void (^completionHandler)(ARDMessageResponse *response,
                                                   NSError *error);
     [invocation getArgument:&message atIndex:2];
     [invocation getArgument:&completionHandler atIndex:5];
@@ skipping 45 matching lines @@
   }] requestServersWithCompletionHandler:[OCMArg any]];
   return mockTURNClient;
 }
 
 - (ARDAppClient *)createAppClientForRoomId:(NSString *)roomId
                                   clientId:(NSString *)clientId
                                isInitiator:(BOOL)isInitiator
                                   messages:(NSArray *)messages
                             messageHandler:
     (void (^)(ARDSignalingMessage *message))messageHandler
-                          connectedHandler:(void (^)(void))connectedHandler {
+                          connectedHandler:(void (^)(NSInvocation *))connectedHandler {
   id turnClient = [self mockTURNClient];
   id signalingChannel = [self mockSignalingChannelForRoomId:roomId
                                                    clientId:clientId
                                              messageHandler:messageHandler];
   id roomServerClient =
       [self mockRoomServerClientForRoomId:roomId
                                  clientId:clientId
                               isInitiator:isInitiator
                                  messages:messages
                            messageHandler:messageHandler];
   id delegate =
       [OCMockObject niceMockForProtocol:@protocol(ARDAppClientDelegate)];
   [[[delegate stub] andDo:^(NSInvocation *invocation) {
-    connectedHandler();
+    connectedHandler(invocation);
   }] appClient:[OCMArg any]
       didChangeConnectionState:RTCIceConnectionStateConnected];
+  [[[delegate stub] andDo:^(NSInvocation *invocation) {
+    connectedHandler(invocation);
+  }] appClient:[OCMArg any]
+      didReceiveLocalVideoTrack:[OCMArg any]];
 
   return [[ARDAppClient alloc] initWithRoomServerClient:roomServerClient
                                        signalingChannel:signalingChannel
                                              turnClient:turnClient
                                                delegate:delegate];
 }
 
 // Tests that an ICE connection is established between two ARDAppClient objects
 // where one is set up as a caller and the other the answerer. Network
 // components are mocked out and messages are relayed directly from object to
@@ skipping 15 matching lines @@
   ARDTestExpectation *answererConnectionExpectation =
       [self expectationWithDescription:@"Answerer PC connected."];
 
   caller = [self createAppClientForRoomId:roomId
                                  clientId:callerId
                               isInitiator:YES
                                  messages:[NSArray array]
                            messageHandler:^(ARDSignalingMessage *message) {
     ARDAppClient *strongAnswerer = weakAnswerer;
     [strongAnswerer channel:strongAnswerer.channel didReceiveMessage:message];
-  } connectedHandler:^{
-    [callerConnectionExpectation fulfill];
+  } connectedHandler:^(NSInvocation *invocation){
+    if ([NSStringFromSelector([invocation selector])
+         isEqualToString:@"appClient:didChangeConnectionState:"])
+      [callerConnectionExpectation fulfill];
   }];
   // TODO(tkchin): Figure out why DTLS-SRTP constraint causes thread assertion
   // crash in Debug.
   caller.defaultPeerConnectionConstraints =
       [[RTCMediaConstraints alloc] initWithMandatoryConstraints:nil
                                             optionalConstraints:nil];
   weakCaller = caller;
 
   answerer = [self createAppClientForRoomId:roomId
                                    clientId:answererId
                                 isInitiator:NO
                                    messages:[NSArray array]
                              messageHandler:^(ARDSignalingMessage *message) {
     ARDAppClient *strongCaller = weakCaller;
     [strongCaller channel:strongCaller.channel didReceiveMessage:message];
-  } connectedHandler:^{
-    [answererConnectionExpectation fulfill];
+  } connectedHandler:^(NSInvocation *invocation){
+    if ([NSStringFromSelector([invocation selector])
+         isEqualToString:@"appClient:didChangeConnectionState:"])
+      [answererConnectionExpectation fulfill];
   }];
   // TODO(tkchin): Figure out why DTLS-SRTP constraint causes thread assertion
   // crash in Debug.
   answerer.defaultPeerConnectionConstraints =
       [[RTCMediaConstraints alloc] initWithMandatoryConstraints:nil
                                             optionalConstraints:nil];
   weakAnswerer = answerer;
 
   // Kick off connection.
   [caller connectToRoomWithId:roomId
                    isLoopback:NO
                   isAudioOnly:NO
             shouldMakeAecDump:NO
         shouldUseLevelControl:NO];
   [answerer connectToRoomWithId:roomId
                      isLoopback:NO
                     isAudioOnly:NO
               shouldMakeAecDump:NO
           shouldUseLevelControl:NO];
   [self waitForExpectationsWithTimeout:20 handler:^(NSError *error) {
     if (error) {
       NSLog(@"Expectations error: %@", error);
     }
   }];
 }
 
+// Test to see that we get a local video connection
+// Note this will currently pass even when no camera is connected as a local
+// video track is created regardless (Perhaps there should be a test for that...)
+- (void)testSession_ShouldGetLocalVideoTrackCallback {

[daniela-webrtc, 2016/10/17 11:33:31]

Please remove the underscore from the name of the method. I know that some
developers use it to increase readability but we don't use it in our codebase.

+  ARDAppClient *caller = nil;
+  NSString *roomId = @"testRoom";
+  NSString *callerId = @"testCallerId";
+
+  ARDTestExpectation *callerConnectionExpectation =
+  [self expectationWithDescription:@"Caller PC connected."];
+
+  caller = [self createAppClientForRoomId:roomId
+                                 clientId:callerId
+                              isInitiator:YES
+                                 messages:[NSArray array]
+                           messageHandler:^(ARDSignalingMessage *message) {
+                           } connectedHandler:^(NSInvocation *invocation){

[daniela-webrtc, 2016/10/17 11:33:31]

Nit: move connectedHandler parameter to next line

+                             if ([NSStringFromSelector([invocation selector])
+                                  isEqualToString:@"appClient:didReceiveLocalVideoTrack:"])
+                               [callerConnectionExpectation fulfill];
+                           }];
+  caller.defaultPeerConnectionConstraints =
+  [[RTCMediaConstraints alloc] initWithMandatoryConstraints:nil
+                                        optionalConstraints:nil];
+
+  // Kick off connection.
+  [caller connectToRoomWithId:roomId
+                   isLoopback:NO
+                  isAudioOnly:NO
+            shouldMakeAecDump:NO
+        shouldUseLevelControl:NO];
+  [self waitForExpectationsWithTimeout:20 handler:^(NSError *error) {
+    if (error) {
+      EXPECT_TRUE(0);
+    }
+  }];
+}
+
 @end
 
+@interface NSString (WebRTCTests)
+- (BOOL) webrtc_containsString: (NSString *)otherString;
+@end
+@implementation NSString (WebRTCTests)
+- (BOOL) webrtc_containsString: (NSString *)otherString
+{
+  return (otherString && [self rangeOfString: otherString].location != NSNotFound);
+}
+@end
+
 @interface ARDSDPUtilsTest : ARDTestCase
 - (void)testPreferVideoCodec;
 @end
 
 @implementation ARDSDPUtilsTest
 
+

[daniela-webrtc, 2016/10/17 11:33:31]

Nit: remove extra line

 - (void)testPreferVideoCodec {
   NSString *sdp = @("m=video 9 RTP/SAVPF 100 116 117 96 120\n"
                     "a=rtpmap:120 H264/90000\n");
-  NSString *expectedSdp = @("m=video 9 RTP/SAVPF 120 100 116 117 96\n"
-                            "a=rtpmap:120 H264/90000\n");
+  NSArray *expectedSdpLines = @[@"m=video 9 RTP/SAVPF 120 100 116 117 96\n",
+                                @"a=rtpmap:120 H264/90000\n"];
   RTCSessionDescription* desc =
       [[RTCSessionDescription alloc] initWithType:RTCSdpTypeOffer sdp:sdp];
   RTCSessionDescription *h264Desc =
       [ARDSDPUtils descriptionForDescription:desc
                          preferredVideoCodec:@"H264"];
-  EXPECT_TRUE([h264Desc.description isEqualToString:expectedSdp]);
+  EXPECT_TRUE([h264Desc.description webrtc_containsString: expectedSdpLines[0]]

[daniela-webrtc, 2016/10/17 11:33:31]

There seems to be no apparent change in the ARDSDPUtils class that might have
broken this check.
I'm curious what value does h264Desc have when you run the test?

[afedor, 2016/10/19 03:10:47]

I get:  
"RTCSessionDescription:\n
offer\n
m=video 9 RTP/SAVPF 120 100 116 117 96\n
a=rtpmap:120 H264/90000\n"

so I coud test for that, or just change isEqualToString: to hasSuffix:, but I
though I'd just test for the individual lines, since AFAIK the SDP doesn't have
to be in a certain order, and those lines are all I need to verify.

+              && [h264Desc.description webrtc_containsString: expectedSdpLines[1]]);
 }
 
 @end
 
 class SignalingTest : public ::testing::Test {
  protected:
   static void SetUpTestCase() {
     rtc::InitializeSSL();
   }
   static void TearDownTestCase() {
     rtc::CleanupSSL();
   }
 };
 
 TEST_F(SignalingTest, SessionTest) {
   @autoreleasepool {
     ARDAppClientTest *test = [[ARDAppClientTest alloc] init];
     [test testSession];
   }
 }
 
+TEST_F(SignalingTest, SessionLocalVideoCallbackTest) {
+  @autoreleasepool {
+    ARDAppClientTest *test = [[ARDAppClientTest alloc] init];
+    [test testSession_ShouldGetLocalVideoTrackCallback];
+  }
+}
+
 TEST_F(SignalingTest, SDPTest) {
   @autoreleasepool {
     ARDSDPUtilsTest *test = [[ARDSDPUtilsTest alloc] init];
     [test testPreferVideoCodec];
   }
 }
 
-
+int main(int argc, char **argv) {
+  ::testing::InitGoogleTest(&argc, argv);
+  return RUN_ALL_TESTS();
+}