blob: 10b17e59864fde79dacbeb55dead961af3fd1f0b [file] [log] [blame]
hbosdb346a72016-11-29 01:57:01 -08001/*
2 * Copyright 2016 The WebRTC project authors. All Rights Reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Yves Gerey3e707812018-11-28 16:47:49 +010011#include <stdint.h>
12#include <string.h>
Henrik Boströmb6199362018-03-12 10:27:55 +010013#include <algorithm>
Yves Gerey3e707812018-11-28 16:47:49 +010014#include <memory>
hbosdb346a72016-11-29 01:57:01 -080015#include <set>
Yves Gerey3e707812018-11-28 16:47:49 +010016#include <string>
hbosdb346a72016-11-29 01:57:01 -080017#include <vector>
18
Steve Anton64b626b2019-01-28 17:25:26 -080019#include "absl/algorithm/container.h"
Steve Anton68586e82018-12-13 17:41:25 -080020#include "absl/strings/match.h"
Yves Gerey3e707812018-11-28 16:47:49 +010021#include "api/audio_codecs/audio_decoder_factory.h"
22#include "api/audio_codecs/audio_encoder_factory.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020023#include "api/audio_codecs/builtin_audio_decoder_factory.h"
24#include "api/audio_codecs/builtin_audio_encoder_factory.h"
Yves Gerey3e707812018-11-28 16:47:49 +010025#include "api/audio_options.h"
Steve Anton10542f22019-01-11 09:11:00 -080026#include "api/data_channel_interface.h"
27#include "api/peer_connection_interface.h"
28#include "api/rtp_receiver_interface.h"
29#include "api/rtp_sender_interface.h"
Mirko Bonadeid9708072019-01-25 20:26:48 +010030#include "api/scoped_refptr.h"
Steve Anton10542f22019-01-11 09:11:00 -080031#include "api/stats/rtc_stats.h"
32#include "api/stats/rtc_stats_report.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020033#include "api/stats/rtcstats_objects.h"
Steve Anton10542f22019-01-11 09:11:00 -080034#include "pc/rtc_stats_traversal.h"
35#include "pc/test/peer_connection_test_wrapper.h"
36#include "pc/test/rtc_stats_obtainer.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020037#include "rtc_base/checks.h"
38#include "rtc_base/event_tracer.h"
39#include "rtc_base/gunit.h"
Steve Anton10542f22019-01-11 09:11:00 -080040#include "rtc_base/ref_counted_object.h"
Yves Gerey3e707812018-11-28 16:47:49 +010041#include "rtc_base/thread.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020042#include "rtc_base/trace_event.h"
Steve Anton10542f22019-01-11 09:11:00 -080043#include "rtc_base/virtual_socket_server.h"
Steve Anton64b626b2019-01-28 17:25:26 -080044#include "test/gmock.h"
Yves Gerey3e707812018-11-28 16:47:49 +010045#include "test/gtest.h"
hbosdb346a72016-11-29 01:57:01 -080046
Steve Anton64b626b2019-01-28 17:25:26 -080047using ::testing::Contains;
48
hbosdb346a72016-11-29 01:57:01 -080049namespace webrtc {
50
51namespace {
52
53const int64_t kGetStatsTimeoutMs = 10000;
54
ehmaldonado80c829f2017-07-18 07:35:19 -070055const unsigned char* GetCategoryEnabledHandler(const char* name) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -070056 if (strcmp("webrtc_stats", name) != 0) {
57 return reinterpret_cast<const unsigned char*>("");
58 }
59 return reinterpret_cast<const unsigned char*>(name);
ehmaldonado80c829f2017-07-18 07:35:19 -070060}
61
ehmaldonado8ab0fd82017-09-04 14:35:04 -070062class RTCStatsReportTraceListener {
63 public:
64 static void SetUp() {
65 if (!traced_report_)
66 traced_report_ = new RTCStatsReportTraceListener();
67 traced_report_->last_trace_ = "";
68 SetupEventTracer(&GetCategoryEnabledHandler,
69 &RTCStatsReportTraceListener::AddTraceEventHandler);
70 }
71
72 static const std::string& last_trace() {
73 RTC_DCHECK(traced_report_);
74 return traced_report_->last_trace_;
75 }
76
77 private:
Steve Anton36b29d12017-10-30 09:57:42 -070078 static void AddTraceEventHandler(
79 char phase,
80 const unsigned char* category_enabled,
81 const char* name,
82 unsigned long long id, // NOLINT(runtime/int)
83 int num_args,
84 const char** arg_names,
85 const unsigned char* arg_types,
86 const unsigned long long* arg_values, // NOLINT(runtime/int)
87 unsigned char flags) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -070088 RTC_DCHECK(traced_report_);
89 EXPECT_STREQ("webrtc_stats",
90 reinterpret_cast<const char*>(category_enabled));
91 EXPECT_STREQ("webrtc_stats", name);
92 EXPECT_EQ(1, num_args);
93 EXPECT_STREQ("report", arg_names[0]);
94 EXPECT_EQ(TRACE_VALUE_TYPE_COPY_STRING, arg_types[0]);
95
96 traced_report_->last_trace_ = reinterpret_cast<const char*>(arg_values[0]);
97 }
98
99 static RTCStatsReportTraceListener* traced_report_;
100 std::string last_trace_;
101};
102
103RTCStatsReportTraceListener* RTCStatsReportTraceListener::traced_report_ =
104 nullptr;
ehmaldonado80c829f2017-07-18 07:35:19 -0700105
Mirko Bonadei6a489f22019-04-09 15:11:12 +0200106class RTCStatsIntegrationTest : public ::testing::Test {
hbosdb346a72016-11-29 01:57:01 -0800107 public:
108 RTCStatsIntegrationTest()
tommie7251592017-07-14 14:44:46 -0700109 : network_thread_(new rtc::Thread(&virtual_socket_server_)),
110 worker_thread_(rtc::Thread::Create()) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -0700111 RTCStatsReportTraceListener::SetUp();
ehmaldonado80c829f2017-07-18 07:35:19 -0700112
tommie7251592017-07-14 14:44:46 -0700113 RTC_CHECK(network_thread_->Start());
114 RTC_CHECK(worker_thread_->Start());
hbosdb346a72016-11-29 01:57:01 -0800115
116 caller_ = new rtc::RefCountedObject<PeerConnectionTestWrapper>(
tommie7251592017-07-14 14:44:46 -0700117 "caller", network_thread_.get(), worker_thread_.get());
hbosdb346a72016-11-29 01:57:01 -0800118 callee_ = new rtc::RefCountedObject<PeerConnectionTestWrapper>(
tommie7251592017-07-14 14:44:46 -0700119 "callee", network_thread_.get(), worker_thread_.get());
hbosdb346a72016-11-29 01:57:01 -0800120 }
121
122 void StartCall() {
123 // Create PeerConnections and "connect" sigslots
124 PeerConnectionInterface::RTCConfiguration config;
125 PeerConnectionInterface::IceServer ice_server;
126 ice_server.uri = "stun:1.1.1.1:3478";
127 config.servers.push_back(ice_server);
Niels Möllerf06f9232018-08-07 12:32:18 +0200128 EXPECT_TRUE(caller_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
kwiberg9e5b11e2017-04-19 03:47:57 -0700129 CreateBuiltinAudioDecoderFactory()));
Niels Möllerf06f9232018-08-07 12:32:18 +0200130 EXPECT_TRUE(callee_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
kwiberg9e5b11e2017-04-19 03:47:57 -0700131 CreateBuiltinAudioDecoderFactory()));
hbosdb346a72016-11-29 01:57:01 -0800132 PeerConnectionTestWrapper::Connect(caller_.get(), callee_.get());
133
134 // Get user media for audio and video
Niels Möller5c4ddad2019-02-12 12:30:58 +0100135 caller_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
136 callee_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
hbosdb346a72016-11-29 01:57:01 -0800137
138 // Create data channels
139 DataChannelInit init;
140 caller_->CreateDataChannel("data", init);
141 callee_->CreateDataChannel("data", init);
142
143 // Negotiate and wait for call to establish
Niels Möllerf06f9232018-08-07 12:32:18 +0200144 caller_->CreateOffer(PeerConnectionInterface::RTCOfferAnswerOptions());
hbosdb346a72016-11-29 01:57:01 -0800145 caller_->WaitForCallEstablished();
146 callee_->WaitForCallEstablished();
147 }
148
149 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller() {
150 return GetStats(caller_->pc());
151 }
Henrik Boström1df1bf82018-03-20 13:24:20 +0100152 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
153 rtc::scoped_refptr<RtpSenderInterface> selector) {
154 return GetStats(caller_->pc(), selector);
155 }
156 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
157 rtc::scoped_refptr<RtpReceiverInterface> selector) {
158 return GetStats(caller_->pc(), selector);
159 }
hbosdb346a72016-11-29 01:57:01 -0800160
161 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee() {
162 return GetStats(callee_->pc());
163 }
Henrik Boström1df1bf82018-03-20 13:24:20 +0100164 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
165 rtc::scoped_refptr<RtpSenderInterface> selector) {
166 return GetStats(callee_->pc(), selector);
167 }
168 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
169 rtc::scoped_refptr<RtpReceiverInterface> selector) {
170 return GetStats(callee_->pc(), selector);
171 }
hbosdb346a72016-11-29 01:57:01 -0800172
173 protected:
174 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
175 PeerConnectionInterface* pc) {
176 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
177 RTCStatsObtainer::Create();
178 pc->GetStats(stats_obtainer);
179 EXPECT_TRUE_WAIT(stats_obtainer->report(), kGetStatsTimeoutMs);
180 return stats_obtainer->report();
181 }
182
Henrik Boström1df1bf82018-03-20 13:24:20 +0100183 template <typename T>
184 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
185 PeerConnectionInterface* pc,
186 rtc::scoped_refptr<T> selector) {
187 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
188 RTCStatsObtainer::Create();
189 pc->GetStats(selector, stats_obtainer);
190 EXPECT_TRUE_WAIT(stats_obtainer->report(), kGetStatsTimeoutMs);
191 return stats_obtainer->report();
192 }
193
deadbeef98e186c2017-05-16 18:00:06 -0700194 // |network_thread_| uses |virtual_socket_server_| so they must be
195 // constructed/destructed in the correct order.
hbosdb346a72016-11-29 01:57:01 -0800196 rtc::VirtualSocketServer virtual_socket_server_;
tommie7251592017-07-14 14:44:46 -0700197 std::unique_ptr<rtc::Thread> network_thread_;
198 std::unique_ptr<rtc::Thread> worker_thread_;
hbosdb346a72016-11-29 01:57:01 -0800199 rtc::scoped_refptr<PeerConnectionTestWrapper> caller_;
200 rtc::scoped_refptr<PeerConnectionTestWrapper> callee_;
201};
202
203class RTCStatsVerifier {
204 public:
205 RTCStatsVerifier(const RTCStatsReport* report, const RTCStats* stats)
206 : report_(report), stats_(stats), all_tests_successful_(true) {
207 RTC_CHECK(report_);
208 RTC_CHECK(stats_);
209 for (const RTCStatsMemberInterface* member : stats_->Members()) {
210 untested_members_.insert(member);
211 }
212 }
213
Yves Gerey665174f2018-06-19 15:03:05 +0200214 void MarkMemberTested(const RTCStatsMemberInterface& member,
215 bool test_successful) {
hbosdb346a72016-11-29 01:57:01 -0800216 untested_members_.erase(&member);
217 all_tests_successful_ &= test_successful;
218 }
219
220 void TestMemberIsDefined(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200221 EXPECT_TRUE(member.is_defined())
222 << stats_->type() << "." << member.name() << "[" << stats_->id()
223 << "] was undefined.";
hbosdb346a72016-11-29 01:57:01 -0800224 MarkMemberTested(member, member.is_defined());
225 }
226
227 void TestMemberIsUndefined(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200228 EXPECT_FALSE(member.is_defined())
229 << stats_->type() << "." << member.name() << "[" << stats_->id()
230 << "] was defined (" << member.ValueToString() << ").";
hbosdb346a72016-11-29 01:57:01 -0800231 MarkMemberTested(member, !member.is_defined());
232 }
233
Yves Gerey665174f2018-06-19 15:03:05 +0200234 template <typename T>
hbos23351192017-01-02 06:52:19 -0800235 void TestMemberIsPositive(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200236 EXPECT_TRUE(member.is_defined())
237 << stats_->type() << "." << member.name() << "[" << stats_->id()
238 << "] was undefined.";
hbos23351192017-01-02 06:52:19 -0800239 if (!member.is_defined()) {
240 MarkMemberTested(member, false);
241 return;
242 }
243 bool is_positive = *member.cast_to<RTCStatsMember<T>>() > T(0);
Yves Gerey665174f2018-06-19 15:03:05 +0200244 EXPECT_TRUE(is_positive)
245 << stats_->type() << "." << member.name() << "[" << stats_->id()
246 << "] was not positive (" << member.ValueToString() << ").";
hbos23351192017-01-02 06:52:19 -0800247 MarkMemberTested(member, is_positive);
248 }
249
Yves Gerey665174f2018-06-19 15:03:05 +0200250 template <typename T>
hbos23351192017-01-02 06:52:19 -0800251 void TestMemberIsNonNegative(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200252 EXPECT_TRUE(member.is_defined())
253 << stats_->type() << "." << member.name() << "[" << stats_->id()
254 << "] was undefined.";
hbos23351192017-01-02 06:52:19 -0800255 if (!member.is_defined()) {
256 MarkMemberTested(member, false);
257 return;
258 }
259 bool is_non_negative = *member.cast_to<RTCStatsMember<T>>() >= T(0);
Yves Gerey665174f2018-06-19 15:03:05 +0200260 EXPECT_TRUE(is_non_negative)
261 << stats_->type() << "." << member.name() << "[" << stats_->id()
262 << "] was not non-negative (" << member.ValueToString() << ").";
hbos23351192017-01-02 06:52:19 -0800263 MarkMemberTested(member, is_non_negative);
264 }
265
Yves Gerey665174f2018-06-19 15:03:05 +0200266 void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
267 const char* expected_type) {
hbosdb346a72016-11-29 01:57:01 -0800268 TestMemberIsIDReference(member, expected_type, false);
269 }
270
Yves Gerey665174f2018-06-19 15:03:05 +0200271 void TestMemberIsOptionalIDReference(const RTCStatsMemberInterface& member,
272 const char* expected_type) {
hbosdb346a72016-11-29 01:57:01 -0800273 TestMemberIsIDReference(member, expected_type, true);
274 }
275
276 bool ExpectAllMembersSuccessfullyTested() {
277 if (untested_members_.empty())
278 return all_tests_successful_;
279 for (const RTCStatsMemberInterface* member : untested_members_) {
Yves Gerey665174f2018-06-19 15:03:05 +0200280 EXPECT_TRUE(false) << stats_->type() << "." << member->name() << "["
281 << stats_->id() << "] was not tested.";
hbosdb346a72016-11-29 01:57:01 -0800282 }
283 return false;
284 }
285
286 private:
Yves Gerey665174f2018-06-19 15:03:05 +0200287 void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
288 const char* expected_type,
289 bool optional) {
hbosdb346a72016-11-29 01:57:01 -0800290 if (optional && !member.is_defined()) {
291 MarkMemberTested(member, true);
292 return;
293 }
294 bool valid_reference = false;
295 if (member.is_defined()) {
296 if (member.type() == RTCStatsMemberInterface::kString) {
297 // A single ID.
298 const RTCStatsMember<std::string>& id =
299 member.cast_to<RTCStatsMember<std::string>>();
300 const RTCStats* referenced_stats = report_->Get(*id);
301 valid_reference =
302 referenced_stats && referenced_stats->type() == expected_type;
303 } else if (member.type() == RTCStatsMemberInterface::kSequenceString) {
304 // A vector of IDs.
305 valid_reference = true;
306 const RTCStatsMember<std::vector<std::string>>& ids =
307 member.cast_to<RTCStatsMember<std::vector<std::string>>>();
Mirko Bonadeic61ce0d2017-11-21 17:04:20 +0100308 for (const std::string& id : *ids) {
hbosdb346a72016-11-29 01:57:01 -0800309 const RTCStats* referenced_stats = report_->Get(id);
310 if (!referenced_stats || referenced_stats->type() != expected_type) {
311 valid_reference = false;
312 break;
313 }
314 }
315 }
316 }
Yves Gerey665174f2018-06-19 15:03:05 +0200317 EXPECT_TRUE(valid_reference)
318 << stats_->type() << "." << member.name()
319 << " is not a reference to an "
Henrik Boström646fda02019-05-22 15:49:42 +0200320 << "existing dictionary of type " << expected_type << " (value: "
321 << (member.is_defined() ? member.ValueToString() : "null") << ").";
hbosdb346a72016-11-29 01:57:01 -0800322 MarkMemberTested(member, valid_reference);
323 }
324
325 rtc::scoped_refptr<const RTCStatsReport> report_;
326 const RTCStats* stats_;
327 std::set<const RTCStatsMemberInterface*> untested_members_;
328 bool all_tests_successful_;
329};
330
331class RTCStatsReportVerifier {
332 public:
333 static std::set<const char*> StatsTypes() {
334 std::set<const char*> stats_types;
335 stats_types.insert(RTCCertificateStats::kType);
336 stats_types.insert(RTCCodecStats::kType);
337 stats_types.insert(RTCDataChannelStats::kType);
338 stats_types.insert(RTCIceCandidatePairStats::kType);
339 stats_types.insert(RTCLocalIceCandidateStats::kType);
340 stats_types.insert(RTCRemoteIceCandidateStats::kType);
341 stats_types.insert(RTCMediaStreamStats::kType);
342 stats_types.insert(RTCMediaStreamTrackStats::kType);
343 stats_types.insert(RTCPeerConnectionStats::kType);
344 stats_types.insert(RTCInboundRTPStreamStats::kType);
345 stats_types.insert(RTCOutboundRTPStreamStats::kType);
346 stats_types.insert(RTCTransportStats::kType);
347 return stats_types;
348 }
349
350 explicit RTCStatsReportVerifier(const RTCStatsReport* report)
Yves Gerey665174f2018-06-19 15:03:05 +0200351 : report_(report) {}
hbosdb346a72016-11-29 01:57:01 -0800352
Henrik Boström1df1bf82018-03-20 13:24:20 +0100353 void VerifyReport(std::vector<const char*> allowed_missing_stats) {
hbosdb346a72016-11-29 01:57:01 -0800354 std::set<const char*> missing_stats = StatsTypes();
355 bool verify_successful = true;
hbos338f78a2017-02-07 06:41:21 -0800356 std::vector<const RTCTransportStats*> transport_stats =
357 report_->GetStatsOfType<RTCTransportStats>();
Mirko Bonadeie12c1fe2018-07-03 12:53:23 +0200358 EXPECT_EQ(transport_stats.size(), 1U);
hbos338f78a2017-02-07 06:41:21 -0800359 std::string selected_candidate_pair_id =
360 *transport_stats[0]->selected_candidate_pair_id;
hbosdb346a72016-11-29 01:57:01 -0800361 for (const RTCStats& stats : *report_) {
362 missing_stats.erase(stats.type());
363 if (stats.type() == RTCCertificateStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200364 verify_successful &=
365 VerifyRTCCertificateStats(stats.cast_to<RTCCertificateStats>());
hbosdb346a72016-11-29 01:57:01 -0800366 } else if (stats.type() == RTCCodecStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200367 verify_successful &=
368 VerifyRTCCodecStats(stats.cast_to<RTCCodecStats>());
hbosdb346a72016-11-29 01:57:01 -0800369 } else if (stats.type() == RTCDataChannelStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200370 verify_successful &=
371 VerifyRTCDataChannelStats(stats.cast_to<RTCDataChannelStats>());
hbosdb346a72016-11-29 01:57:01 -0800372 } else if (stats.type() == RTCIceCandidatePairStats::kType) {
373 verify_successful &= VerifyRTCIceCandidatePairStats(
hbos338f78a2017-02-07 06:41:21 -0800374 stats.cast_to<RTCIceCandidatePairStats>(),
375 stats.id() == selected_candidate_pair_id);
hbosdb346a72016-11-29 01:57:01 -0800376 } else if (stats.type() == RTCLocalIceCandidateStats::kType) {
377 verify_successful &= VerifyRTCLocalIceCandidateStats(
378 stats.cast_to<RTCLocalIceCandidateStats>());
379 } else if (stats.type() == RTCRemoteIceCandidateStats::kType) {
380 verify_successful &= VerifyRTCRemoteIceCandidateStats(
381 stats.cast_to<RTCRemoteIceCandidateStats>());
382 } else if (stats.type() == RTCMediaStreamStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200383 verify_successful &=
384 VerifyRTCMediaStreamStats(stats.cast_to<RTCMediaStreamStats>());
hbosdb346a72016-11-29 01:57:01 -0800385 } else if (stats.type() == RTCMediaStreamTrackStats::kType) {
386 verify_successful &= VerifyRTCMediaStreamTrackStats(
387 stats.cast_to<RTCMediaStreamTrackStats>());
388 } else if (stats.type() == RTCPeerConnectionStats::kType) {
389 verify_successful &= VerifyRTCPeerConnectionStats(
390 stats.cast_to<RTCPeerConnectionStats>());
391 } else if (stats.type() == RTCInboundRTPStreamStats::kType) {
392 verify_successful &= VerifyRTCInboundRTPStreamStats(
393 stats.cast_to<RTCInboundRTPStreamStats>());
394 } else if (stats.type() == RTCOutboundRTPStreamStats::kType) {
395 verify_successful &= VerifyRTCOutboundRTPStreamStats(
396 stats.cast_to<RTCOutboundRTPStreamStats>());
Henrik Boström646fda02019-05-22 15:49:42 +0200397 } else if (stats.type() == RTCAudioSourceStats::kType) {
398 // RTCAudioSourceStats::kType and RTCVideoSourceStats::kType both have
399 // the value "media-source", but they are distinguishable with pointer
400 // equality (==). In JavaScript they would be distinguished with |kind|.
401 verify_successful &=
402 VerifyRTCAudioSourceStats(stats.cast_to<RTCAudioSourceStats>());
403 } else if (stats.type() == RTCVideoSourceStats::kType) {
404 // RTCAudioSourceStats::kType and RTCVideoSourceStats::kType both have
405 // the value "media-source", but they are distinguishable with pointer
406 // equality (==). In JavaScript they would be distinguished with |kind|.
407 verify_successful &=
408 VerifyRTCVideoSourceStats(stats.cast_to<RTCVideoSourceStats>());
hbosdb346a72016-11-29 01:57:01 -0800409 } else if (stats.type() == RTCTransportStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200410 verify_successful &=
411 VerifyRTCTransportStats(stats.cast_to<RTCTransportStats>());
hbosdb346a72016-11-29 01:57:01 -0800412 } else {
413 EXPECT_TRUE(false) << "Unrecognized stats type: " << stats.type();
414 verify_successful = false;
415 }
416 }
Henrik Boström1df1bf82018-03-20 13:24:20 +0100417 for (const char* missing : missing_stats) {
Steve Anton64b626b2019-01-28 17:25:26 -0800418 if (!absl::c_linear_search(allowed_missing_stats, missing)) {
Henrik Boström1df1bf82018-03-20 13:24:20 +0100419 verify_successful = false;
hbosdb346a72016-11-29 01:57:01 -0800420 EXPECT_TRUE(false) << "Missing expected stats type: " << missing;
421 }
422 }
Yves Gerey665174f2018-06-19 15:03:05 +0200423 EXPECT_TRUE(verify_successful)
424 << "One or more problems with the stats. This is the report:\n"
425 << report_->ToJson();
hbosdb346a72016-11-29 01:57:01 -0800426 }
427
Yves Gerey665174f2018-06-19 15:03:05 +0200428 bool VerifyRTCCertificateStats(const RTCCertificateStats& certificate) {
hbosdb346a72016-11-29 01:57:01 -0800429 RTCStatsVerifier verifier(report_, &certificate);
430 verifier.TestMemberIsDefined(certificate.fingerprint);
431 verifier.TestMemberIsDefined(certificate.fingerprint_algorithm);
432 verifier.TestMemberIsDefined(certificate.base64_certificate);
Yves Gerey665174f2018-06-19 15:03:05 +0200433 verifier.TestMemberIsOptionalIDReference(certificate.issuer_certificate_id,
434 RTCCertificateStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800435 return verifier.ExpectAllMembersSuccessfullyTested();
436 }
437
Yves Gerey665174f2018-06-19 15:03:05 +0200438 bool VerifyRTCCodecStats(const RTCCodecStats& codec) {
hbosdb346a72016-11-29 01:57:01 -0800439 RTCStatsVerifier verifier(report_, &codec);
440 verifier.TestMemberIsDefined(codec.payload_type);
hbos13f54b22017-02-28 06:56:04 -0800441 verifier.TestMemberIsDefined(codec.mime_type);
hbos23351192017-01-02 06:52:19 -0800442 verifier.TestMemberIsPositive<uint32_t>(codec.clock_rate);
hbosdb346a72016-11-29 01:57:01 -0800443 verifier.TestMemberIsUndefined(codec.channels);
hbos13f54b22017-02-28 06:56:04 -0800444 verifier.TestMemberIsUndefined(codec.sdp_fmtp_line);
hbosdb346a72016-11-29 01:57:01 -0800445 verifier.TestMemberIsUndefined(codec.implementation);
446 return verifier.ExpectAllMembersSuccessfullyTested();
447 }
448
Yves Gerey665174f2018-06-19 15:03:05 +0200449 bool VerifyRTCDataChannelStats(const RTCDataChannelStats& data_channel) {
hbosdb346a72016-11-29 01:57:01 -0800450 RTCStatsVerifier verifier(report_, &data_channel);
451 verifier.TestMemberIsDefined(data_channel.label);
452 verifier.TestMemberIsDefined(data_channel.protocol);
453 verifier.TestMemberIsDefined(data_channel.datachannelid);
454 verifier.TestMemberIsDefined(data_channel.state);
hbos23351192017-01-02 06:52:19 -0800455 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_sent);
456 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_sent);
457 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_received);
458 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_received);
hbosdb346a72016-11-29 01:57:01 -0800459 return verifier.ExpectAllMembersSuccessfullyTested();
460 }
461
462 bool VerifyRTCIceCandidatePairStats(
Yves Gerey665174f2018-06-19 15:03:05 +0200463 const RTCIceCandidatePairStats& candidate_pair,
464 bool is_selected_pair) {
hbosdb346a72016-11-29 01:57:01 -0800465 RTCStatsVerifier verifier(report_, &candidate_pair);
Yves Gerey665174f2018-06-19 15:03:05 +0200466 verifier.TestMemberIsIDReference(candidate_pair.transport_id,
467 RTCTransportStats::kType);
468 verifier.TestMemberIsIDReference(candidate_pair.local_candidate_id,
469 RTCLocalIceCandidateStats::kType);
470 verifier.TestMemberIsIDReference(candidate_pair.remote_candidate_id,
471 RTCRemoteIceCandidateStats::kType);
hbos06495bc2017-01-02 08:08:18 -0800472 verifier.TestMemberIsDefined(candidate_pair.state);
473 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.priority);
hbos92eaec62017-02-27 01:38:08 -0800474 verifier.TestMemberIsDefined(candidate_pair.nominated);
hbosdb346a72016-11-29 01:57:01 -0800475 verifier.TestMemberIsDefined(candidate_pair.writable);
476 verifier.TestMemberIsUndefined(candidate_pair.readable);
hbos23351192017-01-02 06:52:19 -0800477 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_sent);
478 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_received);
hbosbf8d3e52017-02-28 06:34:47 -0800479 verifier.TestMemberIsNonNegative<double>(
480 candidate_pair.total_round_trip_time);
hbos23351192017-01-02 06:52:19 -0800481 verifier.TestMemberIsNonNegative<double>(
482 candidate_pair.current_round_trip_time);
hbos338f78a2017-02-07 06:41:21 -0800483 if (is_selected_pair) {
484 verifier.TestMemberIsNonNegative<double>(
485 candidate_pair.available_outgoing_bitrate);
deadbeef86c40a12017-06-28 09:37:23 -0700486 // A pair should be nominated in order to be selected.
487 EXPECT_TRUE(*candidate_pair.nominated);
hbos338f78a2017-02-07 06:41:21 -0800488 } else {
489 verifier.TestMemberIsUndefined(candidate_pair.available_outgoing_bitrate);
490 }
hbosdb346a72016-11-29 01:57:01 -0800491 verifier.TestMemberIsUndefined(candidate_pair.available_incoming_bitrate);
hbos23351192017-01-02 06:52:19 -0800492 verifier.TestMemberIsNonNegative<uint64_t>(
493 candidate_pair.requests_received);
494 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.requests_sent);
495 verifier.TestMemberIsNonNegative<uint64_t>(
496 candidate_pair.responses_received);
497 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.responses_sent);
hbosdb346a72016-11-29 01:57:01 -0800498 verifier.TestMemberIsUndefined(candidate_pair.retransmissions_received);
499 verifier.TestMemberIsUndefined(candidate_pair.retransmissions_sent);
500 verifier.TestMemberIsUndefined(candidate_pair.consent_requests_received);
hbos23351192017-01-02 06:52:19 -0800501 verifier.TestMemberIsNonNegative<uint64_t>(
502 candidate_pair.consent_requests_sent);
hbosdb346a72016-11-29 01:57:01 -0800503 verifier.TestMemberIsUndefined(candidate_pair.consent_responses_received);
504 verifier.TestMemberIsUndefined(candidate_pair.consent_responses_sent);
505 return verifier.ExpectAllMembersSuccessfullyTested();
506 }
507
Yves Gerey665174f2018-06-19 15:03:05 +0200508 bool VerifyRTCIceCandidateStats(const RTCIceCandidateStats& candidate) {
hbosdb346a72016-11-29 01:57:01 -0800509 RTCStatsVerifier verifier(report_, &candidate);
Yves Gerey665174f2018-06-19 15:03:05 +0200510 verifier.TestMemberIsIDReference(candidate.transport_id,
511 RTCTransportStats::kType);
hbosc3a2b7f2017-01-02 04:46:15 -0800512 verifier.TestMemberIsDefined(candidate.is_remote);
Gary Liu37e489c2017-11-21 10:49:36 -0800513 if (*candidate.is_remote) {
514 verifier.TestMemberIsUndefined(candidate.network_type);
515 } else {
516 verifier.TestMemberIsDefined(candidate.network_type);
517 }
hbosdb346a72016-11-29 01:57:01 -0800518 verifier.TestMemberIsDefined(candidate.ip);
hbos23351192017-01-02 06:52:19 -0800519 verifier.TestMemberIsNonNegative<int32_t>(candidate.port);
hbosdb346a72016-11-29 01:57:01 -0800520 verifier.TestMemberIsDefined(candidate.protocol);
521 verifier.TestMemberIsDefined(candidate.candidate_type);
hbos23351192017-01-02 06:52:19 -0800522 verifier.TestMemberIsNonNegative<int32_t>(candidate.priority);
hbosdb346a72016-11-29 01:57:01 -0800523 verifier.TestMemberIsUndefined(candidate.url);
hbosd17a5a72017-01-02 08:09:59 -0800524 verifier.TestMemberIsDefined(candidate.deleted);
Philipp Hancke95513752018-09-27 14:40:08 +0200525 verifier.TestMemberIsUndefined(candidate.relay_protocol);
hbosdb346a72016-11-29 01:57:01 -0800526 return verifier.ExpectAllMembersSuccessfullyTested();
527 }
528
529 bool VerifyRTCLocalIceCandidateStats(
530 const RTCLocalIceCandidateStats& local_candidate) {
531 return VerifyRTCIceCandidateStats(local_candidate);
532 }
533
534 bool VerifyRTCRemoteIceCandidateStats(
535 const RTCRemoteIceCandidateStats& remote_candidate) {
536 return VerifyRTCIceCandidateStats(remote_candidate);
537 }
538
Yves Gerey665174f2018-06-19 15:03:05 +0200539 bool VerifyRTCMediaStreamStats(const RTCMediaStreamStats& media_stream) {
hbosdb346a72016-11-29 01:57:01 -0800540 RTCStatsVerifier verifier(report_, &media_stream);
541 verifier.TestMemberIsDefined(media_stream.stream_identifier);
Yves Gerey665174f2018-06-19 15:03:05 +0200542 verifier.TestMemberIsIDReference(media_stream.track_ids,
543 RTCMediaStreamTrackStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800544 return verifier.ExpectAllMembersSuccessfullyTested();
545 }
546
547 bool VerifyRTCMediaStreamTrackStats(
548 const RTCMediaStreamTrackStats& media_stream_track) {
549 RTCStatsVerifier verifier(report_, &media_stream_track);
550 verifier.TestMemberIsDefined(media_stream_track.track_identifier);
551 verifier.TestMemberIsDefined(media_stream_track.remote_source);
552 verifier.TestMemberIsDefined(media_stream_track.ended);
553 verifier.TestMemberIsDefined(media_stream_track.detached);
hbos160e4a72017-01-17 02:53:23 -0800554 verifier.TestMemberIsDefined(media_stream_track.kind);
hbosdb346a72016-11-29 01:57:01 -0800555 // Video or audio media stream track?
hbos160e4a72017-01-17 02:53:23 -0800556 if (*media_stream_track.kind == RTCMediaStreamTrackKind::kVideo) {
Henrik Boström646fda02019-05-22 15:49:42 +0200557 // The type of the referenced media source depends on kind.
558 if (media_stream_track.remote_source.is_defined() &&
559 !*media_stream_track.remote_source) {
560 verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
561 RTCVideoSourceStats::kType);
562 } else {
563 // Remote tracks don't have media source stats.
564 verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
565 }
hbosdb346a72016-11-29 01:57:01 -0800566 // Video-only members
hbos9e302742017-01-20 02:47:10 -0800567 verifier.TestMemberIsNonNegative<uint32_t>(
568 media_stream_track.frame_width);
569 verifier.TestMemberIsNonNegative<uint32_t>(
570 media_stream_track.frame_height);
hbosdb346a72016-11-29 01:57:01 -0800571 verifier.TestMemberIsUndefined(media_stream_track.frames_per_second);
hbos42f6d2f2017-01-20 03:56:50 -0800572 if (*media_stream_track.remote_source) {
hbosfefe0762017-01-20 06:14:25 -0800573 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100574 verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
hbos42f6d2f2017-01-20 03:56:50 -0800575 verifier.TestMemberIsNonNegative<uint32_t>(
576 media_stream_track.frames_received);
hbosf64941f2017-01-20 07:39:09 -0800577 verifier.TestMemberIsNonNegative<uint32_t>(
578 media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 07:21:55 -0800579 verifier.TestMemberIsNonNegative<uint32_t>(
580 media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 16:45:42 +0100581 verifier.TestMemberIsNonNegative<uint32_t>(
582 media_stream_track.freeze_count);
583 verifier.TestMemberIsNonNegative<uint32_t>(
584 media_stream_track.pause_count);
585 verifier.TestMemberIsNonNegative<double>(
586 media_stream_track.total_freezes_duration);
587 verifier.TestMemberIsNonNegative<double>(
588 media_stream_track.total_pauses_duration);
589 verifier.TestMemberIsNonNegative<double>(
590 media_stream_track.total_frames_duration);
591 verifier.TestMemberIsNonNegative<double>(
592 media_stream_track.sum_squared_frame_durations);
hbos42f6d2f2017-01-20 03:56:50 -0800593 } else {
hbosfefe0762017-01-20 06:14:25 -0800594 verifier.TestMemberIsNonNegative<uint32_t>(
595 media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100596 verifier.TestMemberIsNonNegative<uint32_t>(
597 media_stream_track.huge_frames_sent);
hbos42f6d2f2017-01-20 03:56:50 -0800598 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
hbosf64941f2017-01-20 07:39:09 -0800599 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 07:21:55 -0800600 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 16:45:42 +0100601 verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
602 verifier.TestMemberIsUndefined(media_stream_track.pause_count);
603 verifier.TestMemberIsUndefined(
604 media_stream_track.total_freezes_duration);
605 verifier.TestMemberIsUndefined(
606 media_stream_track.total_pauses_duration);
607 verifier.TestMemberIsUndefined(
608 media_stream_track.total_frames_duration);
609 verifier.TestMemberIsUndefined(
610 media_stream_track.sum_squared_frame_durations);
hbos42f6d2f2017-01-20 03:56:50 -0800611 }
hbosdb346a72016-11-29 01:57:01 -0800612 verifier.TestMemberIsUndefined(media_stream_track.frames_corrupted);
613 verifier.TestMemberIsUndefined(media_stream_track.partial_frames_lost);
614 verifier.TestMemberIsUndefined(media_stream_track.full_frames_lost);
615 // Audio-only members should be undefined
616 verifier.TestMemberIsUndefined(media_stream_track.audio_level);
617 verifier.TestMemberIsUndefined(media_stream_track.echo_return_loss);
618 verifier.TestMemberIsUndefined(
619 media_stream_track.echo_return_loss_enhancement);
zsteine76bd3a2017-07-14 12:17:49 -0700620 verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
621 verifier.TestMemberIsUndefined(media_stream_track.total_samples_duration);
hbosdb346a72016-11-29 01:57:01 -0800622 } else {
Yves Gerey665174f2018-06-19 15:03:05 +0200623 RTC_DCHECK_EQ(*media_stream_track.kind, RTCMediaStreamTrackKind::kAudio);
Henrik Boström646fda02019-05-22 15:49:42 +0200624 // The type of the referenced media source depends on kind.
625 if (media_stream_track.remote_source.is_defined() &&
626 !*media_stream_track.remote_source) {
627 verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
628 RTCAudioSourceStats::kType);
629 } else {
630 // Remote tracks don't have media source stats.
631 verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
632 }
hbosdb346a72016-11-29 01:57:01 -0800633 // Video-only members should be undefined
634 verifier.TestMemberIsUndefined(media_stream_track.frame_width);
635 verifier.TestMemberIsUndefined(media_stream_track.frame_height);
636 verifier.TestMemberIsUndefined(media_stream_track.frames_per_second);
637 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100638 verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
hbosdb346a72016-11-29 01:57:01 -0800639 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
640 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
641 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
642 verifier.TestMemberIsUndefined(media_stream_track.frames_corrupted);
643 verifier.TestMemberIsUndefined(media_stream_track.partial_frames_lost);
644 verifier.TestMemberIsUndefined(media_stream_track.full_frames_lost);
Sergey Silkin02371062019-01-31 16:45:42 +0100645 verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
646 verifier.TestMemberIsUndefined(media_stream_track.pause_count);
647 verifier.TestMemberIsUndefined(media_stream_track.total_freezes_duration);
648 verifier.TestMemberIsUndefined(media_stream_track.total_pauses_duration);
649 verifier.TestMemberIsUndefined(media_stream_track.total_frames_duration);
650 verifier.TestMemberIsUndefined(
651 media_stream_track.sum_squared_frame_durations);
hbosdb346a72016-11-29 01:57:01 -0800652 // Audio-only members
hbos9e302742017-01-20 02:47:10 -0800653 verifier.TestMemberIsNonNegative<double>(media_stream_track.audio_level);
zsteine76bd3a2017-07-14 12:17:49 -0700654 verifier.TestMemberIsNonNegative<double>(
655 media_stream_track.total_audio_energy);
656 verifier.TestMemberIsNonNegative<double>(
657 media_stream_track.total_samples_duration);
hbos2d4d6532017-01-20 04:16:41 -0800658 // TODO(hbos): |echo_return_loss| and |echo_return_loss_enhancement| are
659 // flaky on msan bot (sometimes defined, sometimes undefined). Should the
660 // test run until available or is there a way to have it always be
661 // defined? crbug.com/627816
662 verifier.MarkMemberTested(media_stream_track.echo_return_loss, true);
Yves Gerey665174f2018-06-19 15:03:05 +0200663 verifier.MarkMemberTested(media_stream_track.echo_return_loss_enhancement,
664 true);
hbosdb346a72016-11-29 01:57:01 -0800665 }
Gustaf Ullberg9a2e9062017-09-18 09:28:20 +0200666 // totalSamplesReceived, concealedSamples and concealmentEvents are only
667 // present on inbound audio tracks.
Gustaf Ullbergb0a02072017-10-02 12:00:34 +0200668 // jitterBufferDelay is currently only implemented for audio.
Steve Anton2dbc69f2017-08-24 17:15:13 -0700669 if (*media_stream_track.kind == RTCMediaStreamTrackKind::kAudio &&
670 *media_stream_track.remote_source) {
Gustaf Ullbergb0a02072017-10-02 12:00:34 +0200671 verifier.TestMemberIsNonNegative<double>(
672 media_stream_track.jitter_buffer_delay);
Steve Anton2dbc69f2017-08-24 17:15:13 -0700673 verifier.TestMemberIsNonNegative<uint64_t>(
Chen Xing0acffb52019-01-15 15:46:29 +0100674 media_stream_track.jitter_buffer_emitted_count);
675 verifier.TestMemberIsNonNegative<uint64_t>(
Steve Anton2dbc69f2017-08-24 17:15:13 -0700676 media_stream_track.total_samples_received);
677 verifier.TestMemberIsNonNegative<uint64_t>(
678 media_stream_track.concealed_samples);
Gustaf Ullberg9a2e9062017-09-18 09:28:20 +0200679 verifier.TestMemberIsNonNegative<uint64_t>(
680 media_stream_track.concealment_events);
Ruslan Burakov8af88962018-11-22 17:21:10 +0100681 verifier.TestMemberIsNonNegative<uint64_t>(
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200682 media_stream_track.inserted_samples_for_deceleration);
683 verifier.TestMemberIsNonNegative<uint64_t>(
684 media_stream_track.removed_samples_for_acceleration);
685 verifier.TestMemberIsNonNegative<uint64_t>(
686 media_stream_track.silent_concealed_samples);
687 verifier.TestMemberIsNonNegative<uint64_t>(
Ruslan Burakov8af88962018-11-22 17:21:10 +0100688 media_stream_track.jitter_buffer_flushes);
Jakob Ivarsson352ce5c2018-11-27 12:52:16 +0100689 verifier.TestMemberIsNonNegative<uint64_t>(
690 media_stream_track.delayed_packet_outage_samples);
Jakob Ivarsson232b3fd2019-03-06 09:18:40 +0100691 verifier.TestMemberIsNonNegative<double>(
692 media_stream_track.relative_packet_arrival_delay);
Henrik Lundin44125fa2019-04-29 17:00:46 +0200693 verifier.TestMemberIsNonNegative<uint32_t>(
694 media_stream_track.interruption_count);
695 verifier.TestMemberIsNonNegative<double>(
696 media_stream_track.total_interruption_duration);
Steve Anton2dbc69f2017-08-24 17:15:13 -0700697 } else {
Gustaf Ullbergb0a02072017-10-02 12:00:34 +0200698 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
Chen Xing0acffb52019-01-15 15:46:29 +0100699 verifier.TestMemberIsUndefined(
700 media_stream_track.jitter_buffer_emitted_count);
Steve Anton2dbc69f2017-08-24 17:15:13 -0700701 verifier.TestMemberIsUndefined(media_stream_track.total_samples_received);
702 verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
Gustaf Ullberg9a2e9062017-09-18 09:28:20 +0200703 verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
Ruslan Burakov8af88962018-11-22 17:21:10 +0100704 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_flushes);
Jakob Ivarsson352ce5c2018-11-27 12:52:16 +0100705 verifier.TestMemberIsUndefined(
706 media_stream_track.delayed_packet_outage_samples);
Jakob Ivarsson232b3fd2019-03-06 09:18:40 +0100707 verifier.TestMemberIsUndefined(
708 media_stream_track.relative_packet_arrival_delay);
Henrik Lundin44125fa2019-04-29 17:00:46 +0200709 verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
710 verifier.TestMemberIsUndefined(
711 media_stream_track.total_interruption_duration);
Steve Anton2dbc69f2017-08-24 17:15:13 -0700712 }
hbosdb346a72016-11-29 01:57:01 -0800713 return verifier.ExpectAllMembersSuccessfullyTested();
714 }
715
716 bool VerifyRTCPeerConnectionStats(
717 const RTCPeerConnectionStats& peer_connection) {
718 RTCStatsVerifier verifier(report_, &peer_connection);
hbos23351192017-01-02 06:52:19 -0800719 verifier.TestMemberIsNonNegative<uint32_t>(
720 peer_connection.data_channels_opened);
721 verifier.TestMemberIsNonNegative<uint32_t>(
722 peer_connection.data_channels_closed);
hbosdb346a72016-11-29 01:57:01 -0800723 return verifier.ExpectAllMembersSuccessfullyTested();
724 }
725
Yves Gerey665174f2018-06-19 15:03:05 +0200726 void VerifyRTCRTPStreamStats(const RTCRTPStreamStats& stream,
727 RTCStatsVerifier* verifier) {
hbosdb346a72016-11-29 01:57:01 -0800728 verifier->TestMemberIsDefined(stream.ssrc);
729 verifier->TestMemberIsUndefined(stream.associate_stats_id);
730 verifier->TestMemberIsDefined(stream.is_remote);
731 verifier->TestMemberIsDefined(stream.media_type);
Philipp Hancke3bc01662018-08-28 14:55:03 +0200732 verifier->TestMemberIsDefined(stream.kind);
Yves Gerey665174f2018-06-19 15:03:05 +0200733 verifier->TestMemberIsIDReference(stream.track_id,
734 RTCMediaStreamTrackStats::kType);
735 verifier->TestMemberIsIDReference(stream.transport_id,
736 RTCTransportStats::kType);
hbos7bf53692016-12-15 03:33:35 -0800737 verifier->TestMemberIsIDReference(stream.codec_id, RTCCodecStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800738 if (stream.media_type.is_defined() && *stream.media_type == "video") {
hbos23351192017-01-02 06:52:19 -0800739 verifier->TestMemberIsNonNegative<uint32_t>(stream.fir_count);
740 verifier->TestMemberIsNonNegative<uint32_t>(stream.pli_count);
741 verifier->TestMemberIsNonNegative<uint32_t>(stream.nack_count);
hbosdb346a72016-11-29 01:57:01 -0800742 } else {
743 verifier->TestMemberIsUndefined(stream.fir_count);
744 verifier->TestMemberIsUndefined(stream.pli_count);
745 verifier->TestMemberIsUndefined(stream.nack_count);
746 }
747 verifier->TestMemberIsUndefined(stream.sli_count);
748 }
749
750 bool VerifyRTCInboundRTPStreamStats(
751 const RTCInboundRTPStreamStats& inbound_stream) {
752 RTCStatsVerifier verifier(report_, &inbound_stream);
753 VerifyRTCRTPStreamStats(inbound_stream, &verifier);
sakal5fec1282017-02-20 06:43:58 -0800754 if (inbound_stream.media_type.is_defined() &&
755 *inbound_stream.media_type == "video") {
756 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.qp_sum);
757 } else {
hbosa51d4f32017-02-16 05:34:48 -0800758 verifier.TestMemberIsUndefined(inbound_stream.qp_sum);
sakal5fec1282017-02-20 06:43:58 -0800759 }
hbos23351192017-01-02 06:52:19 -0800760 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.packets_received);
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200761 if (inbound_stream.media_type.is_defined() &&
762 *inbound_stream.media_type == "audio") {
763 verifier.TestMemberIsNonNegative<uint64_t>(
764 inbound_stream.fec_packets_received);
765 verifier.TestMemberIsNonNegative<uint64_t>(
766 inbound_stream.fec_packets_discarded);
767 }
hbos23351192017-01-02 06:52:19 -0800768 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.bytes_received);
Harald Alvestrand719487e2017-12-13 12:26:04 +0100769 // packets_lost is defined as signed, but this should never happen in
770 // this test. See RFC 3550.
771 verifier.TestMemberIsNonNegative<int32_t>(inbound_stream.packets_lost);
Henrik Boström01738c62019-04-15 17:32:00 +0200772 verifier.TestMemberIsDefined(inbound_stream.last_packet_received_timestamp);
hbosdb346a72016-11-29 01:57:01 -0800773 if (inbound_stream.media_type.is_defined() &&
774 *inbound_stream.media_type == "video") {
775 verifier.TestMemberIsUndefined(inbound_stream.jitter);
776 } else {
hbos23351192017-01-02 06:52:19 -0800777 verifier.TestMemberIsNonNegative<double>(inbound_stream.jitter);
hbosdb346a72016-11-29 01:57:01 -0800778 }
hbos23351192017-01-02 06:52:19 -0800779 verifier.TestMemberIsNonNegative<double>(inbound_stream.fraction_lost);
hbosa7a9be12017-03-01 01:02:45 -0800780 verifier.TestMemberIsUndefined(inbound_stream.round_trip_time);
hbosdb346a72016-11-29 01:57:01 -0800781 verifier.TestMemberIsUndefined(inbound_stream.packets_discarded);
782 verifier.TestMemberIsUndefined(inbound_stream.packets_repaired);
783 verifier.TestMemberIsUndefined(inbound_stream.burst_packets_lost);
784 verifier.TestMemberIsUndefined(inbound_stream.burst_packets_discarded);
785 verifier.TestMemberIsUndefined(inbound_stream.burst_loss_count);
786 verifier.TestMemberIsUndefined(inbound_stream.burst_discard_count);
787 verifier.TestMemberIsUndefined(inbound_stream.burst_loss_rate);
788 verifier.TestMemberIsUndefined(inbound_stream.burst_discard_rate);
789 verifier.TestMemberIsUndefined(inbound_stream.gap_loss_rate);
790 verifier.TestMemberIsUndefined(inbound_stream.gap_discard_rate);
hbos6769c492017-01-02 08:35:13 -0800791 if (inbound_stream.media_type.is_defined() &&
792 *inbound_stream.media_type == "video") {
793 verifier.TestMemberIsDefined(inbound_stream.frames_decoded);
Henrik Boström2e069262019-04-09 13:59:31 +0200794 // The integration test is not set up to test screen share; don't require
795 // this to be present.
796 verifier.MarkMemberTested(inbound_stream.content_type, true);
hbos6769c492017-01-02 08:35:13 -0800797 } else {
798 verifier.TestMemberIsUndefined(inbound_stream.frames_decoded);
Henrik Boström2e069262019-04-09 13:59:31 +0200799 verifier.TestMemberIsUndefined(inbound_stream.content_type);
hbos6769c492017-01-02 08:35:13 -0800800 }
hbosdb346a72016-11-29 01:57:01 -0800801 return verifier.ExpectAllMembersSuccessfullyTested();
802 }
803
804 bool VerifyRTCOutboundRTPStreamStats(
805 const RTCOutboundRTPStreamStats& outbound_stream) {
806 RTCStatsVerifier verifier(report_, &outbound_stream);
807 VerifyRTCRTPStreamStats(outbound_stream, &verifier);
hbos6769c492017-01-02 08:35:13 -0800808 if (outbound_stream.media_type.is_defined() &&
809 *outbound_stream.media_type == "video") {
Henrik Boström646fda02019-05-22 15:49:42 +0200810 verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
811 RTCVideoSourceStats::kType);
hbos6769c492017-01-02 08:35:13 -0800812 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.qp_sum);
813 } else {
Henrik Boström646fda02019-05-22 15:49:42 +0200814 verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
815 RTCAudioSourceStats::kType);
hbos6769c492017-01-02 08:35:13 -0800816 verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
817 }
hbos23351192017-01-02 06:52:19 -0800818 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.packets_sent);
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200819 verifier.TestMemberIsNonNegative<uint64_t>(
820 outbound_stream.retransmitted_packets_sent);
hbos23351192017-01-02 06:52:19 -0800821 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.bytes_sent);
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200822 verifier.TestMemberIsNonNegative<uint64_t>(
823 outbound_stream.retransmitted_bytes_sent);
hbosdb346a72016-11-29 01:57:01 -0800824 verifier.TestMemberIsUndefined(outbound_stream.target_bitrate);
hbos6769c492017-01-02 08:35:13 -0800825 if (outbound_stream.media_type.is_defined() &&
826 *outbound_stream.media_type == "video") {
827 verifier.TestMemberIsDefined(outbound_stream.frames_encoded);
Henrik Boströmf71362f2019-04-08 16:14:23 +0200828 verifier.TestMemberIsNonNegative<double>(
829 outbound_stream.total_encode_time);
Henrik Boström23aff9b2019-05-20 15:15:38 +0200830 verifier.TestMemberIsNonNegative<uint64_t>(
831 outbound_stream.total_encoded_bytes_target);
Henrik Boström9fe18342019-05-16 18:38:20 +0200832 verifier.TestMemberIsNonNegative<double>(
833 outbound_stream.total_packet_send_delay);
Henrik Boström2e069262019-04-09 13:59:31 +0200834 // The integration test is not set up to test screen share; don't require
835 // this to be present.
836 verifier.MarkMemberTested(outbound_stream.content_type, true);
hbos6769c492017-01-02 08:35:13 -0800837 } else {
838 verifier.TestMemberIsUndefined(outbound_stream.frames_encoded);
Henrik Boströmf71362f2019-04-08 16:14:23 +0200839 verifier.TestMemberIsUndefined(outbound_stream.total_encode_time);
Henrik Boström23aff9b2019-05-20 15:15:38 +0200840 verifier.TestMemberIsUndefined(
841 outbound_stream.total_encoded_bytes_target);
Henrik Boström9fe18342019-05-16 18:38:20 +0200842 // TODO(https://crbug.com/webrtc/10635): Implement for audio as well.
843 verifier.TestMemberIsUndefined(outbound_stream.total_packet_send_delay);
Henrik Boström2e069262019-04-09 13:59:31 +0200844 verifier.TestMemberIsUndefined(outbound_stream.content_type);
hbos6769c492017-01-02 08:35:13 -0800845 }
hbosdb346a72016-11-29 01:57:01 -0800846 return verifier.ExpectAllMembersSuccessfullyTested();
847 }
848
Henrik Boström646fda02019-05-22 15:49:42 +0200849 void VerifyRTCMediaSourceStats(const RTCMediaSourceStats& media_source,
850 RTCStatsVerifier* verifier) {
851 verifier->TestMemberIsDefined(media_source.track_identifier);
852 verifier->TestMemberIsDefined(media_source.kind);
853 if (media_source.kind.is_defined()) {
854 EXPECT_TRUE((*media_source.kind == "audio" &&
855 media_source.type() == RTCAudioSourceStats::kType) ||
856 (*media_source.kind == "video" &&
857 media_source.type() == RTCVideoSourceStats::kType));
858 }
859 }
860
861 bool VerifyRTCAudioSourceStats(const RTCAudioSourceStats& audio_source) {
862 RTCStatsVerifier verifier(report_, &audio_source);
863 VerifyRTCMediaSourceStats(audio_source, &verifier);
864 return verifier.ExpectAllMembersSuccessfullyTested();
865 }
866
867 bool VerifyRTCVideoSourceStats(const RTCVideoSourceStats& video_source) {
868 RTCStatsVerifier verifier(report_, &video_source);
869 VerifyRTCMediaSourceStats(video_source, &verifier);
870 // TODO(hbos): This integration test uses fakes that doesn't support
871 // VideoTrackSourceInterface::Stats. When this is fixed we should
872 // TestMemberIsNonNegative<uint32_t>() for |width| and |height| instead to
873 // reflect real code.
874 verifier.TestMemberIsUndefined(video_source.width);
875 verifier.TestMemberIsUndefined(video_source.height);
876 // TODO(hbos): When |frames| is implemented test that this member should be
877 // expected to be non-negative.
878 verifier.TestMemberIsUndefined(video_source.frames);
879 verifier.TestMemberIsNonNegative<uint32_t>(video_source.frames_per_second);
880 return verifier.ExpectAllMembersSuccessfullyTested();
881 }
882
Yves Gerey665174f2018-06-19 15:03:05 +0200883 bool VerifyRTCTransportStats(const RTCTransportStats& transport) {
hbosdb346a72016-11-29 01:57:01 -0800884 RTCStatsVerifier verifier(report_, &transport);
hbos23351192017-01-02 06:52:19 -0800885 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_sent);
886 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_received);
Yves Gerey665174f2018-06-19 15:03:05 +0200887 verifier.TestMemberIsOptionalIDReference(transport.rtcp_transport_stats_id,
888 RTCTransportStats::kType);
hbos7064d592017-01-16 07:38:02 -0800889 verifier.TestMemberIsDefined(transport.dtls_state);
Yves Gerey665174f2018-06-19 15:03:05 +0200890 verifier.TestMemberIsIDReference(transport.selected_candidate_pair_id,
891 RTCIceCandidatePairStats::kType);
892 verifier.TestMemberIsIDReference(transport.local_certificate_id,
893 RTCCertificateStats::kType);
894 verifier.TestMemberIsIDReference(transport.remote_certificate_id,
895 RTCCertificateStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800896 return verifier.ExpectAllMembersSuccessfullyTested();
897 }
898
899 private:
900 rtc::scoped_refptr<const RTCStatsReport> report_;
901};
902
deadbeef40610e22016-12-22 10:53:38 -0800903#ifdef HAVE_SCTP
hbosdb346a72016-11-29 01:57:01 -0800904TEST_F(RTCStatsIntegrationTest, GetStatsFromCaller) {
905 StartCall();
906
907 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCaller();
Henrik Boström1df1bf82018-03-20 13:24:20 +0100908 RTCStatsReportVerifier(report.get()).VerifyReport({});
ehmaldonado8ab0fd82017-09-04 14:35:04 -0700909 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
hbosdb346a72016-11-29 01:57:01 -0800910}
911
912TEST_F(RTCStatsIntegrationTest, GetStatsFromCallee) {
913 StartCall();
914
915 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
Henrik Boström1df1bf82018-03-20 13:24:20 +0100916 RTCStatsReportVerifier(report.get()).VerifyReport({});
ehmaldonado8ab0fd82017-09-04 14:35:04 -0700917 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
hbosdb346a72016-11-29 01:57:01 -0800918}
919
Henrik Boström1df1bf82018-03-20 13:24:20 +0100920// These tests exercise the integration of the stats selection algorithm inside
921// of PeerConnection. See rtcstatstraveral_unittest.cc for more detailed stats
922// traversal tests on particular stats graphs.
923TEST_F(RTCStatsIntegrationTest, GetStatsWithSenderSelector) {
924 StartCall();
925 ASSERT_FALSE(caller_->pc()->GetSenders().empty());
926 rtc::scoped_refptr<const RTCStatsReport> report =
927 GetStatsFromCaller(caller_->pc()->GetSenders()[0]);
928 std::vector<const char*> allowed_missing_stats = {
929 // TODO(hbos): Include RTC[Audio/Video]ReceiverStats when implemented.
930 // TODO(hbos): Include RTCRemoteOutboundRtpStreamStats when implemented.
931 // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
932 RTCInboundRTPStreamStats::kType, RTCPeerConnectionStats::kType,
933 RTCMediaStreamStats::kType, RTCDataChannelStats::kType,
934 };
935 RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
936 EXPECT_TRUE(report->size());
937}
938
939TEST_F(RTCStatsIntegrationTest, GetStatsWithReceiverSelector) {
940 StartCall();
941
942 ASSERT_FALSE(caller_->pc()->GetReceivers().empty());
943 rtc::scoped_refptr<const RTCStatsReport> report =
944 GetStatsFromCaller(caller_->pc()->GetReceivers()[0]);
945 std::vector<const char*> allowed_missing_stats = {
946 // TODO(hbos): Include RTC[Audio/Video]SenderStats when implemented.
947 // TODO(hbos): Include RTCRemoteInboundRtpStreamStats when implemented.
948 // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
949 RTCOutboundRTPStreamStats::kType, RTCPeerConnectionStats::kType,
950 RTCMediaStreamStats::kType, RTCDataChannelStats::kType,
951 };
952 RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
953 EXPECT_TRUE(report->size());
954}
955
956TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidSenderSelector) {
957 StartCall();
958
959 ASSERT_FALSE(callee_->pc()->GetSenders().empty());
960 // The selector is invalid for the caller because it belongs to the callee.
961 auto invalid_selector = callee_->pc()->GetSenders()[0];
962 rtc::scoped_refptr<const RTCStatsReport> report =
963 GetStatsFromCaller(invalid_selector);
964 EXPECT_FALSE(report->size());
965}
966
967TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidReceiverSelector) {
968 StartCall();
969
970 ASSERT_FALSE(callee_->pc()->GetReceivers().empty());
971 // The selector is invalid for the caller because it belongs to the callee.
972 auto invalid_selector = callee_->pc()->GetReceivers()[0];
973 rtc::scoped_refptr<const RTCStatsReport> report =
974 GetStatsFromCaller(invalid_selector);
975 EXPECT_FALSE(report->size());
976}
977
Yves Gerey59cfd352018-11-26 16:22:20 +0100978// TODO(bugs.webrtc.org/10041) For now this is equivalent to the following
979// test GetsStatsWhileClosingPeerConnection, because pc() is closed by
980// PeerConnectionTestWrapper. See: bugs.webrtc.org/9847
Yves Gereyb5bb5132018-11-14 18:00:14 +0100981TEST_F(RTCStatsIntegrationTest,
Yves Gerey59cfd352018-11-26 16:22:20 +0100982 DISABLED_GetStatsWhileDestroyingPeerConnection) {
hbosb78306a2016-12-19 05:06:57 -0800983 StartCall();
984
985 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
986 RTCStatsObtainer::Create();
987 caller_->pc()->GetStats(stats_obtainer);
988 // This will destroy the peer connection.
989 caller_ = nullptr;
990 // Any pending stats requests should have completed in the act of destroying
991 // the peer connection.
Steve Anton25cfeb92018-04-26 11:44:00 -0700992 ASSERT_TRUE(stats_obtainer->report());
993 EXPECT_EQ(stats_obtainer->report()->ToJson(),
994 RTCStatsReportTraceListener::last_trace());
995}
996
997TEST_F(RTCStatsIntegrationTest, GetsStatsWhileClosingPeerConnection) {
998 StartCall();
999
1000 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1001 RTCStatsObtainer::Create();
1002 caller_->pc()->GetStats(stats_obtainer);
1003 caller_->pc()->Close();
1004
1005 ASSERT_TRUE(stats_obtainer->report());
ehmaldonado8ab0fd82017-09-04 14:35:04 -07001006 EXPECT_EQ(stats_obtainer->report()->ToJson(),
1007 RTCStatsReportTraceListener::last_trace());
hbosb78306a2016-12-19 05:06:57 -08001008}
Henrik Boströmb6199362018-03-12 10:27:55 +01001009
1010// GetStatsReferencedIds() is optimized to recognize what is or isn't a
1011// referenced ID based on dictionary type information and knowing what members
1012// are used as references, as opposed to iterating all members to find the ones
1013// with the "Id" or "Ids" suffix. As such, GetStatsReferencedIds() is tested as
1014// an integration test instead of a unit test in order to guard against adding
1015// new references and forgetting to update GetStatsReferencedIds().
1016TEST_F(RTCStatsIntegrationTest, GetStatsReferencedIds) {
1017 StartCall();
1018
1019 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1020 for (const RTCStats& stats : *report) {
1021 // Find all references by looking at all string members with the "Id" or
1022 // "Ids" suffix.
1023 std::set<const std::string*> expected_ids;
1024 for (const auto* member : stats.Members()) {
1025 if (!member->is_defined())
1026 continue;
1027 if (member->type() == RTCStatsMemberInterface::kString) {
Steve Anton68586e82018-12-13 17:41:25 -08001028 if (absl::EndsWith(member->name(), "Id")) {
Henrik Boströmb6199362018-03-12 10:27:55 +01001029 const auto& id = member->cast_to<const RTCStatsMember<std::string>>();
1030 expected_ids.insert(&(*id));
1031 }
1032 } else if (member->type() == RTCStatsMemberInterface::kSequenceString) {
Steve Anton68586e82018-12-13 17:41:25 -08001033 if (absl::EndsWith(member->name(), "Ids")) {
Henrik Boströmb6199362018-03-12 10:27:55 +01001034 const auto& ids =
1035 member->cast_to<const RTCStatsMember<std::vector<std::string>>>();
1036 for (const std::string& id : *ids)
1037 expected_ids.insert(&id);
1038 }
1039 }
1040 }
1041
1042 std::vector<const std::string*> neighbor_ids = GetStatsReferencedIds(stats);
1043 EXPECT_EQ(neighbor_ids.size(), expected_ids.size());
1044 for (const std::string* neighbor_id : neighbor_ids) {
Steve Anton64b626b2019-01-28 17:25:26 -08001045 EXPECT_THAT(expected_ids, Contains(neighbor_id));
Henrik Boströmb6199362018-03-12 10:27:55 +01001046 }
1047 for (const std::string* expected_id : expected_ids) {
Steve Anton64b626b2019-01-28 17:25:26 -08001048 EXPECT_THAT(neighbor_ids, Contains(expected_id));
Henrik Boströmb6199362018-03-12 10:27:55 +01001049 }
1050 }
1051}
deadbeef40610e22016-12-22 10:53:38 -08001052#endif // HAVE_SCTP
hbosb78306a2016-12-19 05:06:57 -08001053
hbosdb346a72016-11-29 01:57:01 -08001054} // namespace
1055
1056} // namespace webrtc