blob: 00417d96a5f48d6e4cb698548e3dfc3adf548495 [file] [log] [blame]
Harald Alvestrand39993842021-02-17 09:05:31 +00001/*
2 * Copyright 2012 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#ifndef PC_TEST_INTEGRATION_TEST_HELPERS_H_
12#define PC_TEST_INTEGRATION_TEST_HELPERS_H_
13
14#include <limits.h>
15#include <stdint.h>
16#include <stdio.h>
17
18#include <algorithm>
19#include <functional>
Taylor Brandstetter1c7ecef2021-08-11 12:38:35 -070020#include <limits>
Harald Alvestrand39993842021-02-17 09:05:31 +000021#include <list>
22#include <map>
23#include <memory>
24#include <set>
25#include <string>
26#include <utility>
27#include <vector>
28
29#include "absl/algorithm/container.h"
30#include "absl/types/optional.h"
31#include "api/audio_options.h"
32#include "api/call/call_factory_interface.h"
33#include "api/candidate.h"
34#include "api/crypto/crypto_options.h"
35#include "api/data_channel_interface.h"
36#include "api/ice_transport_interface.h"
37#include "api/jsep.h"
38#include "api/media_stream_interface.h"
39#include "api/media_types.h"
40#include "api/peer_connection_interface.h"
Harald Alvestrand39993842021-02-17 09:05:31 +000041#include "api/rtc_error.h"
42#include "api/rtc_event_log/rtc_event_log_factory.h"
43#include "api/rtc_event_log/rtc_event_log_factory_interface.h"
44#include "api/rtc_event_log_output.h"
45#include "api/rtp_receiver_interface.h"
46#include "api/rtp_sender_interface.h"
47#include "api/rtp_transceiver_interface.h"
48#include "api/scoped_refptr.h"
49#include "api/stats/rtc_stats.h"
50#include "api/stats/rtc_stats_report.h"
51#include "api/stats/rtcstats_objects.h"
52#include "api/task_queue/default_task_queue_factory.h"
53#include "api/task_queue/task_queue_factory.h"
54#include "api/transport/field_trial_based_config.h"
55#include "api/transport/webrtc_key_value_config.h"
56#include "api/uma_metrics.h"
57#include "api/video/video_rotation.h"
58#include "api/video_codecs/sdp_video_format.h"
59#include "api/video_codecs/video_decoder_factory.h"
60#include "api/video_codecs/video_encoder_factory.h"
61#include "call/call.h"
62#include "logging/rtc_event_log/fake_rtc_event_log_factory.h"
63#include "media/base/media_engine.h"
64#include "media/base/stream_params.h"
65#include "media/engine/fake_webrtc_video_engine.h"
66#include "media/engine/webrtc_media_engine.h"
67#include "media/engine/webrtc_media_engine_defaults.h"
68#include "modules/audio_device/include/audio_device.h"
69#include "modules/audio_processing/include/audio_processing.h"
70#include "modules/audio_processing/test/audio_processing_builder_for_testing.h"
71#include "p2p/base/fake_ice_transport.h"
72#include "p2p/base/ice_transport_internal.h"
73#include "p2p/base/mock_async_resolver.h"
74#include "p2p/base/p2p_constants.h"
75#include "p2p/base/port.h"
76#include "p2p/base/port_allocator.h"
77#include "p2p/base/port_interface.h"
78#include "p2p/base/test_stun_server.h"
79#include "p2p/base/test_turn_customizer.h"
80#include "p2p/base/test_turn_server.h"
81#include "p2p/client/basic_port_allocator.h"
82#include "pc/dtmf_sender.h"
83#include "pc/local_audio_source.h"
84#include "pc/media_session.h"
85#include "pc/peer_connection.h"
86#include "pc/peer_connection_factory.h"
Markus Handella1b82012021-05-26 18:56:30 +020087#include "pc/peer_connection_proxy.h"
Harald Alvestrand39993842021-02-17 09:05:31 +000088#include "pc/rtp_media_utils.h"
89#include "pc/session_description.h"
90#include "pc/test/fake_audio_capture_module.h"
91#include "pc/test/fake_periodic_video_source.h"
92#include "pc/test/fake_periodic_video_track_source.h"
93#include "pc/test/fake_rtc_certificate_generator.h"
94#include "pc/test/fake_video_track_renderer.h"
95#include "pc/test/mock_peer_connection_observers.h"
96#include "pc/video_track_source.h"
Harald Alvestrand39993842021-02-17 09:05:31 +000097#include "rtc_base/checks.h"
Evan Shrubsole7619b7c2022-03-01 10:42:44 +010098#include "rtc_base/event.h"
Harald Alvestrand39993842021-02-17 09:05:31 +000099#include "rtc_base/fake_clock.h"
100#include "rtc_base/fake_mdns_responder.h"
101#include "rtc_base/fake_network.h"
102#include "rtc_base/firewall_socket_server.h"
103#include "rtc_base/gunit.h"
104#include "rtc_base/helpers.h"
105#include "rtc_base/ip_address.h"
106#include "rtc_base/location.h"
107#include "rtc_base/logging.h"
108#include "rtc_base/mdns_responder_interface.h"
109#include "rtc_base/numerics/safe_conversions.h"
110#include "rtc_base/ref_counted_object.h"
111#include "rtc_base/rtc_certificate_generator.h"
112#include "rtc_base/socket_address.h"
113#include "rtc_base/ssl_stream_adapter.h"
Niels Möller6097b0f2021-03-11 16:46:27 +0100114#include "rtc_base/task_utils/pending_task_safety_flag.h"
Evan Shrubsole7619b7c2022-03-01 10:42:44 +0100115#include "rtc_base/task_utils/repeating_task.h"
Niels Möller6097b0f2021-03-11 16:46:27 +0100116#include "rtc_base/task_utils/to_queued_task.h"
Harald Alvestrand39993842021-02-17 09:05:31 +0000117#include "rtc_base/test_certificate_verifier.h"
118#include "rtc_base/thread.h"
Evan Shrubsole7619b7c2022-03-01 10:42:44 +0100119#include "rtc_base/thread_annotations.h"
Harald Alvestrand39993842021-02-17 09:05:31 +0000120#include "rtc_base/time_utils.h"
121#include "rtc_base/virtual_socket_server.h"
122#include "system_wrappers/include/metrics.h"
Harald Alvestrand39993842021-02-17 09:05:31 +0000123#include "test/gmock.h"
Jonas Orelanded99dae2022-03-09 09:28:10 +0100124#include "test/scoped_key_value_config.h"
Harald Alvestrand39993842021-02-17 09:05:31 +0000125
126namespace webrtc {
127
128using ::cricket::ContentInfo;
129using ::cricket::StreamParams;
130using ::rtc::SocketAddress;
131using ::testing::_;
132using ::testing::Combine;
133using ::testing::Contains;
134using ::testing::DoAll;
135using ::testing::ElementsAre;
136using ::testing::NiceMock;
137using ::testing::Return;
138using ::testing::SetArgPointee;
139using ::testing::UnorderedElementsAreArray;
140using ::testing::Values;
141using RTCConfiguration = PeerConnectionInterface::RTCConfiguration;
142
143static const int kDefaultTimeout = 10000;
144static const int kMaxWaitForStatsMs = 3000;
145static const int kMaxWaitForActivationMs = 5000;
146static const int kMaxWaitForFramesMs = 10000;
147// Default number of audio/video frames to wait for before considering a test
148// successful.
149static const int kDefaultExpectedAudioFrameCount = 3;
150static const int kDefaultExpectedVideoFrameCount = 3;
151
152static const char kDataChannelLabel[] = "data_channel";
153
154// SRTP cipher name negotiated by the tests. This must be updated if the
155// default changes.
Mirko Bonadei7750d802021-07-26 17:27:42 +0200156static const int kDefaultSrtpCryptoSuite = rtc::kSrtpAes128CmSha1_80;
157static const int kDefaultSrtpCryptoSuiteGcm = rtc::kSrtpAeadAes256Gcm;
Harald Alvestrand39993842021-02-17 09:05:31 +0000158
159static const SocketAddress kDefaultLocalAddress("192.168.1.1", 0);
160
161// Helper function for constructing offer/answer options to initiate an ICE
162// restart.
163PeerConnectionInterface::RTCOfferAnswerOptions IceRestartOfferAnswerOptions();
164
165// Remove all stream information (SSRCs, track IDs, etc.) and "msid-semantic"
166// attribute from received SDP, simulating a legacy endpoint.
167void RemoveSsrcsAndMsids(cricket::SessionDescription* desc);
168
169// Removes all stream information besides the stream ids, simulating an
170// endpoint that only signals a=msid lines to convey stream_ids.
171void RemoveSsrcsAndKeepMsids(cricket::SessionDescription* desc);
172
173int FindFirstMediaStatsIndexByKind(
174 const std::string& kind,
175 const std::vector<const webrtc::RTCMediaStreamTrackStats*>&
176 media_stats_vec);
177
Evan Shrubsole7619b7c2022-03-01 10:42:44 +0100178class TaskQueueMetronome : public webrtc::Metronome {
179 public:
180 TaskQueueMetronome(TaskQueueFactory* factory, TimeDelta tick_period);
181 ~TaskQueueMetronome() override;
182
183 // webrtc::Metronome implementation.
184 void AddListener(TickListener* listener) override;
185 void RemoveListener(TickListener* listener) override;
186 TimeDelta TickPeriod() const override;
187
188 private:
189 Mutex mutex_;
190 const TimeDelta tick_period_;
191 std::set<TickListener*> listeners_ RTC_GUARDED_BY(mutex_);
192 RepeatingTaskHandle tick_task_;
193 rtc::TaskQueue queue_;
194};
195
Harald Alvestrand39993842021-02-17 09:05:31 +0000196class SignalingMessageReceiver {
197 public:
198 virtual void ReceiveSdpMessage(SdpType type, const std::string& msg) = 0;
199 virtual void ReceiveIceMessage(const std::string& sdp_mid,
200 int sdp_mline_index,
201 const std::string& msg) = 0;
202
203 protected:
204 SignalingMessageReceiver() {}
205 virtual ~SignalingMessageReceiver() {}
206};
207
208class MockRtpReceiverObserver : public webrtc::RtpReceiverObserverInterface {
209 public:
210 explicit MockRtpReceiverObserver(cricket::MediaType media_type)
211 : expected_media_type_(media_type) {}
212
213 void OnFirstPacketReceived(cricket::MediaType media_type) override {
214 ASSERT_EQ(expected_media_type_, media_type);
215 first_packet_received_ = true;
216 }
217
218 bool first_packet_received() const { return first_packet_received_; }
219
220 virtual ~MockRtpReceiverObserver() {}
221
222 private:
223 bool first_packet_received_ = false;
224 cricket::MediaType expected_media_type_;
225};
226
227// Helper class that wraps a peer connection, observes it, and can accept
228// signaling messages from another wrapper.
229//
230// Uses a fake network, fake A/V capture, and optionally fake
231// encoders/decoders, though they aren't used by default since they don't
232// advertise support of any codecs.
233// TODO(steveanton): See how this could become a subclass of
234// PeerConnectionWrapper defined in peerconnectionwrapper.h.
235class PeerConnectionIntegrationWrapper : public webrtc::PeerConnectionObserver,
236 public SignalingMessageReceiver {
237 public:
Harald Alvestrand39993842021-02-17 09:05:31 +0000238 webrtc::PeerConnectionFactoryInterface* pc_factory() const {
239 return peer_connection_factory_.get();
240 }
241
242 webrtc::PeerConnectionInterface* pc() const { return peer_connection_.get(); }
243
244 // If a signaling message receiver is set (via ConnectFakeSignaling), this
245 // will set the whole offer/answer exchange in motion. Just need to wait for
246 // the signaling state to reach "stable".
247 void CreateAndSetAndSignalOffer() {
248 auto offer = CreateOfferAndWait();
249 ASSERT_NE(nullptr, offer);
250 EXPECT_TRUE(SetLocalDescriptionAndSendSdpMessage(std::move(offer)));
251 }
252
253 // Sets the options to be used when CreateAndSetAndSignalOffer is called, or
254 // when a remote offer is received (via fake signaling) and an answer is
255 // generated. By default, uses default options.
256 void SetOfferAnswerOptions(
257 const PeerConnectionInterface::RTCOfferAnswerOptions& options) {
258 offer_answer_options_ = options;
259 }
260
261 // Set a callback to be invoked when SDP is received via the fake signaling
262 // channel, which provides an opportunity to munge (modify) the SDP. This is
263 // used to test SDP being applied that a PeerConnection would normally not
264 // generate, but a non-JSEP endpoint might.
265 void SetReceivedSdpMunger(
266 std::function<void(cricket::SessionDescription*)> munger) {
267 received_sdp_munger_ = std::move(munger);
268 }
269
270 // Similar to the above, but this is run on SDP immediately after it's
271 // generated.
272 void SetGeneratedSdpMunger(
273 std::function<void(cricket::SessionDescription*)> munger) {
274 generated_sdp_munger_ = std::move(munger);
275 }
276
277 // Set a callback to be invoked when a remote offer is received via the fake
278 // signaling channel. This provides an opportunity to change the
279 // PeerConnection state before an answer is created and sent to the caller.
280 void SetRemoteOfferHandler(std::function<void()> handler) {
281 remote_offer_handler_ = std::move(handler);
282 }
283
284 void SetRemoteAsyncResolver(rtc::MockAsyncResolver* resolver) {
285 remote_async_resolver_ = resolver;
286 }
287
288 // Every ICE connection state in order that has been seen by the observer.
289 std::vector<PeerConnectionInterface::IceConnectionState>
290 ice_connection_state_history() const {
291 return ice_connection_state_history_;
292 }
293 void clear_ice_connection_state_history() {
294 ice_connection_state_history_.clear();
295 }
296
297 // Every standardized ICE connection state in order that has been seen by the
298 // observer.
299 std::vector<PeerConnectionInterface::IceConnectionState>
300 standardized_ice_connection_state_history() const {
301 return standardized_ice_connection_state_history_;
302 }
303
304 // Every PeerConnection state in order that has been seen by the observer.
305 std::vector<PeerConnectionInterface::PeerConnectionState>
306 peer_connection_state_history() const {
307 return peer_connection_state_history_;
308 }
309
310 // Every ICE gathering state in order that has been seen by the observer.
311 std::vector<PeerConnectionInterface::IceGatheringState>
312 ice_gathering_state_history() const {
313 return ice_gathering_state_history_;
314 }
315 std::vector<cricket::CandidatePairChangeEvent>
316 ice_candidate_pair_change_history() const {
317 return ice_candidate_pair_change_history_;
318 }
319
320 // Every PeerConnection signaling state in order that has been seen by the
321 // observer.
322 std::vector<PeerConnectionInterface::SignalingState>
323 peer_connection_signaling_state_history() const {
324 return peer_connection_signaling_state_history_;
325 }
326
327 void AddAudioVideoTracks() {
328 AddAudioTrack();
329 AddVideoTrack();
330 }
331
332 rtc::scoped_refptr<RtpSenderInterface> AddAudioTrack() {
333 return AddTrack(CreateLocalAudioTrack());
334 }
335
336 rtc::scoped_refptr<RtpSenderInterface> AddVideoTrack() {
337 return AddTrack(CreateLocalVideoTrack());
338 }
339
340 rtc::scoped_refptr<webrtc::AudioTrackInterface> CreateLocalAudioTrack() {
341 cricket::AudioOptions options;
342 // Disable highpass filter so that we can get all the test audio frames.
343 options.highpass_filter = false;
344 rtc::scoped_refptr<webrtc::AudioSourceInterface> source =
345 peer_connection_factory_->CreateAudioSource(options);
346 // TODO(perkj): Test audio source when it is implemented. Currently audio
347 // always use the default input.
348 return peer_connection_factory_->CreateAudioTrack(rtc::CreateRandomUuid(),
349 source);
350 }
351
352 rtc::scoped_refptr<webrtc::VideoTrackInterface> CreateLocalVideoTrack() {
353 webrtc::FakePeriodicVideoSource::Config config;
354 config.timestamp_offset_ms = rtc::TimeMillis();
355 return CreateLocalVideoTrackInternal(config);
356 }
357
358 rtc::scoped_refptr<webrtc::VideoTrackInterface>
359 CreateLocalVideoTrackWithConfig(
360 webrtc::FakePeriodicVideoSource::Config config) {
361 return CreateLocalVideoTrackInternal(config);
362 }
363
364 rtc::scoped_refptr<webrtc::VideoTrackInterface>
365 CreateLocalVideoTrackWithRotation(webrtc::VideoRotation rotation) {
366 webrtc::FakePeriodicVideoSource::Config config;
367 config.rotation = rotation;
368 config.timestamp_offset_ms = rtc::TimeMillis();
369 return CreateLocalVideoTrackInternal(config);
370 }
371
372 rtc::scoped_refptr<RtpSenderInterface> AddTrack(
373 rtc::scoped_refptr<MediaStreamTrackInterface> track,
374 const std::vector<std::string>& stream_ids = {}) {
375 auto result = pc()->AddTrack(track, stream_ids);
376 EXPECT_EQ(RTCErrorType::NONE, result.error().type());
377 return result.MoveValue();
378 }
379
380 std::vector<rtc::scoped_refptr<RtpReceiverInterface>> GetReceiversOfType(
381 cricket::MediaType media_type) {
382 std::vector<rtc::scoped_refptr<RtpReceiverInterface>> receivers;
383 for (const auto& receiver : pc()->GetReceivers()) {
384 if (receiver->media_type() == media_type) {
385 receivers.push_back(receiver);
386 }
387 }
388 return receivers;
389 }
390
391 rtc::scoped_refptr<RtpTransceiverInterface> GetFirstTransceiverOfType(
392 cricket::MediaType media_type) {
393 for (auto transceiver : pc()->GetTransceivers()) {
394 if (transceiver->receiver()->media_type() == media_type) {
395 return transceiver;
396 }
397 }
398 return nullptr;
399 }
400
401 bool SignalingStateStable() {
402 return pc()->signaling_state() == webrtc::PeerConnectionInterface::kStable;
403 }
404
405 void CreateDataChannel() { CreateDataChannel(nullptr); }
406
407 void CreateDataChannel(const webrtc::DataChannelInit* init) {
408 CreateDataChannel(kDataChannelLabel, init);
409 }
410
411 void CreateDataChannel(const std::string& label,
412 const webrtc::DataChannelInit* init) {
Harald Alvestrand06c87a12022-02-11 13:12:16 +0000413 data_channels_.push_back(pc()->CreateDataChannel(label, init));
414 ASSERT_TRUE(data_channels_.back().get() != nullptr);
415 data_observers_.push_back(
416 std::make_unique<MockDataChannelObserver>(data_channels_.back()));
Harald Alvestrand39993842021-02-17 09:05:31 +0000417 }
418
Harald Alvestrand06c87a12022-02-11 13:12:16 +0000419 // Return the last observed data channel.
420 DataChannelInterface* data_channel() {
421 if (data_channels_.size() == 0) {
422 return nullptr;
423 }
424 return data_channels_.back();
425 }
426 // Return all data channels.
427 const std::vector<rtc::scoped_refptr<DataChannelInterface>>& data_channels() {
428 return data_channels_;
429 }
430
Harald Alvestrand39993842021-02-17 09:05:31 +0000431 const MockDataChannelObserver* data_observer() const {
Harald Alvestrand06c87a12022-02-11 13:12:16 +0000432 if (data_observers_.size() == 0) {
433 return nullptr;
434 }
435 return data_observers_.back().get();
Harald Alvestrand39993842021-02-17 09:05:31 +0000436 }
437
438 int audio_frames_received() const {
439 return fake_audio_capture_module_->frames_received();
440 }
441
442 // Takes minimum of video frames received for each track.
443 //
444 // Can be used like:
445 // EXPECT_GE(expected_frames, min_video_frames_received_per_track());
446 //
447 // To ensure that all video tracks received at least a certain number of
448 // frames.
449 int min_video_frames_received_per_track() const {
450 int min_frames = INT_MAX;
451 if (fake_video_renderers_.empty()) {
452 return 0;
453 }
454
455 for (const auto& pair : fake_video_renderers_) {
456 min_frames = std::min(min_frames, pair.second->num_rendered_frames());
457 }
458 return min_frames;
459 }
460
461 // Returns a MockStatsObserver in a state after stats gathering finished,
462 // which can be used to access the gathered stats.
463 rtc::scoped_refptr<MockStatsObserver> OldGetStatsForTrack(
464 webrtc::MediaStreamTrackInterface* track) {
Tommi87f70902021-04-27 14:43:08 +0200465 auto observer = rtc::make_ref_counted<MockStatsObserver>();
Harald Alvestrand39993842021-02-17 09:05:31 +0000466 EXPECT_TRUE(peer_connection_->GetStats(
467 observer, nullptr, PeerConnectionInterface::kStatsOutputLevelStandard));
468 EXPECT_TRUE_WAIT(observer->called(), kDefaultTimeout);
469 return observer;
470 }
471
472 // Version that doesn't take a track "filter", and gathers all stats.
473 rtc::scoped_refptr<MockStatsObserver> OldGetStats() {
474 return OldGetStatsForTrack(nullptr);
475 }
476
477 // Synchronously gets stats and returns them. If it times out, fails the test
478 // and returns null.
479 rtc::scoped_refptr<const webrtc::RTCStatsReport> NewGetStats() {
Tommi87f70902021-04-27 14:43:08 +0200480 auto callback =
481 rtc::make_ref_counted<webrtc::MockRTCStatsCollectorCallback>();
Harald Alvestrand39993842021-02-17 09:05:31 +0000482 peer_connection_->GetStats(callback);
483 EXPECT_TRUE_WAIT(callback->called(), kDefaultTimeout);
484 return callback->report();
485 }
486
487 int rendered_width() {
488 EXPECT_FALSE(fake_video_renderers_.empty());
489 return fake_video_renderers_.empty()
490 ? 0
491 : fake_video_renderers_.begin()->second->width();
492 }
493
494 int rendered_height() {
495 EXPECT_FALSE(fake_video_renderers_.empty());
496 return fake_video_renderers_.empty()
497 ? 0
498 : fake_video_renderers_.begin()->second->height();
499 }
500
501 double rendered_aspect_ratio() {
502 if (rendered_height() == 0) {
503 return 0.0;
504 }
505 return static_cast<double>(rendered_width()) / rendered_height();
506 }
507
508 webrtc::VideoRotation rendered_rotation() {
509 EXPECT_FALSE(fake_video_renderers_.empty());
510 return fake_video_renderers_.empty()
511 ? webrtc::kVideoRotation_0
512 : fake_video_renderers_.begin()->second->rotation();
513 }
514
515 int local_rendered_width() {
516 return local_video_renderer_ ? local_video_renderer_->width() : 0;
517 }
518
519 int local_rendered_height() {
520 return local_video_renderer_ ? local_video_renderer_->height() : 0;
521 }
522
523 double local_rendered_aspect_ratio() {
524 if (local_rendered_height() == 0) {
525 return 0.0;
526 }
527 return static_cast<double>(local_rendered_width()) /
528 local_rendered_height();
529 }
530
531 size_t number_of_remote_streams() {
532 if (!pc()) {
533 return 0;
534 }
535 return pc()->remote_streams()->count();
536 }
537
538 StreamCollectionInterface* remote_streams() const {
539 if (!pc()) {
540 ADD_FAILURE();
541 return nullptr;
542 }
543 return pc()->remote_streams();
544 }
545
546 StreamCollectionInterface* local_streams() {
547 if (!pc()) {
548 ADD_FAILURE();
549 return nullptr;
550 }
551 return pc()->local_streams();
552 }
553
554 webrtc::PeerConnectionInterface::SignalingState signaling_state() {
555 return pc()->signaling_state();
556 }
557
558 webrtc::PeerConnectionInterface::IceConnectionState ice_connection_state() {
559 return pc()->ice_connection_state();
560 }
561
562 webrtc::PeerConnectionInterface::IceConnectionState
563 standardized_ice_connection_state() {
564 return pc()->standardized_ice_connection_state();
565 }
566
567 webrtc::PeerConnectionInterface::IceGatheringState ice_gathering_state() {
568 return pc()->ice_gathering_state();
569 }
570
571 // Returns a MockRtpReceiverObserver for each RtpReceiver returned by
572 // GetReceivers. They're updated automatically when a remote offer/answer
573 // from the fake signaling channel is applied, or when
574 // ResetRtpReceiverObservers below is called.
575 const std::vector<std::unique_ptr<MockRtpReceiverObserver>>&
576 rtp_receiver_observers() {
577 return rtp_receiver_observers_;
578 }
579
580 void ResetRtpReceiverObservers() {
581 rtp_receiver_observers_.clear();
582 for (const rtc::scoped_refptr<RtpReceiverInterface>& receiver :
583 pc()->GetReceivers()) {
584 std::unique_ptr<MockRtpReceiverObserver> observer(
585 new MockRtpReceiverObserver(receiver->media_type()));
586 receiver->SetObserver(observer.get());
587 rtp_receiver_observers_.push_back(std::move(observer));
588 }
589 }
590
591 rtc::FakeNetworkManager* network_manager() const {
592 return fake_network_manager_.get();
593 }
594 cricket::PortAllocator* port_allocator() const { return port_allocator_; }
595
596 webrtc::FakeRtcEventLogFactory* event_log_factory() const {
597 return event_log_factory_;
598 }
599
600 const cricket::Candidate& last_candidate_gathered() const {
601 return last_candidate_gathered_;
602 }
603 const cricket::IceCandidateErrorEvent& error_event() const {
604 return error_event_;
605 }
606
607 // Sets the mDNS responder for the owned fake network manager and keeps a
608 // reference to the responder.
609 void SetMdnsResponder(
610 std::unique_ptr<webrtc::FakeMdnsResponder> mdns_responder) {
611 RTC_DCHECK(mdns_responder != nullptr);
612 mdns_responder_ = mdns_responder.get();
613 network_manager()->set_mdns_responder(std::move(mdns_responder));
614 }
615
616 // Returns null on failure.
617 std::unique_ptr<SessionDescriptionInterface> CreateOfferAndWait() {
Tommi87f70902021-04-27 14:43:08 +0200618 auto observer =
619 rtc::make_ref_counted<MockCreateSessionDescriptionObserver>();
Harald Alvestrand39993842021-02-17 09:05:31 +0000620 pc()->CreateOffer(observer, offer_answer_options_);
621 return WaitForDescriptionFromObserver(observer);
622 }
623 bool Rollback() {
624 return SetRemoteDescription(
625 webrtc::CreateSessionDescription(SdpType::kRollback, ""));
626 }
627
628 // Functions for querying stats.
629 void StartWatchingDelayStats() {
630 // Get the baseline numbers for audio_packets and audio_delay.
631 auto received_stats = NewGetStats();
632 auto track_stats =
633 received_stats->GetStatsOfType<webrtc::RTCMediaStreamTrackStats>()[0];
634 ASSERT_TRUE(track_stats->relative_packet_arrival_delay.is_defined());
635 auto rtp_stats =
636 received_stats->GetStatsOfType<webrtc::RTCInboundRTPStreamStats>()[0];
637 ASSERT_TRUE(rtp_stats->packets_received.is_defined());
638 ASSERT_TRUE(rtp_stats->track_id.is_defined());
639 audio_track_stats_id_ = track_stats->id();
640 ASSERT_TRUE(received_stats->Get(audio_track_stats_id_));
641 rtp_stats_id_ = rtp_stats->id();
642 ASSERT_EQ(audio_track_stats_id_, *rtp_stats->track_id);
643 audio_packets_stat_ = *rtp_stats->packets_received;
644 audio_delay_stat_ = *track_stats->relative_packet_arrival_delay;
645 audio_samples_stat_ = *track_stats->total_samples_received;
646 audio_concealed_stat_ = *track_stats->concealed_samples;
647 }
648
649 void UpdateDelayStats(std::string tag, int desc_size) {
650 auto report = NewGetStats();
651 auto track_stats =
652 report->GetAs<webrtc::RTCMediaStreamTrackStats>(audio_track_stats_id_);
653 ASSERT_TRUE(track_stats);
654 auto rtp_stats =
655 report->GetAs<webrtc::RTCInboundRTPStreamStats>(rtp_stats_id_);
656 ASSERT_TRUE(rtp_stats);
657 auto delta_packets = *rtp_stats->packets_received - audio_packets_stat_;
658 auto delta_rpad =
659 *track_stats->relative_packet_arrival_delay - audio_delay_stat_;
660 auto recent_delay = delta_packets > 0 ? delta_rpad / delta_packets : -1;
661 // The purpose of these checks is to sound the alarm early if we introduce
662 // serious regressions. The numbers are not acceptable for production, but
663 // occur on slow bots.
664 //
665 // An average relative packet arrival delay over the renegotiation of
666 // > 100 ms indicates that something is dramatically wrong, and will impact
667 // quality for sure.
668 // Worst bots:
669 // linux_x86_dbg at 0.206
670#if !defined(NDEBUG)
671 EXPECT_GT(0.25, recent_delay) << tag << " size " << desc_size;
672#else
673 EXPECT_GT(0.1, recent_delay) << tag << " size " << desc_size;
674#endif
675 auto delta_samples =
676 *track_stats->total_samples_received - audio_samples_stat_;
677 auto delta_concealed =
678 *track_stats->concealed_samples - audio_concealed_stat_;
679 // These limits should be adjusted down as we improve:
680 //
681 // Concealing more than 4000 samples during a renegotiation is unacceptable.
682 // But some bots are slow.
683
684 // Worst bots:
685 // linux_more_configs bot at conceal count 5184
686 // android_arm_rel at conceal count 9241
687 // linux_x86_dbg at 15174
688#if !defined(NDEBUG)
689 EXPECT_GT(18000U, delta_concealed) << "Concealed " << delta_concealed
690 << " of " << delta_samples << " samples";
691#else
692 EXPECT_GT(15000U, delta_concealed) << "Concealed " << delta_concealed
693 << " of " << delta_samples << " samples";
694#endif
695 // Concealing more than 20% of samples during a renegotiation is
696 // unacceptable.
697 // Worst bots:
Harald Alvestranda52fc6f2021-11-05 11:45:08 +0000698 // Nondebug: Linux32 Release at conceal rate 0.606597 (CI run)
699 // Debug: linux_x86_dbg bot at conceal rate 0.854
Harald Alvestrand39993842021-02-17 09:05:31 +0000700 if (delta_samples > 0) {
701#if !defined(NDEBUG)
Harald Alvestranda52fc6f2021-11-05 11:45:08 +0000702 EXPECT_LT(1.0 * delta_concealed / delta_samples, 0.95)
Harald Alvestrand39993842021-02-17 09:05:31 +0000703 << "Concealed " << delta_concealed << " of " << delta_samples
704 << " samples";
705#else
Harald Alvestranda52fc6f2021-11-05 11:45:08 +0000706 EXPECT_LT(1.0 * delta_concealed / delta_samples, 0.7)
Harald Alvestrand39993842021-02-17 09:05:31 +0000707 << "Concealed " << delta_concealed << " of " << delta_samples
708 << " samples";
709#endif
710 }
711 // Increment trailing counters
712 audio_packets_stat_ = *rtp_stats->packets_received;
713 audio_delay_stat_ = *track_stats->relative_packet_arrival_delay;
714 audio_samples_stat_ = *track_stats->total_samples_received;
715 audio_concealed_stat_ = *track_stats->concealed_samples;
716 }
717
Taylor Brandstetter1c7ecef2021-08-11 12:38:35 -0700718 // Sets number of candidates expected
719 void ExpectCandidates(int candidate_count) {
720 candidates_expected_ = candidate_count;
721 }
722
Harald Alvestrand39993842021-02-17 09:05:31 +0000723 private:
Niels Möller4f0a9192021-09-03 08:54:06 +0200724 // Constructor used by friend class PeerConnectionIntegrationBaseTest.
Harald Alvestrand39993842021-02-17 09:05:31 +0000725 explicit PeerConnectionIntegrationWrapper(const std::string& debug_name)
726 : debug_name_(debug_name) {}
727
728 bool Init(const PeerConnectionFactory::Options* options,
729 const PeerConnectionInterface::RTCConfiguration* config,
730 webrtc::PeerConnectionDependencies dependencies,
731 rtc::Thread* network_thread,
732 rtc::Thread* worker_thread,
733 std::unique_ptr<webrtc::FakeRtcEventLogFactory> event_log_factory,
734 bool reset_encoder_factory,
735 bool reset_decoder_factory) {
736 // There's an error in this test code if Init ends up being called twice.
737 RTC_DCHECK(!peer_connection_);
738 RTC_DCHECK(!peer_connection_factory_);
739
740 fake_network_manager_.reset(new rtc::FakeNetworkManager());
741 fake_network_manager_->AddInterface(kDefaultLocalAddress);
742
743 std::unique_ptr<cricket::PortAllocator> port_allocator(
744 new cricket::BasicPortAllocator(fake_network_manager_.get()));
745 port_allocator_ = port_allocator.get();
746 fake_audio_capture_module_ = FakeAudioCaptureModule::Create();
747 if (!fake_audio_capture_module_) {
748 return false;
749 }
750 rtc::Thread* const signaling_thread = rtc::Thread::Current();
751
752 webrtc::PeerConnectionFactoryDependencies pc_factory_dependencies;
753 pc_factory_dependencies.network_thread = network_thread;
754 pc_factory_dependencies.worker_thread = worker_thread;
755 pc_factory_dependencies.signaling_thread = signaling_thread;
756 pc_factory_dependencies.task_queue_factory =
757 webrtc::CreateDefaultTaskQueueFactory();
758 pc_factory_dependencies.trials = std::make_unique<FieldTrialBasedConfig>();
Evan Shrubsole7619b7c2022-03-01 10:42:44 +0100759 pc_factory_dependencies.metronome = std::make_unique<TaskQueueMetronome>(
760 pc_factory_dependencies.task_queue_factory.get(), TimeDelta::Millis(8));
Harald Alvestrand39993842021-02-17 09:05:31 +0000761 cricket::MediaEngineDependencies media_deps;
762 media_deps.task_queue_factory =
763 pc_factory_dependencies.task_queue_factory.get();
764 media_deps.adm = fake_audio_capture_module_;
765 webrtc::SetMediaEngineDefaults(&media_deps);
766
767 if (reset_encoder_factory) {
768 media_deps.video_encoder_factory.reset();
769 }
770 if (reset_decoder_factory) {
771 media_deps.video_decoder_factory.reset();
772 }
773
774 if (!media_deps.audio_processing) {
775 // If the standard Creation method for APM returns a null pointer, instead
776 // use the builder for testing to create an APM object.
777 media_deps.audio_processing = AudioProcessingBuilderForTesting().Create();
778 }
779
780 media_deps.trials = pc_factory_dependencies.trials.get();
781
782 pc_factory_dependencies.media_engine =
783 cricket::CreateMediaEngine(std::move(media_deps));
784 pc_factory_dependencies.call_factory = webrtc::CreateCallFactory();
785 if (event_log_factory) {
786 event_log_factory_ = event_log_factory.get();
787 pc_factory_dependencies.event_log_factory = std::move(event_log_factory);
788 } else {
789 pc_factory_dependencies.event_log_factory =
790 std::make_unique<webrtc::RtcEventLogFactory>(
791 pc_factory_dependencies.task_queue_factory.get());
792 }
793 peer_connection_factory_ = webrtc::CreateModularPeerConnectionFactory(
794 std::move(pc_factory_dependencies));
795
796 if (!peer_connection_factory_) {
797 return false;
798 }
799 if (options) {
800 peer_connection_factory_->SetOptions(*options);
801 }
802 if (config) {
803 sdp_semantics_ = config->sdp_semantics;
804 }
805
806 dependencies.allocator = std::move(port_allocator);
807 peer_connection_ = CreatePeerConnection(config, std::move(dependencies));
808 return peer_connection_.get() != nullptr;
809 }
810
811 rtc::scoped_refptr<webrtc::PeerConnectionInterface> CreatePeerConnection(
812 const PeerConnectionInterface::RTCConfiguration* config,
813 webrtc::PeerConnectionDependencies dependencies) {
814 PeerConnectionInterface::RTCConfiguration modified_config;
Henrik Boström62995db2022-01-03 09:58:10 +0100815 modified_config.sdp_semantics = sdp_semantics_;
Artem Titov880fa812021-07-30 22:30:23 +0200816 // If `config` is null, this will result in a default configuration being
Harald Alvestrand39993842021-02-17 09:05:31 +0000817 // used.
818 if (config) {
819 modified_config = *config;
820 }
821 // Disable resolution adaptation; we don't want it interfering with the
822 // test results.
823 // TODO(deadbeef): Do something more robust. Since we're testing for aspect
824 // ratios and not specific resolutions, is this even necessary?
825 modified_config.set_cpu_adaptation(false);
826
827 dependencies.observer = this;
828 return peer_connection_factory_->CreatePeerConnection(
829 modified_config, std::move(dependencies));
830 }
831
832 void set_signaling_message_receiver(
833 SignalingMessageReceiver* signaling_message_receiver) {
834 signaling_message_receiver_ = signaling_message_receiver;
835 }
836
837 void set_signaling_delay_ms(int delay_ms) { signaling_delay_ms_ = delay_ms; }
838
839 void set_signal_ice_candidates(bool signal) {
840 signal_ice_candidates_ = signal;
841 }
842
843 rtc::scoped_refptr<webrtc::VideoTrackInterface> CreateLocalVideoTrackInternal(
844 webrtc::FakePeriodicVideoSource::Config config) {
845 // Set max frame rate to 10fps to reduce the risk of test flakiness.
846 // TODO(deadbeef): Do something more robust.
847 config.frame_interval_ms = 100;
848
849 video_track_sources_.emplace_back(
Tommi87f70902021-04-27 14:43:08 +0200850 rtc::make_ref_counted<webrtc::FakePeriodicVideoTrackSource>(
Harald Alvestrand39993842021-02-17 09:05:31 +0000851 config, false /* remote */));
852 rtc::scoped_refptr<webrtc::VideoTrackInterface> track(
853 peer_connection_factory_->CreateVideoTrack(
854 rtc::CreateRandomUuid(), video_track_sources_.back()));
855 if (!local_video_renderer_) {
856 local_video_renderer_.reset(new webrtc::FakeVideoTrackRenderer(track));
857 }
858 return track;
859 }
860
861 void HandleIncomingOffer(const std::string& msg) {
862 RTC_LOG(LS_INFO) << debug_name_ << ": HandleIncomingOffer";
863 std::unique_ptr<SessionDescriptionInterface> desc =
864 webrtc::CreateSessionDescription(SdpType::kOffer, msg);
865 if (received_sdp_munger_) {
866 received_sdp_munger_(desc->description());
867 }
868
869 EXPECT_TRUE(SetRemoteDescription(std::move(desc)));
870 // Setting a remote description may have changed the number of receivers,
871 // so reset the receiver observers.
872 ResetRtpReceiverObservers();
873 if (remote_offer_handler_) {
874 remote_offer_handler_();
875 }
876 auto answer = CreateAnswer();
877 ASSERT_NE(nullptr, answer);
878 EXPECT_TRUE(SetLocalDescriptionAndSendSdpMessage(std::move(answer)));
879 }
880
881 void HandleIncomingAnswer(const std::string& msg) {
882 RTC_LOG(LS_INFO) << debug_name_ << ": HandleIncomingAnswer";
883 std::unique_ptr<SessionDescriptionInterface> desc =
884 webrtc::CreateSessionDescription(SdpType::kAnswer, msg);
885 if (received_sdp_munger_) {
886 received_sdp_munger_(desc->description());
887 }
888
889 EXPECT_TRUE(SetRemoteDescription(std::move(desc)));
890 // Set the RtpReceiverObserver after receivers are created.
891 ResetRtpReceiverObservers();
892 }
893
894 // Returns null on failure.
895 std::unique_ptr<SessionDescriptionInterface> CreateAnswer() {
Tommi87f70902021-04-27 14:43:08 +0200896 auto observer =
897 rtc::make_ref_counted<MockCreateSessionDescriptionObserver>();
Harald Alvestrand39993842021-02-17 09:05:31 +0000898 pc()->CreateAnswer(observer, offer_answer_options_);
899 return WaitForDescriptionFromObserver(observer);
900 }
901
902 std::unique_ptr<SessionDescriptionInterface> WaitForDescriptionFromObserver(
903 MockCreateSessionDescriptionObserver* observer) {
904 EXPECT_EQ_WAIT(true, observer->called(), kDefaultTimeout);
905 if (!observer->result()) {
906 return nullptr;
907 }
908 auto description = observer->MoveDescription();
909 if (generated_sdp_munger_) {
910 generated_sdp_munger_(description->description());
911 }
912 return description;
913 }
914
915 // Setting the local description and sending the SDP message over the fake
916 // signaling channel are combined into the same method because the SDP
917 // message needs to be sent as soon as SetLocalDescription finishes, without
918 // waiting for the observer to be called. This ensures that ICE candidates
919 // don't outrace the description.
920 bool SetLocalDescriptionAndSendSdpMessage(
921 std::unique_ptr<SessionDescriptionInterface> desc) {
Tommi87f70902021-04-27 14:43:08 +0200922 auto observer = rtc::make_ref_counted<MockSetSessionDescriptionObserver>();
Harald Alvestrand39993842021-02-17 09:05:31 +0000923 RTC_LOG(LS_INFO) << debug_name_ << ": SetLocalDescriptionAndSendSdpMessage";
924 SdpType type = desc->GetType();
925 std::string sdp;
926 EXPECT_TRUE(desc->ToString(&sdp));
927 RTC_LOG(LS_INFO) << debug_name_ << ": local SDP contents=\n" << sdp;
928 pc()->SetLocalDescription(observer, desc.release());
929 RemoveUnusedVideoRenderers();
930 // As mentioned above, we need to send the message immediately after
931 // SetLocalDescription.
932 SendSdpMessage(type, sdp);
933 EXPECT_TRUE_WAIT(observer->called(), kDefaultTimeout);
934 return true;
935 }
936
937 bool SetRemoteDescription(std::unique_ptr<SessionDescriptionInterface> desc) {
Tommi87f70902021-04-27 14:43:08 +0200938 auto observer = rtc::make_ref_counted<MockSetSessionDescriptionObserver>();
Harald Alvestrand39993842021-02-17 09:05:31 +0000939 RTC_LOG(LS_INFO) << debug_name_ << ": SetRemoteDescription";
940 pc()->SetRemoteDescription(observer, desc.release());
941 RemoveUnusedVideoRenderers();
942 EXPECT_TRUE_WAIT(observer->called(), kDefaultTimeout);
943 return observer->result();
944 }
945
946 // This is a work around to remove unused fake_video_renderers from
947 // transceivers that have either stopped or are no longer receiving.
948 void RemoveUnusedVideoRenderers() {
949 if (sdp_semantics_ != SdpSemantics::kUnifiedPlan) {
950 return;
951 }
952 auto transceivers = pc()->GetTransceivers();
953 std::set<std::string> active_renderers;
954 for (auto& transceiver : transceivers) {
955 // Note - we don't check for direction here. This function is called
956 // before direction is set, and in that case, we should not remove
957 // the renderer.
958 if (transceiver->receiver()->media_type() == cricket::MEDIA_TYPE_VIDEO) {
959 active_renderers.insert(transceiver->receiver()->track()->id());
960 }
961 }
962 for (auto it = fake_video_renderers_.begin();
963 it != fake_video_renderers_.end();) {
964 // Remove fake video renderers belonging to any non-active transceivers.
965 if (!active_renderers.count(it->first)) {
966 it = fake_video_renderers_.erase(it);
967 } else {
968 it++;
969 }
970 }
971 }
972
Artem Titov880fa812021-07-30 22:30:23 +0200973 // Simulate sending a blob of SDP with delay `signaling_delay_ms_` (0 by
Harald Alvestrand39993842021-02-17 09:05:31 +0000974 // default).
975 void SendSdpMessage(SdpType type, const std::string& msg) {
976 if (signaling_delay_ms_ == 0) {
977 RelaySdpMessageIfReceiverExists(type, msg);
978 } else {
Niels Möller6097b0f2021-03-11 16:46:27 +0100979 rtc::Thread::Current()->PostDelayedTask(
980 ToQueuedTask(task_safety_.flag(),
981 [this, type, msg] {
982 RelaySdpMessageIfReceiverExists(type, msg);
983 }),
Harald Alvestrand39993842021-02-17 09:05:31 +0000984 signaling_delay_ms_);
985 }
986 }
987
988 void RelaySdpMessageIfReceiverExists(SdpType type, const std::string& msg) {
989 if (signaling_message_receiver_) {
990 signaling_message_receiver_->ReceiveSdpMessage(type, msg);
991 }
992 }
993
Artem Titov880fa812021-07-30 22:30:23 +0200994 // Simulate trickling an ICE candidate with delay `signaling_delay_ms_` (0 by
Harald Alvestrand39993842021-02-17 09:05:31 +0000995 // default).
996 void SendIceMessage(const std::string& sdp_mid,
997 int sdp_mline_index,
998 const std::string& msg) {
999 if (signaling_delay_ms_ == 0) {
1000 RelayIceMessageIfReceiverExists(sdp_mid, sdp_mline_index, msg);
1001 } else {
Niels Möller6097b0f2021-03-11 16:46:27 +01001002 rtc::Thread::Current()->PostDelayedTask(
1003 ToQueuedTask(task_safety_.flag(),
1004 [this, sdp_mid, sdp_mline_index, msg] {
1005 RelayIceMessageIfReceiverExists(sdp_mid,
1006 sdp_mline_index, msg);
1007 }),
Harald Alvestrand39993842021-02-17 09:05:31 +00001008 signaling_delay_ms_);
1009 }
1010 }
1011
1012 void RelayIceMessageIfReceiverExists(const std::string& sdp_mid,
1013 int sdp_mline_index,
1014 const std::string& msg) {
1015 if (signaling_message_receiver_) {
1016 signaling_message_receiver_->ReceiveIceMessage(sdp_mid, sdp_mline_index,
1017 msg);
1018 }
1019 }
1020
1021 // SignalingMessageReceiver callbacks.
1022 void ReceiveSdpMessage(SdpType type, const std::string& msg) override {
1023 if (type == SdpType::kOffer) {
1024 HandleIncomingOffer(msg);
1025 } else {
1026 HandleIncomingAnswer(msg);
1027 }
1028 }
1029
1030 void ReceiveIceMessage(const std::string& sdp_mid,
1031 int sdp_mline_index,
1032 const std::string& msg) override {
1033 RTC_LOG(LS_INFO) << debug_name_ << ": ReceiveIceMessage";
1034 std::unique_ptr<webrtc::IceCandidateInterface> candidate(
1035 webrtc::CreateIceCandidate(sdp_mid, sdp_mline_index, msg, nullptr));
1036 EXPECT_TRUE(pc()->AddIceCandidate(candidate.get()));
1037 }
1038
1039 // PeerConnectionObserver callbacks.
1040 void OnSignalingChange(
1041 webrtc::PeerConnectionInterface::SignalingState new_state) override {
1042 EXPECT_EQ(pc()->signaling_state(), new_state);
1043 peer_connection_signaling_state_history_.push_back(new_state);
1044 }
1045 void OnAddTrack(rtc::scoped_refptr<RtpReceiverInterface> receiver,
1046 const std::vector<rtc::scoped_refptr<MediaStreamInterface>>&
1047 streams) override {
1048 if (receiver->media_type() == cricket::MEDIA_TYPE_VIDEO) {
1049 rtc::scoped_refptr<VideoTrackInterface> video_track(
1050 static_cast<VideoTrackInterface*>(receiver->track().get()));
1051 ASSERT_TRUE(fake_video_renderers_.find(video_track->id()) ==
1052 fake_video_renderers_.end());
1053 fake_video_renderers_[video_track->id()] =
1054 std::make_unique<FakeVideoTrackRenderer>(video_track);
1055 }
1056 }
1057 void OnRemoveTrack(
1058 rtc::scoped_refptr<RtpReceiverInterface> receiver) override {
1059 if (receiver->media_type() == cricket::MEDIA_TYPE_VIDEO) {
1060 auto it = fake_video_renderers_.find(receiver->track()->id());
1061 if (it != fake_video_renderers_.end()) {
1062 fake_video_renderers_.erase(it);
1063 } else {
1064 RTC_LOG(LS_ERROR) << "OnRemoveTrack called for non-active renderer";
1065 }
1066 }
1067 }
1068 void OnRenegotiationNeeded() override {}
1069 void OnIceConnectionChange(
1070 webrtc::PeerConnectionInterface::IceConnectionState new_state) override {
1071 EXPECT_EQ(pc()->ice_connection_state(), new_state);
1072 ice_connection_state_history_.push_back(new_state);
1073 }
1074 void OnStandardizedIceConnectionChange(
1075 webrtc::PeerConnectionInterface::IceConnectionState new_state) override {
1076 standardized_ice_connection_state_history_.push_back(new_state);
1077 }
1078 void OnConnectionChange(
1079 webrtc::PeerConnectionInterface::PeerConnectionState new_state) override {
1080 peer_connection_state_history_.push_back(new_state);
1081 }
1082
1083 void OnIceGatheringChange(
1084 webrtc::PeerConnectionInterface::IceGatheringState new_state) override {
1085 EXPECT_EQ(pc()->ice_gathering_state(), new_state);
1086 ice_gathering_state_history_.push_back(new_state);
1087 }
1088
1089 void OnIceSelectedCandidatePairChanged(
1090 const cricket::CandidatePairChangeEvent& event) {
1091 ice_candidate_pair_change_history_.push_back(event);
1092 }
1093
1094 void OnIceCandidate(const webrtc::IceCandidateInterface* candidate) override {
1095 RTC_LOG(LS_INFO) << debug_name_ << ": OnIceCandidate";
1096
1097 if (remote_async_resolver_) {
1098 const auto& local_candidate = candidate->candidate();
1099 if (local_candidate.address().IsUnresolvedIP()) {
1100 RTC_DCHECK(local_candidate.type() == cricket::LOCAL_PORT_TYPE);
1101 rtc::SocketAddress resolved_addr(local_candidate.address());
1102 const auto resolved_ip = mdns_responder_->GetMappedAddressForName(
1103 local_candidate.address().hostname());
1104 RTC_DCHECK(!resolved_ip.IsNil());
1105 resolved_addr.SetResolvedIP(resolved_ip);
1106 EXPECT_CALL(*remote_async_resolver_, GetResolvedAddress(_, _))
1107 .WillOnce(DoAll(SetArgPointee<1>(resolved_addr), Return(true)));
1108 EXPECT_CALL(*remote_async_resolver_, Destroy(_));
1109 }
1110 }
1111
Taylor Brandstetter1c7ecef2021-08-11 12:38:35 -07001112 // Check if we expected to have a candidate.
1113 EXPECT_GT(candidates_expected_, 1);
1114 candidates_expected_--;
Harald Alvestrand39993842021-02-17 09:05:31 +00001115 std::string ice_sdp;
1116 EXPECT_TRUE(candidate->ToString(&ice_sdp));
1117 if (signaling_message_receiver_ == nullptr || !signal_ice_candidates_) {
1118 // Remote party may be deleted.
1119 return;
1120 }
1121 SendIceMessage(candidate->sdp_mid(), candidate->sdp_mline_index(), ice_sdp);
1122 last_candidate_gathered_ = candidate->candidate();
1123 }
1124 void OnIceCandidateError(const std::string& address,
1125 int port,
1126 const std::string& url,
1127 int error_code,
1128 const std::string& error_text) override {
1129 error_event_ = cricket::IceCandidateErrorEvent(address, port, url,
1130 error_code, error_text);
1131 }
1132 void OnDataChannel(
1133 rtc::scoped_refptr<DataChannelInterface> data_channel) override {
1134 RTC_LOG(LS_INFO) << debug_name_ << ": OnDataChannel";
Harald Alvestrand06c87a12022-02-11 13:12:16 +00001135 data_channels_.push_back(data_channel);
1136 data_observers_.push_back(
1137 std::make_unique<MockDataChannelObserver>(data_channel));
Harald Alvestrand39993842021-02-17 09:05:31 +00001138 }
1139
1140 std::string debug_name_;
1141
1142 std::unique_ptr<rtc::FakeNetworkManager> fake_network_manager_;
Artem Titov880fa812021-07-30 22:30:23 +02001143 // Reference to the mDNS responder owned by `fake_network_manager_` after set.
Harald Alvestrand39993842021-02-17 09:05:31 +00001144 webrtc::FakeMdnsResponder* mdns_responder_ = nullptr;
1145
1146 rtc::scoped_refptr<webrtc::PeerConnectionInterface> peer_connection_;
1147 rtc::scoped_refptr<webrtc::PeerConnectionFactoryInterface>
1148 peer_connection_factory_;
1149
1150 cricket::PortAllocator* port_allocator_;
1151 // Needed to keep track of number of frames sent.
1152 rtc::scoped_refptr<FakeAudioCaptureModule> fake_audio_capture_module_;
1153 // Needed to keep track of number of frames received.
1154 std::map<std::string, std::unique_ptr<webrtc::FakeVideoTrackRenderer>>
1155 fake_video_renderers_;
1156 // Needed to ensure frames aren't received for removed tracks.
1157 std::vector<std::unique_ptr<webrtc::FakeVideoTrackRenderer>>
1158 removed_fake_video_renderers_;
1159
1160 // For remote peer communication.
1161 SignalingMessageReceiver* signaling_message_receiver_ = nullptr;
1162 int signaling_delay_ms_ = 0;
1163 bool signal_ice_candidates_ = true;
1164 cricket::Candidate last_candidate_gathered_;
1165 cricket::IceCandidateErrorEvent error_event_;
1166
1167 // Store references to the video sources we've created, so that we can stop
1168 // them, if required.
1169 std::vector<rtc::scoped_refptr<webrtc::VideoTrackSource>>
1170 video_track_sources_;
Artem Titov880fa812021-07-30 22:30:23 +02001171 // `local_video_renderer_` attached to the first created local video track.
Harald Alvestrand39993842021-02-17 09:05:31 +00001172 std::unique_ptr<webrtc::FakeVideoTrackRenderer> local_video_renderer_;
1173
1174 SdpSemantics sdp_semantics_;
1175 PeerConnectionInterface::RTCOfferAnswerOptions offer_answer_options_;
1176 std::function<void(cricket::SessionDescription*)> received_sdp_munger_;
1177 std::function<void(cricket::SessionDescription*)> generated_sdp_munger_;
1178 std::function<void()> remote_offer_handler_;
1179 rtc::MockAsyncResolver* remote_async_resolver_ = nullptr;
Harald Alvestrand06c87a12022-02-11 13:12:16 +00001180 // All data channels either created or observed on this peerconnection
1181 std::vector<rtc::scoped_refptr<DataChannelInterface>> data_channels_;
1182 std::vector<std::unique_ptr<MockDataChannelObserver>> data_observers_;
Harald Alvestrand39993842021-02-17 09:05:31 +00001183
1184 std::vector<std::unique_ptr<MockRtpReceiverObserver>> rtp_receiver_observers_;
1185
1186 std::vector<PeerConnectionInterface::IceConnectionState>
1187 ice_connection_state_history_;
1188 std::vector<PeerConnectionInterface::IceConnectionState>
1189 standardized_ice_connection_state_history_;
1190 std::vector<PeerConnectionInterface::PeerConnectionState>
1191 peer_connection_state_history_;
1192 std::vector<PeerConnectionInterface::IceGatheringState>
1193 ice_gathering_state_history_;
1194 std::vector<cricket::CandidatePairChangeEvent>
1195 ice_candidate_pair_change_history_;
1196 std::vector<PeerConnectionInterface::SignalingState>
1197 peer_connection_signaling_state_history_;
1198 webrtc::FakeRtcEventLogFactory* event_log_factory_;
1199
Taylor Brandstetter1c7ecef2021-08-11 12:38:35 -07001200 // Number of ICE candidates expected. The default is no limit.
1201 int candidates_expected_ = std::numeric_limits<int>::max();
1202
Harald Alvestrand39993842021-02-17 09:05:31 +00001203 // Variables for tracking delay stats on an audio track
1204 int audio_packets_stat_ = 0;
1205 double audio_delay_stat_ = 0.0;
1206 uint64_t audio_samples_stat_ = 0;
1207 uint64_t audio_concealed_stat_ = 0;
1208 std::string rtp_stats_id_;
1209 std::string audio_track_stats_id_;
1210
Niels Möller6097b0f2021-03-11 16:46:27 +01001211 ScopedTaskSafety task_safety_;
Harald Alvestrand39993842021-02-17 09:05:31 +00001212
1213 friend class PeerConnectionIntegrationBaseTest;
1214};
1215
1216class MockRtcEventLogOutput : public webrtc::RtcEventLogOutput {
1217 public:
1218 virtual ~MockRtcEventLogOutput() = default;
1219 MOCK_METHOD(bool, IsActive, (), (const, override));
1220 MOCK_METHOD(bool, Write, (const std::string&), (override));
1221};
1222
1223// This helper object is used for both specifying how many audio/video frames
1224// are expected to be received for a caller/callee. It provides helper functions
1225// to specify these expectations. The object initially starts in a state of no
1226// expectations.
1227class MediaExpectations {
1228 public:
1229 enum ExpectFrames {
1230 kExpectSomeFrames,
1231 kExpectNoFrames,
1232 kNoExpectation,
1233 };
1234
1235 void ExpectBidirectionalAudioAndVideo() {
1236 ExpectBidirectionalAudio();
1237 ExpectBidirectionalVideo();
1238 }
1239
1240 void ExpectBidirectionalAudio() {
1241 CallerExpectsSomeAudio();
1242 CalleeExpectsSomeAudio();
1243 }
1244
1245 void ExpectNoAudio() {
1246 CallerExpectsNoAudio();
1247 CalleeExpectsNoAudio();
1248 }
1249
1250 void ExpectBidirectionalVideo() {
1251 CallerExpectsSomeVideo();
1252 CalleeExpectsSomeVideo();
1253 }
1254
1255 void ExpectNoVideo() {
1256 CallerExpectsNoVideo();
1257 CalleeExpectsNoVideo();
1258 }
1259
1260 void CallerExpectsSomeAudioAndVideo() {
1261 CallerExpectsSomeAudio();
1262 CallerExpectsSomeVideo();
1263 }
1264
1265 void CalleeExpectsSomeAudioAndVideo() {
1266 CalleeExpectsSomeAudio();
1267 CalleeExpectsSomeVideo();
1268 }
1269
1270 // Caller's audio functions.
1271 void CallerExpectsSomeAudio(
1272 int expected_audio_frames = kDefaultExpectedAudioFrameCount) {
1273 caller_audio_expectation_ = kExpectSomeFrames;
1274 caller_audio_frames_expected_ = expected_audio_frames;
1275 }
1276
1277 void CallerExpectsNoAudio() {
1278 caller_audio_expectation_ = kExpectNoFrames;
1279 caller_audio_frames_expected_ = 0;
1280 }
1281
1282 // Caller's video functions.
1283 void CallerExpectsSomeVideo(
1284 int expected_video_frames = kDefaultExpectedVideoFrameCount) {
1285 caller_video_expectation_ = kExpectSomeFrames;
1286 caller_video_frames_expected_ = expected_video_frames;
1287 }
1288
1289 void CallerExpectsNoVideo() {
1290 caller_video_expectation_ = kExpectNoFrames;
1291 caller_video_frames_expected_ = 0;
1292 }
1293
1294 // Callee's audio functions.
1295 void CalleeExpectsSomeAudio(
1296 int expected_audio_frames = kDefaultExpectedAudioFrameCount) {
1297 callee_audio_expectation_ = kExpectSomeFrames;
1298 callee_audio_frames_expected_ = expected_audio_frames;
1299 }
1300
1301 void CalleeExpectsNoAudio() {
1302 callee_audio_expectation_ = kExpectNoFrames;
1303 callee_audio_frames_expected_ = 0;
1304 }
1305
1306 // Callee's video functions.
1307 void CalleeExpectsSomeVideo(
1308 int expected_video_frames = kDefaultExpectedVideoFrameCount) {
1309 callee_video_expectation_ = kExpectSomeFrames;
1310 callee_video_frames_expected_ = expected_video_frames;
1311 }
1312
1313 void CalleeExpectsNoVideo() {
1314 callee_video_expectation_ = kExpectNoFrames;
1315 callee_video_frames_expected_ = 0;
1316 }
1317
1318 ExpectFrames caller_audio_expectation_ = kNoExpectation;
1319 ExpectFrames caller_video_expectation_ = kNoExpectation;
1320 ExpectFrames callee_audio_expectation_ = kNoExpectation;
1321 ExpectFrames callee_video_expectation_ = kNoExpectation;
1322 int caller_audio_frames_expected_ = 0;
1323 int caller_video_frames_expected_ = 0;
1324 int callee_audio_frames_expected_ = 0;
1325 int callee_video_frames_expected_ = 0;
1326};
1327
1328class MockIceTransport : public webrtc::IceTransportInterface {
1329 public:
1330 MockIceTransport(const std::string& name, int component)
1331 : internal_(std::make_unique<cricket::FakeIceTransport>(
1332 name,
1333 component,
1334 nullptr /* network_thread */)) {}
1335 ~MockIceTransport() = default;
1336 cricket::IceTransportInternal* internal() { return internal_.get(); }
1337
1338 private:
1339 std::unique_ptr<cricket::FakeIceTransport> internal_;
1340};
1341
1342class MockIceTransportFactory : public IceTransportFactory {
1343 public:
1344 ~MockIceTransportFactory() override = default;
1345 rtc::scoped_refptr<IceTransportInterface> CreateIceTransport(
1346 const std::string& transport_name,
1347 int component,
1348 IceTransportInit init) {
1349 RecordIceTransportCreated();
Tommi87f70902021-04-27 14:43:08 +02001350 return rtc::make_ref_counted<MockIceTransport>(transport_name, component);
Harald Alvestrand39993842021-02-17 09:05:31 +00001351 }
1352 MOCK_METHOD(void, RecordIceTransportCreated, ());
1353};
1354
1355// Tests two PeerConnections connecting to each other end-to-end, using a
1356// virtual network, fake A/V capture and fake encoder/decoders. The
1357// PeerConnections share the threads/socket servers, but use separate versions
1358// of everything else (including "PeerConnectionFactory"s).
1359class PeerConnectionIntegrationBaseTest : public ::testing::Test {
1360 public:
Florent Castellia6983c62021-05-06 10:50:07 +02001361 PeerConnectionIntegrationBaseTest(
1362 SdpSemantics sdp_semantics,
1363 absl::optional<std::string> field_trials = absl::nullopt)
Harald Alvestrand39993842021-02-17 09:05:31 +00001364 : sdp_semantics_(sdp_semantics),
1365 ss_(new rtc::VirtualSocketServer()),
1366 fss_(new rtc::FirewallSocketServer(ss_.get())),
1367 network_thread_(new rtc::Thread(fss_.get())),
Florent Castellia6983c62021-05-06 10:50:07 +02001368 worker_thread_(rtc::Thread::Create()),
Jonas Orelanded99dae2022-03-09 09:28:10 +01001369 // TODO(bugs.webrtc.org/10335): Pass optional ScopedKeyValueConfig.
1370 field_trials_(new test::ScopedKeyValueConfig(
1371 field_trials.has_value() ? *field_trials : "")) {
Harald Alvestrand39993842021-02-17 09:05:31 +00001372 network_thread_->SetName("PCNetworkThread", this);
1373 worker_thread_->SetName("PCWorkerThread", this);
1374 RTC_CHECK(network_thread_->Start());
1375 RTC_CHECK(worker_thread_->Start());
1376 webrtc::metrics::Reset();
1377 }
1378
1379 ~PeerConnectionIntegrationBaseTest() {
1380 // The PeerConnections should be deleted before the TurnCustomizers.
1381 // A TurnPort is created with a raw pointer to a TurnCustomizer. The
1382 // TurnPort has the same lifetime as the PeerConnection, so it's expected
1383 // that the TurnCustomizer outlives the life of the PeerConnection or else
1384 // when Send() is called it will hit a seg fault.
1385 if (caller_) {
1386 caller_->set_signaling_message_receiver(nullptr);
Tomas Gunnarsson2efb8a52021-04-01 16:26:57 +02001387 caller_->pc()->Close();
Harald Alvestrand39993842021-02-17 09:05:31 +00001388 delete SetCallerPcWrapperAndReturnCurrent(nullptr);
1389 }
1390 if (callee_) {
1391 callee_->set_signaling_message_receiver(nullptr);
Tomas Gunnarsson2efb8a52021-04-01 16:26:57 +02001392 callee_->pc()->Close();
Harald Alvestrand39993842021-02-17 09:05:31 +00001393 delete SetCalleePcWrapperAndReturnCurrent(nullptr);
1394 }
1395
1396 // If turn servers were created for the test they need to be destroyed on
1397 // the network thread.
1398 network_thread()->Invoke<void>(RTC_FROM_HERE, [this] {
1399 turn_servers_.clear();
1400 turn_customizers_.clear();
1401 });
1402 }
1403
1404 bool SignalingStateStable() {
1405 return caller_->SignalingStateStable() && callee_->SignalingStateStable();
1406 }
1407
1408 bool DtlsConnected() {
1409 // TODO(deadbeef): kIceConnectionConnected currently means both ICE and DTLS
1410 // are connected. This is an important distinction. Once we have separate
1411 // ICE and DTLS state, this check needs to use the DTLS state.
1412 return (callee()->ice_connection_state() ==
1413 webrtc::PeerConnectionInterface::kIceConnectionConnected ||
1414 callee()->ice_connection_state() ==
1415 webrtc::PeerConnectionInterface::kIceConnectionCompleted) &&
1416 (caller()->ice_connection_state() ==
1417 webrtc::PeerConnectionInterface::kIceConnectionConnected ||
1418 caller()->ice_connection_state() ==
1419 webrtc::PeerConnectionInterface::kIceConnectionCompleted);
1420 }
1421
Artem Titov880fa812021-07-30 22:30:23 +02001422 // When `event_log_factory` is null, the default implementation of the event
Harald Alvestrand39993842021-02-17 09:05:31 +00001423 // log factory will be used.
1424 std::unique_ptr<PeerConnectionIntegrationWrapper> CreatePeerConnectionWrapper(
1425 const std::string& debug_name,
1426 const PeerConnectionFactory::Options* options,
1427 const RTCConfiguration* config,
1428 webrtc::PeerConnectionDependencies dependencies,
1429 std::unique_ptr<webrtc::FakeRtcEventLogFactory> event_log_factory,
1430 bool reset_encoder_factory,
1431 bool reset_decoder_factory) {
1432 RTCConfiguration modified_config;
1433 if (config) {
1434 modified_config = *config;
1435 }
1436 modified_config.sdp_semantics = sdp_semantics_;
1437 if (!dependencies.cert_generator) {
1438 dependencies.cert_generator =
1439 std::make_unique<FakeRTCCertificateGenerator>();
1440 }
1441 std::unique_ptr<PeerConnectionIntegrationWrapper> client(
1442 new PeerConnectionIntegrationWrapper(debug_name));
1443
1444 if (!client->Init(options, &modified_config, std::move(dependencies),
1445 network_thread_.get(), worker_thread_.get(),
1446 std::move(event_log_factory), reset_encoder_factory,
1447 reset_decoder_factory)) {
1448 return nullptr;
1449 }
1450 return client;
1451 }
1452
1453 std::unique_ptr<PeerConnectionIntegrationWrapper>
1454 CreatePeerConnectionWrapperWithFakeRtcEventLog(
1455 const std::string& debug_name,
1456 const PeerConnectionFactory::Options* options,
1457 const RTCConfiguration* config,
1458 webrtc::PeerConnectionDependencies dependencies) {
1459 return CreatePeerConnectionWrapper(
1460 debug_name, options, config, std::move(dependencies),
1461 std::make_unique<webrtc::FakeRtcEventLogFactory>(),
1462 /*reset_encoder_factory=*/false,
1463 /*reset_decoder_factory=*/false);
1464 }
1465
1466 bool CreatePeerConnectionWrappers() {
1467 return CreatePeerConnectionWrappersWithConfig(
1468 PeerConnectionInterface::RTCConfiguration(),
1469 PeerConnectionInterface::RTCConfiguration());
1470 }
1471
1472 bool CreatePeerConnectionWrappersWithSdpSemantics(
1473 SdpSemantics caller_semantics,
1474 SdpSemantics callee_semantics) {
1475 // Can't specify the sdp_semantics in the passed-in configuration since it
1476 // will be overwritten by CreatePeerConnectionWrapper with whatever is
1477 // stored in sdp_semantics_. So get around this by modifying the instance
1478 // variable before calling CreatePeerConnectionWrapper for the caller and
1479 // callee PeerConnections.
1480 SdpSemantics original_semantics = sdp_semantics_;
1481 sdp_semantics_ = caller_semantics;
1482 caller_ = CreatePeerConnectionWrapper(
1483 "Caller", nullptr, nullptr, webrtc::PeerConnectionDependencies(nullptr),
1484 nullptr,
1485 /*reset_encoder_factory=*/false,
1486 /*reset_decoder_factory=*/false);
1487 sdp_semantics_ = callee_semantics;
1488 callee_ = CreatePeerConnectionWrapper(
1489 "Callee", nullptr, nullptr, webrtc::PeerConnectionDependencies(nullptr),
1490 nullptr,
1491 /*reset_encoder_factory=*/false,
1492 /*reset_decoder_factory=*/false);
1493 sdp_semantics_ = original_semantics;
1494 return caller_ && callee_;
1495 }
1496
1497 bool CreatePeerConnectionWrappersWithConfig(
1498 const PeerConnectionInterface::RTCConfiguration& caller_config,
1499 const PeerConnectionInterface::RTCConfiguration& callee_config) {
1500 caller_ = CreatePeerConnectionWrapper(
1501 "Caller", nullptr, &caller_config,
1502 webrtc::PeerConnectionDependencies(nullptr), nullptr,
1503 /*reset_encoder_factory=*/false,
1504 /*reset_decoder_factory=*/false);
1505 callee_ = CreatePeerConnectionWrapper(
1506 "Callee", nullptr, &callee_config,
1507 webrtc::PeerConnectionDependencies(nullptr), nullptr,
1508 /*reset_encoder_factory=*/false,
1509 /*reset_decoder_factory=*/false);
1510 return caller_ && callee_;
1511 }
1512
1513 bool CreatePeerConnectionWrappersWithConfigAndDeps(
1514 const PeerConnectionInterface::RTCConfiguration& caller_config,
1515 webrtc::PeerConnectionDependencies caller_dependencies,
1516 const PeerConnectionInterface::RTCConfiguration& callee_config,
1517 webrtc::PeerConnectionDependencies callee_dependencies) {
1518 caller_ =
1519 CreatePeerConnectionWrapper("Caller", nullptr, &caller_config,
1520 std::move(caller_dependencies), nullptr,
1521 /*reset_encoder_factory=*/false,
1522 /*reset_decoder_factory=*/false);
1523 callee_ =
1524 CreatePeerConnectionWrapper("Callee", nullptr, &callee_config,
1525 std::move(callee_dependencies), nullptr,
1526 /*reset_encoder_factory=*/false,
1527 /*reset_decoder_factory=*/false);
1528 return caller_ && callee_;
1529 }
1530
1531 bool CreatePeerConnectionWrappersWithOptions(
1532 const PeerConnectionFactory::Options& caller_options,
1533 const PeerConnectionFactory::Options& callee_options) {
1534 caller_ = CreatePeerConnectionWrapper(
1535 "Caller", &caller_options, nullptr,
1536 webrtc::PeerConnectionDependencies(nullptr), nullptr,
1537 /*reset_encoder_factory=*/false,
1538 /*reset_decoder_factory=*/false);
1539 callee_ = CreatePeerConnectionWrapper(
1540 "Callee", &callee_options, nullptr,
1541 webrtc::PeerConnectionDependencies(nullptr), nullptr,
1542 /*reset_encoder_factory=*/false,
1543 /*reset_decoder_factory=*/false);
1544 return caller_ && callee_;
1545 }
1546
1547 bool CreatePeerConnectionWrappersWithFakeRtcEventLog() {
1548 PeerConnectionInterface::RTCConfiguration default_config;
1549 caller_ = CreatePeerConnectionWrapperWithFakeRtcEventLog(
1550 "Caller", nullptr, &default_config,
1551 webrtc::PeerConnectionDependencies(nullptr));
1552 callee_ = CreatePeerConnectionWrapperWithFakeRtcEventLog(
1553 "Callee", nullptr, &default_config,
1554 webrtc::PeerConnectionDependencies(nullptr));
1555 return caller_ && callee_;
1556 }
1557
1558 std::unique_ptr<PeerConnectionIntegrationWrapper>
1559 CreatePeerConnectionWrapperWithAlternateKey() {
1560 std::unique_ptr<FakeRTCCertificateGenerator> cert_generator(
1561 new FakeRTCCertificateGenerator());
1562 cert_generator->use_alternate_key();
1563
1564 webrtc::PeerConnectionDependencies dependencies(nullptr);
1565 dependencies.cert_generator = std::move(cert_generator);
1566 return CreatePeerConnectionWrapper("New Peer", nullptr, nullptr,
1567 std::move(dependencies), nullptr,
1568 /*reset_encoder_factory=*/false,
1569 /*reset_decoder_factory=*/false);
1570 }
1571
1572 bool CreateOneDirectionalPeerConnectionWrappers(bool caller_to_callee) {
1573 caller_ = CreatePeerConnectionWrapper(
1574 "Caller", nullptr, nullptr, webrtc::PeerConnectionDependencies(nullptr),
1575 nullptr,
1576 /*reset_encoder_factory=*/!caller_to_callee,
1577 /*reset_decoder_factory=*/caller_to_callee);
1578 callee_ = CreatePeerConnectionWrapper(
1579 "Callee", nullptr, nullptr, webrtc::PeerConnectionDependencies(nullptr),
1580 nullptr,
1581 /*reset_encoder_factory=*/caller_to_callee,
1582 /*reset_decoder_factory=*/!caller_to_callee);
1583 return caller_ && callee_;
1584 }
1585
1586 cricket::TestTurnServer* CreateTurnServer(
1587 rtc::SocketAddress internal_address,
1588 rtc::SocketAddress external_address,
1589 cricket::ProtocolType type = cricket::ProtocolType::PROTO_UDP,
1590 const std::string& common_name = "test turn server") {
1591 rtc::Thread* thread = network_thread();
Niels Möller6dd49972021-11-24 14:05:55 +01001592 rtc::SocketFactory* socket_factory = fss_.get();
Harald Alvestrand39993842021-02-17 09:05:31 +00001593 std::unique_ptr<cricket::TestTurnServer> turn_server =
1594 network_thread()->Invoke<std::unique_ptr<cricket::TestTurnServer>>(
Niels Möller6dd49972021-11-24 14:05:55 +01001595 RTC_FROM_HERE, [thread, socket_factory, internal_address,
1596 external_address, type, common_name] {
Harald Alvestrand39993842021-02-17 09:05:31 +00001597 return std::make_unique<cricket::TestTurnServer>(
Niels Möller6dd49972021-11-24 14:05:55 +01001598 thread, socket_factory, internal_address, external_address,
1599 type,
Harald Alvestrand39993842021-02-17 09:05:31 +00001600 /*ignore_bad_certs=*/true, common_name);
1601 });
1602 turn_servers_.push_back(std::move(turn_server));
1603 // Interactions with the turn server should be done on the network thread.
1604 return turn_servers_.back().get();
1605 }
1606
1607 cricket::TestTurnCustomizer* CreateTurnCustomizer() {
1608 std::unique_ptr<cricket::TestTurnCustomizer> turn_customizer =
1609 network_thread()->Invoke<std::unique_ptr<cricket::TestTurnCustomizer>>(
1610 RTC_FROM_HERE,
1611 [] { return std::make_unique<cricket::TestTurnCustomizer>(); });
1612 turn_customizers_.push_back(std::move(turn_customizer));
1613 // Interactions with the turn customizer should be done on the network
1614 // thread.
1615 return turn_customizers_.back().get();
1616 }
1617
1618 // Checks that the function counters for a TestTurnCustomizer are greater than
1619 // 0.
1620 void ExpectTurnCustomizerCountersIncremented(
1621 cricket::TestTurnCustomizer* turn_customizer) {
1622 unsigned int allow_channel_data_counter =
1623 network_thread()->Invoke<unsigned int>(
1624 RTC_FROM_HERE, [turn_customizer] {
1625 return turn_customizer->allow_channel_data_cnt_;
1626 });
1627 EXPECT_GT(allow_channel_data_counter, 0u);
1628 unsigned int modify_counter = network_thread()->Invoke<unsigned int>(
1629 RTC_FROM_HERE,
1630 [turn_customizer] { return turn_customizer->modify_cnt_; });
1631 EXPECT_GT(modify_counter, 0u);
1632 }
1633
1634 // Once called, SDP blobs and ICE candidates will be automatically signaled
1635 // between PeerConnections.
1636 void ConnectFakeSignaling() {
1637 caller_->set_signaling_message_receiver(callee_.get());
1638 callee_->set_signaling_message_receiver(caller_.get());
1639 }
1640
1641 // Once called, SDP blobs will be automatically signaled between
1642 // PeerConnections. Note that ICE candidates will not be signaled unless they
1643 // are in the exchanged SDP blobs.
1644 void ConnectFakeSignalingForSdpOnly() {
1645 ConnectFakeSignaling();
1646 SetSignalIceCandidates(false);
1647 }
1648
1649 void SetSignalingDelayMs(int delay_ms) {
1650 caller_->set_signaling_delay_ms(delay_ms);
1651 callee_->set_signaling_delay_ms(delay_ms);
1652 }
1653
1654 void SetSignalIceCandidates(bool signal) {
1655 caller_->set_signal_ice_candidates(signal);
1656 callee_->set_signal_ice_candidates(signal);
1657 }
1658
1659 // Messages may get lost on the unreliable DataChannel, so we send multiple
1660 // times to avoid test flakiness.
1661 void SendRtpDataWithRetries(webrtc::DataChannelInterface* dc,
1662 const std::string& data,
1663 int retries) {
1664 for (int i = 0; i < retries; ++i) {
1665 dc->Send(DataBuffer(data));
1666 }
1667 }
1668
1669 rtc::Thread* network_thread() { return network_thread_.get(); }
1670
1671 rtc::VirtualSocketServer* virtual_socket_server() { return ss_.get(); }
1672
1673 PeerConnectionIntegrationWrapper* caller() { return caller_.get(); }
1674
Artem Titov880fa812021-07-30 22:30:23 +02001675 // Set the `caller_` to the `wrapper` passed in and return the
1676 // original `caller_`.
Harald Alvestrand39993842021-02-17 09:05:31 +00001677 PeerConnectionIntegrationWrapper* SetCallerPcWrapperAndReturnCurrent(
1678 PeerConnectionIntegrationWrapper* wrapper) {
1679 PeerConnectionIntegrationWrapper* old = caller_.release();
1680 caller_.reset(wrapper);
1681 return old;
1682 }
1683
1684 PeerConnectionIntegrationWrapper* callee() { return callee_.get(); }
1685
Artem Titov880fa812021-07-30 22:30:23 +02001686 // Set the `callee_` to the `wrapper` passed in and return the
1687 // original `callee_`.
Harald Alvestrand39993842021-02-17 09:05:31 +00001688 PeerConnectionIntegrationWrapper* SetCalleePcWrapperAndReturnCurrent(
1689 PeerConnectionIntegrationWrapper* wrapper) {
1690 PeerConnectionIntegrationWrapper* old = callee_.release();
1691 callee_.reset(wrapper);
1692 return old;
1693 }
1694
1695 void SetPortAllocatorFlags(uint32_t caller_flags, uint32_t callee_flags) {
1696 network_thread()->Invoke<void>(RTC_FROM_HERE, [this, caller_flags] {
1697 caller()->port_allocator()->set_flags(caller_flags);
1698 });
1699 network_thread()->Invoke<void>(RTC_FROM_HERE, [this, callee_flags] {
1700 callee()->port_allocator()->set_flags(callee_flags);
1701 });
1702 }
1703
1704 rtc::FirewallSocketServer* firewall() const { return fss_.get(); }
1705
1706 // Expects the provided number of new frames to be received within
1707 // kMaxWaitForFramesMs. The new expected frames are specified in
Artem Titov880fa812021-07-30 22:30:23 +02001708 // `media_expectations`. Returns false if any of the expectations were
Harald Alvestrand39993842021-02-17 09:05:31 +00001709 // not met.
1710 bool ExpectNewFrames(const MediaExpectations& media_expectations) {
1711 // Make sure there are no bogus tracks confusing the issue.
1712 caller()->RemoveUnusedVideoRenderers();
1713 callee()->RemoveUnusedVideoRenderers();
1714 // First initialize the expected frame counts based upon the current
1715 // frame count.
1716 int total_caller_audio_frames_expected = caller()->audio_frames_received();
1717 if (media_expectations.caller_audio_expectation_ ==
1718 MediaExpectations::kExpectSomeFrames) {
1719 total_caller_audio_frames_expected +=
1720 media_expectations.caller_audio_frames_expected_;
1721 }
1722 int total_caller_video_frames_expected =
1723 caller()->min_video_frames_received_per_track();
1724 if (media_expectations.caller_video_expectation_ ==
1725 MediaExpectations::kExpectSomeFrames) {
1726 total_caller_video_frames_expected +=
1727 media_expectations.caller_video_frames_expected_;
1728 }
1729 int total_callee_audio_frames_expected = callee()->audio_frames_received();
1730 if (media_expectations.callee_audio_expectation_ ==
1731 MediaExpectations::kExpectSomeFrames) {
1732 total_callee_audio_frames_expected +=
1733 media_expectations.callee_audio_frames_expected_;
1734 }
1735 int total_callee_video_frames_expected =
1736 callee()->min_video_frames_received_per_track();
1737 if (media_expectations.callee_video_expectation_ ==
1738 MediaExpectations::kExpectSomeFrames) {
1739 total_callee_video_frames_expected +=
1740 media_expectations.callee_video_frames_expected_;
1741 }
1742
1743 // Wait for the expected frames.
1744 EXPECT_TRUE_WAIT(caller()->audio_frames_received() >=
1745 total_caller_audio_frames_expected &&
1746 caller()->min_video_frames_received_per_track() >=
1747 total_caller_video_frames_expected &&
1748 callee()->audio_frames_received() >=
1749 total_callee_audio_frames_expected &&
1750 callee()->min_video_frames_received_per_track() >=
1751 total_callee_video_frames_expected,
1752 kMaxWaitForFramesMs);
1753 bool expectations_correct =
1754 caller()->audio_frames_received() >=
1755 total_caller_audio_frames_expected &&
1756 caller()->min_video_frames_received_per_track() >=
1757 total_caller_video_frames_expected &&
1758 callee()->audio_frames_received() >=
1759 total_callee_audio_frames_expected &&
1760 callee()->min_video_frames_received_per_track() >=
1761 total_callee_video_frames_expected;
1762
1763 // After the combined wait, print out a more detailed message upon
1764 // failure.
1765 EXPECT_GE(caller()->audio_frames_received(),
1766 total_caller_audio_frames_expected);
1767 EXPECT_GE(caller()->min_video_frames_received_per_track(),
1768 total_caller_video_frames_expected);
1769 EXPECT_GE(callee()->audio_frames_received(),
1770 total_callee_audio_frames_expected);
1771 EXPECT_GE(callee()->min_video_frames_received_per_track(),
1772 total_callee_video_frames_expected);
1773
1774 // We want to make sure nothing unexpected was received.
1775 if (media_expectations.caller_audio_expectation_ ==
1776 MediaExpectations::kExpectNoFrames) {
1777 EXPECT_EQ(caller()->audio_frames_received(),
1778 total_caller_audio_frames_expected);
1779 if (caller()->audio_frames_received() !=
1780 total_caller_audio_frames_expected) {
1781 expectations_correct = false;
1782 }
1783 }
1784 if (media_expectations.caller_video_expectation_ ==
1785 MediaExpectations::kExpectNoFrames) {
1786 EXPECT_EQ(caller()->min_video_frames_received_per_track(),
1787 total_caller_video_frames_expected);
1788 if (caller()->min_video_frames_received_per_track() !=
1789 total_caller_video_frames_expected) {
1790 expectations_correct = false;
1791 }
1792 }
1793 if (media_expectations.callee_audio_expectation_ ==
1794 MediaExpectations::kExpectNoFrames) {
1795 EXPECT_EQ(callee()->audio_frames_received(),
1796 total_callee_audio_frames_expected);
1797 if (callee()->audio_frames_received() !=
1798 total_callee_audio_frames_expected) {
1799 expectations_correct = false;
1800 }
1801 }
1802 if (media_expectations.callee_video_expectation_ ==
1803 MediaExpectations::kExpectNoFrames) {
1804 EXPECT_EQ(callee()->min_video_frames_received_per_track(),
1805 total_callee_video_frames_expected);
1806 if (callee()->min_video_frames_received_per_track() !=
1807 total_callee_video_frames_expected) {
1808 expectations_correct = false;
1809 }
1810 }
1811 return expectations_correct;
1812 }
1813
1814 void ClosePeerConnections() {
Tomas Gunnarsson2efb8a52021-04-01 16:26:57 +02001815 if (caller())
1816 caller()->pc()->Close();
1817 if (callee())
1818 callee()->pc()->Close();
Harald Alvestrand39993842021-02-17 09:05:31 +00001819 }
1820
1821 void TestNegotiatedCipherSuite(
1822 const PeerConnectionFactory::Options& caller_options,
1823 const PeerConnectionFactory::Options& callee_options,
1824 int expected_cipher_suite) {
1825 ASSERT_TRUE(CreatePeerConnectionWrappersWithOptions(caller_options,
1826 callee_options));
1827 ConnectFakeSignaling();
1828 caller()->AddAudioVideoTracks();
1829 callee()->AddAudioVideoTracks();
1830 caller()->CreateAndSetAndSignalOffer();
1831 ASSERT_TRUE_WAIT(DtlsConnected(), kDefaultTimeout);
1832 EXPECT_EQ_WAIT(rtc::SrtpCryptoSuiteToName(expected_cipher_suite),
1833 caller()->OldGetStats()->SrtpCipher(), kDefaultTimeout);
1834 // TODO(bugs.webrtc.org/9456): Fix it.
1835 EXPECT_METRIC_EQ(1, webrtc::metrics::NumEvents(
1836 "WebRTC.PeerConnection.SrtpCryptoSuite.Audio",
1837 expected_cipher_suite));
1838 }
1839
1840 void TestGcmNegotiationUsesCipherSuite(bool local_gcm_enabled,
1841 bool remote_gcm_enabled,
1842 bool aes_ctr_enabled,
1843 int expected_cipher_suite) {
1844 PeerConnectionFactory::Options caller_options;
1845 caller_options.crypto_options.srtp.enable_gcm_crypto_suites =
1846 local_gcm_enabled;
1847 caller_options.crypto_options.srtp.enable_aes128_sha1_80_crypto_cipher =
1848 aes_ctr_enabled;
1849 PeerConnectionFactory::Options callee_options;
1850 callee_options.crypto_options.srtp.enable_gcm_crypto_suites =
1851 remote_gcm_enabled;
1852 callee_options.crypto_options.srtp.enable_aes128_sha1_80_crypto_cipher =
1853 aes_ctr_enabled;
1854 TestNegotiatedCipherSuite(caller_options, callee_options,
1855 expected_cipher_suite);
1856 }
1857
Jonas Orelanded99dae2022-03-09 09:28:10 +01001858 const WebRtcKeyValueConfig& trials() const { return *field_trials_.get(); }
1859
Harald Alvestrand39993842021-02-17 09:05:31 +00001860 protected:
1861 SdpSemantics sdp_semantics_;
1862
1863 private:
Artem Titov880fa812021-07-30 22:30:23 +02001864 // `ss_` is used by `network_thread_` so it must be destroyed later.
Harald Alvestrand39993842021-02-17 09:05:31 +00001865 std::unique_ptr<rtc::VirtualSocketServer> ss_;
1866 std::unique_ptr<rtc::FirewallSocketServer> fss_;
Artem Titov880fa812021-07-30 22:30:23 +02001867 // `network_thread_` and `worker_thread_` are used by both
1868 // `caller_` and `callee_` so they must be destroyed
Harald Alvestrand39993842021-02-17 09:05:31 +00001869 // later.
1870 std::unique_ptr<rtc::Thread> network_thread_;
1871 std::unique_ptr<rtc::Thread> worker_thread_;
1872 // The turn servers and turn customizers should be accessed & deleted on the
1873 // network thread to avoid a race with the socket read/write that occurs
1874 // on the network thread.
1875 std::vector<std::unique_ptr<cricket::TestTurnServer>> turn_servers_;
1876 std::vector<std::unique_ptr<cricket::TestTurnCustomizer>> turn_customizers_;
1877 std::unique_ptr<PeerConnectionIntegrationWrapper> caller_;
1878 std::unique_ptr<PeerConnectionIntegrationWrapper> callee_;
Jonas Orelanded99dae2022-03-09 09:28:10 +01001879 std::unique_ptr<WebRtcKeyValueConfig> field_trials_;
Harald Alvestrand39993842021-02-17 09:05:31 +00001880};
1881
1882} // namespace webrtc
1883
1884#endif // PC_TEST_INTEGRATION_TEST_HELPERS_H_