blob: b6c92f368f10e488228caa341a8e6f8040fa6f1e [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
11#include <set>
12#include <vector>
13
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020014#include "api/audio_codecs/builtin_audio_decoder_factory.h"
15#include "api/audio_codecs/builtin_audio_encoder_factory.h"
16#include "api/datachannelinterface.h"
17#include "api/peerconnectioninterface.h"
18#include "api/stats/rtcstats_objects.h"
19#include "api/stats/rtcstatsreport.h"
20#include "pc/test/peerconnectiontestwrapper.h"
21#include "pc/test/rtcstatsobtainer.h"
22#include "rtc_base/checks.h"
23#include "rtc_base/event_tracer.h"
24#include "rtc_base/gunit.h"
25#include "rtc_base/refcountedobject.h"
26#include "rtc_base/scoped_ref_ptr.h"
27#include "rtc_base/trace_event.h"
28#include "rtc_base/virtualsocketserver.h"
hbosdb346a72016-11-29 01:57:01 -080029
30namespace webrtc {
31
32namespace {
33
34const int64_t kGetStatsTimeoutMs = 10000;
35
ehmaldonado80c829f2017-07-18 07:35:19 -070036const unsigned char* GetCategoryEnabledHandler(const char* name) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -070037 if (strcmp("webrtc_stats", name) != 0) {
38 return reinterpret_cast<const unsigned char*>("");
39 }
40 return reinterpret_cast<const unsigned char*>(name);
ehmaldonado80c829f2017-07-18 07:35:19 -070041}
42
ehmaldonado8ab0fd82017-09-04 14:35:04 -070043class RTCStatsReportTraceListener {
44 public:
45 static void SetUp() {
46 if (!traced_report_)
47 traced_report_ = new RTCStatsReportTraceListener();
48 traced_report_->last_trace_ = "";
49 SetupEventTracer(&GetCategoryEnabledHandler,
50 &RTCStatsReportTraceListener::AddTraceEventHandler);
51 }
52
53 static const std::string& last_trace() {
54 RTC_DCHECK(traced_report_);
55 return traced_report_->last_trace_;
56 }
57
58 private:
Steve Anton36b29d12017-10-30 09:57:42 -070059 static void AddTraceEventHandler(
60 char phase,
61 const unsigned char* category_enabled,
62 const char* name,
63 unsigned long long id, // NOLINT(runtime/int)
64 int num_args,
65 const char** arg_names,
66 const unsigned char* arg_types,
67 const unsigned long long* arg_values, // NOLINT(runtime/int)
68 unsigned char flags) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -070069 RTC_DCHECK(traced_report_);
70 EXPECT_STREQ("webrtc_stats",
71 reinterpret_cast<const char*>(category_enabled));
72 EXPECT_STREQ("webrtc_stats", name);
73 EXPECT_EQ(1, num_args);
74 EXPECT_STREQ("report", arg_names[0]);
75 EXPECT_EQ(TRACE_VALUE_TYPE_COPY_STRING, arg_types[0]);
76
77 traced_report_->last_trace_ = reinterpret_cast<const char*>(arg_values[0]);
78 }
79
80 static RTCStatsReportTraceListener* traced_report_;
81 std::string last_trace_;
82};
83
84RTCStatsReportTraceListener* RTCStatsReportTraceListener::traced_report_ =
85 nullptr;
ehmaldonado80c829f2017-07-18 07:35:19 -070086
hbosdb346a72016-11-29 01:57:01 -080087class RTCStatsIntegrationTest : public testing::Test {
88 public:
89 RTCStatsIntegrationTest()
tommie7251592017-07-14 14:44:46 -070090 : network_thread_(new rtc::Thread(&virtual_socket_server_)),
91 worker_thread_(rtc::Thread::Create()) {
ehmaldonado8ab0fd82017-09-04 14:35:04 -070092 RTCStatsReportTraceListener::SetUp();
ehmaldonado80c829f2017-07-18 07:35:19 -070093
tommie7251592017-07-14 14:44:46 -070094 RTC_CHECK(network_thread_->Start());
95 RTC_CHECK(worker_thread_->Start());
hbosdb346a72016-11-29 01:57:01 -080096
97 caller_ = new rtc::RefCountedObject<PeerConnectionTestWrapper>(
tommie7251592017-07-14 14:44:46 -070098 "caller", network_thread_.get(), worker_thread_.get());
hbosdb346a72016-11-29 01:57:01 -080099 callee_ = new rtc::RefCountedObject<PeerConnectionTestWrapper>(
tommie7251592017-07-14 14:44:46 -0700100 "callee", network_thread_.get(), worker_thread_.get());
hbosdb346a72016-11-29 01:57:01 -0800101 }
102
103 void StartCall() {
104 // Create PeerConnections and "connect" sigslots
105 PeerConnectionInterface::RTCConfiguration config;
106 PeerConnectionInterface::IceServer ice_server;
107 ice_server.uri = "stun:1.1.1.1:3478";
108 config.servers.push_back(ice_server);
kwiberg9e5b11e2017-04-19 03:47:57 -0700109 EXPECT_TRUE(caller_->CreatePc(nullptr, config,
110 CreateBuiltinAudioEncoderFactory(),
111 CreateBuiltinAudioDecoderFactory()));
112 EXPECT_TRUE(callee_->CreatePc(nullptr, config,
113 CreateBuiltinAudioEncoderFactory(),
114 CreateBuiltinAudioDecoderFactory()));
hbosdb346a72016-11-29 01:57:01 -0800115 PeerConnectionTestWrapper::Connect(caller_.get(), callee_.get());
116
117 // Get user media for audio and video
118 caller_->GetAndAddUserMedia(true, FakeConstraints(),
119 true, FakeConstraints());
120 callee_->GetAndAddUserMedia(true, FakeConstraints(),
121 true, FakeConstraints());
122
123 // Create data channels
124 DataChannelInit init;
125 caller_->CreateDataChannel("data", init);
126 callee_->CreateDataChannel("data", init);
127
128 // Negotiate and wait for call to establish
129 caller_->CreateOffer(nullptr);
130 caller_->WaitForCallEstablished();
131 callee_->WaitForCallEstablished();
132 }
133
134 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller() {
135 return GetStats(caller_->pc());
136 }
137
138 rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee() {
139 return GetStats(callee_->pc());
140 }
141
142 protected:
143 static rtc::scoped_refptr<const RTCStatsReport> GetStats(
144 PeerConnectionInterface* pc) {
145 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
146 RTCStatsObtainer::Create();
147 pc->GetStats(stats_obtainer);
148 EXPECT_TRUE_WAIT(stats_obtainer->report(), kGetStatsTimeoutMs);
149 return stats_obtainer->report();
150 }
151
deadbeef98e186c2017-05-16 18:00:06 -0700152 // |network_thread_| uses |virtual_socket_server_| so they must be
153 // constructed/destructed in the correct order.
hbosdb346a72016-11-29 01:57:01 -0800154 rtc::VirtualSocketServer virtual_socket_server_;
tommie7251592017-07-14 14:44:46 -0700155 std::unique_ptr<rtc::Thread> network_thread_;
156 std::unique_ptr<rtc::Thread> worker_thread_;
hbosdb346a72016-11-29 01:57:01 -0800157 rtc::scoped_refptr<PeerConnectionTestWrapper> caller_;
158 rtc::scoped_refptr<PeerConnectionTestWrapper> callee_;
159};
160
161class RTCStatsVerifier {
162 public:
163 RTCStatsVerifier(const RTCStatsReport* report, const RTCStats* stats)
164 : report_(report), stats_(stats), all_tests_successful_(true) {
165 RTC_CHECK(report_);
166 RTC_CHECK(stats_);
167 for (const RTCStatsMemberInterface* member : stats_->Members()) {
168 untested_members_.insert(member);
169 }
170 }
171
172 void MarkMemberTested(
173 const RTCStatsMemberInterface& member, bool test_successful) {
174 untested_members_.erase(&member);
175 all_tests_successful_ &= test_successful;
176 }
177
178 void TestMemberIsDefined(const RTCStatsMemberInterface& member) {
179 EXPECT_TRUE(member.is_defined()) <<
hbos23351192017-01-02 06:52:19 -0800180 stats_->type() << "." << member.name() << "[" << stats_->id() <<
181 "] was undefined.";
hbosdb346a72016-11-29 01:57:01 -0800182 MarkMemberTested(member, member.is_defined());
183 }
184
185 void TestMemberIsUndefined(const RTCStatsMemberInterface& member) {
186 EXPECT_FALSE(member.is_defined()) <<
hbos23351192017-01-02 06:52:19 -0800187 stats_->type() << "." << member.name() << "[" << stats_->id() <<
188 "] was defined (" << member.ValueToString() << ").";
hbosdb346a72016-11-29 01:57:01 -0800189 MarkMemberTested(member, !member.is_defined());
190 }
191
hbos23351192017-01-02 06:52:19 -0800192 template<typename T>
193 void TestMemberIsPositive(const RTCStatsMemberInterface& member) {
194 EXPECT_TRUE(member.is_defined()) <<
195 stats_->type() << "." << member.name() << "[" << stats_->id() <<
196 "] was undefined.";
197 if (!member.is_defined()) {
198 MarkMemberTested(member, false);
199 return;
200 }
201 bool is_positive = *member.cast_to<RTCStatsMember<T>>() > T(0);
202 EXPECT_TRUE(is_positive) <<
203 stats_->type() << "." << member.name() << "[" << stats_->id() <<
204 "] was not positive (" << member.ValueToString() << ").";
205 MarkMemberTested(member, is_positive);
206 }
207
208 template<typename T>
209 void TestMemberIsNonNegative(const RTCStatsMemberInterface& member) {
210 EXPECT_TRUE(member.is_defined()) <<
211 stats_->type() << "." << member.name() << "[" << stats_->id() <<
212 "] was undefined.";
213 if (!member.is_defined()) {
214 MarkMemberTested(member, false);
215 return;
216 }
217 bool is_non_negative = *member.cast_to<RTCStatsMember<T>>() >= T(0);
218 EXPECT_TRUE(is_non_negative) <<
219 stats_->type() << "." << member.name() << "[" << stats_->id() <<
220 "] was not non-negative (" << member.ValueToString() << ").";
221 MarkMemberTested(member, is_non_negative);
222 }
223
hbosdb346a72016-11-29 01:57:01 -0800224 void TestMemberIsIDReference(
225 const RTCStatsMemberInterface& member,
226 const char* expected_type) {
227 TestMemberIsIDReference(member, expected_type, false);
228 }
229
230 void TestMemberIsOptionalIDReference(
231 const RTCStatsMemberInterface& member,
232 const char* expected_type) {
233 TestMemberIsIDReference(member, expected_type, true);
234 }
235
236 bool ExpectAllMembersSuccessfullyTested() {
237 if (untested_members_.empty())
238 return all_tests_successful_;
239 for (const RTCStatsMemberInterface* member : untested_members_) {
240 EXPECT_TRUE(false) <<
241 stats_->type() << "." << member->name() << "[" << stats_->id() <<
242 "] was not tested.";
243 }
244 return false;
245 }
246
247 private:
248 void TestMemberIsIDReference(
249 const RTCStatsMemberInterface& member,
250 const char* expected_type,
251 bool optional) {
252 if (optional && !member.is_defined()) {
253 MarkMemberTested(member, true);
254 return;
255 }
256 bool valid_reference = false;
257 if (member.is_defined()) {
258 if (member.type() == RTCStatsMemberInterface::kString) {
259 // A single ID.
260 const RTCStatsMember<std::string>& id =
261 member.cast_to<RTCStatsMember<std::string>>();
262 const RTCStats* referenced_stats = report_->Get(*id);
263 valid_reference =
264 referenced_stats && referenced_stats->type() == expected_type;
265 } else if (member.type() == RTCStatsMemberInterface::kSequenceString) {
266 // A vector of IDs.
267 valid_reference = true;
268 const RTCStatsMember<std::vector<std::string>>& ids =
269 member.cast_to<RTCStatsMember<std::vector<std::string>>>();
Mirko Bonadeic61ce0d2017-11-21 17:04:20 +0100270 for (const std::string& id : *ids) {
hbosdb346a72016-11-29 01:57:01 -0800271 const RTCStats* referenced_stats = report_->Get(id);
272 if (!referenced_stats || referenced_stats->type() != expected_type) {
273 valid_reference = false;
274 break;
275 }
276 }
277 }
278 }
279 EXPECT_TRUE(valid_reference) <<
280 stats_->type() << "." << member.name() << " is not a reference to an " <<
281 "existing dictionary of type " << expected_type << " (" <<
282 member.ValueToString() << ").";
283 MarkMemberTested(member, valid_reference);
284 }
285
286 rtc::scoped_refptr<const RTCStatsReport> report_;
287 const RTCStats* stats_;
288 std::set<const RTCStatsMemberInterface*> untested_members_;
289 bool all_tests_successful_;
290};
291
292class RTCStatsReportVerifier {
293 public:
294 static std::set<const char*> StatsTypes() {
295 std::set<const char*> stats_types;
296 stats_types.insert(RTCCertificateStats::kType);
297 stats_types.insert(RTCCodecStats::kType);
298 stats_types.insert(RTCDataChannelStats::kType);
299 stats_types.insert(RTCIceCandidatePairStats::kType);
300 stats_types.insert(RTCLocalIceCandidateStats::kType);
301 stats_types.insert(RTCRemoteIceCandidateStats::kType);
302 stats_types.insert(RTCMediaStreamStats::kType);
303 stats_types.insert(RTCMediaStreamTrackStats::kType);
304 stats_types.insert(RTCPeerConnectionStats::kType);
305 stats_types.insert(RTCInboundRTPStreamStats::kType);
306 stats_types.insert(RTCOutboundRTPStreamStats::kType);
307 stats_types.insert(RTCTransportStats::kType);
308 return stats_types;
309 }
310
311 explicit RTCStatsReportVerifier(const RTCStatsReport* report)
312 : report_(report) {
313 }
314
315 void VerifyReport() {
316 std::set<const char*> missing_stats = StatsTypes();
317 bool verify_successful = true;
hbos338f78a2017-02-07 06:41:21 -0800318 std::vector<const RTCTransportStats*> transport_stats =
319 report_->GetStatsOfType<RTCTransportStats>();
320 EXPECT_EQ(transport_stats.size(), 1);
321 std::string selected_candidate_pair_id =
322 *transport_stats[0]->selected_candidate_pair_id;
hbosdb346a72016-11-29 01:57:01 -0800323 for (const RTCStats& stats : *report_) {
324 missing_stats.erase(stats.type());
325 if (stats.type() == RTCCertificateStats::kType) {
326 verify_successful &= VerifyRTCCertificateStats(
327 stats.cast_to<RTCCertificateStats>());
328 } else if (stats.type() == RTCCodecStats::kType) {
329 verify_successful &= VerifyRTCCodecStats(
330 stats.cast_to<RTCCodecStats>());
331 } else if (stats.type() == RTCDataChannelStats::kType) {
332 verify_successful &= VerifyRTCDataChannelStats(
333 stats.cast_to<RTCDataChannelStats>());
334 } else if (stats.type() == RTCIceCandidatePairStats::kType) {
335 verify_successful &= VerifyRTCIceCandidatePairStats(
hbos338f78a2017-02-07 06:41:21 -0800336 stats.cast_to<RTCIceCandidatePairStats>(),
337 stats.id() == selected_candidate_pair_id);
hbosdb346a72016-11-29 01:57:01 -0800338 } else if (stats.type() == RTCLocalIceCandidateStats::kType) {
339 verify_successful &= VerifyRTCLocalIceCandidateStats(
340 stats.cast_to<RTCLocalIceCandidateStats>());
341 } else if (stats.type() == RTCRemoteIceCandidateStats::kType) {
342 verify_successful &= VerifyRTCRemoteIceCandidateStats(
343 stats.cast_to<RTCRemoteIceCandidateStats>());
344 } else if (stats.type() == RTCMediaStreamStats::kType) {
345 verify_successful &= VerifyRTCMediaStreamStats(
346 stats.cast_to<RTCMediaStreamStats>());
347 } else if (stats.type() == RTCMediaStreamTrackStats::kType) {
348 verify_successful &= VerifyRTCMediaStreamTrackStats(
349 stats.cast_to<RTCMediaStreamTrackStats>());
350 } else if (stats.type() == RTCPeerConnectionStats::kType) {
351 verify_successful &= VerifyRTCPeerConnectionStats(
352 stats.cast_to<RTCPeerConnectionStats>());
353 } else if (stats.type() == RTCInboundRTPStreamStats::kType) {
354 verify_successful &= VerifyRTCInboundRTPStreamStats(
355 stats.cast_to<RTCInboundRTPStreamStats>());
356 } else if (stats.type() == RTCOutboundRTPStreamStats::kType) {
357 verify_successful &= VerifyRTCOutboundRTPStreamStats(
358 stats.cast_to<RTCOutboundRTPStreamStats>());
359 } else if (stats.type() == RTCTransportStats::kType) {
360 verify_successful &= VerifyRTCTransportStats(
361 stats.cast_to<RTCTransportStats>());
362 } else {
363 EXPECT_TRUE(false) << "Unrecognized stats type: " << stats.type();
364 verify_successful = false;
365 }
366 }
367 if (!missing_stats.empty()) {
368 verify_successful = false;
369 for (const char* missing : missing_stats) {
370 EXPECT_TRUE(false) << "Missing expected stats type: " << missing;
371 }
372 }
373 EXPECT_TRUE(verify_successful) <<
374 "One or more problems with the stats. This is the report:\n" <<
ehmaldonado35a872c2017-07-28 07:29:12 -0700375 report_->ToJson();
hbosdb346a72016-11-29 01:57:01 -0800376 }
377
378 bool VerifyRTCCertificateStats(
379 const RTCCertificateStats& certificate) {
380 RTCStatsVerifier verifier(report_, &certificate);
381 verifier.TestMemberIsDefined(certificate.fingerprint);
382 verifier.TestMemberIsDefined(certificate.fingerprint_algorithm);
383 verifier.TestMemberIsDefined(certificate.base64_certificate);
384 verifier.TestMemberIsOptionalIDReference(
385 certificate.issuer_certificate_id, RTCCertificateStats::kType);
386 return verifier.ExpectAllMembersSuccessfullyTested();
387 }
388
389 bool VerifyRTCCodecStats(
390 const RTCCodecStats& codec) {
391 RTCStatsVerifier verifier(report_, &codec);
392 verifier.TestMemberIsDefined(codec.payload_type);
hbos13f54b22017-02-28 06:56:04 -0800393 verifier.TestMemberIsDefined(codec.mime_type);
hbos23351192017-01-02 06:52:19 -0800394 verifier.TestMemberIsPositive<uint32_t>(codec.clock_rate);
hbosdb346a72016-11-29 01:57:01 -0800395 verifier.TestMemberIsUndefined(codec.channels);
hbos13f54b22017-02-28 06:56:04 -0800396 verifier.TestMemberIsUndefined(codec.sdp_fmtp_line);
hbosdb346a72016-11-29 01:57:01 -0800397 verifier.TestMemberIsUndefined(codec.implementation);
398 return verifier.ExpectAllMembersSuccessfullyTested();
399 }
400
401 bool VerifyRTCDataChannelStats(
402 const RTCDataChannelStats& data_channel) {
403 RTCStatsVerifier verifier(report_, &data_channel);
404 verifier.TestMemberIsDefined(data_channel.label);
405 verifier.TestMemberIsDefined(data_channel.protocol);
406 verifier.TestMemberIsDefined(data_channel.datachannelid);
407 verifier.TestMemberIsDefined(data_channel.state);
hbos23351192017-01-02 06:52:19 -0800408 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_sent);
409 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_sent);
410 verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_received);
411 verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_received);
hbosdb346a72016-11-29 01:57:01 -0800412 return verifier.ExpectAllMembersSuccessfullyTested();
413 }
414
415 bool VerifyRTCIceCandidatePairStats(
hbos338f78a2017-02-07 06:41:21 -0800416 const RTCIceCandidatePairStats& candidate_pair, bool is_selected_pair) {
hbosdb346a72016-11-29 01:57:01 -0800417 RTCStatsVerifier verifier(report_, &candidate_pair);
hbos0583b282016-11-30 01:50:14 -0800418 verifier.TestMemberIsIDReference(
419 candidate_pair.transport_id, RTCTransportStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800420 verifier.TestMemberIsIDReference(
421 candidate_pair.local_candidate_id, RTCLocalIceCandidateStats::kType);
422 verifier.TestMemberIsIDReference(
423 candidate_pair.remote_candidate_id, RTCRemoteIceCandidateStats::kType);
hbos06495bc2017-01-02 08:08:18 -0800424 verifier.TestMemberIsDefined(candidate_pair.state);
425 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.priority);
hbos92eaec62017-02-27 01:38:08 -0800426 verifier.TestMemberIsDefined(candidate_pair.nominated);
hbosdb346a72016-11-29 01:57:01 -0800427 verifier.TestMemberIsDefined(candidate_pair.writable);
428 verifier.TestMemberIsUndefined(candidate_pair.readable);
hbos23351192017-01-02 06:52:19 -0800429 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_sent);
430 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_received);
hbosbf8d3e52017-02-28 06:34:47 -0800431 verifier.TestMemberIsNonNegative<double>(
432 candidate_pair.total_round_trip_time);
hbos23351192017-01-02 06:52:19 -0800433 verifier.TestMemberIsNonNegative<double>(
434 candidate_pair.current_round_trip_time);
hbos338f78a2017-02-07 06:41:21 -0800435 if (is_selected_pair) {
436 verifier.TestMemberIsNonNegative<double>(
437 candidate_pair.available_outgoing_bitrate);
deadbeef86c40a12017-06-28 09:37:23 -0700438 // A pair should be nominated in order to be selected.
439 EXPECT_TRUE(*candidate_pair.nominated);
hbos338f78a2017-02-07 06:41:21 -0800440 } else {
441 verifier.TestMemberIsUndefined(candidate_pair.available_outgoing_bitrate);
442 }
hbosdb346a72016-11-29 01:57:01 -0800443 verifier.TestMemberIsUndefined(candidate_pair.available_incoming_bitrate);
hbos23351192017-01-02 06:52:19 -0800444 verifier.TestMemberIsNonNegative<uint64_t>(
445 candidate_pair.requests_received);
446 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.requests_sent);
447 verifier.TestMemberIsNonNegative<uint64_t>(
448 candidate_pair.responses_received);
449 verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.responses_sent);
hbosdb346a72016-11-29 01:57:01 -0800450 verifier.TestMemberIsUndefined(candidate_pair.retransmissions_received);
451 verifier.TestMemberIsUndefined(candidate_pair.retransmissions_sent);
452 verifier.TestMemberIsUndefined(candidate_pair.consent_requests_received);
hbos23351192017-01-02 06:52:19 -0800453 verifier.TestMemberIsNonNegative<uint64_t>(
454 candidate_pair.consent_requests_sent);
hbosdb346a72016-11-29 01:57:01 -0800455 verifier.TestMemberIsUndefined(candidate_pair.consent_responses_received);
456 verifier.TestMemberIsUndefined(candidate_pair.consent_responses_sent);
457 return verifier.ExpectAllMembersSuccessfullyTested();
458 }
459
460 bool VerifyRTCIceCandidateStats(
461 const RTCIceCandidateStats& candidate) {
462 RTCStatsVerifier verifier(report_, &candidate);
hbosb4e426e2017-01-02 09:59:31 -0800463 verifier.TestMemberIsIDReference(
464 candidate.transport_id, RTCTransportStats::kType);
hbosc3a2b7f2017-01-02 04:46:15 -0800465 verifier.TestMemberIsDefined(candidate.is_remote);
Gary Liu37e489c2017-11-21 10:49:36 -0800466 if (*candidate.is_remote) {
467 verifier.TestMemberIsUndefined(candidate.network_type);
468 } else {
469 verifier.TestMemberIsDefined(candidate.network_type);
470 }
hbosdb346a72016-11-29 01:57:01 -0800471 verifier.TestMemberIsDefined(candidate.ip);
hbos23351192017-01-02 06:52:19 -0800472 verifier.TestMemberIsNonNegative<int32_t>(candidate.port);
hbosdb346a72016-11-29 01:57:01 -0800473 verifier.TestMemberIsDefined(candidate.protocol);
474 verifier.TestMemberIsDefined(candidate.candidate_type);
hbos23351192017-01-02 06:52:19 -0800475 verifier.TestMemberIsNonNegative<int32_t>(candidate.priority);
hbosdb346a72016-11-29 01:57:01 -0800476 verifier.TestMemberIsUndefined(candidate.url);
hbosd17a5a72017-01-02 08:09:59 -0800477 verifier.TestMemberIsDefined(candidate.deleted);
hbosdb346a72016-11-29 01:57:01 -0800478 return verifier.ExpectAllMembersSuccessfullyTested();
479 }
480
481 bool VerifyRTCLocalIceCandidateStats(
482 const RTCLocalIceCandidateStats& local_candidate) {
483 return VerifyRTCIceCandidateStats(local_candidate);
484 }
485
486 bool VerifyRTCRemoteIceCandidateStats(
487 const RTCRemoteIceCandidateStats& remote_candidate) {
488 return VerifyRTCIceCandidateStats(remote_candidate);
489 }
490
491 bool VerifyRTCMediaStreamStats(
492 const RTCMediaStreamStats& media_stream) {
493 RTCStatsVerifier verifier(report_, &media_stream);
494 verifier.TestMemberIsDefined(media_stream.stream_identifier);
495 verifier.TestMemberIsIDReference(
496 media_stream.track_ids, RTCMediaStreamTrackStats::kType);
497 return verifier.ExpectAllMembersSuccessfullyTested();
498 }
499
500 bool VerifyRTCMediaStreamTrackStats(
501 const RTCMediaStreamTrackStats& media_stream_track) {
502 RTCStatsVerifier verifier(report_, &media_stream_track);
503 verifier.TestMemberIsDefined(media_stream_track.track_identifier);
504 verifier.TestMemberIsDefined(media_stream_track.remote_source);
505 verifier.TestMemberIsDefined(media_stream_track.ended);
506 verifier.TestMemberIsDefined(media_stream_track.detached);
hbos160e4a72017-01-17 02:53:23 -0800507 verifier.TestMemberIsDefined(media_stream_track.kind);
hbosdb346a72016-11-29 01:57:01 -0800508 // Video or audio media stream track?
hbos160e4a72017-01-17 02:53:23 -0800509 if (*media_stream_track.kind == RTCMediaStreamTrackKind::kVideo) {
hbosdb346a72016-11-29 01:57:01 -0800510 // Video-only members
hbos9e302742017-01-20 02:47:10 -0800511 verifier.TestMemberIsNonNegative<uint32_t>(
512 media_stream_track.frame_width);
513 verifier.TestMemberIsNonNegative<uint32_t>(
514 media_stream_track.frame_height);
hbosdb346a72016-11-29 01:57:01 -0800515 verifier.TestMemberIsUndefined(media_stream_track.frames_per_second);
hbos42f6d2f2017-01-20 03:56:50 -0800516 if (*media_stream_track.remote_source) {
hbosfefe0762017-01-20 06:14:25 -0800517 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
hbos42f6d2f2017-01-20 03:56:50 -0800518 verifier.TestMemberIsNonNegative<uint32_t>(
519 media_stream_track.frames_received);
hbosf64941f2017-01-20 07:39:09 -0800520 verifier.TestMemberIsNonNegative<uint32_t>(
521 media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 07:21:55 -0800522 verifier.TestMemberIsNonNegative<uint32_t>(
523 media_stream_track.frames_dropped);
hbos42f6d2f2017-01-20 03:56:50 -0800524 } else {
hbosfefe0762017-01-20 06:14:25 -0800525 verifier.TestMemberIsNonNegative<uint32_t>(
526 media_stream_track.frames_sent);
hbos42f6d2f2017-01-20 03:56:50 -0800527 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
hbosf64941f2017-01-20 07:39:09 -0800528 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
hbos50cfe1f2017-01-23 07:21:55 -0800529 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
hbos42f6d2f2017-01-20 03:56:50 -0800530 }
hbosdb346a72016-11-29 01:57:01 -0800531 verifier.TestMemberIsUndefined(media_stream_track.frames_corrupted);
532 verifier.TestMemberIsUndefined(media_stream_track.partial_frames_lost);
533 verifier.TestMemberIsUndefined(media_stream_track.full_frames_lost);
534 // Audio-only members should be undefined
535 verifier.TestMemberIsUndefined(media_stream_track.audio_level);
536 verifier.TestMemberIsUndefined(media_stream_track.echo_return_loss);
537 verifier.TestMemberIsUndefined(
538 media_stream_track.echo_return_loss_enhancement);
zsteine76bd3a2017-07-14 12:17:49 -0700539 verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
540 verifier.TestMemberIsUndefined(media_stream_track.total_samples_duration);
hbosdb346a72016-11-29 01:57:01 -0800541 } else {
hbos42f6d2f2017-01-20 03:56:50 -0800542 RTC_DCHECK_EQ(*media_stream_track.kind,
543 RTCMediaStreamTrackKind::kAudio);
hbosdb346a72016-11-29 01:57:01 -0800544 // Video-only members should be undefined
545 verifier.TestMemberIsUndefined(media_stream_track.frame_width);
546 verifier.TestMemberIsUndefined(media_stream_track.frame_height);
547 verifier.TestMemberIsUndefined(media_stream_track.frames_per_second);
548 verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
549 verifier.TestMemberIsUndefined(media_stream_track.frames_received);
550 verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
551 verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
552 verifier.TestMemberIsUndefined(media_stream_track.frames_corrupted);
553 verifier.TestMemberIsUndefined(media_stream_track.partial_frames_lost);
554 verifier.TestMemberIsUndefined(media_stream_track.full_frames_lost);
555 // Audio-only members
hbos9e302742017-01-20 02:47:10 -0800556 verifier.TestMemberIsNonNegative<double>(media_stream_track.audio_level);
zsteine76bd3a2017-07-14 12:17:49 -0700557 verifier.TestMemberIsNonNegative<double>(
558 media_stream_track.total_audio_energy);
559 verifier.TestMemberIsNonNegative<double>(
560 media_stream_track.total_samples_duration);
hbos2d4d6532017-01-20 04:16:41 -0800561 // TODO(hbos): |echo_return_loss| and |echo_return_loss_enhancement| are
562 // flaky on msan bot (sometimes defined, sometimes undefined). Should the
563 // test run until available or is there a way to have it always be
564 // defined? crbug.com/627816
565 verifier.MarkMemberTested(media_stream_track.echo_return_loss, true);
566 verifier.MarkMemberTested(
567 media_stream_track.echo_return_loss_enhancement, true);
hbosdb346a72016-11-29 01:57:01 -0800568 }
Gustaf Ullberg9a2e9062017-09-18 09:28:20 +0200569 // totalSamplesReceived, concealedSamples and concealmentEvents are only
570 // present on inbound audio tracks.
Gustaf Ullbergb0a02072017-10-02 12:00:34 +0200571 // jitterBufferDelay is currently only implemented for audio.
Steve Anton2dbc69f2017-08-24 17:15:13 -0700572 if (*media_stream_track.kind == RTCMediaStreamTrackKind::kAudio &&
573 *media_stream_track.remote_source) {
Gustaf Ullbergb0a02072017-10-02 12:00:34 +0200574 verifier.TestMemberIsNonNegative<double>(
575 media_stream_track.jitter_buffer_delay);
Steve Anton2dbc69f2017-08-24 17:15:13 -0700576 verifier.TestMemberIsNonNegative<uint64_t>(
577 media_stream_track.total_samples_received);
578 verifier.TestMemberIsNonNegative<uint64_t>(
579 media_stream_track.concealed_samples);
Gustaf Ullberg9a2e9062017-09-18 09:28:20 +0200580 verifier.TestMemberIsNonNegative<uint64_t>(
581 media_stream_track.concealment_events);
Steve Anton2dbc69f2017-08-24 17:15:13 -0700582 } else {
Gustaf Ullbergb0a02072017-10-02 12:00:34 +0200583 verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
Steve Anton2dbc69f2017-08-24 17:15:13 -0700584 verifier.TestMemberIsUndefined(media_stream_track.total_samples_received);
585 verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
Gustaf Ullberg9a2e9062017-09-18 09:28:20 +0200586 verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
Steve Anton2dbc69f2017-08-24 17:15:13 -0700587 }
hbosdb346a72016-11-29 01:57:01 -0800588 return verifier.ExpectAllMembersSuccessfullyTested();
589 }
590
591 bool VerifyRTCPeerConnectionStats(
592 const RTCPeerConnectionStats& peer_connection) {
593 RTCStatsVerifier verifier(report_, &peer_connection);
hbos23351192017-01-02 06:52:19 -0800594 verifier.TestMemberIsNonNegative<uint32_t>(
595 peer_connection.data_channels_opened);
596 verifier.TestMemberIsNonNegative<uint32_t>(
597 peer_connection.data_channels_closed);
hbosdb346a72016-11-29 01:57:01 -0800598 return verifier.ExpectAllMembersSuccessfullyTested();
599 }
600
601 void VerifyRTCRTPStreamStats(
602 const RTCRTPStreamStats& stream, RTCStatsVerifier* verifier) {
603 verifier->TestMemberIsDefined(stream.ssrc);
604 verifier->TestMemberIsUndefined(stream.associate_stats_id);
605 verifier->TestMemberIsDefined(stream.is_remote);
606 verifier->TestMemberIsDefined(stream.media_type);
hbos84abeb12017-01-16 06:16:44 -0800607 verifier->TestMemberIsIDReference(
hbosb0ae9202017-01-27 06:35:16 -0800608 stream.track_id, RTCMediaStreamTrackStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800609 verifier->TestMemberIsIDReference(
610 stream.transport_id, RTCTransportStats::kType);
hbos7bf53692016-12-15 03:33:35 -0800611 verifier->TestMemberIsIDReference(stream.codec_id, RTCCodecStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800612 if (stream.media_type.is_defined() && *stream.media_type == "video") {
hbos23351192017-01-02 06:52:19 -0800613 verifier->TestMemberIsNonNegative<uint32_t>(stream.fir_count);
614 verifier->TestMemberIsNonNegative<uint32_t>(stream.pli_count);
615 verifier->TestMemberIsNonNegative<uint32_t>(stream.nack_count);
hbosdb346a72016-11-29 01:57:01 -0800616 } else {
617 verifier->TestMemberIsUndefined(stream.fir_count);
618 verifier->TestMemberIsUndefined(stream.pli_count);
619 verifier->TestMemberIsUndefined(stream.nack_count);
620 }
621 verifier->TestMemberIsUndefined(stream.sli_count);
622 }
623
624 bool VerifyRTCInboundRTPStreamStats(
625 const RTCInboundRTPStreamStats& inbound_stream) {
626 RTCStatsVerifier verifier(report_, &inbound_stream);
627 VerifyRTCRTPStreamStats(inbound_stream, &verifier);
sakal5fec1282017-02-20 06:43:58 -0800628 if (inbound_stream.media_type.is_defined() &&
629 *inbound_stream.media_type == "video") {
630 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.qp_sum);
631 } else {
hbosa51d4f32017-02-16 05:34:48 -0800632 verifier.TestMemberIsUndefined(inbound_stream.qp_sum);
sakal5fec1282017-02-20 06:43:58 -0800633 }
hbos23351192017-01-02 06:52:19 -0800634 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.packets_received);
635 verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.bytes_received);
636 verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.packets_lost);
hbosdb346a72016-11-29 01:57:01 -0800637 if (inbound_stream.media_type.is_defined() &&
638 *inbound_stream.media_type == "video") {
639 verifier.TestMemberIsUndefined(inbound_stream.jitter);
640 } else {
hbos23351192017-01-02 06:52:19 -0800641 verifier.TestMemberIsNonNegative<double>(inbound_stream.jitter);
hbosdb346a72016-11-29 01:57:01 -0800642 }
hbos23351192017-01-02 06:52:19 -0800643 verifier.TestMemberIsNonNegative<double>(inbound_stream.fraction_lost);
hbosa7a9be12017-03-01 01:02:45 -0800644 verifier.TestMemberIsUndefined(inbound_stream.round_trip_time);
hbosdb346a72016-11-29 01:57:01 -0800645 verifier.TestMemberIsUndefined(inbound_stream.packets_discarded);
646 verifier.TestMemberIsUndefined(inbound_stream.packets_repaired);
647 verifier.TestMemberIsUndefined(inbound_stream.burst_packets_lost);
648 verifier.TestMemberIsUndefined(inbound_stream.burst_packets_discarded);
649 verifier.TestMemberIsUndefined(inbound_stream.burst_loss_count);
650 verifier.TestMemberIsUndefined(inbound_stream.burst_discard_count);
651 verifier.TestMemberIsUndefined(inbound_stream.burst_loss_rate);
652 verifier.TestMemberIsUndefined(inbound_stream.burst_discard_rate);
653 verifier.TestMemberIsUndefined(inbound_stream.gap_loss_rate);
654 verifier.TestMemberIsUndefined(inbound_stream.gap_discard_rate);
hbos6769c492017-01-02 08:35:13 -0800655 if (inbound_stream.media_type.is_defined() &&
656 *inbound_stream.media_type == "video") {
657 verifier.TestMemberIsDefined(inbound_stream.frames_decoded);
658 } else {
659 verifier.TestMemberIsUndefined(inbound_stream.frames_decoded);
660 }
hbosdb346a72016-11-29 01:57:01 -0800661 return verifier.ExpectAllMembersSuccessfullyTested();
662 }
663
664 bool VerifyRTCOutboundRTPStreamStats(
665 const RTCOutboundRTPStreamStats& outbound_stream) {
666 RTCStatsVerifier verifier(report_, &outbound_stream);
667 VerifyRTCRTPStreamStats(outbound_stream, &verifier);
hbos6769c492017-01-02 08:35:13 -0800668 if (outbound_stream.media_type.is_defined() &&
669 *outbound_stream.media_type == "video") {
670 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.qp_sum);
671 } else {
672 verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
673 }
hbos23351192017-01-02 06:52:19 -0800674 verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.packets_sent);
675 verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.bytes_sent);
hbosdb346a72016-11-29 01:57:01 -0800676 verifier.TestMemberIsUndefined(outbound_stream.target_bitrate);
hbos6769c492017-01-02 08:35:13 -0800677 if (outbound_stream.media_type.is_defined() &&
678 *outbound_stream.media_type == "video") {
679 verifier.TestMemberIsDefined(outbound_stream.frames_encoded);
680 } else {
681 verifier.TestMemberIsUndefined(outbound_stream.frames_encoded);
682 }
hbosdb346a72016-11-29 01:57:01 -0800683 return verifier.ExpectAllMembersSuccessfullyTested();
684 }
685
686 bool VerifyRTCTransportStats(
687 const RTCTransportStats& transport) {
688 RTCStatsVerifier verifier(report_, &transport);
hbos23351192017-01-02 06:52:19 -0800689 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_sent);
690 verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_received);
hbosdb346a72016-11-29 01:57:01 -0800691 verifier.TestMemberIsOptionalIDReference(
692 transport.rtcp_transport_stats_id, RTCTransportStats::kType);
hbos7064d592017-01-16 07:38:02 -0800693 verifier.TestMemberIsDefined(transport.dtls_state);
hbos7bf53692016-12-15 03:33:35 -0800694 verifier.TestMemberIsIDReference(
695 transport.selected_candidate_pair_id, RTCIceCandidatePairStats::kType);
696 verifier.TestMemberIsIDReference(
697 transport.local_certificate_id, RTCCertificateStats::kType);
698 verifier.TestMemberIsIDReference(
699 transport.remote_certificate_id, RTCCertificateStats::kType);
hbosdb346a72016-11-29 01:57:01 -0800700 return verifier.ExpectAllMembersSuccessfullyTested();
701 }
702
703 private:
704 rtc::scoped_refptr<const RTCStatsReport> report_;
705};
706
deadbeef40610e22016-12-22 10:53:38 -0800707#ifdef HAVE_SCTP
hbosdb346a72016-11-29 01:57:01 -0800708TEST_F(RTCStatsIntegrationTest, GetStatsFromCaller) {
709 StartCall();
710
711 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCaller();
712 RTCStatsReportVerifier(report.get()).VerifyReport();
ehmaldonado8ab0fd82017-09-04 14:35:04 -0700713 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
hbosdb346a72016-11-29 01:57:01 -0800714}
715
716TEST_F(RTCStatsIntegrationTest, GetStatsFromCallee) {
717 StartCall();
718
719 rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
720 RTCStatsReportVerifier(report.get()).VerifyReport();
ehmaldonado8ab0fd82017-09-04 14:35:04 -0700721 EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
hbosdb346a72016-11-29 01:57:01 -0800722}
723
hbosb78306a2016-12-19 05:06:57 -0800724TEST_F(RTCStatsIntegrationTest, GetsStatsWhileDestroyingPeerConnections) {
725 StartCall();
726
727 rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
728 RTCStatsObtainer::Create();
729 caller_->pc()->GetStats(stats_obtainer);
730 // This will destroy the peer connection.
731 caller_ = nullptr;
732 // Any pending stats requests should have completed in the act of destroying
733 // the peer connection.
734 EXPECT_TRUE(stats_obtainer->report());
ehmaldonado8ab0fd82017-09-04 14:35:04 -0700735 EXPECT_EQ(stats_obtainer->report()->ToJson(),
736 RTCStatsReportTraceListener::last_trace());
hbosb78306a2016-12-19 05:06:57 -0800737}
deadbeef40610e22016-12-22 10:53:38 -0800738#endif // HAVE_SCTP
hbosb78306a2016-12-19 05:06:57 -0800739
hbosdb346a72016-11-29 01:57:01 -0800740} // namespace
741
742} // namespace webrtc