Relanding: Implement RTCConfiguration.iceCandidatePoolSize.

webrtc/p2p/base/portallocator_unittest.cc

+/*
+ *  Copyright 2016 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.
+ */
+
+#include <memory>
+
+#include "webrtc/base/gunit.h"
+#include "webrtc/base/thread.h"
+#include "webrtc/p2p/base/fakeportallocator.h"
+#include "webrtc/p2p/base/portallocator.h"
+
+static const char kContentName[] = "test content";
+// Based on ICE_UFRAG_LENGTH
+static const char kIceUfrag[] = "TESTICEUFRAG0000";
+// Based on ICE_PWD_LENGTH
+static const char kIcePwd[] = "TESTICEPWD00000000000000";
+static const char kTurnUsername[] = "test";
+static const char kTurnPassword[] = "test";
+
+class PortAllocatorTest : public testing::Test, public sigslot::has_slots<> {
+ public:
+  PortAllocatorTest() {
+    allocator_.reset(
+        new cricket::FakePortAllocator(rtc::Thread::Current(), nullptr));
+  }
+
+ protected:
+  void SetConfigurationWithPoolSize(int candidate_pool_size) {
+    allocator_->SetConfiguration(cricket::ServerAddresses(),
+                                 std::vector<cricket::RelayServerConfig>(),
+                                 candidate_pool_size);
+  }
+
+  const cricket::FakePortAllocatorSession* PeekPooledSession() const {
+    return static_cast<const cricket::FakePortAllocatorSession*>(
+        allocator_->PeekPooledSession());
+  }
+
+  std::unique_ptr<cricket::FakePortAllocatorSession> GetPooledSession() {
+    return std::unique_ptr<cricket::FakePortAllocatorSession>(
+        static_cast<cricket::FakePortAllocatorSession*>(
+            allocator_->GetPooledSession(kContentName, 0, kIceUfrag, kIcePwd)));
+  }
+
+  // Should only be called at the end of a test as it clears the sessions.
+  bool HasExactlyNPooledSessions(int num_sessions) {

[pthatcher1, 2016/05/05 21:51:25]

Why not call this TakeAllPooledSessions() and have it return the number, and
then use EXPECT_EQ(n, TakeAllPooledSessions())

[Taylor Brandstetter, 2016/05/06 03:53:35]

Good idea, done.

+    while (num_sessions > 0) {
+      auto session = GetPooledSession();
+      if (!session.get()) {
+        return false;
+      }
+      --num_sessions;
+    }
+    if (PeekPooledSession()) {
+      return false;
+    }
+    return true;
+  }
+
+  std::unique_ptr<cricket::FakePortAllocator> allocator_;
+  rtc::SocketAddress stun_server_1{"11.11.11.11", 3478};
+  rtc::SocketAddress stun_server_2{"22.22.22.22", 3478};
+  cricket::RelayServerConfig turn_server_1{"11.11.11.11",      3478,
+                                           kTurnUsername,      kTurnPassword,
+                                           cricket::PROTO_UDP, false};
+  cricket::RelayServerConfig turn_server_2{"22.22.22.22",      3478,
+                                           kTurnUsername,      kTurnPassword,
+                                           cricket::PROTO_UDP, false};
+};
+
+TEST_F(PortAllocatorTest, TestDefaults) {
+  EXPECT_EQ(0UL, allocator_->stun_servers().size());
+  EXPECT_EQ(0UL, allocator_->turn_servers().size());
+  EXPECT_EQ(0, allocator_->candidate_pool_size());
+  EXPECT_TRUE(HasExactlyNPooledSessions(0));
+}
+
+TEST_F(PortAllocatorTest, SetConfigurationUpdatesIceServers) {
+  cricket::ServerAddresses stun_servers_1 = {stun_server_1};
+  std::vector<cricket::RelayServerConfig> turn_servers_1 = {turn_server_1};
+  allocator_->SetConfiguration(stun_servers_1, turn_servers_1, 0);
+  EXPECT_EQ(stun_servers_1, allocator_->stun_servers());
+  EXPECT_EQ(turn_servers_1, allocator_->turn_servers());
+
+  // Update with a different set of servers.
+  cricket::ServerAddresses stun_servers_2 = {stun_server_2};
+  std::vector<cricket::RelayServerConfig> turn_servers_2 = {turn_server_2};
+  allocator_->SetConfiguration(stun_servers_2, turn_servers_2, 0);
+  EXPECT_EQ(stun_servers_2, allocator_->stun_servers());
+  EXPECT_EQ(turn_servers_2, allocator_->turn_servers());
+}
+
+TEST_F(PortAllocatorTest, SetConfigurationUpdatesCandidatePoolSize) {
+  SetConfigurationWithPoolSize(2);
+  EXPECT_EQ(2, allocator_->candidate_pool_size());
+  SetConfigurationWithPoolSize(3);
+  EXPECT_EQ(3, allocator_->candidate_pool_size());
+  SetConfigurationWithPoolSize(1);
+  EXPECT_EQ(1, allocator_->candidate_pool_size());
+  SetConfigurationWithPoolSize(4);
+  EXPECT_EQ(4, allocator_->candidate_pool_size());
+}
+
+// A negative pool size should just be treated as zero.
+TEST_F(PortAllocatorTest, SetConfigurationWithNegativePoolSizeDoesntCrash) {
+  SetConfigurationWithPoolSize(-1);

[pthatcher1, 2016/05/05 21:51:25]

Are you going to verify something here?

[Taylor Brandstetter, 2016/05/06 03:53:35]

Just that it "DoesntCrash" (see test name).

[pthatcher1, 2016/05/07 00:21:44]

Ah.  I missed that.  Perhaps just a comment like so:

// ASSERT(doesn't crash) :)

Might be nice.

[Taylor Brandstetter, 2016/05/09 22:07:10]

Done.

+}
+
+// Test that if the candidate pool size is nonzero, pooled sessions are
+// created, and StartGettingPorts is called on them.
+TEST_F(PortAllocatorTest, SetConfigurationCreatesPooledSessions) {
+  SetConfigurationWithPoolSize(2);
+  auto session_1 = GetPooledSession();
+  auto session_2 = GetPooledSession();
+  ASSERT_NE(nullptr, session_1.get());
+  ASSERT_NE(nullptr, session_2.get());
+  EXPECT_EQ(1, session_1->port_config_count());
+  EXPECT_EQ(1, session_2->port_config_count());
+  EXPECT_TRUE(HasExactlyNPooledSessions(0));
+}
+
+// Test that if the candidate pool size is increased, pooled sessions are
+// created as necessary.
+TEST_F(PortAllocatorTest, SetConfigurationCreatesMorePooledSessions) {
+  SetConfigurationWithPoolSize(1);
+  SetConfigurationWithPoolSize(2);
+  EXPECT_TRUE(HasExactlyNPooledSessions(2));
+}
+
+// Test that if the candidate pool size is reduced, extra sessions are
+// destroyed.
+TEST_F(PortAllocatorTest, SetConfigurationDestroysPooledSessions) {
+  SetConfigurationWithPoolSize(2);
+  SetConfigurationWithPoolSize(1);
+  EXPECT_TRUE(HasExactlyNPooledSessions(1));
+}
+
+// Test that if the candidate pool size is reduced and increased, but reducing
+// didn't actually destroy any sessions (because they were already given away),
+// increasing the size to its initial value doesn't create a new session.
+TEST_F(PortAllocatorTest, SetConfigurationDoesntCreateExtraSessions) {
+  SetConfigurationWithPoolSize(1);
+  GetPooledSession();
+  SetConfigurationWithPoolSize(0);
+  SetConfigurationWithPoolSize(1);
+  EXPECT_TRUE(HasExactlyNPooledSessions(0));
+}
+
+// According to JSEP, exising pooled sessions should be destroyed and new
+// ones created when the ICE servers change.
+TEST_F(PortAllocatorTest,
+       SetConfigurationRecreatesPooledSessionsWhenIceServersChange) {
+  cricket::ServerAddresses stun_servers_1 = {stun_server_1};
+  std::vector<cricket::RelayServerConfig> turn_servers_1 = {turn_server_1};
+  allocator_->SetConfiguration(stun_servers_1, turn_servers_1, 1);
+  EXPECT_EQ(stun_servers_1, allocator_->stun_servers());
+  EXPECT_EQ(turn_servers_1, allocator_->turn_servers());
+
+  // Update with a different set of servers (and also change pool size).
+  cricket::ServerAddresses stun_servers_2 = {stun_server_2};
+  std::vector<cricket::RelayServerConfig> turn_servers_2 = {turn_server_2};
+  allocator_->SetConfiguration(stun_servers_2, turn_servers_2, 2);
+  EXPECT_EQ(stun_servers_2, allocator_->stun_servers());
+  EXPECT_EQ(turn_servers_2, allocator_->turn_servers());
+  auto session_1 = GetPooledSession();
+  auto session_2 = GetPooledSession();
+  ASSERT_NE(nullptr, session_1.get());
+  ASSERT_NE(nullptr, session_2.get());
+  EXPECT_EQ(stun_servers_2, session_1->stun_servers());
+  EXPECT_EQ(turn_servers_2, session_1->turn_servers());
+  EXPECT_EQ(stun_servers_2, session_2->stun_servers());
+  EXPECT_EQ(turn_servers_2, session_2->turn_servers());
+  EXPECT_TRUE(HasExactlyNPooledSessions(0));
+}
+
+TEST_F(PortAllocatorTest, PeekPooledSessionReturnsNextSession) {
+  SetConfigurationWithPoolSize(2);
+  auto peeked_session_1 = PeekPooledSession();
+  auto session_1 = GetPooledSession();
+  EXPECT_EQ(session_1.get(), peeked_session_1);
+  auto peeked_session_2 = PeekPooledSession();
+  auto session_2 = GetPooledSession();
+  EXPECT_EQ(session_2.get(), peeked_session_2);
+}
+
+// Verify that subclasses of PortAllocatorSession are given a chance to update
+// transport info when GetPooledSession is called, and the base class updates
+// the info itself.
+TEST_F(PortAllocatorTest, GetPooledSessionUpdatesTransportInfo) {
+  SetConfigurationWithPoolSize(1);
+  auto peeked_session = PeekPooledSession();
+  ASSERT_NE(nullptr, peeked_session);
+  EXPECT_EQ(0, peeked_session->transport_info_updates());
+  std::unique_ptr<cricket::FakePortAllocatorSession> session(
+      static_cast<cricket::FakePortAllocatorSession*>(
+          allocator_->GetPooledSession(kContentName, 1, kIceUfrag, kIcePwd)));
+  EXPECT_EQ(1, session->transport_info_updates());
+  EXPECT_EQ(kContentName, session->content_name());
+  EXPECT_EQ(1, session->component());
+  EXPECT_EQ(kIceUfrag, session->ice_ufrag());
+  EXPECT_EQ(kIcePwd, session->ice_pwd());
+}