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
|
// Copyright 2014 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.skylark.util;
import static com.google.common.truth.Truth.assertThat;
import com.google.common.base.Joiner;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.util.BuildViewTestCase;
import com.google.devtools.build.lib.packages.PackageFactory;
import com.google.devtools.build.lib.packages.PackageFactory.PackageContext;
import com.google.devtools.build.lib.rules.SkylarkModules;
import com.google.devtools.build.lib.rules.SkylarkRuleContext;
import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.util.EvaluationTestCase;
import org.junit.Before;
/**
* A class to contain the common functionality for Skylark tests.
*/
public abstract class SkylarkTestCase extends BuildViewTestCase {
// We don't have multiple inheritance, so we fake it.
protected EvaluationTestCase ev;
protected void setUpEvaluator() throws Exception {
ev =
new EvaluationTestCase() {
@Override
public Environment newEnvironment() throws Exception {
return Environment.builder(mutability)
.setSkylark()
.setEventHandler(getEventHandler())
.setGlobals(SkylarkModules.GLOBALS)
.setLoadingPhase()
.build()
.setupDynamic(
PackageFactory.PKG_CONTEXT,
// This dummy pkgContext works because no Skylark unit test attempts to actually
// create rules. Creating actual rules is tested in SkylarkIntegrationTest.
new PackageContext(null, null, getEventHandler()));
}
};
ev.setUp();
}
@Before
@Override
protected void setUp() throws Exception {
super.setUp();
setUpEvaluator();
}
protected Object eval(String... input) throws Exception {
return ev.eval(input);
}
protected void update(String name, Object value) throws Exception {
ev.update(name, value);
}
protected Object lookup(String name) throws Exception {
return ev.lookup(name);
}
protected void checkEvalError(String msg, String... input) throws Exception {
ev.checkEvalError(msg, input);
}
protected void checkEvalErrorContains(String msg, String... input) throws Exception {
ev.checkEvalErrorContains(msg, input);
}
protected SkylarkRuleContext dummyRuleContext() throws Exception {
return createRuleContext("//foo:foo");
}
protected SkylarkRuleContext createRuleContext(String label) throws Exception {
return new SkylarkRuleContext(getRuleContextForSkylark(getConfiguredTarget(label)));
}
protected Object evalRuleContextCode(String... lines) throws Exception {
return evalRuleContextCode(dummyRuleContext(), lines);
}
/**
* RuleContext can't be null, SkylarkBuiltInFunctions checks it.
* However not all built in functions use it, if usesRuleContext == false
* the wrapping function won't need a ruleContext parameter.
*/
protected Object evalRuleContextCode(SkylarkRuleContext ruleContext, String... code)
throws Exception {
setUpEvaluator();
if (ruleContext != null) {
update("ruleContext", ruleContext);
}
return eval(code);
}
protected void assertArtifactFilenames(Iterable<Artifact> artifacts, String... expected) {
int i = 0;
for (Artifact artifact : artifacts) {
assertEquals(expected[i++], artifact.getFilename());
}
}
protected Object evalRuleClassCode(String... lines) throws Exception {
setUpEvaluator();
return eval("def impl(ctx): return None\n" + Joiner.on("\n").join(lines));
}
protected void checkError(SkylarkRuleContext ruleContext, String errorMsg, String... lines)
throws Exception {
try {
evalRuleContextCode(ruleContext, lines);
fail();
} catch (EvalException e) {
assertThat(e).hasMessage(errorMsg);
}
}
protected void checkErrorStartsWith(
SkylarkRuleContext ruleContext, String errorMsg, String... lines) throws Exception {
try {
evalRuleContextCode(ruleContext, lines);
fail();
} catch (EvalException e) {
assertThat(e.getMessage()).startsWith(errorMsg);
}
}
protected void checkErrorContains(String errorMsg, String... lines) throws Exception {
try {
eval(lines);
fail("checkErrorContains(String, String...): There was no error");
} catch (EvalException e) {
assertThat(e.getMessage()).contains(errorMsg);
}
}
protected void checkErrorContains(
SkylarkRuleContext ruleContext, String errorMsg, String... lines) throws Exception {
try {
evalRuleContextCode(ruleContext, lines);
fail("checkErrorContains(SkylarkRuleContext, String, String...): There was no error");
} catch (EvalException e) {
assertThat(e.getMessage()).contains(errorMsg);
}
}
}
|
