RTCStatsCollector and RTCPeerConnectionStats added

webrtc/stats/rtcstatscollector_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 "webrtc/stats/rtcstatscollector.h"
+
+#include <memory>
+#include <string>
+#include <utility>
+#include <vector>
+
+#include "webrtc/api/jsepsessiondescription.h"
+#include "webrtc/api/rtcstats_objects.h"
+#include "webrtc/api/rtcstatsreport.h"
+#include "webrtc/api/test/mock_datachannel.h"
+#include "webrtc/api/test/mock_peerconnection.h"
+#include "webrtc/api/test/mock_webrtcsession.h"
+#include "webrtc/base/checks.h"
+#include "webrtc/base/gunit.h"
+#include "webrtc/base/logging.h"
+#include "webrtc/base/test/faketiming.h"
+#include "webrtc/media/base/fakemediaengine.h"
+
+using testing::Return;
+using testing::ReturnRef;
+
+namespace webrtc {
+
+class RTCStatsCollectorTester : public SetSessionDescriptionObserver {
+ public:
+  RTCStatsCollectorTester()
+      : worker_thread_(rtc::Thread::Current()),
+        network_thread_(rtc::Thread::Current()),
+        media_engine_(new cricket::FakeMediaEngine()),
+        channel_manager_(new cricket::ChannelManager(media_engine_,
+                                                     worker_thread_,
+                                                     network_thread_)),
+        media_controller_(
+            MediaControllerInterface::Create(cricket::MediaConfig(),
+                                             worker_thread_,
+                                             channel_manager_.get())),
+        session_(media_controller_.get()),
+        pc_() {
+    EXPECT_CALL(pc_, session()).WillRepeatedly(Return(&session_));
+    EXPECT_CALL(pc_, sctp_data_channels()).WillRepeatedly(
+        ReturnRef(data_channels_));
+  }
+
+  MockWebRtcSession& session() { return session_; }
+  MockPeerConnection& pc() { return pc_; }
+  std::vector<rtc::scoped_refptr<DataChannel>>& data_channels() {
+    return data_channels_;
+  }
+
+  // SetSessionDescriptionObserver overrides.
+  void OnSuccess() override {}
+  void OnFailure(const std::string& error) override {
+    RTC_NOTREACHED() << error;
+  }
+
+ private:
+  rtc::Thread* const worker_thread_;
+  rtc::Thread* const network_thread_;
+  cricket::FakeMediaEngine* media_engine_;
+  std::unique_ptr<cricket::ChannelManager> channel_manager_;
+  std::unique_ptr<webrtc::MediaControllerInterface> media_controller_;
+  MockWebRtcSession session_;
+  MockPeerConnection pc_;
+
+  std::vector<rtc::scoped_refptr<DataChannel>> data_channels_;
+};
+
+class RTCStatsCollectorTest : public testing::Test {
+ public:
+  RTCStatsCollectorTest()
+    : test_(new rtc::RefCountedObject<RTCStatsCollectorTester>()),
+      timing_(new rtc::FakeTiming()),
+      collector_(&test_->pc(), 50.0, std::unique_ptr<rtc::Timing>(timing_)) {
+  }
+
+ protected:
+  rtc::scoped_refptr<RTCStatsCollectorTester> test_;
+  rtc::FakeTiming* timing_;  // Owned by |collector_|.
+  RTCStatsCollector collector_;
+};
+
+TEST_F(RTCStatsCollectorTest, CachedStatsReport) {
+  // Caching should ensure |a| and |b| are the same report.
+  rtc::scoped_refptr<const RTCStatsReport> a = collector_.GetStatsReport();
+  rtc::scoped_refptr<const RTCStatsReport> b = collector_.GetStatsReport();
+  EXPECT_EQ(a.get(), b.get());

[hta-webrtc, 2016/08/24 13:02:16]

Should you add EXPECT_TRUE(a.get()) too? This set of tests will trivially pass
if GetStatsReport returns null the first 2 times.

[hbos, 2016/08/24 14:28:00]

Done.

+  // Invalidate cache by clearing it.
+  collector_.ClearCachedStatsReport();
+  rtc::scoped_refptr<const RTCStatsReport> c = collector_.GetStatsReport();
+  EXPECT_NE(b.get(), c.get());
+  // Invalidate cache by advancing time.
+  timing_->AdvanceTimeMillisecs(51.0);
+  rtc::scoped_refptr<const RTCStatsReport> d = collector_.GetStatsReport();
+  EXPECT_NE(c.get(), d.get());
+}
+
+TEST_F(RTCStatsCollectorTest, CollectRTCPeerConnectionStats) {
+  rtc::scoped_refptr<const RTCStatsReport> report = collector_.GetStatsReport();
+  EXPECT_EQ(report->GetStatsOfType<RTCPeerConnectionStats>().size(),
+            static_cast<size_t>(1)) << "Expecting 1 RTCPeerConnectionStats.";
+  const RTCStats* stats = (*report)["peerConnectionId"];
+  EXPECT_TRUE(stats);
+  {
+    // Expected stats with no data channels
+    const RTCPeerConnectionStats& pcstats =
+        stats->cast_to<RTCPeerConnectionStats>();
+    EXPECT_EQ(*pcstats.data_channels_opened, static_cast<uint32_t>(0));
+    EXPECT_EQ(*pcstats.data_channels_closed, static_cast<uint32_t>(0));
+  }
+
+  test_->data_channels().push_back(
+      new MockDataChannel(DataChannelInterface::kConnecting));
+  test_->data_channels().push_back(
+      new MockDataChannel(DataChannelInterface::kOpen));
+  test_->data_channels().push_back(
+      new MockDataChannel(DataChannelInterface::kClosing));
+  test_->data_channels().push_back(
+      new MockDataChannel(DataChannelInterface::kClosed));
+
+  collector_.ClearCachedStatsReport();
+  report = collector_.GetStatsReport();
+  EXPECT_EQ(report->GetStatsOfType<RTCPeerConnectionStats>().size(),
+            static_cast<size_t>(1)) << "Expecting 1 RTCPeerConnectionStats.";
+  stats = (*report)["peerConnectionId"];
+  EXPECT_TRUE(stats);
+  {
+    // Expected stats with the above four data channels
+    const RTCPeerConnectionStats& pcstats =
+        stats->cast_to<RTCPeerConnectionStats>();
+    EXPECT_EQ(*pcstats.data_channels_opened, static_cast<uint32_t>(1));

[hta-webrtc, 2016/08/24 13:02:16]

I'd expect "opened" to be larger than "closed", since the difference is supposed
to be the number of currently open datachannels. Later CL, but you may want to
add a TODO.

[hbos, 2016/08/24 14:28:00]

Done.

+    EXPECT_EQ(*pcstats.data_channels_closed, static_cast<uint32_t>(3));
+  }
+}
+
+}  // namespace webrtc