RTCStats and RTCStatsReport added (webrtc/stats)

webrtc/stats/rtcstats_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/api/rtcstats.h"
+#include "webrtc/api/rtcstatsreport.h"
+
+#include "webrtc/base/checks.h"
+#include "webrtc/base/gunit.h"
+#include "webrtc/base/logging.h"
+
+namespace webrtc {
+
+class RTCTestStats : public RTCStats {
+ public:
+  RTCTestStats(const std::string& id, double timestamp)
+      : RTCStats(id, timestamp),
+        m_int32("mInt32"),
+        m_uint32("mUint32"),
+        m_int64("mInt64"),
+        m_uint64("mUint64"),
+        m_double("mDouble"),
+        m_static_string("mStaticString"),
+        m_string("mString"),
+        m_sequence_int32("mSequenceInt32"),
+        m_sequence_uint32("mSequenceUint32"),
+        m_sequence_int64("mSequenceInt64"),
+        m_sequence_uint64("mSequenceUint64"),
+        m_sequence_double("mSequenceDouble"),
+        m_sequence_static_string("mSequenceStaticString"),
+        m_sequence_string("mSequenceString") {
+  }
+
+  WEBRTC_RTCSTATS_IMPL(RTCStats, RTCTestStats,
+      &m_int32,
+      &m_uint32,
+      &m_int64,
+      &m_uint64,
+      &m_double,
+      &m_static_string,
+      &m_string,
+      &m_sequence_int32,
+      &m_sequence_uint32,
+      &m_sequence_int64,
+      &m_sequence_uint64,
+      &m_sequence_double,
+      &m_sequence_static_string,
+      &m_sequence_string);
+
+  RTCStatsMember<int32_t> m_int32;
+  RTCStatsMember<uint32_t> m_uint32;
+  RTCStatsMember<int64_t> m_int64;
+  RTCStatsMember<uint64_t> m_uint64;
+  RTCStatsMember<double> m_double;
+  RTCStatsMember<const char*> m_static_string;
+  RTCStatsMember<std::string> m_string;
+
+  RTCStatsMember<std::vector<int32_t>> m_sequence_int32;
+  RTCStatsMember<std::vector<uint32_t>> m_sequence_uint32;
+  RTCStatsMember<std::vector<int64_t>> m_sequence_int64;
+  RTCStatsMember<std::vector<uint64_t>> m_sequence_uint64;
+  RTCStatsMember<std::vector<double>> m_sequence_double;
+  RTCStatsMember<std::vector<const char*>> m_sequence_static_string;
+  RTCStatsMember<std::vector<std::string>> m_sequence_string;
+};
+
+const char* const RTCTestStats::kType = "test-stats";
+
+class RTCChildStats : public RTCStats {
+ public:
+  RTCChildStats(const std::string& id, double timestamp)
+      : RTCStats(id, timestamp),
+        child_int("childInt") {}
+
+  WEBRTC_RTCSTATS_IMPL(RTCStats, RTCChildStats,
+      &child_int);
+
+  RTCStatsMember<int32_t> child_int;
+};
+
+const char* const RTCChildStats::kType = "child-stats";
+
+class RTCGrandChildStats : public RTCChildStats {
+ public:
+  RTCGrandChildStats(const std::string& id, double timestamp)
+      : RTCChildStats(id, timestamp),
+        grandchild_int("grandchildInt") {}
+
+  WEBRTC_RTCSTATS_IMPL(RTCChildStats, RTCGrandChildStats,
+      &grandchild_int);
+
+  RTCStatsMember<int32_t> grandchild_int;
+};
+
+const char* const RTCGrandChildStats::kType = "grandchild-stats";
+
+class RTCStatsTest : public testing::Test {
+};
+
+TEST_F(RTCStatsTest, RTCStatsAndMembers) {
+  RTCTestStats stats("testId", 42.0);
+  EXPECT_EQ(stats.id(), "testId");
+  EXPECT_EQ(stats.timestamp(), 42.0);
+  std::vector<const RTCStatsMemberInterface*> members = stats.Members();
+  EXPECT_EQ(members.size(), static_cast<size_t>(14));
+  for (const RTCStatsMemberInterface* member : members) {
+    EXPECT_FALSE(member->is_defined());
+  }
+  stats.m_int32 = 123;
+  stats.m_uint32 = 123;
+  stats.m_int64 = 123;
+  stats.m_uint64 = 123;
+  stats.m_double = 123.0;
+  stats.m_static_string = "123";
+  stats.m_string = std::string("123");
+  stats.m_sequence_int32 = std::vector<int32_t>();
+  stats.m_sequence_uint32 = std::vector<uint32_t>();
+  EXPECT_FALSE(stats.m_sequence_int64.is_defined());
+  stats.m_sequence_int64 = std::vector<int64_t>();
+  stats.m_sequence_uint64 = std::vector<uint64_t>();
+  stats.m_sequence_double = std::vector<double>();
+  stats.m_sequence_static_string = std::vector<const char*>();
+  stats.m_sequence_string = std::vector<std::string>();
+  for (const RTCStatsMemberInterface* member : members) {
+    EXPECT_TRUE(member->is_defined());
+  }
+  EXPECT_EQ(*stats.m_int32, static_cast<int32_t>(123));
+  EXPECT_EQ(*stats.m_uint32, static_cast<uint32_t>(123));
+  EXPECT_EQ(*stats.m_int64, static_cast<int64_t>(123));
+  EXPECT_EQ(*stats.m_uint64, static_cast<uint64_t>(123));
+  EXPECT_EQ(*stats.m_double, 123.0);
+  EXPECT_EQ(*stats.m_static_string, "123");
+  EXPECT_EQ(*stats.m_string, std::string("123"));
+  EXPECT_EQ(*stats.m_sequence_int32, std::vector<int32_t>());
+  EXPECT_EQ(*stats.m_sequence_uint32, std::vector<uint32_t>());
+  EXPECT_EQ(*stats.m_sequence_int64, std::vector<int64_t>());
+  EXPECT_EQ(*stats.m_sequence_uint64, std::vector<uint64_t>());
+  EXPECT_EQ(*stats.m_sequence_double, std::vector<double>());
+  EXPECT_EQ(*stats.m_sequence_static_string, std::vector<const char*>());
+  EXPECT_EQ(*stats.m_sequence_string, std::vector<std::string>());
+  int32_t numbers[] = { 4, 8, 15, 16, 23, 42 };
+  std::vector<int32_t> numbers_sequence(&numbers[0], &numbers[5]);
+  stats.m_sequence_int32->insert(stats.m_sequence_int32->end(),
+                                 numbers_sequence.begin(),
+                                 numbers_sequence.end());
+  EXPECT_EQ(*stats.m_sequence_int32, numbers_sequence);
+}
+
+TEST_F(RTCStatsTest, RTCStatsGrandChild) {
+  RTCGrandChildStats stats("grandchild", 0.0);
+  stats.child_int = 1;
+  stats.grandchild_int = 2;
+  int32_t sum = 0;
+  for (const RTCStatsMemberInterface* member : stats.Members()) {
+    sum += *member->cast_to<const RTCStatsMember<int32_t>>();
+  }
+  EXPECT_EQ(sum, static_cast<int32_t>(3));
+
+  std::unique_ptr<RTCStats> copy_ptr = stats.copy();
+  RTCGrandChildStats& copy = copy_ptr->cast_to<RTCGrandChildStats>();
+  EXPECT_EQ(*copy.child_int, *stats.child_int);
+  EXPECT_EQ(*copy.grandchild_int, *stats.grandchild_int);
+}
+
+TEST_F(RTCStatsTest, TestRTCStatsReport) {
+  rtc::scoped_refptr<RTCStatsReport> report = RTCStatsReport::Create();
+  EXPECT_EQ(report->size(), static_cast<size_t>(0));
+  report->AddStats(std::unique_ptr<RTCStats>(new RTCTestStats("a0", 1.0)));
+  report->AddStats(std::unique_ptr<RTCStats>(new RTCTestStats("a1", 2.0)));
+  report->AddStats(std::unique_ptr<RTCStats>(new RTCChildStats("b0", 4.0)));
+  report->AddStats(std::unique_ptr<RTCStats>(new RTCChildStats("b1", 8.0)));
+  report->AddStats(std::unique_ptr<RTCStats>(new RTCTestStats("a2", 16.0)));
+  report->AddStats(std::unique_ptr<RTCStats>(new RTCChildStats("b2", 32.0)));
+  EXPECT_EQ(report->size(), static_cast<size_t>(6));
+
+  EXPECT_EQ((*report)["missing"], nullptr);
+  EXPECT_EQ((*report)["a0"]->id(), "a0");
+  EXPECT_EQ((*report)["b2"]->id(), "b2");
+
+  std::vector<const RTCTestStats*> a = report->GetStatsOfType<RTCTestStats>();
+  EXPECT_EQ(a.size(), static_cast<size_t>(3));
+  uint32_t mask = 0;
+  for (const RTCTestStats* stats : a)
+    mask |= static_cast<uint32_t>(stats->timestamp());
+  EXPECT_EQ(mask, static_cast<uint32_t>(1 | 2 | 16));
+
+  std::vector<const RTCChildStats*> b = report->GetStatsOfType<RTCChildStats>();
+  EXPECT_EQ(b.size(), static_cast<size_t>(3));
+  mask = 0;
+  for (const RTCChildStats* stats : b)
+    mask |= static_cast<uint32_t>(stats->timestamp());
+  EXPECT_EQ(mask, static_cast<uint32_t>(4 | 8 | 32));
+
+  EXPECT_EQ(report->GetStatsOfType<RTCGrandChildStats>().size(),
+            static_cast<size_t>(0));
+}
+
+// Death tests.
+#if RTC_DCHECK_IS_ON && GTEST_HAS_DEATH_TEST && !defined(WEBRTC_ANDROID)

[hta - Chromium, 2016/08/23 14:25:13]

Can you add a comment (perhaps with a bug ID) on why these restrictions exist,
so that we can remove the #if if the reasons to have it go away?

[hbos, 2016/08/23 16:21:18]

There are many #ifs such as this in the webrtc repo, but none of them have a
comment saying why or with a bug number. The only explanation I found was a
comment in base/test/gtest_util.h saying "Death tests misbehave on Android." I
referene this file in a comment.

+
+TEST_F(RTCStatsTest, ValueOfUndefinedMemberShouldCrash) {

[hta - Chromium, 2016/08/23 14:25:13]

I think it's recommended to keep death tests in its own test class. (Not sure -
I may be remembering things from long ago.) I don't think you use the fixture at
all here, so these could be TEST macros rather than TEST_F macros.

[hbos, 2016/08/23 16:21:18]

Done.

+  RTCTestStats stats("testId", 0.0);
+  EXPECT_FALSE(stats.m_int32.is_defined());
+  EXPECT_DEATH(*stats.m_int32, "");
+}
+
+TEST_F(RTCStatsTest, InvalidCastingShouldCrash) {
+  RTCGrandChildStats stats("grandchild", 0.0);
+  EXPECT_DEATH(stats.cast_to<RTCChildStats>(), "");
+}
+
+#endif  // RTC_DCHECK_IS_ON && GTEST_HAS_DEATH_TEST && !defined(WEBRTC_ANDROID)
+
+}  // namespace webrtc