blob: 61251379e4c26a88a2dfa3923ed3bed367d5b1a6 [file] [log] [blame]
hbosdb346a72016-11-29 09:57:011/*
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 15:47:4911#include <stdint.h>
12#include <string.h>
Jonas Olssona4d87372019-07-05 17:08:3313
Yves Gerey3e707812018-11-28 15:47:4914#include <memory>
hbosdb346a72016-11-29 09:57:0115#include <set>
Yves Gerey3e707812018-11-28 15:47:4916#include <string>
hbosdb346a72016-11-29 09:57:0117#include <vector>
18
Steve Anton64b626b2019-01-29 01:25:2619#include "absl/algorithm/container.h"
Steve Anton68586e82018-12-14 01:41:2520#include "absl/strings/match.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3121#include "api/audio_codecs/builtin_audio_decoder_factory.h"
22#include "api/audio_codecs/builtin_audio_encoder_factory.h"
Yves Gerey3e707812018-11-28 15:47:4923#include "api/audio_options.h"
Steve Anton10542f22019-01-11 17:11:0024#include "api/data_channel_interface.h"
25#include "api/peer_connection_interface.h"
26#include "api/rtp_receiver_interface.h"
27#include "api/rtp_sender_interface.h"
Mirko Bonadeid9708072019-01-25 19:26:4828#include "api/scoped_refptr.h"
Steve Anton10542f22019-01-11 17:11:0029#include "api/stats/rtc_stats.h"
30#include "api/stats/rtc_stats_report.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3131#include "api/stats/rtcstats_objects.h"
Steve Anton10542f22019-01-11 17:11:0032#include "pc/rtc_stats_traversal.h"
33#include "pc/test/peer_connection_test_wrapper.h"
34#include "pc/test/rtc_stats_obtainer.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3135#include "rtc_base/checks.h"
36#include "rtc_base/event_tracer.h"
37#include "rtc_base/gunit.h"
Yves Gerey3e707812018-11-28 15:47:4938#include "rtc_base/thread.h"
Mirko Bonadei92ea95e2017-09-15 04:47:3139#include "rtc_base/trace_event.h"
Steve Anton10542f22019-01-11 17:11:0040#include "rtc_base/virtual_socket_server.h"
Steve Anton64b626b2019-01-29 01:25:2641#include "test/gmock.h"
Yves Gerey3e707812018-11-28 15:47:4942#include "test/gtest.h"
hbosdb346a72016-11-29 09:57:0143
Steve Anton64b626b2019-01-29 01:25:2644using ::testing::Contains;
45
hbosdb346a72016-11-29 09:57:0146namespace webrtc {
47
48namespace {
49
50const int64_t kGetStatsTimeoutMs = 10000;
51
ehmaldonado80c829f2017-07-18 14:35:1952const unsigned char* GetCategoryEnabledHandler(const char* name) {
ehmaldonado8ab0fd82017-09-04 21:35:0453 if (strcmp("webrtc_stats", name) != 0) {
54 return reinterpret_cast<const unsigned char*>("");
55 }
56 return reinterpret_cast<const unsigned char*>(name);
ehmaldonado80c829f2017-07-18 14:35:1957}
58
ehmaldonado8ab0fd82017-09-04 21:35:0459class RTCStatsReportTraceListener {
60 public:
61 static void SetUp() {
62 if (!traced_report_)
63 traced_report_ = new RTCStatsReportTraceListener();
64 traced_report_->last_trace_ = "";
65 SetupEventTracer(&GetCategoryEnabledHandler,
66 &RTCStatsReportTraceListener::AddTraceEventHandler);
67 }
68
69 static const std::string& last_trace() {
70 RTC_DCHECK(traced_report_);
71 return traced_report_->last_trace_;
72 }
73
74 private:
Steve Anton36b29d12017-10-30 16:57:4275 static void AddTraceEventHandler(
76 char phase,
77 const unsigned char* category_enabled,
78 const char* name,
79 unsigned long long id, // NOLINT(runtime/int)
80 int num_args,
81 const char** arg_names,
82 const unsigned char* arg_types,
83 const unsigned long long* arg_values, // NOLINT(runtime/int)
84 unsigned char flags) {
ehmaldonado8ab0fd82017-09-04 21:35:0485 RTC_DCHECK(traced_report_);
86 EXPECT_STREQ("webrtc_stats",
87 reinterpret_cast<const char*>(category_enabled));
88 EXPECT_STREQ("webrtc_stats", name);
89 EXPECT_EQ(1, num_args);
90 EXPECT_STREQ("report", arg_names[0]);
91 EXPECT_EQ(TRACE_VALUE_TYPE_COPY_STRING, arg_types[0]);
92
93 traced_report_->last_trace_ = reinterpret_cast<const char*>(arg_values[0]);
94 }
95
96 static RTCStatsReportTraceListener* traced_report_;
97 std::string last_trace_;
98};
99
100RTCStatsReportTraceListener* RTCStatsReportTraceListener::traced_report_ =
101 nullptr;
ehmaldonado80c829f2017-07-18 14:35:19102
Mirko Bonadei6a489f22019-04-09 13:11:12103class RTCStatsIntegrationTest : public ::testing::Test {
hbosdb346a72016-11-29 09:57:01104 public:
105 RTCStatsIntegrationTest()
tommie7251592017-07-14 21:44:46106 : network_thread_(new rtc::Thread(&virtual_socket_server_)),
107 worker_thread_(rtc::Thread::Create()) {
ehmaldonado8ab0fd82017-09-04 21:35:04108 RTCStatsReportTraceListener::SetUp();
ehmaldonado80c829f2017-07-18 14:35:19109
tommie7251592017-07-14 21:44:46110 RTC_CHECK(network_thread_->Start());
111 RTC_CHECK(worker_thread_->Start());
hbosdb346a72016-11-29 09:57:01112
Tommi87f70902021-04-27 12:43:08113 caller_ = rtc::make_ref_counted<PeerConnectionTestWrapper>(
tommie7251592017-07-14 21:44:46114 "caller", network_thread_.get(), worker_thread_.get());
Tommi87f70902021-04-27 12:43:08115 callee_ = rtc::make_ref_counted<PeerConnectionTestWrapper>(
tommie7251592017-07-14 21:44:46116 "callee", network_thread_.get(), worker_thread_.get());
hbosdb346a72016-11-29 09:57:01117 }
118
119 void StartCall() {
120 // Create PeerConnections and "connect" sigslots
121 PeerConnectionInterface::RTCConfiguration config;
Henrik Boström62995db2022-01-03 08:58:10122 config.sdp_semantics = SdpSemantics::kUnifiedPlan;
hbosdb346a72016-11-29 09:57:01123 PeerConnectionInterface::IceServer ice_server;
124 ice_server.uri = "stun:1.1.1.1:3478";
125 config.servers.push_back(ice_server);
Niels Möllerf06f9232018-08-07 10:32:18126 EXPECT_TRUE(caller_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
kwiberg9e5b11e2017-04-19 10:47:57127 CreateBuiltinAudioDecoderFactory()));
Niels Möllerf06f9232018-08-07 10:32:18128 EXPECT_TRUE(callee_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
kwiberg9e5b11e2017-04-19 10:47:57129 CreateBuiltinAudioDecoderFactory()));
hbosdb346a72016-11-29 09:57:01130 PeerConnectionTestWrapper::Connect(caller_.get(), callee_.get());
131
132 // Get user media for audio and video
Niels Möller5c4ddad2019-02-12 11:30:58133 caller_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
134 callee_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
hbosdb346a72016-11-29 09:57:01135
136 // Create data channels
137 DataChannelInit init;
138 caller_->CreateDataChannel("data", init);
139 callee_->CreateDataChannel("data", init);
140
141 // Negotiate and wait for call to establish
Niels Möllerf06f9232018-08-07 10:32:18142 caller_->CreateOffer(PeerConnectionInterface::RTCOfferAnswerOptions());
hbosdb346a72016-11-29 09:57:01143 caller_->WaitForCallEstablished();
144 callee_->WaitForCallEstablished();
145 }
146
147 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller() {
148 return GetStats(caller_->pc());
149 }
Henrik Boström1df1bf82018-03-20 12:24:20150 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
151 rtc::scoped_refptr<RtpSenderInterface> selector) {
152 return GetStats(caller_->pc(), selector);
153 }
154 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
155 rtc::scoped_refptr<RtpReceiverInterface> selector) {
156 return GetStats(caller_->pc(), selector);
157 }
hbosdb346a72016-11-29 09:57:01158
159 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee() {
160 return GetStats(callee_->pc());
161 }
Henrik Boström1df1bf82018-03-20 12:24:20162 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
163 rtc::scoped_refptr<RtpSenderInterface> selector) {
164 return GetStats(callee_->pc(), selector);
165 }
166 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
167 rtc::scoped_refptr<RtpReceiverInterface> selector) {
168 return GetStats(callee_->pc(), selector);
169 }
hbosdb346a72016-11-29 09:57:01170
171 protected:
172 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
173 PeerConnectionInterface* pc) {
174 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
175 RTCStatsObtainer::Create();
Niels Möllerafb246b2022-04-20 12:26:50176 pc->GetStats(stats_obtainer.get());
177 EXPECT_TRUE_WAIT(stats_obtainer->report() != nullptr, kGetStatsTimeoutMs);
hbosdb346a72016-11-29 09:57:01178 return stats_obtainer->report();
179 }
180
Henrik Boström1df1bf82018-03-20 12:24:20181 template <typename T>
182 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
183 PeerConnectionInterface* pc,
184 rtc::scoped_refptr<T> selector) {
185 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
186 RTCStatsObtainer::Create();
187 pc->GetStats(selector, stats_obtainer);
Niels Möllerafb246b2022-04-20 12:26:50188 EXPECT_TRUE_WAIT(stats_obtainer->report() != nullptr, kGetStatsTimeoutMs);
Henrik Boström1df1bf82018-03-20 12:24:20189 return stats_obtainer->report();
190 }
191
Artem Titov880fa812021-07-30 20:30:23192 // `network_thread_` uses `virtual_socket_server_` so they must be
deadbeef98e186c2017-05-17 01:00:06193 // constructed/destructed in the correct order.
hbosdb346a72016-11-29 09:57:01194 rtc::VirtualSocketServer virtual_socket_server_;
tommie7251592017-07-14 21:44:46195 std::unique_ptr<rtc::Thread> network_thread_;
196 std::unique_ptr<rtc::Thread> worker_thread_;
hbosdb346a72016-11-29 09:57:01197 rtc::scoped_refptr<PeerConnectionTestWrapper> caller_;
198 rtc::scoped_refptr<PeerConnectionTestWrapper> callee_;
199};
200
201class RTCStatsVerifier {
202 public:
203 RTCStatsVerifier(const RTCStatsReport* report, const RTCStats* stats)
204 : report_(report), stats_(stats), all_tests_successful_(true) {
205 RTC_CHECK(report_);
206 RTC_CHECK(stats_);
207 for (const RTCStatsMemberInterface* member : stats_->Members()) {
208 untested_members_.insert(member);
209 }
210 }
211
Yves Gerey665174f2018-06-19 13:03:05212 void MarkMemberTested(const RTCStatsMemberInterface& member,
213 bool test_successful) {
hbosdb346a72016-11-29 09:57:01214 untested_members_.erase(&member);
215 all_tests_successful_ &= test_successful;
216 }
217
218 void TestMemberIsDefined(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 13:03:05219 EXPECT_TRUE(member.is_defined())
220 << stats_->type() << "." << member.name() << "[" << stats_->id()
221 << "] was undefined.";
hbosdb346a72016-11-29 09:57:01222 MarkMemberTested(member, member.is_defined());
223 }
224
225 void TestMemberIsUndefined(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 13:03:05226 EXPECT_FALSE(member.is_defined())
227 << stats_->type() << "." << member.name() << "[" << stats_->id()
228 << "] was defined (" << member.ValueToString() << ").";
hbosdb346a72016-11-29 09:57:01229 MarkMemberTested(member, !member.is_defined());
230 }
231
Yves Gerey665174f2018-06-19 13:03:05232 template <typename T>
hbos23351192017-01-02 14:52:19233 void TestMemberIsPositive(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 13:03:05234 EXPECT_TRUE(member.is_defined())
235 << stats_->type() << "." << member.name() << "[" << stats_->id()
236 << "] was undefined.";
hbos23351192017-01-02 14:52:19237 if (!member.is_defined()) {
238 MarkMemberTested(member, false);
239 return;
240 }
241 bool is_positive = *member.cast_to<RTCStatsMember<T>>() > T(0);
Yves Gerey665174f2018-06-19 13:03:05242 EXPECT_TRUE(is_positive)
243 << stats_->type() << "." << member.name() << "[" << stats_->id()
244 << "] was not positive (" << member.ValueToString() << ").";
hbos23351192017-01-02 14:52:19245 MarkMemberTested(member, is_positive);
246 }
247
Yves Gerey665174f2018-06-19 13:03:05248 template <typename T>
hbos23351192017-01-02 14:52:19249 void TestMemberIsNonNegative(const RTCStatsMemberInterface& member) {
Yves Gerey665174f2018-06-19 13:03:05250 EXPECT_TRUE(member.is_defined())
251 << stats_->type() << "." << member.name() << "[" << stats_->id()
252 << "] was undefined.";
hbos23351192017-01-02 14:52:19253 if (!member.is_defined()) {
254 MarkMemberTested(member, false);
255 return;
256 }
257 bool is_non_negative = *member.cast_to<RTCStatsMember<T>>() >= T(0);
Yves Gerey665174f2018-06-19 13:03:05258 EXPECT_TRUE(is_non_negative)
259 << stats_->type() << "." << member.name() << "[" << stats_->id()
260 << "] was not non-negative (" << member.ValueToString() << ").";
hbos23351192017-01-02 14:52:19261 MarkMemberTested(member, is_non_negative);
262 }
263
Yves Gerey665174f2018-06-19 13:03:05264 void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
265 const char* expected_type) {
hbosdb346a72016-11-29 09:57:01266 TestMemberIsIDReference(member, expected_type, false);
267 }
268
Yves Gerey665174f2018-06-19 13:03:05269 void TestMemberIsOptionalIDReference(const RTCStatsMemberInterface& member,
270 const char* expected_type) {
hbosdb346a72016-11-29 09:57:01271 TestMemberIsIDReference(member, expected_type, true);
272 }
273
274 bool ExpectAllMembersSuccessfullyTested() {
275 if (untested_members_.empty())
276 return all_tests_successful_;
277 for (const RTCStatsMemberInterface* member : untested_members_) {
Yves Gerey665174f2018-06-19 13:03:05278 EXPECT_TRUE(false) << stats_->type() << "." << member->name() << "["
279 << stats_->id() << "] was not tested.";
hbosdb346a72016-11-29 09:57:01280 }
281 return false;
282 }
283
284 private:
Yves Gerey665174f2018-06-19 13:03:05285 void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
286 const char* expected_type,
287 bool optional) {
hbosdb346a72016-11-29 09:57:01288 if (optional && !member.is_defined()) {
289 MarkMemberTested(member, true);
290 return;
291 }
292 bool valid_reference = false;
293 if (member.is_defined()) {
294 if (member.type() == RTCStatsMemberInterface::kString) {
295 // A single ID.
296 const RTCStatsMember<std::string>& id =
297 member.cast_to<RTCStatsMember<std::string>>();
298 const RTCStats* referenced_stats = report_->Get(*id);
299 valid_reference =
300 referenced_stats && referenced_stats->type() == expected_type;
301 } else if (member.type() == RTCStatsMemberInterface::kSequenceString) {
302 // A vector of IDs.
303 valid_reference = true;
304 const RTCStatsMember<std::vector<std::string>>& ids =
305 member.cast_to<RTCStatsMember<std::vector<std::string>>>();
Mirko Bonadeic61ce0d2017-11-21 16:04:20306 for (const std::string& id : *ids) {
hbosdb346a72016-11-29 09:57:01307 const RTCStats* referenced_stats = report_->Get(id);
308 if (!referenced_stats || referenced_stats->type() != expected_type) {
309 valid_reference = false;
310 break;
311 }
312 }
313 }
314 }
Yves Gerey665174f2018-06-19 13:03:05315 EXPECT_TRUE(valid_reference)
316 << stats_->type() << "." << member.name()
317 << " is not a reference to an "
Jonas Olssonb2b20312020-01-14 11:11:31318 "existing dictionary of type "
319 << expected_type << " (value: "
Henrik Boström646fda02019-05-22 13:49:42320 << (member.is_defined() ? member.ValueToString() : "null") << ").";
hbosdb346a72016-11-29 09:57:01321 MarkMemberTested(member, valid_reference);
322 }
323
324 rtc::scoped_refptr<const RTCStatsReport> report_;
325 const RTCStats* stats_;
326 std::set<const RTCStatsMemberInterface*> untested_members_;
327 bool all_tests_successful_;
328};
329
330class RTCStatsReportVerifier {
331 public:
332 static std::set<const char*> StatsTypes() {
333 std::set<const char*> stats_types;
334 stats_types.insert(RTCCertificateStats::kType);
335 stats_types.insert(RTCCodecStats::kType);
336 stats_types.insert(RTCDataChannelStats::kType);
337 stats_types.insert(RTCIceCandidatePairStats::kType);
338 stats_types.insert(RTCLocalIceCandidateStats::kType);
339 stats_types.insert(RTCRemoteIceCandidateStats::kType);
340 stats_types.insert(RTCMediaStreamStats::kType);
341 stats_types.insert(RTCMediaStreamTrackStats::kType);
342 stats_types.insert(RTCPeerConnectionStats::kType);
343 stats_types.insert(RTCInboundRTPStreamStats::kType);
344 stats_types.insert(RTCOutboundRTPStreamStats::kType);
345 stats_types.insert(RTCTransportStats::kType);
346 return stats_types;
347 }
348
349 explicit RTCStatsReportVerifier(const RTCStatsReport* report)
Yves Gerey665174f2018-06-19 13:03:05350 : report_(report) {}
hbosdb346a72016-11-29 09:57:01351
Eldar Rello9276e2c2020-06-10 14:53:39352 void VerifyReport(std::vector<const char*> allowed_missing_stats) {
hbosdb346a72016-11-29 09:57:01353 std::set<const char*> missing_stats = StatsTypes();
354 bool verify_successful = true;
hbos338f78a2017-02-07 14:41:21355 std::vector<const RTCTransportStats*> transport_stats =
356 report_->GetStatsOfType<RTCTransportStats>();
Mirko Bonadeie12c1fe2018-07-03 10:53:23357 EXPECT_EQ(transport_stats.size(), 1U);
hbos338f78a2017-02-07 14:41:21358 std::string selected_candidate_pair_id =
359 *transport_stats[0]->selected_candidate_pair_id;
hbosdb346a72016-11-29 09:57:01360 for (const RTCStats& stats : *report_) {
361 missing_stats.erase(stats.type());
362 if (stats.type() == RTCCertificateStats::kType) {
Yves Gerey665174f2018-06-19 13:03:05363 verify_successful &=
364 VerifyRTCCertificateStats(stats.cast_to<RTCCertificateStats>());
hbosdb346a72016-11-29 09:57:01365 } else if (stats.type() == RTCCodecStats::kType) {
Yves Gerey665174f2018-06-19 13:03:05366 verify_successful &=
367 VerifyRTCCodecStats(stats.cast_to<RTCCodecStats>());
hbosdb346a72016-11-29 09:57:01368 } else if (stats.type() == RTCDataChannelStats::kType) {
Yves Gerey665174f2018-06-19 13:03:05369 verify_successful &=
370 VerifyRTCDataChannelStats(stats.cast_to<RTCDataChannelStats>());
hbosdb346a72016-11-29 09:57:01371 } else if (stats.type() == RTCIceCandidatePairStats::kType) {
372 verify_successful &= VerifyRTCIceCandidatePairStats(
hbos338f78a2017-02-07 14:41:21373 stats.cast_to<RTCIceCandidatePairStats>(),
374 stats.id() == selected_candidate_pair_id);
hbosdb346a72016-11-29 09:57:01375 } else if (stats.type() == RTCLocalIceCandidateStats::kType) {
376 verify_successful &= VerifyRTCLocalIceCandidateStats(
377 stats.cast_to<RTCLocalIceCandidateStats>());
378 } else if (stats.type() == RTCRemoteIceCandidateStats::kType) {
379 verify_successful &= VerifyRTCRemoteIceCandidateStats(
380 stats.cast_to<RTCRemoteIceCandidateStats>());
381 } else if (stats.type() == RTCMediaStreamStats::kType) {
Yves Gerey665174f2018-06-19 13:03:05382 verify_successful &=
383 VerifyRTCMediaStreamStats(stats.cast_to<RTCMediaStreamStats>());
hbosdb346a72016-11-29 09:57:01384 } else if (stats.type() == RTCMediaStreamTrackStats::kType) {
385 verify_successful &= VerifyRTCMediaStreamTrackStats(
386 stats.cast_to<RTCMediaStreamTrackStats>());
387 } else if (stats.type() == RTCPeerConnectionStats::kType) {
388 verify_successful &= VerifyRTCPeerConnectionStats(
389 stats.cast_to<RTCPeerConnectionStats>());
390 } else if (stats.type() == RTCInboundRTPStreamStats::kType) {
391 verify_successful &= VerifyRTCInboundRTPStreamStats(
392 stats.cast_to<RTCInboundRTPStreamStats>());
393 } else if (stats.type() == RTCOutboundRTPStreamStats::kType) {
394 verify_successful &= VerifyRTCOutboundRTPStreamStats(
Eldar Rello9276e2c2020-06-10 14:53:39395 stats.cast_to<RTCOutboundRTPStreamStats>());
Henrik Boström883eefc2019-05-27 11:40:25396 } else if (stats.type() == RTCRemoteInboundRtpStreamStats::kType) {
397 verify_successful &= VerifyRTCRemoteInboundRtpStreamStats(
398 stats.cast_to<RTCRemoteInboundRtpStreamStats>());
Alessio Bazzicaf7b1b952021-03-23 16:23:04399 } else if (stats.type() == RTCRemoteOutboundRtpStreamStats::kType) {
400 verify_successful &= VerifyRTCRemoteOutboundRTPStreamStats(
401 stats.cast_to<RTCRemoteOutboundRtpStreamStats>());
Henrik Boström646fda02019-05-22 13:49:42402 } else if (stats.type() == RTCAudioSourceStats::kType) {
403 // RTCAudioSourceStats::kType and RTCVideoSourceStats::kType both have
404 // the value "media-source", but they are distinguishable with pointer
Artem Titov880fa812021-07-30 20:30:23405 // equality (==). In JavaScript they would be distinguished with `kind`.
Henrik Boström646fda02019-05-22 13:49:42406 verify_successful &=
407 VerifyRTCAudioSourceStats(stats.cast_to<RTCAudioSourceStats>());
408 } else if (stats.type() == RTCVideoSourceStats::kType) {
409 // RTCAudioSourceStats::kType and RTCVideoSourceStats::kType both have
410 // the value "media-source", but they are distinguishable with pointer
Artem Titov880fa812021-07-30 20:30:23411 // equality (==). In JavaScript they would be distinguished with `kind`.
Henrik Boström646fda02019-05-22 13:49:42412 verify_successful &=
413 VerifyRTCVideoSourceStats(stats.cast_to<RTCVideoSourceStats>());
hbosdb346a72016-11-29 09:57:01414 } else if (stats.type() == RTCTransportStats::kType) {
Yves Gerey665174f2018-06-19 13:03:05415 verify_successful &=
416 VerifyRTCTransportStats(stats.cast_to<RTCTransportStats>());
hbosdb346a72016-11-29 09:57:01417 } else {
418 EXPECT_TRUE(false) << "Unrecognized stats type: " << stats.type();
419 verify_successful = false;
420 }
421 }
Henrik Boström1df1bf82018-03-20 12:24:20422 for (const char* missing : missing_stats) {
Steve Anton64b626b2019-01-29 01:25:26423 if (!absl::c_linear_search(allowed_missing_stats, missing)) {
Henrik Boström1df1bf82018-03-20 12:24:20424 verify_successful = false;
hbosdb346a72016-11-29 09:57:01425 EXPECT_TRUE(false) << "Missing expected stats type: " << missing;
426 }
427 }
Yves Gerey665174f2018-06-19 13:03:05428 EXPECT_TRUE(verify_successful)
429 << "One or more problems with the stats. This is the report:\n"
430 << report_->ToJson();
hbosdb346a72016-11-29 09:57:01431 }
432
Yves Gerey665174f2018-06-19 13:03:05433 bool VerifyRTCCertificateStats(const RTCCertificateStats& certificate) {
Niels Möllerafb246b2022-04-20 12:26:50434 RTCStatsVerifier verifier(report_.get(), &certificate);
hbosdb346a72016-11-29 09:57:01435 verifier.TestMemberIsDefined(certificate.fingerprint);
436 verifier.TestMemberIsDefined(certificate.fingerprint_algorithm);
437 verifier.TestMemberIsDefined(certificate.base64_certificate);
Yves Gerey665174f2018-06-19 13:03:05438 verifier.TestMemberIsOptionalIDReference(certificate.issuer_certificate_id,
439 RTCCertificateStats::kType);
hbosdb346a72016-11-29 09:57:01440 return verifier.ExpectAllMembersSuccessfullyTested();
441 }
442
Yves Gerey665174f2018-06-19 13:03:05443 bool VerifyRTCCodecStats(const RTCCodecStats& codec) {
Niels Möllerafb246b2022-04-20 12:26:50444 RTCStatsVerifier verifier(report_.get(), &codec);
Philipp Hancke95157a02020-11-16 19:08:27445 verifier.TestMemberIsIDReference(codec.transport_id,
446 RTCTransportStats::kType);
hbosdb346a72016-11-29 09:57:01447 verifier.TestMemberIsDefined(codec.payload_type);
hbos13f54b22017-02-28 14:56:04448 verifier.TestMemberIsDefined(codec.mime_type);
hbos23351192017-01-02 14:52:19449 verifier.TestMemberIsPositive<uint32_t>(codec.clock_rate);
Johannes Kron72d69152020-02-10 13:05:55450
451 if (codec.mime_type->rfind("audio", 0) == 0)
452 verifier.TestMemberIsPositive<uint32_t>(codec.channels);
453 else
454 verifier.TestMemberIsUndefined(codec.channels);
455
456 // sdp_fmtp_line is an optional field.
457 verifier.MarkMemberTested(codec.sdp_fmtp_line, true);
hbosdb346a72016-11-29 09:57:01458 return verifier.ExpectAllMembersSuccessfullyTested();
459 }
460
Yves Gerey665174f2018-06-19 13:03:05461 bool VerifyRTCDataChannelStats(const RTCDataChannelStats& data_channel) {
Niels Möllerafb246b2022-04-20 12:26:50462 RTCStatsVerifier verifier(report_.get(), &data_channel);
hbosdb346a72016-11-29 09:57:01463 verifier.TestMemberIsDefined(data_channel.label);
464 verifier.TestMemberIsDefined(data_channel.protocol);
Harald Alvestrand10ef8472020-06-05 13:38:51465 verifier.TestMemberIsDefined(data_channel.data_channel_identifier);
hbosdb346a72016-11-29 09:57:01466 verifier.TestMemberIsDefined(data_channel.state);
hbos23351192017-01-02 14:52:19467 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_sent);
468 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_sent);
469 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_received);
470 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_received);
hbosdb346a72016-11-29 09:57:01471 return verifier.ExpectAllMembersSuccessfullyTested();
472 }
473
474 bool VerifyRTCIceCandidatePairStats(
Yves Gerey665174f2018-06-19 13:03:05475 const RTCIceCandidatePairStats& candidate_pair,
476 bool is_selected_pair) {
Niels Möllerafb246b2022-04-20 12:26:50477 RTCStatsVerifier verifier(report_.get(), &candidate_pair);
Yves Gerey665174f2018-06-19 13:03:05478 verifier.TestMemberIsIDReference(candidate_pair.transport_id,
479 RTCTransportStats::kType);
480 verifier.TestMemberIsIDReference(candidate_pair.local_candidate_id,
481 RTCLocalIceCandidateStats::kType);
482 verifier.TestMemberIsIDReference(candidate_pair.remote_candidate_id,
483 RTCRemoteIceCandidateStats::kType);
hbos06495bc2017-01-02 16:08:18484 verifier.TestMemberIsDefined(candidate_pair.state);
485 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.priority);
hbos92eaec62017-02-27 09:38:08486 verifier.TestMemberIsDefined(candidate_pair.nominated);
hbosdb346a72016-11-29 09:57:01487 verifier.TestMemberIsDefined(candidate_pair.writable);
Taylor Brandstetter79326ea2021-09-28 22:09:53488 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.packets_sent);
489 verifier.TestMemberIsNonNegative<uint64_t>(
490 candidate_pair.packets_discarded_on_send);
491 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.packets_received);
hbos23351192017-01-02 14:52:19492 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_sent);
Taylor Brandstetter79326ea2021-09-28 22:09:53493 verifier.TestMemberIsNonNegative<uint64_t>(
494 candidate_pair.bytes_discarded_on_send);
hbos23351192017-01-02 14:52:19495 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_received);
hbosbf8d3e52017-02-28 14:34:47496 verifier.TestMemberIsNonNegative<double>(
497 candidate_pair.total_round_trip_time);
hbos23351192017-01-02 14:52:19498 verifier.TestMemberIsNonNegative<double>(
499 candidate_pair.current_round_trip_time);
hbos338f78a2017-02-07 14:41:21500 if (is_selected_pair) {
501 verifier.TestMemberIsNonNegative<double>(
502 candidate_pair.available_outgoing_bitrate);
deadbeef86c40a12017-06-28 16:37:23503 // A pair should be nominated in order to be selected.
504 EXPECT_TRUE(*candidate_pair.nominated);
hbos338f78a2017-02-07 14:41:21505 } else {
506 verifier.TestMemberIsUndefined(candidate_pair.available_outgoing_bitrate);
507 }
hbosdb346a72016-11-29 09:57:01508 verifier.TestMemberIsUndefined(candidate_pair.available_incoming_bitrate);
hbos23351192017-01-02 14:52:19509 verifier.TestMemberIsNonNegative<uint64_t>(
510 candidate_pair.requests_received);
511 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.requests_sent);
512 verifier.TestMemberIsNonNegative<uint64_t>(
513 candidate_pair.responses_received);
514 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.responses_sent);
hbos23351192017-01-02 14:52:19515 verifier.TestMemberIsNonNegative<uint64_t>(
516 candidate_pair.consent_requests_sent);
Jonas Oreland0d13bbd2022-03-02 10:17:36517
hbosdb346a72016-11-29 09:57:01518 return verifier.ExpectAllMembersSuccessfullyTested();
519 }
520
Yves Gerey665174f2018-06-19 13:03:05521 bool VerifyRTCIceCandidateStats(const RTCIceCandidateStats& candidate) {
Niels Möllerafb246b2022-04-20 12:26:50522 RTCStatsVerifier verifier(report_.get(), &candidate);
Yves Gerey665174f2018-06-19 13:03:05523 verifier.TestMemberIsIDReference(candidate.transport_id,
524 RTCTransportStats::kType);
hbosc3a2b7f2017-01-02 12:46:15525 verifier.TestMemberIsDefined(candidate.is_remote);
Gary Liu37e489c2017-11-21 18:49:36526 if (*candidate.is_remote) {
527 verifier.TestMemberIsUndefined(candidate.network_type);
Jonas Oreland0d13bbd2022-03-02 10:17:36528 verifier.TestMemberIsUndefined(candidate.network_adapter_type);
529 verifier.TestMemberIsUndefined(candidate.vpn);
Gary Liu37e489c2017-11-21 18:49:36530 } else {
531 verifier.TestMemberIsDefined(candidate.network_type);
Jonas Oreland0d13bbd2022-03-02 10:17:36532 verifier.TestMemberIsDefined(candidate.network_adapter_type);
533 verifier.TestMemberIsDefined(candidate.vpn);
Gary Liu37e489c2017-11-21 18:49:36534 }
hbosdb346a72016-11-29 09:57:01535 verifier.TestMemberIsDefined(candidate.ip);
Philipp Hanckea9ba4502021-03-22 12:22:54536 verifier.TestMemberIsDefined(candidate.address);
hbos23351192017-01-02 14:52:19537 verifier.TestMemberIsNonNegative<int32_t>(candidate.port);
hbosdb346a72016-11-29 09:57:01538 verifier.TestMemberIsDefined(candidate.protocol);
539 verifier.TestMemberIsDefined(candidate.candidate_type);
hbos23351192017-01-02 14:52:19540 verifier.TestMemberIsNonNegative<int32_t>(candidate.priority);
hbosdb346a72016-11-29 09:57:01541 verifier.TestMemberIsUndefined(candidate.url);
Philipp Hancke95513752018-09-27 12:40:08542 verifier.TestMemberIsUndefined(candidate.relay_protocol);
hbosdb346a72016-11-29 09:57:01543 return verifier.ExpectAllMembersSuccessfullyTested();
544 }
545
546 bool VerifyRTCLocalIceCandidateStats(
547 const RTCLocalIceCandidateStats& local_candidate) {
548 return VerifyRTCIceCandidateStats(local_candidate);
549 }
550
551 bool VerifyRTCRemoteIceCandidateStats(
552 const RTCRemoteIceCandidateStats& remote_candidate) {
553 return VerifyRTCIceCandidateStats(remote_candidate);
554 }
555
Yves Gerey665174f2018-06-19 13:03:05556 bool VerifyRTCMediaStreamStats(const RTCMediaStreamStats& media_stream) {
Niels Möllerafb246b2022-04-20 12:26:50557 RTCStatsVerifier verifier(report_.get(), &media_stream);
hbosdb346a72016-11-29 09:57:01558 verifier.TestMemberIsDefined(media_stream.stream_identifier);
Yves Gerey665174f2018-06-19 13:03:05559 verifier.TestMemberIsIDReference(media_stream.track_ids,
560 RTCMediaStreamTrackStats::kType);
hbosdb346a72016-11-29 09:57:01561 return verifier.ExpectAllMembersSuccessfullyTested();
562 }
563
564 bool VerifyRTCMediaStreamTrackStats(
565 const RTCMediaStreamTrackStats& media_stream_track) {
Niels Möllerafb246b2022-04-20 12:26:50566 RTCStatsVerifier verifier(report_.get(), &media_stream_track);
hbosdb346a72016-11-29 09:57:01567 verifier.TestMemberIsDefined(media_stream_track.track_identifier);
568 verifier.TestMemberIsDefined(media_stream_track.remote_source);
569 verifier.TestMemberIsDefined(media_stream_track.ended);
570 verifier.TestMemberIsDefined(media_stream_track.detached);
hbos160e4a72017-01-17 10:53:23571 verifier.TestMemberIsDefined(media_stream_track.kind);
Guido Urdaneta67378412019-05-28 15:38:08572 RTC_DCHECK(media_stream_track.remote_source.is_defined());
hbosdb346a72016-11-29 09:57:01573 // Video or audio media stream track?
hbos160e4a72017-01-17 10:53:23574 if (*media_stream_track.kind == RTCMediaStreamTrackKind::kVideo) {
Henrik Boström646fda02019-05-22 13:49:42575 // The type of the referenced media source depends on kind.
hbos42f6d2f2017-01-20 11:56:50576 if (*media_stream_track.remote_source) {
Guido Urdaneta67378412019-05-28 15:38:08577 verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
578 verifier.TestMemberIsNonNegative<double>(
579 media_stream_track.jitter_buffer_delay);
580 verifier.TestMemberIsNonNegative<uint64_t>(
581 media_stream_track.jitter_buffer_emitted_count);
hbosfefe0762017-01-20 14:14:25582 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 15:35:03583 verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
hbos42f6d2f2017-01-20 11:56:50584 verifier.TestMemberIsNonNegative<uint32_t>(
585 media_stream_track.frames_received);
hbosf64941f2017-01-20 15:39:09586 verifier.TestMemberIsNonNegative<uint32_t>(
587 media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 15:21:55588 verifier.TestMemberIsNonNegative<uint32_t>(
589 media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 15:45:42590 verifier.TestMemberIsNonNegative<uint32_t>(
591 media_stream_track.freeze_count);
592 verifier.TestMemberIsNonNegative<uint32_t>(
593 media_stream_track.pause_count);
594 verifier.TestMemberIsNonNegative<double>(
595 media_stream_track.total_freezes_duration);
596 verifier.TestMemberIsNonNegative<double>(
597 media_stream_track.total_pauses_duration);
598 verifier.TestMemberIsNonNegative<double>(
599 media_stream_track.total_frames_duration);
600 verifier.TestMemberIsNonNegative<double>(
601 media_stream_track.sum_squared_frame_durations);
hbos42f6d2f2017-01-20 11:56:50602 } else {
Guido Urdaneta67378412019-05-28 15:38:08603 verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
604 RTCVideoSourceStats::kType);
605 // Local tracks have no jitter buffer.
606 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
607 verifier.TestMemberIsUndefined(
608 media_stream_track.jitter_buffer_emitted_count);
hbosfefe0762017-01-20 14:14:25609 verifier.TestMemberIsNonNegative<uint32_t>(
610 media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 15:35:03611 verifier.TestMemberIsNonNegative<uint32_t>(
612 media_stream_track.huge_frames_sent);
hbos42f6d2f2017-01-20 11:56:50613 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
hbosf64941f2017-01-20 15:39:09614 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 15:21:55615 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 15:45:42616 verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
617 verifier.TestMemberIsUndefined(media_stream_track.pause_count);
618 verifier.TestMemberIsUndefined(
619 media_stream_track.total_freezes_duration);
620 verifier.TestMemberIsUndefined(
621 media_stream_track.total_pauses_duration);
622 verifier.TestMemberIsUndefined(
623 media_stream_track.total_frames_duration);
624 verifier.TestMemberIsUndefined(
625 media_stream_track.sum_squared_frame_durations);
hbos42f6d2f2017-01-20 11:56:50626 }
Guido Urdaneta67378412019-05-28 15:38:08627 // Video-only members
628 verifier.TestMemberIsNonNegative<uint32_t>(
629 media_stream_track.frame_width);
630 verifier.TestMemberIsNonNegative<uint32_t>(
631 media_stream_track.frame_height);
hbosdb346a72016-11-29 09:57:01632 // Audio-only members should be undefined
633 verifier.TestMemberIsUndefined(media_stream_track.audio_level);
634 verifier.TestMemberIsUndefined(media_stream_track.echo_return_loss);
635 verifier.TestMemberIsUndefined(
636 media_stream_track.echo_return_loss_enhancement);
zsteine76bd3a2017-07-14 19:17:49637 verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
638 verifier.TestMemberIsUndefined(media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 15:38:08639 verifier.TestMemberIsUndefined(media_stream_track.total_samples_received);
640 verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
Henrik Boström21e99da2019-08-21 10:09:51641 verifier.TestMemberIsUndefined(
642 media_stream_track.silent_concealed_samples);
Guido Urdaneta67378412019-05-28 15:38:08643 verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
Henrik Boström21e99da2019-08-21 10:09:51644 verifier.TestMemberIsUndefined(
645 media_stream_track.inserted_samples_for_deceleration);
646 verifier.TestMemberIsUndefined(
647 media_stream_track.removed_samples_for_acceleration);
Guido Urdaneta67378412019-05-28 15:38:08648 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_flushes);
649 verifier.TestMemberIsUndefined(
650 media_stream_track.delayed_packet_outage_samples);
651 verifier.TestMemberIsUndefined(
652 media_stream_track.relative_packet_arrival_delay);
653 verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
654 verifier.TestMemberIsUndefined(
655 media_stream_track.total_interruption_duration);
Artem Titove618cc92020-03-11 10:18:54656 verifier.TestMemberIsUndefined(
657 media_stream_track.jitter_buffer_target_delay);
hbosdb346a72016-11-29 09:57:01658 } else {
Yves Gerey665174f2018-06-19 13:03:05659 RTC_DCHECK_EQ(*media_stream_track.kind, RTCMediaStreamTrackKind::kAudio);
Henrik Boström646fda02019-05-22 13:49:42660 // The type of the referenced media source depends on kind.
Guido Urdaneta67378412019-05-28 15:38:08661 if (*media_stream_track.remote_source) {
Henrik Boström646fda02019-05-22 13:49:42662 // Remote tracks don't have media source stats.
663 verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
Guido Urdaneta67378412019-05-28 15:38:08664 verifier.TestMemberIsNonNegative<double>(
665 media_stream_track.jitter_buffer_delay);
666 verifier.TestMemberIsNonNegative<uint64_t>(
667 media_stream_track.jitter_buffer_emitted_count);
Artem Titove618cc92020-03-11 10:18:54668 verifier.TestMemberIsNonNegative<double>(
669 media_stream_track.jitter_buffer_target_delay);
Henrik Boströmd2c336f2019-07-03 15:11:10670 verifier.TestMemberIsPositive<double>(media_stream_track.audio_level);
671 verifier.TestMemberIsPositive<double>(
672 media_stream_track.total_audio_energy);
673 verifier.TestMemberIsPositive<uint64_t>(
Guido Urdaneta67378412019-05-28 15:38:08674 media_stream_track.total_samples_received);
Henrik Boströmd2c336f2019-07-03 15:11:10675 verifier.TestMemberIsPositive<double>(
676 media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 15:38:08677 verifier.TestMemberIsNonNegative<uint64_t>(
678 media_stream_track.concealed_samples);
679 verifier.TestMemberIsNonNegative<uint64_t>(
Henrik Boström21e99da2019-08-21 10:09:51680 media_stream_track.silent_concealed_samples);
681 verifier.TestMemberIsNonNegative<uint64_t>(
Guido Urdaneta67378412019-05-28 15:38:08682 media_stream_track.concealment_events);
683 verifier.TestMemberIsNonNegative<uint64_t>(
684 media_stream_track.inserted_samples_for_deceleration);
685 verifier.TestMemberIsNonNegative<uint64_t>(
686 media_stream_track.removed_samples_for_acceleration);
687 verifier.TestMemberIsNonNegative<uint64_t>(
Guido Urdaneta67378412019-05-28 15:38:08688 media_stream_track.jitter_buffer_flushes);
689 verifier.TestMemberIsNonNegative<uint64_t>(
690 media_stream_track.delayed_packet_outage_samples);
691 verifier.TestMemberIsNonNegative<double>(
692 media_stream_track.relative_packet_arrival_delay);
693 verifier.TestMemberIsNonNegative<uint32_t>(
694 media_stream_track.interruption_count);
695 verifier.TestMemberIsNonNegative<double>(
696 media_stream_track.total_interruption_duration);
697 } else {
698 verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
699 RTCAudioSourceStats::kType);
700 // Local audio tracks have no jitter buffer.
701 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
702 verifier.TestMemberIsUndefined(
703 media_stream_track.jitter_buffer_emitted_count);
Artem Titove618cc92020-03-11 10:18:54704 verifier.TestMemberIsUndefined(
705 media_stream_track.jitter_buffer_target_delay);
Henrik Boströmd2c336f2019-07-03 15:11:10706 verifier.TestMemberIsUndefined(media_stream_track.audio_level);
707 verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
Guido Urdaneta67378412019-05-28 15:38:08708 verifier.TestMemberIsUndefined(
709 media_stream_track.total_samples_received);
Henrik Boströmd2c336f2019-07-03 15:11:10710 verifier.TestMemberIsUndefined(
711 media_stream_track.total_samples_duration);
Guido Urdaneta67378412019-05-28 15:38:08712 verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
Henrik Boström21e99da2019-08-21 10:09:51713 verifier.TestMemberIsUndefined(
714 media_stream_track.silent_concealed_samples);
Guido Urdaneta67378412019-05-28 15:38:08715 verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
716 verifier.TestMemberIsUndefined(
Henrik Boström21e99da2019-08-21 10:09:51717 media_stream_track.inserted_samples_for_deceleration);
718 verifier.TestMemberIsUndefined(
719 media_stream_track.removed_samples_for_acceleration);
720 verifier.TestMemberIsUndefined(
Guido Urdaneta67378412019-05-28 15:38:08721 media_stream_track.jitter_buffer_flushes);
722 verifier.TestMemberIsUndefined(
723 media_stream_track.delayed_packet_outage_samples);
724 verifier.TestMemberIsUndefined(
725 media_stream_track.relative_packet_arrival_delay);
726 verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
727 verifier.TestMemberIsUndefined(
728 media_stream_track.total_interruption_duration);
Henrik Boström646fda02019-05-22 13:49:42729 }
hbosdb346a72016-11-29 09:57:01730 // Video-only members should be undefined
731 verifier.TestMemberIsUndefined(media_stream_track.frame_width);
732 verifier.TestMemberIsUndefined(media_stream_track.frame_height);
hbosdb346a72016-11-29 09:57:01733 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
Ilya Nikolaevskiy70473fc2018-02-28 15:35:03734 verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
hbosdb346a72016-11-29 09:57:01735 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
736 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
737 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
Sergey Silkin02371062019-01-31 15:45:42738 verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
739 verifier.TestMemberIsUndefined(media_stream_track.pause_count);
740 verifier.TestMemberIsUndefined(media_stream_track.total_freezes_duration);
741 verifier.TestMemberIsUndefined(media_stream_track.total_pauses_duration);
742 verifier.TestMemberIsUndefined(media_stream_track.total_frames_duration);
743 verifier.TestMemberIsUndefined(
744 media_stream_track.sum_squared_frame_durations);
hbosdb346a72016-11-29 09:57:01745 // Audio-only members
Artem Titov880fa812021-07-30 20:30:23746 // TODO(hbos): `echo_return_loss` and `echo_return_loss_enhancement` are
hbos2d4d6532017-01-20 12:16:41747 // flaky on msan bot (sometimes defined, sometimes undefined). Should the
748 // test run until available or is there a way to have it always be
749 // defined? crbug.com/627816
750 verifier.MarkMemberTested(media_stream_track.echo_return_loss, true);
Yves Gerey665174f2018-06-19 13:03:05751 verifier.MarkMemberTested(media_stream_track.echo_return_loss_enhancement,
752 true);
hbosdb346a72016-11-29 09:57:01753 }
754 return verifier.ExpectAllMembersSuccessfullyTested();
755 }
756
757 bool VerifyRTCPeerConnectionStats(
758 const RTCPeerConnectionStats& peer_connection) {
Niels Möllerafb246b2022-04-20 12:26:50759 RTCStatsVerifier verifier(report_.get(), &peer_connection);
hbos23351192017-01-02 14:52:19760 verifier.TestMemberIsNonNegative<uint32_t>(
761 peer_connection.data_channels_opened);
762 verifier.TestMemberIsNonNegative<uint32_t>(
763 peer_connection.data_channels_closed);
hbosdb346a72016-11-29 09:57:01764 return verifier.ExpectAllMembersSuccessfullyTested();
765 }
766
Yves Gerey665174f2018-06-19 13:03:05767 void VerifyRTCRTPStreamStats(const RTCRTPStreamStats& stream,
Alessio Bazzicaf7b1b952021-03-23 16:23:04768 RTCStatsVerifier& verifier) {
769 verifier.TestMemberIsDefined(stream.ssrc);
770 verifier.TestMemberIsDefined(stream.kind);
Henrik Boström2f71b612021-03-23 14:18:55771 // Some legacy metrics are only defined for some of the RTP types in the
772 // hierarcy.
773 if (stream.type() == RTCInboundRTPStreamStats::kType ||
774 stream.type() == RTCOutboundRTPStreamStats::kType) {
Alessio Bazzicaf7b1b952021-03-23 16:23:04775 verifier.TestMemberIsDefined(stream.media_type);
776 verifier.TestMemberIsIDReference(stream.track_id,
777 RTCMediaStreamTrackStats::kType);
Henrik Boström2f71b612021-03-23 14:18:55778 } else {
Alessio Bazzicaf7b1b952021-03-23 16:23:04779 verifier.TestMemberIsUndefined(stream.media_type);
780 verifier.TestMemberIsUndefined(stream.track_id);
Henrik Boström2f71b612021-03-23 14:18:55781 }
Alessio Bazzicaf7b1b952021-03-23 16:23:04782 verifier.TestMemberIsIDReference(stream.transport_id,
783 RTCTransportStats::kType);
784 verifier.TestMemberIsIDReference(stream.codec_id, RTCCodecStats::kType);
785 }
786
787 void VerifyRTCSentRTPStreamStats(const RTCSentRtpStreamStats& sent_stream,
788 RTCStatsVerifier& verifier) {
789 VerifyRTCRTPStreamStats(sent_stream, verifier);
790 verifier.TestMemberIsDefined(sent_stream.packets_sent);
791 verifier.TestMemberIsDefined(sent_stream.bytes_sent);
hbosdb346a72016-11-29 09:57:01792 }
793
794 bool VerifyRTCInboundRTPStreamStats(
795 const RTCInboundRTPStreamStats& inbound_stream) {
Niels Möllerafb246b2022-04-20 12:26:50796 RTCStatsVerifier verifier(report_.get(), &inbound_stream);
Minyue Li28a2c632021-07-07 13:53:38797 VerifyRTCReceivedRtpStreamStats(inbound_stream, verifier,
Philipp Hanckea3b5c4e2022-04-22 13:09:54798 inbound_stream.kind.is_defined() &&
Minyue Li28a2c632021-07-07 13:53:38799 *inbound_stream.media_type == "audio");
Alessio Bazzicaf7b1b952021-03-23 16:23:04800 verifier.TestMemberIsOptionalIDReference(
801 inbound_stream.remote_id, RTCRemoteOutboundRtpStreamStats::kType);
Henrik Boströma6c7d5c2022-06-16 14:55:31802 verifier.TestMemberIsDefined(inbound_stream.track_identifier);
Philipp Hanckea3b5c4e2022-04-22 13:09:54803 if (inbound_stream.kind.is_defined() &&
sakal5fec1282017-02-20 14:43:58804 *inbound_stream.media_type == "video") {
805 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.qp_sum);
Henrik Boström6b430862019-08-16 11:09:51806 verifier.TestMemberIsDefined(inbound_stream.decoder_implementation);
sakal5fec1282017-02-20 14:43:58807 } else {
hbosa51d4f32017-02-16 13:34:48808 verifier.TestMemberIsUndefined(inbound_stream.qp_sum);
Henrik Boström6b430862019-08-16 11:09:51809 verifier.TestMemberIsUndefined(inbound_stream.decoder_implementation);
sakal5fec1282017-02-20 14:43:58810 }
hbos23351192017-01-02 14:52:19811 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.packets_received);
Philipp Hanckea3b5c4e2022-04-22 13:09:54812 if (inbound_stream.kind.is_defined() &&
Ivo Creusen8d8ffdb2019-04-30 07:45:21813 *inbound_stream.media_type == "audio") {
814 verifier.TestMemberIsNonNegative<uint64_t>(
815 inbound_stream.fec_packets_received);
816 verifier.TestMemberIsNonNegative<uint64_t>(
817 inbound_stream.fec_packets_discarded);
Henrik Boström4a5dab02020-01-28 10:15:35818 } else {
819 verifier.TestMemberIsUndefined(inbound_stream.fec_packets_received);
820 verifier.TestMemberIsUndefined(inbound_stream.fec_packets_discarded);
Ivo Creusen8d8ffdb2019-04-30 07:45:21821 }
hbos23351192017-01-02 14:52:19822 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.bytes_received);
Niels Möllerac0a4cb2019-10-09 13:01:33823 verifier.TestMemberIsNonNegative<uint64_t>(
824 inbound_stream.header_bytes_received);
Henrik Boström01738c62019-04-15 15:32:00825 verifier.TestMemberIsDefined(inbound_stream.last_packet_received_timestamp);
Eldar Rello4e5bc9f2020-07-06 11:18:07826 if (inbound_stream.frames_received.ValueOrDefault(0) > 0) {
827 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frame_width);
828 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frame_height);
829 } else {
830 verifier.TestMemberIsUndefined(inbound_stream.frame_width);
831 verifier.TestMemberIsUndefined(inbound_stream.frame_height);
832 }
833 if (inbound_stream.frames_per_second.is_defined()) {
834 verifier.TestMemberIsNonNegative<double>(
835 inbound_stream.frames_per_second);
836 } else {
837 verifier.TestMemberIsUndefined(inbound_stream.frames_per_second);
838 }
Byoungchan Lee899b29e2021-06-29 13:09:18839 verifier.TestMemberIsNonNegative<double>(
840 inbound_stream.jitter_buffer_delay);
841 verifier.TestMemberIsNonNegative<uint64_t>(
842 inbound_stream.jitter_buffer_emitted_count);
Philipp Hanckea3b5c4e2022-04-22 13:09:54843 if (inbound_stream.kind.is_defined() &&
hbosdb346a72016-11-29 09:57:01844 *inbound_stream.media_type == "video") {
Eldar Rello4e5bc9f2020-07-06 11:18:07845 verifier.TestMemberIsUndefined(inbound_stream.total_samples_received);
846 verifier.TestMemberIsUndefined(inbound_stream.concealed_samples);
847 verifier.TestMemberIsUndefined(inbound_stream.silent_concealed_samples);
848 verifier.TestMemberIsUndefined(inbound_stream.concealment_events);
849 verifier.TestMemberIsUndefined(
850 inbound_stream.inserted_samples_for_deceleration);
851 verifier.TestMemberIsUndefined(
852 inbound_stream.removed_samples_for_acceleration);
853 verifier.TestMemberIsUndefined(inbound_stream.audio_level);
854 verifier.TestMemberIsUndefined(inbound_stream.total_audio_energy);
855 verifier.TestMemberIsUndefined(inbound_stream.total_samples_duration);
856 verifier.TestMemberIsNonNegative<int32_t>(inbound_stream.frames_received);
Di Wufd1e9d12021-03-09 17:25:28857 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.fir_count);
858 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.pli_count);
859 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.nack_count);
hbosdb346a72016-11-29 09:57:01860 } else {
Di Wufd1e9d12021-03-09 17:25:28861 verifier.TestMemberIsUndefined(inbound_stream.fir_count);
862 verifier.TestMemberIsUndefined(inbound_stream.pli_count);
863 verifier.TestMemberIsUndefined(inbound_stream.nack_count);
Eldar Rello4e5bc9f2020-07-06 11:18:07864 verifier.TestMemberIsPositive<uint64_t>(
865 inbound_stream.total_samples_received);
866 verifier.TestMemberIsNonNegative<uint64_t>(
867 inbound_stream.concealed_samples);
868 verifier.TestMemberIsNonNegative<uint64_t>(
869 inbound_stream.silent_concealed_samples);
870 verifier.TestMemberIsNonNegative<uint64_t>(
871 inbound_stream.concealment_events);
872 verifier.TestMemberIsNonNegative<uint64_t>(
873 inbound_stream.inserted_samples_for_deceleration);
874 verifier.TestMemberIsNonNegative<uint64_t>(
875 inbound_stream.removed_samples_for_acceleration);
876 verifier.TestMemberIsPositive<double>(inbound_stream.audio_level);
877 verifier.TestMemberIsPositive<double>(inbound_stream.total_audio_energy);
878 verifier.TestMemberIsPositive<double>(
879 inbound_stream.total_samples_duration);
880 verifier.TestMemberIsUndefined(inbound_stream.frames_received);
hbosdb346a72016-11-29 09:57:01881 }
Åsa Perssonfcf79cc2019-10-22 13:23:44882 // Test runtime too short to get an estimate (at least two RTCP sender
883 // reports need to be received).
884 verifier.MarkMemberTested(inbound_stream.estimated_playout_timestamp, true);
Philipp Hanckea3b5c4e2022-04-22 13:09:54885 if (inbound_stream.kind.is_defined() &&
hbos6769c492017-01-02 16:35:13886 *inbound_stream.media_type == "video") {
887 verifier.TestMemberIsDefined(inbound_stream.frames_decoded);
Rasmus Brandt2efae772019-06-27 12:29:34888 verifier.TestMemberIsDefined(inbound_stream.key_frames_decoded);
Eldar Rello4e5bc9f2020-07-06 11:18:07889 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frames_dropped);
Johannes Kronbfd343b2019-07-01 08:07:50890 verifier.TestMemberIsNonNegative<double>(
891 inbound_stream.total_decode_time);
Johannes Kron00376e12019-11-25 09:25:42892 verifier.TestMemberIsNonNegative<double>(
Philipp Hanckea16a6a62022-04-25 10:21:30893 inbound_stream.total_processing_delay);
894 verifier.TestMemberIsNonNegative<double>(
Philipp Hancke0359ba22022-05-05 13:55:36895 inbound_stream.total_assembly_time);
896 verifier.TestMemberIsDefined(
897 inbound_stream.frames_assembled_from_multiple_packets);
898 verifier.TestMemberIsNonNegative<double>(
Johannes Kron00376e12019-11-25 09:25:42899 inbound_stream.total_inter_frame_delay);
900 verifier.TestMemberIsNonNegative<double>(
901 inbound_stream.total_squared_inter_frame_delay);
Henrik Boström2e069262019-04-09 11:59:31902 // The integration test is not set up to test screen share; don't require
903 // this to be present.
904 verifier.MarkMemberTested(inbound_stream.content_type, true);
Philipp Hancke6fb8d1a2022-05-30 10:37:04905 verifier.TestMemberIsNonNegative<double>(
906 inbound_stream.min_playout_delay);
hbos6769c492017-01-02 16:35:13907 } else {
908 verifier.TestMemberIsUndefined(inbound_stream.frames_decoded);
Rasmus Brandt2efae772019-06-27 12:29:34909 verifier.TestMemberIsUndefined(inbound_stream.key_frames_decoded);
Eldar Rello4e5bc9f2020-07-06 11:18:07910 verifier.TestMemberIsUndefined(inbound_stream.frames_dropped);
Johannes Kronbfd343b2019-07-01 08:07:50911 verifier.TestMemberIsUndefined(inbound_stream.total_decode_time);
Philipp Hanckea16a6a62022-04-25 10:21:30912 verifier.TestMemberIsUndefined(inbound_stream.total_processing_delay);
Philipp Hancke0359ba22022-05-05 13:55:36913 verifier.TestMemberIsUndefined(inbound_stream.total_assembly_time);
914 verifier.TestMemberIsUndefined(
915 inbound_stream.frames_assembled_from_multiple_packets);
Johannes Kron00376e12019-11-25 09:25:42916 verifier.TestMemberIsUndefined(inbound_stream.total_inter_frame_delay);
917 verifier.TestMemberIsUndefined(
918 inbound_stream.total_squared_inter_frame_delay);
Henrik Boström2e069262019-04-09 11:59:31919 verifier.TestMemberIsUndefined(inbound_stream.content_type);
Philipp Hancke6fb8d1a2022-05-30 10:37:04920 verifier.TestMemberIsUndefined(inbound_stream.min_playout_delay);
hbos6769c492017-01-02 16:35:13921 }
hbosdb346a72016-11-29 09:57:01922 return verifier.ExpectAllMembersSuccessfullyTested();
923 }
924
925 bool VerifyRTCOutboundRTPStreamStats(
Eldar Rello9276e2c2020-06-10 14:53:39926 const RTCOutboundRTPStreamStats& outbound_stream) {
Niels Möllerafb246b2022-04-20 12:26:50927 RTCStatsVerifier verifier(report_.get(), &outbound_stream);
Alessio Bazzicaf7b1b952021-03-23 16:23:04928 VerifyRTCRTPStreamStats(outbound_stream, verifier);
Philipp Hanckea3b5c4e2022-04-22 13:09:54929 if (outbound_stream.kind.is_defined() &&
hbos6769c492017-01-02 16:35:13930 *outbound_stream.media_type == "video") {
Henrik Boström646fda02019-05-22 13:49:42931 verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
932 RTCVideoSourceStats::kType);
Di Wufd1e9d12021-03-09 17:25:28933 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.fir_count);
934 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.pli_count);
Henrik Boströma0ff50c2020-05-05 13:54:46935 if (*outbound_stream.frames_encoded > 0) {
936 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.qp_sum);
937 } else {
938 verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
939 }
hbos6769c492017-01-02 16:35:13940 } else {
Di Wufd1e9d12021-03-09 17:25:28941 verifier.TestMemberIsUndefined(outbound_stream.fir_count);
942 verifier.TestMemberIsUndefined(outbound_stream.pli_count);
Henrik Boström646fda02019-05-22 13:49:42943 verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
944 RTCAudioSourceStats::kType);
hbos6769c492017-01-02 16:35:13945 verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
946 }
Jakob Ivarssone91c9922021-07-06 07:55:43947 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.nack_count);
Henrik Boström4f40fa52019-12-19 12:27:27948 verifier.TestMemberIsOptionalIDReference(
949 outbound_stream.remote_id, RTCRemoteInboundRtpStreamStats::kType);
hbos23351192017-01-02 14:52:19950 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.packets_sent);
Henrik Boströmcf96e0f2019-04-17 11:51:53951 verifier.TestMemberIsNonNegative<uint64_t>(
952 outbound_stream.retransmitted_packets_sent);
hbos23351192017-01-02 14:52:19953 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.bytes_sent);
Henrik Boströmcf96e0f2019-04-17 11:51:53954 verifier.TestMemberIsNonNegative<uint64_t>(
Niels Möllerac0a4cb2019-10-09 13:01:33955 outbound_stream.header_bytes_sent);
956 verifier.TestMemberIsNonNegative<uint64_t>(
Henrik Boströmcf96e0f2019-04-17 11:51:53957 outbound_stream.retransmitted_bytes_sent);
Philipp Hanckea3b5c4e2022-04-22 13:09:54958 if (outbound_stream.kind.is_defined() &&
hbos6769c492017-01-02 16:35:13959 *outbound_stream.media_type == "video") {
960 verifier.TestMemberIsDefined(outbound_stream.frames_encoded);
Rasmus Brandt2efae772019-06-27 12:29:34961 verifier.TestMemberIsDefined(outbound_stream.key_frames_encoded);
Henrik Boströmf71362f2019-04-08 14:14:23962 verifier.TestMemberIsNonNegative<double>(
963 outbound_stream.total_encode_time);
Henrik Boström23aff9b2019-05-20 13:15:38964 verifier.TestMemberIsNonNegative<uint64_t>(
965 outbound_stream.total_encoded_bytes_target);
Henrik Boström9fe18342019-05-16 16:38:20966 verifier.TestMemberIsNonNegative<double>(
967 outbound_stream.total_packet_send_delay);
Henrik Boströmce33b6a2019-05-28 15:42:38968 verifier.TestMemberIsDefined(outbound_stream.quality_limitation_reason);
Byoungchan Lee7d235352021-05-28 12:32:04969 verifier.TestMemberIsDefined(
970 outbound_stream.quality_limitation_durations);
Evan Shrubsolecc62b162019-09-09 09:26:45971 verifier.TestMemberIsNonNegative<uint32_t>(
972 outbound_stream.quality_limitation_resolution_changes);
Henrik Boström2e069262019-04-09 11:59:31973 // The integration test is not set up to test screen share; don't require
974 // this to be present.
975 verifier.MarkMemberTested(outbound_stream.content_type, true);
Henrik Boström6b430862019-08-16 11:09:51976 verifier.TestMemberIsDefined(outbound_stream.encoder_implementation);
Eldar Rello9276e2c2020-06-10 14:53:39977 // Unless an implementation-specific amount of time has passed and at
978 // least one frame has been encoded, undefined is reported. Because it
979 // is hard to tell what is the case here, we treat FPS as optional.
980 // TODO(hbos): Update the tests to run until all implemented metrics
981 // should be populated.
982 if (outbound_stream.frames_per_second.is_defined()) {
983 verifier.TestMemberIsNonNegative<double>(
984 outbound_stream.frames_per_second);
Henrik Boströma0ff50c2020-05-05 13:54:46985 } else {
986 verifier.TestMemberIsUndefined(outbound_stream.frames_per_second);
Henrik Boströma0ff50c2020-05-05 13:54:46987 }
Eldar Rello9276e2c2020-06-10 14:53:39988 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frame_height);
989 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frame_width);
990 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frames_sent);
991 verifier.TestMemberIsNonNegative<uint32_t>(
992 outbound_stream.huge_frames_sent);
Jakob Ivarssonbf087452021-11-11 12:43:49993 verifier.TestMemberIsUndefined(outbound_stream.target_bitrate);
Eldar Rello9276e2c2020-06-10 14:53:39994 verifier.MarkMemberTested(outbound_stream.rid, true);
hbos6769c492017-01-02 16:35:13995 } else {
996 verifier.TestMemberIsUndefined(outbound_stream.frames_encoded);
Rasmus Brandt2efae772019-06-27 12:29:34997 verifier.TestMemberIsUndefined(outbound_stream.key_frames_encoded);
Henrik Boströmf71362f2019-04-08 14:14:23998 verifier.TestMemberIsUndefined(outbound_stream.total_encode_time);
Henrik Boström23aff9b2019-05-20 13:15:38999 verifier.TestMemberIsUndefined(
1000 outbound_stream.total_encoded_bytes_target);
Henrik Boström9fe18342019-05-16 16:38:201001 // TODO(https://crbug.com/webrtc/10635): Implement for audio as well.
1002 verifier.TestMemberIsUndefined(outbound_stream.total_packet_send_delay);
Henrik Boströmce33b6a2019-05-28 15:42:381003 verifier.TestMemberIsUndefined(outbound_stream.quality_limitation_reason);
Evan Shrubsolecc62b162019-09-09 09:26:451004 verifier.TestMemberIsUndefined(
Byoungchan Lee7d235352021-05-28 12:32:041005 outbound_stream.quality_limitation_durations);
1006 verifier.TestMemberIsUndefined(
Evan Shrubsolecc62b162019-09-09 09:26:451007 outbound_stream.quality_limitation_resolution_changes);
Henrik Boström2e069262019-04-09 11:59:311008 verifier.TestMemberIsUndefined(outbound_stream.content_type);
Henrik Boström6b430862019-08-16 11:09:511009 // TODO(hbos): Implement for audio as well.
1010 verifier.TestMemberIsUndefined(outbound_stream.encoder_implementation);
Henrik Boströma0ff50c2020-05-05 13:54:461011 verifier.TestMemberIsUndefined(outbound_stream.rid);
1012 verifier.TestMemberIsUndefined(outbound_stream.frames_per_second);
1013 verifier.TestMemberIsUndefined(outbound_stream.frame_height);
1014 verifier.TestMemberIsUndefined(outbound_stream.frame_width);
1015 verifier.TestMemberIsUndefined(outbound_stream.frames_sent);
1016 verifier.TestMemberIsUndefined(outbound_stream.huge_frames_sent);
Jakob Ivarssonbf087452021-11-11 12:43:491017 verifier.TestMemberIsNonNegative<double>(outbound_stream.target_bitrate);
hbos6769c492017-01-02 16:35:131018 }
hbosdb346a72016-11-29 09:57:011019 return verifier.ExpectAllMembersSuccessfullyTested();
1020 }
1021
Henrik Boström2f71b612021-03-23 14:18:551022 void VerifyRTCReceivedRtpStreamStats(
1023 const RTCReceivedRtpStreamStats& received_rtp,
Minyue Li28a2c632021-07-07 13:53:381024 RTCStatsVerifier& verifier,
1025 bool packets_discarded_defined) {
Henrik Boström2f71b612021-03-23 14:18:551026 VerifyRTCRTPStreamStats(received_rtp, verifier);
Alessio Bazzicaf7b1b952021-03-23 16:23:041027 verifier.TestMemberIsNonNegative<double>(received_rtp.jitter);
1028 verifier.TestMemberIsDefined(received_rtp.packets_lost);
Minyue Li28a2c632021-07-07 13:53:381029 if (packets_discarded_defined) {
1030 verifier.TestMemberIsNonNegative<uint64_t>(
1031 received_rtp.packets_discarded);
1032 } else {
1033 verifier.TestMemberIsUndefined(received_rtp.packets_discarded);
1034 }
Henrik Boström2f71b612021-03-23 14:18:551035 }
1036
Henrik Boström883eefc2019-05-27 11:40:251037 bool VerifyRTCRemoteInboundRtpStreamStats(
1038 const RTCRemoteInboundRtpStreamStats& remote_inbound_stream) {
Niels Möllerafb246b2022-04-20 12:26:501039 RTCStatsVerifier verifier(report_.get(), &remote_inbound_stream);
Minyue Li28a2c632021-07-07 13:53:381040 VerifyRTCReceivedRtpStreamStats(remote_inbound_stream, verifier, false);
Di Wu86f04ad2021-03-01 07:36:031041 verifier.TestMemberIsDefined(remote_inbound_stream.fraction_lost);
Henrik Boström883eefc2019-05-27 11:40:251042 verifier.TestMemberIsIDReference(remote_inbound_stream.local_id,
1043 RTCOutboundRTPStreamStats::kType);
1044 verifier.TestMemberIsNonNegative<double>(
1045 remote_inbound_stream.round_trip_time);
Di Wu88a51b22021-03-01 19:22:061046 verifier.TestMemberIsNonNegative<double>(
1047 remote_inbound_stream.total_round_trip_time);
1048 verifier.TestMemberIsNonNegative<int32_t>(
1049 remote_inbound_stream.round_trip_time_measurements);
Henrik Boström883eefc2019-05-27 11:40:251050 return verifier.ExpectAllMembersSuccessfullyTested();
1051 }
1052
Alessio Bazzicaf7b1b952021-03-23 16:23:041053 bool VerifyRTCRemoteOutboundRTPStreamStats(
1054 const RTCRemoteOutboundRtpStreamStats& remote_outbound_stream) {
Niels Möllerafb246b2022-04-20 12:26:501055 RTCStatsVerifier verifier(report_.get(), &remote_outbound_stream);
Alessio Bazzicaf7b1b952021-03-23 16:23:041056 VerifyRTCRTPStreamStats(remote_outbound_stream, verifier);
1057 VerifyRTCSentRTPStreamStats(remote_outbound_stream, verifier);
1058 verifier.TestMemberIsIDReference(remote_outbound_stream.local_id,
1059 RTCOutboundRTPStreamStats::kType);
1060 verifier.TestMemberIsNonNegative<double>(
1061 remote_outbound_stream.remote_timestamp);
1062 verifier.TestMemberIsDefined(remote_outbound_stream.reports_sent);
1063 return verifier.ExpectAllMembersSuccessfullyTested();
1064 }
1065
Henrik Boström646fda02019-05-22 13:49:421066 void VerifyRTCMediaSourceStats(const RTCMediaSourceStats& media_source,
1067 RTCStatsVerifier* verifier) {
1068 verifier->TestMemberIsDefined(media_source.track_identifier);
1069 verifier->TestMemberIsDefined(media_source.kind);
1070 if (media_source.kind.is_defined()) {
1071 EXPECT_TRUE((*media_source.kind == "audio" &&
1072 media_source.type() == RTCAudioSourceStats::kType) ||
1073 (*media_source.kind == "video" &&
1074 media_source.type() == RTCVideoSourceStats::kType));
1075 }
1076 }
1077
1078 bool VerifyRTCAudioSourceStats(const RTCAudioSourceStats& audio_source) {
Niels Möllerafb246b2022-04-20 12:26:501079 RTCStatsVerifier verifier(report_.get(), &audio_source);
Henrik Boström646fda02019-05-22 13:49:421080 VerifyRTCMediaSourceStats(audio_source, &verifier);
Henrik Boström262bbae2019-09-13 09:34:551081 // Audio level, unlike audio energy, only gets updated at a certain
1082 // frequency, so we don't require that one to be positive to avoid a race
1083 // (https://crbug.com/webrtc/10962).
1084 verifier.TestMemberIsNonNegative<double>(audio_source.audio_level);
Henrik Boströmd2c336f2019-07-03 15:11:101085 verifier.TestMemberIsPositive<double>(audio_source.total_audio_energy);
1086 verifier.TestMemberIsPositive<double>(audio_source.total_samples_duration);
Artem Titov880fa812021-07-30 20:30:231087 // TODO(hbos): `echo_return_loss` and `echo_return_loss_enhancement` are
Taylor Brandstetter64851c02021-06-24 20:32:501088 // flaky on msan bot (sometimes defined, sometimes undefined). Should the
1089 // test run until available or is there a way to have it always be
1090 // defined? crbug.com/627816
1091 verifier.MarkMemberTested(audio_source.echo_return_loss, true);
1092 verifier.MarkMemberTested(audio_source.echo_return_loss_enhancement, true);
Henrik Boström646fda02019-05-22 13:49:421093 return verifier.ExpectAllMembersSuccessfullyTested();
1094 }
1095
1096 bool VerifyRTCVideoSourceStats(const RTCVideoSourceStats& video_source) {
Niels Möllerafb246b2022-04-20 12:26:501097 RTCStatsVerifier verifier(report_.get(), &video_source);
Henrik Boström646fda02019-05-22 13:49:421098 VerifyRTCMediaSourceStats(video_source, &verifier);
1099 // TODO(hbos): This integration test uses fakes that doesn't support
1100 // VideoTrackSourceInterface::Stats. When this is fixed we should
Artem Titov880fa812021-07-30 20:30:231101 // TestMemberIsNonNegative<uint32_t>() for `width` and `height` instead to
Henrik Boström646fda02019-05-22 13:49:421102 // reflect real code.
1103 verifier.TestMemberIsUndefined(video_source.width);
1104 verifier.TestMemberIsUndefined(video_source.height);
Di Wu668dbf62021-02-27 08:29:151105 verifier.TestMemberIsNonNegative<uint32_t>(video_source.frames);
Byoungchan Leeefe46b62021-11-10 02:23:561106 verifier.TestMemberIsNonNegative<double>(video_source.frames_per_second);
Henrik Boström646fda02019-05-22 13:49:421107 return verifier.ExpectAllMembersSuccessfullyTested();
1108 }
1109
Yves Gerey665174f2018-06-19 13:03:051110 bool VerifyRTCTransportStats(const RTCTransportStats& transport) {
Niels Möllerafb246b2022-04-20 12:26:501111 RTCStatsVerifier verifier(report_.get(), &transport);
hbos23351192017-01-02 14:52:191112 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_sent);
Artem Titovedacbd52020-07-06 14:06:371113 verifier.TestMemberIsNonNegative<uint64_t>(transport.packets_sent);
hbos23351192017-01-02 14:52:191114 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_received);
Artem Titovedacbd52020-07-06 14:06:371115 verifier.TestMemberIsNonNegative<uint64_t>(transport.packets_received);
Yves Gerey665174f2018-06-19 13:03:051116 verifier.TestMemberIsOptionalIDReference(transport.rtcp_transport_stats_id,
1117 RTCTransportStats::kType);
hbos7064d592017-01-16 15:38:021118 verifier.TestMemberIsDefined(transport.dtls_state);
Yves Gerey665174f2018-06-19 13:03:051119 verifier.TestMemberIsIDReference(transport.selected_candidate_pair_id,
1120 RTCIceCandidatePairStats::kType);
1121 verifier.TestMemberIsIDReference(transport.local_certificate_id,
1122 RTCCertificateStats::kType);
1123 verifier.TestMemberIsIDReference(transport.remote_certificate_id,
1124 RTCCertificateStats::kType);
Harald Alvestrand5cb78072019-10-28 08:51:171125 verifier.TestMemberIsDefined(transport.tls_version);
1126 verifier.TestMemberIsDefined(transport.dtls_cipher);
Philipp Hancke69c1df22022-04-22 13:46:241127 verifier.TestMemberIsDefined(transport.dtls_role);
Harald Alvestrand5cb78072019-10-28 08:51:171128 verifier.TestMemberIsDefined(transport.srtp_cipher);
Jonas Oreland149dc722019-08-28 06:10:271129 verifier.TestMemberIsPositive<uint32_t>(
1130 transport.selected_candidate_pair_changes);
Philipp Hanckecc1b9b02022-05-04 16:58:261131 verifier.TestMemberIsDefined(transport.ice_role);
Philipp Hancke95b1a342022-05-05 05:53:541132 verifier.TestMemberIsDefined(transport.ice_local_username_fragment);
Philipp Hancke1f491572022-05-09 15:43:311133 verifier.TestMemberIsDefined(transport.ice_state);
hbosdb346a72016-11-29 09:57:011134 return verifier.ExpectAllMembersSuccessfullyTested();
1135 }
1136
1137 private:
1138 rtc::scoped_refptr<const RTCStatsReport> report_;
1139};
1140
Mirko Bonadei5eb43b42021-01-18 12:24:401141#ifdef WEBRTC_HAVE_SCTP
hbosdb346a72016-11-29 09:57:011142TEST_F(RTCStatsIntegrationTest, GetStatsFromCaller) {
1143 StartCall();
1144
1145 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCaller();
Eldar Rello9276e2c2020-06-10 14:53:391146 RTCStatsReportVerifier(report.get()).VerifyReport({});
Doudou Kisabaka2dec4962019-11-28 13:24:311147
Henrik Boströma0ff50c2020-05-05 13:54:461148#if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 21:35:041149 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
Jianhui Daib1ba8532022-05-13 02:40:251150#endif
hbosdb346a72016-11-29 09:57:011151}
1152
1153TEST_F(RTCStatsIntegrationTest, GetStatsFromCallee) {
1154 StartCall();
1155
1156 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
Eldar Rello9276e2c2020-06-10 14:53:391157 RTCStatsReportVerifier(report.get()).VerifyReport({});
Doudou Kisabaka2dec4962019-11-28 13:24:311158
Henrik Boströma0ff50c2020-05-05 13:54:461159#if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 21:35:041160 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
Jianhui Daib1ba8532022-05-13 02:40:251161#endif
hbosdb346a72016-11-29 09:57:011162}
1163
Henrik Boström1df1bf82018-03-20 12:24:201164// These tests exercise the integration of the stats selection algorithm inside
1165// of PeerConnection. See rtcstatstraveral_unittest.cc for more detailed stats
1166// traversal tests on particular stats graphs.
1167TEST_F(RTCStatsIntegrationTest, GetStatsWithSenderSelector) {
1168 StartCall();
1169 ASSERT_FALSE(caller_->pc()->GetSenders().empty());
1170 rtc::scoped_refptr<const RTCStatsReport> report =
1171 GetStatsFromCaller(caller_->pc()->GetSenders()[0]);
1172 std::vector<const char*> allowed_missing_stats = {
1173 // TODO(hbos): Include RTC[Audio/Video]ReceiverStats when implemented.
1174 // TODO(hbos): Include RTCRemoteOutboundRtpStreamStats when implemented.
1175 // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
Jonas Olssona4d87372019-07-05 17:08:331176 RTCInboundRTPStreamStats::kType,
1177 RTCPeerConnectionStats::kType,
1178 RTCMediaStreamStats::kType,
1179 RTCDataChannelStats::kType,
Henrik Boström1df1bf82018-03-20 12:24:201180 };
Eldar Rello9276e2c2020-06-10 14:53:391181 RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
Henrik Boström1df1bf82018-03-20 12:24:201182 EXPECT_TRUE(report->size());
1183}
1184
1185TEST_F(RTCStatsIntegrationTest, GetStatsWithReceiverSelector) {
1186 StartCall();
1187
1188 ASSERT_FALSE(caller_->pc()->GetReceivers().empty());
1189 rtc::scoped_refptr<const RTCStatsReport> report =
1190 GetStatsFromCaller(caller_->pc()->GetReceivers()[0]);
1191 std::vector<const char*> allowed_missing_stats = {
1192 // TODO(hbos): Include RTC[Audio/Video]SenderStats when implemented.
1193 // TODO(hbos): Include RTCRemoteInboundRtpStreamStats when implemented.
1194 // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
Jonas Olssona4d87372019-07-05 17:08:331195 RTCOutboundRTPStreamStats::kType,
1196 RTCPeerConnectionStats::kType,
1197 RTCMediaStreamStats::kType,
1198 RTCDataChannelStats::kType,
Henrik Boström1df1bf82018-03-20 12:24:201199 };
Eldar Rello9276e2c2020-06-10 14:53:391200 RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
Henrik Boström1df1bf82018-03-20 12:24:201201 EXPECT_TRUE(report->size());
1202}
1203
1204TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidSenderSelector) {
1205 StartCall();
1206
1207 ASSERT_FALSE(callee_->pc()->GetSenders().empty());
1208 // The selector is invalid for the caller because it belongs to the callee.
1209 auto invalid_selector = callee_->pc()->GetSenders()[0];
1210 rtc::scoped_refptr<const RTCStatsReport> report =
1211 GetStatsFromCaller(invalid_selector);
1212 EXPECT_FALSE(report->size());
1213}
1214
1215TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidReceiverSelector) {
1216 StartCall();
1217
1218 ASSERT_FALSE(callee_->pc()->GetReceivers().empty());
1219 // The selector is invalid for the caller because it belongs to the callee.
1220 auto invalid_selector = callee_->pc()->GetReceivers()[0];
1221 rtc::scoped_refptr<const RTCStatsReport> report =
1222 GetStatsFromCaller(invalid_selector);
1223 EXPECT_FALSE(report->size());
1224}
1225
Yves Gerey59cfd352018-11-26 15:22:201226// TODO(bugs.webrtc.org/10041) For now this is equivalent to the following
1227// test GetsStatsWhileClosingPeerConnection, because pc() is closed by
1228// PeerConnectionTestWrapper. See: bugs.webrtc.org/9847
Yves Gereyb5bb5132018-11-14 17:00:141229TEST_F(RTCStatsIntegrationTest,
Yves Gerey59cfd352018-11-26 15:22:201230 DISABLED_GetStatsWhileDestroyingPeerConnection) {
hbosb78306a2016-12-19 13:06:571231 StartCall();
1232
1233 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1234 RTCStatsObtainer::Create();
Niels Möllerafb246b2022-04-20 12:26:501235 caller_->pc()->GetStats(stats_obtainer.get());
hbosb78306a2016-12-19 13:06:571236 // This will destroy the peer connection.
1237 caller_ = nullptr;
1238 // Any pending stats requests should have completed in the act of destroying
1239 // the peer connection.
Steve Anton25cfeb92018-04-26 18:44:001240 ASSERT_TRUE(stats_obtainer->report());
Jianhui Daib1ba8532022-05-13 02:40:251241#if RTC_TRACE_EVENTS_ENABLED
Steve Anton25cfeb92018-04-26 18:44:001242 EXPECT_EQ(stats_obtainer->report()->ToJson(),
1243 RTCStatsReportTraceListener::last_trace());
Jianhui Daib1ba8532022-05-13 02:40:251244#endif
Steve Anton25cfeb92018-04-26 18:44:001245}
1246
1247TEST_F(RTCStatsIntegrationTest, GetsStatsWhileClosingPeerConnection) {
1248 StartCall();
1249
1250 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1251 RTCStatsObtainer::Create();
Niels Möllerafb246b2022-04-20 12:26:501252 caller_->pc()->GetStats(stats_obtainer.get());
Steve Anton25cfeb92018-04-26 18:44:001253 caller_->pc()->Close();
1254
1255 ASSERT_TRUE(stats_obtainer->report());
Jianhui Daib1ba8532022-05-13 02:40:251256#if RTC_TRACE_EVENTS_ENABLED
ehmaldonado8ab0fd82017-09-04 21:35:041257 EXPECT_EQ(stats_obtainer->report()->ToJson(),
1258 RTCStatsReportTraceListener::last_trace());
Jianhui Daib1ba8532022-05-13 02:40:251259#endif
hbosb78306a2016-12-19 13:06:571260}
Henrik Boströmb6199362018-03-12 09:27:551261
1262// GetStatsReferencedIds() is optimized to recognize what is or isn't a
1263// referenced ID based on dictionary type information and knowing what members
1264// are used as references, as opposed to iterating all members to find the ones
1265// with the "Id" or "Ids" suffix. As such, GetStatsReferencedIds() is tested as
1266// an integration test instead of a unit test in order to guard against adding
1267// new references and forgetting to update GetStatsReferencedIds().
1268TEST_F(RTCStatsIntegrationTest, GetStatsReferencedIds) {
1269 StartCall();
1270
1271 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1272 for (const RTCStats& stats : *report) {
1273 // Find all references by looking at all string members with the "Id" or
1274 // "Ids" suffix.
1275 std::set<const std::string*> expected_ids;
1276 for (const auto* member : stats.Members()) {
1277 if (!member->is_defined())
1278 continue;
1279 if (member->type() == RTCStatsMemberInterface::kString) {
Steve Anton68586e82018-12-14 01:41:251280 if (absl::EndsWith(member->name(), "Id")) {
Henrik Boströmb6199362018-03-12 09:27:551281 const auto& id = member->cast_to<const RTCStatsMember<std::string>>();
1282 expected_ids.insert(&(*id));
1283 }
1284 } else if (member->type() == RTCStatsMemberInterface::kSequenceString) {
Steve Anton68586e82018-12-14 01:41:251285 if (absl::EndsWith(member->name(), "Ids")) {
Henrik Boströmb6199362018-03-12 09:27:551286 const auto& ids =
1287 member->cast_to<const RTCStatsMember<std::vector<std::string>>>();
1288 for (const std::string& id : *ids)
1289 expected_ids.insert(&id);
1290 }
1291 }
1292 }
1293
1294 std::vector<const std::string*> neighbor_ids = GetStatsReferencedIds(stats);
1295 EXPECT_EQ(neighbor_ids.size(), expected_ids.size());
1296 for (const std::string* neighbor_id : neighbor_ids) {
Steve Anton64b626b2019-01-29 01:25:261297 EXPECT_THAT(expected_ids, Contains(neighbor_id));
Henrik Boströmb6199362018-03-12 09:27:551298 }
1299 for (const std::string* expected_id : expected_ids) {
Steve Anton64b626b2019-01-29 01:25:261300 EXPECT_THAT(neighbor_ids, Contains(expected_id));
Henrik Boströmb6199362018-03-12 09:27:551301 }
1302 }
1303}
Henrik Boström943ad972021-04-08 07:30:051304
1305TEST_F(RTCStatsIntegrationTest, GetStatsContainsNoDuplicateMembers) {
1306 StartCall();
1307
1308 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1309 for (const RTCStats& stats : *report) {
1310 std::set<std::string> member_names;
1311 for (const auto* member : stats.Members()) {
1312 EXPECT_TRUE(member_names.find(member->name()) == member_names.end())
1313 << member->name() << " is a duplicate!";
1314 member_names.insert(member->name());
1315 }
1316 }
1317}
Mirko Bonadei5eb43b42021-01-18 12:24:401318#endif // WEBRTC_HAVE_SCTP
hbosb78306a2016-12-19 13:06:571319
hbosdb346a72016-11-29 09:57:011320} // namespace
1321
1322} // namespace webrtc