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
|
// Copyright 2014 Google Inc. 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.runtime.commands;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.pkgcache.PackageCacheOptions;
import com.google.devtools.build.lib.query2.BlazeQueryEnvironment;
import com.google.devtools.build.lib.query2.SkyframeQueryEnvironment;
import com.google.devtools.build.lib.query2.engine.BlazeQueryEvalResult;
import com.google.devtools.build.lib.query2.engine.QueryEnvironment.QueryFunction;
import com.google.devtools.build.lib.query2.engine.QueryEnvironment.Setting;
import com.google.devtools.build.lib.query2.engine.QueryEvalResult;
import com.google.devtools.build.lib.query2.engine.QueryException;
import com.google.devtools.build.lib.query2.engine.QueryExpression;
import com.google.devtools.build.lib.query2.output.OutputFormatter;
import com.google.devtools.build.lib.query2.output.OutputFormatter.UnorderedFormatter;
import com.google.devtools.build.lib.query2.output.QueryOptions;
import com.google.devtools.build.lib.runtime.BlazeCommand;
import com.google.devtools.build.lib.runtime.BlazeModule;
import com.google.devtools.build.lib.runtime.BlazeRuntime;
import com.google.devtools.build.lib.runtime.Command;
import com.google.devtools.build.lib.util.AbruptExitException;
import com.google.devtools.build.lib.util.ExitCode;
import com.google.devtools.common.options.OptionsParser;
import com.google.devtools.common.options.OptionsProvider;
import java.io.IOException;
import java.io.PrintStream;
import java.util.Set;
/**
* Command line wrapper for executing a query with blaze.
*/
@Command(name = "query",
options = { PackageCacheOptions.class,
QueryOptions.class },
help = "resource:query.txt",
shortDescription = "Executes a dependency graph query.",
allowResidue = true,
binaryStdOut = true,
canRunInOutputDirectory = true)
public final class QueryCommand implements BlazeCommand {
@Override
public void editOptions(BlazeRuntime runtime, OptionsParser optionsParser) { }
/**
* Exit codes:
* 0 on successful evaluation.
* 1 if query evaluation did not complete.
* 2 if query parsing failed.
* 3 if errors were reported but evaluation produced a partial result
* (only when --keep_going is in effect.)
*/
@Override
public ExitCode exec(BlazeRuntime runtime, OptionsProvider options) {
QueryOptions queryOptions = options.getOptions(QueryOptions.class);
try {
runtime.setupPackageCache(
options.getOptions(PackageCacheOptions.class),
runtime.getDefaultsPackageContent());
} catch (InterruptedException e) {
runtime.getReporter().handle(Event.error("query interrupted"));
return ExitCode.INTERRUPTED;
} catch (AbruptExitException e) {
runtime.getReporter().handle(Event.error(null, "Unknown error: " + e.getMessage()));
return e.getExitCode();
}
if (options.getResidue().isEmpty()) {
runtime.getReporter().handle(Event.error(
"missing query expression. Type 'blaze help query' for syntax and help"));
return ExitCode.COMMAND_LINE_ERROR;
}
Iterable<OutputFormatter> formatters = runtime.getQueryOutputFormatters();
OutputFormatter formatter =
OutputFormatter.getFormatter(formatters, queryOptions.outputFormat);
if (formatter == null) {
runtime.getReporter().handle(Event.error(
String.format("Invalid output format '%s'. Valid values are: %s",
queryOptions.outputFormat, OutputFormatter.formatterNames(formatters))));
return ExitCode.COMMAND_LINE_ERROR;
}
String query = Joiner.on(' ').join(options.getResidue());
Set<Setting> settings = queryOptions.toSettings();
BlazeQueryEnvironment env = newQueryEnvironment(
runtime,
queryOptions.keepGoing,
queryOptions.loadingPhaseThreads,
settings);
// 1. Parse query:
QueryExpression expr;
try {
expr = QueryExpression.parse(query, env);
} catch (QueryException e) {
runtime.getReporter().handle(Event.error(
null, "Error while parsing '" + query + "': " + e.getMessage()));
return ExitCode.COMMAND_LINE_ERROR;
}
// 2. Evaluate expression:
BlazeQueryEvalResult<Target> result;
try {
result = env.evaluateQuery(expr);
} catch (QueryException e) {
// Keep consistent with reportBuildFileError()
runtime.getReporter().handle(Event.error(e.getMessage()));
return ExitCode.ANALYSIS_FAILURE;
}
// 3. Output results:
PrintStream output = new PrintStream(runtime.getReporter().getOutErr().getOutputStream());
try {
output(queryOptions, result, formatter, output);
} catch (IOException e) {
runtime.getReporter().handle(Event.error("I/O error: " + e.getMessage()));
return ExitCode.LOCAL_ENVIRONMENTAL_ERROR;
} finally {
output.flush();
}
if (result.getResultSet().isEmpty()) {
runtime.getReporter().handle(Event.info("Empty results"));
}
return result.getSuccess() ? ExitCode.SUCCESS : ExitCode.PARTIAL_ANALYSIS_FAILURE;
}
@VisibleForTesting
public static void output(QueryOptions queryOptions, QueryEvalResult<Target> result,
OutputFormatter formatter, PrintStream outputStream)
throws IOException {
if (queryOptions.orderResults || !(formatter instanceof UnorderedFormatter)) {
formatter.output(queryOptions, ((BlazeQueryEvalResult<Target>) result).getResultGraph(),
outputStream);
} else {
((UnorderedFormatter) formatter).outputUnordered(queryOptions, result.getResultSet(),
outputStream);
}
}
@VisibleForTesting // for com.google.devtools.deps.gquery.test.QueryResultTestUtil
public static BlazeQueryEnvironment newQueryEnvironment(BlazeRuntime runtime,
boolean keepGoing, int loadingPhaseThreads, Set<Setting> settings) {
ImmutableList.Builder<QueryFunction> functions = ImmutableList.builder();
for (BlazeModule module : runtime.getBlazeModules()) {
functions.addAll(module.getQueryFunctions());
}
return new SkyframeQueryEnvironment(
runtime.getPackageManager().newTransitiveLoader(),
runtime.getPackageManager(),
runtime.getTargetPatternEvaluator(),
keepGoing, loadingPhaseThreads, runtime.getReporter(), settings, functions.build());
}
}
|
