RTCMediaStream[Track]Stats added.

webrtc/api/rtcstatscollector_unittest.cc

 /*
  *  Copyright 2016 The WebRTC project authors. All Rights Reserved.
  *
  *  Use of this source code is governed by a BSD-style license
  *  that can be found in the LICENSE file in the root of the source
  *  tree. An additional intellectual property rights grant can be found
  *  in the file PATENTS.  All contributing project authors may
  *  be found in the AUTHORS file in the root of the source tree.
  */
 
 #include "webrtc/api/rtcstatscollector.h"
 
 #include <memory>
 #include <ostream>
 #include <string>
 #include <vector>
 
+#include "webrtc/api/mediastream.h"
+#include "webrtc/api/mediastreamtrack.h"
 #include "webrtc/api/jsepsessiondescription.h"
 #include "webrtc/api/stats/rtcstats_objects.h"
 #include "webrtc/api/stats/rtcstatsreport.h"
 #include "webrtc/api/test/mock_datachannel.h"
 #include "webrtc/api/test/mock_peerconnection.h"
 #include "webrtc/api/test/mock_webrtcsession.h"
 #include "webrtc/base/checks.h"
 #include "webrtc/base/fakeclock.h"
 #include "webrtc/base/fakesslidentity.h"
 #include "webrtc/base/gunit.h"
@@ skipping 35 matching lines @@
 }
 
 void PrintTo(const RTCRemoteIceCandidateStats& stats, ::std::ostream* os) {
   *os << stats.ToString();
 }
 
 void PrintTo(const RTCPeerConnectionStats& stats, ::std::ostream* os) {
   *os << stats.ToString();
 }
 
+void PrintTo(const RTCMediaStreamStats& stats, ::std::ostream* os) {
+  *os << stats.ToString();
+}
+
+void PrintTo(const RTCMediaStreamTrackStats& stats, ::std::ostream* os) {
+  *os << stats.ToString();
+}
+
 void PrintTo(const RTCInboundRTPStreamStats& stats, ::std::ostream* os) {
   *os << stats.ToString();
 }
 
 void PrintTo(const RTCOutboundRTPStreamStats& stats, ::std::ostream* os) {
   *os << stats.ToString();
 }
 
 void PrintTo(const RTCTransportStats& stats, ::std::ostream* os) {
   *os << stats.ToString();
@@ skipping 60 matching lines @@
     const std::string& candidate_type,
     uint32_t priority) {
   std::unique_ptr<cricket::Candidate> candidate(new cricket::Candidate());
   candidate->set_address(rtc::SocketAddress(hostname, port));
   candidate->set_protocol(protocol);
   candidate->set_type(candidate_type);
   candidate->set_priority(priority);
   return candidate;
 }
 
+class FakeAudioProcessorForStats : public AudioProcessorInterface {

[Taylor Brandstetter, 2016/11/04 18:19:14]

nit: Since these fake objects only exist to return specific values, it seems
like it would be appropriate to use mocks instead. But probably not worth
changing everything at this point.

[hbos, 2016/11/08 13:43:37]

Acknowledged. Leaving as-is.

+ public:
+  static rtc::scoped_refptr<FakeAudioProcessorForStats> Create(
+      AudioProcessorInterface::AudioProcessorStats stats) {
+    return rtc::scoped_refptr<FakeAudioProcessorForStats>(
+        new rtc::RefCountedObject<FakeAudioProcessorForStats>(stats));
+  }

[Taylor Brandstetter, 2016/11/04 18:19:14]

nit: The Create methods here seem redundant. Couldn't FakeAudioProcessorForStats
inherit from rtc::RefCountedObject<AudioProcessorInterface>, and the unit test
could just use the constructor?

[hbos, 2016/11/08 13:43:37]

Done. Did it for FakeVideoTrackSourceForStats too.

+
+  FakeAudioProcessorForStats(
+      AudioProcessorInterface::AudioProcessorStats stats)
+      : stats_(stats) {
+  }
+
+  void GetStats(AudioProcessorInterface::AudioProcessorStats* stats) override {
+    *stats = stats_;
+  }
+
+ private:
+  AudioProcessorInterface::AudioProcessorStats stats_;
+};
+
+class FakeAudioTrackForStats
+    : public MediaStreamTrack<AudioTrackInterface> {
+ public:
+  static rtc::scoped_refptr<FakeAudioTrackForStats> Create(
+      const std::string& id,
+      MediaStreamTrackInterface::TrackState state,
+      int signal_level,
+      rtc::scoped_refptr<FakeAudioProcessorForStats> processor) {
+    rtc::scoped_refptr<FakeAudioTrackForStats> audio_track_stats(
+        new rtc::RefCountedObject<FakeAudioTrackForStats>(
+            id, signal_level, processor));
+    audio_track_stats->set_state(state);
+    return audio_track_stats;
+  }
+
+  FakeAudioTrackForStats(
+      const std::string& id,
+      int signal_level,
+      rtc::scoped_refptr<FakeAudioProcessorForStats> processor)
+      : MediaStreamTrack<AudioTrackInterface>(id),
+        signal_level_(signal_level),
+        processor_(processor) {
+  }
+
+  std::string kind() const override {
+    return MediaStreamTrackInterface::kAudioKind;
+  }
+  webrtc::AudioSourceInterface* GetSource() const override { return nullptr; }
+  void AddSink(webrtc::AudioTrackSinkInterface* sink) override {}
+  void RemoveSink(webrtc::AudioTrackSinkInterface* sink) override {}
+  bool GetSignalLevel(int* level) override {
+    *level = signal_level_;
+    return true;
+  }
+  rtc::scoped_refptr<AudioProcessorInterface> GetAudioProcessor() override {
+    return processor_;
+  }
+
+ private:
+  int signal_level_;
+  rtc::scoped_refptr<FakeAudioProcessorForStats> processor_;
+};
+
+class FakeVideoTrackSourceForStats : public VideoTrackSourceInterface {
+ public:
+  static rtc::scoped_refptr<FakeVideoTrackSourceForStats> Create(
+      VideoTrackSourceInterface::Stats stats) {
+    return rtc::scoped_refptr<FakeVideoTrackSourceForStats>(
+        new rtc::RefCountedObject<FakeVideoTrackSourceForStats>(stats));
+  }
+
+  FakeVideoTrackSourceForStats(VideoTrackSourceInterface::Stats stats)
+      : stats_(stats) {
+  }
+
+  MediaSourceInterface::SourceState state() const override {
+    return MediaSourceInterface::kLive;
+  }
+  bool remote() const override { return false; }
+  void RegisterObserver(ObserverInterface* observer) override {}
+  void UnregisterObserver(ObserverInterface* observer) override {}
+  void AddOrUpdateSink(rtc::VideoSinkInterface<cricket::VideoFrame>* sink,
+                       const rtc::VideoSinkWants& wants) override {}
+  void RemoveSink(rtc::VideoSinkInterface<cricket::VideoFrame>* sink) override {
+  }
+  bool is_screencast() const override { return false; }
+  rtc::Optional<bool> needs_denoising() const override {
+    return rtc::Optional<bool>();
+  }
+  bool GetStats(VideoTrackSourceInterface::Stats* stats) override {
+    *stats = stats_;
+    return true;
+  }
+
+ private:
+  VideoTrackSourceInterface::Stats stats_;
+};
+
+class FakeVideoTrackForStats
+    : public MediaStreamTrack<VideoTrackInterface> {
+ public:
+  static rtc::scoped_refptr<FakeVideoTrackForStats> Create(
+      const std::string& id,
+      MediaStreamTrackInterface::TrackState state,
+      rtc::scoped_refptr<VideoTrackSourceInterface> source) {
+    rtc::scoped_refptr<FakeVideoTrackForStats> video_track(
+        new rtc::RefCountedObject<FakeVideoTrackForStats>(id, source));
+    video_track->set_state(state);
+    return video_track;
+  }
+
+  FakeVideoTrackForStats(
+      const std::string& id,
+      rtc::scoped_refptr<VideoTrackSourceInterface> source)
+      : MediaStreamTrack<VideoTrackInterface>(id),
+        source_(source) {
+  }
+
+  std::string kind() const override {
+    return MediaStreamTrackInterface::kVideoKind;
+  }
+  VideoTrackSourceInterface* GetSource() const override {
+    return source_;
+  }
+
+ private:
+  rtc::scoped_refptr<VideoTrackSourceInterface> source_;
+};
+
 class RTCStatsCollectorTestHelper : public SetSessionDescriptionObserver {
  public:
   RTCStatsCollectorTestHelper()
       : worker_thread_(rtc::Thread::Current()),
         network_thread_(rtc::Thread::Current()),
         media_engine_(new cricket::FakeMediaEngine()),
         channel_manager_(
             new cricket::ChannelManager(media_engine_,
                                         worker_thread_,
                                         network_thread_)),
         media_controller_(
             MediaControllerInterface::Create(cricket::MediaConfig(),
                                              worker_thread_,
                                              channel_manager_.get(),
                                              &event_log_)),
         session_(media_controller_.get()),
         pc_() {
     // Default return values for mocks.
+    EXPECT_CALL(pc_, local_streams()).WillRepeatedly(Return(nullptr));
+    EXPECT_CALL(pc_, remote_streams()).WillRepeatedly(Return(nullptr));
     EXPECT_CALL(pc_, session()).WillRepeatedly(Return(&session_));
     EXPECT_CALL(pc_, sctp_data_channels()).WillRepeatedly(
         ReturnRef(data_channels_));
     EXPECT_CALL(session_, video_channel()).WillRepeatedly(ReturnNull());
     EXPECT_CALL(session_, voice_channel()).WillRepeatedly(ReturnNull());
     EXPECT_CALL(session_, GetTransportStats(_)).WillRepeatedly(Return(false));
     EXPECT_CALL(session_, GetLocalCertificate(_, _)).WillRepeatedly(
         Return(false));
     EXPECT_CALL(session_, GetRemoteSSLCertificate_ReturnsRawPointer(_))
         .WillRepeatedly(Return(nullptr));
@@ skipping 10 matching lines @@
   }
 
   // SetSessionDescriptionObserver overrides.
   void OnSuccess() override {}
   void OnFailure(const std::string& error) override {
     RTC_NOTREACHED() << error;
   }
 
  private:
   rtc::ScopedFakeClock fake_clock_;
-  webrtc::RtcEventLogNullImpl event_log_;
+  RtcEventLogNullImpl event_log_;
   rtc::Thread* const worker_thread_;
   rtc::Thread* const network_thread_;
   cricket::FakeMediaEngine* media_engine_;
   std::unique_ptr<cricket::ChannelManager> channel_manager_;
-  std::unique_ptr<webrtc::MediaControllerInterface> media_controller_;
+  std::unique_ptr<MediaControllerInterface> media_controller_;
   MockWebRtcSession session_;
   MockPeerConnection pc_;
 
   std::vector<rtc::scoped_refptr<DataChannel>> data_channels_;
 };
 
 class RTCTestStats : public RTCStats {
  public:
   WEBRTC_RTCSTATS_DECL();
 
@@ skipping 755 matching lines @@
     // channels that have been opened and closed, not the numbers currently
     // open/closed, we would expect opened >= closed and (opened - closed) to be
     // the number currently open. crbug.com/636818.
     const RTCPeerConnectionStats& pcstats =
         stats->cast_to<RTCPeerConnectionStats>();
     EXPECT_EQ(*pcstats.data_channels_opened, static_cast<uint32_t>(1));
     EXPECT_EQ(*pcstats.data_channels_closed, static_cast<uint32_t>(3));
   }
 }
 
+TEST_F(RTCStatsCollectorTest,
+       CollectRTCMediaStreamStatsAndRTCMediaStreamTrackStats_Audio) {
+  rtc::scoped_refptr<StreamCollection> local_streams =
+      StreamCollection::Create();
+  rtc::scoped_refptr<StreamCollection> remote_streams =
+      StreamCollection::Create();
+  EXPECT_CALL(test_->pc(), local_streams())
+      .WillRepeatedly(Return(local_streams));
+  EXPECT_CALL(test_->pc(), remote_streams())
+      .WillRepeatedly(Return(remote_streams));
+
+  rtc::scoped_refptr<MediaStream> local_stream =
+      MediaStream::Create("LocalStreamLabel");
+  local_streams->AddStream(local_stream);
+  rtc::scoped_refptr<MediaStream> remote_stream =
+      MediaStream::Create("RemoteStreamLabel");
+  remote_streams->AddStream(remote_stream);
+
+  // Local audio track
+  AudioProcessorInterface::AudioProcessorStats local_audio_processor_stats;
+  local_audio_processor_stats.echo_return_loss = 42;
+  local_audio_processor_stats.echo_return_loss_enhancement = 52;
+  rtc::scoped_refptr<FakeAudioTrackForStats> local_audio_track =
+      FakeAudioTrackForStats::Create(
+          "LocalAudioTrackID",
+          MediaStreamTrackInterface::TrackState::kEnded,
+          32767,
+          FakeAudioProcessorForStats::Create(local_audio_processor_stats));
+  local_stream->AddTrack(local_audio_track);
+
+  // Remote audio track
+  AudioProcessorInterface::AudioProcessorStats remote_audio_processor_stats;
+  remote_audio_processor_stats.echo_return_loss = 13;
+  remote_audio_processor_stats.echo_return_loss_enhancement = 37;
+  rtc::scoped_refptr<FakeAudioTrackForStats> remote_audio_track =
+      FakeAudioTrackForStats::Create(
+          "RemoteAudioTrackID",
+          MediaStreamTrackInterface::TrackState::kLive,
+          0,
+          FakeAudioProcessorForStats::Create(remote_audio_processor_stats));
+  remote_stream->AddTrack(remote_audio_track);
+
+  rtc::scoped_refptr<const RTCStatsReport> report = GetStatsReport();
+
+  RTCMediaStreamStats expected_local_stream(
+      "RTCMediaStream_LocalStreamLabel", report->timestamp_us());
+  expected_local_stream.stream_identifier = "LocalStreamLabel";
+  expected_local_stream.track_ids = std::vector<std::string>();
+  expected_local_stream.track_ids->push_back(
+      "RTCMediaStreamTrack_LocalAudioTrackID");
+  EXPECT_TRUE(report->Get(expected_local_stream.id()));
+  EXPECT_EQ(expected_local_stream,
+            report->Get(expected_local_stream.id())->cast_to<
+                RTCMediaStreamStats>());
+
+  RTCMediaStreamStats expected_remote_stream(
+      "RTCMediaStream_RemoteStreamLabel", report->timestamp_us());
+  expected_remote_stream.stream_identifier = "RemoteStreamLabel";
+  expected_remote_stream.track_ids = std::vector<std::string>();
+  expected_remote_stream.track_ids->push_back(
+      "RTCMediaStreamTrack_RemoteAudioTrackID");
+  EXPECT_TRUE(report->Get(expected_remote_stream.id()));
+  EXPECT_EQ(expected_remote_stream,
+            report->Get(expected_remote_stream.id())->cast_to<
+                RTCMediaStreamStats>());
+
+  RTCMediaStreamTrackStats expected_local_audio_track(
+      "RTCMediaStreamTrack_LocalAudioTrackID", report->timestamp_us());
+  expected_local_audio_track.track_identifier = "LocalAudioTrackID";
+  expected_local_audio_track.remote_source = false;
+  expected_local_audio_track.ended = true;
+  expected_local_audio_track.detached = false;
+  expected_local_audio_track.audio_level = 1.0;
+  expected_local_audio_track.echo_return_loss = 42.0;
+  expected_local_audio_track.echo_return_loss_enhancement = 52.0;
+  EXPECT_TRUE(report->Get(expected_local_audio_track.id()));
+  EXPECT_EQ(expected_local_audio_track,
+            report->Get(expected_local_audio_track.id())->cast_to<
+                RTCMediaStreamTrackStats>());
+
+  RTCMediaStreamTrackStats expected_remote_audio_track(
+      "RTCMediaStreamTrack_RemoteAudioTrackID", report->timestamp_us());
+  expected_remote_audio_track.track_identifier = "RemoteAudioTrackID";
+  expected_remote_audio_track.remote_source = true;
+  expected_remote_audio_track.ended = false;
+  expected_remote_audio_track.detached = false;
+  expected_remote_audio_track.audio_level = 0.0;
+  expected_remote_audio_track.echo_return_loss = 13.0;
+  expected_remote_audio_track.echo_return_loss_enhancement = 37.0;
+  EXPECT_TRUE(report->Get(expected_remote_audio_track.id()));
+  EXPECT_EQ(expected_remote_audio_track,
+            report->Get(expected_remote_audio_track.id())->cast_to<
+                RTCMediaStreamTrackStats>());
+}
+
+TEST_F(RTCStatsCollectorTest,
+       CollectRTCMediaStreamStatsAndRTCMediaStreamTrackStats_Video) {
+  rtc::scoped_refptr<StreamCollection> local_streams =
+      StreamCollection::Create();
+  rtc::scoped_refptr<StreamCollection> remote_streams =
+      StreamCollection::Create();
+  EXPECT_CALL(test_->pc(), local_streams())
+      .WillRepeatedly(Return(local_streams));
+  EXPECT_CALL(test_->pc(), remote_streams())
+      .WillRepeatedly(Return(remote_streams));
+
+  rtc::scoped_refptr<MediaStream> local_stream =
+      MediaStream::Create("LocalStreamLabel");
+  local_streams->AddStream(local_stream);
+  rtc::scoped_refptr<MediaStream> remote_stream =
+      MediaStream::Create("RemoteStreamLabel");
+  remote_streams->AddStream(remote_stream);
+
+  // Local video track
+  VideoTrackSourceInterface::Stats local_video_track_source_stats;
+  local_video_track_source_stats.input_width = 1234;
+  local_video_track_source_stats.input_height = 4321;
+  rtc::scoped_refptr<FakeVideoTrackSourceForStats> local_video_track_source =
+      FakeVideoTrackSourceForStats::Create(local_video_track_source_stats);
+  rtc::scoped_refptr<FakeVideoTrackForStats> local_video_track =
+      FakeVideoTrackForStats::Create(
+          "LocalVideoTrackID",
+          MediaStreamTrackInterface::TrackState::kLive,
+          local_video_track_source);
+  local_stream->AddTrack(local_video_track);
+
+  // Remote video track
+  VideoTrackSourceInterface::Stats remote_video_track_source_stats;
+  remote_video_track_source_stats.input_width = 1234;
+  remote_video_track_source_stats.input_height = 4321;
+  rtc::scoped_refptr<FakeVideoTrackSourceForStats> remote_video_track_source =
+      FakeVideoTrackSourceForStats::Create(remote_video_track_source_stats);
+  rtc::scoped_refptr<FakeVideoTrackForStats> remote_video_track =
+      FakeVideoTrackForStats::Create(
+          "RemoteVideoTrackID",
+          MediaStreamTrackInterface::TrackState::kEnded,
+          remote_video_track_source);
+  remote_stream->AddTrack(remote_video_track);
+
+  rtc::scoped_refptr<const RTCStatsReport> report = GetStatsReport();
+
+  RTCMediaStreamStats expected_local_stream(
+      "RTCMediaStream_LocalStreamLabel", report->timestamp_us());
+  expected_local_stream.stream_identifier = "LocalStreamLabel";
+  expected_local_stream.track_ids = std::vector<std::string>();
+  expected_local_stream.track_ids->push_back(
+      "RTCMediaStreamTrack_LocalVideoTrackID");
+  EXPECT_TRUE(report->Get(expected_local_stream.id()));
+  EXPECT_EQ(expected_local_stream,
+            report->Get(expected_local_stream.id())->cast_to<
+                RTCMediaStreamStats>());
+
+  RTCMediaStreamStats expected_remote_stream(
+      "RTCMediaStream_RemoteStreamLabel", report->timestamp_us());
+  expected_remote_stream.stream_identifier = "RemoteStreamLabel";
+  expected_remote_stream.track_ids = std::vector<std::string>();
+  expected_remote_stream.track_ids->push_back(
+      "RTCMediaStreamTrack_RemoteVideoTrackID");
+  EXPECT_TRUE(report->Get(expected_remote_stream.id()));
+  EXPECT_EQ(expected_remote_stream,
+            report->Get(expected_remote_stream.id())->cast_to<
+                RTCMediaStreamStats>());
+
+  RTCMediaStreamTrackStats expected_local_video_track(
+      "RTCMediaStreamTrack_LocalVideoTrackID", report->timestamp_us());
+  expected_local_video_track.track_identifier = "LocalVideoTrackID";
+  expected_local_video_track.remote_source = false;
+  expected_local_video_track.ended = false;
+  expected_local_video_track.detached = false;
+  expected_local_video_track.frame_width = 1234;
+  expected_local_video_track.frame_height = 4321;
+  EXPECT_TRUE(report->Get(expected_local_video_track.id()));
+  EXPECT_EQ(expected_local_video_track,
+            report->Get(expected_local_video_track.id())->cast_to<
+                RTCMediaStreamTrackStats>());
+
+  RTCMediaStreamTrackStats expected_remote_video_track(
+      "RTCMediaStreamTrack_RemoteVideoTrackID", report->timestamp_us());
+  expected_remote_video_track.track_identifier = "RemoteVideoTrackID";

[hta-webrtc, 2016/11/08 09:50:22]

Would it be clearer to use remote_video_track->id here?
I'm always nervous when we're writing tests where multiple strings have to be
kept in sync.

[hbos, 2016/11/08 13:43:37]

Done, updated all "blah_identifiers" (but not RTCStats IDs).

+  expected_remote_video_track.remote_source = true;
+  expected_remote_video_track.ended = true;
+  expected_remote_video_track.detached = false;
+  expected_remote_video_track.frame_width = 1234;
+  expected_remote_video_track.frame_height = 4321;
+  EXPECT_TRUE(report->Get(expected_remote_video_track.id()));
+  EXPECT_EQ(expected_remote_video_track,
+            report->Get(expected_remote_video_track.id())->cast_to<
+                RTCMediaStreamTrackStats>());
+}
+
 TEST_F(RTCStatsCollectorTest, CollectRTCInboundRTPStreamStats_Audio) {
   MockVoiceMediaChannel* voice_media_channel = new MockVoiceMediaChannel();
   cricket::VoiceChannel voice_channel(
       test_->worker_thread(), test_->network_thread(), test_->media_engine(),
       voice_media_channel, nullptr, "VoiceContentName", false);
 
   cricket::VoiceMediaInfo voice_media_info;
   voice_media_info.receivers.push_back(cricket::VoiceReceiverInfo());
   voice_media_info.receivers[0].local_stats.push_back(
       cricket::SsrcReceiverInfo());
@@ skipping 321 matching lines @@
   rtc::scoped_refptr<FakeRTCStatsCollector> collector_;
 };
 
 TEST_F(RTCStatsCollectorTestWithFakeCollector, ThreadUsageAndResultsMerging) {
   collector_->VerifyThreadUsageAndResultsMerging();
 }
 
 }  // namespace
 
 }  // namespace webrtc