1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
#pragma once
#ifdef __GNUC__
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-parameter"
#endif
//===- llvm/Testing/Support/Error.h ---------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_TESTING_SUPPORT_ERROR_H
#define LLVM_TESTING_SUPPORT_ERROR_H
#include "llvm/ADT/Optional.h"
#include "llvm/Support/Error.h"
#include "llvm/Testing/Support/SupportHelpers.h"
#include "gmock/gmock.h"
#include <ostream>
namespace llvm {
namespace detail {
ErrorHolder TakeError(Error Err);
template <typename T> ExpectedHolder<T> TakeExpected(Expected<T> &Exp) {
return {TakeError(Exp.takeError()), Exp};
}
template <typename T> ExpectedHolder<T> TakeExpected(Expected<T> &&Exp) {
return TakeExpected(Exp);
}
template <typename T>
class ValueMatchesMono
: public testing::MatcherInterface<const ExpectedHolder<T> &> {
public:
explicit ValueMatchesMono(const testing::Matcher<T> &Matcher)
: Matcher(Matcher) {}
bool MatchAndExplain(const ExpectedHolder<T> &Holder,
testing::MatchResultListener *listener) const override {
if (!Holder.Success())
return false;
bool result = Matcher.MatchAndExplain(*Holder.Exp, listener);
if (result || !listener->IsInterested())
return result;
*listener << "(";
Matcher.DescribeNegationTo(listener->stream());
*listener << ")";
return result;
}
void DescribeTo(std::ostream *OS) const override {
*OS << "succeeded with value (";
Matcher.DescribeTo(OS);
*OS << ")";
}
void DescribeNegationTo(std::ostream *OS) const override {
*OS << "did not succeed or value (";
Matcher.DescribeNegationTo(OS);
*OS << ")";
}
private:
testing::Matcher<T> Matcher;
};
template<typename M>
class ValueMatchesPoly {
public:
explicit ValueMatchesPoly(const M &Matcher) : Matcher(Matcher) {}
template <typename T>
operator testing::Matcher<const ExpectedHolder<T> &>() const {
return MakeMatcher(
new ValueMatchesMono<T>(testing::SafeMatcherCast<T>(Matcher)));
}
private:
M Matcher;
};
template <typename InfoT>
class ErrorMatchesMono : public testing::MatcherInterface<const ErrorHolder &> {
public:
explicit ErrorMatchesMono(Optional<testing::Matcher<InfoT &>> Matcher)
: Matcher(std::move(Matcher)) {}
bool MatchAndExplain(const ErrorHolder &Holder,
testing::MatchResultListener *listener) const override {
if (Holder.Success())
return false;
if (Holder.Infos.size() > 1) {
*listener << "multiple errors";
return false;
}
auto &Info = *Holder.Infos[0];
if (!Info.isA<InfoT>()) {
*listener << "Error was not of given type";
return false;
}
if (!Matcher)
return true;
return Matcher->MatchAndExplain(static_cast<InfoT &>(Info), listener);
}
void DescribeTo(std::ostream *OS) const override {
*OS << "failed with Error of given type";
if (Matcher) {
*OS << " and the error ";
Matcher->DescribeTo(OS);
}
}
void DescribeNegationTo(std::ostream *OS) const override {
*OS << "succeeded or did not fail with the error of given type";
if (Matcher) {
*OS << " or the error ";
Matcher->DescribeNegationTo(OS);
}
}
private:
Optional<testing::Matcher<InfoT &>> Matcher;
};
class ErrorMessageMatches
: public testing::MatcherInterface<const ErrorHolder &> {
public:
explicit ErrorMessageMatches(
testing::Matcher<std::vector<std::string>> Matcher)
: Matcher(std::move(Matcher)) {}
bool MatchAndExplain(const ErrorHolder &Holder,
testing::MatchResultListener *listener) const override {
std::vector<std::string> Messages;
for (const std::shared_ptr<ErrorInfoBase> &Info: Holder.Infos)
Messages.push_back(Info->message());
return Matcher.MatchAndExplain(Messages, listener);
}
void DescribeTo(std::ostream *OS) const override {
*OS << "failed with Error whose message ";
Matcher.DescribeTo(OS);
}
void DescribeNegationTo(std::ostream *OS) const override {
*OS << "failed with an Error whose message ";
Matcher.DescribeNegationTo(OS);
}
private:
testing::Matcher<std::vector<std::string>> Matcher;
};
} // namespace detail
#define EXPECT_THAT_ERROR(Err, Matcher) \
EXPECT_THAT(llvm::detail::TakeError(Err), Matcher)
#define ASSERT_THAT_ERROR(Err, Matcher) \
ASSERT_THAT(llvm::detail::TakeError(Err), Matcher)
/// Helper macro for checking the result of an 'Expected<T>'
///
/// @code{.cpp}
/// // function to be tested
/// Expected<int> myDivide(int A, int B);
///
/// TEST(myDivideTests, GoodAndBad) {
/// // test good case
/// // if you only care about success or failure:
/// EXPECT_THAT_EXPECTED(myDivide(10, 5), Succeeded());
/// // if you also care about the value:
/// EXPECT_THAT_EXPECTED(myDivide(10, 5), HasValue(2));
///
/// // test the error case
/// EXPECT_THAT_EXPECTED(myDivide(10, 0), Failed());
/// // also check the error message
/// EXPECT_THAT_EXPECTED(myDivide(10, 0),
/// FailedWithMessage("B must not be zero!"));
/// }
/// @endcode
#define EXPECT_THAT_EXPECTED(Err, Matcher) \
EXPECT_THAT(llvm::detail::TakeExpected(Err), Matcher)
#define ASSERT_THAT_EXPECTED(Err, Matcher) \
ASSERT_THAT(llvm::detail::TakeExpected(Err), Matcher)
MATCHER(Succeeded, "") { return arg.Success(); }
MATCHER(Failed, "") { return !arg.Success(); }
template <typename InfoT>
testing::Matcher<const detail::ErrorHolder &> Failed() {
return MakeMatcher(new detail::ErrorMatchesMono<InfoT>(None));
}
template <typename InfoT, typename M>
testing::Matcher<const detail::ErrorHolder &> Failed(M Matcher) {
return MakeMatcher(new detail::ErrorMatchesMono<InfoT>(
testing::SafeMatcherCast<InfoT &>(Matcher)));
}
template <typename... M>
testing::Matcher<const detail::ErrorHolder &> FailedWithMessage(M... Matcher) {
static_assert(sizeof...(M) > 0, "");
return MakeMatcher(
new detail::ErrorMessageMatches(testing::ElementsAre(Matcher...)));
}
template <typename M>
testing::Matcher<const detail::ErrorHolder &> FailedWithMessageArray(M Matcher) {
return MakeMatcher(new detail::ErrorMessageMatches(Matcher));
}
template <typename M>
detail::ValueMatchesPoly<M> HasValue(M Matcher) {
return detail::ValueMatchesPoly<M>(Matcher);
}
} // namespace llvm
#endif
#ifdef __GNUC__
#pragma GCC diagnostic pop
#endif
|
