blob: ca0df26bb01fd879c30f63e9699f9491ca8e5642 [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>
Jonas Olssona4d87372019-07-05 19:08:33 +020013
Henrik Boströmb6199362018-03-12 10:27:55 +010014#include <algorithm>
Yves Gerey3e707812018-11-28 16:47:49 +010015#include <memory>
hbosdb346a72016-11-29 01:57:01 -080016#include <set>
Yves Gerey3e707812018-11-28 16:47:49 +010017#include <string>
hbosdb346a72016-11-29 01:57:01 -080018#include <vector>
19
Steve Anton64b626b2019-01-28 17:25:26 -080020#include "absl/algorithm/container.h"
Steve Anton68586e82018-12-13 17:41:25 -080021#include "absl/strings/match.h"
Yves Gerey3e707812018-11-28 16:47:49 +010022#include "api/audio_codecs/audio_decoder_factory.h"
23#include "api/audio_codecs/audio_encoder_factory.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020024#include "api/audio_codecs/builtin_audio_decoder_factory.h"
25#include "api/audio_codecs/builtin_audio_encoder_factory.h"
Yves Gerey3e707812018-11-28 16:47:49 +010026#include "api/audio_options.h"
Steve Anton10542f22019-01-11 09:11:00 -080027#include "api/data_channel_interface.h"
28#include "api/peer_connection_interface.h"
29#include "api/rtp_receiver_interface.h"
30#include "api/rtp_sender_interface.h"
Mirko Bonadeid9708072019-01-25 20:26:48 +010031#include "api/scoped_refptr.h"
Steve Anton10542f22019-01-11 09:11:00 -080032#include "api/stats/rtc_stats.h"
33#include "api/stats/rtc_stats_report.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020034#include "api/stats/rtcstats_objects.h"
Steve Anton10542f22019-01-11 09:11:00 -080035#include "pc/rtc_stats_traversal.h"
36#include "pc/test/peer_connection_test_wrapper.h"
37#include "pc/test/rtc_stats_obtainer.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020038#include "rtc_base/checks.h"
39#include "rtc_base/event_tracer.h"
40#include "rtc_base/gunit.h"
Steve Anton10542f22019-01-11 09:11:00 -080041#include "rtc_base/ref_counted_object.h"
Yves Gerey3e707812018-11-28 16:47:49 +010042#include "rtc_base/thread.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020043#include "rtc_base/trace_event.h"
Steve Anton10542f22019-01-11 09:11:00 -080044#include "rtc_base/virtual_socket_server.h"
Steve Anton64b626b2019-01-28 17:25:26 -080045#include "test/gmock.h"
Yves Gerey3e707812018-11-28 16:47:49 +010046#include "test/gtest.h"
hbosdb346a72016-11-29 01:57:01 -080047
Steve Anton64b626b2019-01-28 17:25:26 -080048using ::testing::Contains;
49
hbosdb346a72016-11-29 01:57:01 -080050namespace webrtc {
51
52namespace {
53
54const int64_t kGetStatsTimeoutMs = 10000;
55
ehmaldonado80c829f2017-07-18 07:35:19 -070056const unsigned char* GetCategoryEnabledHandler(const char* name) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -070057 if (strcmp("webrtc_stats", name) != 0) {
58 return reinterpret_cast<const unsigned char*>("");
59 }
60 return reinterpret_cast<const unsigned char*>(name);
ehmaldonado80c829f2017-07-18 07:35:19 -070061}
62
ehmaldonado8ab0fd82017-09-04 14:35:04 -070063class RTCStatsReportTraceListener {
64 public:
65 static void SetUp() {
66 if (!traced_report_)
67 traced_report_ = new RTCStatsReportTraceListener();
68 traced_report_->last_trace_ = "";
69 SetupEventTracer(&GetCategoryEnabledHandler,
70 &RTCStatsReportTraceListener::AddTraceEventHandler);
71 }
72
73 static const std::string& last_trace() {
74 RTC_DCHECK(traced_report_);
75 return traced_report_->last_trace_;
76 }
77
78 private:
Steve Anton36b29d12017-10-30 09:57:42 -070079 static void AddTraceEventHandler(
80 char phase,
81 const unsigned char* category_enabled,
82 const char* name,
83 unsigned long long id, // NOLINT(runtime/int)
84 int num_args,
85 const char** arg_names,
86 const unsigned char* arg_types,
87 const unsigned long long* arg_values, // NOLINT(runtime/int)
88 unsigned char flags) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -070089 RTC_DCHECK(traced_report_);
90 EXPECT_STREQ("webrtc_stats",
91 reinterpret_cast<const char*>(category_enabled));
92 EXPECT_STREQ("webrtc_stats", name);
93 EXPECT_EQ(1, num_args);
94 EXPECT_STREQ("report", arg_names[0]);
95 EXPECT_EQ(TRACE_VALUE_TYPE_COPY_STRING, arg_types[0]);
96
97 traced_report_->last_trace_ = reinterpret_cast<const char*>(arg_values[0]);
98 }
99
100 static RTCStatsReportTraceListener* traced_report_;
101 std::string last_trace_;
102};
103
104RTCStatsReportTraceListener* RTCStatsReportTraceListener::traced_report_ =
105 nullptr;
ehmaldonado80c829f2017-07-18 07:35:19 -0700106
Mirko Bonadei6a489f22019-04-09 15:11:12 +0200107class RTCStatsIntegrationTest : public ::testing::Test {
hbosdb346a72016-11-29 01:57:01 -0800108 public:
109 RTCStatsIntegrationTest()
tommie7251592017-07-14 14:44:46 -0700110 : network_thread_(new rtc::Thread(&virtual_socket_server_)),
111 worker_thread_(rtc::Thread::Create()) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -0700112 RTCStatsReportTraceListener::SetUp();
ehmaldonado80c829f2017-07-18 07:35:19 -0700113
tommie7251592017-07-14 14:44:46 -0700114 RTC_CHECK(network_thread_->Start());
115 RTC_CHECK(worker_thread_->Start());
hbosdb346a72016-11-29 01:57:01 -0800116
Tommi87f70902021-04-27 14:43:08 +0200117 caller_ = rtc::make_ref_counted<PeerConnectionTestWrapper>(
tommie7251592017-07-14 14:44:46 -0700118 "caller", network_thread_.get(), worker_thread_.get());
Tommi87f70902021-04-27 14:43:08 +0200119 callee_ = rtc::make_ref_counted<PeerConnectionTestWrapper>(
tommie7251592017-07-14 14:44:46 -0700120 "callee", network_thread_.get(), worker_thread_.get());
hbosdb346a72016-11-29 01:57:01 -0800121 }
122
123 void StartCall() {
124 // Create PeerConnections and "connect" sigslots
125 PeerConnectionInterface::RTCConfiguration config;
126 PeerConnectionInterface::IceServer ice_server;
127 ice_server.uri = "stun:1.1.1.1:3478";
128 config.servers.push_back(ice_server);
Niels Möllerf06f9232018-08-07 12:32:18 +0200129 EXPECT_TRUE(caller_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
kwiberg9e5b11e2017-04-19 03:47:57 -0700130 CreateBuiltinAudioDecoderFactory()));
Niels Möllerf06f9232018-08-07 12:32:18 +0200131 EXPECT_TRUE(callee_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
kwiberg9e5b11e2017-04-19 03:47:57 -0700132 CreateBuiltinAudioDecoderFactory()));
hbosdb346a72016-11-29 01:57:01 -0800133 PeerConnectionTestWrapper::Connect(caller_.get(), callee_.get());
134
135 // Get user media for audio and video
Niels Möller5c4ddad2019-02-12 12:30:58 +0100136 caller_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
137 callee_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
hbosdb346a72016-11-29 01:57:01 -0800138
139 // Create data channels
140 DataChannelInit init;
141 caller_->CreateDataChannel("data", init);
142 callee_->CreateDataChannel("data", init);
143
144 // Negotiate and wait for call to establish
Niels Möllerf06f9232018-08-07 12:32:18 +0200145 caller_->CreateOffer(PeerConnectionInterface::RTCOfferAnswerOptions());
hbosdb346a72016-11-29 01:57:01 -0800146 caller_->WaitForCallEstablished();
147 callee_->WaitForCallEstablished();
148 }
149
150 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller() {
151 return GetStats(caller_->pc());
152 }
Henrik Boström1df1bf82018-03-20 13:24:20 +0100153 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
154 rtc::scoped_refptr<RtpSenderInterface> selector) {
155 return GetStats(caller_->pc(), selector);
156 }
157 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
158 rtc::scoped_refptr<RtpReceiverInterface> selector) {
159 return GetStats(caller_->pc(), selector);
160 }
hbosdb346a72016-11-29 01:57:01 -0800161
162 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee() {
163 return GetStats(callee_->pc());
164 }
Henrik Boström1df1bf82018-03-20 13:24:20 +0100165 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
166 rtc::scoped_refptr<RtpSenderInterface> selector) {
167 return GetStats(callee_->pc(), selector);
168 }
169 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
170 rtc::scoped_refptr<RtpReceiverInterface> selector) {
171 return GetStats(callee_->pc(), selector);
172 }
hbosdb346a72016-11-29 01:57:01 -0800173
174 protected:
175 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
176 PeerConnectionInterface* pc) {
177 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
178 RTCStatsObtainer::Create();
179 pc->GetStats(stats_obtainer);
180 EXPECT_TRUE_WAIT(stats_obtainer->report(), kGetStatsTimeoutMs);
181 return stats_obtainer->report();
182 }
183
Henrik Boström1df1bf82018-03-20 13:24:20 +0100184 template <typename T>
185 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
186 PeerConnectionInterface* pc,
187 rtc::scoped_refptr<T> selector) {
188 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
189 RTCStatsObtainer::Create();
190 pc->GetStats(selector, stats_obtainer);
191 EXPECT_TRUE_WAIT(stats_obtainer->report(), kGetStatsTimeoutMs);
192 return stats_obtainer->report();
193 }
194
Artem Titov880fa812021-07-30 22:30:23 +0200195 // `network_thread_` uses `virtual_socket_server_` so they must be
deadbeef98e186c2017-05-16 18:00:06 -0700196 // constructed/destructed in the correct order.
hbosdb346a72016-11-29 01:57:01 -0800197 rtc::VirtualSocketServer virtual_socket_server_;
tommie7251592017-07-14 14:44:46 -0700198 std::unique_ptr<rtc::Thread> network_thread_;
199 std::unique_ptr<rtc::Thread> worker_thread_;
hbosdb346a72016-11-29 01:57:01 -0800200 rtc::scoped_refptr<PeerConnectionTestWrapper> caller_;
201 rtc::scoped_refptr<PeerConnectionTestWrapper> callee_;
202};
203
204class RTCStatsVerifier {
205 public:
206 RTCStatsVerifier(const RTCStatsReport* report, const RTCStats* stats)
207 : report_(report), stats_(stats), all_tests_successful_(true) {
208 RTC_CHECK(report_);
209 RTC_CHECK(stats_);
210 for (const RTCStatsMemberInterface* member : stats_->Members()) {
211 untested_members_.insert(member);
212 }
213 }
214
Yves Gerey665174f2018-06-19 15:03:05 +0200215 void MarkMemberTested(const RTCStatsMemberInterface& member,
216 bool test_successful) {
hbosdb346a72016-11-29 01:57:01 -0800217 untested_members_.erase(&member);
218 all_tests_successful_ &= test_successful;
219 }
220
221 void TestMemberIsDefined(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200222 EXPECT_TRUE(member.is_defined())
223 << stats_->type() << "." << member.name() << "[" << stats_->id()
224 << "] was undefined.";
hbosdb346a72016-11-29 01:57:01 -0800225 MarkMemberTested(member, member.is_defined());
226 }
227
228 void TestMemberIsUndefined(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200229 EXPECT_FALSE(member.is_defined())
230 << stats_->type() << "." << member.name() << "[" << stats_->id()
231 << "] was defined (" << member.ValueToString() << ").";
hbosdb346a72016-11-29 01:57:01 -0800232 MarkMemberTested(member, !member.is_defined());
233 }
234
Yves Gerey665174f2018-06-19 15:03:05 +0200235 template <typename T>
hbos23351192017-01-02 06:52:19 -0800236 void TestMemberIsPositive(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200237 EXPECT_TRUE(member.is_defined())
238 << stats_->type() << "." << member.name() << "[" << stats_->id()
239 << "] was undefined.";
hbos23351192017-01-02 06:52:19 -0800240 if (!member.is_defined()) {
241 MarkMemberTested(member, false);
242 return;
243 }
244 bool is_positive = *member.cast_to<RTCStatsMember<T>>() > T(0);
Yves Gerey665174f2018-06-19 15:03:05 +0200245 EXPECT_TRUE(is_positive)
246 << stats_->type() << "." << member.name() << "[" << stats_->id()
247 << "] was not positive (" << member.ValueToString() << ").";
hbos23351192017-01-02 06:52:19 -0800248 MarkMemberTested(member, is_positive);
249 }
250
Yves Gerey665174f2018-06-19 15:03:05 +0200251 template <typename T>
hbos23351192017-01-02 06:52:19 -0800252 void TestMemberIsNonNegative(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 15:03:05 +0200253 EXPECT_TRUE(member.is_defined())
254 << stats_->type() << "." << member.name() << "[" << stats_->id()
255 << "] was undefined.";
hbos23351192017-01-02 06:52:19 -0800256 if (!member.is_defined()) {
257 MarkMemberTested(member, false);
258 return;
259 }
260 bool is_non_negative = *member.cast_to<RTCStatsMember<T>>() >= T(0);
Yves Gerey665174f2018-06-19 15:03:05 +0200261 EXPECT_TRUE(is_non_negative)
262 << stats_->type() << "." << member.name() << "[" << stats_->id()
263 << "] was not non-negative (" << member.ValueToString() << ").";
hbos23351192017-01-02 06:52:19 -0800264 MarkMemberTested(member, is_non_negative);
265 }
266
Yves Gerey665174f2018-06-19 15:03:05 +0200267 void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
268 const char* expected_type) {
hbosdb346a72016-11-29 01:57:01 -0800269 TestMemberIsIDReference(member, expected_type, false);
270 }
271
Yves Gerey665174f2018-06-19 15:03:05 +0200272 void TestMemberIsOptionalIDReference(const RTCStatsMemberInterface& member,
273 const char* expected_type) {
hbosdb346a72016-11-29 01:57:01 -0800274 TestMemberIsIDReference(member, expected_type, true);
275 }
276
277 bool ExpectAllMembersSuccessfullyTested() {
278 if (untested_members_.empty())
279 return all_tests_successful_;
280 for (const RTCStatsMemberInterface* member : untested_members_) {
Yves Gerey665174f2018-06-19 15:03:05 +0200281 EXPECT_TRUE(false) << stats_->type() << "." << member->name() << "["
282 << stats_->id() << "] was not tested.";
hbosdb346a72016-11-29 01:57:01 -0800283 }
284 return false;
285 }
286
287 private:
Yves Gerey665174f2018-06-19 15:03:05 +0200288 void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
289 const char* expected_type,
290 bool optional) {
hbosdb346a72016-11-29 01:57:01 -0800291 if (optional && !member.is_defined()) {
292 MarkMemberTested(member, true);
293 return;
294 }
295 bool valid_reference = false;
296 if (member.is_defined()) {
297 if (member.type() == RTCStatsMemberInterface::kString) {
298 // A single ID.
299 const RTCStatsMember<std::string>& id =
300 member.cast_to<RTCStatsMember<std::string>>();
301 const RTCStats* referenced_stats = report_->Get(*id);
302 valid_reference =
303 referenced_stats && referenced_stats->type() == expected_type;
304 } else if (member.type() == RTCStatsMemberInterface::kSequenceString) {
305 // A vector of IDs.
306 valid_reference = true;
307 const RTCStatsMember<std::vector<std::string>>& ids =
308 member.cast_to<RTCStatsMember<std::vector<std::string>>>();
Mirko Bonadeic61ce0d2017-11-21 17:04:20 +0100309 for (const std::string& id : *ids) {
hbosdb346a72016-11-29 01:57:01 -0800310 const RTCStats* referenced_stats = report_->Get(id);
311 if (!referenced_stats || referenced_stats->type() != expected_type) {
312 valid_reference = false;
313 break;
314 }
315 }
316 }
317 }
Yves Gerey665174f2018-06-19 15:03:05 +0200318 EXPECT_TRUE(valid_reference)
319 << stats_->type() << "." << member.name()
320 << " is not a reference to an "
Jonas Olssonb2b20312020-01-14 12:11:31 +0100321 "existing dictionary of type "
322 << expected_type << " (value: "
Henrik Boström646fda02019-05-22 15:49:42 +0200323 << (member.is_defined() ? member.ValueToString() : "null") << ").";
hbosdb346a72016-11-29 01:57:01 -0800324 MarkMemberTested(member, valid_reference);
325 }
326
327 rtc::scoped_refptr<const RTCStatsReport> report_;
328 const RTCStats* stats_;
329 std::set<const RTCStatsMemberInterface*> untested_members_;
330 bool all_tests_successful_;
331};
332
333class RTCStatsReportVerifier {
334 public:
335 static std::set<const char*> StatsTypes() {
336 std::set<const char*> stats_types;
337 stats_types.insert(RTCCertificateStats::kType);
338 stats_types.insert(RTCCodecStats::kType);
339 stats_types.insert(RTCDataChannelStats::kType);
340 stats_types.insert(RTCIceCandidatePairStats::kType);
341 stats_types.insert(RTCLocalIceCandidateStats::kType);
342 stats_types.insert(RTCRemoteIceCandidateStats::kType);
343 stats_types.insert(RTCMediaStreamStats::kType);
344 stats_types.insert(RTCMediaStreamTrackStats::kType);
345 stats_types.insert(RTCPeerConnectionStats::kType);
346 stats_types.insert(RTCInboundRTPStreamStats::kType);
347 stats_types.insert(RTCOutboundRTPStreamStats::kType);
348 stats_types.insert(RTCTransportStats::kType);
349 return stats_types;
350 }
351
352 explicit RTCStatsReportVerifier(const RTCStatsReport* report)
Yves Gerey665174f2018-06-19 15:03:05 +0200353 : report_(report) {}
hbosdb346a72016-11-29 01:57:01 -0800354
Eldar Rello9276e2c2020-06-10 17:53:39 +0300355 void VerifyReport(std::vector<const char*> allowed_missing_stats) {
hbosdb346a72016-11-29 01:57:01 -0800356 std::set<const char*> missing_stats = StatsTypes();
357 bool verify_successful = true;
hbos338f78a2017-02-07 06:41:21 -0800358 std::vector<const RTCTransportStats*> transport_stats =
359 report_->GetStatsOfType<RTCTransportStats>();
Mirko Bonadeie12c1fe2018-07-03 12:53:23 +0200360 EXPECT_EQ(transport_stats.size(), 1U);
hbos338f78a2017-02-07 06:41:21 -0800361 std::string selected_candidate_pair_id =
362 *transport_stats[0]->selected_candidate_pair_id;
hbosdb346a72016-11-29 01:57:01 -0800363 for (const RTCStats& stats : *report_) {
364 missing_stats.erase(stats.type());
365 if (stats.type() == RTCCertificateStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200366 verify_successful &=
367 VerifyRTCCertificateStats(stats.cast_to<RTCCertificateStats>());
hbosdb346a72016-11-29 01:57:01 -0800368 } else if (stats.type() == RTCCodecStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200369 verify_successful &=
370 VerifyRTCCodecStats(stats.cast_to<RTCCodecStats>());
hbosdb346a72016-11-29 01:57:01 -0800371 } else if (stats.type() == RTCDataChannelStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200372 verify_successful &=
373 VerifyRTCDataChannelStats(stats.cast_to<RTCDataChannelStats>());
hbosdb346a72016-11-29 01:57:01 -0800374 } else if (stats.type() == RTCIceCandidatePairStats::kType) {
375 verify_successful &= VerifyRTCIceCandidatePairStats(
hbos338f78a2017-02-07 06:41:21 -0800376 stats.cast_to<RTCIceCandidatePairStats>(),
377 stats.id() == selected_candidate_pair_id);
hbosdb346a72016-11-29 01:57:01 -0800378 } else if (stats.type() == RTCLocalIceCandidateStats::kType) {
379 verify_successful &= VerifyRTCLocalIceCandidateStats(
380 stats.cast_to<RTCLocalIceCandidateStats>());
381 } else if (stats.type() == RTCRemoteIceCandidateStats::kType) {
382 verify_successful &= VerifyRTCRemoteIceCandidateStats(
383 stats.cast_to<RTCRemoteIceCandidateStats>());
384 } else if (stats.type() == RTCMediaStreamStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200385 verify_successful &=
386 VerifyRTCMediaStreamStats(stats.cast_to<RTCMediaStreamStats>());
hbosdb346a72016-11-29 01:57:01 -0800387 } else if (stats.type() == RTCMediaStreamTrackStats::kType) {
388 verify_successful &= VerifyRTCMediaStreamTrackStats(
389 stats.cast_to<RTCMediaStreamTrackStats>());
390 } else if (stats.type() == RTCPeerConnectionStats::kType) {
391 verify_successful &= VerifyRTCPeerConnectionStats(
392 stats.cast_to<RTCPeerConnectionStats>());
393 } else if (stats.type() == RTCInboundRTPStreamStats::kType) {
394 verify_successful &= VerifyRTCInboundRTPStreamStats(
395 stats.cast_to<RTCInboundRTPStreamStats>());
396 } else if (stats.type() == RTCOutboundRTPStreamStats::kType) {
397 verify_successful &= VerifyRTCOutboundRTPStreamStats(
Eldar Rello9276e2c2020-06-10 17:53:39 +0300398 stats.cast_to<RTCOutboundRTPStreamStats>());
Henrik Boström883eefc2019-05-27 13:40:25 +0200399 } else if (stats.type() == RTCRemoteInboundRtpStreamStats::kType) {
400 verify_successful &= VerifyRTCRemoteInboundRtpStreamStats(
401 stats.cast_to<RTCRemoteInboundRtpStreamStats>());
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100402 } else if (stats.type() == RTCRemoteOutboundRtpStreamStats::kType) {
403 verify_successful &= VerifyRTCRemoteOutboundRTPStreamStats(
404 stats.cast_to<RTCRemoteOutboundRtpStreamStats>());
Henrik Boström646fda02019-05-22 15:49:42 +0200405 } else if (stats.type() == RTCAudioSourceStats::kType) {
406 // RTCAudioSourceStats::kType and RTCVideoSourceStats::kType both have
407 // the value "media-source", but they are distinguishable with pointer
Artem Titov880fa812021-07-30 22:30:23 +0200408 // equality (==). In JavaScript they would be distinguished with `kind`.
Henrik Boström646fda02019-05-22 15:49:42 +0200409 verify_successful &=
410 VerifyRTCAudioSourceStats(stats.cast_to<RTCAudioSourceStats>());
411 } else if (stats.type() == RTCVideoSourceStats::kType) {
412 // RTCAudioSourceStats::kType and RTCVideoSourceStats::kType both have
413 // the value "media-source", but they are distinguishable with pointer
Artem Titov880fa812021-07-30 22:30:23 +0200414 // equality (==). In JavaScript they would be distinguished with `kind`.
Henrik Boström646fda02019-05-22 15:49:42 +0200415 verify_successful &=
416 VerifyRTCVideoSourceStats(stats.cast_to<RTCVideoSourceStats>());
hbosdb346a72016-11-29 01:57:01 -0800417 } else if (stats.type() == RTCTransportStats::kType) {
Yves Gerey665174f2018-06-19 15:03:05 +0200418 verify_successful &=
419 VerifyRTCTransportStats(stats.cast_to<RTCTransportStats>());
hbosdb346a72016-11-29 01:57:01 -0800420 } else {
421 EXPECT_TRUE(false) << "Unrecognized stats type: " << stats.type();
422 verify_successful = false;
423 }
424 }
Henrik Boström1df1bf82018-03-20 13:24:20 +0100425 for (const char* missing : missing_stats) {
Steve Anton64b626b2019-01-28 17:25:26 -0800426 if (!absl::c_linear_search(allowed_missing_stats, missing)) {
Henrik Boström1df1bf82018-03-20 13:24:20 +0100427 verify_successful = false;
hbosdb346a72016-11-29 01:57:01 -0800428 EXPECT_TRUE(false) << "Missing expected stats type: " << missing;
429 }
430 }
Yves Gerey665174f2018-06-19 15:03:05 +0200431 EXPECT_TRUE(verify_successful)
432 << "One or more problems with the stats. This is the report:\n"
433 << report_->ToJson();
hbosdb346a72016-11-29 01:57:01 -0800434 }
435
Yves Gerey665174f2018-06-19 15:03:05 +0200436 bool VerifyRTCCertificateStats(const RTCCertificateStats& certificate) {
hbosdb346a72016-11-29 01:57:01 -0800437 RTCStatsVerifier verifier(report_, &certificate);
438 verifier.TestMemberIsDefined(certificate.fingerprint);
439 verifier.TestMemberIsDefined(certificate.fingerprint_algorithm);
440 verifier.TestMemberIsDefined(certificate.base64_certificate);
Yves Gerey665174f2018-06-19 15:03:05 +0200441 verifier.TestMemberIsOptionalIDReference(certificate.issuer_certificate_id,
442 RTCCertificateStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800443 return verifier.ExpectAllMembersSuccessfullyTested();
444 }
445
Yves Gerey665174f2018-06-19 15:03:05 +0200446 bool VerifyRTCCodecStats(const RTCCodecStats& codec) {
hbosdb346a72016-11-29 01:57:01 -0800447 RTCStatsVerifier verifier(report_, &codec);
Philipp Hancke95157a02020-11-16 20:08:27 +0100448 verifier.TestMemberIsIDReference(codec.transport_id,
449 RTCTransportStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800450 verifier.TestMemberIsDefined(codec.payload_type);
hbos13f54b22017-02-28 06:56:04 -0800451 verifier.TestMemberIsDefined(codec.mime_type);
hbos23351192017-01-02 06:52:19 -0800452 verifier.TestMemberIsPositive<uint32_t>(codec.clock_rate);
Johannes Kron72d69152020-02-10 14:05:55 +0100453
454 if (codec.mime_type->rfind("audio", 0) == 0)
455 verifier.TestMemberIsPositive<uint32_t>(codec.channels);
456 else
457 verifier.TestMemberIsUndefined(codec.channels);
458
459 // sdp_fmtp_line is an optional field.
460 verifier.MarkMemberTested(codec.sdp_fmtp_line, true);
hbosdb346a72016-11-29 01:57:01 -0800461 return verifier.ExpectAllMembersSuccessfullyTested();
462 }
463
Yves Gerey665174f2018-06-19 15:03:05 +0200464 bool VerifyRTCDataChannelStats(const RTCDataChannelStats& data_channel) {
hbosdb346a72016-11-29 01:57:01 -0800465 RTCStatsVerifier verifier(report_, &data_channel);
466 verifier.TestMemberIsDefined(data_channel.label);
467 verifier.TestMemberIsDefined(data_channel.protocol);
Harald Alvestrand10ef8472020-06-05 15:38:51 +0200468 verifier.TestMemberIsDefined(data_channel.data_channel_identifier);
hbosdb346a72016-11-29 01:57:01 -0800469 verifier.TestMemberIsDefined(data_channel.state);
hbos23351192017-01-02 06:52:19 -0800470 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_sent);
471 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_sent);
472 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_received);
473 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_received);
hbosdb346a72016-11-29 01:57:01 -0800474 return verifier.ExpectAllMembersSuccessfullyTested();
475 }
476
477 bool VerifyRTCIceCandidatePairStats(
Yves Gerey665174f2018-06-19 15:03:05 +0200478 const RTCIceCandidatePairStats& candidate_pair,
479 bool is_selected_pair) {
hbosdb346a72016-11-29 01:57:01 -0800480 RTCStatsVerifier verifier(report_, &candidate_pair);
Yves Gerey665174f2018-06-19 15:03:05 +0200481 verifier.TestMemberIsIDReference(candidate_pair.transport_id,
482 RTCTransportStats::kType);
483 verifier.TestMemberIsIDReference(candidate_pair.local_candidate_id,
484 RTCLocalIceCandidateStats::kType);
485 verifier.TestMemberIsIDReference(candidate_pair.remote_candidate_id,
486 RTCRemoteIceCandidateStats::kType);
hbos06495bc2017-01-02 08:08:18 -0800487 verifier.TestMemberIsDefined(candidate_pair.state);
488 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.priority);
hbos92eaec62017-02-27 01:38:08 -0800489 verifier.TestMemberIsDefined(candidate_pair.nominated);
hbosdb346a72016-11-29 01:57:01 -0800490 verifier.TestMemberIsDefined(candidate_pair.writable);
491 verifier.TestMemberIsUndefined(candidate_pair.readable);
Taylor Brandstetter79326ea2021-09-28 15:09:53 -0700492 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.packets_sent);
493 verifier.TestMemberIsNonNegative<uint64_t>(
494 candidate_pair.packets_discarded_on_send);
495 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.packets_received);
hbos23351192017-01-02 06:52:19 -0800496 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_sent);
Taylor Brandstetter79326ea2021-09-28 15:09:53 -0700497 verifier.TestMemberIsNonNegative<uint64_t>(
498 candidate_pair.bytes_discarded_on_send);
hbos23351192017-01-02 06:52:19 -0800499 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_received);
hbosbf8d3e52017-02-28 06:34:47 -0800500 verifier.TestMemberIsNonNegative<double>(
501 candidate_pair.total_round_trip_time);
hbos23351192017-01-02 06:52:19 -0800502 verifier.TestMemberIsNonNegative<double>(
503 candidate_pair.current_round_trip_time);
hbos338f78a2017-02-07 06:41:21 -0800504 if (is_selected_pair) {
505 verifier.TestMemberIsNonNegative<double>(
506 candidate_pair.available_outgoing_bitrate);
deadbeef86c40a12017-06-28 09:37:23 -0700507 // A pair should be nominated in order to be selected.
508 EXPECT_TRUE(*candidate_pair.nominated);
hbos338f78a2017-02-07 06:41:21 -0800509 } else {
510 verifier.TestMemberIsUndefined(candidate_pair.available_outgoing_bitrate);
511 }
hbosdb346a72016-11-29 01:57:01 -0800512 verifier.TestMemberIsUndefined(candidate_pair.available_incoming_bitrate);
hbos23351192017-01-02 06:52:19 -0800513 verifier.TestMemberIsNonNegative<uint64_t>(
514 candidate_pair.requests_received);
515 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.requests_sent);
516 verifier.TestMemberIsNonNegative<uint64_t>(
517 candidate_pair.responses_received);
518 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.responses_sent);
hbosdb346a72016-11-29 01:57:01 -0800519 verifier.TestMemberIsUndefined(candidate_pair.retransmissions_received);
520 verifier.TestMemberIsUndefined(candidate_pair.retransmissions_sent);
521 verifier.TestMemberIsUndefined(candidate_pair.consent_requests_received);
hbos23351192017-01-02 06:52:19 -0800522 verifier.TestMemberIsNonNegative<uint64_t>(
523 candidate_pair.consent_requests_sent);
hbosdb346a72016-11-29 01:57:01 -0800524 verifier.TestMemberIsUndefined(candidate_pair.consent_responses_received);
525 verifier.TestMemberIsUndefined(candidate_pair.consent_responses_sent);
526 return verifier.ExpectAllMembersSuccessfullyTested();
527 }
528
Yves Gerey665174f2018-06-19 15:03:05 +0200529 bool VerifyRTCIceCandidateStats(const RTCIceCandidateStats& candidate) {
hbosdb346a72016-11-29 01:57:01 -0800530 RTCStatsVerifier verifier(report_, &candidate);
Yves Gerey665174f2018-06-19 15:03:05 +0200531 verifier.TestMemberIsIDReference(candidate.transport_id,
532 RTCTransportStats::kType);
hbosc3a2b7f2017-01-02 04:46:15 -0800533 verifier.TestMemberIsDefined(candidate.is_remote);
Gary Liu37e489c2017-11-21 10:49:36 -0800534 if (*candidate.is_remote) {
535 verifier.TestMemberIsUndefined(candidate.network_type);
536 } else {
537 verifier.TestMemberIsDefined(candidate.network_type);
538 }
hbosdb346a72016-11-29 01:57:01 -0800539 verifier.TestMemberIsDefined(candidate.ip);
Philipp Hanckea9ba4502021-03-22 13:22:54 +0100540 verifier.TestMemberIsDefined(candidate.address);
hbos23351192017-01-02 06:52:19 -0800541 verifier.TestMemberIsNonNegative<int32_t>(candidate.port);
hbosdb346a72016-11-29 01:57:01 -0800542 verifier.TestMemberIsDefined(candidate.protocol);
543 verifier.TestMemberIsDefined(candidate.candidate_type);
hbos23351192017-01-02 06:52:19 -0800544 verifier.TestMemberIsNonNegative<int32_t>(candidate.priority);
hbosdb346a72016-11-29 01:57:01 -0800545 verifier.TestMemberIsUndefined(candidate.url);
Philipp Hancke95513752018-09-27 14:40:08 +0200546 verifier.TestMemberIsUndefined(candidate.relay_protocol);
hbosdb346a72016-11-29 01:57:01 -0800547 return verifier.ExpectAllMembersSuccessfullyTested();
548 }
549
550 bool VerifyRTCLocalIceCandidateStats(
551 const RTCLocalIceCandidateStats& local_candidate) {
552 return VerifyRTCIceCandidateStats(local_candidate);
553 }
554
555 bool VerifyRTCRemoteIceCandidateStats(
556 const RTCRemoteIceCandidateStats& remote_candidate) {
557 return VerifyRTCIceCandidateStats(remote_candidate);
558 }
559
Yves Gerey665174f2018-06-19 15:03:05 +0200560 bool VerifyRTCMediaStreamStats(const RTCMediaStreamStats& media_stream) {
hbosdb346a72016-11-29 01:57:01 -0800561 RTCStatsVerifier verifier(report_, &media_stream);
562 verifier.TestMemberIsDefined(media_stream.stream_identifier);
Yves Gerey665174f2018-06-19 15:03:05 +0200563 verifier.TestMemberIsIDReference(media_stream.track_ids,
564 RTCMediaStreamTrackStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800565 return verifier.ExpectAllMembersSuccessfullyTested();
566 }
567
568 bool VerifyRTCMediaStreamTrackStats(
569 const RTCMediaStreamTrackStats& media_stream_track) {
570 RTCStatsVerifier verifier(report_, &media_stream_track);
571 verifier.TestMemberIsDefined(media_stream_track.track_identifier);
572 verifier.TestMemberIsDefined(media_stream_track.remote_source);
573 verifier.TestMemberIsDefined(media_stream_track.ended);
574 verifier.TestMemberIsDefined(media_stream_track.detached);
hbos160e4a72017-01-17 02:53:23 -0800575 verifier.TestMemberIsDefined(media_stream_track.kind);
Guido Urdaneta67378412019-05-28 17:38:08 +0200576 RTC_DCHECK(media_stream_track.remote_source.is_defined());
hbosdb346a72016-11-29 01:57:01 -0800577 // Video or audio media stream track?
hbos160e4a72017-01-17 02:53:23 -0800578 if (*media_stream_track.kind == RTCMediaStreamTrackKind::kVideo) {
Henrik Boström646fda02019-05-22 15:49:42 +0200579 // The type of the referenced media source depends on kind.
hbos42f6d2f2017-01-20 03:56:50 -0800580 if (*media_stream_track.remote_source) {
Guido Urdaneta67378412019-05-28 17:38:08 +0200581 verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
582 verifier.TestMemberIsNonNegative<double>(
583 media_stream_track.jitter_buffer_delay);
584 verifier.TestMemberIsNonNegative<uint64_t>(
585 media_stream_track.jitter_buffer_emitted_count);
hbosfefe0762017-01-20 06:14:25 -0800586 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100587 verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
hbos42f6d2f2017-01-20 03:56:50 -0800588 verifier.TestMemberIsNonNegative<uint32_t>(
589 media_stream_track.frames_received);
hbosf64941f2017-01-20 07:39:09 -0800590 verifier.TestMemberIsNonNegative<uint32_t>(
591 media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 07:21:55 -0800592 verifier.TestMemberIsNonNegative<uint32_t>(
593 media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 16:45:42 +0100594 verifier.TestMemberIsNonNegative<uint32_t>(
595 media_stream_track.freeze_count);
596 verifier.TestMemberIsNonNegative<uint32_t>(
597 media_stream_track.pause_count);
598 verifier.TestMemberIsNonNegative<double>(
599 media_stream_track.total_freezes_duration);
600 verifier.TestMemberIsNonNegative<double>(
601 media_stream_track.total_pauses_duration);
602 verifier.TestMemberIsNonNegative<double>(
603 media_stream_track.total_frames_duration);
604 verifier.TestMemberIsNonNegative<double>(
605 media_stream_track.sum_squared_frame_durations);
hbos42f6d2f2017-01-20 03:56:50 -0800606 } else {
Guido Urdaneta67378412019-05-28 17:38:08 +0200607 verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
608 RTCVideoSourceStats::kType);
609 // Local tracks have no jitter buffer.
610 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
611 verifier.TestMemberIsUndefined(
612 media_stream_track.jitter_buffer_emitted_count);
hbosfefe0762017-01-20 06:14:25 -0800613 verifier.TestMemberIsNonNegative<uint32_t>(
614 media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100615 verifier.TestMemberIsNonNegative<uint32_t>(
616 media_stream_track.huge_frames_sent);
hbos42f6d2f2017-01-20 03:56:50 -0800617 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
hbosf64941f2017-01-20 07:39:09 -0800618 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 07:21:55 -0800619 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 16:45:42 +0100620 verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
621 verifier.TestMemberIsUndefined(media_stream_track.pause_count);
622 verifier.TestMemberIsUndefined(
623 media_stream_track.total_freezes_duration);
624 verifier.TestMemberIsUndefined(
625 media_stream_track.total_pauses_duration);
626 verifier.TestMemberIsUndefined(
627 media_stream_track.total_frames_duration);
628 verifier.TestMemberIsUndefined(
629 media_stream_track.sum_squared_frame_durations);
hbos42f6d2f2017-01-20 03:56:50 -0800630 }
Guido Urdaneta67378412019-05-28 17:38:08 +0200631 // Video-only members
632 verifier.TestMemberIsNonNegative<uint32_t>(
633 media_stream_track.frame_width);
634 verifier.TestMemberIsNonNegative<uint32_t>(
635 media_stream_track.frame_height);
636 verifier.TestMemberIsUndefined(media_stream_track.frames_per_second);
hbosdb346a72016-11-29 01:57:01 -0800637 verifier.TestMemberIsUndefined(media_stream_track.frames_corrupted);
638 verifier.TestMemberIsUndefined(media_stream_track.partial_frames_lost);
639 verifier.TestMemberIsUndefined(media_stream_track.full_frames_lost);
640 // Audio-only members should be undefined
641 verifier.TestMemberIsUndefined(media_stream_track.audio_level);
642 verifier.TestMemberIsUndefined(media_stream_track.echo_return_loss);
643 verifier.TestMemberIsUndefined(
644 media_stream_track.echo_return_loss_enhancement);
zsteine76bd3a2017-07-14 12:17:49 -0700645 verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
646 verifier.TestMemberIsUndefined(media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 17:38:08 +0200647 verifier.TestMemberIsUndefined(media_stream_track.total_samples_received);
648 verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
Henrik Boström21e99da2019-08-21 12:09:51 +0200649 verifier.TestMemberIsUndefined(
650 media_stream_track.silent_concealed_samples);
Guido Urdaneta67378412019-05-28 17:38:08 +0200651 verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
Henrik Boström21e99da2019-08-21 12:09:51 +0200652 verifier.TestMemberIsUndefined(
653 media_stream_track.inserted_samples_for_deceleration);
654 verifier.TestMemberIsUndefined(
655 media_stream_track.removed_samples_for_acceleration);
Guido Urdaneta67378412019-05-28 17:38:08 +0200656 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_flushes);
657 verifier.TestMemberIsUndefined(
658 media_stream_track.delayed_packet_outage_samples);
659 verifier.TestMemberIsUndefined(
660 media_stream_track.relative_packet_arrival_delay);
661 verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
662 verifier.TestMemberIsUndefined(
663 media_stream_track.total_interruption_duration);
Artem Titove618cc92020-03-11 11:18:54 +0100664 verifier.TestMemberIsUndefined(
665 media_stream_track.jitter_buffer_target_delay);
hbosdb346a72016-11-29 01:57:01 -0800666 } else {
Yves Gerey665174f2018-06-19 15:03:05 +0200667 RTC_DCHECK_EQ(*media_stream_track.kind, RTCMediaStreamTrackKind::kAudio);
Henrik Boström646fda02019-05-22 15:49:42 +0200668 // The type of the referenced media source depends on kind.
Guido Urdaneta67378412019-05-28 17:38:08 +0200669 if (*media_stream_track.remote_source) {
Henrik Boström646fda02019-05-22 15:49:42 +0200670 // Remote tracks don't have media source stats.
671 verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
Guido Urdaneta67378412019-05-28 17:38:08 +0200672 verifier.TestMemberIsNonNegative<double>(
673 media_stream_track.jitter_buffer_delay);
674 verifier.TestMemberIsNonNegative<uint64_t>(
675 media_stream_track.jitter_buffer_emitted_count);
Artem Titove618cc92020-03-11 11:18:54 +0100676 verifier.TestMemberIsNonNegative<double>(
677 media_stream_track.jitter_buffer_target_delay);
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200678 verifier.TestMemberIsPositive<double>(media_stream_track.audio_level);
679 verifier.TestMemberIsPositive<double>(
680 media_stream_track.total_audio_energy);
681 verifier.TestMemberIsPositive<uint64_t>(
Guido Urdaneta67378412019-05-28 17:38:08 +0200682 media_stream_track.total_samples_received);
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200683 verifier.TestMemberIsPositive<double>(
684 media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 17:38:08 +0200685 verifier.TestMemberIsNonNegative<uint64_t>(
686 media_stream_track.concealed_samples);
687 verifier.TestMemberIsNonNegative<uint64_t>(
Henrik Boström21e99da2019-08-21 12:09:51 +0200688 media_stream_track.silent_concealed_samples);
689 verifier.TestMemberIsNonNegative<uint64_t>(
Guido Urdaneta67378412019-05-28 17:38:08 +0200690 media_stream_track.concealment_events);
691 verifier.TestMemberIsNonNegative<uint64_t>(
692 media_stream_track.inserted_samples_for_deceleration);
693 verifier.TestMemberIsNonNegative<uint64_t>(
694 media_stream_track.removed_samples_for_acceleration);
695 verifier.TestMemberIsNonNegative<uint64_t>(
Guido Urdaneta67378412019-05-28 17:38:08 +0200696 media_stream_track.jitter_buffer_flushes);
697 verifier.TestMemberIsNonNegative<uint64_t>(
698 media_stream_track.delayed_packet_outage_samples);
699 verifier.TestMemberIsNonNegative<double>(
700 media_stream_track.relative_packet_arrival_delay);
701 verifier.TestMemberIsNonNegative<uint32_t>(
702 media_stream_track.interruption_count);
703 verifier.TestMemberIsNonNegative<double>(
704 media_stream_track.total_interruption_duration);
705 } else {
706 verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
707 RTCAudioSourceStats::kType);
708 // Local audio tracks have no jitter buffer.
709 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
710 verifier.TestMemberIsUndefined(
711 media_stream_track.jitter_buffer_emitted_count);
Artem Titove618cc92020-03-11 11:18:54 +0100712 verifier.TestMemberIsUndefined(
713 media_stream_track.jitter_buffer_target_delay);
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200714 verifier.TestMemberIsUndefined(media_stream_track.audio_level);
715 verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
Guido Urdaneta67378412019-05-28 17:38:08 +0200716 verifier.TestMemberIsUndefined(
717 media_stream_track.total_samples_received);
Henrik Boströmd2c336f2019-07-03 17:11:10 +0200718 verifier.TestMemberIsUndefined(
719 media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 17:38:08 +0200720 verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
Henrik Boström21e99da2019-08-21 12:09:51 +0200721 verifier.TestMemberIsUndefined(
722 media_stream_track.silent_concealed_samples);
Guido Urdaneta67378412019-05-28 17:38:08 +0200723 verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
724 verifier.TestMemberIsUndefined(
Henrik Boström21e99da2019-08-21 12:09:51 +0200725 media_stream_track.inserted_samples_for_deceleration);
726 verifier.TestMemberIsUndefined(
727 media_stream_track.removed_samples_for_acceleration);
728 verifier.TestMemberIsUndefined(
Guido Urdaneta67378412019-05-28 17:38:08 +0200729 media_stream_track.jitter_buffer_flushes);
730 verifier.TestMemberIsUndefined(
731 media_stream_track.delayed_packet_outage_samples);
732 verifier.TestMemberIsUndefined(
733 media_stream_track.relative_packet_arrival_delay);
734 verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
735 verifier.TestMemberIsUndefined(
736 media_stream_track.total_interruption_duration);
Henrik Boström646fda02019-05-22 15:49:42 +0200737 }
hbosdb346a72016-11-29 01:57:01 -0800738 // Video-only members should be undefined
739 verifier.TestMemberIsUndefined(media_stream_track.frame_width);
740 verifier.TestMemberIsUndefined(media_stream_track.frame_height);
741 verifier.TestMemberIsUndefined(media_stream_track.frames_per_second);
742 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 16:35:03 +0100743 verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
hbosdb346a72016-11-29 01:57:01 -0800744 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
745 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
746 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
747 verifier.TestMemberIsUndefined(media_stream_track.frames_corrupted);
748 verifier.TestMemberIsUndefined(media_stream_track.partial_frames_lost);
749 verifier.TestMemberIsUndefined(media_stream_track.full_frames_lost);
Sergey Silkin02371062019-01-31 16:45:42 +0100750 verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
751 verifier.TestMemberIsUndefined(media_stream_track.pause_count);
752 verifier.TestMemberIsUndefined(media_stream_track.total_freezes_duration);
753 verifier.TestMemberIsUndefined(media_stream_track.total_pauses_duration);
754 verifier.TestMemberIsUndefined(media_stream_track.total_frames_duration);
755 verifier.TestMemberIsUndefined(
756 media_stream_track.sum_squared_frame_durations);
hbosdb346a72016-11-29 01:57:01 -0800757 // Audio-only members
Artem Titov880fa812021-07-30 22:30:23 +0200758 // TODO(hbos): `echo_return_loss` and `echo_return_loss_enhancement` are
hbos2d4d6532017-01-20 04:16:41 -0800759 // flaky on msan bot (sometimes defined, sometimes undefined). Should the
760 // test run until available or is there a way to have it always be
761 // defined? crbug.com/627816
762 verifier.MarkMemberTested(media_stream_track.echo_return_loss, true);
Yves Gerey665174f2018-06-19 15:03:05 +0200763 verifier.MarkMemberTested(media_stream_track.echo_return_loss_enhancement,
764 true);
hbosdb346a72016-11-29 01:57:01 -0800765 }
766 return verifier.ExpectAllMembersSuccessfullyTested();
767 }
768
769 bool VerifyRTCPeerConnectionStats(
770 const RTCPeerConnectionStats& peer_connection) {
771 RTCStatsVerifier verifier(report_, &peer_connection);
hbos23351192017-01-02 06:52:19 -0800772 verifier.TestMemberIsNonNegative<uint32_t>(
773 peer_connection.data_channels_opened);
774 verifier.TestMemberIsNonNegative<uint32_t>(
775 peer_connection.data_channels_closed);
hbosdb346a72016-11-29 01:57:01 -0800776 return verifier.ExpectAllMembersSuccessfullyTested();
777 }
778
Yves Gerey665174f2018-06-19 15:03:05 +0200779 void VerifyRTCRTPStreamStats(const RTCRTPStreamStats& stream,
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100780 RTCStatsVerifier& verifier) {
781 verifier.TestMemberIsDefined(stream.ssrc);
782 verifier.TestMemberIsDefined(stream.kind);
Henrik Boström2f71b612021-03-23 15:18:55 +0100783 // Some legacy metrics are only defined for some of the RTP types in the
784 // hierarcy.
785 if (stream.type() == RTCInboundRTPStreamStats::kType ||
786 stream.type() == RTCOutboundRTPStreamStats::kType) {
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100787 verifier.TestMemberIsDefined(stream.media_type);
788 verifier.TestMemberIsIDReference(stream.track_id,
789 RTCMediaStreamTrackStats::kType);
Henrik Boström2f71b612021-03-23 15:18:55 +0100790 } else {
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100791 verifier.TestMemberIsUndefined(stream.media_type);
792 verifier.TestMemberIsUndefined(stream.track_id);
Henrik Boström2f71b612021-03-23 15:18:55 +0100793 }
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100794 verifier.TestMemberIsIDReference(stream.transport_id,
795 RTCTransportStats::kType);
796 verifier.TestMemberIsIDReference(stream.codec_id, RTCCodecStats::kType);
797 }
798
799 void VerifyRTCSentRTPStreamStats(const RTCSentRtpStreamStats& sent_stream,
800 RTCStatsVerifier& verifier) {
801 VerifyRTCRTPStreamStats(sent_stream, verifier);
802 verifier.TestMemberIsDefined(sent_stream.packets_sent);
803 verifier.TestMemberIsDefined(sent_stream.bytes_sent);
hbosdb346a72016-11-29 01:57:01 -0800804 }
805
806 bool VerifyRTCInboundRTPStreamStats(
807 const RTCInboundRTPStreamStats& inbound_stream) {
808 RTCStatsVerifier verifier(report_, &inbound_stream);
Minyue Li28a2c632021-07-07 15:53:38 +0200809 VerifyRTCReceivedRtpStreamStats(inbound_stream, verifier,
810 inbound_stream.media_type.is_defined() &&
811 *inbound_stream.media_type == "audio");
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100812 verifier.TestMemberIsOptionalIDReference(
813 inbound_stream.remote_id, RTCRemoteOutboundRtpStreamStats::kType);
sakal5fec1282017-02-20 06:43:58 -0800814 if (inbound_stream.media_type.is_defined() &&
815 *inbound_stream.media_type == "video") {
816 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.qp_sum);
Henrik Boström6b430862019-08-16 13:09:51 +0200817 verifier.TestMemberIsDefined(inbound_stream.decoder_implementation);
sakal5fec1282017-02-20 06:43:58 -0800818 } else {
hbosa51d4f32017-02-16 05:34:48 -0800819 verifier.TestMemberIsUndefined(inbound_stream.qp_sum);
Henrik Boström6b430862019-08-16 13:09:51 +0200820 verifier.TestMemberIsUndefined(inbound_stream.decoder_implementation);
sakal5fec1282017-02-20 06:43:58 -0800821 }
hbos23351192017-01-02 06:52:19 -0800822 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.packets_received);
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200823 if (inbound_stream.media_type.is_defined() &&
824 *inbound_stream.media_type == "audio") {
825 verifier.TestMemberIsNonNegative<uint64_t>(
826 inbound_stream.fec_packets_received);
827 verifier.TestMemberIsNonNegative<uint64_t>(
828 inbound_stream.fec_packets_discarded);
Henrik Boström4a5dab02020-01-28 11:15:35 +0100829 } else {
830 verifier.TestMemberIsUndefined(inbound_stream.fec_packets_received);
831 verifier.TestMemberIsUndefined(inbound_stream.fec_packets_discarded);
Ivo Creusen8d8ffdb2019-04-30 09:45:21 +0200832 }
hbos23351192017-01-02 06:52:19 -0800833 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.bytes_received);
Niels Möllerac0a4cb2019-10-09 15:01:33 +0200834 verifier.TestMemberIsNonNegative<uint64_t>(
835 inbound_stream.header_bytes_received);
Henrik Boström01738c62019-04-15 17:32:00 +0200836 verifier.TestMemberIsDefined(inbound_stream.last_packet_received_timestamp);
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300837 if (inbound_stream.frames_received.ValueOrDefault(0) > 0) {
838 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frame_width);
839 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frame_height);
840 } else {
841 verifier.TestMemberIsUndefined(inbound_stream.frame_width);
842 verifier.TestMemberIsUndefined(inbound_stream.frame_height);
843 }
844 if (inbound_stream.frames_per_second.is_defined()) {
845 verifier.TestMemberIsNonNegative<double>(
846 inbound_stream.frames_per_second);
847 } else {
848 verifier.TestMemberIsUndefined(inbound_stream.frames_per_second);
849 }
850 verifier.TestMemberIsUndefined(inbound_stream.frame_bit_depth);
Byoungchan Lee899b29e2021-06-29 22:09:18 +0900851 verifier.TestMemberIsNonNegative<double>(
852 inbound_stream.jitter_buffer_delay);
853 verifier.TestMemberIsNonNegative<uint64_t>(
854 inbound_stream.jitter_buffer_emitted_count);
hbosdb346a72016-11-29 01:57:01 -0800855 if (inbound_stream.media_type.is_defined() &&
856 *inbound_stream.media_type == "video") {
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300857 verifier.TestMemberIsUndefined(inbound_stream.total_samples_received);
858 verifier.TestMemberIsUndefined(inbound_stream.concealed_samples);
859 verifier.TestMemberIsUndefined(inbound_stream.silent_concealed_samples);
860 verifier.TestMemberIsUndefined(inbound_stream.concealment_events);
861 verifier.TestMemberIsUndefined(
862 inbound_stream.inserted_samples_for_deceleration);
863 verifier.TestMemberIsUndefined(
864 inbound_stream.removed_samples_for_acceleration);
865 verifier.TestMemberIsUndefined(inbound_stream.audio_level);
866 verifier.TestMemberIsUndefined(inbound_stream.total_audio_energy);
867 verifier.TestMemberIsUndefined(inbound_stream.total_samples_duration);
868 verifier.TestMemberIsNonNegative<int32_t>(inbound_stream.frames_received);
Di Wufd1e9d12021-03-09 09:25:28 -0800869 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.fir_count);
870 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.pli_count);
871 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.nack_count);
hbosdb346a72016-11-29 01:57:01 -0800872 } else {
Di Wufd1e9d12021-03-09 09:25:28 -0800873 verifier.TestMemberIsUndefined(inbound_stream.fir_count);
874 verifier.TestMemberIsUndefined(inbound_stream.pli_count);
875 verifier.TestMemberIsUndefined(inbound_stream.nack_count);
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300876 verifier.TestMemberIsPositive<uint64_t>(
877 inbound_stream.total_samples_received);
878 verifier.TestMemberIsNonNegative<uint64_t>(
879 inbound_stream.concealed_samples);
880 verifier.TestMemberIsNonNegative<uint64_t>(
881 inbound_stream.silent_concealed_samples);
882 verifier.TestMemberIsNonNegative<uint64_t>(
883 inbound_stream.concealment_events);
884 verifier.TestMemberIsNonNegative<uint64_t>(
885 inbound_stream.inserted_samples_for_deceleration);
886 verifier.TestMemberIsNonNegative<uint64_t>(
887 inbound_stream.removed_samples_for_acceleration);
888 verifier.TestMemberIsPositive<double>(inbound_stream.audio_level);
889 verifier.TestMemberIsPositive<double>(inbound_stream.total_audio_energy);
890 verifier.TestMemberIsPositive<double>(
891 inbound_stream.total_samples_duration);
892 verifier.TestMemberIsUndefined(inbound_stream.frames_received);
hbosdb346a72016-11-29 01:57:01 -0800893 }
hbosa7a9be12017-03-01 01:02:45 -0800894 verifier.TestMemberIsUndefined(inbound_stream.round_trip_time);
hbosdb346a72016-11-29 01:57:01 -0800895 verifier.TestMemberIsUndefined(inbound_stream.packets_repaired);
896 verifier.TestMemberIsUndefined(inbound_stream.burst_packets_lost);
897 verifier.TestMemberIsUndefined(inbound_stream.burst_packets_discarded);
898 verifier.TestMemberIsUndefined(inbound_stream.burst_loss_count);
899 verifier.TestMemberIsUndefined(inbound_stream.burst_discard_count);
900 verifier.TestMemberIsUndefined(inbound_stream.burst_loss_rate);
901 verifier.TestMemberIsUndefined(inbound_stream.burst_discard_rate);
902 verifier.TestMemberIsUndefined(inbound_stream.gap_loss_rate);
903 verifier.TestMemberIsUndefined(inbound_stream.gap_discard_rate);
Åsa Perssonfcf79cc2019-10-22 15:23:44 +0200904 // Test runtime too short to get an estimate (at least two RTCP sender
905 // reports need to be received).
906 verifier.MarkMemberTested(inbound_stream.estimated_playout_timestamp, true);
hbos6769c492017-01-02 08:35:13 -0800907 if (inbound_stream.media_type.is_defined() &&
908 *inbound_stream.media_type == "video") {
909 verifier.TestMemberIsDefined(inbound_stream.frames_decoded);
Rasmus Brandt2efae772019-06-27 14:29:34 +0200910 verifier.TestMemberIsDefined(inbound_stream.key_frames_decoded);
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300911 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frames_dropped);
Johannes Kronbfd343b2019-07-01 10:07:50 +0200912 verifier.TestMemberIsNonNegative<double>(
913 inbound_stream.total_decode_time);
Johannes Kron00376e12019-11-25 10:25:42 +0100914 verifier.TestMemberIsNonNegative<double>(
915 inbound_stream.total_inter_frame_delay);
916 verifier.TestMemberIsNonNegative<double>(
917 inbound_stream.total_squared_inter_frame_delay);
Henrik Boström2e069262019-04-09 13:59:31 +0200918 // The integration test is not set up to test screen share; don't require
919 // this to be present.
920 verifier.MarkMemberTested(inbound_stream.content_type, true);
hbos6769c492017-01-02 08:35:13 -0800921 } else {
922 verifier.TestMemberIsUndefined(inbound_stream.frames_decoded);
Rasmus Brandt2efae772019-06-27 14:29:34 +0200923 verifier.TestMemberIsUndefined(inbound_stream.key_frames_decoded);
Eldar Rello4e5bc9f2020-07-06 14:18:07 +0300924 verifier.TestMemberIsUndefined(inbound_stream.frames_dropped);
Johannes Kronbfd343b2019-07-01 10:07:50 +0200925 verifier.TestMemberIsUndefined(inbound_stream.total_decode_time);
Johannes Kron00376e12019-11-25 10:25:42 +0100926 verifier.TestMemberIsUndefined(inbound_stream.total_inter_frame_delay);
927 verifier.TestMemberIsUndefined(
928 inbound_stream.total_squared_inter_frame_delay);
Henrik Boström2e069262019-04-09 13:59:31 +0200929 verifier.TestMemberIsUndefined(inbound_stream.content_type);
hbos6769c492017-01-02 08:35:13 -0800930 }
hbosdb346a72016-11-29 01:57:01 -0800931 return verifier.ExpectAllMembersSuccessfullyTested();
932 }
933
934 bool VerifyRTCOutboundRTPStreamStats(
Eldar Rello9276e2c2020-06-10 17:53:39 +0300935 const RTCOutboundRTPStreamStats& outbound_stream) {
hbosdb346a72016-11-29 01:57:01 -0800936 RTCStatsVerifier verifier(report_, &outbound_stream);
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +0100937 VerifyRTCRTPStreamStats(outbound_stream, verifier);
hbos6769c492017-01-02 08:35:13 -0800938 if (outbound_stream.media_type.is_defined() &&
939 *outbound_stream.media_type == "video") {
Henrik Boström646fda02019-05-22 15:49:42 +0200940 verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
941 RTCVideoSourceStats::kType);
Di Wufd1e9d12021-03-09 09:25:28 -0800942 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.fir_count);
943 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.pli_count);
Henrik Boströma0ff50c2020-05-05 15:54:46 +0200944 if (*outbound_stream.frames_encoded > 0) {
945 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.qp_sum);
946 } else {
947 verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
948 }
hbos6769c492017-01-02 08:35:13 -0800949 } else {
Di Wufd1e9d12021-03-09 09:25:28 -0800950 verifier.TestMemberIsUndefined(outbound_stream.fir_count);
951 verifier.TestMemberIsUndefined(outbound_stream.pli_count);
Henrik Boström646fda02019-05-22 15:49:42 +0200952 verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
953 RTCAudioSourceStats::kType);
hbos6769c492017-01-02 08:35:13 -0800954 verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
955 }
Jakob Ivarssone91c9922021-07-06 09:55:43 +0200956 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.nack_count);
Henrik Boström4f40fa52019-12-19 13:27:27 +0100957 verifier.TestMemberIsOptionalIDReference(
958 outbound_stream.remote_id, RTCRemoteInboundRtpStreamStats::kType);
hbos23351192017-01-02 06:52:19 -0800959 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.packets_sent);
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200960 verifier.TestMemberIsNonNegative<uint64_t>(
961 outbound_stream.retransmitted_packets_sent);
hbos23351192017-01-02 06:52:19 -0800962 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.bytes_sent);
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200963 verifier.TestMemberIsNonNegative<uint64_t>(
Niels Möllerac0a4cb2019-10-09 15:01:33 +0200964 outbound_stream.header_bytes_sent);
965 verifier.TestMemberIsNonNegative<uint64_t>(
Henrik Boströmcf96e0f2019-04-17 13:51:53 +0200966 outbound_stream.retransmitted_bytes_sent);
hbos6769c492017-01-02 08:35:13 -0800967 if (outbound_stream.media_type.is_defined() &&
968 *outbound_stream.media_type == "video") {
969 verifier.TestMemberIsDefined(outbound_stream.frames_encoded);
Rasmus Brandt2efae772019-06-27 14:29:34 +0200970 verifier.TestMemberIsDefined(outbound_stream.key_frames_encoded);
Henrik Boströmf71362f2019-04-08 16:14:23 +0200971 verifier.TestMemberIsNonNegative<double>(
972 outbound_stream.total_encode_time);
Henrik Boström23aff9b2019-05-20 15:15:38 +0200973 verifier.TestMemberIsNonNegative<uint64_t>(
974 outbound_stream.total_encoded_bytes_target);
Henrik Boström9fe18342019-05-16 18:38:20 +0200975 verifier.TestMemberIsNonNegative<double>(
976 outbound_stream.total_packet_send_delay);
Henrik Boströmce33b6a2019-05-28 17:42:38 +0200977 verifier.TestMemberIsDefined(outbound_stream.quality_limitation_reason);
Byoungchan Lee7d235352021-05-28 21:32:04 +0900978 verifier.TestMemberIsDefined(
979 outbound_stream.quality_limitation_durations);
Evan Shrubsolecc62b162019-09-09 11:26:45 +0200980 verifier.TestMemberIsNonNegative<uint32_t>(
981 outbound_stream.quality_limitation_resolution_changes);
Henrik Boström2e069262019-04-09 13:59:31 +0200982 // The integration test is not set up to test screen share; don't require
983 // this to be present.
984 verifier.MarkMemberTested(outbound_stream.content_type, true);
Henrik Boström6b430862019-08-16 13:09:51 +0200985 verifier.TestMemberIsDefined(outbound_stream.encoder_implementation);
Eldar Rello9276e2c2020-06-10 17:53:39 +0300986 // Unless an implementation-specific amount of time has passed and at
987 // least one frame has been encoded, undefined is reported. Because it
988 // is hard to tell what is the case here, we treat FPS as optional.
989 // TODO(hbos): Update the tests to run until all implemented metrics
990 // should be populated.
991 if (outbound_stream.frames_per_second.is_defined()) {
992 verifier.TestMemberIsNonNegative<double>(
993 outbound_stream.frames_per_second);
Henrik Boströma0ff50c2020-05-05 15:54:46 +0200994 } else {
995 verifier.TestMemberIsUndefined(outbound_stream.frames_per_second);
Henrik Boströma0ff50c2020-05-05 15:54:46 +0200996 }
Eldar Rello9276e2c2020-06-10 17:53:39 +0300997 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frame_height);
998 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frame_width);
999 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frames_sent);
1000 verifier.TestMemberIsNonNegative<uint32_t>(
1001 outbound_stream.huge_frames_sent);
Jakob Ivarssonbf087452021-11-11 13:43:49 +01001002 verifier.TestMemberIsUndefined(outbound_stream.target_bitrate);
Eldar Rello9276e2c2020-06-10 17:53:39 +03001003 verifier.MarkMemberTested(outbound_stream.rid, true);
hbos6769c492017-01-02 08:35:13 -08001004 } else {
1005 verifier.TestMemberIsUndefined(outbound_stream.frames_encoded);
Rasmus Brandt2efae772019-06-27 14:29:34 +02001006 verifier.TestMemberIsUndefined(outbound_stream.key_frames_encoded);
Henrik Boströmf71362f2019-04-08 16:14:23 +02001007 verifier.TestMemberIsUndefined(outbound_stream.total_encode_time);
Henrik Boström23aff9b2019-05-20 15:15:38 +02001008 verifier.TestMemberIsUndefined(
1009 outbound_stream.total_encoded_bytes_target);
Henrik Boström9fe18342019-05-16 18:38:20 +02001010 // TODO(https://crbug.com/webrtc/10635): Implement for audio as well.
1011 verifier.TestMemberIsUndefined(outbound_stream.total_packet_send_delay);
Henrik Boströmce33b6a2019-05-28 17:42:38 +02001012 verifier.TestMemberIsUndefined(outbound_stream.quality_limitation_reason);
Evan Shrubsolecc62b162019-09-09 11:26:45 +02001013 verifier.TestMemberIsUndefined(
Byoungchan Lee7d235352021-05-28 21:32:04 +09001014 outbound_stream.quality_limitation_durations);
1015 verifier.TestMemberIsUndefined(
Evan Shrubsolecc62b162019-09-09 11:26:45 +02001016 outbound_stream.quality_limitation_resolution_changes);
Henrik Boström2e069262019-04-09 13:59:31 +02001017 verifier.TestMemberIsUndefined(outbound_stream.content_type);
Henrik Boström6b430862019-08-16 13:09:51 +02001018 // TODO(hbos): Implement for audio as well.
1019 verifier.TestMemberIsUndefined(outbound_stream.encoder_implementation);
Henrik Boströma0ff50c2020-05-05 15:54:46 +02001020 verifier.TestMemberIsUndefined(outbound_stream.rid);
1021 verifier.TestMemberIsUndefined(outbound_stream.frames_per_second);
1022 verifier.TestMemberIsUndefined(outbound_stream.frame_height);
1023 verifier.TestMemberIsUndefined(outbound_stream.frame_width);
1024 verifier.TestMemberIsUndefined(outbound_stream.frames_sent);
1025 verifier.TestMemberIsUndefined(outbound_stream.huge_frames_sent);
Jakob Ivarssonbf087452021-11-11 13:43:49 +01001026 verifier.TestMemberIsNonNegative<double>(outbound_stream.target_bitrate);
hbos6769c492017-01-02 08:35:13 -08001027 }
hbosdb346a72016-11-29 01:57:01 -08001028 return verifier.ExpectAllMembersSuccessfullyTested();
1029 }
1030
Henrik Boström2f71b612021-03-23 15:18:55 +01001031 void VerifyRTCReceivedRtpStreamStats(
1032 const RTCReceivedRtpStreamStats& received_rtp,
Minyue Li28a2c632021-07-07 15:53:38 +02001033 RTCStatsVerifier& verifier,
1034 bool packets_discarded_defined) {
Henrik Boström2f71b612021-03-23 15:18:55 +01001035 VerifyRTCRTPStreamStats(received_rtp, verifier);
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +01001036 verifier.TestMemberIsNonNegative<double>(received_rtp.jitter);
1037 verifier.TestMemberIsDefined(received_rtp.packets_lost);
Minyue Li28a2c632021-07-07 15:53:38 +02001038 if (packets_discarded_defined) {
1039 verifier.TestMemberIsNonNegative<uint64_t>(
1040 received_rtp.packets_discarded);
1041 } else {
1042 verifier.TestMemberIsUndefined(received_rtp.packets_discarded);
1043 }
Henrik Boström2f71b612021-03-23 15:18:55 +01001044 }
1045
Henrik Boström883eefc2019-05-27 13:40:25 +02001046 bool VerifyRTCRemoteInboundRtpStreamStats(
1047 const RTCRemoteInboundRtpStreamStats& remote_inbound_stream) {
1048 RTCStatsVerifier verifier(report_, &remote_inbound_stream);
Minyue Li28a2c632021-07-07 15:53:38 +02001049 VerifyRTCReceivedRtpStreamStats(remote_inbound_stream, verifier, false);
Di Wu86f04ad2021-02-28 23:36:03 -08001050 verifier.TestMemberIsDefined(remote_inbound_stream.fraction_lost);
Henrik Boström883eefc2019-05-27 13:40:25 +02001051 verifier.TestMemberIsIDReference(remote_inbound_stream.local_id,
1052 RTCOutboundRTPStreamStats::kType);
1053 verifier.TestMemberIsNonNegative<double>(
1054 remote_inbound_stream.round_trip_time);
Di Wu88a51b22021-03-01 11:22:06 -08001055 verifier.TestMemberIsNonNegative<double>(
1056 remote_inbound_stream.total_round_trip_time);
1057 verifier.TestMemberIsNonNegative<int32_t>(
1058 remote_inbound_stream.round_trip_time_measurements);
Henrik Boström883eefc2019-05-27 13:40:25 +02001059 return verifier.ExpectAllMembersSuccessfullyTested();
1060 }
1061
Alessio Bazzicaf7b1b952021-03-23 17:23:04 +01001062 bool VerifyRTCRemoteOutboundRTPStreamStats(
1063 const RTCRemoteOutboundRtpStreamStats& remote_outbound_stream) {
1064 RTCStatsVerifier verifier(report_, &remote_outbound_stream);
1065 VerifyRTCRTPStreamStats(remote_outbound_stream, verifier);
1066 VerifyRTCSentRTPStreamStats(remote_outbound_stream, verifier);
1067 verifier.TestMemberIsIDReference(remote_outbound_stream.local_id,
1068 RTCOutboundRTPStreamStats::kType);
1069 verifier.TestMemberIsNonNegative<double>(
1070 remote_outbound_stream.remote_timestamp);
1071 verifier.TestMemberIsDefined(remote_outbound_stream.reports_sent);
1072 return verifier.ExpectAllMembersSuccessfullyTested();
1073 }
1074
Henrik Boström646fda02019-05-22 15:49:42 +02001075 void VerifyRTCMediaSourceStats(const RTCMediaSourceStats& media_source,
1076 RTCStatsVerifier* verifier) {
1077 verifier->TestMemberIsDefined(media_source.track_identifier);
1078 verifier->TestMemberIsDefined(media_source.kind);
1079 if (media_source.kind.is_defined()) {
1080 EXPECT_TRUE((*media_source.kind == "audio" &&
1081 media_source.type() == RTCAudioSourceStats::kType) ||
1082 (*media_source.kind == "video" &&
1083 media_source.type() == RTCVideoSourceStats::kType));
1084 }
1085 }
1086
1087 bool VerifyRTCAudioSourceStats(const RTCAudioSourceStats& audio_source) {
1088 RTCStatsVerifier verifier(report_, &audio_source);
1089 VerifyRTCMediaSourceStats(audio_source, &verifier);
Henrik Boström262bbae2019-09-13 11:34:55 +02001090 // Audio level, unlike audio energy, only gets updated at a certain
1091 // frequency, so we don't require that one to be positive to avoid a race
1092 // (https://crbug.com/webrtc/10962).
1093 verifier.TestMemberIsNonNegative<double>(audio_source.audio_level);
Henrik Boströmd2c336f2019-07-03 17:11:10 +02001094 verifier.TestMemberIsPositive<double>(audio_source.total_audio_energy);
1095 verifier.TestMemberIsPositive<double>(audio_source.total_samples_duration);
Artem Titov880fa812021-07-30 22:30:23 +02001096 // TODO(hbos): `echo_return_loss` and `echo_return_loss_enhancement` are
Taylor Brandstetter64851c02021-06-24 13:32:50 -07001097 // flaky on msan bot (sometimes defined, sometimes undefined). Should the
1098 // test run until available or is there a way to have it always be
1099 // defined? crbug.com/627816
1100 verifier.MarkMemberTested(audio_source.echo_return_loss, true);
1101 verifier.MarkMemberTested(audio_source.echo_return_loss_enhancement, true);
Henrik Boström646fda02019-05-22 15:49:42 +02001102 return verifier.ExpectAllMembersSuccessfullyTested();
1103 }
1104
1105 bool VerifyRTCVideoSourceStats(const RTCVideoSourceStats& video_source) {
1106 RTCStatsVerifier verifier(report_, &video_source);
1107 VerifyRTCMediaSourceStats(video_source, &verifier);
1108 // TODO(hbos): This integration test uses fakes that doesn't support
1109 // VideoTrackSourceInterface::Stats. When this is fixed we should
Artem Titov880fa812021-07-30 22:30:23 +02001110 // TestMemberIsNonNegative<uint32_t>() for `width` and `height` instead to
Henrik Boström646fda02019-05-22 15:49:42 +02001111 // reflect real code.
1112 verifier.TestMemberIsUndefined(video_source.width);
1113 verifier.TestMemberIsUndefined(video_source.height);
Di Wu668dbf62021-02-27 00:29:15 -08001114 verifier.TestMemberIsNonNegative<uint32_t>(video_source.frames);
Byoungchan Leeefe46b62021-11-10 11:23:56 +09001115 verifier.TestMemberIsNonNegative<double>(video_source.frames_per_second);
Henrik Boström646fda02019-05-22 15:49:42 +02001116 return verifier.ExpectAllMembersSuccessfullyTested();
1117 }
1118
Yves Gerey665174f2018-06-19 15:03:05 +02001119 bool VerifyRTCTransportStats(const RTCTransportStats& transport) {
hbosdb346a72016-11-29 01:57:01 -08001120 RTCStatsVerifier verifier(report_, &transport);
hbos23351192017-01-02 06:52:19 -08001121 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_sent);
Artem Titovedacbd52020-07-06 16:06:37 +02001122 verifier.TestMemberIsNonNegative<uint64_t>(transport.packets_sent);
hbos23351192017-01-02 06:52:19 -08001123 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_received);
Artem Titovedacbd52020-07-06 16:06:37 +02001124 verifier.TestMemberIsNonNegative<uint64_t>(transport.packets_received);
Yves Gerey665174f2018-06-19 15:03:05 +02001125 verifier.TestMemberIsOptionalIDReference(transport.rtcp_transport_stats_id,
1126 RTCTransportStats::kType);
hbos7064d592017-01-16 07:38:02 -08001127 verifier.TestMemberIsDefined(transport.dtls_state);
Yves Gerey665174f2018-06-19 15:03:05 +02001128 verifier.TestMemberIsIDReference(transport.selected_candidate_pair_id,
1129 RTCIceCandidatePairStats::kType);
1130 verifier.TestMemberIsIDReference(transport.local_certificate_id,
1131 RTCCertificateStats::kType);
1132 verifier.TestMemberIsIDReference(transport.remote_certificate_id,
1133 RTCCertificateStats::kType);
Harald Alvestrand5cb78072019-10-28 09:51:17 +01001134 verifier.TestMemberIsDefined(transport.tls_version);
1135 verifier.TestMemberIsDefined(transport.dtls_cipher);
1136 verifier.TestMemberIsDefined(transport.srtp_cipher);
Jonas Oreland149dc722019-08-28 08:10:27 +02001137 verifier.TestMemberIsPositive<uint32_t>(
1138 transport.selected_candidate_pair_changes);
hbosdb346a72016-11-29 01:57:01 -08001139 return verifier.ExpectAllMembersSuccessfullyTested();
1140 }
1141
1142 private:
1143 rtc::scoped_refptr<const RTCStatsReport> report_;
1144};
1145
Mirko Bonadei5eb43b42021-01-18 13:24:40 +01001146#ifdef WEBRTC_HAVE_SCTP
hbosdb346a72016-11-29 01:57:01 -08001147TEST_F(RTCStatsIntegrationTest, GetStatsFromCaller) {
1148 StartCall();
1149
1150 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCaller();
Eldar Rello9276e2c2020-06-10 17:53:39 +03001151 RTCStatsReportVerifier(report.get()).VerifyReport({});
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001152
Henrik Boströma0ff50c2020-05-05 15:54:46 +02001153#if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 14:35:04 -07001154 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001155 #endif
hbosdb346a72016-11-29 01:57:01 -08001156}
1157
1158TEST_F(RTCStatsIntegrationTest, GetStatsFromCallee) {
1159 StartCall();
1160
1161 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
Eldar Rello9276e2c2020-06-10 17:53:39 +03001162 RTCStatsReportVerifier(report.get()).VerifyReport({});
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001163
Henrik Boströma0ff50c2020-05-05 15:54:46 +02001164#if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 14:35:04 -07001165 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001166 #endif
hbosdb346a72016-11-29 01:57:01 -08001167}
1168
Henrik Boström1df1bf82018-03-20 13:24:20 +01001169// These tests exercise the integration of the stats selection algorithm inside
1170// of PeerConnection. See rtcstatstraveral_unittest.cc for more detailed stats
1171// traversal tests on particular stats graphs.
1172TEST_F(RTCStatsIntegrationTest, GetStatsWithSenderSelector) {
1173 StartCall();
1174 ASSERT_FALSE(caller_->pc()->GetSenders().empty());
1175 rtc::scoped_refptr<const RTCStatsReport> report =
1176 GetStatsFromCaller(caller_->pc()->GetSenders()[0]);
1177 std::vector<const char*> allowed_missing_stats = {
1178 // TODO(hbos): Include RTC[Audio/Video]ReceiverStats when implemented.
1179 // TODO(hbos): Include RTCRemoteOutboundRtpStreamStats when implemented.
1180 // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
Jonas Olssona4d87372019-07-05 19:08:33 +02001181 RTCInboundRTPStreamStats::kType,
1182 RTCPeerConnectionStats::kType,
1183 RTCMediaStreamStats::kType,
1184 RTCDataChannelStats::kType,
Henrik Boström1df1bf82018-03-20 13:24:20 +01001185 };
Eldar Rello9276e2c2020-06-10 17:53:39 +03001186 RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
Henrik Boström1df1bf82018-03-20 13:24:20 +01001187 EXPECT_TRUE(report->size());
1188}
1189
1190TEST_F(RTCStatsIntegrationTest, GetStatsWithReceiverSelector) {
1191 StartCall();
1192
1193 ASSERT_FALSE(caller_->pc()->GetReceivers().empty());
1194 rtc::scoped_refptr<const RTCStatsReport> report =
1195 GetStatsFromCaller(caller_->pc()->GetReceivers()[0]);
1196 std::vector<const char*> allowed_missing_stats = {
1197 // TODO(hbos): Include RTC[Audio/Video]SenderStats when implemented.
1198 // TODO(hbos): Include RTCRemoteInboundRtpStreamStats when implemented.
1199 // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
Jonas Olssona4d87372019-07-05 19:08:33 +02001200 RTCOutboundRTPStreamStats::kType,
1201 RTCPeerConnectionStats::kType,
1202 RTCMediaStreamStats::kType,
1203 RTCDataChannelStats::kType,
Henrik Boström1df1bf82018-03-20 13:24:20 +01001204 };
Eldar Rello9276e2c2020-06-10 17:53:39 +03001205 RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
Henrik Boström1df1bf82018-03-20 13:24:20 +01001206 EXPECT_TRUE(report->size());
1207}
1208
1209TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidSenderSelector) {
1210 StartCall();
1211
1212 ASSERT_FALSE(callee_->pc()->GetSenders().empty());
1213 // The selector is invalid for the caller because it belongs to the callee.
1214 auto invalid_selector = callee_->pc()->GetSenders()[0];
1215 rtc::scoped_refptr<const RTCStatsReport> report =
1216 GetStatsFromCaller(invalid_selector);
1217 EXPECT_FALSE(report->size());
1218}
1219
1220TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidReceiverSelector) {
1221 StartCall();
1222
1223 ASSERT_FALSE(callee_->pc()->GetReceivers().empty());
1224 // The selector is invalid for the caller because it belongs to the callee.
1225 auto invalid_selector = callee_->pc()->GetReceivers()[0];
1226 rtc::scoped_refptr<const RTCStatsReport> report =
1227 GetStatsFromCaller(invalid_selector);
1228 EXPECT_FALSE(report->size());
1229}
1230
Yves Gerey59cfd352018-11-26 16:22:20 +01001231// TODO(bugs.webrtc.org/10041) For now this is equivalent to the following
1232// test GetsStatsWhileClosingPeerConnection, because pc() is closed by
1233// PeerConnectionTestWrapper. See: bugs.webrtc.org/9847
Yves Gereyb5bb5132018-11-14 18:00:14 +01001234TEST_F(RTCStatsIntegrationTest,
Yves Gerey59cfd352018-11-26 16:22:20 +01001235 DISABLED_GetStatsWhileDestroyingPeerConnection) {
hbosb78306a2016-12-19 05:06:57 -08001236 StartCall();
1237
1238 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1239 RTCStatsObtainer::Create();
1240 caller_->pc()->GetStats(stats_obtainer);
1241 // This will destroy the peer connection.
1242 caller_ = nullptr;
1243 // Any pending stats requests should have completed in the act of destroying
1244 // the peer connection.
Steve Anton25cfeb92018-04-26 11:44:00 -07001245 ASSERT_TRUE(stats_obtainer->report());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001246 #if RTC_TRACE_EVENTS_ENABLED
Steve Anton25cfeb92018-04-26 11:44:00 -07001247 EXPECT_EQ(stats_obtainer->report()->ToJson(),
1248 RTCStatsReportTraceListener::last_trace());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001249 #endif
Steve Anton25cfeb92018-04-26 11:44:00 -07001250}
1251
1252TEST_F(RTCStatsIntegrationTest, GetsStatsWhileClosingPeerConnection) {
1253 StartCall();
1254
1255 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1256 RTCStatsObtainer::Create();
1257 caller_->pc()->GetStats(stats_obtainer);
1258 caller_->pc()->Close();
1259
1260 ASSERT_TRUE(stats_obtainer->report());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001261 #if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 14:35:04 -07001262 EXPECT_EQ(stats_obtainer->report()->ToJson(),
1263 RTCStatsReportTraceListener::last_trace());
Doudou Kisabaka2dec4962019-11-28 14:24:31 +01001264 #endif
hbosb78306a2016-12-19 05:06:57 -08001265}
Henrik Boströmb6199362018-03-12 10:27:55 +01001266
1267// GetStatsReferencedIds() is optimized to recognize what is or isn't a
1268// referenced ID based on dictionary type information and knowing what members
1269// are used as references, as opposed to iterating all members to find the ones
1270// with the "Id" or "Ids" suffix. As such, GetStatsReferencedIds() is tested as
1271// an integration test instead of a unit test in order to guard against adding
1272// new references and forgetting to update GetStatsReferencedIds().
1273TEST_F(RTCStatsIntegrationTest, GetStatsReferencedIds) {
1274 StartCall();
1275
1276 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1277 for (const RTCStats& stats : *report) {
1278 // Find all references by looking at all string members with the "Id" or
1279 // "Ids" suffix.
1280 std::set<const std::string*> expected_ids;
1281 for (const auto* member : stats.Members()) {
1282 if (!member->is_defined())
1283 continue;
1284 if (member->type() == RTCStatsMemberInterface::kString) {
Steve Anton68586e82018-12-13 17:41:25 -08001285 if (absl::EndsWith(member->name(), "Id")) {
Henrik Boströmb6199362018-03-12 10:27:55 +01001286 const auto& id = member->cast_to<const RTCStatsMember<std::string>>();
1287 expected_ids.insert(&(*id));
1288 }
1289 } else if (member->type() == RTCStatsMemberInterface::kSequenceString) {
Steve Anton68586e82018-12-13 17:41:25 -08001290 if (absl::EndsWith(member->name(), "Ids")) {
Henrik Boströmb6199362018-03-12 10:27:55 +01001291 const auto& ids =
1292 member->cast_to<const RTCStatsMember<std::vector<std::string>>>();
1293 for (const std::string& id : *ids)
1294 expected_ids.insert(&id);
1295 }
1296 }
1297 }
1298
1299 std::vector<const std::string*> neighbor_ids = GetStatsReferencedIds(stats);
1300 EXPECT_EQ(neighbor_ids.size(), expected_ids.size());
1301 for (const std::string* neighbor_id : neighbor_ids) {
Steve Anton64b626b2019-01-28 17:25:26 -08001302 EXPECT_THAT(expected_ids, Contains(neighbor_id));
Henrik Boströmb6199362018-03-12 10:27:55 +01001303 }
1304 for (const std::string* expected_id : expected_ids) {
Steve Anton64b626b2019-01-28 17:25:26 -08001305 EXPECT_THAT(neighbor_ids, Contains(expected_id));
Henrik Boströmb6199362018-03-12 10:27:55 +01001306 }
1307 }
1308}
Henrik Boström943ad972021-04-08 09:30:05 +02001309
1310TEST_F(RTCStatsIntegrationTest, GetStatsContainsNoDuplicateMembers) {
1311 StartCall();
1312
1313 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1314 for (const RTCStats& stats : *report) {
1315 std::set<std::string> member_names;
1316 for (const auto* member : stats.Members()) {
1317 EXPECT_TRUE(member_names.find(member->name()) == member_names.end())
1318 << member->name() << " is a duplicate!";
1319 member_names.insert(member->name());
1320 }
1321 }
1322}
Mirko Bonadei5eb43b42021-01-18 13:24:40 +01001323#endif // WEBRTC_HAVE_SCTP
hbosb78306a2016-12-19 05:06:57 -08001324
hbosdb346a72016-11-29 01:57:01 -08001325} // namespace
1326
1327} // namespace webrtc