Add base fixture and PeerConnection wrapper for unit tests
This lays the groundwork for splitting up the
PeerConnectionInterface unit tests into multiple files so that
the tests can be organized better. The intent is for each unit
test file to declare a test fixture which subclasses
PeerConnectionUnitTestFixture and creates PeerConnectionWrappers
to write assertions against.
Bug: webrtc:8222
Change-Id: I21175b1e1828a6cd5012305a8a27faaf4eecf81c
Reviewed-on: https://webrtc-review.googlesource.com/1120
Commit-Queue: Steve Anton <steveanton@webrtc.org>
Reviewed-by: Taylor Brandstetter <deadbeef@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#20004}diff --git a/pc/peerconnectionwrapper.h b/pc/peerconnectionwrapper.h
new file mode 100644
index 0000000..83b8186
--- /dev/null
+++ b/pc/peerconnectionwrapper.h
@@ -0,0 +1,108 @@
+/*
+ * Copyright 2017 The WebRTC project authors. All Rights Reserved.
+ *
+ * Use of this source code is governed by a BSD-style license
+ * that can be found in the LICENSE file in the root of the source
+ * tree. An additional intellectual property rights grant can be found
+ * in the file PATENTS. All contributing project authors may
+ * be found in the AUTHORS file in the root of the source tree.
+ */
+
+#ifndef PC_PEERCONNECTIONWRAPPER_H_
+#define PC_PEERCONNECTIONWRAPPER_H_
+
+#include <functional>
+#include <memory>
+#include <string>
+
+#include "api/peerconnectioninterface.h"
+#include "pc/test/mockpeerconnectionobservers.h"
+
+namespace webrtc {
+
+// Class that wraps a PeerConnection so that it is easier to use in unit tests.
+// Namely, gives a synchronous API for the event-callback-based API of
+// PeerConnection and provides an observer object that stores information from
+// PeerConnectionObserver callbacks.
+//
+// This is intended to be subclassed if additional information needs to be
+// stored with the PeerConnection (e.g., fake PeerConnection parameters so that
+// tests can be written against those interactions). The base
+// PeerConnectionWrapper should only have helper methods that are broadly
+// useful. More specific helper methods should be created in the test-specific
+// subclass.
+//
+// The wrapper is intended to be constructed by specialized factory methods on
+// a test fixture class then used as a local variable in each test case.
+class PeerConnectionWrapper {
+ public:
+ // Constructs a PeerConnectionWrapper from the given PeerConnection.
+ // The given PeerConnectionFactory should be the factory that created the
+ // PeerConnection and the MockPeerConnectionObserver should be the observer
+ // that is watching the PeerConnection.
+ PeerConnectionWrapper(
+ rtc::scoped_refptr<PeerConnectionFactoryInterface> pc_factory,
+ rtc::scoped_refptr<PeerConnectionInterface> pc,
+ std::unique_ptr<MockPeerConnectionObserver> observer);
+ virtual ~PeerConnectionWrapper();
+
+ PeerConnectionFactoryInterface* pc_factory();
+ PeerConnectionInterface* pc();
+ MockPeerConnectionObserver* observer();
+
+ // Calls the underlying PeerConnection's CreateOffer method and returns the
+ // resulting SessionDescription once it is available. If the method call
+ // failed, null is returned.
+ std::unique_ptr<SessionDescriptionInterface> CreateOffer(
+ const PeerConnectionInterface::RTCOfferAnswerOptions& options);
+ // Calls CreateOffer with default options.
+ std::unique_ptr<SessionDescriptionInterface> CreateOffer();
+ // Calls CreateOffer and sets a copy of the offer as the local description.
+ std::unique_ptr<SessionDescriptionInterface> CreateOfferAndSetAsLocal();
+
+ // Calls the underlying PeerConnection's CreateAnswer method and returns the
+ // resulting SessionDescription once it is available. If the method call
+ // failed, null is returned.
+ std::unique_ptr<SessionDescriptionInterface> CreateAnswer(
+ const PeerConnectionInterface::RTCOfferAnswerOptions& options);
+ // Calls CreateAnswer with the default options.
+ std::unique_ptr<SessionDescriptionInterface> CreateAnswer();
+ // Calls CreateAnswer and sets a copy of the offer as the local description.
+ std::unique_ptr<SessionDescriptionInterface> CreateAnswerAndSetAsLocal();
+
+ // Calls the underlying PeerConnection's SetLocalDescription method with the
+ // given session description and waits for the success/failure response.
+ // Returns true if the description was successfully set.
+ bool SetLocalDescription(std::unique_ptr<SessionDescriptionInterface> desc);
+ // Calls the underlying PeerConnection's SetRemoteDescription method with the
+ // given session description and waits for the success/failure response.
+ // Returns true if the description was successfully set.
+ bool SetRemoteDescription(std::unique_ptr<SessionDescriptionInterface> desc);
+
+ // Adds a new stream with one audio track to the underlying PeerConnection.
+ void AddAudioStream(const std::string& stream_label,
+ const std::string& track_label);
+ // Adds a new stream with one video track to the underlying PeerConnection.
+ void AddVideoStream(const std::string& stream_label,
+ const std::string& track_label);
+ // Adds a new stream with one audio and one video track to the underlying
+ // PeerConnection.
+ void AddAudioVideoStream(const std::string& stream_label,
+ const std::string& audio_track_label,
+ const std::string& video_track_label);
+
+ private:
+ std::unique_ptr<SessionDescriptionInterface> CreateSdp(
+ std::function<void(CreateSessionDescriptionObserver*)> fn);
+ bool SetSdp(std::function<void(SetSessionDescriptionObserver*)> fn);
+ std::unique_ptr<SessionDescriptionInterface> CloneSessionDescription(
+ const SessionDescriptionInterface* desc);
+
+ rtc::scoped_refptr<PeerConnectionFactoryInterface> pc_factory_;
+ rtc::scoped_refptr<PeerConnectionInterface> pc_;
+ std::unique_ptr<MockPeerConnectionObserver> observer_;
+};
+
+} // namespace webrtc
+
+#endif // PC_PEERCONNECTIONWRAPPER_H_
