blob: 860f3ead053285f5bae38497430ff75a9b95c16e [file] [log] [blame] [edit]
/*
* 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.
*/
#include "api/rtc_error.h"
#include <string>
#include <utility>
#include "absl/strings/str_cat.h"
#include "absl/strings/string_view.h"
#include "rtc_base/checks.h"
#include "test/gtest.h"
namespace webrtc {
namespace {
constexpr int kDefaultMoveOnlyIntValue = 0xbadf00d;
// Class that has no copy constructor, ensuring that RTCErrorOr can
struct MoveOnlyInt {
MoveOnlyInt() {}
explicit MoveOnlyInt(int value) : value(value) {}
MoveOnlyInt(const MoveOnlyInt& other) = delete;
MoveOnlyInt& operator=(const MoveOnlyInt& other) = delete;
MoveOnlyInt(MoveOnlyInt&& other) : value(other.value) {}
MoveOnlyInt& operator=(MoveOnlyInt&& other) {
value = other.value;
return *this;
}
int value = kDefaultMoveOnlyIntValue;
};
// Same as above. Used to test conversion from RTCErrorOr<A> to RTCErrorOr<B>
// when A can be converted to B.
struct MoveOnlyInt2 {
MoveOnlyInt2() {}
explicit MoveOnlyInt2(int value) : value(value) {}
MoveOnlyInt2(const MoveOnlyInt2& other) = delete;
MoveOnlyInt2& operator=(const MoveOnlyInt2& other) = delete;
MoveOnlyInt2(MoveOnlyInt2&& other) : value(other.value) {}
MoveOnlyInt2& operator=(MoveOnlyInt2&& other) {
value = other.value;
return *this;
}
explicit MoveOnlyInt2(MoveOnlyInt&& other) : value(other.value) {}
MoveOnlyInt2& operator=(MoveOnlyInt&& other) {
value = other.value;
return *this;
}
int value = kDefaultMoveOnlyIntValue;
};
// Test that the default constructor creates a "no error" error.
TEST(RTCErrorTest, DefaultConstructor) {
RTCError e;
EXPECT_EQ(e.type(), RTCErrorType::NONE);
EXPECT_STREQ(e.message(), "");
EXPECT_TRUE(e.ok());
}
TEST(RTCErrorTest, NormalConstructors) {
RTCError a(RTCErrorType::INVALID_PARAMETER);
EXPECT_EQ(a.type(), RTCErrorType::INVALID_PARAMETER);
EXPECT_STREQ(a.message(), "");
// Constructor that takes const char* message.
RTCError b(RTCErrorType::UNSUPPORTED_PARAMETER, "foobar");
EXPECT_EQ(b.type(), RTCErrorType::UNSUPPORTED_PARAMETER);
EXPECT_STREQ(b.message(), "foobar");
// Constructor that takes absl::string_view message.
RTCError c(RTCErrorType::SYNTAX_ERROR, absl::string_view("baz"));
EXPECT_EQ(c.type(), RTCErrorType::SYNTAX_ERROR);
EXPECT_STREQ(c.message(), "baz");
// Constructor that takes std::string message.
RTCError d(RTCErrorType::INVALID_RANGE, std::string("new"));
EXPECT_EQ(d.type(), RTCErrorType::INVALID_RANGE);
EXPECT_STREQ(d.message(), "new");
}
TEST(RTCErrorTest, MoveConstructor) {
// Static string.
RTCError a(RTCErrorType::INVALID_PARAMETER, "foo");
RTCError b(std::move(a));
EXPECT_EQ(b.type(), RTCErrorType::INVALID_PARAMETER);
EXPECT_STREQ(b.message(), "foo");
// Non-static string.
RTCError c(RTCErrorType::UNSUPPORTED_PARAMETER, std::string("bar"));
RTCError d(std::move(c));
EXPECT_EQ(d.type(), RTCErrorType::UNSUPPORTED_PARAMETER);
EXPECT_STREQ(d.message(), "bar");
}
TEST(RTCErrorTest, MoveAssignment) {
// Try all combinations of "is static string"/"is non-static string" moves.
RTCError e(RTCErrorType::INVALID_PARAMETER, "foo");
e = RTCError(RTCErrorType::UNSUPPORTED_PARAMETER, "bar");
EXPECT_EQ(e.type(), RTCErrorType::UNSUPPORTED_PARAMETER);
EXPECT_STREQ(e.message(), "bar");
e = RTCError(RTCErrorType::SYNTAX_ERROR, absl::string_view("baz"));
EXPECT_STREQ(e.message(), "baz");
e = RTCError(RTCErrorType::SYNTAX_ERROR, std::string("another"));
EXPECT_STREQ(e.message(), "another");
}
// Test that the error returned by RTCError::OK() is a "no error" error.
TEST(RTCErrorTest, OKConstant) {
RTCError ok = RTCError::OK();
EXPECT_EQ(ok.type(), RTCErrorType::NONE);
EXPECT_STREQ(ok.message(), "");
EXPECT_TRUE(ok.ok());
}
// Test that "error.ok()" behaves as expected.
TEST(RTCErrorTest, OkMethod) {
RTCError success;
RTCError failure(RTCErrorType::INTERNAL_ERROR);
EXPECT_TRUE(success.ok());
EXPECT_FALSE(failure.ok());
}
// Test that a message can be set using either static const strings or
// std::strings.
TEST(RTCErrorTest, SetMessage) {
RTCError e;
e.set_message("foo");
EXPECT_STREQ(e.message(), "foo");
e.set_message(absl::string_view("bar"));
EXPECT_STREQ(e.message(), "bar");
e.set_message(std::string("string"));
EXPECT_STREQ(e.message(), "string");
}
TEST(RTCErrorTest, Stringify) {
RTCError e(RTCErrorType::INVALID_PARAMETER, "foo");
EXPECT_EQ(absl::StrCat(e), "INVALID_PARAMETER with message: \"foo\"");
}
// Test that the default constructor creates an "INTERNAL_ERROR".
TEST(RTCErrorOrTest, DefaultConstructor) {
RTCErrorOr<MoveOnlyInt> e;
EXPECT_EQ(e.error().type(), RTCErrorType::INTERNAL_ERROR);
}
// Test that an RTCErrorOr can be implicitly constructed from a value.
TEST(RTCErrorOrTest, ImplicitValueConstructor) {
RTCErrorOr<MoveOnlyInt> e = [] { return MoveOnlyInt(100); }();
EXPECT_EQ(e.value().value, 100);
}
// Test that an RTCErrorOr can be implicitly constructed from an RTCError.
TEST(RTCErrorOrTest, ImplicitErrorConstructor) {
RTCErrorOr<MoveOnlyInt> e = [] {
return RTCError(RTCErrorType::SYNTAX_ERROR);
}();
EXPECT_EQ(e.error().type(), RTCErrorType::SYNTAX_ERROR);
}
TEST(RTCErrorOrTest, MoveConstructor) {
RTCErrorOr<MoveOnlyInt> a(MoveOnlyInt(5));
RTCErrorOr<MoveOnlyInt> b(std::move(a));
EXPECT_EQ(b.value().value, 5);
}
TEST(RTCErrorOrTest, MoveAssignment) {
RTCErrorOr<MoveOnlyInt> a(MoveOnlyInt(5));
RTCErrorOr<MoveOnlyInt> b(MoveOnlyInt(10));
a = std::move(b);
EXPECT_EQ(a.value().value, 10);
}
TEST(RTCErrorOrTest, ConversionConstructor) {
RTCErrorOr<MoveOnlyInt> a(MoveOnlyInt(1));
RTCErrorOr<MoveOnlyInt2> b(std::move(a));
}
TEST(RTCErrorOrTest, ConversionAssignment) {
RTCErrorOr<MoveOnlyInt> a(MoveOnlyInt(5));
RTCErrorOr<MoveOnlyInt2> b(MoveOnlyInt2(10));
b = std::move(a);
EXPECT_EQ(b.value().value, 5);
}
TEST(RTCErrorOrTest, OkMethod) {
RTCErrorOr<int> success(1337);
RTCErrorOr<int> error = RTCError(RTCErrorType::INTERNAL_ERROR);
EXPECT_TRUE(success.ok());
EXPECT_FALSE(error.ok());
}
TEST(RTCErrorOrTest, MoveError) {
RTCErrorOr<int> e({RTCErrorType::SYNTAX_ERROR, "message"});
RTCError err = e.MoveError();
EXPECT_EQ(err.type(), RTCErrorType::SYNTAX_ERROR);
EXPECT_STREQ(err.message(), "message");
}
TEST(RTCErrorOrTest, MoveValue) {
RTCErrorOr<MoveOnlyInt> e(MoveOnlyInt(88));
MoveOnlyInt value = e.MoveValue();
EXPECT_EQ(value.value, 88);
}
TEST(RTCErrorOrTest, StringifyWithUnprintableValue) {
RTCErrorOr<MoveOnlyInt> e(MoveOnlyInt(1337));
EXPECT_EQ(absl::StrCat(e), "OK");
}
TEST(RTCErrorOrTest, StringifyWithStringValue) {
RTCErrorOr<absl::string_view> e("foo");
EXPECT_EQ(absl::StrCat(e), "OK with value: foo");
}
TEST(RTCErrorOrTest, StringifyWithPrintableValue) {
RTCErrorOr<int> e(1337);
EXPECT_EQ(absl::StrCat(e), "OK with value: 1337");
}
TEST(RTCErrorOrTest, StringifyWithError) {
RTCErrorOr<int> e({RTCErrorType::SYNTAX_ERROR, "message"});
EXPECT_EQ(absl::StrCat(e), "SYNTAX_ERROR with message: \"message\"");
}
// Death tests.
// Disabled on Android because death tests misbehave on Android, see
// base/test/gtest_util.h.
#if RTC_DCHECK_IS_ON && GTEST_HAS_DEATH_TEST && !defined(WEBRTC_ANDROID)
TEST(RTCErrorOrDeathTest, ConstructWithOkError) {
RTCErrorOr<int> err;
EXPECT_DEATH(err = RTCError::OK(), "");
}
TEST(RTCErrorOrDeathTest, DereferenceErrorValue) {
RTCErrorOr<int> error = RTCError(RTCErrorType::INTERNAL_ERROR);
EXPECT_DEATH(error.value(), "");
}
TEST(RTCErrorOrDeathTest, MoveErrorValue) {
RTCErrorOr<int> error = RTCError(RTCErrorType::INTERNAL_ERROR);
EXPECT_DEATH(error.MoveValue(), "");
}
#endif // RTC_DCHECK_IS_ON && GTEST_HAS_DEATH_TEST && !defined(WEBRTC_ANDROID)
} // namespace
} // namespace webrtc