Implement network performance simulation for remoting perf tests.

remoting/test/protocol_perftest.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/base64.h"
 #include "base/file_util.h"
 #include "base/message_loop/message_loop.h"
+#include "base/rand_util.h"
 #include "base/run_loop.h"
 #include "base/single_thread_task_runner.h"
 #include "base/synchronization/waitable_event.h"
 #include "base/thread_task_runner_handle.h"
 #include "jingle/glue/thread_wrapper.h"
 #include "net/base/test_data_directory.h"
 #include "net/url_request/url_request_context_getter.h"
 #include "remoting/base/rsa_key_pair.h"
 #include "remoting/client/audio_player.h"
 #include "remoting/client/chromoting_client.h"
 #include "remoting/client/client_context.h"
 #include "remoting/client/client_user_interface.h"
 #include "remoting/client/video_renderer.h"
 #include "remoting/host/chromoting_host.h"
 #include "remoting/host/chromoting_host_context.h"
 #include "remoting/host/fake_desktop_environment.h"
 #include "remoting/host/video_scheduler.h"
-#include "remoting/protocol/chromium_port_allocator.h"
 #include "remoting/protocol/jingle_session_manager.h"
 #include "remoting/protocol/libjingle_transport_factory.h"
 #include "remoting/protocol/me2me_host_authenticator_factory.h"
 #include "remoting/protocol/negotiating_client_authenticator.h"
 #include "remoting/protocol/session_config.h"
 #include "remoting/signaling/fake_signal_strategy.h"
+#include "remoting/test/fake_network_dispatcher.h"
+#include "remoting/test/fake_port_allocator.h"
+#include "remoting/test/fake_socket_factory.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace remoting {
 
 using protocol::ChannelConfig;
 
 const char kHostJid[] = "host_jid@example.com/host";
 const char kHostOwner[] = "jane.doe@example.com";
 const char kClientJid[] = "jane.doe@example.com/client";
 
-class ProtocolPerfTest : public testing::Test,
-                         public ClientUserInterface,
-                         public VideoRenderer,
-                         public HostStatusObserver {
+struct NetworkPerformanceParams {
+  NetworkPerformanceParams(int bandwidth,
+                           int max_buffers,
+                           double latency_average_ms,
+                           double latency_stddev_ms,
+                           double out_of_order_rate)
+      : bandwidth(bandwidth),
+        max_buffers(max_buffers),
+        latency_average(base::TimeDelta::FromMillisecondsD(latency_average_ms)),
+        latency_stddev(base::TimeDelta::FromMillisecondsD(latency_stddev_ms)),
+        out_of_order_rate(out_of_order_rate) {}
+
+  int bandwidth;
+  int max_buffers;
+  base::TimeDelta latency_average;
+  base::TimeDelta latency_stddev;
+  double out_of_order_rate;
+};
+
+class ProtocolPerfTest
+    : public testing::Test,
+      public testing::WithParamInterface<NetworkPerformanceParams>,
+      public ClientUserInterface,
+      public VideoRenderer,
+      public HostStatusObserver {
  public:
   ProtocolPerfTest()
       : host_thread_("host"),
         capture_thread_("capture"),
         encode_thread_("encode") {
     VideoScheduler::EnableTimestampsForTests();
     host_thread_.StartWithOptions(
         base::Thread::Options(base::MessageLoop::TYPE_IO, 0));
     capture_thread_.Start();
     encode_thread_.Start();
   }
+
   virtual ~ProtocolPerfTest() {
     host_thread_.message_loop_proxy()->DeleteSoon(FROM_HERE, host_.release());
     host_thread_.message_loop_proxy()->DeleteSoon(FROM_HERE,
                                                   host_signaling_.release());
     message_loop_.RunUntilIdle();
   }
 
   // ClientUserInterface interface.
   virtual void OnConnectionState(protocol::ConnectionToHost::State state,
                                  protocol::ErrorCode error) OVERRIDE {
@@ skipping 88 matching lines @@
         *max_latency = latency;
       }
     }
   }
 
   // Creates test host and client and starts connection between them. Caller
   // should call WaitConnected() to wait until connection is established. The
   // host is started on |host_thread_| while the client works on the main
   // thread.
   void StartHostAndClient(protocol::ChannelConfig::Codec video_codec) {
+    fake_network_dispatcher_ =  new FakeNetworkDispatcher();
+
     client_signaling_.reset(new FakeSignalStrategy(kClientJid));
 
     jingle_glue::JingleThreadWrapper::EnsureForCurrentMessageLoop();
 
     protocol_config_ = protocol::CandidateSessionConfig::CreateDefault();
     protocol_config_->DisableAudioChannel();
     protocol_config_->mutable_video_configs()->clear();
     protocol_config_->mutable_video_configs()->push_back(
         protocol::ChannelConfig(
             protocol::ChannelConfig::TRANSPORT_STREAM, 2, video_codec));
 
     host_thread_.message_loop_proxy()->PostTask(
         FROM_HERE,
         base::Bind(&ProtocolPerfTest::StartHost, base::Unretained(this)));
   }
 
   void StartHost() {
     DCHECK(host_thread_.message_loop_proxy()->BelongsToCurrentThread());
 
     jingle_glue::JingleThreadWrapper::EnsureForCurrentMessageLoop();
 
     host_signaling_.reset(new FakeSignalStrategy(kHostJid));
     host_signaling_->ConnectTo(client_signaling_.get());
 
     protocol::NetworkSettings network_settings(
         protocol::NetworkSettings::NAT_TRAVERSAL_OUTGOING);
 
-    // TODO(sergeyu): Replace with a fake port allocator.
-    scoped_ptr<cricket::HttpPortAllocatorBase> host_port_allocator =
-        protocol::ChromiumPortAllocator::Create(NULL, network_settings)
-            .PassAs<cricket::HttpPortAllocatorBase>();
-
+    scoped_ptr<FakePortAllocator> port_allocator(
+        FakePortAllocator::Create(fake_network_dispatcher_));
+    port_allocator->socket_factory()->SetBandwidth(GetParam().bandwidth,
+                                                   GetParam().max_buffers);
+    port_allocator->socket_factory()->SetLatency(GetParam().latency_average,
+                                                 GetParam().latency_stddev);
+    port_allocator->socket_factory()->set_out_of_order_rate(
+        GetParam().out_of_order_rate);
     scoped_ptr<protocol::TransportFactory> host_transport_factory(
         new protocol::LibjingleTransportFactory(
             host_signaling_.get(),
-            host_port_allocator.Pass(),
+            port_allocator.PassAs<cricket::HttpPortAllocatorBase>(),
             network_settings));
 
     scoped_ptr<protocol::SessionManager> session_manager(
         new protocol::JingleSessionManager(host_transport_factory.Pass()));
 
     // Encoder runs on a separate thread, main thread is used for everything
     // else.
     host_.reset(new ChromotingHost(host_signaling_.get(),
                                    &desktop_environment_factory_,
                                    session_manager.Pass(),
@@ skipping 39 matching lines @@
   void StartClientAfterHost() {
     client_signaling_->ConnectTo(host_signaling_.get());
 
     protocol::NetworkSettings network_settings(
         protocol::NetworkSettings::NAT_TRAVERSAL_OUTGOING);
 
     // Initialize client.
     client_context_.reset(
         new ClientContext(base::ThreadTaskRunnerHandle::Get()));
 
-    // TODO(sergeyu): Replace with a fake port allocator
-    scoped_ptr<cricket::HttpPortAllocatorBase> client_port_allocator =
-        protocol::ChromiumPortAllocator::Create(NULL, network_settings)
-            .PassAs<cricket::HttpPortAllocatorBase>();
-
+    scoped_ptr<FakePortAllocator> port_allocator(
+        FakePortAllocator::Create(fake_network_dispatcher_));
+    port_allocator->socket_factory()->SetBandwidth(GetParam().bandwidth,
+                                                   GetParam().max_buffers);
+    port_allocator->socket_factory()->SetLatency(GetParam().latency_average,
+                                                 GetParam().latency_stddev);
+    port_allocator->socket_factory()->set_out_of_order_rate(
+        GetParam().out_of_order_rate);
     scoped_ptr<protocol::TransportFactory> client_transport_factory(
-        new protocol::LibjingleTransportFactory(client_signaling_.get(),
-                                                client_port_allocator.Pass(),
-                                                network_settings));
+        new protocol::LibjingleTransportFactory(
+            client_signaling_.get(),
+            port_allocator.PassAs<cricket::HttpPortAllocatorBase>(),
+            network_settings));
 
     std::vector<protocol::AuthenticationMethod> auth_methods;
     auth_methods.push_back(protocol::AuthenticationMethod::Spake2(
         protocol::AuthenticationMethod::NONE));
     scoped_ptr<protocol::Authenticator> client_authenticator(
         new protocol::NegotiatingClientAuthenticator(
             std::string(),  // client_pairing_id
             std::string(),  // client_pairing_secret
             std::string(),  // authentication_tag
             base::Bind(&ProtocolPerfTest::FetchPin, base::Unretained(this)),
             scoped_ptr<protocol::ThirdPartyClientAuthenticator::TokenFetcher>(),
             auth_methods));
     client_.reset(new ChromotingClient(
         client_context_.get(), this, this, scoped_ptr<AudioPlayer>()));
     client_->SetProtocolConfigForTests(protocol_config_->Clone());
     client_->Start(
         client_signaling_.get(), client_authenticator.Pass(),
         client_transport_factory.Pass(), kHostJid, std::string());
   }
 
   void FetchPin(
       bool pairing_supported,
       const protocol::SecretFetchedCallback& secret_fetched_callback) {
     secret_fetched_callback.Run("123456");
   }
 
   base::MessageLoopForIO message_loop_;
 
+  scoped_refptr<FakeNetworkDispatcher> fake_network_dispatcher_;
+
   base::Thread host_thread_;
   base::Thread capture_thread_;
   base::Thread encode_thread_;
   FakeDesktopEnvironmentFactory desktop_environment_factory_;
 
   scoped_ptr<protocol::CandidateSessionConfig> protocol_config_;
 
   scoped_ptr<FakeSignalStrategy> host_signaling_;
   scoped_ptr<FakeSignalStrategy> client_signaling_;
 
   scoped_ptr<ChromotingHost> host_;
   scoped_ptr<ClientContext> client_context_;
   scoped_ptr<ChromotingClient> client_;
 
   scoped_ptr<base::RunLoop> connecting_loop_;
   scoped_ptr<base::RunLoop> waiting_frames_loop_;
 
   bool client_connected_;
   bool host_connected_;
 
   base::Closure on_frame_task_;
 
   scoped_ptr<VideoPacket> last_video_packet_;
 
   DISALLOW_COPY_AND_ASSIGN(ProtocolPerfTest);
 };
 
-TEST_F(ProtocolPerfTest, StreamFrameRate) {
+INSTANTIATE_TEST_CASE_P(
+    NoDelay,
+    ProtocolPerfTest,
+    ::testing::Values(NetworkPerformanceParams(0, 0, 0, 0, 0.0)));
+
+INSTANTIATE_TEST_CASE_P(
+    HighLatency,
+    ProtocolPerfTest,
+    ::testing::Values(NetworkPerformanceParams(0, 0, 300, 30, 0.0),
+                      NetworkPerformanceParams(0, 0, 30, 10, 0.0)));
+
+INSTANTIATE_TEST_CASE_P(
+    OutOfOrder,
+    ProtocolPerfTest,
+    ::testing::Values(NetworkPerformanceParams(0, 0, 2, 0, 0.01),
+                      NetworkPerformanceParams(0, 0, 30, 1, 0.01),
+                      NetworkPerformanceParams(0, 0, 30, 1, 0.1),
+                      NetworkPerformanceParams(0, 0, 300, 20, 0.01),
+                      NetworkPerformanceParams(0, 0, 300, 20, 0.1)));
+
+INSTANTIATE_TEST_CASE_P(
+    LimitedBandwidth,
+    ProtocolPerfTest,
+    ::testing::Values(
+        // 100 MBps
+        NetworkPerformanceParams(800000000, 800000000, 2, 1, 0.0),
+        // 8 MBps
+        NetworkPerformanceParams(1000000, 300000, 30, 5, 0.01),
+        NetworkPerformanceParams(1000000, 2000000, 30, 5, 0.01),
+        // 800 kBps
+        NetworkPerformanceParams(100000, 30000, 130, 5, 0.01),
+        NetworkPerformanceParams(100000, 200000, 130, 5, 0.01)));
+
+TEST_P(ProtocolPerfTest, StreamFrameRate) {
   StartHostAndClient(protocol::ChannelConfig::CODEC_VP8);
   ASSERT_NO_FATAL_FAILURE(WaitConnected());
 
   base::TimeDelta latency;
 
   ReceiveFrame(&latency);
   LOG(INFO) << "First frame latency: " << latency.InMillisecondsF() << "ms";
   ReceiveFrames(20, NULL);
 
   base::TimeTicks started = base::TimeTicks::Now();
   ReceiveFrames(40, &latency);
   base::TimeDelta elapsed = base::TimeTicks::Now() - started;
   LOG(INFO) << "Frame rate: " << (40.0 / elapsed.InSecondsF());
   LOG(INFO) << "Maximum latency: " << latency.InMillisecondsF() << "ms";
 }
 
+const int kIntermittentFrameSize = 100 * 1000;
+
 // Frame generator that rewrites the whole screen every 60th frame. Should only
 // be used with the VERBATIM codec as the allocated frame may contain arbitrary
 // data.
 class IntermittentChangeFrameGenerator
     : public base::RefCountedThreadSafe<IntermittentChangeFrameGenerator> {
  public:
   IntermittentChangeFrameGenerator()
       : frame_index_(0) {}
 
   scoped_ptr<webrtc::DesktopFrame> GenerateFrame(
       webrtc::DesktopCapturer::Callback* callback) {
-    const int kWidth = 800;
-    const int kHeight = 600;
+    const int kWidth = 1000;
+    const int kHeight = kIntermittentFrameSize / kWidth / 4;
 
     bool fresh_frame = false;
     if (frame_index_ % 60 == 0 || !current_frame_) {
       current_frame_.reset(webrtc::SharedDesktopFrame::Wrap(
           new webrtc::BasicDesktopFrame(webrtc::DesktopSize(kWidth, kHeight))));
       fresh_frame = true;
     }
     ++frame_index_;
 
     scoped_ptr<webrtc::DesktopFrame> result(current_frame_->Share());
     result->mutable_updated_region()->Clear();
     if (fresh_frame) {
       result->mutable_updated_region()->AddRect(
           webrtc::DesktopRect::MakeXYWH(0, 0, kWidth, kHeight));
     }
     return result.Pass();
   }
 
  private:
   ~IntermittentChangeFrameGenerator() {}
   friend class base::RefCountedThreadSafe<IntermittentChangeFrameGenerator>;
 
   int frame_index_;
   scoped_ptr<webrtc::SharedDesktopFrame> current_frame_;
 
   DISALLOW_COPY_AND_ASSIGN(IntermittentChangeFrameGenerator);
 };
 
-TEST_F(ProtocolPerfTest, IntermittentChanges) {
+TEST_P(ProtocolPerfTest, IntermittentChanges) {
   desktop_environment_factory_.set_frame_generator(
       base::Bind(&IntermittentChangeFrameGenerator::GenerateFrame,
                  new IntermittentChangeFrameGenerator()));
 
   StartHostAndClient(protocol::ChannelConfig::CODEC_VERBATIM);
   ASSERT_NO_FATAL_FAILURE(WaitConnected());
 
   ReceiveFrame(NULL);
 
-  for (int i = 0; i < 5; ++i) {
+  base::TimeDelta expected = GetParam().latency_average;
+  if (GetParam().bandwidth > 0) {
+    expected += base::TimeDelta::FromSecondsD(kIntermittentFrameSize /
+                                              GetParam().bandwidth);
+  }
+  LOG(INFO) << "Expected: " << expected.InMillisecondsF() << "ms";
+
+  base::TimeDelta sum;
+
+  const int kFrames = 5;
+  for (int i = 0; i < kFrames; ++i) {
     base::TimeDelta latency;
     ReceiveFrame(&latency);
     LOG(INFO) << "Latency: " << latency.InMillisecondsF()
               << "ms Encode: " << last_video_packet_->encode_time_ms()
               << "ms Capture: " << last_video_packet_->capture_time_ms()
               << "ms";
+    sum += latency;
   }
+
+  LOG(INFO) << "Average: " << (sum / kFrames).InMillisecondsF();
 }
 
 }  // namespace remoting