-
Notifications
You must be signed in to change notification settings - Fork 10.8k
/
StencilTest.cpp
224 lines (204 loc) · 7.84 KB
/
StencilTest.cpp
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
//===- unittest/Tooling/StencilTest.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 "clang/Tooling/Refactoring/Stencil.h"
#include "clang/ASTMatchers/ASTMatchers.h"
#include "clang/Tooling/FixIt.h"
#include "clang/Tooling/Tooling.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
using namespace clang;
using namespace tooling;
using namespace ast_matchers;
namespace {
using ::testing::AllOf;
using ::testing::Eq;
using ::testing::HasSubstr;
using MatchResult = MatchFinder::MatchResult;
using stencil::cat;
using stencil::dPrint;
using stencil::text;
// In tests, we can't directly match on llvm::Expected since its accessors
// mutate the object. So, we collapse it to an Optional.
static llvm::Optional<std::string> toOptional(llvm::Expected<std::string> V) {
if (V)
return *V;
ADD_FAILURE() << "Losing error in conversion to IsSomething: "
<< llvm::toString(V.takeError());
return llvm::None;
}
// A very simple matcher for llvm::Optional values.
MATCHER_P(IsSomething, ValueMatcher, "") {
if (!arg)
return false;
return ::testing::ExplainMatchResult(ValueMatcher, *arg, result_listener);
}
// Create a valid translation-unit from a statement.
static std::string wrapSnippet(llvm::Twine StatementCode) {
return ("auto stencil_test_snippet = []{" + StatementCode + "};").str();
}
static DeclarationMatcher wrapMatcher(const StatementMatcher &Matcher) {
return varDecl(hasName("stencil_test_snippet"),
hasDescendant(compoundStmt(hasAnySubstatement(Matcher))));
}
struct TestMatch {
// The AST unit from which `result` is built. We bundle it because it backs
// the result. Users are not expected to access it.
std::unique_ptr<ASTUnit> AstUnit;
// The result to use in the test. References `ast_unit`.
MatchResult Result;
};
// Matches `Matcher` against the statement `StatementCode` and returns the
// result. Handles putting the statement inside a function and modifying the
// matcher correspondingly. `Matcher` should match `StatementCode` exactly --
// that is, produce exactly one match.
static llvm::Optional<TestMatch> matchStmt(llvm::Twine StatementCode,
StatementMatcher Matcher) {
auto AstUnit = buildASTFromCode(wrapSnippet(StatementCode));
if (AstUnit == nullptr) {
ADD_FAILURE() << "AST construction failed";
return llvm::None;
}
ASTContext &Context = AstUnit->getASTContext();
auto Matches = ast_matchers::match(wrapMatcher(Matcher), Context);
// We expect a single, exact match for the statement.
if (Matches.size() != 1) {
ADD_FAILURE() << "Wrong number of matches: " << Matches.size();
return llvm::None;
}
return TestMatch{std::move(AstUnit), MatchResult(Matches[0], &Context)};
}
class StencilTest : public ::testing::Test {
protected:
// Verifies that the given stencil fails when evaluated on a valid match
// result. Binds a statement to "stmt", a (non-member) ctor-initializer to
// "init", an expression to "expr" and a (nameless) declaration to "decl".
void testError(const Stencil &Stencil,
::testing::Matcher<std::string> Matcher) {
const std::string Snippet = R"cc(
struct A {};
class F : public A {
public:
F(int) {}
};
F(1);
)cc";
auto StmtMatch = matchStmt(
Snippet,
stmt(hasDescendant(
cxxConstructExpr(
hasDeclaration(decl(hasDescendant(cxxCtorInitializer(
isBaseInitializer())
.bind("init")))
.bind("decl")))
.bind("expr")))
.bind("stmt"));
ASSERT_TRUE(StmtMatch);
if (auto ResultOrErr = Stencil.eval(StmtMatch->Result)) {
ADD_FAILURE() << "Expected failure but succeeded: " << *ResultOrErr;
} else {
auto Err = llvm::handleErrors(ResultOrErr.takeError(),
[&Matcher](const llvm::StringError &Err) {
EXPECT_THAT(Err.getMessage(), Matcher);
});
if (Err) {
ADD_FAILURE() << "Unhandled error: " << llvm::toString(std::move(Err));
}
}
}
// Tests failures caused by references to unbound nodes. `unbound_id` is the
// id that will cause the failure.
void testUnboundNodeError(const Stencil &Stencil, llvm::StringRef UnboundId) {
testError(Stencil, AllOf(HasSubstr(UnboundId), HasSubstr("not bound")));
}
};
TEST_F(StencilTest, SingleStatement) {
StringRef Condition("C"), Then("T"), Else("E");
const std::string Snippet = R"cc(
if (true)
return 1;
else
return 0;
)cc";
auto StmtMatch = matchStmt(
Snippet, ifStmt(hasCondition(expr().bind(Condition)),
hasThen(stmt().bind(Then)), hasElse(stmt().bind(Else))));
ASSERT_TRUE(StmtMatch);
// Invert the if-then-else.
auto Stencil = cat("if (!", node(Condition), ") ", statement(Else), " else ",
statement(Then));
EXPECT_THAT(toOptional(Stencil.eval(StmtMatch->Result)),
IsSomething(Eq("if (!true) return 0; else return 1;")));
}
TEST_F(StencilTest, SingleStatementCallOperator) {
StringRef Condition("C"), Then("T"), Else("E");
const std::string Snippet = R"cc(
if (true)
return 1;
else
return 0;
)cc";
auto StmtMatch = matchStmt(
Snippet, ifStmt(hasCondition(expr().bind(Condition)),
hasThen(stmt().bind(Then)), hasElse(stmt().bind(Else))));
ASSERT_TRUE(StmtMatch);
// Invert the if-then-else.
Stencil S = cat("if (!", node(Condition), ") ", statement(Else), " else ",
statement(Then));
EXPECT_THAT(toOptional(S(StmtMatch->Result)),
IsSomething(Eq("if (!true) return 0; else return 1;")));
}
TEST_F(StencilTest, UnboundNode) {
const std::string Snippet = R"cc(
if (true)
return 1;
else
return 0;
)cc";
auto StmtMatch = matchStmt(Snippet, ifStmt(hasCondition(stmt().bind("a1")),
hasThen(stmt().bind("a2"))));
ASSERT_TRUE(StmtMatch);
auto Stencil = cat("if(!", node("a1"), ") ", node("UNBOUND"), ";");
auto ResultOrErr = Stencil.eval(StmtMatch->Result);
EXPECT_TRUE(llvm::errorToBool(ResultOrErr.takeError()))
<< "Expected unbound node, got " << *ResultOrErr;
}
// Tests that a stencil with a single parameter (`Id`) evaluates to the expected
// string, when `Id` is bound to the expression-statement in `Snippet`.
void testExpr(StringRef Id, StringRef Snippet, const Stencil &Stencil,
StringRef Expected) {
auto StmtMatch = matchStmt(Snippet, expr().bind(Id));
ASSERT_TRUE(StmtMatch);
EXPECT_THAT(toOptional(Stencil.eval(StmtMatch->Result)),
IsSomething(Expected));
}
TEST_F(StencilTest, SelectionOp) {
StringRef Id = "id";
testExpr(Id, "3;", cat(node(Id)), "3");
}
TEST(StencilEqualityTest, Equality) {
auto Lhs = cat("foo", dPrint("dprint_id"));
auto Rhs = cat("foo", dPrint("dprint_id"));
EXPECT_EQ(Lhs, Rhs);
}
TEST(StencilEqualityTest, InEqualityDifferentOrdering) {
auto Lhs = cat("foo", dPrint("node"));
auto Rhs = cat(dPrint("node"), "foo");
EXPECT_NE(Lhs, Rhs);
}
TEST(StencilEqualityTest, InEqualityDifferentSizes) {
auto Lhs = cat("foo", dPrint("node"), "bar", "baz");
auto Rhs = cat("foo", dPrint("node"), "bar");
EXPECT_NE(Lhs, Rhs);
}
// node is opaque and therefore cannot be examined for equality.
TEST(StencilEqualityTest, InEqualitySelection) {
auto S1 = cat(node("node"));
auto S2 = cat(node("node"));
EXPECT_NE(S1, S2);
}
} // namespace