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
|
// Copyright 2016 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.devtools.build.lib.packages.Attribute.attr;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.config.BuildOptions;
import com.google.devtools.build.lib.analysis.config.ConfigurationEnvironment;
import com.google.devtools.build.lib.analysis.config.ConfigurationFragmentFactory;
import com.google.devtools.build.lib.analysis.config.FragmentOptions;
import com.google.devtools.build.lib.analysis.config.InvalidConfigurationException;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.packages.Attribute;
import com.google.devtools.build.lib.packages.AttributeMap;
import com.google.devtools.build.lib.packages.BuildType;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.packages.RuleClass;
import com.google.devtools.build.lib.testutil.TestRuleClassProvider;
import com.google.devtools.build.lib.testutil.UnknownRuleConfiguredTarget;
import com.google.devtools.build.lib.util.FileTypeSet;
import com.google.devtools.common.options.Option;
import com.google.devtools.common.options.OptionsParser.OptionUsageRestrictions;
import java.util.List;
/**
* Rule and configuration class definitions for testing late-bound split attributes.
*/
public class LateBoundSplitUtil {
/**
* A custom {@link FragmentOptions} with the option to be split.
*/
public static class TestOptions extends FragmentOptions { // public for options loader
@Option(
name = "foo",
defaultValue = "",
optionUsageRestrictions = OptionUsageRestrictions.UNDOCUMENTED
)
public String fooFlag;
@Override
public List<Attribute.SplitTransition<BuildOptions>> getPotentialSplitTransitions() {
return ImmutableList.<Attribute.SplitTransition<BuildOptions>>of(SIMPLE_SPLIT);
}
}
/**
* The split.
*/
private static final Attribute.SplitTransition<BuildOptions> SIMPLE_SPLIT =
new Attribute.SplitTransition<BuildOptions>() {
@Override
public List<BuildOptions> split(BuildOptions buildOptions) {
BuildOptions split1 = buildOptions.clone();
split1.get(TestOptions.class).fooFlag = "one";
BuildOptions split2 = buildOptions.clone();
split2.get(TestOptions.class).fooFlag = "two";
return ImmutableList.<BuildOptions>of(split1, split2);
}
@Override
public boolean defaultsToSelf() {
return false;
}
};
/**
* The {@link BuildConfiguration.Fragment} that contains the options.
*/
static class TestFragment extends BuildConfiguration.Fragment {
}
/**
* The fragment's loader.
*/
static class FragmentLoader implements ConfigurationFragmentFactory {
@Override
public BuildConfiguration.Fragment create(ConfigurationEnvironment env,
BuildOptions buildOptions)
throws InvalidConfigurationException {
return new TestFragment();
}
@Override
public Class<? extends BuildConfiguration.Fragment> creates() {
return TestFragment.class;
}
@Override
public ImmutableSet<Class<? extends FragmentOptions>> requiredOptions() {
return ImmutableSet.<Class<? extends FragmentOptions>>of(TestOptions.class);
}
}
/**
* The resolver that chooses the late-bound attribute's value.
*/
private static final Attribute.LateBoundLabel<BuildConfiguration> SIMPLE_LATEBOUND_RESOLVER =
new Attribute.LateBoundLabel<BuildConfiguration>() {
@Override
public Label resolve(Rule rule, AttributeMap attributes, BuildConfiguration configuration) {
return Label.parseAbsoluteUnchecked("//foo:latebound_dep");
}
};
/**
* A custom rule that applies a late-bound split attribute.
*/
static class RuleWithLateBoundSplitAttribute implements RuleDefinition {
@Override
public RuleClass build(RuleClass.Builder builder, RuleDefinitionEnvironment environment) {
return builder
.add(attr(":latebound_split_attr", BuildType.LABEL)
.allowedFileTypes(FileTypeSet.ANY_FILE)
.allowedRuleClasses(Attribute.ANY_RULE)
.cfg(SIMPLE_SPLIT)
.value(SIMPLE_LATEBOUND_RESOLVER))
.requiresConfigurationFragments(TestFragment.class)
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("rule_with_latebound_split")
.ancestors(BaseRuleClasses.RuleBase.class)
.factoryClass(UnknownRuleConfiguredTarget.class)
.build();
}
}
/**
* A custom rule that requires {@link TestFragment}.
*/
static class RuleWithTestFragment implements RuleDefinition {
@Override
public RuleClass build(RuleClass.Builder builder, RuleDefinitionEnvironment environment) {
return builder
.requiresConfigurationFragments(TestFragment.class)
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name("rule_with_test_fragment")
.ancestors(BaseRuleClasses.RuleBase.class)
.factoryClass(UnknownRuleConfiguredTarget.class)
.build();
}
}
/**
* Returns a rule class provider with standard test setup plus the above rules/configs.
*/
static ConfiguredRuleClassProvider getRuleClassProvider() {
ConfiguredRuleClassProvider.Builder builder = new ConfiguredRuleClassProvider.Builder();
TestRuleClassProvider.addStandardRules(builder);
builder.addRuleDefinition(new RuleWithLateBoundSplitAttribute());
builder.addRuleDefinition(new RuleWithTestFragment());
builder.addConfigurationFragment(new FragmentLoader());
builder.addConfigurationOptions(TestOptions.class);
return builder.build();
}
/**
* Returns the {@link TestOptions} from the given configuration.
*/
static TestOptions getOptions(BuildConfiguration config) {
return config.getOptions().get(TestOptions.class);
}
}
|
