blob: 24d4616577146fc10b7abdefaeae44468aa80fe3 [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"
Jonas Orelande62c2f22022-03-29 11:04:48 +020036#include "api/field_trials_view.h"
Harald Alvestrand39993842021-02-17 09:05:31 +000037#include "api/ice_transport_interface.h"
38#include "api/jsep.h"
39#include "api/media_stream_interface.h"
40#include "api/media_types.h"
41#include "api/peer_connection_interface.h"
Harald Alvestrand39993842021-02-17 09:05:31 +000042#include "api/rtc_error.h"
43#include "api/rtc_event_log/rtc_event_log_factory.h"
44#include "api/rtc_event_log/rtc_event_log_factory_interface.h"
45#include "api/rtc_event_log_output.h"
46#include "api/rtp_receiver_interface.h"
47#include "api/rtp_sender_interface.h"
48#include "api/rtp_transceiver_interface.h"
49#include "api/scoped_refptr.h"
50#include "api/stats/rtc_stats.h"
51#include "api/stats/rtc_stats_report.h"
52#include "api/stats/rtcstats_objects.h"
53#include "api/task_queue/default_task_queue_factory.h"
54#include "api/task_queue/task_queue_factory.h"
55#include "api/transport/field_trial_based_config.h"
Harald Alvestrand39993842021-02-17 09:05:31 +000056#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(),
Niels Möllerafb246b2022-04-20 14:26:50 +0200349 source.get());
Harald Alvestrand39993842021-02-17 09:05:31 +0000350 }
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) {
Florent Castelli72424402022-04-06 03:45:10 +0200413 auto data_channel_or_error = pc()->CreateDataChannelOrError(label, init);
414 ASSERT_TRUE(data_channel_or_error.ok());
415 data_channels_.push_back(data_channel_or_error.MoveValue());
Harald Alvestrand06c87a12022-02-11 13:12:16 +0000416 ASSERT_TRUE(data_channels_.back().get() != nullptr);
417 data_observers_.push_back(
Niels Möllerafb246b2022-04-20 14:26:50 +0200418 std::make_unique<MockDataChannelObserver>(data_channels_.back().get()));
Harald Alvestrand39993842021-02-17 09:05:31 +0000419 }
420
Harald Alvestrand06c87a12022-02-11 13:12:16 +0000421 // Return the last observed data channel.
422 DataChannelInterface* data_channel() {
423 if (data_channels_.size() == 0) {
424 return nullptr;
425 }
Niels Möllerafb246b2022-04-20 14:26:50 +0200426 return data_channels_.back().get();
Harald Alvestrand06c87a12022-02-11 13:12:16 +0000427 }
428 // Return all data channels.
Florent Castellid4d97eb2022-05-04 00:28:06 +0200429 std::vector<rtc::scoped_refptr<DataChannelInterface>>& data_channels() {
Harald Alvestrand06c87a12022-02-11 13:12:16 +0000430 return data_channels_;
431 }
432
Harald Alvestrand39993842021-02-17 09:05:31 +0000433 const MockDataChannelObserver* data_observer() const {
Harald Alvestrand06c87a12022-02-11 13:12:16 +0000434 if (data_observers_.size() == 0) {
435 return nullptr;
436 }
437 return data_observers_.back().get();
Harald Alvestrand39993842021-02-17 09:05:31 +0000438 }
439
Florent Castellid4d97eb2022-05-04 00:28:06 +0200440 std::vector<std::unique_ptr<MockDataChannelObserver>>& data_observers() {
441 return data_observers_;
442 }
443
Harald Alvestrand39993842021-02-17 09:05:31 +0000444 int audio_frames_received() const {
445 return fake_audio_capture_module_->frames_received();
446 }
447
448 // Takes minimum of video frames received for each track.
449 //
450 // Can be used like:
451 // EXPECT_GE(expected_frames, min_video_frames_received_per_track());
452 //
453 // To ensure that all video tracks received at least a certain number of
454 // frames.
455 int min_video_frames_received_per_track() const {
456 int min_frames = INT_MAX;
457 if (fake_video_renderers_.empty()) {
458 return 0;
459 }
460
461 for (const auto& pair : fake_video_renderers_) {
462 min_frames = std::min(min_frames, pair.second->num_rendered_frames());
463 }
464 return min_frames;
465 }
466
467 // Returns a MockStatsObserver in a state after stats gathering finished,
468 // which can be used to access the gathered stats.
469 rtc::scoped_refptr<MockStatsObserver> OldGetStatsForTrack(
470 webrtc::MediaStreamTrackInterface* track) {
Tommi87f70902021-04-27 14:43:08 +0200471 auto observer = rtc::make_ref_counted<MockStatsObserver>();
Harald Alvestrand39993842021-02-17 09:05:31 +0000472 EXPECT_TRUE(peer_connection_->GetStats(
Niels Möllerafb246b2022-04-20 14:26:50 +0200473 observer.get(), nullptr,
474 PeerConnectionInterface::kStatsOutputLevelStandard));
Harald Alvestrand39993842021-02-17 09:05:31 +0000475 EXPECT_TRUE_WAIT(observer->called(), kDefaultTimeout);
476 return observer;
477 }
478
479 // Version that doesn't take a track "filter", and gathers all stats.
480 rtc::scoped_refptr<MockStatsObserver> OldGetStats() {
481 return OldGetStatsForTrack(nullptr);
482 }
483
484 // Synchronously gets stats and returns them. If it times out, fails the test
485 // and returns null.
486 rtc::scoped_refptr<const webrtc::RTCStatsReport> NewGetStats() {
Tommi87f70902021-04-27 14:43:08 +0200487 auto callback =
488 rtc::make_ref_counted<webrtc::MockRTCStatsCollectorCallback>();
Niels Möllerafb246b2022-04-20 14:26:50 +0200489 peer_connection_->GetStats(callback.get());
Harald Alvestrand39993842021-02-17 09:05:31 +0000490 EXPECT_TRUE_WAIT(callback->called(), kDefaultTimeout);
491 return callback->report();
492 }
493
494 int rendered_width() {
495 EXPECT_FALSE(fake_video_renderers_.empty());
496 return fake_video_renderers_.empty()
497 ? 0
498 : fake_video_renderers_.begin()->second->width();
499 }
500
501 int rendered_height() {
502 EXPECT_FALSE(fake_video_renderers_.empty());
503 return fake_video_renderers_.empty()
504 ? 0
505 : fake_video_renderers_.begin()->second->height();
506 }
507
508 double rendered_aspect_ratio() {
509 if (rendered_height() == 0) {
510 return 0.0;
511 }
512 return static_cast<double>(rendered_width()) / rendered_height();
513 }
514
515 webrtc::VideoRotation rendered_rotation() {
516 EXPECT_FALSE(fake_video_renderers_.empty());
517 return fake_video_renderers_.empty()
518 ? webrtc::kVideoRotation_0
519 : fake_video_renderers_.begin()->second->rotation();
520 }
521
522 int local_rendered_width() {
523 return local_video_renderer_ ? local_video_renderer_->width() : 0;
524 }
525
526 int local_rendered_height() {
527 return local_video_renderer_ ? local_video_renderer_->height() : 0;
528 }
529
530 double local_rendered_aspect_ratio() {
531 if (local_rendered_height() == 0) {
532 return 0.0;
533 }
534 return static_cast<double>(local_rendered_width()) /
535 local_rendered_height();
536 }
537
538 size_t number_of_remote_streams() {
539 if (!pc()) {
540 return 0;
541 }
542 return pc()->remote_streams()->count();
543 }
544
545 StreamCollectionInterface* remote_streams() const {
546 if (!pc()) {
547 ADD_FAILURE();
548 return nullptr;
549 }
Niels Möllerafb246b2022-04-20 14:26:50 +0200550 return pc()->remote_streams().get();
Harald Alvestrand39993842021-02-17 09:05:31 +0000551 }
552
553 StreamCollectionInterface* local_streams() {
554 if (!pc()) {
555 ADD_FAILURE();
556 return nullptr;
557 }
Niels Möllerafb246b2022-04-20 14:26:50 +0200558 return pc()->local_streams().get();
Harald Alvestrand39993842021-02-17 09:05:31 +0000559 }
560
561 webrtc::PeerConnectionInterface::SignalingState signaling_state() {
562 return pc()->signaling_state();
563 }
564
565 webrtc::PeerConnectionInterface::IceConnectionState ice_connection_state() {
566 return pc()->ice_connection_state();
567 }
568
569 webrtc::PeerConnectionInterface::IceConnectionState
570 standardized_ice_connection_state() {
571 return pc()->standardized_ice_connection_state();
572 }
573
574 webrtc::PeerConnectionInterface::IceGatheringState ice_gathering_state() {
575 return pc()->ice_gathering_state();
576 }
577
578 // Returns a MockRtpReceiverObserver for each RtpReceiver returned by
579 // GetReceivers. They're updated automatically when a remote offer/answer
580 // from the fake signaling channel is applied, or when
581 // ResetRtpReceiverObservers below is called.
582 const std::vector<std::unique_ptr<MockRtpReceiverObserver>>&
583 rtp_receiver_observers() {
584 return rtp_receiver_observers_;
585 }
586
587 void ResetRtpReceiverObservers() {
588 rtp_receiver_observers_.clear();
589 for (const rtc::scoped_refptr<RtpReceiverInterface>& receiver :
590 pc()->GetReceivers()) {
591 std::unique_ptr<MockRtpReceiverObserver> observer(
592 new MockRtpReceiverObserver(receiver->media_type()));
593 receiver->SetObserver(observer.get());
594 rtp_receiver_observers_.push_back(std::move(observer));
595 }
596 }
597
598 rtc::FakeNetworkManager* network_manager() const {
599 return fake_network_manager_.get();
600 }
601 cricket::PortAllocator* port_allocator() const { return port_allocator_; }
602
603 webrtc::FakeRtcEventLogFactory* event_log_factory() const {
604 return event_log_factory_;
605 }
606
607 const cricket::Candidate& last_candidate_gathered() const {
608 return last_candidate_gathered_;
609 }
610 const cricket::IceCandidateErrorEvent& error_event() const {
611 return error_event_;
612 }
613
614 // Sets the mDNS responder for the owned fake network manager and keeps a
615 // reference to the responder.
616 void SetMdnsResponder(
617 std::unique_ptr<webrtc::FakeMdnsResponder> mdns_responder) {
618 RTC_DCHECK(mdns_responder != nullptr);
619 mdns_responder_ = mdns_responder.get();
620 network_manager()->set_mdns_responder(std::move(mdns_responder));
621 }
622
623 // Returns null on failure.
624 std::unique_ptr<SessionDescriptionInterface> CreateOfferAndWait() {
Tommi87f70902021-04-27 14:43:08 +0200625 auto observer =
626 rtc::make_ref_counted<MockCreateSessionDescriptionObserver>();
Niels Möllerafb246b2022-04-20 14:26:50 +0200627 pc()->CreateOffer(observer.get(), offer_answer_options_);
628 return WaitForDescriptionFromObserver(observer.get());
Harald Alvestrand39993842021-02-17 09:05:31 +0000629 }
630 bool Rollback() {
631 return SetRemoteDescription(
632 webrtc::CreateSessionDescription(SdpType::kRollback, ""));
633 }
634
635 // Functions for querying stats.
636 void StartWatchingDelayStats() {
637 // Get the baseline numbers for audio_packets and audio_delay.
638 auto received_stats = NewGetStats();
639 auto track_stats =
640 received_stats->GetStatsOfType<webrtc::RTCMediaStreamTrackStats>()[0];
641 ASSERT_TRUE(track_stats->relative_packet_arrival_delay.is_defined());
642 auto rtp_stats =
643 received_stats->GetStatsOfType<webrtc::RTCInboundRTPStreamStats>()[0];
644 ASSERT_TRUE(rtp_stats->packets_received.is_defined());
645 ASSERT_TRUE(rtp_stats->track_id.is_defined());
646 audio_track_stats_id_ = track_stats->id();
647 ASSERT_TRUE(received_stats->Get(audio_track_stats_id_));
648 rtp_stats_id_ = rtp_stats->id();
649 ASSERT_EQ(audio_track_stats_id_, *rtp_stats->track_id);
650 audio_packets_stat_ = *rtp_stats->packets_received;
651 audio_delay_stat_ = *track_stats->relative_packet_arrival_delay;
652 audio_samples_stat_ = *track_stats->total_samples_received;
653 audio_concealed_stat_ = *track_stats->concealed_samples;
654 }
655
656 void UpdateDelayStats(std::string tag, int desc_size) {
657 auto report = NewGetStats();
658 auto track_stats =
659 report->GetAs<webrtc::RTCMediaStreamTrackStats>(audio_track_stats_id_);
660 ASSERT_TRUE(track_stats);
661 auto rtp_stats =
662 report->GetAs<webrtc::RTCInboundRTPStreamStats>(rtp_stats_id_);
663 ASSERT_TRUE(rtp_stats);
664 auto delta_packets = *rtp_stats->packets_received - audio_packets_stat_;
665 auto delta_rpad =
666 *track_stats->relative_packet_arrival_delay - audio_delay_stat_;
667 auto recent_delay = delta_packets > 0 ? delta_rpad / delta_packets : -1;
668 // The purpose of these checks is to sound the alarm early if we introduce
669 // serious regressions. The numbers are not acceptable for production, but
670 // occur on slow bots.
671 //
672 // An average relative packet arrival delay over the renegotiation of
673 // > 100 ms indicates that something is dramatically wrong, and will impact
674 // quality for sure.
675 // Worst bots:
676 // linux_x86_dbg at 0.206
677#if !defined(NDEBUG)
678 EXPECT_GT(0.25, recent_delay) << tag << " size " << desc_size;
679#else
680 EXPECT_GT(0.1, recent_delay) << tag << " size " << desc_size;
681#endif
682 auto delta_samples =
683 *track_stats->total_samples_received - audio_samples_stat_;
684 auto delta_concealed =
685 *track_stats->concealed_samples - audio_concealed_stat_;
686 // These limits should be adjusted down as we improve:
687 //
688 // Concealing more than 4000 samples during a renegotiation is unacceptable.
689 // But some bots are slow.
690
691 // Worst bots:
692 // linux_more_configs bot at conceal count 5184
693 // android_arm_rel at conceal count 9241
694 // linux_x86_dbg at 15174
695#if !defined(NDEBUG)
696 EXPECT_GT(18000U, delta_concealed) << "Concealed " << delta_concealed
697 << " of " << delta_samples << " samples";
698#else
699 EXPECT_GT(15000U, delta_concealed) << "Concealed " << delta_concealed
700 << " of " << delta_samples << " samples";
701#endif
702 // Concealing more than 20% of samples during a renegotiation is
703 // unacceptable.
704 // Worst bots:
Harald Alvestranda52fc6f2021-11-05 11:45:08 +0000705 // Nondebug: Linux32 Release at conceal rate 0.606597 (CI run)
706 // Debug: linux_x86_dbg bot at conceal rate 0.854
Harald Alvestrand39993842021-02-17 09:05:31 +0000707 if (delta_samples > 0) {
708#if !defined(NDEBUG)
Harald Alvestranda52fc6f2021-11-05 11:45:08 +0000709 EXPECT_LT(1.0 * delta_concealed / delta_samples, 0.95)
Harald Alvestrand39993842021-02-17 09:05:31 +0000710 << "Concealed " << delta_concealed << " of " << delta_samples
711 << " samples";
712#else
Harald Alvestranda52fc6f2021-11-05 11:45:08 +0000713 EXPECT_LT(1.0 * delta_concealed / delta_samples, 0.7)
Harald Alvestrand39993842021-02-17 09:05:31 +0000714 << "Concealed " << delta_concealed << " of " << delta_samples
715 << " samples";
716#endif
717 }
718 // Increment trailing counters
719 audio_packets_stat_ = *rtp_stats->packets_received;
720 audio_delay_stat_ = *track_stats->relative_packet_arrival_delay;
721 audio_samples_stat_ = *track_stats->total_samples_received;
722 audio_concealed_stat_ = *track_stats->concealed_samples;
723 }
724
Taylor Brandstetter1c7ecef2021-08-11 12:38:35 -0700725 // Sets number of candidates expected
726 void ExpectCandidates(int candidate_count) {
727 candidates_expected_ = candidate_count;
728 }
729
Harald Alvestrand39993842021-02-17 09:05:31 +0000730 private:
Niels Möller4f0a9192021-09-03 08:54:06 +0200731 // Constructor used by friend class PeerConnectionIntegrationBaseTest.
Harald Alvestrand39993842021-02-17 09:05:31 +0000732 explicit PeerConnectionIntegrationWrapper(const std::string& debug_name)
733 : debug_name_(debug_name) {}
734
735 bool Init(const PeerConnectionFactory::Options* options,
736 const PeerConnectionInterface::RTCConfiguration* config,
737 webrtc::PeerConnectionDependencies dependencies,
738 rtc::Thread* network_thread,
739 rtc::Thread* worker_thread,
740 std::unique_ptr<webrtc::FakeRtcEventLogFactory> event_log_factory,
741 bool reset_encoder_factory,
Harald Alvestrand35ba0c52022-05-05 07:37:41 +0000742 bool reset_decoder_factory,
743 bool create_media_engine) {
Harald Alvestrand39993842021-02-17 09:05:31 +0000744 // There's an error in this test code if Init ends up being called twice.
745 RTC_DCHECK(!peer_connection_);
746 RTC_DCHECK(!peer_connection_factory_);
747
748 fake_network_manager_.reset(new rtc::FakeNetworkManager());
749 fake_network_manager_->AddInterface(kDefaultLocalAddress);
750
751 std::unique_ptr<cricket::PortAllocator> port_allocator(
752 new cricket::BasicPortAllocator(fake_network_manager_.get()));
753 port_allocator_ = port_allocator.get();
754 fake_audio_capture_module_ = FakeAudioCaptureModule::Create();
755 if (!fake_audio_capture_module_) {
756 return false;
757 }
758 rtc::Thread* const signaling_thread = rtc::Thread::Current();
759
760 webrtc::PeerConnectionFactoryDependencies pc_factory_dependencies;
761 pc_factory_dependencies.network_thread = network_thread;
762 pc_factory_dependencies.worker_thread = worker_thread;
763 pc_factory_dependencies.signaling_thread = signaling_thread;
764 pc_factory_dependencies.task_queue_factory =
765 webrtc::CreateDefaultTaskQueueFactory();
766 pc_factory_dependencies.trials = std::make_unique<FieldTrialBasedConfig>();
Evan Shrubsole7619b7c2022-03-01 10:42:44 +0100767 pc_factory_dependencies.metronome = std::make_unique<TaskQueueMetronome>(
768 pc_factory_dependencies.task_queue_factory.get(), TimeDelta::Millis(8));
Harald Alvestrand39993842021-02-17 09:05:31 +0000769 cricket::MediaEngineDependencies media_deps;
770 media_deps.task_queue_factory =
771 pc_factory_dependencies.task_queue_factory.get();
772 media_deps.adm = fake_audio_capture_module_;
773 webrtc::SetMediaEngineDefaults(&media_deps);
774
775 if (reset_encoder_factory) {
776 media_deps.video_encoder_factory.reset();
777 }
778 if (reset_decoder_factory) {
779 media_deps.video_decoder_factory.reset();
780 }
781
782 if (!media_deps.audio_processing) {
783 // If the standard Creation method for APM returns a null pointer, instead
784 // use the builder for testing to create an APM object.
785 media_deps.audio_processing = AudioProcessingBuilderForTesting().Create();
786 }
787
788 media_deps.trials = pc_factory_dependencies.trials.get();
789
Harald Alvestrand35ba0c52022-05-05 07:37:41 +0000790 if (create_media_engine) {
791 pc_factory_dependencies.media_engine =
792 cricket::CreateMediaEngine(std::move(media_deps));
793 }
Harald Alvestrand39993842021-02-17 09:05:31 +0000794 pc_factory_dependencies.call_factory = webrtc::CreateCallFactory();
795 if (event_log_factory) {
796 event_log_factory_ = event_log_factory.get();
797 pc_factory_dependencies.event_log_factory = std::move(event_log_factory);
798 } else {
799 pc_factory_dependencies.event_log_factory =
800 std::make_unique<webrtc::RtcEventLogFactory>(
801 pc_factory_dependencies.task_queue_factory.get());
802 }
803 peer_connection_factory_ = webrtc::CreateModularPeerConnectionFactory(
804 std::move(pc_factory_dependencies));
805
806 if (!peer_connection_factory_) {
807 return false;
808 }
809 if (options) {
810 peer_connection_factory_->SetOptions(*options);
811 }
812 if (config) {
813 sdp_semantics_ = config->sdp_semantics;
814 }
815
816 dependencies.allocator = std::move(port_allocator);
817 peer_connection_ = CreatePeerConnection(config, std::move(dependencies));
818 return peer_connection_.get() != nullptr;
819 }
820
821 rtc::scoped_refptr<webrtc::PeerConnectionInterface> CreatePeerConnection(
822 const PeerConnectionInterface::RTCConfiguration* config,
823 webrtc::PeerConnectionDependencies dependencies) {
824 PeerConnectionInterface::RTCConfiguration modified_config;
Henrik Boström62995db2022-01-03 09:58:10 +0100825 modified_config.sdp_semantics = sdp_semantics_;
Artem Titov880fa812021-07-30 22:30:23 +0200826 // If `config` is null, this will result in a default configuration being
Harald Alvestrand39993842021-02-17 09:05:31 +0000827 // used.
828 if (config) {
829 modified_config = *config;
830 }
831 // Disable resolution adaptation; we don't want it interfering with the
832 // test results.
833 // TODO(deadbeef): Do something more robust. Since we're testing for aspect
834 // ratios and not specific resolutions, is this even necessary?
835 modified_config.set_cpu_adaptation(false);
836
837 dependencies.observer = this;
Florent Castelli72424402022-04-06 03:45:10 +0200838 auto peer_connection_or_error =
839 peer_connection_factory_->CreatePeerConnectionOrError(
840 modified_config, std::move(dependencies));
841 return peer_connection_or_error.ok() ? peer_connection_or_error.MoveValue()
842 : nullptr;
Harald Alvestrand39993842021-02-17 09:05:31 +0000843 }
844
845 void set_signaling_message_receiver(
846 SignalingMessageReceiver* signaling_message_receiver) {
847 signaling_message_receiver_ = signaling_message_receiver;
848 }
849
850 void set_signaling_delay_ms(int delay_ms) { signaling_delay_ms_ = delay_ms; }
851
852 void set_signal_ice_candidates(bool signal) {
853 signal_ice_candidates_ = signal;
854 }
855
856 rtc::scoped_refptr<webrtc::VideoTrackInterface> CreateLocalVideoTrackInternal(
857 webrtc::FakePeriodicVideoSource::Config config) {
858 // Set max frame rate to 10fps to reduce the risk of test flakiness.
859 // TODO(deadbeef): Do something more robust.
860 config.frame_interval_ms = 100;
861
862 video_track_sources_.emplace_back(
Tommi87f70902021-04-27 14:43:08 +0200863 rtc::make_ref_counted<webrtc::FakePeriodicVideoTrackSource>(
Harald Alvestrand39993842021-02-17 09:05:31 +0000864 config, false /* remote */));
865 rtc::scoped_refptr<webrtc::VideoTrackInterface> track(
866 peer_connection_factory_->CreateVideoTrack(
Niels Möllerafb246b2022-04-20 14:26:50 +0200867 rtc::CreateRandomUuid(), video_track_sources_.back().get()));
Harald Alvestrand39993842021-02-17 09:05:31 +0000868 if (!local_video_renderer_) {
Niels Möllerafb246b2022-04-20 14:26:50 +0200869 local_video_renderer_.reset(
870 new webrtc::FakeVideoTrackRenderer(track.get()));
Harald Alvestrand39993842021-02-17 09:05:31 +0000871 }
872 return track;
873 }
874
875 void HandleIncomingOffer(const std::string& msg) {
876 RTC_LOG(LS_INFO) << debug_name_ << ": HandleIncomingOffer";
877 std::unique_ptr<SessionDescriptionInterface> desc =
878 webrtc::CreateSessionDescription(SdpType::kOffer, msg);
879 if (received_sdp_munger_) {
880 received_sdp_munger_(desc->description());
881 }
882
883 EXPECT_TRUE(SetRemoteDescription(std::move(desc)));
884 // Setting a remote description may have changed the number of receivers,
885 // so reset the receiver observers.
886 ResetRtpReceiverObservers();
887 if (remote_offer_handler_) {
888 remote_offer_handler_();
889 }
890 auto answer = CreateAnswer();
891 ASSERT_NE(nullptr, answer);
892 EXPECT_TRUE(SetLocalDescriptionAndSendSdpMessage(std::move(answer)));
893 }
894
895 void HandleIncomingAnswer(const std::string& msg) {
896 RTC_LOG(LS_INFO) << debug_name_ << ": HandleIncomingAnswer";
897 std::unique_ptr<SessionDescriptionInterface> desc =
898 webrtc::CreateSessionDescription(SdpType::kAnswer, msg);
899 if (received_sdp_munger_) {
900 received_sdp_munger_(desc->description());
901 }
902
903 EXPECT_TRUE(SetRemoteDescription(std::move(desc)));
904 // Set the RtpReceiverObserver after receivers are created.
905 ResetRtpReceiverObservers();
906 }
907
908 // Returns null on failure.
909 std::unique_ptr<SessionDescriptionInterface> CreateAnswer() {
Tommi87f70902021-04-27 14:43:08 +0200910 auto observer =
911 rtc::make_ref_counted<MockCreateSessionDescriptionObserver>();
Niels Möllerafb246b2022-04-20 14:26:50 +0200912 pc()->CreateAnswer(observer.get(), offer_answer_options_);
913 return WaitForDescriptionFromObserver(observer.get());
Harald Alvestrand39993842021-02-17 09:05:31 +0000914 }
915
916 std::unique_ptr<SessionDescriptionInterface> WaitForDescriptionFromObserver(
917 MockCreateSessionDescriptionObserver* observer) {
918 EXPECT_EQ_WAIT(true, observer->called(), kDefaultTimeout);
919 if (!observer->result()) {
920 return nullptr;
921 }
922 auto description = observer->MoveDescription();
923 if (generated_sdp_munger_) {
924 generated_sdp_munger_(description->description());
925 }
926 return description;
927 }
928
929 // Setting the local description and sending the SDP message over the fake
930 // signaling channel are combined into the same method because the SDP
931 // message needs to be sent as soon as SetLocalDescription finishes, without
932 // waiting for the observer to be called. This ensures that ICE candidates
933 // don't outrace the description.
934 bool SetLocalDescriptionAndSendSdpMessage(
935 std::unique_ptr<SessionDescriptionInterface> desc) {
Tommi87f70902021-04-27 14:43:08 +0200936 auto observer = rtc::make_ref_counted<MockSetSessionDescriptionObserver>();
Harald Alvestrand39993842021-02-17 09:05:31 +0000937 RTC_LOG(LS_INFO) << debug_name_ << ": SetLocalDescriptionAndSendSdpMessage";
938 SdpType type = desc->GetType();
939 std::string sdp;
940 EXPECT_TRUE(desc->ToString(&sdp));
941 RTC_LOG(LS_INFO) << debug_name_ << ": local SDP contents=\n" << sdp;
Niels Möllerafb246b2022-04-20 14:26:50 +0200942 pc()->SetLocalDescription(observer.get(), desc.release());
Harald Alvestrand39993842021-02-17 09:05:31 +0000943 RemoveUnusedVideoRenderers();
944 // As mentioned above, we need to send the message immediately after
945 // SetLocalDescription.
946 SendSdpMessage(type, sdp);
947 EXPECT_TRUE_WAIT(observer->called(), kDefaultTimeout);
948 return true;
949 }
950
951 bool SetRemoteDescription(std::unique_ptr<SessionDescriptionInterface> desc) {
Tommi87f70902021-04-27 14:43:08 +0200952 auto observer = rtc::make_ref_counted<MockSetSessionDescriptionObserver>();
Harald Alvestrand39993842021-02-17 09:05:31 +0000953 RTC_LOG(LS_INFO) << debug_name_ << ": SetRemoteDescription";
Niels Möllerafb246b2022-04-20 14:26:50 +0200954 pc()->SetRemoteDescription(observer.get(), desc.release());
Harald Alvestrand39993842021-02-17 09:05:31 +0000955 RemoveUnusedVideoRenderers();
956 EXPECT_TRUE_WAIT(observer->called(), kDefaultTimeout);
957 return observer->result();
958 }
959
960 // This is a work around to remove unused fake_video_renderers from
961 // transceivers that have either stopped or are no longer receiving.
962 void RemoveUnusedVideoRenderers() {
963 if (sdp_semantics_ != SdpSemantics::kUnifiedPlan) {
964 return;
965 }
966 auto transceivers = pc()->GetTransceivers();
967 std::set<std::string> active_renderers;
968 for (auto& transceiver : transceivers) {
969 // Note - we don't check for direction here. This function is called
970 // before direction is set, and in that case, we should not remove
971 // the renderer.
972 if (transceiver->receiver()->media_type() == cricket::MEDIA_TYPE_VIDEO) {
973 active_renderers.insert(transceiver->receiver()->track()->id());
974 }
975 }
976 for (auto it = fake_video_renderers_.begin();
977 it != fake_video_renderers_.end();) {
978 // Remove fake video renderers belonging to any non-active transceivers.
979 if (!active_renderers.count(it->first)) {
980 it = fake_video_renderers_.erase(it);
981 } else {
982 it++;
983 }
984 }
985 }
986
Artem Titov880fa812021-07-30 22:30:23 +0200987 // Simulate sending a blob of SDP with delay `signaling_delay_ms_` (0 by
Harald Alvestrand39993842021-02-17 09:05:31 +0000988 // default).
989 void SendSdpMessage(SdpType type, const std::string& msg) {
990 if (signaling_delay_ms_ == 0) {
991 RelaySdpMessageIfReceiverExists(type, msg);
992 } else {
Niels Möller6097b0f2021-03-11 16:46:27 +0100993 rtc::Thread::Current()->PostDelayedTask(
994 ToQueuedTask(task_safety_.flag(),
995 [this, type, msg] {
996 RelaySdpMessageIfReceiverExists(type, msg);
997 }),
Harald Alvestrand39993842021-02-17 09:05:31 +0000998 signaling_delay_ms_);
999 }
1000 }
1001
1002 void RelaySdpMessageIfReceiverExists(SdpType type, const std::string& msg) {
1003 if (signaling_message_receiver_) {
1004 signaling_message_receiver_->ReceiveSdpMessage(type, msg);
1005 }
1006 }
1007
Artem Titov880fa812021-07-30 22:30:23 +02001008 // Simulate trickling an ICE candidate with delay `signaling_delay_ms_` (0 by
Harald Alvestrand39993842021-02-17 09:05:31 +00001009 // default).
1010 void SendIceMessage(const std::string& sdp_mid,
1011 int sdp_mline_index,
1012 const std::string& msg) {
1013 if (signaling_delay_ms_ == 0) {
1014 RelayIceMessageIfReceiverExists(sdp_mid, sdp_mline_index, msg);
1015 } else {
Niels Möller6097b0f2021-03-11 16:46:27 +01001016 rtc::Thread::Current()->PostDelayedTask(
1017 ToQueuedTask(task_safety_.flag(),
1018 [this, sdp_mid, sdp_mline_index, msg] {
1019 RelayIceMessageIfReceiverExists(sdp_mid,
1020 sdp_mline_index, msg);
1021 }),
Harald Alvestrand39993842021-02-17 09:05:31 +00001022 signaling_delay_ms_);
1023 }
1024 }
1025
1026 void RelayIceMessageIfReceiverExists(const std::string& sdp_mid,
1027 int sdp_mline_index,
1028 const std::string& msg) {
1029 if (signaling_message_receiver_) {
1030 signaling_message_receiver_->ReceiveIceMessage(sdp_mid, sdp_mline_index,
1031 msg);
1032 }
1033 }
1034
1035 // SignalingMessageReceiver callbacks.
1036 void ReceiveSdpMessage(SdpType type, const std::string& msg) override {
1037 if (type == SdpType::kOffer) {
1038 HandleIncomingOffer(msg);
1039 } else {
1040 HandleIncomingAnswer(msg);
1041 }
1042 }
1043
1044 void ReceiveIceMessage(const std::string& sdp_mid,
1045 int sdp_mline_index,
1046 const std::string& msg) override {
1047 RTC_LOG(LS_INFO) << debug_name_ << ": ReceiveIceMessage";
1048 std::unique_ptr<webrtc::IceCandidateInterface> candidate(
1049 webrtc::CreateIceCandidate(sdp_mid, sdp_mline_index, msg, nullptr));
1050 EXPECT_TRUE(pc()->AddIceCandidate(candidate.get()));
1051 }
1052
1053 // PeerConnectionObserver callbacks.
1054 void OnSignalingChange(
1055 webrtc::PeerConnectionInterface::SignalingState new_state) override {
1056 EXPECT_EQ(pc()->signaling_state(), new_state);
1057 peer_connection_signaling_state_history_.push_back(new_state);
1058 }
1059 void OnAddTrack(rtc::scoped_refptr<RtpReceiverInterface> receiver,
1060 const std::vector<rtc::scoped_refptr<MediaStreamInterface>>&
1061 streams) override {
1062 if (receiver->media_type() == cricket::MEDIA_TYPE_VIDEO) {
1063 rtc::scoped_refptr<VideoTrackInterface> video_track(
1064 static_cast<VideoTrackInterface*>(receiver->track().get()));
1065 ASSERT_TRUE(fake_video_renderers_.find(video_track->id()) ==
1066 fake_video_renderers_.end());
1067 fake_video_renderers_[video_track->id()] =
Niels Möllerafb246b2022-04-20 14:26:50 +02001068 std::make_unique<FakeVideoTrackRenderer>(video_track.get());
Harald Alvestrand39993842021-02-17 09:05:31 +00001069 }
1070 }
1071 void OnRemoveTrack(
1072 rtc::scoped_refptr<RtpReceiverInterface> receiver) override {
1073 if (receiver->media_type() == cricket::MEDIA_TYPE_VIDEO) {
1074 auto it = fake_video_renderers_.find(receiver->track()->id());
1075 if (it != fake_video_renderers_.end()) {
1076 fake_video_renderers_.erase(it);
1077 } else {
1078 RTC_LOG(LS_ERROR) << "OnRemoveTrack called for non-active renderer";
1079 }
1080 }
1081 }
1082 void OnRenegotiationNeeded() override {}
1083 void OnIceConnectionChange(
1084 webrtc::PeerConnectionInterface::IceConnectionState new_state) override {
1085 EXPECT_EQ(pc()->ice_connection_state(), new_state);
1086 ice_connection_state_history_.push_back(new_state);
1087 }
1088 void OnStandardizedIceConnectionChange(
1089 webrtc::PeerConnectionInterface::IceConnectionState new_state) override {
1090 standardized_ice_connection_state_history_.push_back(new_state);
1091 }
1092 void OnConnectionChange(
1093 webrtc::PeerConnectionInterface::PeerConnectionState new_state) override {
1094 peer_connection_state_history_.push_back(new_state);
1095 }
1096
1097 void OnIceGatheringChange(
1098 webrtc::PeerConnectionInterface::IceGatheringState new_state) override {
1099 EXPECT_EQ(pc()->ice_gathering_state(), new_state);
1100 ice_gathering_state_history_.push_back(new_state);
1101 }
1102
1103 void OnIceSelectedCandidatePairChanged(
1104 const cricket::CandidatePairChangeEvent& event) {
1105 ice_candidate_pair_change_history_.push_back(event);
1106 }
1107
1108 void OnIceCandidate(const webrtc::IceCandidateInterface* candidate) override {
1109 RTC_LOG(LS_INFO) << debug_name_ << ": OnIceCandidate";
1110
1111 if (remote_async_resolver_) {
1112 const auto& local_candidate = candidate->candidate();
1113 if (local_candidate.address().IsUnresolvedIP()) {
1114 RTC_DCHECK(local_candidate.type() == cricket::LOCAL_PORT_TYPE);
1115 rtc::SocketAddress resolved_addr(local_candidate.address());
1116 const auto resolved_ip = mdns_responder_->GetMappedAddressForName(
1117 local_candidate.address().hostname());
1118 RTC_DCHECK(!resolved_ip.IsNil());
1119 resolved_addr.SetResolvedIP(resolved_ip);
1120 EXPECT_CALL(*remote_async_resolver_, GetResolvedAddress(_, _))
1121 .WillOnce(DoAll(SetArgPointee<1>(resolved_addr), Return(true)));
1122 EXPECT_CALL(*remote_async_resolver_, Destroy(_));
1123 }
1124 }
1125
Taylor Brandstetter1c7ecef2021-08-11 12:38:35 -07001126 // Check if we expected to have a candidate.
1127 EXPECT_GT(candidates_expected_, 1);
1128 candidates_expected_--;
Harald Alvestrand39993842021-02-17 09:05:31 +00001129 std::string ice_sdp;
1130 EXPECT_TRUE(candidate->ToString(&ice_sdp));
1131 if (signaling_message_receiver_ == nullptr || !signal_ice_candidates_) {
1132 // Remote party may be deleted.
1133 return;
1134 }
1135 SendIceMessage(candidate->sdp_mid(), candidate->sdp_mline_index(), ice_sdp);
1136 last_candidate_gathered_ = candidate->candidate();
1137 }
1138 void OnIceCandidateError(const std::string& address,
1139 int port,
1140 const std::string& url,
1141 int error_code,
1142 const std::string& error_text) override {
1143 error_event_ = cricket::IceCandidateErrorEvent(address, port, url,
1144 error_code, error_text);
1145 }
1146 void OnDataChannel(
1147 rtc::scoped_refptr<DataChannelInterface> data_channel) override {
1148 RTC_LOG(LS_INFO) << debug_name_ << ": OnDataChannel";
Harald Alvestrand06c87a12022-02-11 13:12:16 +00001149 data_channels_.push_back(data_channel);
1150 data_observers_.push_back(
Niels Möllerafb246b2022-04-20 14:26:50 +02001151 std::make_unique<MockDataChannelObserver>(data_channel.get()));
Harald Alvestrand39993842021-02-17 09:05:31 +00001152 }
1153
1154 std::string debug_name_;
1155
1156 std::unique_ptr<rtc::FakeNetworkManager> fake_network_manager_;
Artem Titov880fa812021-07-30 22:30:23 +02001157 // Reference to the mDNS responder owned by `fake_network_manager_` after set.
Harald Alvestrand39993842021-02-17 09:05:31 +00001158 webrtc::FakeMdnsResponder* mdns_responder_ = nullptr;
1159
1160 rtc::scoped_refptr<webrtc::PeerConnectionInterface> peer_connection_;
1161 rtc::scoped_refptr<webrtc::PeerConnectionFactoryInterface>
1162 peer_connection_factory_;
1163
1164 cricket::PortAllocator* port_allocator_;
1165 // Needed to keep track of number of frames sent.
1166 rtc::scoped_refptr<FakeAudioCaptureModule> fake_audio_capture_module_;
1167 // Needed to keep track of number of frames received.
1168 std::map<std::string, std::unique_ptr<webrtc::FakeVideoTrackRenderer>>
1169 fake_video_renderers_;
1170 // Needed to ensure frames aren't received for removed tracks.
1171 std::vector<std::unique_ptr<webrtc::FakeVideoTrackRenderer>>
1172 removed_fake_video_renderers_;
1173
1174 // For remote peer communication.
1175 SignalingMessageReceiver* signaling_message_receiver_ = nullptr;
1176 int signaling_delay_ms_ = 0;
1177 bool signal_ice_candidates_ = true;
1178 cricket::Candidate last_candidate_gathered_;
1179 cricket::IceCandidateErrorEvent error_event_;
1180
1181 // Store references to the video sources we've created, so that we can stop
1182 // them, if required.
1183 std::vector<rtc::scoped_refptr<webrtc::VideoTrackSource>>
1184 video_track_sources_;
Artem Titov880fa812021-07-30 22:30:23 +02001185 // `local_video_renderer_` attached to the first created local video track.
Harald Alvestrand39993842021-02-17 09:05:31 +00001186 std::unique_ptr<webrtc::FakeVideoTrackRenderer> local_video_renderer_;
1187
1188 SdpSemantics sdp_semantics_;
1189 PeerConnectionInterface::RTCOfferAnswerOptions offer_answer_options_;
1190 std::function<void(cricket::SessionDescription*)> received_sdp_munger_;
1191 std::function<void(cricket::SessionDescription*)> generated_sdp_munger_;
1192 std::function<void()> remote_offer_handler_;
1193 rtc::MockAsyncResolver* remote_async_resolver_ = nullptr;
Harald Alvestrand06c87a12022-02-11 13:12:16 +00001194 // All data channels either created or observed on this peerconnection
1195 std::vector<rtc::scoped_refptr<DataChannelInterface>> data_channels_;
1196 std::vector<std::unique_ptr<MockDataChannelObserver>> data_observers_;
Harald Alvestrand39993842021-02-17 09:05:31 +00001197
1198 std::vector<std::unique_ptr<MockRtpReceiverObserver>> rtp_receiver_observers_;
1199
1200 std::vector<PeerConnectionInterface::IceConnectionState>
1201 ice_connection_state_history_;
1202 std::vector<PeerConnectionInterface::IceConnectionState>
1203 standardized_ice_connection_state_history_;
1204 std::vector<PeerConnectionInterface::PeerConnectionState>
1205 peer_connection_state_history_;
1206 std::vector<PeerConnectionInterface::IceGatheringState>
1207 ice_gathering_state_history_;
1208 std::vector<cricket::CandidatePairChangeEvent>
1209 ice_candidate_pair_change_history_;
1210 std::vector<PeerConnectionInterface::SignalingState>
1211 peer_connection_signaling_state_history_;
1212 webrtc::FakeRtcEventLogFactory* event_log_factory_;
1213
Taylor Brandstetter1c7ecef2021-08-11 12:38:35 -07001214 // Number of ICE candidates expected. The default is no limit.
1215 int candidates_expected_ = std::numeric_limits<int>::max();
1216
Harald Alvestrand39993842021-02-17 09:05:31 +00001217 // Variables for tracking delay stats on an audio track
1218 int audio_packets_stat_ = 0;
1219 double audio_delay_stat_ = 0.0;
1220 uint64_t audio_samples_stat_ = 0;
1221 uint64_t audio_concealed_stat_ = 0;
1222 std::string rtp_stats_id_;
1223 std::string audio_track_stats_id_;
1224
Niels Möller6097b0f2021-03-11 16:46:27 +01001225 ScopedTaskSafety task_safety_;
Harald Alvestrand39993842021-02-17 09:05:31 +00001226
1227 friend class PeerConnectionIntegrationBaseTest;
1228};
1229
1230class MockRtcEventLogOutput : public webrtc::RtcEventLogOutput {
1231 public:
1232 virtual ~MockRtcEventLogOutput() = default;
1233 MOCK_METHOD(bool, IsActive, (), (const, override));
1234 MOCK_METHOD(bool, Write, (const std::string&), (override));
1235};
1236
1237// This helper object is used for both specifying how many audio/video frames
1238// are expected to be received for a caller/callee. It provides helper functions
1239// to specify these expectations. The object initially starts in a state of no
1240// expectations.
1241class MediaExpectations {
1242 public:
1243 enum ExpectFrames {
1244 kExpectSomeFrames,
1245 kExpectNoFrames,
1246 kNoExpectation,
1247 };
1248
1249 void ExpectBidirectionalAudioAndVideo() {
1250 ExpectBidirectionalAudio();
1251 ExpectBidirectionalVideo();
1252 }
1253
1254 void ExpectBidirectionalAudio() {
1255 CallerExpectsSomeAudio();
1256 CalleeExpectsSomeAudio();
1257 }
1258
1259 void ExpectNoAudio() {
1260 CallerExpectsNoAudio();
1261 CalleeExpectsNoAudio();
1262 }
1263
1264 void ExpectBidirectionalVideo() {
1265 CallerExpectsSomeVideo();
1266 CalleeExpectsSomeVideo();
1267 }
1268
1269 void ExpectNoVideo() {
1270 CallerExpectsNoVideo();
1271 CalleeExpectsNoVideo();
1272 }
1273
1274 void CallerExpectsSomeAudioAndVideo() {
1275 CallerExpectsSomeAudio();
1276 CallerExpectsSomeVideo();
1277 }
1278
1279 void CalleeExpectsSomeAudioAndVideo() {
1280 CalleeExpectsSomeAudio();
1281 CalleeExpectsSomeVideo();
1282 }
1283
1284 // Caller's audio functions.
1285 void CallerExpectsSomeAudio(
1286 int expected_audio_frames = kDefaultExpectedAudioFrameCount) {
1287 caller_audio_expectation_ = kExpectSomeFrames;
1288 caller_audio_frames_expected_ = expected_audio_frames;
1289 }
1290
1291 void CallerExpectsNoAudio() {
1292 caller_audio_expectation_ = kExpectNoFrames;
1293 caller_audio_frames_expected_ = 0;
1294 }
1295
1296 // Caller's video functions.
1297 void CallerExpectsSomeVideo(
1298 int expected_video_frames = kDefaultExpectedVideoFrameCount) {
1299 caller_video_expectation_ = kExpectSomeFrames;
1300 caller_video_frames_expected_ = expected_video_frames;
1301 }
1302
1303 void CallerExpectsNoVideo() {
1304 caller_video_expectation_ = kExpectNoFrames;
1305 caller_video_frames_expected_ = 0;
1306 }
1307
1308 // Callee's audio functions.
1309 void CalleeExpectsSomeAudio(
1310 int expected_audio_frames = kDefaultExpectedAudioFrameCount) {
1311 callee_audio_expectation_ = kExpectSomeFrames;
1312 callee_audio_frames_expected_ = expected_audio_frames;
1313 }
1314
1315 void CalleeExpectsNoAudio() {
1316 callee_audio_expectation_ = kExpectNoFrames;
1317 callee_audio_frames_expected_ = 0;
1318 }
1319
1320 // Callee's video functions.
1321 void CalleeExpectsSomeVideo(
1322 int expected_video_frames = kDefaultExpectedVideoFrameCount) {
1323 callee_video_expectation_ = kExpectSomeFrames;
1324 callee_video_frames_expected_ = expected_video_frames;
1325 }
1326
1327 void CalleeExpectsNoVideo() {
1328 callee_video_expectation_ = kExpectNoFrames;
1329 callee_video_frames_expected_ = 0;
1330 }
1331
1332 ExpectFrames caller_audio_expectation_ = kNoExpectation;
1333 ExpectFrames caller_video_expectation_ = kNoExpectation;
1334 ExpectFrames callee_audio_expectation_ = kNoExpectation;
1335 ExpectFrames callee_video_expectation_ = kNoExpectation;
1336 int caller_audio_frames_expected_ = 0;
1337 int caller_video_frames_expected_ = 0;
1338 int callee_audio_frames_expected_ = 0;
1339 int callee_video_frames_expected_ = 0;
1340};
1341
1342class MockIceTransport : public webrtc::IceTransportInterface {
1343 public:
1344 MockIceTransport(const std::string& name, int component)
1345 : internal_(std::make_unique<cricket::FakeIceTransport>(
1346 name,
1347 component,
1348 nullptr /* network_thread */)) {}
1349 ~MockIceTransport() = default;
1350 cricket::IceTransportInternal* internal() { return internal_.get(); }
1351
1352 private:
1353 std::unique_ptr<cricket::FakeIceTransport> internal_;
1354};
1355
1356class MockIceTransportFactory : public IceTransportFactory {
1357 public:
1358 ~MockIceTransportFactory() override = default;
1359 rtc::scoped_refptr<IceTransportInterface> CreateIceTransport(
1360 const std::string& transport_name,
1361 int component,
1362 IceTransportInit init) {
1363 RecordIceTransportCreated();
Tommi87f70902021-04-27 14:43:08 +02001364 return rtc::make_ref_counted<MockIceTransport>(transport_name, component);
Harald Alvestrand39993842021-02-17 09:05:31 +00001365 }
1366 MOCK_METHOD(void, RecordIceTransportCreated, ());
1367};
1368
1369// Tests two PeerConnections connecting to each other end-to-end, using a
1370// virtual network, fake A/V capture and fake encoder/decoders. The
1371// PeerConnections share the threads/socket servers, but use separate versions
1372// of everything else (including "PeerConnectionFactory"s).
1373class PeerConnectionIntegrationBaseTest : public ::testing::Test {
1374 public:
Florent Castellia6983c62021-05-06 10:50:07 +02001375 PeerConnectionIntegrationBaseTest(
1376 SdpSemantics sdp_semantics,
1377 absl::optional<std::string> field_trials = absl::nullopt)
Harald Alvestrand39993842021-02-17 09:05:31 +00001378 : sdp_semantics_(sdp_semantics),
1379 ss_(new rtc::VirtualSocketServer()),
1380 fss_(new rtc::FirewallSocketServer(ss_.get())),
1381 network_thread_(new rtc::Thread(fss_.get())),
Florent Castellia6983c62021-05-06 10:50:07 +02001382 worker_thread_(rtc::Thread::Create()),
Jonas Orelanded99dae2022-03-09 09:28:10 +01001383 // TODO(bugs.webrtc.org/10335): Pass optional ScopedKeyValueConfig.
1384 field_trials_(new test::ScopedKeyValueConfig(
1385 field_trials.has_value() ? *field_trials : "")) {
Harald Alvestrand39993842021-02-17 09:05:31 +00001386 network_thread_->SetName("PCNetworkThread", this);
1387 worker_thread_->SetName("PCWorkerThread", this);
1388 RTC_CHECK(network_thread_->Start());
1389 RTC_CHECK(worker_thread_->Start());
1390 webrtc::metrics::Reset();
1391 }
1392
1393 ~PeerConnectionIntegrationBaseTest() {
1394 // The PeerConnections should be deleted before the TurnCustomizers.
1395 // A TurnPort is created with a raw pointer to a TurnCustomizer. The
1396 // TurnPort has the same lifetime as the PeerConnection, so it's expected
1397 // that the TurnCustomizer outlives the life of the PeerConnection or else
1398 // when Send() is called it will hit a seg fault.
1399 if (caller_) {
1400 caller_->set_signaling_message_receiver(nullptr);
Tomas Gunnarsson2efb8a52021-04-01 16:26:57 +02001401 caller_->pc()->Close();
Harald Alvestrand39993842021-02-17 09:05:31 +00001402 delete SetCallerPcWrapperAndReturnCurrent(nullptr);
1403 }
1404 if (callee_) {
1405 callee_->set_signaling_message_receiver(nullptr);
Tomas Gunnarsson2efb8a52021-04-01 16:26:57 +02001406 callee_->pc()->Close();
Harald Alvestrand39993842021-02-17 09:05:31 +00001407 delete SetCalleePcWrapperAndReturnCurrent(nullptr);
1408 }
1409
1410 // If turn servers were created for the test they need to be destroyed on
1411 // the network thread.
1412 network_thread()->Invoke<void>(RTC_FROM_HERE, [this] {
1413 turn_servers_.clear();
1414 turn_customizers_.clear();
1415 });
1416 }
1417
1418 bool SignalingStateStable() {
1419 return caller_->SignalingStateStable() && callee_->SignalingStateStable();
1420 }
1421
1422 bool DtlsConnected() {
1423 // TODO(deadbeef): kIceConnectionConnected currently means both ICE and DTLS
1424 // are connected. This is an important distinction. Once we have separate
1425 // ICE and DTLS state, this check needs to use the DTLS state.
1426 return (callee()->ice_connection_state() ==
1427 webrtc::PeerConnectionInterface::kIceConnectionConnected ||
1428 callee()->ice_connection_state() ==
1429 webrtc::PeerConnectionInterface::kIceConnectionCompleted) &&
1430 (caller()->ice_connection_state() ==
1431 webrtc::PeerConnectionInterface::kIceConnectionConnected ||
1432 caller()->ice_connection_state() ==
1433 webrtc::PeerConnectionInterface::kIceConnectionCompleted);
1434 }
1435
Artem Titov880fa812021-07-30 22:30:23 +02001436 // When `event_log_factory` is null, the default implementation of the event
Harald Alvestrand39993842021-02-17 09:05:31 +00001437 // log factory will be used.
1438 std::unique_ptr<PeerConnectionIntegrationWrapper> CreatePeerConnectionWrapper(
1439 const std::string& debug_name,
1440 const PeerConnectionFactory::Options* options,
1441 const RTCConfiguration* config,
1442 webrtc::PeerConnectionDependencies dependencies,
1443 std::unique_ptr<webrtc::FakeRtcEventLogFactory> event_log_factory,
1444 bool reset_encoder_factory,
Harald Alvestrand35ba0c52022-05-05 07:37:41 +00001445 bool reset_decoder_factory,
1446 bool create_media_engine = true) {
Harald Alvestrand39993842021-02-17 09:05:31 +00001447 RTCConfiguration modified_config;
1448 if (config) {
1449 modified_config = *config;
1450 }
1451 modified_config.sdp_semantics = sdp_semantics_;
1452 if (!dependencies.cert_generator) {
1453 dependencies.cert_generator =
1454 std::make_unique<FakeRTCCertificateGenerator>();
1455 }
1456 std::unique_ptr<PeerConnectionIntegrationWrapper> client(
1457 new PeerConnectionIntegrationWrapper(debug_name));
1458
1459 if (!client->Init(options, &modified_config, std::move(dependencies),
1460 network_thread_.get(), worker_thread_.get(),
1461 std::move(event_log_factory), reset_encoder_factory,
Harald Alvestrand35ba0c52022-05-05 07:37:41 +00001462 reset_decoder_factory, create_media_engine)) {
Harald Alvestrand39993842021-02-17 09:05:31 +00001463 return nullptr;
1464 }
1465 return client;
1466 }
1467
1468 std::unique_ptr<PeerConnectionIntegrationWrapper>
1469 CreatePeerConnectionWrapperWithFakeRtcEventLog(
1470 const std::string& debug_name,
1471 const PeerConnectionFactory::Options* options,
1472 const RTCConfiguration* config,
1473 webrtc::PeerConnectionDependencies dependencies) {
1474 return CreatePeerConnectionWrapper(
1475 debug_name, options, config, std::move(dependencies),
1476 std::make_unique<webrtc::FakeRtcEventLogFactory>(),
1477 /*reset_encoder_factory=*/false,
1478 /*reset_decoder_factory=*/false);
1479 }
1480
1481 bool CreatePeerConnectionWrappers() {
1482 return CreatePeerConnectionWrappersWithConfig(
1483 PeerConnectionInterface::RTCConfiguration(),
1484 PeerConnectionInterface::RTCConfiguration());
1485 }
1486
1487 bool CreatePeerConnectionWrappersWithSdpSemantics(
1488 SdpSemantics caller_semantics,
1489 SdpSemantics callee_semantics) {
1490 // Can't specify the sdp_semantics in the passed-in configuration since it
1491 // will be overwritten by CreatePeerConnectionWrapper with whatever is
1492 // stored in sdp_semantics_. So get around this by modifying the instance
1493 // variable before calling CreatePeerConnectionWrapper for the caller and
1494 // callee PeerConnections.
1495 SdpSemantics original_semantics = sdp_semantics_;
1496 sdp_semantics_ = caller_semantics;
1497 caller_ = CreatePeerConnectionWrapper(
1498 "Caller", nullptr, nullptr, webrtc::PeerConnectionDependencies(nullptr),
1499 nullptr,
1500 /*reset_encoder_factory=*/false,
1501 /*reset_decoder_factory=*/false);
1502 sdp_semantics_ = callee_semantics;
1503 callee_ = CreatePeerConnectionWrapper(
1504 "Callee", nullptr, nullptr, webrtc::PeerConnectionDependencies(nullptr),
1505 nullptr,
1506 /*reset_encoder_factory=*/false,
1507 /*reset_decoder_factory=*/false);
1508 sdp_semantics_ = original_semantics;
1509 return caller_ && callee_;
1510 }
1511
1512 bool CreatePeerConnectionWrappersWithConfig(
1513 const PeerConnectionInterface::RTCConfiguration& caller_config,
1514 const PeerConnectionInterface::RTCConfiguration& callee_config) {
1515 caller_ = CreatePeerConnectionWrapper(
1516 "Caller", nullptr, &caller_config,
1517 webrtc::PeerConnectionDependencies(nullptr), nullptr,
1518 /*reset_encoder_factory=*/false,
1519 /*reset_decoder_factory=*/false);
1520 callee_ = CreatePeerConnectionWrapper(
1521 "Callee", nullptr, &callee_config,
1522 webrtc::PeerConnectionDependencies(nullptr), nullptr,
1523 /*reset_encoder_factory=*/false,
1524 /*reset_decoder_factory=*/false);
1525 return caller_ && callee_;
1526 }
1527
1528 bool CreatePeerConnectionWrappersWithConfigAndDeps(
1529 const PeerConnectionInterface::RTCConfiguration& caller_config,
1530 webrtc::PeerConnectionDependencies caller_dependencies,
1531 const PeerConnectionInterface::RTCConfiguration& callee_config,
1532 webrtc::PeerConnectionDependencies callee_dependencies) {
1533 caller_ =
1534 CreatePeerConnectionWrapper("Caller", nullptr, &caller_config,
1535 std::move(caller_dependencies), nullptr,
1536 /*reset_encoder_factory=*/false,
1537 /*reset_decoder_factory=*/false);
1538 callee_ =
1539 CreatePeerConnectionWrapper("Callee", nullptr, &callee_config,
1540 std::move(callee_dependencies), nullptr,
1541 /*reset_encoder_factory=*/false,
1542 /*reset_decoder_factory=*/false);
1543 return caller_ && callee_;
1544 }
1545
1546 bool CreatePeerConnectionWrappersWithOptions(
1547 const PeerConnectionFactory::Options& caller_options,
1548 const PeerConnectionFactory::Options& callee_options) {
1549 caller_ = CreatePeerConnectionWrapper(
1550 "Caller", &caller_options, nullptr,
1551 webrtc::PeerConnectionDependencies(nullptr), nullptr,
1552 /*reset_encoder_factory=*/false,
1553 /*reset_decoder_factory=*/false);
1554 callee_ = CreatePeerConnectionWrapper(
1555 "Callee", &callee_options, nullptr,
1556 webrtc::PeerConnectionDependencies(nullptr), nullptr,
1557 /*reset_encoder_factory=*/false,
1558 /*reset_decoder_factory=*/false);
1559 return caller_ && callee_;
1560 }
1561
1562 bool CreatePeerConnectionWrappersWithFakeRtcEventLog() {
1563 PeerConnectionInterface::RTCConfiguration default_config;
1564 caller_ = CreatePeerConnectionWrapperWithFakeRtcEventLog(
1565 "Caller", nullptr, &default_config,
1566 webrtc::PeerConnectionDependencies(nullptr));
1567 callee_ = CreatePeerConnectionWrapperWithFakeRtcEventLog(
1568 "Callee", nullptr, &default_config,
1569 webrtc::PeerConnectionDependencies(nullptr));
1570 return caller_ && callee_;
1571 }
1572
1573 std::unique_ptr<PeerConnectionIntegrationWrapper>
1574 CreatePeerConnectionWrapperWithAlternateKey() {
1575 std::unique_ptr<FakeRTCCertificateGenerator> cert_generator(
1576 new FakeRTCCertificateGenerator());
1577 cert_generator->use_alternate_key();
1578
1579 webrtc::PeerConnectionDependencies dependencies(nullptr);
1580 dependencies.cert_generator = std::move(cert_generator);
1581 return CreatePeerConnectionWrapper("New Peer", nullptr, nullptr,
1582 std::move(dependencies), nullptr,
1583 /*reset_encoder_factory=*/false,
1584 /*reset_decoder_factory=*/false);
1585 }
1586
1587 bool CreateOneDirectionalPeerConnectionWrappers(bool caller_to_callee) {
1588 caller_ = CreatePeerConnectionWrapper(
1589 "Caller", nullptr, nullptr, webrtc::PeerConnectionDependencies(nullptr),
1590 nullptr,
1591 /*reset_encoder_factory=*/!caller_to_callee,
1592 /*reset_decoder_factory=*/caller_to_callee);
1593 callee_ = CreatePeerConnectionWrapper(
1594 "Callee", nullptr, nullptr, webrtc::PeerConnectionDependencies(nullptr),
1595 nullptr,
1596 /*reset_encoder_factory=*/caller_to_callee,
1597 /*reset_decoder_factory=*/!caller_to_callee);
1598 return caller_ && callee_;
1599 }
1600
Harald Alvestrand35ba0c52022-05-05 07:37:41 +00001601 bool CreatePeerConnectionWrappersWithoutMediaEngine() {
1602 caller_ = CreatePeerConnectionWrapper(
1603 "Caller", nullptr, nullptr, webrtc::PeerConnectionDependencies(nullptr),
1604 nullptr,
1605 /*reset_encoder_factory=*/false,
1606 /*reset_decoder_factory=*/false,
1607 /*create_media_engine=*/false);
1608 callee_ = CreatePeerConnectionWrapper(
1609 "Callee", nullptr, nullptr, webrtc::PeerConnectionDependencies(nullptr),
1610 nullptr,
1611 /*reset_encoder_factory=*/false,
1612 /*reset_decoder_factory=*/false,
1613 /*create_media_engine=*/false);
1614 return caller_ && callee_;
1615 }
1616
Harald Alvestrand39993842021-02-17 09:05:31 +00001617 cricket::TestTurnServer* CreateTurnServer(
1618 rtc::SocketAddress internal_address,
1619 rtc::SocketAddress external_address,
1620 cricket::ProtocolType type = cricket::ProtocolType::PROTO_UDP,
1621 const std::string& common_name = "test turn server") {
1622 rtc::Thread* thread = network_thread();
Niels Möller6dd49972021-11-24 14:05:55 +01001623 rtc::SocketFactory* socket_factory = fss_.get();
Harald Alvestrand39993842021-02-17 09:05:31 +00001624 std::unique_ptr<cricket::TestTurnServer> turn_server =
1625 network_thread()->Invoke<std::unique_ptr<cricket::TestTurnServer>>(
Niels Möller6dd49972021-11-24 14:05:55 +01001626 RTC_FROM_HERE, [thread, socket_factory, internal_address,
1627 external_address, type, common_name] {
Harald Alvestrand39993842021-02-17 09:05:31 +00001628 return std::make_unique<cricket::TestTurnServer>(
Niels Möller6dd49972021-11-24 14:05:55 +01001629 thread, socket_factory, internal_address, external_address,
1630 type,
Harald Alvestrand39993842021-02-17 09:05:31 +00001631 /*ignore_bad_certs=*/true, common_name);
1632 });
1633 turn_servers_.push_back(std::move(turn_server));
1634 // Interactions with the turn server should be done on the network thread.
1635 return turn_servers_.back().get();
1636 }
1637
1638 cricket::TestTurnCustomizer* CreateTurnCustomizer() {
1639 std::unique_ptr<cricket::TestTurnCustomizer> turn_customizer =
1640 network_thread()->Invoke<std::unique_ptr<cricket::TestTurnCustomizer>>(
1641 RTC_FROM_HERE,
1642 [] { return std::make_unique<cricket::TestTurnCustomizer>(); });
1643 turn_customizers_.push_back(std::move(turn_customizer));
1644 // Interactions with the turn customizer should be done on the network
1645 // thread.
1646 return turn_customizers_.back().get();
1647 }
1648
1649 // Checks that the function counters for a TestTurnCustomizer are greater than
1650 // 0.
1651 void ExpectTurnCustomizerCountersIncremented(
1652 cricket::TestTurnCustomizer* turn_customizer) {
1653 unsigned int allow_channel_data_counter =
1654 network_thread()->Invoke<unsigned int>(
1655 RTC_FROM_HERE, [turn_customizer] {
1656 return turn_customizer->allow_channel_data_cnt_;
1657 });
1658 EXPECT_GT(allow_channel_data_counter, 0u);
1659 unsigned int modify_counter = network_thread()->Invoke<unsigned int>(
1660 RTC_FROM_HERE,
1661 [turn_customizer] { return turn_customizer->modify_cnt_; });
1662 EXPECT_GT(modify_counter, 0u);
1663 }
1664
1665 // Once called, SDP blobs and ICE candidates will be automatically signaled
1666 // between PeerConnections.
1667 void ConnectFakeSignaling() {
1668 caller_->set_signaling_message_receiver(callee_.get());
1669 callee_->set_signaling_message_receiver(caller_.get());
1670 }
1671
1672 // Once called, SDP blobs will be automatically signaled between
1673 // PeerConnections. Note that ICE candidates will not be signaled unless they
1674 // are in the exchanged SDP blobs.
1675 void ConnectFakeSignalingForSdpOnly() {
1676 ConnectFakeSignaling();
1677 SetSignalIceCandidates(false);
1678 }
1679
1680 void SetSignalingDelayMs(int delay_ms) {
1681 caller_->set_signaling_delay_ms(delay_ms);
1682 callee_->set_signaling_delay_ms(delay_ms);
1683 }
1684
1685 void SetSignalIceCandidates(bool signal) {
1686 caller_->set_signal_ice_candidates(signal);
1687 callee_->set_signal_ice_candidates(signal);
1688 }
1689
1690 // Messages may get lost on the unreliable DataChannel, so we send multiple
1691 // times to avoid test flakiness.
1692 void SendRtpDataWithRetries(webrtc::DataChannelInterface* dc,
1693 const std::string& data,
1694 int retries) {
1695 for (int i = 0; i < retries; ++i) {
1696 dc->Send(DataBuffer(data));
1697 }
1698 }
1699
1700 rtc::Thread* network_thread() { return network_thread_.get(); }
1701
1702 rtc::VirtualSocketServer* virtual_socket_server() { return ss_.get(); }
1703
1704 PeerConnectionIntegrationWrapper* caller() { return caller_.get(); }
1705
Artem Titov880fa812021-07-30 22:30:23 +02001706 // Set the `caller_` to the `wrapper` passed in and return the
1707 // original `caller_`.
Harald Alvestrand39993842021-02-17 09:05:31 +00001708 PeerConnectionIntegrationWrapper* SetCallerPcWrapperAndReturnCurrent(
1709 PeerConnectionIntegrationWrapper* wrapper) {
1710 PeerConnectionIntegrationWrapper* old = caller_.release();
1711 caller_.reset(wrapper);
1712 return old;
1713 }
1714
1715 PeerConnectionIntegrationWrapper* callee() { return callee_.get(); }
1716
Artem Titov880fa812021-07-30 22:30:23 +02001717 // Set the `callee_` to the `wrapper` passed in and return the
1718 // original `callee_`.
Harald Alvestrand39993842021-02-17 09:05:31 +00001719 PeerConnectionIntegrationWrapper* SetCalleePcWrapperAndReturnCurrent(
1720 PeerConnectionIntegrationWrapper* wrapper) {
1721 PeerConnectionIntegrationWrapper* old = callee_.release();
1722 callee_.reset(wrapper);
1723 return old;
1724 }
1725
1726 void SetPortAllocatorFlags(uint32_t caller_flags, uint32_t callee_flags) {
1727 network_thread()->Invoke<void>(RTC_FROM_HERE, [this, caller_flags] {
1728 caller()->port_allocator()->set_flags(caller_flags);
1729 });
1730 network_thread()->Invoke<void>(RTC_FROM_HERE, [this, callee_flags] {
1731 callee()->port_allocator()->set_flags(callee_flags);
1732 });
1733 }
1734
1735 rtc::FirewallSocketServer* firewall() const { return fss_.get(); }
1736
1737 // Expects the provided number of new frames to be received within
1738 // kMaxWaitForFramesMs. The new expected frames are specified in
Artem Titov880fa812021-07-30 22:30:23 +02001739 // `media_expectations`. Returns false if any of the expectations were
Harald Alvestrand39993842021-02-17 09:05:31 +00001740 // not met.
1741 bool ExpectNewFrames(const MediaExpectations& media_expectations) {
1742 // Make sure there are no bogus tracks confusing the issue.
1743 caller()->RemoveUnusedVideoRenderers();
1744 callee()->RemoveUnusedVideoRenderers();
1745 // First initialize the expected frame counts based upon the current
1746 // frame count.
1747 int total_caller_audio_frames_expected = caller()->audio_frames_received();
1748 if (media_expectations.caller_audio_expectation_ ==
1749 MediaExpectations::kExpectSomeFrames) {
1750 total_caller_audio_frames_expected +=
1751 media_expectations.caller_audio_frames_expected_;
1752 }
1753 int total_caller_video_frames_expected =
1754 caller()->min_video_frames_received_per_track();
1755 if (media_expectations.caller_video_expectation_ ==
1756 MediaExpectations::kExpectSomeFrames) {
1757 total_caller_video_frames_expected +=
1758 media_expectations.caller_video_frames_expected_;
1759 }
1760 int total_callee_audio_frames_expected = callee()->audio_frames_received();
1761 if (media_expectations.callee_audio_expectation_ ==
1762 MediaExpectations::kExpectSomeFrames) {
1763 total_callee_audio_frames_expected +=
1764 media_expectations.callee_audio_frames_expected_;
1765 }
1766 int total_callee_video_frames_expected =
1767 callee()->min_video_frames_received_per_track();
1768 if (media_expectations.callee_video_expectation_ ==
1769 MediaExpectations::kExpectSomeFrames) {
1770 total_callee_video_frames_expected +=
1771 media_expectations.callee_video_frames_expected_;
1772 }
1773
1774 // Wait for the expected frames.
1775 EXPECT_TRUE_WAIT(caller()->audio_frames_received() >=
1776 total_caller_audio_frames_expected &&
1777 caller()->min_video_frames_received_per_track() >=
1778 total_caller_video_frames_expected &&
1779 callee()->audio_frames_received() >=
1780 total_callee_audio_frames_expected &&
1781 callee()->min_video_frames_received_per_track() >=
1782 total_callee_video_frames_expected,
1783 kMaxWaitForFramesMs);
1784 bool expectations_correct =
1785 caller()->audio_frames_received() >=
1786 total_caller_audio_frames_expected &&
1787 caller()->min_video_frames_received_per_track() >=
1788 total_caller_video_frames_expected &&
1789 callee()->audio_frames_received() >=
1790 total_callee_audio_frames_expected &&
1791 callee()->min_video_frames_received_per_track() >=
1792 total_callee_video_frames_expected;
1793
1794 // After the combined wait, print out a more detailed message upon
1795 // failure.
1796 EXPECT_GE(caller()->audio_frames_received(),
1797 total_caller_audio_frames_expected);
1798 EXPECT_GE(caller()->min_video_frames_received_per_track(),
1799 total_caller_video_frames_expected);
1800 EXPECT_GE(callee()->audio_frames_received(),
1801 total_callee_audio_frames_expected);
1802 EXPECT_GE(callee()->min_video_frames_received_per_track(),
1803 total_callee_video_frames_expected);
1804
1805 // We want to make sure nothing unexpected was received.
1806 if (media_expectations.caller_audio_expectation_ ==
1807 MediaExpectations::kExpectNoFrames) {
1808 EXPECT_EQ(caller()->audio_frames_received(),
1809 total_caller_audio_frames_expected);
1810 if (caller()->audio_frames_received() !=
1811 total_caller_audio_frames_expected) {
1812 expectations_correct = false;
1813 }
1814 }
1815 if (media_expectations.caller_video_expectation_ ==
1816 MediaExpectations::kExpectNoFrames) {
1817 EXPECT_EQ(caller()->min_video_frames_received_per_track(),
1818 total_caller_video_frames_expected);
1819 if (caller()->min_video_frames_received_per_track() !=
1820 total_caller_video_frames_expected) {
1821 expectations_correct = false;
1822 }
1823 }
1824 if (media_expectations.callee_audio_expectation_ ==
1825 MediaExpectations::kExpectNoFrames) {
1826 EXPECT_EQ(callee()->audio_frames_received(),
1827 total_callee_audio_frames_expected);
1828 if (callee()->audio_frames_received() !=
1829 total_callee_audio_frames_expected) {
1830 expectations_correct = false;
1831 }
1832 }
1833 if (media_expectations.callee_video_expectation_ ==
1834 MediaExpectations::kExpectNoFrames) {
1835 EXPECT_EQ(callee()->min_video_frames_received_per_track(),
1836 total_callee_video_frames_expected);
1837 if (callee()->min_video_frames_received_per_track() !=
1838 total_callee_video_frames_expected) {
1839 expectations_correct = false;
1840 }
1841 }
1842 return expectations_correct;
1843 }
1844
1845 void ClosePeerConnections() {
Tomas Gunnarsson2efb8a52021-04-01 16:26:57 +02001846 if (caller())
1847 caller()->pc()->Close();
1848 if (callee())
1849 callee()->pc()->Close();
Harald Alvestrand39993842021-02-17 09:05:31 +00001850 }
1851
1852 void TestNegotiatedCipherSuite(
1853 const PeerConnectionFactory::Options& caller_options,
1854 const PeerConnectionFactory::Options& callee_options,
1855 int expected_cipher_suite) {
1856 ASSERT_TRUE(CreatePeerConnectionWrappersWithOptions(caller_options,
1857 callee_options));
1858 ConnectFakeSignaling();
1859 caller()->AddAudioVideoTracks();
1860 callee()->AddAudioVideoTracks();
1861 caller()->CreateAndSetAndSignalOffer();
1862 ASSERT_TRUE_WAIT(DtlsConnected(), kDefaultTimeout);
1863 EXPECT_EQ_WAIT(rtc::SrtpCryptoSuiteToName(expected_cipher_suite),
1864 caller()->OldGetStats()->SrtpCipher(), kDefaultTimeout);
1865 // TODO(bugs.webrtc.org/9456): Fix it.
1866 EXPECT_METRIC_EQ(1, webrtc::metrics::NumEvents(
1867 "WebRTC.PeerConnection.SrtpCryptoSuite.Audio",
1868 expected_cipher_suite));
1869 }
1870
1871 void TestGcmNegotiationUsesCipherSuite(bool local_gcm_enabled,
1872 bool remote_gcm_enabled,
1873 bool aes_ctr_enabled,
1874 int expected_cipher_suite) {
1875 PeerConnectionFactory::Options caller_options;
1876 caller_options.crypto_options.srtp.enable_gcm_crypto_suites =
1877 local_gcm_enabled;
1878 caller_options.crypto_options.srtp.enable_aes128_sha1_80_crypto_cipher =
1879 aes_ctr_enabled;
1880 PeerConnectionFactory::Options callee_options;
1881 callee_options.crypto_options.srtp.enable_gcm_crypto_suites =
1882 remote_gcm_enabled;
1883 callee_options.crypto_options.srtp.enable_aes128_sha1_80_crypto_cipher =
1884 aes_ctr_enabled;
1885 TestNegotiatedCipherSuite(caller_options, callee_options,
1886 expected_cipher_suite);
1887 }
1888
Jonas Orelande62c2f22022-03-29 11:04:48 +02001889 const FieldTrialsView& trials() const { return *field_trials_.get(); }
Jonas Orelanded99dae2022-03-09 09:28:10 +01001890
Harald Alvestrand39993842021-02-17 09:05:31 +00001891 protected:
1892 SdpSemantics sdp_semantics_;
1893
1894 private:
Artem Titov880fa812021-07-30 22:30:23 +02001895 // `ss_` is used by `network_thread_` so it must be destroyed later.
Harald Alvestrand39993842021-02-17 09:05:31 +00001896 std::unique_ptr<rtc::VirtualSocketServer> ss_;
1897 std::unique_ptr<rtc::FirewallSocketServer> fss_;
Artem Titov880fa812021-07-30 22:30:23 +02001898 // `network_thread_` and `worker_thread_` are used by both
1899 // `caller_` and `callee_` so they must be destroyed
Harald Alvestrand39993842021-02-17 09:05:31 +00001900 // later.
1901 std::unique_ptr<rtc::Thread> network_thread_;
1902 std::unique_ptr<rtc::Thread> worker_thread_;
1903 // The turn servers and turn customizers should be accessed & deleted on the
1904 // network thread to avoid a race with the socket read/write that occurs
1905 // on the network thread.
1906 std::vector<std::unique_ptr<cricket::TestTurnServer>> turn_servers_;
1907 std::vector<std::unique_ptr<cricket::TestTurnCustomizer>> turn_customizers_;
1908 std::unique_ptr<PeerConnectionIntegrationWrapper> caller_;
1909 std::unique_ptr<PeerConnectionIntegrationWrapper> callee_;
Jonas Orelande62c2f22022-03-29 11:04:48 +02001910 std::unique_ptr<FieldTrialsView> field_trials_;
Harald Alvestrand39993842021-02-17 09:05:31 +00001911};
1912
1913} // namespace webrtc
1914
1915#endif // PC_TEST_INTEGRATION_TEST_HELPERS_H_