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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
|
// 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.util;
import static com.google.devtools.build.lib.packages.Attribute.ConfigurationTransition.HOST;
import static com.google.devtools.build.lib.packages.Attribute.attr;
import static com.google.devtools.build.lib.packages.BuildType.LABEL;
import static com.google.devtools.build.lib.packages.BuildType.LABEL_LIST;
import static com.google.devtools.build.lib.packages.BuildType.NODEP_LABEL_LIST;
import static com.google.devtools.build.lib.syntax.Type.BOOLEAN;
import static com.google.devtools.build.lib.syntax.Type.STRING;
import static com.google.devtools.build.lib.syntax.Type.STRING_LIST;
import com.google.common.base.Function;
import com.google.common.collect.ImmutableCollection;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.ConfiguredAspect;
import com.google.devtools.build.lib.analysis.ConfiguredAspectFactory;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.RuleConfiguredTarget.Mode;
import com.google.devtools.build.lib.analysis.RuleConfiguredTargetBuilder;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.RuleDefinition;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.analysis.Runfiles;
import com.google.devtools.build.lib.analysis.RunfilesProvider;
import com.google.devtools.build.lib.analysis.TransitiveInfoCollection;
import com.google.devtools.build.lib.analysis.TransitiveInfoProvider;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.LabelSyntaxException;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.concurrent.ThreadSafety.Immutable;
import com.google.devtools.build.lib.packages.AspectDefinition;
import com.google.devtools.build.lib.packages.AspectParameters;
import com.google.devtools.build.lib.packages.Attribute.LateBoundLabel;
import com.google.devtools.build.lib.packages.Attribute.LateBoundLabelList;
import com.google.devtools.build.lib.packages.AttributeMap;
import com.google.devtools.build.lib.packages.BuildType;
import com.google.devtools.build.lib.packages.NativeAspectClass;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.packages.RuleClass.Builder;
import com.google.devtools.build.lib.rules.RuleConfiguredTargetFactory;
import com.google.devtools.build.lib.syntax.Type;
import com.google.devtools.build.lib.util.FileTypeSet;
import java.util.List;
/**
* Various rule and aspect classes that aid in testing the aspect machinery.
*
* <p>These are mostly used in {@link com.google.devtools.build.lib.analysis.DependencyResolverTest}
* and {@link com.google.devtools.build.lib.analysis.AspectTest}.
*/
public class TestAspects {
public static final LateBoundLabel EMPTY_LATE_BOUND_LABEL = new LateBoundLabel<Object>() {
@Override
public Label resolve(Rule rule, AttributeMap attributes, Object configuration) {
return null;
}
};
/**
* A transitive info provider for collecting aspects in the transitive closure. Created by
* aspects.
*/
@Immutable
public static final class AspectInfo implements TransitiveInfoProvider {
private final NestedSet<String> data;
public AspectInfo(NestedSet<String> data) {
this.data = data;
}
public NestedSet<String> getData() {
return data;
}
}
/**
* A transitive info provider for collecting aspects in the transitive closure. Created by
* rules.
*/
@Immutable
public static final class RuleInfo implements TransitiveInfoProvider {
private final NestedSet<String> data;
public RuleInfo(NestedSet<String> data) {
this.data = data;
}
public NestedSet<String> getData() {
return data;
}
}
/**
* A very simple provider used in tests that check whether the logic that attaches aspects
* depending on whether a configured target has a provider works or not.
*/
@Immutable
public static final class RequiredProvider implements TransitiveInfoProvider {
}
private static NestedSet<String> collectAspectData(String me, RuleContext ruleContext) {
NestedSetBuilder<String> result = new NestedSetBuilder<>(Order.STABLE_ORDER);
result.add(me);
Iterable<String> attributeNames = ruleContext.attributes().getAttributeNames();
for (String attributeName : attributeNames) {
Type<?> attributeType = ruleContext.attributes().getAttributeType(attributeName);
if (!LABEL.equals(attributeType) && !LABEL_LIST.equals(attributeType)) {
continue;
}
Iterable<AspectInfo> prerequisites = ruleContext
.getPrerequisites(attributeName, Mode.DONT_CHECK, AspectInfo.class);
for (AspectInfo prerequisite : prerequisites) {
result.addTransitive(prerequisite.getData());
}
}
return result.build();
}
/**
* A simple rule configured target factory that is used in all the mock rules in this class.
*/
public static class DummyRuleFactory implements RuleConfiguredTargetFactory {
@Override
public ConfiguredTarget create(RuleContext ruleContext) throws InterruptedException {
RuleConfiguredTargetBuilder builder =
new RuleConfiguredTargetBuilder(ruleContext)
.addProvider(
new RuleInfo(collectAspectData("rule " + ruleContext.getLabel(), ruleContext)))
.setFilesToBuild(NestedSetBuilder.<Artifact>create(Order.STABLE_ORDER))
.setRunfilesSupport(null, null)
.add(RunfilesProvider.class, RunfilesProvider.simple(Runfiles.EMPTY));
if (ruleContext.getRule().getRuleClassObject().getName().equals("honest")) {
builder.addProvider(new RequiredProvider());
}
return builder.build();
}
}
/**
* A base class for mock aspects to reduce boilerplate.
*/
public abstract static class BaseAspect extends NativeAspectClass
implements ConfiguredAspectFactory {
@Override
public ConfiguredAspect create(
ConfiguredTarget base, RuleContext ruleContext, AspectParameters parameters) {
String information = parameters.isEmpty()
? ""
: " data " + Iterables.getFirst(parameters.getAttribute("baz"), null);
return new ConfiguredAspect.Builder(this, parameters, ruleContext)
.addProvider(
new AspectInfo(
collectAspectData("aspect " + ruleContext.getLabel() + information, ruleContext)))
.build();
}
}
public static final SimpleAspect SIMPLE_ASPECT = new SimpleAspect();
private static final AspectDefinition SIMPLE_ASPECT_DEFINITION =
new AspectDefinition.Builder(SIMPLE_ASPECT).build();
/**
* A very simple aspect.
*/
public static class SimpleAspect extends BaseAspect {
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
return SIMPLE_ASPECT_DEFINITION;
}
}
public static final ExtraAttributeAspect EXTRA_ATTRIBUTE_ASPECT = new ExtraAttributeAspect();
private static final AspectDefinition EXTRA_ATTRIBUTE_ASPECT_DEFINITION =
new AspectDefinition.Builder(EXTRA_ATTRIBUTE_ASPECT)
.add(attr("$dep", LABEL).value(Label.parseAbsoluteUnchecked("//extra:extra")))
.build();
private static final ExtraAttributeAspectRequiringProvider
EXTRA_ATTRIBUTE_ASPECT_REQUIRING_PROVIDER = new ExtraAttributeAspectRequiringProvider();
private static final AspectDefinition EXTRA_ATTRIBUTE_ASPECT_REQUIRING_PROVIDER_DEFINITION =
new AspectDefinition.Builder(EXTRA_ATTRIBUTE_ASPECT_REQUIRING_PROVIDER)
.add(attr("$dep", LABEL).value(Label.parseAbsoluteUnchecked("//extra:extra")))
.requireProvider(RequiredProvider.class)
.build();
/**
* An aspect that defines its own implicit attribute.
*/
public static class ExtraAttributeAspect extends BaseAspect {
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
return EXTRA_ATTRIBUTE_ASPECT_DEFINITION;
}
}
public static final AttributeAspect ATTRIBUTE_ASPECT = new AttributeAspect();
private static final AspectDefinition ATTRIBUTE_ASPECT_DEFINITION =
new AspectDefinition.Builder(ATTRIBUTE_ASPECT)
.attributeAspect("foo", ATTRIBUTE_ASPECT)
.build();
/**
* An aspect that propagates along all attributes.
*/
public static class AllAttributesAspect extends BaseAspect {
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
return ALL_ATTRIBUTES_ASPECT_DEFINITION;
}
}
public static final NativeAspectClass ALL_ATTRIBUTES_ASPECT = new AllAttributesAspect();
private static final AspectDefinition ALL_ATTRIBUTES_ASPECT_DEFINITION =
new AspectDefinition.Builder(ALL_ATTRIBUTES_ASPECT)
.allAttributesAspect(ALL_ATTRIBUTES_ASPECT)
.build();
/** An aspect that propagates along all attributes and has a tool dependency. */
public static class AllAttributesWithToolAspect extends BaseAspect {
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
return ALL_ATTRIBUTES_WITH_TOOL_ASPECT_DEFINITION;
}
}
public static final NativeAspectClass ALL_ATTRIBUTES_WITH_TOOL_ASPECT =
new AllAttributesWithToolAspect();
private static final AspectDefinition ALL_ATTRIBUTES_WITH_TOOL_ASPECT_DEFINITION =
new AspectDefinition.Builder(ALL_ATTRIBUTES_WITH_TOOL_ASPECT)
.allAttributesAspect(ALL_ATTRIBUTES_WITH_TOOL_ASPECT)
.add(
attr("$tool", BuildType.LABEL)
.allowedFileTypes(FileTypeSet.ANY_FILE)
.value(Label.parseAbsoluteUnchecked("//a:tool")))
.build();
/**
* An aspect that requires aspects on the attributes of rules it attaches to.
*/
public static class AttributeAspect extends BaseAspect {
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
return ATTRIBUTE_ASPECT_DEFINITION;
}
}
/**
* An aspect that defines its own implicit attribute and requires provider.
*/
public static class ExtraAttributeAspectRequiringProvider extends BaseAspect {
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
return EXTRA_ATTRIBUTE_ASPECT_REQUIRING_PROVIDER_DEFINITION;
}
}
public static class AspectRequiringProvider extends BaseAspect {
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
return ASPECT_REQUIRING_PROVIDER_DEFINITION;
}
}
/**
* An aspect that has a definition depending on parameters provided by originating rule.
*/
public static class ParametrizedDefinitionAspect extends NativeAspectClass
implements ConfiguredAspectFactory {
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
AspectDefinition.Builder builder =
new AspectDefinition.Builder(PARAMETRIZED_DEFINITION_ASPECT)
.attributeAspect("foo", this);
ImmutableCollection<String> baz = aspectParameters.getAttribute("baz");
if (baz != null) {
try {
builder.add(attr("$dep", LABEL).value(Label.parseAbsolute(baz.iterator().next())));
} catch (LabelSyntaxException e) {
throw new IllegalStateException();
}
}
return builder.build();
}
@Override
public ConfiguredAspect create(
ConfiguredTarget base, RuleContext ruleContext, AspectParameters parameters) {
StringBuilder information = new StringBuilder("aspect " + ruleContext.getLabel());
if (!parameters.isEmpty()) {
information.append(" data " + Iterables.getFirst(parameters.getAttribute("baz"), null));
information.append(" ");
}
List<? extends TransitiveInfoCollection> deps =
ruleContext.getPrerequisites("$dep", Mode.TARGET);
information.append("$dep:[");
for (TransitiveInfoCollection dep : deps) {
information.append(" ");
information.append(dep.getLabel());
}
information.append("]");
return new ConfiguredAspect.Builder(this, parameters, ruleContext)
.addProvider(new AspectInfo(collectAspectData(information.toString(), ruleContext)))
.build();
}
}
private static final ParametrizedDefinitionAspect PARAMETRIZED_DEFINITION_ASPECT =
new ParametrizedDefinitionAspect();
private static final AspectRequiringProvider ASPECT_REQUIRING_PROVIDER =
new AspectRequiringProvider();
private static final AspectDefinition ASPECT_REQUIRING_PROVIDER_DEFINITION =
new AspectDefinition.Builder(ASPECT_REQUIRING_PROVIDER)
.requireProvider(RequiredProvider.class)
.build();
/**
* An aspect that prints a warning.
*/
public static class WarningAspect extends NativeAspectClass
implements ConfiguredAspectFactory {
@Override
public ConfiguredAspect create(
ConfiguredTarget base, RuleContext ruleContext, AspectParameters parameters) {
ruleContext.ruleWarning("Aspect warning on " + base.getTarget().getLabel());
return new ConfiguredAspect.Builder(this, parameters, ruleContext).build();
}
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
return WARNING_ASPECT_DEFINITION;
}
}
public static final WarningAspect WARNING_ASPECT = new WarningAspect();
private static final AspectDefinition WARNING_ASPECT_DEFINITION =
new AspectDefinition.Builder(WARNING_ASPECT)
.attributeAspect("bar", WARNING_ASPECT)
.build();
/**
* An aspect that raises an error.
*/
public static class ErrorAspect extends NativeAspectClass
implements ConfiguredAspectFactory {
@Override
public ConfiguredAspect create(
ConfiguredTarget base, RuleContext ruleContext, AspectParameters parameters) {
ruleContext.ruleError("Aspect error");
return null;
}
@Override
public AspectDefinition getDefinition(AspectParameters aspectParameters) {
return ERROR_ASPECT_DEFINITION;
}
}
public static final ErrorAspect ERROR_ASPECT = new ErrorAspect();
private static final AspectDefinition ERROR_ASPECT_DEFINITION =
new AspectDefinition.Builder(ERROR_ASPECT)
.attributeAspect("bar", ERROR_ASPECT)
.build();
/**
* A common base rule for mock rules in this class to reduce boilerplate.
*
* <p>It has a few common attributes because internal Blaze machinery assumes the presence of
* these.
*/
public static class BaseRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("testonly", BOOLEAN).nonconfigurable("test").value(false))
.add(attr("deprecation", STRING).nonconfigurable("test").value((String) null))
.add(attr("tags", STRING_LIST))
.add(attr("visibility", NODEP_LABEL_LIST).orderIndependent().cfg(HOST)
.nonconfigurable("test"))
.add(attr(RuleClass.COMPATIBLE_ENVIRONMENT_ATTR, LABEL_LIST)
.allowedFileTypes(FileTypeSet.NO_FILE))
.add(attr(RuleClass.RESTRICTED_ENVIRONMENT_ATTR, LABEL_LIST)
.allowedFileTypes(FileTypeSet.NO_FILE))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("base")
.factoryClass(DummyRuleFactory.class)
.build();
}
}
/**
* A rule that defines an aspect on one of its attributes.
*/
public static class AspectRequiringRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("foo", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE)
.aspect(SIMPLE_ASPECT))
.add(attr("bar", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE)
.aspect(SIMPLE_ASPECT))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("aspect")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* A rule that defines an {@link AspectRequiringProvider} on one of its attributes.
*/
public static class AspectRequiringProviderRule implements RuleDefinition {
private static final class TestAspectParametersExtractor implements
Function<Rule, AspectParameters> {
@Override
public AspectParameters apply(Rule rule) {
if (rule.isAttrDefined("baz", STRING)) {
String value = rule.getAttributeContainer().getAttr("baz").toString();
if (!value.equals("")) {
return new AspectParameters.Builder().addAttribute("baz", value).build();
}
}
return AspectParameters.EMPTY;
}
}
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("foo", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE)
.aspect(ASPECT_REQUIRING_PROVIDER, new TestAspectParametersExtractor()))
.add(attr("baz", STRING))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("aspect_requiring_provider")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* A rule that defines an {@link ExtraAttributeAspect} on one of its attributes.
*/
public static class ExtraAttributeAspectRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("foo", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE)
.aspect(EXTRA_ATTRIBUTE_ASPECT))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("rule_with_extra_deps_aspect")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* A rule that defines an {@link ParametrizedDefinitionAspect} on one of its attributes.
*/
public static class ParametrizedDefinitionAspectRule implements RuleDefinition {
private static final class TestAspectParametersExtractor
implements Function<Rule, AspectParameters> {
@Override
public AspectParameters apply(Rule rule) {
if (rule.isAttrDefined("baz", STRING)) {
String value = rule.getAttributeContainer().getAttr("baz").toString();
if (!value.equals("")) {
return new AspectParameters.Builder().addAttribute("baz", value).build();
}
}
return AspectParameters.EMPTY;
}
}
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(
attr("foo", LABEL_LIST)
.allowedFileTypes(FileTypeSet.ANY_FILE)
.aspect(PARAMETRIZED_DEFINITION_ASPECT, new TestAspectParametersExtractor()))
.add(attr("baz", STRING))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("parametrized_definition_aspect")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* A rule that defines an {@link ExtraAttributeAspectRequiringProvider} on one of its attributes.
*/
public static class ExtraAttributeAspectRequiringProviderRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("foo", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE)
.aspect(EXTRA_ATTRIBUTE_ASPECT_REQUIRING_PROVIDER))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("extra_attribute_aspect_requiring_provider")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* A rule that defines an {@link AllAttributesAspect} on one of its attributes.
*/
public static class AllAttributesAspectRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("foo", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE)
.aspect(ALL_ATTRIBUTES_ASPECT))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("all_attributes_aspect")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/** A rule that defines an {@link AllAttributesWithToolAspect} on one of its attributes. */
public static class AllAttributesWithToolAspectRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(
attr("foo", LABEL_LIST)
.allowedFileTypes(FileTypeSet.ANY_FILE)
.aspect(ALL_ATTRIBUTES_WITH_TOOL_ASPECT))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("all_attributes_with_tool_aspect")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* A rule that defines a {@link WarningAspect} on one of its attributes.
*/
public static class WarningAspectRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("foo", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE)
.aspect(WARNING_ASPECT))
.add(attr("bar", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("warning_aspect")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* A rule that defines an {@link ErrorAspect} on one of its attributes.
*/
public static class ErrorAspectRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("foo", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE)
.aspect(ERROR_ASPECT))
.add(attr("bar", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("error_aspect")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* A simple rule that has an attribute.
*/
public static class SimpleRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("foo", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE))
.add(attr("foo1", LABEL).allowedFileTypes(FileTypeSet.ANY_FILE))
.add(attr("txt", STRING))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("simple")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* A rule that advertises a provider but doesn't implement it.
*/
public static class LiarRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("foo", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE))
.advertiseProvider(RequiredProvider.class)
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("liar")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* A rule that advertises a provider and implements it.
*/
public static class HonestRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("foo", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE))
.advertiseProvider(RequiredProvider.class)
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("honest")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* Rule with an implcit dependency.
*/
public static class ImplicitDepRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr("$dep", LABEL).value(Label.parseAbsoluteUnchecked("//extra:extra")))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("implicit_dep")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
/**
* Rule with a late-bound dependency.
*/
public static class LateBoundDepRule implements RuleDefinition {
private static final LateBoundLabelList<BuildConfiguration> PLUGINS_LABEL_LIST =
new LateBoundLabelList<BuildConfiguration>() {
@Override
public List<Label> resolve(Rule rule, AttributeMap attributes,
BuildConfiguration configuration) {
return configuration.getPlugins();
}
};
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr(":plugins", LABEL_LIST).value(PLUGINS_LABEL_LIST))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("late_bound_dep")
.factoryClass(DummyRuleFactory.class)
.ancestors(BaseRule.class)
.build();
}
}
}
|