1 /*
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 <stdint.h>
12 #include <string.h>
13 
14 #include <algorithm>
15 #include <memory>
16 #include <set>
17 #include <string>
18 #include <vector>
19 
20 #include "absl/algorithm/container.h"
21 #include "absl/strings/match.h"
22 #include "api/audio_codecs/audio_decoder_factory.h"
23 #include "api/audio_codecs/audio_encoder_factory.h"
24 #include "api/audio_codecs/builtin_audio_decoder_factory.h"
25 #include "api/audio_codecs/builtin_audio_encoder_factory.h"
26 #include "api/audio_options.h"
27 #include "api/data_channel_interface.h"
28 #include "api/peer_connection_interface.h"
29 #include "api/rtp_receiver_interface.h"
30 #include "api/rtp_sender_interface.h"
31 #include "api/scoped_refptr.h"
32 #include "api/stats/rtc_stats.h"
33 #include "api/stats/rtc_stats_report.h"
34 #include "api/stats/rtcstats_objects.h"
35 #include "pc/rtc_stats_traversal.h"
36 #include "pc/test/peer_connection_test_wrapper.h"
37 #include "pc/test/rtc_stats_obtainer.h"
38 #include "rtc_base/checks.h"
39 #include "rtc_base/event_tracer.h"
40 #include "rtc_base/gunit.h"
41 #include "rtc_base/ref_counted_object.h"
42 #include "rtc_base/thread.h"
43 #include "rtc_base/trace_event.h"
44 #include "rtc_base/virtual_socket_server.h"
45 #include "test/gmock.h"
46 #include "test/gtest.h"
47 
48 using ::testing::Contains;
49 
50 namespace webrtc {
51 
52 namespace {
53 
54 const int64_t kGetStatsTimeoutMs = 10000;
55 
GetCategoryEnabledHandler(const char * name)56 const unsigned char* GetCategoryEnabledHandler(const char* name) {
57   if (strcmp("webrtc_stats", name) != 0) {
58     return reinterpret_cast<const unsigned char*>("");
59   }
60   return reinterpret_cast<const unsigned char*>(name);
61 }
62 
63 class RTCStatsReportTraceListener {
64  public:
SetUp()65   static void SetUp() {
66     if (!traced_report_)
67       traced_report_ = new RTCStatsReportTraceListener();
68     traced_report_->last_trace_ = "";
69     SetupEventTracer(&GetCategoryEnabledHandler,
70                      &RTCStatsReportTraceListener::AddTraceEventHandler);
71   }
72 
last_trace()73   static const std::string& last_trace() {
74     RTC_DCHECK(traced_report_);
75     return traced_report_->last_trace_;
76   }
77 
78  private:
AddTraceEventHandler(char phase,const unsigned char * category_enabled,const char * name,unsigned long long id,int num_args,const char ** arg_names,const unsigned char * arg_types,const unsigned long long * arg_values,unsigned char flags)79   static void AddTraceEventHandler(
80       char phase,
81       const unsigned char* category_enabled,
82       const char* name,
83       unsigned long long id,  // NOLINT(runtime/int)
84       int num_args,
85       const char** arg_names,
86       const unsigned char* arg_types,
87       const unsigned long long* arg_values,  // NOLINT(runtime/int)
88       unsigned char flags) {
89     RTC_DCHECK(traced_report_);
90     EXPECT_STREQ("webrtc_stats",
91                  reinterpret_cast<const char*>(category_enabled));
92     EXPECT_STREQ("webrtc_stats", name);
93     EXPECT_EQ(1, num_args);
94     EXPECT_STREQ("report", arg_names[0]);
95     EXPECT_EQ(TRACE_VALUE_TYPE_COPY_STRING, arg_types[0]);
96 
97     traced_report_->last_trace_ = reinterpret_cast<const char*>(arg_values[0]);
98   }
99 
100   static RTCStatsReportTraceListener* traced_report_;
101   std::string last_trace_;
102 };
103 
104 RTCStatsReportTraceListener* RTCStatsReportTraceListener::traced_report_ =
105     nullptr;
106 
107 class RTCStatsIntegrationTest : public ::testing::Test {
108  public:
RTCStatsIntegrationTest()109   RTCStatsIntegrationTest()
110       : network_thread_(new rtc::Thread(&virtual_socket_server_)),
111         worker_thread_(rtc::Thread::Create()) {
112     RTCStatsReportTraceListener::SetUp();
113 
114     RTC_CHECK(network_thread_->Start());
115     RTC_CHECK(worker_thread_->Start());
116 
117     caller_ = new rtc::RefCountedObject<PeerConnectionTestWrapper>(
118         "caller", network_thread_.get(), worker_thread_.get());
119     callee_ = new rtc::RefCountedObject<PeerConnectionTestWrapper>(
120         "callee", network_thread_.get(), worker_thread_.get());
121   }
122 
StartCall()123   void StartCall() {
124     // Create PeerConnections and "connect" sigslots
125     PeerConnectionInterface::RTCConfiguration config;
126     PeerConnectionInterface::IceServer ice_server;
127     ice_server.uri = "stun:1.1.1.1:3478";
128     config.servers.push_back(ice_server);
129     EXPECT_TRUE(caller_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
130                                   CreateBuiltinAudioDecoderFactory()));
131     EXPECT_TRUE(callee_->CreatePc(config, CreateBuiltinAudioEncoderFactory(),
132                                   CreateBuiltinAudioDecoderFactory()));
133     PeerConnectionTestWrapper::Connect(caller_.get(), callee_.get());
134 
135     // Get user media for audio and video
136     caller_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
137     callee_->GetAndAddUserMedia(true, cricket::AudioOptions(), true);
138 
139     // Create data channels
140     DataChannelInit init;
141     caller_->CreateDataChannel("data", init);
142     callee_->CreateDataChannel("data", init);
143 
144     // Negotiate and wait for call to establish
145     caller_->CreateOffer(PeerConnectionInterface::RTCOfferAnswerOptions());
146     caller_->WaitForCallEstablished();
147     callee_->WaitForCallEstablished();
148   }
149 
GetStatsFromCaller()150   rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller() {
151     return GetStats(caller_->pc());
152   }
GetStatsFromCaller(rtc::scoped_refptr<RtpSenderInterface> selector)153   rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
154       rtc::scoped_refptr<RtpSenderInterface> selector) {
155     return GetStats(caller_->pc(), selector);
156   }
GetStatsFromCaller(rtc::scoped_refptr<RtpReceiverInterface> selector)157   rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCaller(
158       rtc::scoped_refptr<RtpReceiverInterface> selector) {
159     return GetStats(caller_->pc(), selector);
160   }
161 
GetStatsFromCallee()162   rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee() {
163     return GetStats(callee_->pc());
164   }
GetStatsFromCallee(rtc::scoped_refptr<RtpSenderInterface> selector)165   rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
166       rtc::scoped_refptr<RtpSenderInterface> selector) {
167     return GetStats(callee_->pc(), selector);
168   }
GetStatsFromCallee(rtc::scoped_refptr<RtpReceiverInterface> selector)169   rtc::scoped_refptr<const RTCStatsReport> GetStatsFromCallee(
170       rtc::scoped_refptr<RtpReceiverInterface> selector) {
171     return GetStats(callee_->pc(), selector);
172   }
173 
174  protected:
GetStats(PeerConnectionInterface * pc)175   static rtc::scoped_refptr<const RTCStatsReport> GetStats(
176       PeerConnectionInterface* pc) {
177     rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
178         RTCStatsObtainer::Create();
179     pc->GetStats(stats_obtainer);
180     EXPECT_TRUE_WAIT(stats_obtainer->report(), kGetStatsTimeoutMs);
181     return stats_obtainer->report();
182   }
183 
184   template <typename T>
GetStats(PeerConnectionInterface * pc,rtc::scoped_refptr<T> selector)185   static rtc::scoped_refptr<const RTCStatsReport> GetStats(
186       PeerConnectionInterface* pc,
187       rtc::scoped_refptr<T> selector) {
188     rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
189         RTCStatsObtainer::Create();
190     pc->GetStats(selector, stats_obtainer);
191     EXPECT_TRUE_WAIT(stats_obtainer->report(), kGetStatsTimeoutMs);
192     return stats_obtainer->report();
193   }
194 
195   // |network_thread_| uses |virtual_socket_server_| so they must be
196   // constructed/destructed in the correct order.
197   rtc::VirtualSocketServer virtual_socket_server_;
198   std::unique_ptr<rtc::Thread> network_thread_;
199   std::unique_ptr<rtc::Thread> worker_thread_;
200   rtc::scoped_refptr<PeerConnectionTestWrapper> caller_;
201   rtc::scoped_refptr<PeerConnectionTestWrapper> callee_;
202 };
203 
204 class RTCStatsVerifier {
205  public:
RTCStatsVerifier(const RTCStatsReport * report,const RTCStats * stats)206   RTCStatsVerifier(const RTCStatsReport* report, const RTCStats* stats)
207       : report_(report), stats_(stats), all_tests_successful_(true) {
208     RTC_CHECK(report_);
209     RTC_CHECK(stats_);
210     for (const RTCStatsMemberInterface* member : stats_->Members()) {
211       untested_members_.insert(member);
212     }
213   }
214 
MarkMemberTested(const RTCStatsMemberInterface & member,bool test_successful)215   void MarkMemberTested(const RTCStatsMemberInterface& member,
216                         bool test_successful) {
217     untested_members_.erase(&member);
218     all_tests_successful_ &= test_successful;
219   }
220 
TestMemberIsDefined(const RTCStatsMemberInterface & member)221   void TestMemberIsDefined(const RTCStatsMemberInterface& member) {
222     EXPECT_TRUE(member.is_defined())
223         << stats_->type() << "." << member.name() << "[" << stats_->id()
224         << "] was undefined.";
225     MarkMemberTested(member, member.is_defined());
226   }
227 
TestMemberIsUndefined(const RTCStatsMemberInterface & member)228   void TestMemberIsUndefined(const RTCStatsMemberInterface& member) {
229     EXPECT_FALSE(member.is_defined())
230         << stats_->type() << "." << member.name() << "[" << stats_->id()
231         << "] was defined (" << member.ValueToString() << ").";
232     MarkMemberTested(member, !member.is_defined());
233   }
234 
235   template <typename T>
TestMemberIsPositive(const RTCStatsMemberInterface & member)236   void TestMemberIsPositive(const RTCStatsMemberInterface& member) {
237     EXPECT_TRUE(member.is_defined())
238         << stats_->type() << "." << member.name() << "[" << stats_->id()
239         << "] was undefined.";
240     if (!member.is_defined()) {
241       MarkMemberTested(member, false);
242       return;
243     }
244     bool is_positive = *member.cast_to<RTCStatsMember<T>>() > T(0);
245     EXPECT_TRUE(is_positive)
246         << stats_->type() << "." << member.name() << "[" << stats_->id()
247         << "] was not positive (" << member.ValueToString() << ").";
248     MarkMemberTested(member, is_positive);
249   }
250 
251   template <typename T>
TestMemberIsNonNegative(const RTCStatsMemberInterface & member)252   void TestMemberIsNonNegative(const RTCStatsMemberInterface& member) {
253     EXPECT_TRUE(member.is_defined())
254         << stats_->type() << "." << member.name() << "[" << stats_->id()
255         << "] was undefined.";
256     if (!member.is_defined()) {
257       MarkMemberTested(member, false);
258       return;
259     }
260     bool is_non_negative = *member.cast_to<RTCStatsMember<T>>() >= T(0);
261     EXPECT_TRUE(is_non_negative)
262         << stats_->type() << "." << member.name() << "[" << stats_->id()
263         << "] was not non-negative (" << member.ValueToString() << ").";
264     MarkMemberTested(member, is_non_negative);
265   }
266 
TestMemberIsIDReference(const RTCStatsMemberInterface & member,const char * expected_type)267   void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
268                                const char* expected_type) {
269     TestMemberIsIDReference(member, expected_type, false);
270   }
271 
TestMemberIsOptionalIDReference(const RTCStatsMemberInterface & member,const char * expected_type)272   void TestMemberIsOptionalIDReference(const RTCStatsMemberInterface& member,
273                                        const char* expected_type) {
274     TestMemberIsIDReference(member, expected_type, true);
275   }
276 
ExpectAllMembersSuccessfullyTested()277   bool ExpectAllMembersSuccessfullyTested() {
278     if (untested_members_.empty())
279       return all_tests_successful_;
280     for (const RTCStatsMemberInterface* member : untested_members_) {
281       EXPECT_TRUE(false) << stats_->type() << "." << member->name() << "["
282                          << stats_->id() << "] was not tested.";
283     }
284     return false;
285   }
286 
287  private:
TestMemberIsIDReference(const RTCStatsMemberInterface & member,const char * expected_type,bool optional)288   void TestMemberIsIDReference(const RTCStatsMemberInterface& member,
289                                const char* expected_type,
290                                bool optional) {
291     if (optional && !member.is_defined()) {
292       MarkMemberTested(member, true);
293       return;
294     }
295     bool valid_reference = false;
296     if (member.is_defined()) {
297       if (member.type() == RTCStatsMemberInterface::kString) {
298         // A single ID.
299         const RTCStatsMember<std::string>& id =
300             member.cast_to<RTCStatsMember<std::string>>();
301         const RTCStats* referenced_stats = report_->Get(*id);
302         valid_reference =
303             referenced_stats && referenced_stats->type() == expected_type;
304       } else if (member.type() == RTCStatsMemberInterface::kSequenceString) {
305         // A vector of IDs.
306         valid_reference = true;
307         const RTCStatsMember<std::vector<std::string>>& ids =
308             member.cast_to<RTCStatsMember<std::vector<std::string>>>();
309         for (const std::string& id : *ids) {
310           const RTCStats* referenced_stats = report_->Get(id);
311           if (!referenced_stats || referenced_stats->type() != expected_type) {
312             valid_reference = false;
313             break;
314           }
315         }
316       }
317     }
318     EXPECT_TRUE(valid_reference)
319         << stats_->type() << "." << member.name()
320         << " is not a reference to an "
321            "existing dictionary of type "
322         << expected_type << " (value: "
323         << (member.is_defined() ? member.ValueToString() : "null") << ").";
324     MarkMemberTested(member, valid_reference);
325   }
326 
327   rtc::scoped_refptr<const RTCStatsReport> report_;
328   const RTCStats* stats_;
329   std::set<const RTCStatsMemberInterface*> untested_members_;
330   bool all_tests_successful_;
331 };
332 
333 class RTCStatsReportVerifier {
334  public:
StatsTypes()335   static std::set<const char*> StatsTypes() {
336     std::set<const char*> stats_types;
337     stats_types.insert(RTCCertificateStats::kType);
338     stats_types.insert(RTCCodecStats::kType);
339     stats_types.insert(RTCDataChannelStats::kType);
340     stats_types.insert(RTCIceCandidatePairStats::kType);
341     stats_types.insert(RTCLocalIceCandidateStats::kType);
342     stats_types.insert(RTCRemoteIceCandidateStats::kType);
343     stats_types.insert(RTCMediaStreamStats::kType);
344     stats_types.insert(RTCMediaStreamTrackStats::kType);
345     stats_types.insert(RTCPeerConnectionStats::kType);
346     stats_types.insert(RTCInboundRTPStreamStats::kType);
347     stats_types.insert(RTCOutboundRTPStreamStats::kType);
348     stats_types.insert(RTCTransportStats::kType);
349     return stats_types;
350   }
351 
RTCStatsReportVerifier(const RTCStatsReport * report)352   explicit RTCStatsReportVerifier(const RTCStatsReport* report)
353       : report_(report) {}
354 
VerifyReport(std::vector<const char * > allowed_missing_stats)355   void VerifyReport(std::vector<const char*> allowed_missing_stats) {
356     std::set<const char*> missing_stats = StatsTypes();
357     bool verify_successful = true;
358     std::vector<const RTCTransportStats*> transport_stats =
359         report_->GetStatsOfType<RTCTransportStats>();
360     EXPECT_EQ(transport_stats.size(), 1U);
361     std::string selected_candidate_pair_id =
362         *transport_stats[0]->selected_candidate_pair_id;
363     for (const RTCStats& stats : *report_) {
364       missing_stats.erase(stats.type());
365       if (stats.type() == RTCCertificateStats::kType) {
366         verify_successful &=
367             VerifyRTCCertificateStats(stats.cast_to<RTCCertificateStats>());
368       } else if (stats.type() == RTCCodecStats::kType) {
369         verify_successful &=
370             VerifyRTCCodecStats(stats.cast_to<RTCCodecStats>());
371       } else if (stats.type() == RTCDataChannelStats::kType) {
372         verify_successful &=
373             VerifyRTCDataChannelStats(stats.cast_to<RTCDataChannelStats>());
374       } else if (stats.type() == RTCIceCandidatePairStats::kType) {
375         verify_successful &= VerifyRTCIceCandidatePairStats(
376             stats.cast_to<RTCIceCandidatePairStats>(),
377             stats.id() == selected_candidate_pair_id);
378       } else if (stats.type() == RTCLocalIceCandidateStats::kType) {
379         verify_successful &= VerifyRTCLocalIceCandidateStats(
380             stats.cast_to<RTCLocalIceCandidateStats>());
381       } else if (stats.type() == RTCRemoteIceCandidateStats::kType) {
382         verify_successful &= VerifyRTCRemoteIceCandidateStats(
383             stats.cast_to<RTCRemoteIceCandidateStats>());
384       } else if (stats.type() == RTCMediaStreamStats::kType) {
385         verify_successful &=
386             VerifyRTCMediaStreamStats(stats.cast_to<RTCMediaStreamStats>());
387       } else if (stats.type() == RTCMediaStreamTrackStats::kType) {
388         verify_successful &= VerifyRTCMediaStreamTrackStats(
389             stats.cast_to<RTCMediaStreamTrackStats>());
390       } else if (stats.type() == RTCPeerConnectionStats::kType) {
391         verify_successful &= VerifyRTCPeerConnectionStats(
392             stats.cast_to<RTCPeerConnectionStats>());
393       } else if (stats.type() == RTCInboundRTPStreamStats::kType) {
394         verify_successful &= VerifyRTCInboundRTPStreamStats(
395             stats.cast_to<RTCInboundRTPStreamStats>());
396       } else if (stats.type() == RTCOutboundRTPStreamStats::kType) {
397         verify_successful &= VerifyRTCOutboundRTPStreamStats(
398             stats.cast_to<RTCOutboundRTPStreamStats>());
399       } else if (stats.type() == RTCRemoteInboundRtpStreamStats::kType) {
400         verify_successful &= VerifyRTCRemoteInboundRtpStreamStats(
401             stats.cast_to<RTCRemoteInboundRtpStreamStats>());
402       } 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
405         // equality (==). In JavaScript they would be distinguished with |kind|.
406         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
411         // equality (==). In JavaScript they would be distinguished with |kind|.
412         verify_successful &=
413             VerifyRTCVideoSourceStats(stats.cast_to<RTCVideoSourceStats>());
414       } else if (stats.type() == RTCTransportStats::kType) {
415         verify_successful &=
416             VerifyRTCTransportStats(stats.cast_to<RTCTransportStats>());
417       } else {
418         EXPECT_TRUE(false) << "Unrecognized stats type: " << stats.type();
419         verify_successful = false;
420       }
421     }
422     for (const char* missing : missing_stats) {
423       if (!absl::c_linear_search(allowed_missing_stats, missing)) {
424         verify_successful = false;
425         EXPECT_TRUE(false) << "Missing expected stats type: " << missing;
426       }
427     }
428     EXPECT_TRUE(verify_successful)
429         << "One or more problems with the stats. This is the report:\n"
430         << report_->ToJson();
431   }
432 
VerifyRTCCertificateStats(const RTCCertificateStats & certificate)433   bool VerifyRTCCertificateStats(const RTCCertificateStats& certificate) {
434     RTCStatsVerifier verifier(report_, &certificate);
435     verifier.TestMemberIsDefined(certificate.fingerprint);
436     verifier.TestMemberIsDefined(certificate.fingerprint_algorithm);
437     verifier.TestMemberIsDefined(certificate.base64_certificate);
438     verifier.TestMemberIsOptionalIDReference(certificate.issuer_certificate_id,
439                                              RTCCertificateStats::kType);
440     return verifier.ExpectAllMembersSuccessfullyTested();
441   }
442 
VerifyRTCCodecStats(const RTCCodecStats & codec)443   bool VerifyRTCCodecStats(const RTCCodecStats& codec) {
444     RTCStatsVerifier verifier(report_, &codec);
445     verifier.TestMemberIsDefined(codec.payload_type);
446     verifier.TestMemberIsDefined(codec.mime_type);
447     verifier.TestMemberIsPositive<uint32_t>(codec.clock_rate);
448 
449     if (codec.mime_type->rfind("audio", 0) == 0)
450       verifier.TestMemberIsPositive<uint32_t>(codec.channels);
451     else
452       verifier.TestMemberIsUndefined(codec.channels);
453 
454     // sdp_fmtp_line is an optional field.
455     verifier.MarkMemberTested(codec.sdp_fmtp_line, true);
456     return verifier.ExpectAllMembersSuccessfullyTested();
457   }
458 
VerifyRTCDataChannelStats(const RTCDataChannelStats & data_channel)459   bool VerifyRTCDataChannelStats(const RTCDataChannelStats& data_channel) {
460     RTCStatsVerifier verifier(report_, &data_channel);
461     verifier.TestMemberIsDefined(data_channel.label);
462     verifier.TestMemberIsDefined(data_channel.protocol);
463     verifier.TestMemberIsDefined(data_channel.data_channel_identifier);
464     verifier.TestMemberIsDefined(data_channel.state);
465     verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_sent);
466     verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_sent);
467     verifier.TestMemberIsNonNegative<uint32_t>(data_channel.messages_received);
468     verifier.TestMemberIsNonNegative<uint64_t>(data_channel.bytes_received);
469     return verifier.ExpectAllMembersSuccessfullyTested();
470   }
471 
VerifyRTCIceCandidatePairStats(const RTCIceCandidatePairStats & candidate_pair,bool is_selected_pair)472   bool VerifyRTCIceCandidatePairStats(
473       const RTCIceCandidatePairStats& candidate_pair,
474       bool is_selected_pair) {
475     RTCStatsVerifier verifier(report_, &candidate_pair);
476     verifier.TestMemberIsIDReference(candidate_pair.transport_id,
477                                      RTCTransportStats::kType);
478     verifier.TestMemberIsIDReference(candidate_pair.local_candidate_id,
479                                      RTCLocalIceCandidateStats::kType);
480     verifier.TestMemberIsIDReference(candidate_pair.remote_candidate_id,
481                                      RTCRemoteIceCandidateStats::kType);
482     verifier.TestMemberIsDefined(candidate_pair.state);
483     verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.priority);
484     verifier.TestMemberIsDefined(candidate_pair.nominated);
485     verifier.TestMemberIsDefined(candidate_pair.writable);
486     verifier.TestMemberIsUndefined(candidate_pair.readable);
487     verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_sent);
488     verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.bytes_received);
489     verifier.TestMemberIsNonNegative<double>(
490         candidate_pair.total_round_trip_time);
491     verifier.TestMemberIsNonNegative<double>(
492         candidate_pair.current_round_trip_time);
493     if (is_selected_pair) {
494       verifier.TestMemberIsNonNegative<double>(
495           candidate_pair.available_outgoing_bitrate);
496       // A pair should be nominated in order to be selected.
497       EXPECT_TRUE(*candidate_pair.nominated);
498     } else {
499       verifier.TestMemberIsUndefined(candidate_pair.available_outgoing_bitrate);
500     }
501     verifier.TestMemberIsUndefined(candidate_pair.available_incoming_bitrate);
502     verifier.TestMemberIsNonNegative<uint64_t>(
503         candidate_pair.requests_received);
504     verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.requests_sent);
505     verifier.TestMemberIsNonNegative<uint64_t>(
506         candidate_pair.responses_received);
507     verifier.TestMemberIsNonNegative<uint64_t>(candidate_pair.responses_sent);
508     verifier.TestMemberIsUndefined(candidate_pair.retransmissions_received);
509     verifier.TestMemberIsUndefined(candidate_pair.retransmissions_sent);
510     verifier.TestMemberIsUndefined(candidate_pair.consent_requests_received);
511     verifier.TestMemberIsNonNegative<uint64_t>(
512         candidate_pair.consent_requests_sent);
513     verifier.TestMemberIsUndefined(candidate_pair.consent_responses_received);
514     verifier.TestMemberIsUndefined(candidate_pair.consent_responses_sent);
515     return verifier.ExpectAllMembersSuccessfullyTested();
516   }
517 
VerifyRTCIceCandidateStats(const RTCIceCandidateStats & candidate)518   bool VerifyRTCIceCandidateStats(const RTCIceCandidateStats& candidate) {
519     RTCStatsVerifier verifier(report_, &candidate);
520     verifier.TestMemberIsIDReference(candidate.transport_id,
521                                      RTCTransportStats::kType);
522     verifier.TestMemberIsDefined(candidate.is_remote);
523     if (*candidate.is_remote) {
524       verifier.TestMemberIsUndefined(candidate.network_type);
525     } else {
526       verifier.TestMemberIsDefined(candidate.network_type);
527     }
528     verifier.TestMemberIsDefined(candidate.ip);
529     verifier.TestMemberIsNonNegative<int32_t>(candidate.port);
530     verifier.TestMemberIsDefined(candidate.protocol);
531     verifier.TestMemberIsDefined(candidate.candidate_type);
532     verifier.TestMemberIsNonNegative<int32_t>(candidate.priority);
533     verifier.TestMemberIsUndefined(candidate.url);
534     verifier.TestMemberIsDefined(candidate.deleted);
535     verifier.TestMemberIsUndefined(candidate.relay_protocol);
536     return verifier.ExpectAllMembersSuccessfullyTested();
537   }
538 
VerifyRTCLocalIceCandidateStats(const RTCLocalIceCandidateStats & local_candidate)539   bool VerifyRTCLocalIceCandidateStats(
540       const RTCLocalIceCandidateStats& local_candidate) {
541     return VerifyRTCIceCandidateStats(local_candidate);
542   }
543 
VerifyRTCRemoteIceCandidateStats(const RTCRemoteIceCandidateStats & remote_candidate)544   bool VerifyRTCRemoteIceCandidateStats(
545       const RTCRemoteIceCandidateStats& remote_candidate) {
546     return VerifyRTCIceCandidateStats(remote_candidate);
547   }
548 
VerifyRTCMediaStreamStats(const RTCMediaStreamStats & media_stream)549   bool VerifyRTCMediaStreamStats(const RTCMediaStreamStats& media_stream) {
550     RTCStatsVerifier verifier(report_, &media_stream);
551     verifier.TestMemberIsDefined(media_stream.stream_identifier);
552     verifier.TestMemberIsIDReference(media_stream.track_ids,
553                                      RTCMediaStreamTrackStats::kType);
554     return verifier.ExpectAllMembersSuccessfullyTested();
555   }
556 
VerifyRTCMediaStreamTrackStats(const RTCMediaStreamTrackStats & media_stream_track)557   bool VerifyRTCMediaStreamTrackStats(
558       const RTCMediaStreamTrackStats& media_stream_track) {
559     RTCStatsVerifier verifier(report_, &media_stream_track);
560     verifier.TestMemberIsDefined(media_stream_track.track_identifier);
561     verifier.TestMemberIsDefined(media_stream_track.remote_source);
562     verifier.TestMemberIsDefined(media_stream_track.ended);
563     verifier.TestMemberIsDefined(media_stream_track.detached);
564     verifier.TestMemberIsDefined(media_stream_track.kind);
565     RTC_DCHECK(media_stream_track.remote_source.is_defined());
566     // Video or audio media stream track?
567     if (*media_stream_track.kind == RTCMediaStreamTrackKind::kVideo) {
568       // The type of the referenced media source depends on kind.
569       if (*media_stream_track.remote_source) {
570         verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
571         verifier.TestMemberIsNonNegative<double>(
572             media_stream_track.jitter_buffer_delay);
573         verifier.TestMemberIsNonNegative<uint64_t>(
574             media_stream_track.jitter_buffer_emitted_count);
575         verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
576         verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
577         verifier.TestMemberIsNonNegative<uint32_t>(
578             media_stream_track.frames_received);
579         verifier.TestMemberIsNonNegative<uint32_t>(
580             media_stream_track.frames_decoded);
581         verifier.TestMemberIsNonNegative<uint32_t>(
582             media_stream_track.frames_dropped);
583         verifier.TestMemberIsNonNegative<uint32_t>(
584             media_stream_track.freeze_count);
585         verifier.TestMemberIsNonNegative<uint32_t>(
586             media_stream_track.pause_count);
587         verifier.TestMemberIsNonNegative<double>(
588             media_stream_track.total_freezes_duration);
589         verifier.TestMemberIsNonNegative<double>(
590             media_stream_track.total_pauses_duration);
591         verifier.TestMemberIsNonNegative<double>(
592             media_stream_track.total_frames_duration);
593         verifier.TestMemberIsNonNegative<double>(
594             media_stream_track.sum_squared_frame_durations);
595       } else {
596         verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
597                                          RTCVideoSourceStats::kType);
598         // Local tracks have no jitter buffer.
599         verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
600         verifier.TestMemberIsUndefined(
601             media_stream_track.jitter_buffer_emitted_count);
602         verifier.TestMemberIsNonNegative<uint32_t>(
603             media_stream_track.frames_sent);
604         verifier.TestMemberIsNonNegative<uint32_t>(
605             media_stream_track.huge_frames_sent);
606         verifier.TestMemberIsUndefined(media_stream_track.frames_received);
607         verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
608         verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
609         verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
610         verifier.TestMemberIsUndefined(media_stream_track.pause_count);
611         verifier.TestMemberIsUndefined(
612             media_stream_track.total_freezes_duration);
613         verifier.TestMemberIsUndefined(
614             media_stream_track.total_pauses_duration);
615         verifier.TestMemberIsUndefined(
616             media_stream_track.total_frames_duration);
617         verifier.TestMemberIsUndefined(
618             media_stream_track.sum_squared_frame_durations);
619       }
620       // Video-only members
621       verifier.TestMemberIsNonNegative<uint32_t>(
622           media_stream_track.frame_width);
623       verifier.TestMemberIsNonNegative<uint32_t>(
624           media_stream_track.frame_height);
625       verifier.TestMemberIsUndefined(media_stream_track.frames_per_second);
626       verifier.TestMemberIsUndefined(media_stream_track.frames_corrupted);
627       verifier.TestMemberIsUndefined(media_stream_track.partial_frames_lost);
628       verifier.TestMemberIsUndefined(media_stream_track.full_frames_lost);
629       // Audio-only members should be undefined
630       verifier.TestMemberIsUndefined(media_stream_track.audio_level);
631       verifier.TestMemberIsUndefined(media_stream_track.echo_return_loss);
632       verifier.TestMemberIsUndefined(
633           media_stream_track.echo_return_loss_enhancement);
634       verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
635       verifier.TestMemberIsUndefined(media_stream_track.total_samples_duration);
636       verifier.TestMemberIsUndefined(media_stream_track.total_samples_received);
637       verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
638       verifier.TestMemberIsUndefined(
639           media_stream_track.silent_concealed_samples);
640       verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
641       verifier.TestMemberIsUndefined(
642           media_stream_track.inserted_samples_for_deceleration);
643       verifier.TestMemberIsUndefined(
644           media_stream_track.removed_samples_for_acceleration);
645       verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_flushes);
646       verifier.TestMemberIsUndefined(
647           media_stream_track.delayed_packet_outage_samples);
648       verifier.TestMemberIsUndefined(
649           media_stream_track.relative_packet_arrival_delay);
650       verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
651       verifier.TestMemberIsUndefined(
652           media_stream_track.total_interruption_duration);
653       verifier.TestMemberIsUndefined(
654           media_stream_track.jitter_buffer_target_delay);
655     } else {
656       RTC_DCHECK_EQ(*media_stream_track.kind, RTCMediaStreamTrackKind::kAudio);
657       // The type of the referenced media source depends on kind.
658       if (*media_stream_track.remote_source) {
659         // Remote tracks don't have media source stats.
660         verifier.TestMemberIsUndefined(media_stream_track.media_source_id);
661         verifier.TestMemberIsNonNegative<double>(
662             media_stream_track.jitter_buffer_delay);
663         verifier.TestMemberIsNonNegative<uint64_t>(
664             media_stream_track.jitter_buffer_emitted_count);
665         verifier.TestMemberIsNonNegative<double>(
666             media_stream_track.jitter_buffer_target_delay);
667         verifier.TestMemberIsPositive<double>(media_stream_track.audio_level);
668         verifier.TestMemberIsPositive<double>(
669             media_stream_track.total_audio_energy);
670         verifier.TestMemberIsPositive<uint64_t>(
671             media_stream_track.total_samples_received);
672         verifier.TestMemberIsPositive<double>(
673             media_stream_track.total_samples_duration);
674         verifier.TestMemberIsNonNegative<uint64_t>(
675             media_stream_track.concealed_samples);
676         verifier.TestMemberIsNonNegative<uint64_t>(
677             media_stream_track.silent_concealed_samples);
678         verifier.TestMemberIsNonNegative<uint64_t>(
679             media_stream_track.concealment_events);
680         verifier.TestMemberIsNonNegative<uint64_t>(
681             media_stream_track.inserted_samples_for_deceleration);
682         verifier.TestMemberIsNonNegative<uint64_t>(
683             media_stream_track.removed_samples_for_acceleration);
684         verifier.TestMemberIsNonNegative<uint64_t>(
685             media_stream_track.jitter_buffer_flushes);
686         verifier.TestMemberIsNonNegative<uint64_t>(
687             media_stream_track.delayed_packet_outage_samples);
688         verifier.TestMemberIsNonNegative<double>(
689             media_stream_track.relative_packet_arrival_delay);
690         verifier.TestMemberIsNonNegative<uint32_t>(
691             media_stream_track.interruption_count);
692         verifier.TestMemberIsNonNegative<double>(
693             media_stream_track.total_interruption_duration);
694       } else {
695         verifier.TestMemberIsIDReference(media_stream_track.media_source_id,
696                                          RTCAudioSourceStats::kType);
697         // Local audio tracks have no jitter buffer.
698         verifier.TestMemberIsUndefined(media_stream_track.jitter_buffer_delay);
699         verifier.TestMemberIsUndefined(
700             media_stream_track.jitter_buffer_emitted_count);
701         verifier.TestMemberIsUndefined(
702             media_stream_track.jitter_buffer_target_delay);
703         verifier.TestMemberIsUndefined(media_stream_track.audio_level);
704         verifier.TestMemberIsUndefined(media_stream_track.total_audio_energy);
705         verifier.TestMemberIsUndefined(
706             media_stream_track.total_samples_received);
707         verifier.TestMemberIsUndefined(
708             media_stream_track.total_samples_duration);
709         verifier.TestMemberIsUndefined(media_stream_track.concealed_samples);
710         verifier.TestMemberIsUndefined(
711             media_stream_track.silent_concealed_samples);
712         verifier.TestMemberIsUndefined(media_stream_track.concealment_events);
713         verifier.TestMemberIsUndefined(
714             media_stream_track.inserted_samples_for_deceleration);
715         verifier.TestMemberIsUndefined(
716             media_stream_track.removed_samples_for_acceleration);
717         verifier.TestMemberIsUndefined(
718             media_stream_track.jitter_buffer_flushes);
719         verifier.TestMemberIsUndefined(
720             media_stream_track.delayed_packet_outage_samples);
721         verifier.TestMemberIsUndefined(
722             media_stream_track.relative_packet_arrival_delay);
723         verifier.TestMemberIsUndefined(media_stream_track.interruption_count);
724         verifier.TestMemberIsUndefined(
725             media_stream_track.total_interruption_duration);
726       }
727       // Video-only members should be undefined
728       verifier.TestMemberIsUndefined(media_stream_track.frame_width);
729       verifier.TestMemberIsUndefined(media_stream_track.frame_height);
730       verifier.TestMemberIsUndefined(media_stream_track.frames_per_second);
731       verifier.TestMemberIsUndefined(media_stream_track.frames_sent);
732       verifier.TestMemberIsUndefined(media_stream_track.huge_frames_sent);
733       verifier.TestMemberIsUndefined(media_stream_track.frames_received);
734       verifier.TestMemberIsUndefined(media_stream_track.frames_decoded);
735       verifier.TestMemberIsUndefined(media_stream_track.frames_dropped);
736       verifier.TestMemberIsUndefined(media_stream_track.frames_corrupted);
737       verifier.TestMemberIsUndefined(media_stream_track.partial_frames_lost);
738       verifier.TestMemberIsUndefined(media_stream_track.full_frames_lost);
739       verifier.TestMemberIsUndefined(media_stream_track.freeze_count);
740       verifier.TestMemberIsUndefined(media_stream_track.pause_count);
741       verifier.TestMemberIsUndefined(media_stream_track.total_freezes_duration);
742       verifier.TestMemberIsUndefined(media_stream_track.total_pauses_duration);
743       verifier.TestMemberIsUndefined(media_stream_track.total_frames_duration);
744       verifier.TestMemberIsUndefined(
745           media_stream_track.sum_squared_frame_durations);
746       // Audio-only members
747       // TODO(hbos): |echo_return_loss| and |echo_return_loss_enhancement| are
748       // flaky on msan bot (sometimes defined, sometimes undefined). Should the
749       // test run until available or is there a way to have it always be
750       // defined? crbug.com/627816
751       verifier.MarkMemberTested(media_stream_track.echo_return_loss, true);
752       verifier.MarkMemberTested(media_stream_track.echo_return_loss_enhancement,
753                                 true);
754     }
755     return verifier.ExpectAllMembersSuccessfullyTested();
756   }
757 
VerifyRTCPeerConnectionStats(const RTCPeerConnectionStats & peer_connection)758   bool VerifyRTCPeerConnectionStats(
759       const RTCPeerConnectionStats& peer_connection) {
760     RTCStatsVerifier verifier(report_, &peer_connection);
761     verifier.TestMemberIsNonNegative<uint32_t>(
762         peer_connection.data_channels_opened);
763     verifier.TestMemberIsNonNegative<uint32_t>(
764         peer_connection.data_channels_closed);
765     return verifier.ExpectAllMembersSuccessfullyTested();
766   }
767 
VerifyRTCRTPStreamStats(const RTCRTPStreamStats & stream,RTCStatsVerifier * verifier)768   void VerifyRTCRTPStreamStats(const RTCRTPStreamStats& stream,
769                                RTCStatsVerifier* verifier) {
770     verifier->TestMemberIsDefined(stream.ssrc);
771     verifier->TestMemberIsDefined(stream.is_remote);
772     verifier->TestMemberIsDefined(stream.media_type);
773     verifier->TestMemberIsDefined(stream.kind);
774     verifier->TestMemberIsIDReference(stream.track_id,
775                                       RTCMediaStreamTrackStats::kType);
776     verifier->TestMemberIsIDReference(stream.transport_id,
777                                       RTCTransportStats::kType);
778     verifier->TestMemberIsIDReference(stream.codec_id, RTCCodecStats::kType);
779     if (stream.media_type.is_defined() && *stream.media_type == "video") {
780       verifier->TestMemberIsNonNegative<uint32_t>(stream.fir_count);
781       verifier->TestMemberIsNonNegative<uint32_t>(stream.pli_count);
782       verifier->TestMemberIsNonNegative<uint32_t>(stream.nack_count);
783     } else {
784       verifier->TestMemberIsUndefined(stream.fir_count);
785       verifier->TestMemberIsUndefined(stream.pli_count);
786       verifier->TestMemberIsUndefined(stream.nack_count);
787     }
788     verifier->TestMemberIsUndefined(stream.sli_count);
789   }
790 
VerifyRTCInboundRTPStreamStats(const RTCInboundRTPStreamStats & inbound_stream)791   bool VerifyRTCInboundRTPStreamStats(
792       const RTCInboundRTPStreamStats& inbound_stream) {
793     RTCStatsVerifier verifier(report_, &inbound_stream);
794     VerifyRTCRTPStreamStats(inbound_stream, &verifier);
795     if (inbound_stream.media_type.is_defined() &&
796         *inbound_stream.media_type == "video") {
797       verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.qp_sum);
798       verifier.TestMemberIsDefined(inbound_stream.decoder_implementation);
799     } else {
800       verifier.TestMemberIsUndefined(inbound_stream.qp_sum);
801       verifier.TestMemberIsUndefined(inbound_stream.decoder_implementation);
802     }
803     verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.packets_received);
804     if (inbound_stream.media_type.is_defined() &&
805         *inbound_stream.media_type == "audio") {
806       verifier.TestMemberIsNonNegative<uint64_t>(
807           inbound_stream.fec_packets_received);
808       verifier.TestMemberIsNonNegative<uint64_t>(
809           inbound_stream.fec_packets_discarded);
810     } else {
811       verifier.TestMemberIsUndefined(inbound_stream.fec_packets_received);
812       verifier.TestMemberIsUndefined(inbound_stream.fec_packets_discarded);
813     }
814     verifier.TestMemberIsNonNegative<uint64_t>(inbound_stream.bytes_received);
815     verifier.TestMemberIsNonNegative<uint64_t>(
816         inbound_stream.header_bytes_received);
817     // packets_lost is defined as signed, but this should never happen in
818     // this test. See RFC 3550.
819     verifier.TestMemberIsNonNegative<int32_t>(inbound_stream.packets_lost);
820     verifier.TestMemberIsDefined(inbound_stream.last_packet_received_timestamp);
821     if (inbound_stream.frames_received.ValueOrDefault(0) > 0) {
822       verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frame_width);
823       verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frame_height);
824     } else {
825       verifier.TestMemberIsUndefined(inbound_stream.frame_width);
826       verifier.TestMemberIsUndefined(inbound_stream.frame_height);
827     }
828     if (inbound_stream.frames_per_second.is_defined()) {
829       verifier.TestMemberIsNonNegative<double>(
830           inbound_stream.frames_per_second);
831     } else {
832       verifier.TestMemberIsUndefined(inbound_stream.frames_per_second);
833     }
834     verifier.TestMemberIsUndefined(inbound_stream.frame_bit_depth);
835     if (inbound_stream.media_type.is_defined() &&
836         *inbound_stream.media_type == "video") {
837       verifier.TestMemberIsUndefined(inbound_stream.jitter);
838       verifier.TestMemberIsUndefined(inbound_stream.jitter_buffer_delay);
839       verifier.TestMemberIsUndefined(
840           inbound_stream.jitter_buffer_emitted_count);
841       verifier.TestMemberIsUndefined(inbound_stream.total_samples_received);
842       verifier.TestMemberIsUndefined(inbound_stream.concealed_samples);
843       verifier.TestMemberIsUndefined(inbound_stream.silent_concealed_samples);
844       verifier.TestMemberIsUndefined(inbound_stream.concealment_events);
845       verifier.TestMemberIsUndefined(
846           inbound_stream.inserted_samples_for_deceleration);
847       verifier.TestMemberIsUndefined(
848           inbound_stream.removed_samples_for_acceleration);
849       verifier.TestMemberIsUndefined(inbound_stream.audio_level);
850       verifier.TestMemberIsUndefined(inbound_stream.total_audio_energy);
851       verifier.TestMemberIsUndefined(inbound_stream.total_samples_duration);
852       verifier.TestMemberIsNonNegative<int32_t>(inbound_stream.frames_received);
853     } else {
854       verifier.TestMemberIsNonNegative<double>(inbound_stream.jitter);
855       verifier.TestMemberIsNonNegative<double>(
856           inbound_stream.jitter_buffer_delay);
857       verifier.TestMemberIsNonNegative<uint64_t>(
858           inbound_stream.jitter_buffer_emitted_count);
859       verifier.TestMemberIsPositive<uint64_t>(
860           inbound_stream.total_samples_received);
861       verifier.TestMemberIsNonNegative<uint64_t>(
862           inbound_stream.concealed_samples);
863       verifier.TestMemberIsNonNegative<uint64_t>(
864           inbound_stream.silent_concealed_samples);
865       verifier.TestMemberIsNonNegative<uint64_t>(
866           inbound_stream.concealment_events);
867       verifier.TestMemberIsNonNegative<uint64_t>(
868           inbound_stream.inserted_samples_for_deceleration);
869       verifier.TestMemberIsNonNegative<uint64_t>(
870           inbound_stream.removed_samples_for_acceleration);
871       verifier.TestMemberIsPositive<double>(inbound_stream.audio_level);
872       verifier.TestMemberIsPositive<double>(inbound_stream.total_audio_energy);
873       verifier.TestMemberIsPositive<double>(
874           inbound_stream.total_samples_duration);
875       verifier.TestMemberIsUndefined(inbound_stream.frames_received);
876     }
877     verifier.TestMemberIsUndefined(inbound_stream.round_trip_time);
878     verifier.TestMemberIsUndefined(inbound_stream.packets_discarded);
879     verifier.TestMemberIsUndefined(inbound_stream.packets_repaired);
880     verifier.TestMemberIsUndefined(inbound_stream.burst_packets_lost);
881     verifier.TestMemberIsUndefined(inbound_stream.burst_packets_discarded);
882     verifier.TestMemberIsUndefined(inbound_stream.burst_loss_count);
883     verifier.TestMemberIsUndefined(inbound_stream.burst_discard_count);
884     verifier.TestMemberIsUndefined(inbound_stream.burst_loss_rate);
885     verifier.TestMemberIsUndefined(inbound_stream.burst_discard_rate);
886     verifier.TestMemberIsUndefined(inbound_stream.gap_loss_rate);
887     verifier.TestMemberIsUndefined(inbound_stream.gap_discard_rate);
888     // Test runtime too short to get an estimate (at least two RTCP sender
889     // reports need to be received).
890     verifier.MarkMemberTested(inbound_stream.estimated_playout_timestamp, true);
891     if (inbound_stream.media_type.is_defined() &&
892         *inbound_stream.media_type == "video") {
893       verifier.TestMemberIsDefined(inbound_stream.frames_decoded);
894       verifier.TestMemberIsDefined(inbound_stream.key_frames_decoded);
895       verifier.TestMemberIsNonNegative<uint32_t>(inbound_stream.frames_dropped);
896       verifier.TestMemberIsNonNegative<double>(
897           inbound_stream.total_decode_time);
898       verifier.TestMemberIsNonNegative<double>(
899           inbound_stream.total_inter_frame_delay);
900       verifier.TestMemberIsNonNegative<double>(
901           inbound_stream.total_squared_inter_frame_delay);
902       // 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);
905     } else {
906       verifier.TestMemberIsUndefined(inbound_stream.frames_decoded);
907       verifier.TestMemberIsUndefined(inbound_stream.key_frames_decoded);
908       verifier.TestMemberIsUndefined(inbound_stream.frames_dropped);
909       verifier.TestMemberIsUndefined(inbound_stream.total_decode_time);
910       verifier.TestMemberIsUndefined(inbound_stream.total_inter_frame_delay);
911       verifier.TestMemberIsUndefined(
912           inbound_stream.total_squared_inter_frame_delay);
913       verifier.TestMemberIsUndefined(inbound_stream.content_type);
914     }
915     return verifier.ExpectAllMembersSuccessfullyTested();
916   }
917 
VerifyRTCOutboundRTPStreamStats(const RTCOutboundRTPStreamStats & outbound_stream)918   bool VerifyRTCOutboundRTPStreamStats(
919       const RTCOutboundRTPStreamStats& outbound_stream) {
920     RTCStatsVerifier verifier(report_, &outbound_stream);
921     VerifyRTCRTPStreamStats(outbound_stream, &verifier);
922     if (outbound_stream.media_type.is_defined() &&
923         *outbound_stream.media_type == "video") {
924       verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
925                                        RTCVideoSourceStats::kType);
926       if (*outbound_stream.frames_encoded > 0) {
927         verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.qp_sum);
928       } else {
929         verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
930       }
931     } else {
932       verifier.TestMemberIsIDReference(outbound_stream.media_source_id,
933                                        RTCAudioSourceStats::kType);
934       verifier.TestMemberIsUndefined(outbound_stream.qp_sum);
935     }
936     verifier.TestMemberIsOptionalIDReference(
937         outbound_stream.remote_id, RTCRemoteInboundRtpStreamStats::kType);
938     verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.packets_sent);
939     verifier.TestMemberIsNonNegative<uint64_t>(
940         outbound_stream.retransmitted_packets_sent);
941     verifier.TestMemberIsNonNegative<uint64_t>(outbound_stream.bytes_sent);
942     verifier.TestMemberIsNonNegative<uint64_t>(
943         outbound_stream.header_bytes_sent);
944     verifier.TestMemberIsNonNegative<uint64_t>(
945         outbound_stream.retransmitted_bytes_sent);
946     verifier.TestMemberIsUndefined(outbound_stream.target_bitrate);
947     if (outbound_stream.media_type.is_defined() &&
948         *outbound_stream.media_type == "video") {
949       verifier.TestMemberIsDefined(outbound_stream.frames_encoded);
950       verifier.TestMemberIsDefined(outbound_stream.key_frames_encoded);
951       verifier.TestMemberIsNonNegative<double>(
952           outbound_stream.total_encode_time);
953       verifier.TestMemberIsNonNegative<uint64_t>(
954           outbound_stream.total_encoded_bytes_target);
955       verifier.TestMemberIsNonNegative<double>(
956           outbound_stream.total_packet_send_delay);
957       verifier.TestMemberIsDefined(outbound_stream.quality_limitation_reason);
958       verifier.TestMemberIsNonNegative<uint32_t>(
959           outbound_stream.quality_limitation_resolution_changes);
960       // The integration test is not set up to test screen share; don't require
961       // this to be present.
962       verifier.MarkMemberTested(outbound_stream.content_type, true);
963       verifier.TestMemberIsDefined(outbound_stream.encoder_implementation);
964       // Unless an implementation-specific amount of time has passed and at
965       // least one frame has been encoded, undefined is reported. Because it
966       // is hard to tell what is the case here, we treat FPS as optional.
967       // TODO(hbos): Update the tests to run until all implemented metrics
968       // should be populated.
969       if (outbound_stream.frames_per_second.is_defined()) {
970         verifier.TestMemberIsNonNegative<double>(
971             outbound_stream.frames_per_second);
972       } else {
973         verifier.TestMemberIsUndefined(outbound_stream.frames_per_second);
974       }
975       verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frame_height);
976       verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frame_width);
977       verifier.TestMemberIsNonNegative<uint32_t>(outbound_stream.frames_sent);
978       verifier.TestMemberIsNonNegative<uint32_t>(
979           outbound_stream.huge_frames_sent);
980       verifier.MarkMemberTested(outbound_stream.rid, true);
981     } else {
982       verifier.TestMemberIsUndefined(outbound_stream.frames_encoded);
983       verifier.TestMemberIsUndefined(outbound_stream.key_frames_encoded);
984       verifier.TestMemberIsUndefined(outbound_stream.total_encode_time);
985       verifier.TestMemberIsUndefined(
986           outbound_stream.total_encoded_bytes_target);
987       // TODO(https://crbug.com/webrtc/10635): Implement for audio as well.
988       verifier.TestMemberIsUndefined(outbound_stream.total_packet_send_delay);
989       verifier.TestMemberIsUndefined(outbound_stream.quality_limitation_reason);
990       verifier.TestMemberIsUndefined(
991           outbound_stream.quality_limitation_resolution_changes);
992       verifier.TestMemberIsUndefined(outbound_stream.content_type);
993       // TODO(hbos): Implement for audio as well.
994       verifier.TestMemberIsUndefined(outbound_stream.encoder_implementation);
995       verifier.TestMemberIsUndefined(outbound_stream.rid);
996       verifier.TestMemberIsUndefined(outbound_stream.frames_per_second);
997       verifier.TestMemberIsUndefined(outbound_stream.frame_height);
998       verifier.TestMemberIsUndefined(outbound_stream.frame_width);
999       verifier.TestMemberIsUndefined(outbound_stream.frames_sent);
1000       verifier.TestMemberIsUndefined(outbound_stream.huge_frames_sent);
1001     }
1002     return verifier.ExpectAllMembersSuccessfullyTested();
1003   }
1004 
VerifyRTCRemoteInboundRtpStreamStats(const RTCRemoteInboundRtpStreamStats & remote_inbound_stream)1005   bool VerifyRTCRemoteInboundRtpStreamStats(
1006       const RTCRemoteInboundRtpStreamStats& remote_inbound_stream) {
1007     RTCStatsVerifier verifier(report_, &remote_inbound_stream);
1008     verifier.TestMemberIsDefined(remote_inbound_stream.ssrc);
1009     verifier.TestMemberIsDefined(remote_inbound_stream.kind);
1010     verifier.TestMemberIsIDReference(remote_inbound_stream.transport_id,
1011                                      RTCTransportStats::kType);
1012     verifier.TestMemberIsIDReference(remote_inbound_stream.codec_id,
1013                                      RTCCodecStats::kType);
1014     verifier.TestMemberIsDefined(remote_inbound_stream.packets_lost);
1015     // Note that the existance of RTCCodecStats is needed for |codec_id| and
1016     // |jitter| to be present.
1017     verifier.TestMemberIsNonNegative<double>(remote_inbound_stream.jitter);
1018     verifier.TestMemberIsIDReference(remote_inbound_stream.local_id,
1019                                      RTCOutboundRTPStreamStats::kType);
1020     verifier.TestMemberIsNonNegative<double>(
1021         remote_inbound_stream.round_trip_time);
1022     return verifier.ExpectAllMembersSuccessfullyTested();
1023   }
1024 
VerifyRTCMediaSourceStats(const RTCMediaSourceStats & media_source,RTCStatsVerifier * verifier)1025   void VerifyRTCMediaSourceStats(const RTCMediaSourceStats& media_source,
1026                                  RTCStatsVerifier* verifier) {
1027     verifier->TestMemberIsDefined(media_source.track_identifier);
1028     verifier->TestMemberIsDefined(media_source.kind);
1029     if (media_source.kind.is_defined()) {
1030       EXPECT_TRUE((*media_source.kind == "audio" &&
1031                    media_source.type() == RTCAudioSourceStats::kType) ||
1032                   (*media_source.kind == "video" &&
1033                    media_source.type() == RTCVideoSourceStats::kType));
1034     }
1035   }
1036 
VerifyRTCAudioSourceStats(const RTCAudioSourceStats & audio_source)1037   bool VerifyRTCAudioSourceStats(const RTCAudioSourceStats& audio_source) {
1038     RTCStatsVerifier verifier(report_, &audio_source);
1039     VerifyRTCMediaSourceStats(audio_source, &verifier);
1040     // Audio level, unlike audio energy, only gets updated at a certain
1041     // frequency, so we don't require that one to be positive to avoid a race
1042     // (https://crbug.com/webrtc/10962).
1043     verifier.TestMemberIsNonNegative<double>(audio_source.audio_level);
1044     verifier.TestMemberIsPositive<double>(audio_source.total_audio_energy);
1045     verifier.TestMemberIsPositive<double>(audio_source.total_samples_duration);
1046     return verifier.ExpectAllMembersSuccessfullyTested();
1047   }
1048 
VerifyRTCVideoSourceStats(const RTCVideoSourceStats & video_source)1049   bool VerifyRTCVideoSourceStats(const RTCVideoSourceStats& video_source) {
1050     RTCStatsVerifier verifier(report_, &video_source);
1051     VerifyRTCMediaSourceStats(video_source, &verifier);
1052     // TODO(hbos): This integration test uses fakes that doesn't support
1053     // VideoTrackSourceInterface::Stats. When this is fixed we should
1054     // TestMemberIsNonNegative<uint32_t>() for |width| and |height| instead to
1055     // reflect real code.
1056     verifier.TestMemberIsUndefined(video_source.width);
1057     verifier.TestMemberIsUndefined(video_source.height);
1058     // TODO(hbos): When |frames| is implemented test that this member should be
1059     // expected to be non-negative.
1060     verifier.TestMemberIsUndefined(video_source.frames);
1061     verifier.TestMemberIsNonNegative<uint32_t>(video_source.frames_per_second);
1062     return verifier.ExpectAllMembersSuccessfullyTested();
1063   }
1064 
VerifyRTCTransportStats(const RTCTransportStats & transport)1065   bool VerifyRTCTransportStats(const RTCTransportStats& transport) {
1066     RTCStatsVerifier verifier(report_, &transport);
1067     verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_sent);
1068     verifier.TestMemberIsNonNegative<uint64_t>(transport.packets_sent);
1069     verifier.TestMemberIsNonNegative<uint64_t>(transport.bytes_received);
1070     verifier.TestMemberIsNonNegative<uint64_t>(transport.packets_received);
1071     verifier.TestMemberIsOptionalIDReference(transport.rtcp_transport_stats_id,
1072                                              RTCTransportStats::kType);
1073     verifier.TestMemberIsDefined(transport.dtls_state);
1074     verifier.TestMemberIsIDReference(transport.selected_candidate_pair_id,
1075                                      RTCIceCandidatePairStats::kType);
1076     verifier.TestMemberIsIDReference(transport.local_certificate_id,
1077                                      RTCCertificateStats::kType);
1078     verifier.TestMemberIsIDReference(transport.remote_certificate_id,
1079                                      RTCCertificateStats::kType);
1080     verifier.TestMemberIsDefined(transport.tls_version);
1081     verifier.TestMemberIsDefined(transport.dtls_cipher);
1082     verifier.TestMemberIsDefined(transport.srtp_cipher);
1083     verifier.TestMemberIsPositive<uint32_t>(
1084         transport.selected_candidate_pair_changes);
1085     return verifier.ExpectAllMembersSuccessfullyTested();
1086   }
1087 
1088  private:
1089   rtc::scoped_refptr<const RTCStatsReport> report_;
1090 };
1091 
1092 #ifdef HAVE_SCTP
TEST_F(RTCStatsIntegrationTest,GetStatsFromCaller)1093 TEST_F(RTCStatsIntegrationTest, GetStatsFromCaller) {
1094   StartCall();
1095 
1096   rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCaller();
1097   RTCStatsReportVerifier(report.get()).VerifyReport({});
1098 
1099 #if RTC_TRACE_EVENTS_ENABLED
1100   EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
1101   #endif
1102 }
1103 
TEST_F(RTCStatsIntegrationTest,GetStatsFromCallee)1104 TEST_F(RTCStatsIntegrationTest, GetStatsFromCallee) {
1105   StartCall();
1106 
1107   rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1108   RTCStatsReportVerifier(report.get()).VerifyReport({});
1109 
1110 #if RTC_TRACE_EVENTS_ENABLED
1111   EXPECT_EQ(report->ToJson(), RTCStatsReportTraceListener::last_trace());
1112   #endif
1113 }
1114 
1115 // These tests exercise the integration of the stats selection algorithm inside
1116 // of PeerConnection. See rtcstatstraveral_unittest.cc for more detailed stats
1117 // traversal tests on particular stats graphs.
TEST_F(RTCStatsIntegrationTest,GetStatsWithSenderSelector)1118 TEST_F(RTCStatsIntegrationTest, GetStatsWithSenderSelector) {
1119   StartCall();
1120   ASSERT_FALSE(caller_->pc()->GetSenders().empty());
1121   rtc::scoped_refptr<const RTCStatsReport> report =
1122       GetStatsFromCaller(caller_->pc()->GetSenders()[0]);
1123   std::vector<const char*> allowed_missing_stats = {
1124       // TODO(hbos): Include RTC[Audio/Video]ReceiverStats when implemented.
1125       // TODO(hbos): Include RTCRemoteOutboundRtpStreamStats when implemented.
1126       // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
1127       RTCInboundRTPStreamStats::kType,
1128       RTCPeerConnectionStats::kType,
1129       RTCMediaStreamStats::kType,
1130       RTCDataChannelStats::kType,
1131   };
1132   RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
1133   EXPECT_TRUE(report->size());
1134 }
1135 
TEST_F(RTCStatsIntegrationTest,GetStatsWithReceiverSelector)1136 TEST_F(RTCStatsIntegrationTest, GetStatsWithReceiverSelector) {
1137   StartCall();
1138 
1139   ASSERT_FALSE(caller_->pc()->GetReceivers().empty());
1140   rtc::scoped_refptr<const RTCStatsReport> report =
1141       GetStatsFromCaller(caller_->pc()->GetReceivers()[0]);
1142   std::vector<const char*> allowed_missing_stats = {
1143       // TODO(hbos): Include RTC[Audio/Video]SenderStats when implemented.
1144       // TODO(hbos): Include RTCRemoteInboundRtpStreamStats when implemented.
1145       // TODO(hbos): Include RTCRtpContributingSourceStats when implemented.
1146       RTCOutboundRTPStreamStats::kType,
1147       RTCPeerConnectionStats::kType,
1148       RTCMediaStreamStats::kType,
1149       RTCDataChannelStats::kType,
1150   };
1151   RTCStatsReportVerifier(report.get()).VerifyReport(allowed_missing_stats);
1152   EXPECT_TRUE(report->size());
1153 }
1154 
TEST_F(RTCStatsIntegrationTest,GetStatsWithInvalidSenderSelector)1155 TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidSenderSelector) {
1156   StartCall();
1157 
1158   ASSERT_FALSE(callee_->pc()->GetSenders().empty());
1159   // The selector is invalid for the caller because it belongs to the callee.
1160   auto invalid_selector = callee_->pc()->GetSenders()[0];
1161   rtc::scoped_refptr<const RTCStatsReport> report =
1162       GetStatsFromCaller(invalid_selector);
1163   EXPECT_FALSE(report->size());
1164 }
1165 
TEST_F(RTCStatsIntegrationTest,GetStatsWithInvalidReceiverSelector)1166 TEST_F(RTCStatsIntegrationTest, GetStatsWithInvalidReceiverSelector) {
1167   StartCall();
1168 
1169   ASSERT_FALSE(callee_->pc()->GetReceivers().empty());
1170   // The selector is invalid for the caller because it belongs to the callee.
1171   auto invalid_selector = callee_->pc()->GetReceivers()[0];
1172   rtc::scoped_refptr<const RTCStatsReport> report =
1173       GetStatsFromCaller(invalid_selector);
1174   EXPECT_FALSE(report->size());
1175 }
1176 
1177 // TODO(bugs.webrtc.org/10041) For now this is equivalent to the following
1178 // test GetsStatsWhileClosingPeerConnection, because pc() is closed by
1179 // PeerConnectionTestWrapper. See: bugs.webrtc.org/9847
TEST_F(RTCStatsIntegrationTest,DISABLED_GetStatsWhileDestroyingPeerConnection)1180 TEST_F(RTCStatsIntegrationTest,
1181        DISABLED_GetStatsWhileDestroyingPeerConnection) {
1182   StartCall();
1183 
1184   rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1185       RTCStatsObtainer::Create();
1186   caller_->pc()->GetStats(stats_obtainer);
1187   // This will destroy the peer connection.
1188   caller_ = nullptr;
1189   // Any pending stats requests should have completed in the act of destroying
1190   // the peer connection.
1191   ASSERT_TRUE(stats_obtainer->report());
1192   #if RTC_TRACE_EVENTS_ENABLED
1193   EXPECT_EQ(stats_obtainer->report()->ToJson(),
1194             RTCStatsReportTraceListener::last_trace());
1195   #endif
1196 }
1197 
TEST_F(RTCStatsIntegrationTest,GetsStatsWhileClosingPeerConnection)1198 TEST_F(RTCStatsIntegrationTest, GetsStatsWhileClosingPeerConnection) {
1199   StartCall();
1200 
1201   rtc::scoped_refptr<RTCStatsObtainer> stats_obtainer =
1202       RTCStatsObtainer::Create();
1203   caller_->pc()->GetStats(stats_obtainer);
1204   caller_->pc()->Close();
1205 
1206   ASSERT_TRUE(stats_obtainer->report());
1207   #if RTC_TRACE_EVENTS_ENABLED
1208   EXPECT_EQ(stats_obtainer->report()->ToJson(),
1209             RTCStatsReportTraceListener::last_trace());
1210   #endif
1211 }
1212 
1213 // GetStatsReferencedIds() is optimized to recognize what is or isn't a
1214 // referenced ID based on dictionary type information and knowing what members
1215 // are used as references, as opposed to iterating all members to find the ones
1216 // with the "Id" or "Ids" suffix. As such, GetStatsReferencedIds() is tested as
1217 // an integration test instead of a unit test in order to guard against adding
1218 // new references and forgetting to update GetStatsReferencedIds().
TEST_F(RTCStatsIntegrationTest,GetStatsReferencedIds)1219 TEST_F(RTCStatsIntegrationTest, GetStatsReferencedIds) {
1220   StartCall();
1221 
1222   rtc::scoped_refptr<const RTCStatsReport> report = GetStatsFromCallee();
1223   for (const RTCStats& stats : *report) {
1224     // Find all references by looking at all string members with the "Id" or
1225     // "Ids" suffix.
1226     std::set<const std::string*> expected_ids;
1227     for (const auto* member : stats.Members()) {
1228       if (!member->is_defined())
1229         continue;
1230       if (member->type() == RTCStatsMemberInterface::kString) {
1231         if (absl::EndsWith(member->name(), "Id")) {
1232           const auto& id = member->cast_to<const RTCStatsMember<std::string>>();
1233           expected_ids.insert(&(*id));
1234         }
1235       } else if (member->type() == RTCStatsMemberInterface::kSequenceString) {
1236         if (absl::EndsWith(member->name(), "Ids")) {
1237           const auto& ids =
1238               member->cast_to<const RTCStatsMember<std::vector<std::string>>>();
1239           for (const std::string& id : *ids)
1240             expected_ids.insert(&id);
1241         }
1242       }
1243     }
1244 
1245     std::vector<const std::string*> neighbor_ids = GetStatsReferencedIds(stats);
1246     EXPECT_EQ(neighbor_ids.size(), expected_ids.size());
1247     for (const std::string* neighbor_id : neighbor_ids) {
1248       EXPECT_THAT(expected_ids, Contains(neighbor_id));
1249     }
1250     for (const std::string* expected_id : expected_ids) {
1251       EXPECT_THAT(neighbor_ids, Contains(expected_id));
1252     }
1253   }
1254 }
1255 #endif  // HAVE_SCTP
1256 
1257 }  // namespace
1258 
1259 }  // namespace webrtc
1260