Test CreatePeerConnectionFactory() with a forwarding mock AudioDecoderFactory

webrtc/pc/peerconnectionendtoend_unittest.cc

 /*
  *  Copyright 2013 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 <memory>
 
+#include "webrtc/api/audio_codecs/builtin_audio_decoder_factory.h"
 #include "webrtc/base/gunit.h"
 #include "webrtc/base/logging.h"
+#include "webrtc/base/ptr_util.h"
 #include "webrtc/base/ssladapter.h"
-#include "webrtc/base/thread.h"
 #include "webrtc/base/sslstreamadapter.h"
 #include "webrtc/base/stringencode.h"
 #include "webrtc/base/stringutils.h"
+#include "webrtc/base/thread.h"
 #ifdef WEBRTC_ANDROID
 #include "webrtc/pc/test/androidtestinitializer.h"
 #endif
 #include "webrtc/pc/test/peerconnectiontestwrapper.h"
 // Notice that mockpeerconnectionobservers.h must be included after the above!
 #include "webrtc/pc/test/mockpeerconnectionobservers.h"
+#include "webrtc/test/mock_audio_decoder.h"
+#include "webrtc/test/mock_audio_decoder_factory.h"
+
+using testing::AtLeast;
+using testing::Invoke;
+using testing::StrictMock;
+using testing::_;
 
 using webrtc::DataChannelInterface;
 using webrtc::FakeConstraints;
 using webrtc::MediaConstraintsInterface;
 using webrtc::MediaStreamInterface;
 using webrtc::PeerConnectionInterface;
 
 namespace {
 
 const int kMaxWait = 10000;
@@ skipping 16 matching lines @@
         "callee", &network_thread_, &worker_thread_);
     webrtc::PeerConnectionInterface::IceServer ice_server;
     ice_server.uri = "stun:stun.l.google.com:19302";
     config_.servers.push_back(ice_server);
 
 #ifdef WEBRTC_ANDROID
     webrtc::InitializeAndroidObjects();
 #endif
   }
 
-  void CreatePcs() {
-    CreatePcs(NULL);
-  }
-
-  void CreatePcs(const MediaConstraintsInterface* pc_constraints) {
-    EXPECT_TRUE(caller_->CreatePc(pc_constraints, config_));
-    EXPECT_TRUE(callee_->CreatePc(pc_constraints, config_));
+  void CreatePcs(
+      const MediaConstraintsInterface* pc_constraints,
+      rtc::scoped_refptr<webrtc::AudioEncoderFactory> audio_encoder_factory,
+      rtc::scoped_refptr<webrtc::AudioDecoderFactory> audio_decoder_factory) {
+    EXPECT_TRUE(caller_->CreatePc(
+        pc_constraints, config_, audio_encoder_factory, audio_decoder_factory));
+    EXPECT_TRUE(callee_->CreatePc(
+        pc_constraints, config_, audio_encoder_factory, audio_decoder_factory));
     PeerConnectionTestWrapper::Connect(caller_.get(), callee_.get());
 
     caller_->SignalOnDataChannel.connect(
         this, &PeerConnectionEndToEndTest::OnCallerAddedDataChanel);
     callee_->SignalOnDataChannel.connect(
         this, &PeerConnectionEndToEndTest::OnCalleeAddedDataChannel);
   }
 
   void GetAndAddUserMedia() {
     FakeConstraints audio_constraints;
@@ skipping 77 matching lines @@
  protected:
   rtc::Thread network_thread_;
   rtc::Thread worker_thread_;
   rtc::scoped_refptr<PeerConnectionTestWrapper> caller_;
   rtc::scoped_refptr<PeerConnectionTestWrapper> callee_;
   DataChannelList caller_signaled_data_channels_;
   DataChannelList callee_signaled_data_channels_;
   webrtc::PeerConnectionInterface::RTCConfiguration config_;
 };
 
+std::unique_ptr<webrtc::AudioDecoder> CreateForwardingMockDecoder(
+    std::unique_ptr<webrtc::AudioDecoder> real_decoder) {
+  class ForwardingMockDecoder : public StrictMock<webrtc::MockAudioDecoder> {
+   public:
+    ForwardingMockDecoder(std::unique_ptr<AudioDecoder> decoder)
+        : decoder_(std::move(decoder)) {}
+
+   private:
+    std::unique_ptr<AudioDecoder> decoder_;
+  };
+
+  const auto dec = real_decoder.get();  // For lambda capturing.
+  auto mock_decoder =
+      rtc::MakeUnique<ForwardingMockDecoder>(std::move(real_decoder));
+  EXPECT_CALL(*mock_decoder, Channels())
+      .Times(AtLeast(1))
+      .WillRepeatedly(Invoke([dec] { return dec->Channels(); }));
+  EXPECT_CALL(*mock_decoder, DecodeInternal(_, _, _, _, _))
+      .Times(AtLeast(1))
+      .WillRepeatedly(
+          Invoke([dec](const uint8_t* encoded, size_t encoded_len,
+                       int sample_rate_hz, int16_t* decoded,
+                       webrtc::AudioDecoder::SpeechType* speech_type) {
+            return dec->Decode(encoded, encoded_len, sample_rate_hz,
+                               std::numeric_limits<size_t>::max(), decoded,
+                               speech_type);
+          }));
+  EXPECT_CALL(*mock_decoder, Die());
+  EXPECT_CALL(*mock_decoder, HasDecodePlc()).WillRepeatedly(Invoke([dec] {
+    return dec->HasDecodePlc();
+  }));
+  EXPECT_CALL(*mock_decoder, IncomingPacket(_, _, _, _, _))
+      .Times(AtLeast(1))
+      .WillRepeatedly(Invoke([dec](const uint8_t* payload, size_t payload_len,
+                                   uint16_t rtp_sequence_number,
+                                   uint32_t rtp_timestamp,
+                                   uint32_t arrival_timestamp) {
+        return dec->IncomingPacket(payload, payload_len, rtp_sequence_number,
+                                   rtp_timestamp, arrival_timestamp);
+      }));
+  EXPECT_CALL(*mock_decoder, PacketDuration(_, _))
+      .Times(AtLeast(1))
+      .WillRepeatedly(Invoke([dec](const uint8_t* encoded, size_t encoded_len) {
+        return dec->PacketDuration(encoded, encoded_len);
+      }));
+  EXPECT_CALL(*mock_decoder, SampleRateHz())
+      .Times(AtLeast(1))
+      .WillRepeatedly(Invoke([dec] { return dec->SampleRateHz(); }));
+
+  return std::move(mock_decoder);
+}
+
+rtc::scoped_refptr<webrtc::AudioDecoderFactory>
+CreateForwardingMockDecoderFactory(
+    webrtc::AudioDecoderFactory* real_decoder_factory) {
+  rtc::scoped_refptr<webrtc::MockAudioDecoderFactory> mock_decoder_factory =
+      new rtc::RefCountedObject<StrictMock<webrtc::MockAudioDecoderFactory>>;
+  EXPECT_CALL(*mock_decoder_factory, GetSupportedDecoders())
+      .Times(AtLeast(1))
+      .WillRepeatedly(Invoke([real_decoder_factory] {
+        return real_decoder_factory->GetSupportedDecoders();
+      }));
+  EXPECT_CALL(*mock_decoder_factory, IsSupportedDecoder(_))
+      .Times(AtLeast(1))
+      .WillRepeatedly(
+          Invoke([real_decoder_factory](const webrtc::SdpAudioFormat& format) {
+            return real_decoder_factory->IsSupportedDecoder(format);
+          }));
+  EXPECT_CALL(*mock_decoder_factory, MakeAudioDecoderMock(_, _))
+      .Times(AtLeast(2))
+      .WillRepeatedly(
+          Invoke([real_decoder_factory](
+                     const webrtc::SdpAudioFormat& format,
+                     std::unique_ptr<webrtc::AudioDecoder>* return_value) {
+            auto real_decoder = real_decoder_factory->MakeAudioDecoder(format);
+            *return_value =
+                real_decoder
+                    ? CreateForwardingMockDecoder(std::move(real_decoder))
+                    : nullptr;
+          }));
+  return mock_decoder_factory;
+}
+
 // Disabled for TSan v2, see
 // https://bugs.chromium.org/p/webrtc/issues/detail?id=4719 for details.
 // Disabled for Mac, see
 // https://bugs.chromium.org/p/webrtc/issues/detail?id=5231 for details.
 #if !defined(THREAD_SANITIZER) && !defined(WEBRTC_MAC)
 TEST_F(PeerConnectionEndToEndTest, Call) {
-  CreatePcs();
+  rtc::scoped_refptr<webrtc::AudioDecoderFactory> real_decoder_factory =
+      webrtc::CreateBuiltinAudioDecoderFactory();
+  CreatePcs(nullptr, webrtc::CreateBuiltinAudioEncoderFactory(),
+            CreateForwardingMockDecoderFactory(real_decoder_factory.get()));

[the sun, 2017/04/18 10:38:21]

What's the rationale for only using the mocks here? Would it be better to add a
separate test case?

[kwiberg-webrtc, 2017/04/18 10:56:08]

IIRC only the two Call* tests actually decode audio packets. If I were to
support the others as well, I would need to EXPECT different things there. I
went with the simplest possible solution.
I didn't do that because this one already does what I want, and injecting a
forwarding mock doesn't change at all what the test does, so duplicating it
seemed unnecessary.

   GetAndAddUserMedia();
   Negotiate();
   WaitForCallEstablished();
 }
 #endif // if !defined(THREAD_SANITIZER) && !defined(WEBRTC_MAC)
 
 #if !defined(ADDRESS_SANITIZER)
 TEST_F(PeerConnectionEndToEndTest, CallWithLegacySdp) {
   FakeConstraints pc_constraints;
   pc_constraints.AddMandatory(MediaConstraintsInterface::kEnableDtlsSrtp,
                               false);
-  CreatePcs(&pc_constraints);
+  CreatePcs(&pc_constraints, webrtc::CreateBuiltinAudioEncoderFactory(),
+            webrtc::CreateBuiltinAudioDecoderFactory());
   GetAndAddUserMedia();
   Negotiate();
   WaitForCallEstablished();
 }
 #endif  // !defined(ADDRESS_SANITIZER)
 
 #ifdef HAVE_SCTP
 // Verifies that a DataChannel created before the negotiation can transition to
 // "OPEN" and transfer data.
 TEST_F(PeerConnectionEndToEndTest, CreateDataChannelBeforeNegotiate) {
-  CreatePcs();
+  CreatePcs(nullptr, webrtc::CreateBuiltinAudioEncoderFactory(),
+            webrtc::CreateBuiltinAudioDecoderFactory());
 
   webrtc::DataChannelInit init;
   rtc::scoped_refptr<DataChannelInterface> caller_dc(
       caller_->CreateDataChannel("data", init));
   rtc::scoped_refptr<DataChannelInterface> callee_dc(
       callee_->CreateDataChannel("data", init));
 
   Negotiate();
   WaitForConnection();
 
   WaitForDataChannelsToOpen(caller_dc, callee_signaled_data_channels_, 0);
   WaitForDataChannelsToOpen(callee_dc, caller_signaled_data_channels_, 0);
 
   TestDataChannelSendAndReceive(caller_dc, callee_signaled_data_channels_[0]);
   TestDataChannelSendAndReceive(callee_dc, caller_signaled_data_channels_[0]);
 
   CloseDataChannels(caller_dc, callee_signaled_data_channels_, 0);
   CloseDataChannels(callee_dc, caller_signaled_data_channels_, 0);
 }
 
 // Verifies that a DataChannel created after the negotiation can transition to
 // "OPEN" and transfer data.
 TEST_F(PeerConnectionEndToEndTest, CreateDataChannelAfterNegotiate) {
-  CreatePcs();
+  CreatePcs(nullptr, webrtc::CreateBuiltinAudioEncoderFactory(),
+            webrtc::CreateBuiltinAudioDecoderFactory());
 
   webrtc::DataChannelInit init;
 
   // This DataChannel is for creating the data content in the negotiation.
   rtc::scoped_refptr<DataChannelInterface> dummy(
       caller_->CreateDataChannel("data", init));
   Negotiate();
   WaitForConnection();
 
   // Wait for the data channel created pre-negotiation to be opened.
@@ skipping 10 matching lines @@
 
   TestDataChannelSendAndReceive(caller_dc, callee_signaled_data_channels_[1]);
   TestDataChannelSendAndReceive(callee_dc, caller_signaled_data_channels_[0]);
 
   CloseDataChannels(caller_dc, callee_signaled_data_channels_, 1);
   CloseDataChannels(callee_dc, caller_signaled_data_channels_, 0);
 }
 
 // Verifies that DataChannel IDs are even/odd based on the DTLS roles.
 TEST_F(PeerConnectionEndToEndTest, DataChannelIdAssignment) {
-  CreatePcs();
+  CreatePcs(nullptr, webrtc::CreateBuiltinAudioEncoderFactory(),
+            webrtc::CreateBuiltinAudioDecoderFactory());
 
   webrtc::DataChannelInit init;
   rtc::scoped_refptr<DataChannelInterface> caller_dc_1(
       caller_->CreateDataChannel("data", init));
   rtc::scoped_refptr<DataChannelInterface> callee_dc_1(
       callee_->CreateDataChannel("data", init));
 
   Negotiate();
   WaitForConnection();
 
   EXPECT_EQ(1U, caller_dc_1->id() % 2);
   EXPECT_EQ(0U, callee_dc_1->id() % 2);
 
   rtc::scoped_refptr<DataChannelInterface> caller_dc_2(
       caller_->CreateDataChannel("data", init));
   rtc::scoped_refptr<DataChannelInterface> callee_dc_2(
       callee_->CreateDataChannel("data", init));
 
   EXPECT_EQ(1U, caller_dc_2->id() % 2);
   EXPECT_EQ(0U, callee_dc_2->id() % 2);
 }
 
 // Verifies that the message is received by the right remote DataChannel when
 // there are multiple DataChannels.
 TEST_F(PeerConnectionEndToEndTest,
        MessageTransferBetweenTwoPairsOfDataChannels) {
-  CreatePcs();
+  CreatePcs(nullptr, webrtc::CreateBuiltinAudioEncoderFactory(),
+            webrtc::CreateBuiltinAudioDecoderFactory());
 
   webrtc::DataChannelInit init;
 
   rtc::scoped_refptr<DataChannelInterface> caller_dc_1(
       caller_->CreateDataChannel("data", init));
   rtc::scoped_refptr<DataChannelInterface> caller_dc_2(
       caller_->CreateDataChannel("data", init));
 
   Negotiate();
   WaitForConnection();
@@ skipping 100 matching lines @@
 // Verifies that a DataChannel added from an OPEN message functions after
 // a channel has been previously closed (webrtc issue 3778).
 // This previously failed because the new channel re-uses the ID of the closed
 // channel, and the closed channel was incorrectly still assigned to the id.
 // TODO(deadbeef): This is disabled because there's currently a race condition
 // caused by the fact that a data channel signals that it's closed before it
 // really is. Re-enable this test once that's fixed.
 // See: https://bugs.chromium.org/p/webrtc/issues/detail?id=4453
 TEST_F(PeerConnectionEndToEndTest,
        DISABLED_DataChannelFromOpenWorksAfterClose) {
-  CreatePcs();
+  CreatePcs(nullptr, webrtc::CreateBuiltinAudioEncoderFactory(),
+            webrtc::CreateBuiltinAudioDecoderFactory());
 
   webrtc::DataChannelInit init;
   rtc::scoped_refptr<DataChannelInterface> caller_dc(
       caller_->CreateDataChannel("data", init));
 
   Negotiate();
   WaitForConnection();
 
   WaitForDataChannelsToOpen(caller_dc, callee_signaled_data_channels_, 0);
   CloseDataChannels(caller_dc, callee_signaled_data_channels_, 0);
 
   // Create a new channel and ensure it works after closing the previous one.
   caller_dc = caller_->CreateDataChannel("data2", init);
 
   WaitForDataChannelsToOpen(caller_dc, callee_signaled_data_channels_, 1);
   TestDataChannelSendAndReceive(caller_dc, callee_signaled_data_channels_[1]);
 
   CloseDataChannels(caller_dc, callee_signaled_data_channels_, 1);
 }
 
 // This tests that if a data channel is closed remotely while not referenced
 // by the application (meaning only the PeerConnection contributes to its
 // reference count), no memory access violation will occur.
 // See: https://code.google.com/p/chromium/issues/detail?id=565048
 TEST_F(PeerConnectionEndToEndTest, CloseDataChannelRemotelyWhileNotReferenced) {
-  CreatePcs();
+  CreatePcs(nullptr, webrtc::CreateBuiltinAudioEncoderFactory(),
+            webrtc::CreateBuiltinAudioDecoderFactory());
 
   webrtc::DataChannelInit init;
   rtc::scoped_refptr<DataChannelInterface> caller_dc(
       caller_->CreateDataChannel("data", init));
 
   Negotiate();
   WaitForConnection();
 
   WaitForDataChannelsToOpen(caller_dc, callee_signaled_data_channels_, 0);
   // This removes the reference to the remote data channel that we hold.
   callee_signaled_data_channels_.clear();
   caller_dc->Close();
   EXPECT_EQ_WAIT(DataChannelInterface::kClosed, caller_dc->state(), kMaxWait);
 
   // Wait for a bit longer so the remote data channel will receive the
   // close message and be destroyed.
   rtc::Thread::Current()->ProcessMessages(100);
 }
 #endif  // HAVE_SCTP