1fae1314f1
(based on a conversation I had with @labath yesterday in https://github.com/llvm/llvm-project/pull/106442) Most APIs that currently vend a Status would be better served by returning llvm::Expected<> instead. If possibles APIs should be refactored to avoid Status. The only legitimate long-term uses of Status are objects that need to store an error for a long time (which should be questioned as a design decision, too). This patch makes the transition to llvm::Error easier by making the places that cannot switch to llvm::Error explicit: They are marked with a call to Status::clone(). Every other API can and should be refactored to use llvm::Expected. In the end Status should only be used in very few places. Whenever an unchecked Error is dropped by Status it logs this to the verbose API channel. Implementation notes: This patch introduces two new kinds of error_category as well as new llvm::Error types. Here is the mapping of lldb::ErrorType to llvm::Errors: ``` (eErrorTypeInvalid) eErrorTypeGeneric llvm::StringError eErrorTypePOSIX llvm::ECError eErrorTypeMachKernel MachKernelError eErrorTypeExpression llvm::ErrorList<ExpressionError> eErrorTypeWin32 Win32Error ``` Relanding with built-in cloning support for llvm::ECError, and support for initializing a Windows error with a NO_ERROR error code, and modifying TestGDBRemotePlatformFile.py to support different renderings of ENOSYS.
113 lines
3.9 KiB
C++
113 lines
3.9 KiB
C++
//===-- StatusTest.cpp ----------------------------------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "lldb/Utility/Status.h"
|
|
#include "gtest/gtest.h"
|
|
|
|
#ifdef _WIN32
|
|
#include <windows.h>
|
|
#endif
|
|
|
|
using namespace lldb_private;
|
|
using namespace lldb;
|
|
|
|
TEST(StatusTest, Formatv) {
|
|
EXPECT_EQ("", llvm::formatv("{0}", Status()).str());
|
|
EXPECT_EQ(
|
|
"Hello Status",
|
|
llvm::formatv("{0}", Status::FromErrorString("Hello Status")).str());
|
|
EXPECT_EQ(
|
|
"Hello",
|
|
llvm::formatv("{0:5}", Status::FromErrorString("Hello Error")).str());
|
|
}
|
|
|
|
TEST(StatusTest, ErrorConstructor) {
|
|
EXPECT_TRUE(Status::FromError(llvm::Error::success()).Success());
|
|
|
|
Status eagain = Status::FromError(
|
|
llvm::errorCodeToError(std::error_code(EAGAIN, std::generic_category())));
|
|
EXPECT_TRUE(eagain.Fail());
|
|
EXPECT_EQ(eErrorTypePOSIX, eagain.GetType());
|
|
EXPECT_EQ(Status::ValueType(EAGAIN), eagain.GetError());
|
|
|
|
Status foo = Status::FromError(llvm::createStringError("foo"));
|
|
EXPECT_TRUE(foo.Fail());
|
|
EXPECT_EQ(eErrorTypeGeneric, foo.GetType());
|
|
EXPECT_STREQ("foo", foo.AsCString());
|
|
|
|
foo = Status::FromError(llvm::Error::success());
|
|
EXPECT_TRUE(foo.Success());
|
|
}
|
|
|
|
TEST(StatusTest, ErrorCodeConstructor) {
|
|
EXPECT_TRUE(Status(std::error_code()).Success());
|
|
|
|
Status eagain = std::error_code(EAGAIN, std::generic_category());
|
|
EXPECT_TRUE(eagain.Fail());
|
|
EXPECT_EQ(eErrorTypePOSIX, eagain.GetType());
|
|
EXPECT_EQ(Status::ValueType(EAGAIN), eagain.GetError());
|
|
|
|
llvm::Error list = llvm::joinErrors(llvm::createStringError("foo"),
|
|
llvm::createStringError("bar"));
|
|
Status foobar = Status::FromError(std::move(list));
|
|
EXPECT_EQ(std::string("foo\nbar"), std::string(foobar.AsCString()));
|
|
}
|
|
|
|
TEST(StatusTest, ErrorConversion) {
|
|
EXPECT_FALSE(bool(Status().ToError()));
|
|
|
|
llvm::Error eagain = Status(EAGAIN, ErrorType::eErrorTypePOSIX).ToError();
|
|
EXPECT_TRUE(bool(eagain));
|
|
std::error_code ec = llvm::errorToErrorCode(std::move(eagain));
|
|
EXPECT_EQ(EAGAIN, ec.value());
|
|
EXPECT_EQ(std::generic_category(), ec.category());
|
|
|
|
llvm::Error foo = Status::FromErrorString("foo").ToError();
|
|
EXPECT_TRUE(bool(foo));
|
|
EXPECT_EQ("foo", llvm::toString(std::move(foo)));
|
|
|
|
llvm::Error eperm = llvm::errorCodeToError({EPERM, std::generic_category()});
|
|
llvm::Error eintr = llvm::errorCodeToError({EINTR, std::generic_category()});
|
|
llvm::Error elist = llvm::joinErrors(std::move(eperm), std::move(eintr));
|
|
elist = llvm::joinErrors(std::move(elist), llvm::createStringError("foo"));
|
|
Status list = Status::FromError(std::move(elist));
|
|
EXPECT_EQ((int)list.GetError(), EPERM);
|
|
EXPECT_EQ(list.GetType(), eErrorTypePOSIX);
|
|
}
|
|
|
|
#ifdef _WIN32
|
|
TEST(StatusTest, ErrorWin32) {
|
|
auto success = Status(NO_ERROR, ErrorType::eErrorTypeWin32);
|
|
EXPECT_STREQ(NULL, success.AsCString());
|
|
EXPECT_FALSE(success.ToError());
|
|
EXPECT_TRUE(success.Success());
|
|
|
|
WCHAR name[128]{};
|
|
ULONG nameLen = std::size(name);
|
|
ULONG langs = 0;
|
|
GetUserPreferredUILanguages(MUI_LANGUAGE_NAME, &langs,
|
|
reinterpret_cast<PZZWSTR>(&name), &nameLen);
|
|
// Skip the following tests on non-English, non-US, locales because the
|
|
// formatted messages will be different.
|
|
bool skip = wcscmp(L"en-US", name) != 0;
|
|
|
|
Status s = Status(ERROR_ACCESS_DENIED, ErrorType::eErrorTypeWin32);
|
|
EXPECT_TRUE(s.Fail());
|
|
if (!skip)
|
|
EXPECT_STREQ("Access is denied. ", s.AsCString());
|
|
|
|
s = Status(ERROR_IPSEC_IKE_TIMED_OUT, ErrorType::eErrorTypeWin32);
|
|
if (!skip)
|
|
EXPECT_STREQ("Negotiation timed out ", s.AsCString());
|
|
|
|
s = Status(16000, ErrorType::eErrorTypeWin32);
|
|
if (!skip)
|
|
EXPECT_STREQ("unknown error", s.AsCString());
|
|
}
|
|
#endif
|