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
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
|
// 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.packages;
import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth.assertWithMessage;
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.OUTPUT_LIST;
import static com.google.devtools.build.lib.packages.ImplicitOutputsFunction.substitutePlaceholderIntoTemplate;
import static com.google.devtools.build.lib.packages.RuleClass.NO_EXTERNAL_BINDINGS;
import static com.google.devtools.build.lib.syntax.Type.BOOLEAN;
import static com.google.devtools.build.lib.syntax.Type.INTEGER;
import static com.google.devtools.build.lib.syntax.Type.STRING;
import static com.google.devtools.build.lib.syntax.Type.STRING_LIST;
import static org.junit.Assert.fail;
import com.google.common.base.Function;
import com.google.common.base.Predicate;
import com.google.common.base.Predicates;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
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.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.EventCollector;
import com.google.devtools.build.lib.events.EventKind;
import com.google.devtools.build.lib.events.Location;
import com.google.devtools.build.lib.events.Location.LineAndColumn;
import com.google.devtools.build.lib.packages.Attribute.SkylarkComputedDefaultTemplate.CannotPrecomputeDefaultsException;
import com.google.devtools.build.lib.packages.Attribute.ValidityPredicate;
import com.google.devtools.build.lib.packages.ConfigurationFragmentPolicy.MissingFragmentPolicy;
import com.google.devtools.build.lib.packages.RuleClass.Builder.RuleClassType;
import com.google.devtools.build.lib.packages.RuleClass.Configurator;
import com.google.devtools.build.lib.packages.RuleClass.ConfiguredTargetFactory;
import com.google.devtools.build.lib.packages.RuleFactory.BuildLangTypedAttributeValuesMap;
import com.google.devtools.build.lib.packages.util.PackageLoadingTestCase;
import com.google.devtools.build.lib.syntax.BaseFunction;
import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.Type;
import com.google.devtools.build.lib.vfs.Path;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nullable;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/**
* Tests for {@link RuleClass}.
*/
@RunWith(JUnit4.class)
public class RuleClassTest extends PackageLoadingTestCase {
private static final RuleClass.ConfiguredTargetFactory<Object, Object>
DUMMY_CONFIGURED_TARGET_FACTORY = new RuleClass.ConfiguredTargetFactory<Object, Object>() {
@Override
public Object create(Object ruleContext) throws InterruptedException {
throw new IllegalStateException();
}
};
private static final class DummyFragment extends BuildConfiguration.Fragment {
}
private static final Predicate<String> PREFERRED_DEPENDENCY_PREDICATE = Predicates.alwaysFalse();
private static RuleClass createRuleClassA() throws LabelSyntaxException {
return newRuleClass(
"ruleA",
false,
false,
false,
false,
false,
false,
ImplicitOutputsFunction.NONE,
RuleClass.NO_CHANGE,
null,
DUMMY_CONFIGURED_TARGET_FACTORY,
PredicatesWithMessage.<Rule>alwaysTrue(),
PREFERRED_DEPENDENCY_PREDICATE,
AdvertisedProviderSet.EMPTY,
null,
NO_EXTERNAL_BINDINGS,
null,
ImmutableSet.<Class<?>>of(),
MissingFragmentPolicy.FAIL_ANALYSIS,
true,
attr("my-string-attr", STRING).mandatory().build(),
attr("my-label-attr", LABEL)
.mandatory()
.legacyAllowAnyFileType()
.value(Label.parseAbsolute("//default:label"))
.build(),
attr("my-labellist-attr", LABEL_LIST).mandatory().legacyAllowAnyFileType().build(),
attr("my-integer-attr", INTEGER).value(42).build(),
attr("my-string-attr2", STRING).mandatory().value((String) null).build(),
attr("my-stringlist-attr", STRING_LIST).build(),
attr("my-sorted-stringlist-attr", STRING_LIST).orderIndependent().build());
}
private static RuleClass createRuleClassB(RuleClass ruleClassA) {
// emulates attribute inheritance
List<Attribute> attributes = new ArrayList<>(ruleClassA.getAttributes());
attributes.add(attr("another-string-attr", STRING).mandatory().build());
return newRuleClass(
"ruleB",
false,
false,
false,
false,
false,
false,
ImplicitOutputsFunction.NONE,
RuleClass.NO_CHANGE,
null,
DUMMY_CONFIGURED_TARGET_FACTORY,
PredicatesWithMessage.<Rule>alwaysTrue(),
PREFERRED_DEPENDENCY_PREDICATE,
AdvertisedProviderSet.EMPTY,
null,
NO_EXTERNAL_BINDINGS,
null,
ImmutableSet.<Class<?>>of(),
MissingFragmentPolicy.FAIL_ANALYSIS,
true,
attributes.toArray(new Attribute[0]));
}
@Test
public void testRuleClassBasics() throws Exception {
RuleClass ruleClassA = createRuleClassA();
assertThat(ruleClassA.getName()).isEqualTo("ruleA");
assertThat(ruleClassA.getAttributeCount()).isEqualTo(7);
assertThat((int) ruleClassA.getAttributeIndex("my-string-attr")).isEqualTo(0);
assertThat((int) ruleClassA.getAttributeIndex("my-label-attr")).isEqualTo(1);
assertThat((int) ruleClassA.getAttributeIndex("my-labellist-attr")).isEqualTo(2);
assertThat((int) ruleClassA.getAttributeIndex("my-integer-attr")).isEqualTo(3);
assertThat((int) ruleClassA.getAttributeIndex("my-string-attr2")).isEqualTo(4);
assertThat((int) ruleClassA.getAttributeIndex("my-stringlist-attr")).isEqualTo(5);
assertThat((int) ruleClassA.getAttributeIndex("my-sorted-stringlist-attr")).isEqualTo(6);
assertThat(ruleClassA.getAttributeByName("my-string-attr"))
.isEqualTo(ruleClassA.getAttribute(0));
assertThat(ruleClassA.getAttributeByName("my-label-attr"))
.isEqualTo(ruleClassA.getAttribute(1));
assertThat(ruleClassA.getAttributeByName("my-labellist-attr"))
.isEqualTo(ruleClassA.getAttribute(2));
assertThat(ruleClassA.getAttributeByName("my-integer-attr"))
.isEqualTo(ruleClassA.getAttribute(3));
assertThat(ruleClassA.getAttributeByName("my-string-attr2"))
.isEqualTo(ruleClassA.getAttribute(4));
assertThat(ruleClassA.getAttributeByName("my-stringlist-attr"))
.isEqualTo(ruleClassA.getAttribute(5));
assertThat(ruleClassA.getAttributeByName("my-sorted-stringlist-attr"))
.isEqualTo(ruleClassA.getAttribute(6));
// default based on type
assertThat(ruleClassA.getAttribute(0).getDefaultValue(null)).isEqualTo("");
assertThat(ruleClassA.getAttribute(1).getDefaultValue(null))
.isEqualTo(Label.parseAbsolute("//default:label"));
assertThat(ruleClassA.getAttribute(2).getDefaultValue(null)).isEqualTo(Collections.emptyList());
assertThat(ruleClassA.getAttribute(3).getDefaultValue(null)).isEqualTo(42);
// default explicitly specified
assertThat(ruleClassA.getAttribute(4).getDefaultValue(null)).isNull();
assertThat(ruleClassA.getAttribute(5).getDefaultValue(null)).isEqualTo(Collections.emptyList());
assertThat(ruleClassA.getAttribute(6).getDefaultValue(null)).isEqualTo(Collections.emptyList());
}
@Test
public void testRuleClassInheritance() throws Exception {
RuleClass ruleClassA = createRuleClassA();
RuleClass ruleClassB = createRuleClassB(ruleClassA);
assertThat(ruleClassB.getName()).isEqualTo("ruleB");
assertThat(ruleClassB.getAttributeCount()).isEqualTo(8);
assertThat((int) ruleClassB.getAttributeIndex("my-string-attr")).isEqualTo(0);
assertThat((int) ruleClassB.getAttributeIndex("my-label-attr")).isEqualTo(1);
assertThat((int) ruleClassB.getAttributeIndex("my-labellist-attr")).isEqualTo(2);
assertThat((int) ruleClassB.getAttributeIndex("my-integer-attr")).isEqualTo(3);
assertThat((int) ruleClassB.getAttributeIndex("my-string-attr2")).isEqualTo(4);
assertThat((int) ruleClassB.getAttributeIndex("my-stringlist-attr")).isEqualTo(5);
assertThat((int) ruleClassB.getAttributeIndex("my-sorted-stringlist-attr")).isEqualTo(6);
assertThat((int) ruleClassB.getAttributeIndex("another-string-attr")).isEqualTo(7);
assertThat(ruleClassB.getAttributeByName("my-string-attr"))
.isEqualTo(ruleClassB.getAttribute(0));
assertThat(ruleClassB.getAttributeByName("my-label-attr"))
.isEqualTo(ruleClassB.getAttribute(1));
assertThat(ruleClassB.getAttributeByName("my-labellist-attr"))
.isEqualTo(ruleClassB.getAttribute(2));
assertThat(ruleClassB.getAttributeByName("my-integer-attr"))
.isEqualTo(ruleClassB.getAttribute(3));
assertThat(ruleClassB.getAttributeByName("my-string-attr2"))
.isEqualTo(ruleClassB.getAttribute(4));
assertThat(ruleClassB.getAttributeByName("my-stringlist-attr"))
.isEqualTo(ruleClassB.getAttribute(5));
assertThat(ruleClassB.getAttributeByName("my-sorted-stringlist-attr"))
.isEqualTo(ruleClassB.getAttribute(6));
assertThat(ruleClassB.getAttributeByName("another-string-attr"))
.isEqualTo(ruleClassB.getAttribute(7));
}
private static final String TEST_PACKAGE_NAME = "testpackage";
private static final String TEST_RULE_NAME = "my-rule-A";
private static final int TEST_RULE_DEFINED_AT_LINE = 42;
private static final String TEST_RULE_LABEL = "@//" + TEST_PACKAGE_NAME + ":" + TEST_RULE_NAME;
private Path testBuildfilePath;
private Location testRuleLocation;
@Before
public final void setRuleLocation() throws Exception {
testBuildfilePath = scratch.resolve("/home/user/workspace/testpackage/BUILD");
testRuleLocation = Location.fromPathAndStartColumn(
testBuildfilePath.asFragment(), 0, 0, new LineAndColumn(TEST_RULE_DEFINED_AT_LINE, 0));
}
private Package.Builder createDummyPackageBuilder() {
return packageFactory.newPackageBuilder(
PackageIdentifier.createInMainRepo(TEST_PACKAGE_NAME), "TESTING")
.setFilename(testBuildfilePath)
.setMakeEnv(new MakeEnvironment.Builder());
}
@Test
public void testDuplicatedDeps() throws Exception {
RuleClass depsRuleClass =
newRuleClass(
"ruleDeps",
false,
false,
false,
false,
false,
false,
ImplicitOutputsFunction.NONE,
RuleClass.NO_CHANGE,
null,
DUMMY_CONFIGURED_TARGET_FACTORY,
PredicatesWithMessage.<Rule>alwaysTrue(),
PREFERRED_DEPENDENCY_PREDICATE,
AdvertisedProviderSet.EMPTY,
null,
NO_EXTERNAL_BINDINGS,
null,
ImmutableSet.<Class<?>>of(),
MissingFragmentPolicy.FAIL_ANALYSIS,
true,
attr("list1", LABEL_LIST).mandatory().legacyAllowAnyFileType().build(),
attr("list2", LABEL_LIST).mandatory().legacyAllowAnyFileType().build(),
attr("list3", LABEL_LIST).mandatory().legacyAllowAnyFileType().build());
// LinkedHashMap -> predictable iteration order for testing
Map<String, Object> attributeValues = new LinkedHashMap<>();
attributeValues.put("list1", Lists.newArrayList("//testpackage:dup1", ":dup1", ":nodup"));
attributeValues.put("list2", Lists.newArrayList(":nodup1", ":nodup2"));
attributeValues.put("list3", Lists.newArrayList(":dup1", ":dup1", ":dup2", ":dup2"));
reporter.removeHandler(failFastHandler);
createRule(depsRuleClass, "depsRule", attributeValues, testRuleLocation);
assertThat(eventCollector.count()).isSameAs(3);
assertDupError("//testpackage:dup1", "list1", "depsRule");
assertDupError("//testpackage:dup1", "list3", "depsRule");
assertDupError("//testpackage:dup2", "list3", "depsRule");
}
private void assertDupError(String label, String attrName, String ruleName) {
assertContainsEvent(String.format("Label '%s' is duplicated in the '%s' attribute of rule '%s'",
label, attrName, ruleName));
}
@Test
public void testCreateRuleWithLegacyPublicVisibility() throws Exception {
RuleClass ruleClass =
newRuleClass(
"ruleVis",
false,
false,
false,
false,
false,
false,
ImplicitOutputsFunction.NONE,
RuleClass.NO_CHANGE,
null,
DUMMY_CONFIGURED_TARGET_FACTORY,
PredicatesWithMessage.<Rule>alwaysTrue(),
PREFERRED_DEPENDENCY_PREDICATE,
AdvertisedProviderSet.EMPTY,
null,
NO_EXTERNAL_BINDINGS,
null,
ImmutableSet.<Class<?>>of(),
MissingFragmentPolicy.FAIL_ANALYSIS,
true,
attr("visibility", LABEL_LIST).legacyAllowAnyFileType().build());
Map<String, Object> attributeValues = new HashMap<>();
attributeValues.put("visibility", Arrays.asList("//visibility:legacy_public"));
reporter.removeHandler(failFastHandler);
EventCollector collector = new EventCollector(EventKind.ERRORS);
reporter.addHandler(collector);
createRule(ruleClass, TEST_RULE_NAME, attributeValues, testRuleLocation);
assertContainsEvent("//visibility:legacy_public only allowed in package declaration");
}
@Test
public void testCreateRule() throws Exception {
RuleClass ruleClassA = createRuleClassA();
// LinkedHashMap -> predictable iteration order for testing
Map<String, Object> attributeValues = new LinkedHashMap<>();
attributeValues.put("my-labellist-attr", "foobar"); // wrong type
attributeValues.put("bogus-attr", "foobar"); // no such attr
attributeValues.put("my-stringlist-attr", Arrays.asList("foo", "bar"));
reporter.removeHandler(failFastHandler);
EventCollector collector = new EventCollector(EventKind.ERRORS);
reporter.addHandler(collector);
Rule rule = createRule(ruleClassA, TEST_RULE_NAME, attributeValues, testRuleLocation);
// TODO(blaze-team): (2009) refactor to use assertContainsEvent
Iterator<String> expectedMessages = Arrays.asList(
"expected value of type 'list(label)' for attribute 'my-labellist-attr' "
+ "in 'ruleA' rule, but got \"foobar\" (string)",
"no such attribute 'bogus-attr' in 'ruleA' rule",
"missing value for mandatory "
+ "attribute 'my-string-attr' in 'ruleA' rule",
"missing value for mandatory attribute 'my-label-attr' in 'ruleA' rule",
"missing value for mandatory "
+ "attribute 'my-labellist-attr' in 'ruleA' rule",
"missing value for mandatory "
+ "attribute 'my-string-attr2' in 'ruleA' rule"
).iterator();
for (Event event : collector) {
assertThat(event.getLocation().getStartLineAndColumn().getLine())
.isEqualTo(TEST_RULE_DEFINED_AT_LINE);
assertThat(event.getLocation().getPath()).isEqualTo(testBuildfilePath.asFragment());
assertThat(event.getMessage())
.isEqualTo(TEST_RULE_LABEL.toString().substring(1) + ": " + expectedMessages.next());
}
// Test basic rule properties:
assertThat(rule.getRuleClass()).isEqualTo("ruleA");
assertThat(rule.getName()).isEqualTo(TEST_RULE_NAME);
assertThat(rule.getLabel().toString()).isEqualTo(TEST_RULE_LABEL.substring(1));
// Test attribute access:
AttributeMap attributes = RawAttributeMapper.of(rule);
assertThat(attributes.get("my-label-attr", BuildType.LABEL).toString())
.isEqualTo("//default:label");
assertThat(attributes.get("my-integer-attr", Type.INTEGER).intValue()).isEqualTo(42);
// missing attribute -> default chosen based on type
assertThat(attributes.get("my-string-attr", Type.STRING)).isEmpty();
assertThat(attributes.get("my-labellist-attr", BuildType.LABEL_LIST)).isEmpty();
assertThat(attributes.get("my-stringlist-attr", Type.STRING_LIST))
.isEqualTo(Arrays.asList("foo", "bar"));
try {
attributes.get("my-labellist-attr", Type.STRING); // wrong type
fail();
} catch (IllegalArgumentException e) {
assertThat(e).hasMessage("Attribute my-labellist-attr is of type list(label) "
+ "and not of type string in ruleA rule //testpackage:my-rule-A");
}
}
@Test
public void testImplicitOutputs() throws Exception {
RuleClass ruleClassC =
newRuleClass(
"ruleC",
false,
false,
false,
false,
false,
false,
ImplicitOutputsFunction.fromTemplates(
"foo-%{name}.bar", "lib%{name}-wazoo-%{name}.mumble", "stuff-%{outs}-bar"),
RuleClass.NO_CHANGE,
null,
DUMMY_CONFIGURED_TARGET_FACTORY,
PredicatesWithMessage.<Rule>alwaysTrue(),
PREFERRED_DEPENDENCY_PREDICATE,
AdvertisedProviderSet.EMPTY,
null,
NO_EXTERNAL_BINDINGS,
null,
ImmutableSet.<Class<?>>of(),
MissingFragmentPolicy.FAIL_ANALYSIS,
true,
attr("name", STRING).build(),
attr("outs", OUTPUT_LIST).build());
Map<String, Object> attributeValues = new HashMap<>();
attributeValues.put("outs", Collections.singletonList("explicit_out"));
attributeValues.put("name", "myrule");
Rule rule = createRule(ruleClassC, "myrule", attributeValues, testRuleLocation);
Set<String> set = new HashSet<>();
for (OutputFile outputFile : rule.getOutputFiles()) {
set.add(outputFile.getName());
assertThat(outputFile.getGeneratingRule()).isSameAs(rule);
}
assertThat(set).containsExactly("foo-myrule.bar", "libmyrule-wazoo-myrule.mumble",
"stuff-explicit_out-bar", "explicit_out");
}
@Test
public void testImplicitOutsWithBasenameDirname() throws Exception {
RuleClass ruleClass =
newRuleClass(
"ruleClass",
false,
false,
false,
false,
false,
false,
ImplicitOutputsFunction.fromTemplates("%{dirname}lib%{basename}.bar"),
RuleClass.NO_CHANGE,
null,
DUMMY_CONFIGURED_TARGET_FACTORY,
PredicatesWithMessage.<Rule>alwaysTrue(),
PREFERRED_DEPENDENCY_PREDICATE,
AdvertisedProviderSet.EMPTY,
null,
NO_EXTERNAL_BINDINGS,
null,
ImmutableSet.<Class<?>>of(),
MissingFragmentPolicy.FAIL_ANALYSIS,
true);
Rule rule = createRule(ruleClass, "myRule", Collections.<String, Object>emptyMap(),
testRuleLocation);
assertThat(Iterables.getOnlyElement(rule.getOutputFiles()).getName())
.isEqualTo("libmyRule.bar");
Rule ruleWithSlash = createRule(ruleClass, "myRule/with/slash",
Collections.<String, Object>emptyMap(), testRuleLocation);
assertThat(Iterables.getOnlyElement(ruleWithSlash.getOutputFiles()).getName())
.isEqualTo("myRule/with/libslash.bar");
}
/**
* Helper routine that instantiates a rule class with the given computed default and supporting
* attributes for the default to reference.
*/
private static RuleClass getRuleClassWithComputedDefault(Attribute computedDefault) {
return newRuleClass(
"ruleClass",
false,
false,
false,
false,
false,
false,
ImplicitOutputsFunction.fromTemplates("empty"),
RuleClass.NO_CHANGE,
null,
DUMMY_CONFIGURED_TARGET_FACTORY,
PredicatesWithMessage.<Rule>alwaysTrue(),
PREFERRED_DEPENDENCY_PREDICATE,
AdvertisedProviderSet.EMPTY,
null,
NO_EXTERNAL_BINDINGS,
null,
ImmutableSet.<Class<?>>of(),
MissingFragmentPolicy.FAIL_ANALYSIS,
true,
attr("condition", BOOLEAN).value(false).build(),
attr("declared1", BOOLEAN).value(false).build(),
attr("declared2", BOOLEAN).value(false).build(),
attr("nonconfigurable", BOOLEAN).nonconfigurable("test").value(false).build(),
computedDefault);
}
/**
* Helper routine that checks that a computed default is valid and bound to the expected value.
*/
private void checkValidComputedDefault(Object expectedValue, Attribute computedDefault,
ImmutableMap<String, Object> attrValueMap) throws Exception {
assertThat(computedDefault.getDefaultValueForTesting() instanceof Attribute.ComputedDefault)
.isTrue();
Rule rule = createRule(getRuleClassWithComputedDefault(computedDefault), "myRule",
attrValueMap, testRuleLocation);
AttributeMap attributes = RawAttributeMapper.of(rule);
assertThat(attributes.get(computedDefault.getName(), computedDefault.getType()))
.isEqualTo(expectedValue);
}
/**
* Helper routine that checks that a computed default is invalid due to declared dependency
* issues and fails with the expected message.
*/
private void checkInvalidComputedDefault(Attribute computedDefault, String expectedMessage)
throws Exception {
try {
createRule(getRuleClassWithComputedDefault(computedDefault), "myRule",
ImmutableMap.<String, Object>of(), testRuleLocation);
fail("Expected computed default \"" + computedDefault.getName() + "\" to fail with "
+ "declaration errors");
} catch (IllegalArgumentException e) {
// Expected outcome.
assertThat(e).hasMessage(expectedMessage);
}
}
/**
* Tests computed default values are computed as expected.
*/
@Test
public void testComputedDefault() throws Exception {
Attribute computedDefault =
attr("$result", BOOLEAN).value(new Attribute.ComputedDefault("condition") {
@Override
public Object getDefault(AttributeMap rule) {
return rule.get("condition", Type.BOOLEAN);
}
}).build();
checkValidComputedDefault(Boolean.FALSE, computedDefault,
ImmutableMap.<String, Object>of("condition", Boolean.FALSE));
checkValidComputedDefault(Boolean.TRUE, computedDefault,
ImmutableMap.<String, Object>of("condition", Boolean.TRUE));
}
/**
* Tests that computed defaults can only read attribute values for configurable attributes that
* have been explicitly declared.
*/
@Test
public void testComputedDefaultDeclarations() throws Exception {
checkValidComputedDefault(
Boolean.FALSE,
attr("$good_default_no_declares", BOOLEAN).value(
new Attribute.ComputedDefault() {
@Override public Object getDefault(AttributeMap rule) {
// OK: not a value check:
return rule.isAttributeValueExplicitlySpecified("undeclared");
}
}).build(),
ImmutableMap.<String, Object>of());
checkValidComputedDefault(
Boolean.FALSE,
attr("$good_default_one_declare", BOOLEAN).value(
new Attribute.ComputedDefault("declared1") {
@Override public Object getDefault(AttributeMap rule) {
return rule.get("declared1", Type.BOOLEAN);
}
}).build(),
ImmutableMap.<String, Object>of());
checkValidComputedDefault(
Boolean.FALSE,
attr("$good_default_two_declares", BOOLEAN).value(
new Attribute.ComputedDefault("declared1", "declared2") {
@Override public Object getDefault(AttributeMap rule) {
return rule.get("declared1", Type.BOOLEAN) && rule.get("declared2", Type.BOOLEAN);
}
}).build(),
ImmutableMap.<String, Object>of());
checkInvalidComputedDefault(
attr("$bad_default_no_declares", BOOLEAN).value(
new Attribute.ComputedDefault() {
@Override public Object getDefault(AttributeMap rule) {
return rule.get("declared1", Type.BOOLEAN);
}
}).build(),
"attribute \"declared1\" isn't available in this computed default context");
checkInvalidComputedDefault(
attr("$bad_default_one_declare", BOOLEAN).value(
new Attribute.ComputedDefault("declared1") {
@Override public Object getDefault(AttributeMap rule) {
return rule.get("declared1", Type.BOOLEAN) || rule.get("declared2", Type.BOOLEAN);
}
}).build(),
"attribute \"declared2\" isn't available in this computed default context");
checkInvalidComputedDefault(
attr("$bad_default_two_declares", BOOLEAN).value(
new Attribute.ComputedDefault("declared1", "declared2") {
@Override public Object getDefault(AttributeMap rule) {
return rule.get("condition", Type.BOOLEAN);
}
}).build(),
"attribute \"condition\" isn't available in this computed default context");
}
/**
* Tests that computed defaults *can* read attribute values for non-configurable attributes
* without needing to explicitly declare them.
*/
@Test
public void testComputedDefaultWithNonConfigurableAttributes() throws Exception {
checkValidComputedDefault(
Boolean.FALSE,
attr("$good_default_reading_undeclared_nonconfigurable_attribute", BOOLEAN).value(
new Attribute.ComputedDefault() {
@Override public Object getDefault(AttributeMap rule) {
return rule.get("nonconfigurable", Type.BOOLEAN);
}
}).build(),
ImmutableMap.<String, Object>of());
}
@Test
public void testOutputsAreOrdered() throws Exception {
RuleClass ruleClassC =
newRuleClass(
"ruleC",
false,
false,
false,
false,
false,
false,
ImplicitOutputsFunction.fromTemplates("first-%{name}", "second-%{name}", "out-%{outs}"),
RuleClass.NO_CHANGE,
null,
DUMMY_CONFIGURED_TARGET_FACTORY,
PredicatesWithMessage.<Rule>alwaysTrue(),
PREFERRED_DEPENDENCY_PREDICATE,
AdvertisedProviderSet.EMPTY,
null,
NO_EXTERNAL_BINDINGS,
null,
ImmutableSet.<Class<?>>of(),
MissingFragmentPolicy.FAIL_ANALYSIS,
true,
attr("name", STRING).build(),
attr("outs", OUTPUT_LIST).build());
Map<String, Object> attributeValues = new HashMap<>();
attributeValues.put("outs", ImmutableList.of("third", "fourth"));
attributeValues.put("name", "myrule");
Rule rule = createRule(ruleClassC, "myrule", attributeValues, testRuleLocation);
List<String> actual = new ArrayList<>();
for (OutputFile outputFile : rule.getOutputFiles()) {
actual.add(outputFile.getName());
assertThat(outputFile.getGeneratingRule()).isSameAs(rule);
}
assertWithMessage("unexpected output set").that(actual).containsExactly("first-myrule",
"second-myrule", "out-third", "out-fourth", "third", "fourth");
assertWithMessage("invalid output ordering").that(actual).containsExactly("first-myrule",
"second-myrule", "out-third", "out-fourth", "third", "fourth").inOrder();
}
@Test
public void testSubstitutePlaceholderIntoTemplate() throws Exception {
RuleClass ruleClass =
newRuleClass(
"ruleA",
false,
false,
false,
false,
false,
false,
ImplicitOutputsFunction.NONE,
RuleClass.NO_CHANGE,
null,
DUMMY_CONFIGURED_TARGET_FACTORY,
PredicatesWithMessage.<Rule>alwaysTrue(),
PREFERRED_DEPENDENCY_PREDICATE,
AdvertisedProviderSet.EMPTY,
null,
NO_EXTERNAL_BINDINGS,
null,
ImmutableSet.<Class<?>>of(),
MissingFragmentPolicy.FAIL_ANALYSIS,
true,
attr("a", STRING_LIST).mandatory().build(),
attr("b", STRING_LIST).mandatory().build(),
attr("c", STRING_LIST).mandatory().build(),
attr("baz", STRING_LIST).mandatory().build(),
attr("empty", STRING_LIST).build());
Map<String, Object> attributeValues = new LinkedHashMap<>();
attributeValues.put("a", ImmutableList.of("a", "A"));
attributeValues.put("b", ImmutableList.of("b", "B"));
attributeValues.put("c", ImmutableList.of("c", "C"));
attributeValues.put("baz", ImmutableList.of("baz", "BAZ"));
attributeValues.put("empty", ImmutableList.<String>of());
AttributeMap rule = RawAttributeMapper.of(
createRule(ruleClass, "testrule", attributeValues, testRuleLocation));
assertThat(substitutePlaceholderIntoTemplate("foo", rule)).containsExactly("foo");
assertThat(substitutePlaceholderIntoTemplate("foo-%{baz}-bar", rule)).containsExactly(
"foo-baz-bar", "foo-BAZ-bar").inOrder();
assertThat(substitutePlaceholderIntoTemplate("%{a}-%{b}-%{c}", rule)).containsExactly("a-b-c",
"a-b-C", "a-B-c", "a-B-C", "A-b-c", "A-b-C", "A-B-c", "A-B-C").inOrder();
assertThat(substitutePlaceholderIntoTemplate("%{a", rule)).containsExactly("%{a");
assertThat(substitutePlaceholderIntoTemplate("%{a}}", rule)).containsExactly("a}", "A}")
.inOrder();
assertThat(substitutePlaceholderIntoTemplate("x%{a}y%{empty}", rule)).isEmpty();
}
@Test
public void testOrderIndependentAttribute() throws Exception {
RuleClass ruleClassA = createRuleClassA();
List<String> list = Arrays.asList("foo", "bar", "baz");
Map<String, Object> attributeValues = new LinkedHashMap<>();
// mandatory values
attributeValues.put("my-string-attr", "");
attributeValues.put("my-label-attr", "//project");
attributeValues.put("my-string-attr2", "");
attributeValues.put("my-labellist-attr", Collections.emptyList());
// to compare the effect of .orderIndependent()
attributeValues.put("my-stringlist-attr", list);
attributeValues.put("my-sorted-stringlist-attr", list);
Rule rule = createRule(ruleClassA, "testrule", attributeValues, testRuleLocation);
AttributeMap attributes = RawAttributeMapper.of(rule);
assertThat(attributes.get("my-stringlist-attr", Type.STRING_LIST)).isEqualTo(list);
assertThat(attributes.get("my-sorted-stringlist-attr", Type.STRING_LIST))
.isEqualTo(Arrays.asList("bar", "baz", "foo"));
}
private Rule createRule(
RuleClass ruleClass, String name, Map<String, Object> attributeValues, Location location)
throws LabelSyntaxException, InterruptedException, CannotPrecomputeDefaultsException {
Package.Builder pkgBuilder = createDummyPackageBuilder();
Label ruleLabel;
try {
ruleLabel = pkgBuilder.createLabel(name);
} catch (LabelSyntaxException e) {
throw new IllegalArgumentException("Rule has illegal label");
}
return ruleClass.createRule(
pkgBuilder,
ruleLabel,
new BuildLangTypedAttributeValuesMap(attributeValues),
reporter,
/*ast=*/ null,
location,
new AttributeContainer(ruleClass));
}
@Test
public void testOverrideWithWrongType() {
try {
RuleClass parentRuleClass = createParentRuleClass();
RuleClass.Builder childRuleClassBuilder = new RuleClass.Builder(
"child_rule", RuleClassType.NORMAL, false, parentRuleClass);
childRuleClassBuilder.override(attr("attr", INTEGER));
fail();
} catch (IllegalStateException e) {
assertThat(e).hasMessage("The type of the new attribute 'int' is different from "
+ "the original one 'string'.");
}
}
@Test
public void testOverrideWithRightType() {
RuleClass parentRuleClass = createParentRuleClass();
RuleClass.Builder childRuleClassBuilder = new RuleClass.Builder(
"child_rule", RuleClassType.NORMAL, false, parentRuleClass);
childRuleClassBuilder.override(attr("attr", STRING));
}
@Test
public void testCopyAndOverrideAttribute() throws Exception {
RuleClass parentRuleClass = createParentRuleClass();
RuleClass childRuleClass = createChildRuleClass(parentRuleClass);
Map<String, Object> parentValues = new LinkedHashMap<>();
Map<String, Object> childValues = new LinkedHashMap<>();
childValues.put("attr", "somevalue");
createRule(parentRuleClass, "parent_rule", parentValues, testRuleLocation);
createRule(childRuleClass, "child_rule", childValues, testRuleLocation);
}
@Test
public void testCopyAndOverrideAttributeMandatoryMissing() throws Exception {
RuleClass parentRuleClass = createParentRuleClass();
RuleClass childRuleClass = createChildRuleClass(parentRuleClass);
Map<String, Object> childValues = new LinkedHashMap<>();
reporter.removeHandler(failFastHandler);
createRule(childRuleClass, "child_rule", childValues, testRuleLocation);
assertThat(eventCollector.count()).isSameAs(1);
assertContainsEvent("//testpackage:child_rule: missing value for mandatory "
+ "attribute 'attr' in 'child_rule' rule");
}
@Test
public void testRequiredFragmentInheritance() throws Exception {
RuleClass parentRuleClass = createParentRuleClass();
RuleClass childRuleClass = createChildRuleClass(parentRuleClass);
assertThat(parentRuleClass.getConfigurationFragmentPolicy().getRequiredConfigurationFragments())
.containsExactly(DummyFragment.class);
assertThat(childRuleClass.getConfigurationFragmentPolicy().getRequiredConfigurationFragments())
.containsExactly(DummyFragment.class);
}
private static RuleClass newRuleClass(
String name,
boolean skylarkExecutable,
boolean documented,
boolean publicByDefault,
boolean binaryOutput,
boolean workspaceOnly,
boolean outputsDefaultExecutable,
ImplicitOutputsFunction implicitOutputsFunction,
Configurator<?, ?> configurator,
RuleTransitionFactory transitionFactory,
ConfiguredTargetFactory<?, ?> configuredTargetFactory,
PredicateWithMessage<Rule> validityPredicate,
Predicate<String> preferredDependencyPredicate,
AdvertisedProviderSet advertisedProviders,
@Nullable BaseFunction configuredTargetFunction,
Function<? super Rule, Map<String, Label>> externalBindingsFunction,
@Nullable Environment ruleDefinitionEnvironment,
Set<Class<?>> allowedConfigurationFragments,
MissingFragmentPolicy missingFragmentPolicy,
boolean supportsConstraintChecking,
Attribute... attributes) {
String ruleDefinitionEnvironmentHashCode =
ruleDefinitionEnvironment == null
? null
: ruleDefinitionEnvironment.getTransitiveContentHashCode();
return new RuleClass(
name,
/*isSkylark=*/ skylarkExecutable,
skylarkExecutable,
/*skylarkTestable=*/ false,
documented,
publicByDefault,
binaryOutput,
workspaceOnly,
outputsDefaultExecutable,
implicitOutputsFunction,
/*isConfigMatcher=*/ false,
configurator,
transitionFactory,
configuredTargetFactory,
validityPredicate,
preferredDependencyPredicate,
advertisedProviders,
configuredTargetFunction,
externalBindingsFunction,
/*optionReferenceFunction=*/ RuleClass.NO_OPTION_REFERENCE,
ruleDefinitionEnvironment,
ruleDefinitionEnvironmentHashCode,
new ConfigurationFragmentPolicy.Builder()
.requiresConfigurationFragments(allowedConfigurationFragments)
.setMissingFragmentPolicy(missingFragmentPolicy)
.build(),
supportsConstraintChecking,
/*requiredToolchains=*/ ImmutableList.<ClassObjectConstructor.Key>of(),
attributes);
}
private static RuleClass createParentRuleClass() {
return newRuleClass(
"parent_rule",
false,
false,
false,
false,
false,
false,
ImplicitOutputsFunction.NONE,
RuleClass.NO_CHANGE,
null,
DUMMY_CONFIGURED_TARGET_FACTORY,
PredicatesWithMessage.<Rule>alwaysTrue(),
PREFERRED_DEPENDENCY_PREDICATE,
AdvertisedProviderSet.EMPTY,
null,
NO_EXTERNAL_BINDINGS,
null,
ImmutableSet.<Class<?>>of(DummyFragment.class),
MissingFragmentPolicy.FAIL_ANALYSIS,
true,
attr("attr", STRING).build());
}
private static RuleClass createChildRuleClass(RuleClass parentRuleClass) {
RuleClass.Builder childRuleClassBuilder = new RuleClass.Builder(
"child_rule", RuleClassType.NORMAL, false, parentRuleClass);
return childRuleClassBuilder.override(
childRuleClassBuilder
.factory(DUMMY_CONFIGURED_TARGET_FACTORY)
.copy("attr").mandatory())
.add(attr("tags", STRING_LIST))
.build();
}
@Test
public void testValidityChecker() throws Exception {
RuleClass depClass = new RuleClass.Builder("dep", RuleClassType.NORMAL, false)
.factory(DUMMY_CONFIGURED_TARGET_FACTORY)
.add(attr("tags", STRING_LIST))
.build();
final Rule dep1 = createRule(depClass, "dep1", Collections.<String, Object>emptyMap(),
testRuleLocation);
final Rule dep2 = createRule(depClass, "dep2", Collections.<String, Object>emptyMap(),
testRuleLocation);
ValidityPredicate checker =
new ValidityPredicate() {
@Override
public String checkValid(Rule from, Rule to) {
assertThat(from.getName()).isEqualTo("top");
if (to.getName().equals("dep1")) {
return "pear";
} else if (to.getName().equals("dep2")) {
return null;
} else {
fail("invalid dependency");
return null;
}
}
};
RuleClass topClass = new RuleClass.Builder("top", RuleClassType.NORMAL, false)
.factory(DUMMY_CONFIGURED_TARGET_FACTORY)
.add(attr("tags", STRING_LIST))
.add(attr("deps", LABEL_LIST).legacyAllowAnyFileType()
.validityPredicate(checker))
.build();
Rule topRule = createRule(topClass, "top", Collections.<String, Object>emptyMap(),
testRuleLocation);
assertThat(topClass.getAttributeByName("deps").getValidityPredicate().checkValid(topRule, dep1))
.isEqualTo("pear");
assertThat(topClass.getAttributeByName("deps").getValidityPredicate().checkValid(topRule, dep2))
.isNull();
}
/**
* Tests structure for making certain rules "preferential choices" for certain files
* under --compile_one_dependency.
*/
@Test
public void testPreferredDependencyChecker() throws Exception {
final String cppFile = "file.cc";
final String textFile = "file.txt";
// Default: not preferred for anything.
RuleClass defaultClass = new RuleClass.Builder("defaultClass", RuleClassType.NORMAL, false)
.factory(DUMMY_CONFIGURED_TARGET_FACTORY)
.add(attr("tags", STRING_LIST))
.build();
final Rule defaultRule = createRule(defaultClass, "defaultRule",
Collections.<String, Object>emptyMap(), testRuleLocation);
assertThat(defaultRule.getRuleClassObject().isPreferredDependency(cppFile)).isFalse();
assertThat(defaultRule.getRuleClassObject().isPreferredDependency(textFile)).isFalse();
// Make a rule that's preferred for C++ sources.
RuleClass cppClass = new RuleClass.Builder("cppClass", RuleClassType.NORMAL, false)
.factory(DUMMY_CONFIGURED_TARGET_FACTORY)
.add(attr("tags", STRING_LIST))
.setPreferredDependencyPredicate(new Predicate<String>() {
@Override
public boolean apply(String filename) {
return filename.endsWith(".cc");
}
})
.build();
final Rule cppRule = createRule(cppClass, "cppRule",
Collections.<String, Object>emptyMap(), testRuleLocation);
assertThat(cppRule.getRuleClassObject().isPreferredDependency(cppFile)).isTrue();
assertThat(cppRule.getRuleClassObject().isPreferredDependency(textFile)).isFalse();
}
@Test
public void testBadRuleClassNames() {
expectError(RuleClassType.NORMAL, "8abc");
expectError(RuleClassType.NORMAL, "!abc");
expectError(RuleClassType.NORMAL, "a b");
}
private void expectError(RuleClassType type, String name) {
try {
type.checkName(name);
fail();
} catch (IllegalArgumentException expected) {
// expected
}
}
@Test
public void testRequiredToolchains() throws Exception {
RuleClass.Builder ruleClassBuilder =
new RuleClass.Builder("ruleClass", RuleClassType.NORMAL, false)
.factory(DUMMY_CONFIGURED_TARGET_FACTORY)
.add(attr("tags", STRING_LIST));
ClassObjectConstructor.Key toolchain1 = new ClassObjectConstructor.Key() {};
ClassObjectConstructor.Key toolchain2 = new ClassObjectConstructor.Key() {};
ruleClassBuilder.addRequiredToolchain(toolchain1);
ruleClassBuilder.addRequiredToolchain(toolchain2);
RuleClass ruleClass = ruleClassBuilder.build();
assertThat(ruleClass.getRequiredToolchains()).containsExactly(toolchain1, toolchain2).inOrder();
}
}
|