/
BlazeRuntimeWrapper.java
430 lines (383 loc) · 16.6 KB
/
BlazeRuntimeWrapper.java
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
// Copyright 2019 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.buildtool.util;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.collect.ImmutableList.toImmutableList;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.common.eventbus.EventBus;
import com.google.common.eventbus.Subscribe;
import com.google.devtools.build.lib.analysis.AnalysisOptions;
import com.google.devtools.build.lib.analysis.AnalysisPhaseCompleteEvent;
import com.google.devtools.build.lib.analysis.BlazeDirectories;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.ServerDirectories;
import com.google.devtools.build.lib.analysis.config.BuildConfigurationCollection;
import com.google.devtools.build.lib.bugreport.Crash;
import com.google.devtools.build.lib.bugreport.CrashContext;
import com.google.devtools.build.lib.buildeventstream.BuildEventProtocolOptions;
import com.google.devtools.build.lib.buildtool.BuildRequest;
import com.google.devtools.build.lib.buildtool.BuildRequestOptions;
import com.google.devtools.build.lib.buildtool.BuildResult;
import com.google.devtools.build.lib.buildtool.BuildTool;
import com.google.devtools.build.lib.clock.JavaClock;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.events.Reporter;
import com.google.devtools.build.lib.events.StoredEventHandler;
import com.google.devtools.build.lib.events.util.EventCollectionApparatus;
import com.google.devtools.build.lib.exec.BinTools;
import com.google.devtools.build.lib.exec.ExecutionOptions;
import com.google.devtools.build.lib.exec.local.LocalExecutionOptions;
import com.google.devtools.build.lib.packages.semantics.BuildLanguageOptions;
import com.google.devtools.build.lib.pkgcache.LoadingOptions;
import com.google.devtools.build.lib.pkgcache.PackageOptions;
import com.google.devtools.build.lib.profiler.Profiler;
import com.google.devtools.build.lib.profiler.SilentCloseable;
import com.google.devtools.build.lib.runtime.BlazeCommand;
import com.google.devtools.build.lib.runtime.BlazeCommandResult;
import com.google.devtools.build.lib.runtime.BlazeCommandUtils;
import com.google.devtools.build.lib.runtime.BlazeModule;
import com.google.devtools.build.lib.runtime.BlazeRuntime;
import com.google.devtools.build.lib.runtime.ClientOptions;
import com.google.devtools.build.lib.runtime.Command;
import com.google.devtools.build.lib.runtime.CommandEnvironment;
import com.google.devtools.build.lib.runtime.CommonCommandOptions;
import com.google.devtools.build.lib.runtime.KeepGoingOption;
import com.google.devtools.build.lib.runtime.LoadingPhaseThreadsOption;
import com.google.devtools.build.lib.runtime.UiOptions;
import com.google.devtools.build.lib.runtime.commands.BuildCommand;
import com.google.devtools.build.lib.runtime.proto.InvocationPolicyOuterClass.InvocationPolicy;
import com.google.devtools.build.lib.sandbox.SandboxOptions;
import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
import com.google.devtools.build.lib.server.FailureDetails.Spawn;
import com.google.devtools.build.lib.server.FailureDetails.Spawn.Code;
import com.google.devtools.build.lib.skyframe.SkyframeExecutor;
import com.google.devtools.build.lib.util.DetailedExitCode;
import com.google.devtools.build.lib.util.io.OutErr;
import com.google.devtools.build.lib.worker.WorkerMetricsCollector;
import com.google.devtools.common.options.InvocationPolicyEnforcer;
import com.google.devtools.common.options.OptionsBase;
import com.google.devtools.common.options.OptionsParser;
import com.google.devtools.common.options.OptionsParsingException;
import com.google.protobuf.Any;
import com.google.protobuf.Message;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
/**
* A wrapper for {@link BlazeRuntime} for testing purposes that makes it possible to exercise (most)
* of the build machinery in integration tests. Note that {@code BlazeCommandDispatcher} is not
* exercised here.
*/
public class BlazeRuntimeWrapper {
private final BlazeRuntime runtime;
private CommandEnvironment env;
private final EventCollectionApparatus events;
private boolean commandCreated;
private BuildRequest lastRequest;
private BuildResult lastResult;
private BuildConfigurationCollection configurations;
private ImmutableSet<ConfiguredTarget> topLevelTargets;
private OptionsParser optionsParser;
private final List<String> optionsToParse = new ArrayList<>();
private final Map<String, Object> starlarkOptions = new HashMap<>();
private final List<Class<? extends OptionsBase>> additionalOptionsClasses = new ArrayList<>();
private final List<String> crashMessages = new ArrayList<>();
private final List<Object> eventBusSubscribers = new ArrayList<>();
public BlazeRuntimeWrapper(
EventCollectionApparatus events,
ServerDirectories serverDirectories,
BlazeDirectories directories,
BinTools binTools,
BlazeRuntime.Builder builder)
throws Exception {
this.events = events;
runtime =
builder
.setServerDirectories(serverDirectories)
.addBlazeModule(
new BlazeModule() {
@Override
public void beforeCommand(CommandEnvironment env) {
// This only does something interesting for tests that create their own
// BlazeCommandDispatcher. :-(
if (BlazeRuntimeWrapper.this.env != env) {
BlazeRuntimeWrapper.this.env = env;
BlazeRuntimeWrapper.this.lastRequest = null;
BlazeRuntimeWrapper.this.lastResult = null;
resetOptions();
env.getEventBus().register(this);
}
}
@Subscribe
public void analysisPhaseComplete(AnalysisPhaseCompleteEvent e) {
topLevelTargets = ImmutableSet.copyOf(e.getTopLevelTargets());
}
})
.addBlazeModule(
new BlazeModule() {
@Override
public void beforeCommand(CommandEnvironment env) {
BlazeRuntimeWrapper.this.events.initExternal(env.getReporter());
}
})
.build();
runtime.initWorkspace(directories, binTools);
}
public final BlazeRuntime getRuntime() {
return runtime;
}
/** Registers the given {@code subscriber} with the {@link EventBus} before each command. */
public void registerSubscriber(Object subscriber) {
eventBusSubscribers.add(subscriber);
}
public final CommandEnvironment newCommand() throws Exception {
return newCommand(BuildCommand.class);
}
/** Creates a new command environment; executeBuild does this automatically if you do not. */
public final CommandEnvironment newCommand(Class<? extends BlazeCommand> command)
throws Exception {
return newCommandWithExtensions(command, /*extensions=*/ ImmutableList.of());
}
/**
* Creates a new command environment with additional proto extensions as if they were passed to
* the blaze server.
*/
public final CommandEnvironment newCommandWithExtensions(
Class<? extends BlazeCommand> command, List<Message> extensions) throws Exception {
Command commandAnnotation =
checkNotNull(
command.getAnnotation(Command.class),
"BlazeCommand %s missing command annotation",
command);
additionalOptionsClasses.addAll(
BlazeCommandUtils.getOptions(
command, runtime.getBlazeModules(), runtime.getRuleClassProvider()));
initializeOptionsParser(commandAnnotation);
commandCreated = true;
if (env != null) {
runtime.afterCommand(env, BlazeCommandResult.success());
}
checkNotNull(
optionsParser,
"The options parser must be initialized before creating a new command environment");
optionsParser.setStarlarkOptions(starlarkOptions);
env =
runtime
.getWorkspace()
.initCommand(
commandAnnotation,
optionsParser,
new ArrayList<>(),
0L,
0L,
extensions.stream().map(Any::pack).collect(toImmutableList()),
this.crashMessages::add);
return env;
}
/**
* Returns the command environment. You must call {@link #newCommand()} before calling this
* method.
*/
public CommandEnvironment getCommandEnvironment() {
return env;
}
public SkyframeExecutor getSkyframeExecutor() {
return runtime.getWorkspace().getSkyframeExecutor();
}
public void resetOptions() {
optionsToParse.clear();
starlarkOptions.clear();
}
public void addOptions(String... args) {
addOptions(ImmutableList.copyOf(args));
}
public void addOptions(List<String> args) {
optionsToParse.addAll(args);
}
public void addStarlarkOption(String label, Object value) {
starlarkOptions.put(Label.parseAbsoluteUnchecked(label).getCanonicalForm(), value);
}
public ImmutableList<String> getOptions() {
return ImmutableList.copyOf(optionsToParse);
}
public <O extends OptionsBase> O getOptions(Class<O> optionsClass) {
return optionsParser.getOptions(optionsClass);
}
public void addOptionsClass(Class<? extends OptionsBase> optionsClass) {
additionalOptionsClasses.add(optionsClass);
}
void finalizeBuildResult(@SuppressWarnings("unused") BuildResult request) {}
/**
* Initializes a new options parser, parsing all the options set by {@link
* #addOptions(String...)}.
*/
private void initializeOptionsParser(Command commandAnnotation) throws OptionsParsingException {
// Create the options parser and parse all the options collected so far
optionsParser = createOptionsParser(commandAnnotation);
optionsParser.parse(optionsToParse);
// Enforce the test invocation policy once the options have been added
InvocationPolicyEnforcer optionsPolicyEnforcer =
new InvocationPolicyEnforcer(
runtime.getModuleInvocationPolicy(), Level.FINE, /*conversionContext=*/ null);
try {
optionsPolicyEnforcer.enforce(optionsParser, commandAnnotation.name());
} catch (OptionsParsingException e) {
throw new IllegalStateException(e);
}
}
private OptionsParser createOptionsParser(Command commandAnnotation) {
Set<Class<? extends OptionsBase>> options =
new HashSet<>(
ImmutableList.of(
BuildRequestOptions.class,
BuildEventProtocolOptions.class,
ExecutionOptions.class,
LocalExecutionOptions.class,
CommonCommandOptions.class,
ClientOptions.class,
LoadingOptions.class,
AnalysisOptions.class,
KeepGoingOption.class,
LoadingPhaseThreadsOption.class,
PackageOptions.class,
BuildLanguageOptions.class,
UiOptions.class,
SandboxOptions.class));
options.addAll(additionalOptionsClasses);
for (BlazeModule module : runtime.getBlazeModules()) {
Iterables.addAll(options, module.getCommonCommandOptions());
Iterables.addAll(options, module.getCommandOptions(commandAnnotation));
}
options.addAll(runtime.getRuleClassProvider().getFragmentRegistry().getOptionsClasses());
return OptionsParser.builder().optionsClasses(options).build();
}
public void executeBuild(List<String> targets) throws Exception {
if (!commandCreated) {
// If you didn't create a command we do it for you
newCommand();
}
commandCreated = false;
BuildTool buildTool = new BuildTool(env);
Reporter reporter = env.getReporter();
try (OutErr.SystemPatcher systemOutErrPatcher = reporter.getOutErr().getSystemPatcher()) {
Profiler.instance()
.start(
/*profiledTasks=*/ ImmutableSet.of(),
/*stream=*/ null,
/*format=*/ null,
/*outputBase=*/ null,
/*buildID=*/ null,
/*recordAllDurations=*/ false,
new JavaClock(),
/*execStartTimeNanos=*/ 42,
/*slimProfile=*/ false,
/*includePrimaryOutput=*/ false,
/*includeTargetLabel=*/ false,
/*collectTaskHistograms=*/ true,
/*collectWorkerDataInProfiler=*/ false,
/*collectLoadAverage=*/ false,
WorkerMetricsCollector.instance(),
runtime.getBugReporter());
StoredEventHandler storedEventHandler = new StoredEventHandler();
reporter.addHandler(storedEventHandler);
// This cannot go into newCommand, because we hook up the EventCollectionApparatus as a
// module, and after that ran, further changes to the apparatus aren't reflected on the
// reporter.
for (BlazeModule module : runtime.getBlazeModules()) {
module.beforeCommand(env);
}
reporter.removeHandler(storedEventHandler);
EventBus eventBus = env.getEventBus();
for (Object subscriber : eventBusSubscribers) {
eventBus.register(subscriber);
}
// Replay events from beforeCommand, just as BlazeCommandDispatcher does.
storedEventHandler.replayOn(reporter);
env.beforeCommand(InvocationPolicy.getDefaultInstance());
lastRequest = createRequest(env.getCommandName(), targets);
lastResult = new BuildResult(lastRequest.getStartTime());
for (BlazeModule module : runtime.getBlazeModules()) {
env.getSkyframeExecutor().injectExtraPrecomputedValues(module.getPrecomputedValues());
}
Crash crash = null;
DetailedExitCode detailedExitCode = DetailedExitCode.of(createGenericDetailedFailure());
try {
try (SilentCloseable c = Profiler.instance().profile("syncPackageLoading")) {
env.syncPackageLoading(lastRequest);
}
buildTool.buildTargets(lastRequest, lastResult, null);
detailedExitCode = DetailedExitCode.success();
} catch (RuntimeException | Error e) {
crash = Crash.from(e);
detailedExitCode = crash.getDetailedExitCode();
throw e;
} finally {
env.getTimestampGranularityMonitor().waitForTimestampGranularity(lastRequest.getOutErr());
this.configurations = lastResult.getBuildConfigurationCollection();
finalizeBuildResult(lastResult);
buildTool.stopRequest(
lastResult, crash != null ? crash.getThrowable() : null, detailedExitCode);
getSkyframeExecutor().notifyCommandComplete(reporter);
if (crash != null) {
runtime
.getBugReporter()
.handleCrash(crash, CrashContext.keepAlive().reportingTo(reporter));
}
}
} finally {
Profiler.instance().stop();
}
}
private static FailureDetail createGenericDetailedFailure() {
return FailureDetail.newBuilder()
.setSpawn(Spawn.newBuilder().setCode(Code.NON_ZERO_EXIT))
.build();
}
private BuildRequest createRequest(String commandName, List<String> targets) {
BuildRequest.Builder builder =
BuildRequest.builder()
.setCommandName(commandName)
.setId(env.getCommandId())
.setOptions(optionsParser)
.setStartupOptions(null)
.setOutErr(env.getReporter().getOutErr())
.setTargets(targets)
.setStartTimeMillis(runtime.getClock().currentTimeMillis());
if ("test".equals(commandName)) {
builder.setRunTests(true);
}
return builder.build();
}
public BuildRequest getLastRequest() {
return lastRequest;
}
public BuildResult getLastResult() {
return lastResult;
}
public BuildConfigurationCollection getConfigurationCollection() {
return configurations;
}
public ImmutableSet<ConfiguredTarget> getTopLevelTargets() {
return topLevelTargets;
}
public List<String> getCrashMessages() {
return crashMessages;
}
}