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
|
// Copyright 2014 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.testutil;
import static com.google.devtools.build.lib.packages.Attribute.attr;
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.syntax.Type.INTEGER;
import static com.google.devtools.build.lib.syntax.Type.STRING_LIST;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.analysis.BaseRuleClasses;
import com.google.devtools.build.lib.analysis.ConfiguredRuleClassProvider;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.MakeVariableInfo;
import com.google.devtools.build.lib.analysis.PlatformConfiguration;
import com.google.devtools.build.lib.analysis.RuleConfiguredTargetBuilder;
import com.google.devtools.build.lib.analysis.RuleConfiguredTargetFactory;
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.RunfilesProvider;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.packages.RuleClass.Builder;
import com.google.devtools.build.lib.syntax.Type;
import com.google.devtools.build.lib.util.FileTypeSet;
import java.lang.reflect.Method;
import java.util.Map;
/**
* Helper class to provide a RuleClassProvider for tests.
*/
public class TestRuleClassProvider {
private static ConfiguredRuleClassProvider ruleProvider = null;
/**
* Adds all the rule classes supported internally within the build tool to the given builder.
*/
public static void addStandardRules(ConfiguredRuleClassProvider.Builder builder) {
try {
Class<?> providerClass = Class.forName(TestConstants.TEST_RULE_CLASS_PROVIDER);
// The method setup in the rule class provider requires the tools repository to be set
// beforehand.
builder.setToolsRepository(TestConstants.TOOLS_REPOSITORY);
Method setupMethod = providerClass.getMethod("setup",
ConfiguredRuleClassProvider.Builder.class);
setupMethod.invoke(null, builder);
} catch (Exception e) {
throw new IllegalStateException(e);
}
}
/**
* Return a rule class provider.
*/
public static ConfiguredRuleClassProvider getRuleClassProvider() {
if (ruleProvider == null) {
ConfiguredRuleClassProvider.Builder builder =
new ConfiguredRuleClassProvider.Builder();
addStandardRules(builder);
builder.addRuleDefinition(new TestingDummyRule());
builder.addRuleDefinition(new MockToolchainRule());
ruleProvider = builder.build();
}
return ruleProvider;
}
/**
* A dummy rule with some dummy attributes.
*/
public static final class TestingDummyRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment env) {
return builder
.setUndocumented()
.add(attr("srcs", LABEL_LIST).allowedFileTypes(FileTypeSet.ANY_FILE))
.add(attr("outs", OUTPUT_LIST))
.add(attr("dummystrings", STRING_LIST))
.add(attr("dummyinteger", INTEGER))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("testing_dummy_rule")
.ancestors(BaseRuleClasses.RuleBase.class)
.factoryClass(UnknownRuleConfiguredTarget.class)
.build();
}
}
/**
* Stub rule to test Make variable expansion.
*/
public static final class MakeVariableTester implements RuleConfiguredTargetFactory {
@Override
public ConfiguredTarget create(RuleContext ruleContext)
throws InterruptedException, RuleErrorException {
Map<String, String> variables = ruleContext.attributes().get("variables", Type.STRING_DICT);
return new RuleConfiguredTargetBuilder(ruleContext)
.setFilesToBuild(NestedSetBuilder.emptySet(Order.STABLE_ORDER))
.addProvider(RunfilesProvider.EMPTY)
.addNativeDeclaredProvider(new MakeVariableInfo(ImmutableMap.copyOf(variables)))
.build();
}
}
/**
* Definition of a stub rule to test Make variable expansion.
*/
public static final class MakeVariableTesterRule implements RuleDefinition {
@Override
public RuleClass build(Builder builder, RuleDefinitionEnvironment environment) {
return builder
.advertiseProvider(MakeVariableInfo.class)
.add(attr("variables", Type.STRING_DICT))
.build();
}
@Override
public Metadata getMetadata() {
return Metadata.builder()
.name("make_variable_tester")
.ancestors(
BaseRuleClasses.BaseRule.class, BaseRuleClasses.MakeVariableExpandingRule.class)
.factoryClass(MakeVariableTester.class)
.build();
}
}
/** A mock rule that requires a toolchain. */
public static class MockToolchainRule implements RuleDefinition {
@Override
public RuleClass build(RuleClass.Builder builder, RuleDefinitionEnvironment env) {
return builder
.requiresConfigurationFragments(PlatformConfiguration.class)
.addRequiredToolchains(
ImmutableList.of(Label.parseAbsoluteUnchecked("//toolchain:test_toolchain")))
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("mock_toolchain_rule")
.factoryClass(UnknownRuleConfiguredTarget.class)
.ancestors(BaseRuleClasses.RuleBase.class)
.build();
}
}
}
|
