Files
platform-external-webrtc/pc/jsepsessiondescription_unittest.cc
Steve Anton 06817cd973 [Unified Plan] Support legacy endpoints that do not use a=mid
These legacy endpoints were supported with Plan B since the SDP
parser would fill in default MID values if a=mid was absent that
happened to match the default offered MIDs.

With Unified Plan, these default MIDs changed so the autofilled
MIDs do not match any more.

This CL adds information to the SessionDescription struct to
indicate whether or not a=mid was present and modified
PeerConnection::SetRemoteDescription to copy MIDs from the local
description if the a=mid lines are not present.

Bug: webrtc:9540
Change-Id: Ibf923b4ad59edb0facd06ddbd01cc10c62fc48e6
Reviewed-on: https://webrtc-review.googlesource.com/c/114820
Commit-Queue: Steve Anton <steveanton@webrtc.org>
Reviewed-by: Amit Hilbuch <amithi@webrtc.org>
Reviewed-by: Seth Hampson <shampson@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#26054}
2018-12-19 01:01:59 +00:00

433 lines
18 KiB
C++

/*
* Copyright 2012 The WebRTC project authors. All Rights Reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#include <stddef.h>
#include <stdint.h>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "absl/memory/memory.h"
#include "api/candidate.h"
#include "api/jsep.h"
#include "api/jsepicecandidate.h"
#include "api/jsepsessiondescription.h"
#include "media/base/codec.h"
#include "p2p/base/p2pconstants.h"
#include "p2p/base/port.h"
#include "p2p/base/transportdescription.h"
#include "p2p/base/transportinfo.h"
#include "pc/sessiondescription.h"
#include "pc/webrtcsdp.h"
#include "rtc_base/helpers.h"
#include "rtc_base/socketaddress.h"
#include "rtc_base/stringencode.h"
#include "test/gtest.h"
using cricket::MediaProtocolType;
using ::testing::Values;
using webrtc::IceCandidateCollection;
using webrtc::IceCandidateInterface;
using webrtc::JsepIceCandidate;
using webrtc::JsepSessionDescription;
using webrtc::SdpType;
using webrtc::SessionDescriptionInterface;
static const char kCandidateUfrag[] = "ufrag";
static const char kCandidatePwd[] = "pwd";
static const char kCandidateUfragVoice[] = "ufrag_voice";
static const char kCandidatePwdVoice[] = "pwd_voice";
static const char kCandidateUfragVideo[] = "ufrag_video";
static const char kCandidatePwdVideo[] = "pwd_video";
static const char kCandidateFoundation[] = "a0+B/1";
static const uint32_t kCandidatePriority = 2130706432U; // pref = 1.0
static const uint32_t kCandidateGeneration = 2;
// This creates a session description with both audio and video media contents.
// In SDP this is described by two m lines, one audio and one video.
static cricket::SessionDescription* CreateCricketSessionDescription() {
cricket::SessionDescription* desc(new cricket::SessionDescription());
// AudioContentDescription
std::unique_ptr<cricket::AudioContentDescription> audio(
new cricket::AudioContentDescription());
// VideoContentDescription
std::unique_ptr<cricket::VideoContentDescription> video(
new cricket::VideoContentDescription());
audio->AddCodec(cricket::AudioCodec(103, "ISAC", 16000, 0, 0));
desc->AddContent(cricket::CN_AUDIO, MediaProtocolType::kRtp, audio.release());
video->AddCodec(cricket::VideoCodec(120, "VP8"));
desc->AddContent(cricket::CN_VIDEO, MediaProtocolType::kRtp, video.release());
desc->AddTransportInfo(cricket::TransportInfo(
cricket::CN_AUDIO,
cricket::TransportDescription(
std::vector<std::string>(), kCandidateUfragVoice, kCandidatePwdVoice,
cricket::ICEMODE_FULL, cricket::CONNECTIONROLE_NONE, NULL)));
desc->AddTransportInfo(cricket::TransportInfo(
cricket::CN_VIDEO,
cricket::TransportDescription(
std::vector<std::string>(), kCandidateUfragVideo, kCandidatePwdVideo,
cricket::ICEMODE_FULL, cricket::CONNECTIONROLE_NONE, NULL)));
return desc;
}
class JsepSessionDescriptionTest : public testing::Test {
protected:
virtual void SetUp() {
int port = 1234;
rtc::SocketAddress address("127.0.0.1", port++);
cricket::Candidate candidate(cricket::ICE_CANDIDATE_COMPONENT_RTP, "udp",
address, 1, "", "", "local", 0, "1");
candidate_ = candidate;
const std::string session_id = rtc::ToString(rtc::CreateRandomId64());
const std::string session_version = rtc::ToString(rtc::CreateRandomId());
jsep_desc_ = absl::make_unique<JsepSessionDescription>(SdpType::kOffer);
ASSERT_TRUE(jsep_desc_->Initialize(CreateCricketSessionDescription(),
session_id, session_version));
}
std::string Serialize(const SessionDescriptionInterface* desc) {
std::string sdp;
EXPECT_TRUE(desc->ToString(&sdp));
EXPECT_FALSE(sdp.empty());
return sdp;
}
std::unique_ptr<SessionDescriptionInterface> DeSerialize(
const std::string& sdp) {
auto jsep_desc = absl::make_unique<JsepSessionDescription>(SdpType::kOffer);
EXPECT_TRUE(webrtc::SdpDeserialize(sdp, jsep_desc.get(), nullptr));
return std::move(jsep_desc);
}
cricket::Candidate candidate_;
std::unique_ptr<JsepSessionDescription> jsep_desc_;
};
// Test that number_of_mediasections() returns the number of media contents in
// a session description.
TEST_F(JsepSessionDescriptionTest, CheckSessionDescription) {
EXPECT_EQ(2u, jsep_desc_->number_of_mediasections());
}
// Test that we can add a candidate to a session description without MID.
TEST_F(JsepSessionDescriptionTest, AddCandidateWithoutMid) {
JsepIceCandidate jsep_candidate("", 0, candidate_);
EXPECT_TRUE(jsep_desc_->AddCandidate(&jsep_candidate));
const IceCandidateCollection* ice_candidates = jsep_desc_->candidates(0);
ASSERT_TRUE(ice_candidates != NULL);
EXPECT_EQ(1u, ice_candidates->count());
const IceCandidateInterface* ice_candidate = ice_candidates->at(0);
ASSERT_TRUE(ice_candidate != NULL);
candidate_.set_username(kCandidateUfragVoice);
candidate_.set_password(kCandidatePwdVoice);
EXPECT_TRUE(ice_candidate->candidate().IsEquivalent(candidate_));
EXPECT_EQ(0, ice_candidate->sdp_mline_index());
EXPECT_EQ(0u, jsep_desc_->candidates(1)->count());
}
// Test that we can add and remove candidates to a session description with
// MID. Removing candidates requires MID (transport_name).
TEST_F(JsepSessionDescriptionTest, AddAndRemoveCandidatesWithMid) {
// mid and m-line index don't match, in this case mid is preferred.
std::string mid = "video";
JsepIceCandidate jsep_candidate(mid, 0, candidate_);
EXPECT_TRUE(jsep_desc_->AddCandidate(&jsep_candidate));
EXPECT_EQ(0u, jsep_desc_->candidates(0)->count());
const IceCandidateCollection* ice_candidates = jsep_desc_->candidates(1);
ASSERT_TRUE(ice_candidates != NULL);
EXPECT_EQ(1u, ice_candidates->count());
const IceCandidateInterface* ice_candidate = ice_candidates->at(0);
ASSERT_TRUE(ice_candidate != NULL);
candidate_.set_username(kCandidateUfragVideo);
candidate_.set_password(kCandidatePwdVideo);
EXPECT_TRUE(ice_candidate->candidate().IsEquivalent(candidate_));
// The mline index should have been updated according to mid.
EXPECT_EQ(1, ice_candidate->sdp_mline_index());
std::vector<cricket::Candidate> candidates(1, candidate_);
candidates[0].set_transport_name(mid);
EXPECT_EQ(1u, jsep_desc_->RemoveCandidates(candidates));
EXPECT_EQ(0u, jsep_desc_->candidates(0)->count());
EXPECT_EQ(0u, jsep_desc_->candidates(1)->count());
}
TEST_F(JsepSessionDescriptionTest, AddCandidateAlreadyHasUfrag) {
candidate_.set_username(kCandidateUfrag);
candidate_.set_password(kCandidatePwd);
JsepIceCandidate jsep_candidate("audio", 0, candidate_);
EXPECT_TRUE(jsep_desc_->AddCandidate(&jsep_candidate));
const IceCandidateCollection* ice_candidates = jsep_desc_->candidates(0);
ASSERT_TRUE(ice_candidates != NULL);
EXPECT_EQ(1u, ice_candidates->count());
const IceCandidateInterface* ice_candidate = ice_candidates->at(0);
ASSERT_TRUE(ice_candidate != NULL);
candidate_.set_username(kCandidateUfrag);
candidate_.set_password(kCandidatePwd);
EXPECT_TRUE(ice_candidate->candidate().IsEquivalent(candidate_));
EXPECT_EQ(0u, jsep_desc_->candidates(1)->count());
}
// Test that we can not add a candidate if there is no corresponding media
// content in the session description.
TEST_F(JsepSessionDescriptionTest, AddBadCandidate) {
JsepIceCandidate bad_candidate1("", 55, candidate_);
EXPECT_FALSE(jsep_desc_->AddCandidate(&bad_candidate1));
JsepIceCandidate bad_candidate2("some weird mid", 0, candidate_);
EXPECT_FALSE(jsep_desc_->AddCandidate(&bad_candidate2));
}
// Tests that repeatedly adding the same candidate, with or without credentials,
// does not increase the number of candidates in the description.
TEST_F(JsepSessionDescriptionTest, AddCandidateDuplicates) {
JsepIceCandidate jsep_candidate("", 0, candidate_);
EXPECT_TRUE(jsep_desc_->AddCandidate(&jsep_candidate));
EXPECT_EQ(1u, jsep_desc_->candidates(0)->count());
// Add the same candidate again. It should be ignored.
EXPECT_TRUE(jsep_desc_->AddCandidate(&jsep_candidate));
EXPECT_EQ(1u, jsep_desc_->candidates(0)->count());
// Create a new candidate, identical except that the ufrag and pwd are now
// populated.
candidate_.set_username(kCandidateUfragVoice);
candidate_.set_password(kCandidatePwdVoice);
JsepIceCandidate jsep_candidate_with_credentials("", 0, candidate_);
// This should also be identified as redundant and ignored.
EXPECT_TRUE(jsep_desc_->AddCandidate(&jsep_candidate_with_credentials));
EXPECT_EQ(1u, jsep_desc_->candidates(0)->count());
}
// Test that we can serialize a JsepSessionDescription and deserialize it again.
TEST_F(JsepSessionDescriptionTest, SerializeDeserialize) {
std::string sdp = Serialize(jsep_desc_.get());
auto parsed_jsep_desc = DeSerialize(sdp);
EXPECT_EQ(2u, parsed_jsep_desc->number_of_mediasections());
std::string parsed_sdp = Serialize(parsed_jsep_desc.get());
EXPECT_EQ(sdp, parsed_sdp);
}
// Tests that we can serialize and deserialize a JsepSesssionDescription
// with candidates.
TEST_F(JsepSessionDescriptionTest, SerializeDeserializeWithCandidates) {
std::string sdp = Serialize(jsep_desc_.get());
// Add a candidate and check that the serialized result is different.
JsepIceCandidate jsep_candidate("audio", 0, candidate_);
EXPECT_TRUE(jsep_desc_->AddCandidate(&jsep_candidate));
std::string sdp_with_candidate = Serialize(jsep_desc_.get());
EXPECT_NE(sdp, sdp_with_candidate);
auto parsed_jsep_desc = DeSerialize(sdp_with_candidate);
std::string parsed_sdp_with_candidate = Serialize(parsed_jsep_desc.get());
EXPECT_EQ(sdp_with_candidate, parsed_sdp_with_candidate);
}
// TODO(zhihuang): Modify these tests. These are used to verify that after
// adding the candidates, the connection_address field is set correctly. Modify
// those so that the "connection address" is tested directly.
// Tests serialization of SDP with only IPv6 candidates and verifies that IPv6
// is used as default address in c line according to preference.
TEST_F(JsepSessionDescriptionTest, SerializeSessionDescriptionWithIPv6Only) {
// Stun has a high preference than local host.
cricket::Candidate candidate1(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "udp",
rtc::SocketAddress("::1", 1234), kCandidatePriority, "", "",
cricket::STUN_PORT_TYPE, kCandidateGeneration, kCandidateFoundation);
cricket::Candidate candidate2(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "udp",
rtc::SocketAddress("::2", 1235), kCandidatePriority, "", "",
cricket::LOCAL_PORT_TYPE, kCandidateGeneration, kCandidateFoundation);
JsepIceCandidate jice1("audio", 0, candidate1);
JsepIceCandidate jice2("audio", 0, candidate2);
JsepIceCandidate jice3("video", 0, candidate1);
JsepIceCandidate jice4("video", 0, candidate2);
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice1));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice2));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice3));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice4));
std::string message = Serialize(jsep_desc_.get());
// Should have a c line like this one.
EXPECT_NE(message.find("c=IN IP6 ::1"), std::string::npos);
// Shouldn't have a IP4 c line.
EXPECT_EQ(message.find("c=IN IP4"), std::string::npos);
}
// Tests serialization of SDP with both IPv4 and IPv6 candidates and
// verifies that IPv4 is used as default address in c line even if the
// preference of IPv4 is lower.
TEST_F(JsepSessionDescriptionTest,
SerializeSessionDescriptionWithBothIPFamilies) {
cricket::Candidate candidate_v4(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "udp",
rtc::SocketAddress("192.168.1.5", 1234), kCandidatePriority, "", "",
cricket::STUN_PORT_TYPE, kCandidateGeneration, kCandidateFoundation);
cricket::Candidate candidate_v6(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "udp",
rtc::SocketAddress("::1", 1234), kCandidatePriority, "", "",
cricket::LOCAL_PORT_TYPE, kCandidateGeneration, kCandidateFoundation);
JsepIceCandidate jice_v4("audio", 0, candidate_v4);
JsepIceCandidate jice_v6("audio", 0, candidate_v6);
JsepIceCandidate jice_v4_video("video", 0, candidate_v4);
JsepIceCandidate jice_v6_video("video", 0, candidate_v6);
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice_v4));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice_v6));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice_v4_video));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice_v6_video));
std::string message = Serialize(jsep_desc_.get());
// Should have a c line like this one.
EXPECT_NE(message.find("c=IN IP4 192.168.1.5"), std::string::npos);
// Shouldn't have a IP6 c line.
EXPECT_EQ(message.find("c=IN IP6"), std::string::npos);
}
// Tests serialization of SDP with both UDP and TCP candidates and
// verifies that UDP is used as default address in c line even if the
// preference of UDP is lower.
TEST_F(JsepSessionDescriptionTest,
SerializeSessionDescriptionWithBothProtocols) {
// Stun has a high preference than local host.
cricket::Candidate candidate1(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "tcp",
rtc::SocketAddress("::1", 1234), kCandidatePriority, "", "",
cricket::STUN_PORT_TYPE, kCandidateGeneration, kCandidateFoundation);
cricket::Candidate candidate2(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "udp",
rtc::SocketAddress("fe80::1234:5678:abcd:ef12", 1235), kCandidatePriority,
"", "", cricket::LOCAL_PORT_TYPE, kCandidateGeneration,
kCandidateFoundation);
JsepIceCandidate jice1("audio", 0, candidate1);
JsepIceCandidate jice2("audio", 0, candidate2);
JsepIceCandidate jice3("video", 0, candidate1);
JsepIceCandidate jice4("video", 0, candidate2);
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice1));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice2));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice3));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice4));
std::string message = Serialize(jsep_desc_.get());
// Should have a c line like this one.
EXPECT_NE(message.find("c=IN IP6 fe80::1234:5678:abcd:ef12"),
std::string::npos);
// Shouldn't have a IP4 c line.
EXPECT_EQ(message.find("c=IN IP4"), std::string::npos);
}
// Tests serialization of SDP with only TCP candidates and verifies that
// null IPv4 is used as default address in c line.
TEST_F(JsepSessionDescriptionTest, SerializeSessionDescriptionWithTCPOnly) {
// Stun has a high preference than local host.
cricket::Candidate candidate1(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "tcp",
rtc::SocketAddress("::1", 1234), kCandidatePriority, "", "",
cricket::STUN_PORT_TYPE, kCandidateGeneration, kCandidateFoundation);
cricket::Candidate candidate2(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "tcp",
rtc::SocketAddress("::2", 1235), kCandidatePriority, "", "",
cricket::LOCAL_PORT_TYPE, kCandidateGeneration, kCandidateFoundation);
JsepIceCandidate jice1("audio", 0, candidate1);
JsepIceCandidate jice2("audio", 0, candidate2);
JsepIceCandidate jice3("video", 0, candidate1);
JsepIceCandidate jice4("video", 0, candidate2);
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice1));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice2));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice3));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice4));
std::string message = Serialize(jsep_desc_.get());
EXPECT_EQ(message.find("c=IN IP6 ::3"), std::string::npos);
// Should have a c line like this one when no any default exists.
EXPECT_NE(message.find("c=IN IP4 0.0.0.0"), std::string::npos);
}
// Tests that the connection address will be correctly set when the Candidate is
// removed.
TEST_F(JsepSessionDescriptionTest, RemoveCandidateAndSetConnectionAddress) {
cricket::Candidate candidate1(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "udp",
rtc::SocketAddress("::1", 1234), kCandidatePriority, "", "",
cricket::LOCAL_PORT_TYPE, kCandidateGeneration, kCandidateFoundation);
candidate1.set_transport_name("audio");
cricket::Candidate candidate2(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "tcp",
rtc::SocketAddress("::2", 1235), kCandidatePriority, "", "",
cricket::LOCAL_PORT_TYPE, kCandidateGeneration, kCandidateFoundation);
candidate2.set_transport_name("audio");
cricket::Candidate candidate3(
cricket::ICE_CANDIDATE_COMPONENT_RTP, "udp",
rtc::SocketAddress("192.168.1.1", 1236), kCandidatePriority, "", "",
cricket::LOCAL_PORT_TYPE, kCandidateGeneration, kCandidateFoundation);
candidate3.set_transport_name("audio");
JsepIceCandidate jice1("audio", 0, candidate1);
JsepIceCandidate jice2("audio", 0, candidate2);
JsepIceCandidate jice3("audio", 0, candidate3);
size_t audio_index = 0;
auto media_desc =
jsep_desc_->description()->contents()[audio_index].media_description();
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice1));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice2));
ASSERT_TRUE(jsep_desc_->AddCandidate(&jice3));
std::vector<cricket::Candidate> candidates;
EXPECT_EQ("192.168.1.1:1236", media_desc->connection_address().ToString());
candidates.push_back(candidate3);
ASSERT_TRUE(jsep_desc_->RemoveCandidates(candidates));
EXPECT_EQ("[::1]:1234", media_desc->connection_address().ToString());
candidates.clear();
candidates.push_back(candidate2);
ASSERT_TRUE(jsep_desc_->RemoveCandidates(candidates));
EXPECT_EQ("[::1]:1234", media_desc->connection_address().ToString());
candidates.clear();
candidates.push_back(candidate1);
ASSERT_TRUE(jsep_desc_->RemoveCandidates(candidates));
EXPECT_EQ("0.0.0.0:9", media_desc->connection_address().ToString());
}
class EnumerateAllSdpTypesTest : public ::testing::Test,
public ::testing::WithParamInterface<SdpType> {
};
TEST_P(EnumerateAllSdpTypesTest, TestIdentity) {
SdpType type = GetParam();
const char* str = webrtc::SdpTypeToString(type);
EXPECT_EQ(type, webrtc::SdpTypeFromString(str));
}
INSTANTIATE_TEST_CASE_P(JsepSessionDescriptionTest,
EnumerateAllSdpTypesTest,
Values(SdpType::kOffer,
SdpType::kPrAnswer,
SdpType::kAnswer));