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
239
240
|
// Copyright 2015 The Bazel Authors. 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.analysis;
import static com.google.common.truth.Truth.assertThat;
import static com.google.devtools.build.lib.packages.Attribute.attr;
import static org.junit.Assert.fail;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.packages.AspectDefinition;
import com.google.devtools.build.lib.packages.AspectParameters;
import com.google.devtools.build.lib.packages.Attribute;
import com.google.devtools.build.lib.packages.Attribute.ConfigurationTransition;
import com.google.devtools.build.lib.packages.Attribute.LateBoundLabel;
import com.google.devtools.build.lib.packages.AttributeMap;
import com.google.devtools.build.lib.packages.BuildType;
import com.google.devtools.build.lib.packages.ConfigurationFragmentPolicy.MissingFragmentPolicy;
import com.google.devtools.build.lib.packages.NativeAspectClass;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.skylarkinterface.SkylarkModule;
import com.google.devtools.build.lib.util.FileTypeSet;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/**
* Tests for aspect definitions.
*/
@RunWith(JUnit4.class)
public class AspectDefinitionTest {
/**
* A dummy aspect factory. Is there to demonstrate how to define aspects and so that we can test
* {@code attributeAspect}.
*/
public static final class TestAspectClass extends NativeAspectClass
implements ConfiguredAspectFactory {
private AspectDefinition definition;
public void setAspectDefinition(AspectDefinition definition) {
this.definition = definition;
}
@Override
public ConfiguredAspect create(
ConfiguredTarget base, RuleContext context, AspectParameters parameters) {
throw new IllegalStateException();
}
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
return definition;
}
}
public static final TestAspectClass TEST_ASPECT_CLASS = new TestAspectClass();
@Test
public void testAspectWithImplicitOrLateboundAttribute_AddsToAttributeMap() throws Exception {
Attribute implicit = attr("$runtime", BuildType.LABEL)
.value(Label.parseAbsoluteUnchecked("//run:time"))
.build();
LateBoundLabel<String> latebound = new LateBoundLabel<String>() {
@Override
public Label resolve(Rule rule, AttributeMap attributes, String configuration) {
return Label.parseAbsoluteUnchecked("//run:away");
}
};
AspectDefinition simple = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.add(implicit)
.add(attr(":latebound", BuildType.LABEL).value(latebound))
.build();
assertThat(simple.getAttributes()).containsEntry("$runtime", implicit);
assertThat(simple.getAttributes()).containsKey(":latebound");
assertThat(simple.getAttributes().get(":latebound").getLateBoundDefault())
.isEqualTo(latebound);
}
@Test
public void testAspectWithDuplicateAttribute_FailsToAdd() throws Exception {
try {
new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.add(attr("$runtime", BuildType.LABEL).value(Label.parseAbsoluteUnchecked("//run:time")))
.add(attr("$runtime", BuildType.LABEL).value(Label.parseAbsoluteUnchecked("//oops")));
fail(); // expected IllegalArgumentException
} catch (IllegalArgumentException e) {
// expected
}
}
@Test
public void testAspectWithUserVisibleAttribute_FailsToAdd() throws Exception {
try {
new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.add(
attr("invalid", BuildType.LABEL)
.value(Label.parseAbsoluteUnchecked("//run:time"))
.allowedFileTypes(FileTypeSet.NO_FILE))
.build();
fail(); // expected IllegalArgumentException
} catch (IllegalArgumentException e) {
// expected
}
}
@Test
public void testAttributeAspect_WrapsAndAddsToMap() throws Exception {
AspectDefinition withAspects = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.attributeAspect("srcs", TEST_ASPECT_CLASS)
.attributeAspect("deps", TEST_ASPECT_CLASS)
.build();
assertThat(withAspects.getAttributeAspects(createLabelListAttribute("srcs")))
.containsExactly(TEST_ASPECT_CLASS);
assertThat(withAspects.getAttributeAspects(createLabelListAttribute("deps")))
.containsExactly(TEST_ASPECT_CLASS);
}
@Test
public void testAttributeAspect_AllAttributes() throws Exception {
AspectDefinition withAspects = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.allAttributesAspect(TEST_ASPECT_CLASS)
.build();
assertThat(withAspects.getAttributeAspects(createLabelListAttribute("srcs")))
.containsExactly(TEST_ASPECT_CLASS);
assertThat(withAspects.getAttributeAspects(createLabelListAttribute("deps")))
.containsExactly(TEST_ASPECT_CLASS);
}
private static Attribute createLabelListAttribute(String name) {
return Attribute.attr(name, BuildType.LABEL_LIST)
.allowedFileTypes(FileTypeSet.ANY_FILE)
.build();
}
@Test
public void testRequireProvider_AddsToSetOfRequiredProvidersAndNames() throws Exception {
AspectDefinition requiresProviders = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.requireProvider(String.class)
.requireProvider(Integer.class)
.build();
assertThat(requiresProviders.getRequiredProviders())
.containsExactly(String.class, Integer.class);
assertThat(requiresProviders.getRequiredProviderNames())
.containsExactly("java.lang.String", "java.lang.Integer");
}
@Test
public void testNoConfigurationFragmentPolicySetup_HasNonNullPolicy() throws Exception {
AspectDefinition noPolicy = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.build();
assertThat(noPolicy.getConfigurationFragmentPolicy()).isNotNull();
}
@Test
public void testMissingFragmentPolicy_PropagatedToConfigurationFragmentPolicy() throws Exception {
AspectDefinition missingFragments = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.setMissingFragmentPolicy(MissingFragmentPolicy.IGNORE)
.build();
assertThat(missingFragments.getConfigurationFragmentPolicy()).isNotNull();
assertThat(missingFragments.getConfigurationFragmentPolicy().getMissingFragmentPolicy())
.isEqualTo(MissingFragmentPolicy.IGNORE);
}
@Test
public void testRequiresConfigurationFragments_PropagatedToConfigurationFragmentPolicy()
throws Exception {
AspectDefinition requiresFragments = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.requiresConfigurationFragments(Integer.class, String.class)
.build();
assertThat(requiresFragments.getConfigurationFragmentPolicy()).isNotNull();
assertThat(
requiresFragments.getConfigurationFragmentPolicy().getRequiredConfigurationFragments())
.containsExactly(Integer.class, String.class);
}
@Test
public void testRequiresHostConfigurationFragments_PropagatedToConfigurationFragmentPolicy()
throws Exception {
AspectDefinition requiresFragments = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.requiresHostConfigurationFragments(Integer.class, String.class)
.build();
assertThat(requiresFragments.getConfigurationFragmentPolicy()).isNotNull();
assertThat(
requiresFragments.getConfigurationFragmentPolicy().getRequiredConfigurationFragments())
.containsExactly(Integer.class, String.class);
}
@Test
public void testRequiresConfigurationFragmentNames_PropagatedToConfigurationFragmentPolicy()
throws Exception {
AspectDefinition requiresFragments = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.requiresConfigurationFragmentsBySkylarkModuleName(ImmutableList.of("test_fragment"))
.build();
assertThat(requiresFragments.getConfigurationFragmentPolicy()).isNotNull();
assertThat(
requiresFragments.getConfigurationFragmentPolicy()
.isLegalConfigurationFragment(TestFragment.class, ConfigurationTransition.NONE))
.isTrue();
}
@Test
public void testRequiresHostConfigurationFragmentNames_PropagatedToConfigurationFragmentPolicy()
throws Exception {
AspectDefinition requiresFragments = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.requiresHostConfigurationFragmentsBySkylarkModuleName(ImmutableList.of("test_fragment"))
.build();
assertThat(requiresFragments.getConfigurationFragmentPolicy()).isNotNull();
assertThat(
requiresFragments.getConfigurationFragmentPolicy()
.isLegalConfigurationFragment(TestFragment.class, ConfigurationTransition.HOST))
.isTrue();
}
@Test
public void testEmptySkylarkConfigurationFragmentPolicySetup_HasNonNullPolicy() throws Exception {
AspectDefinition noPolicy = new AspectDefinition.Builder(TEST_ASPECT_CLASS)
.requiresConfigurationFragmentsBySkylarkModuleName(ImmutableList.<String>of())
.requiresHostConfigurationFragmentsBySkylarkModuleName(ImmutableList.<String>of())
.build();
assertThat(noPolicy.getConfigurationFragmentPolicy()).isNotNull();
}
@SkylarkModule(name = "test_fragment", doc = "test fragment")
private static final class TestFragment {}
}
|