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
|
// 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.analysis;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.EventReportingArtifacts;
import com.google.devtools.build.lib.analysis.TopLevelArtifactHelper.ArtifactsInOutputGroup;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget;
import com.google.devtools.build.lib.analysis.test.InstrumentedFilesProvider;
import com.google.devtools.build.lib.analysis.test.TestProvider;
import com.google.devtools.build.lib.buildeventstream.ArtifactGroupNamer;
import com.google.devtools.build.lib.buildeventstream.BuildEvent;
import com.google.devtools.build.lib.buildeventstream.BuildEventConverters;
import com.google.devtools.build.lib.buildeventstream.BuildEventId;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.File;
import com.google.devtools.build.lib.buildeventstream.BuildEventStreamProtos.OutputGroup;
import com.google.devtools.build.lib.buildeventstream.BuildEventWithConfiguration;
import com.google.devtools.build.lib.buildeventstream.BuildEventWithOrderConstraint;
import com.google.devtools.build.lib.buildeventstream.GenericBuildEvent;
import com.google.devtools.build.lib.buildeventstream.TestFileNameConstants;
import com.google.devtools.build.lib.causes.Cause;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder;
import com.google.devtools.build.lib.collect.nestedset.NestedSetView;
import com.google.devtools.build.lib.collect.nestedset.Order;
import com.google.devtools.build.lib.packages.AttributeMap;
import com.google.devtools.build.lib.packages.TestSize;
import com.google.devtools.build.lib.rules.AliasConfiguredTarget;
import com.google.devtools.build.lib.syntax.Type;
import com.google.devtools.build.lib.util.Preconditions;
import com.google.devtools.build.skyframe.SkyValue;
import java.util.Collection;
/** This event is fired as soon as a target is either built or fails. */
public final class TargetCompleteEvent
implements SkyValue,
BuildEventWithOrderConstraint,
EventReportingArtifacts,
BuildEventWithConfiguration {
private final ConfiguredTarget target;
private final NestedSet<Cause> rootCauses;
private final Collection<BuildEventId> postedAfter;
private final Iterable<ArtifactsInOutputGroup> outputs;
private final NestedSet<Artifact> baselineCoverageArtifacts;
private final boolean isTest;
private TargetCompleteEvent(
ConfiguredTarget target,
NestedSet<Cause> rootCauses,
Iterable<ArtifactsInOutputGroup> outputs,
boolean isTest) {
this.target = target;
this.rootCauses =
(rootCauses == null) ? NestedSetBuilder.<Cause>emptySet(Order.STABLE_ORDER) : rootCauses;
ImmutableList.Builder postedAfterBuilder = ImmutableList.builder();
for (Cause cause : getRootCauses()) {
postedAfterBuilder.add(BuildEventId.fromCause(cause));
}
this.postedAfter = postedAfterBuilder.build();
this.outputs = outputs;
this.isTest = isTest;
InstrumentedFilesProvider instrumentedFilesProvider =
this.target.getProvider(InstrumentedFilesProvider.class);
if (instrumentedFilesProvider == null) {
this.baselineCoverageArtifacts = null;
} else {
NestedSet<Artifact> baselineCoverageArtifacts =
instrumentedFilesProvider.getBaselineCoverageArtifacts();
if (!baselineCoverageArtifacts.isEmpty()) {
this.baselineCoverageArtifacts = baselineCoverageArtifacts;
} else {
this.baselineCoverageArtifacts = null;
}
}
}
/** Construct a successful target completion event. */
public static TargetCompleteEvent createSuccessfulTarget(
ConfiguredTarget ct, NestedSet<ArtifactsInOutputGroup> outputs) {
return new TargetCompleteEvent(ct, null, outputs, false);
}
/** Construct a successful target completion event for a target that will be tested. */
public static TargetCompleteEvent createSuccessfulTestTarget(ConfiguredTarget ct) {
return new TargetCompleteEvent(ct, null, ImmutableList.<ArtifactsInOutputGroup>of(), true);
}
/**
* Construct a target completion event for a failed target, with the given non-empty root causes.
*/
public static TargetCompleteEvent createFailed(ConfiguredTarget ct, NestedSet<Cause> rootCauses) {
Preconditions.checkArgument(!Iterables.isEmpty(rootCauses));
return new TargetCompleteEvent(
ct, rootCauses, ImmutableList.<ArtifactsInOutputGroup>of(), false);
}
/**
* Returns the target associated with the event.
*/
public ConfiguredTarget getTarget() {
return target;
}
/**
* Determines whether the target has failed or succeeded.
*/
public boolean failed() {
return !rootCauses.isEmpty();
}
/** Get the root causes of the target. May be empty. */
public Iterable<Cause> getRootCauses() {
return rootCauses;
}
@Override
public BuildEventId getEventId() {
Label label = getTarget().getLabel();
if (target instanceof AliasConfiguredTarget) {
label = ((AliasConfiguredTarget) target).getOriginalLabel();
}
BuildConfiguration config = getTarget().getConfiguration();
BuildEventId configId =
config == null ? BuildEventId.nullConfigurationId() : config.getEventId();
return BuildEventId.targetCompleted(label, configId);
}
@Override
public Collection<BuildEventId> getChildrenEvents() {
ImmutableList.Builder childrenBuilder = ImmutableList.builder();
for (Cause cause : getRootCauses()) {
childrenBuilder.add(BuildEventId.fromCause(cause));
}
if (isTest) {
// For tests, announce all the test actions that will minimally happen (except for
// interruption). If after the result of a test action another attempt is necessary,
// it will be announced with the action that made the new attempt necessary.
Label label = target.getTarget().getLabel();
TestProvider.TestParams params = target.getProvider(TestProvider.class).getTestParams();
for (int run = 0; run < Math.max(params.getRuns(), 1); run++) {
for (int shard = 0; shard < Math.max(params.getShards(), 1); shard++) {
childrenBuilder.add(
BuildEventId.testResult(label, run, shard, target.getConfiguration().getEventId()));
}
}
childrenBuilder.add(BuildEventId.testSummary(label, target.getConfiguration().getEventId()));
}
return childrenBuilder.build();
}
// TODO(aehlig): remove as soon as we managed to get rid of the deprecated "important_output"
// field.
private static void addImportantOutputs(
BuildEventStreamProtos.TargetComplete.Builder builder,
BuildEventConverters converters,
Iterable<Artifact> artifacts) {
for (Artifact artifact : artifacts) {
String name = artifact.getPath().relativeTo(artifact.getRoot().getPath()).getPathString();
String uri = converters.pathConverter().apply(artifact.getPath());
builder.addImportantOutput(File.newBuilder().setName(name).setUri(uri).build());
}
}
@Override
public BuildEventStreamProtos.BuildEvent asStreamProto(BuildEventConverters converters) {
BuildEventStreamProtos.TargetComplete.Builder builder =
BuildEventStreamProtos.TargetComplete.newBuilder();
builder.setSuccess(!failed());
builder.setTargetKind(target.getTarget().getTargetKind());
builder.addAllTag(getTags());
builder.addAllOutputGroup(getOutputFilesByGroup(converters.artifactGroupNamer()));
if (isTest) {
builder.setTestSize(
TargetConfiguredEvent.bepTestSize(
TestSize.getTestSize(target.getTarget().getAssociatedRule())));
}
// TODO(aehlig): remove direct reporting of artifacts as soon as clients no longer
// need it.
for (ArtifactsInOutputGroup group : outputs) {
if (group.areImportant()) {
addImportantOutputs(builder, converters, group.getArtifacts());
}
}
if (baselineCoverageArtifacts != null) {
addImportantOutputs(builder, converters, baselineCoverageArtifacts);
}
BuildEventStreamProtos.TargetComplete complete = builder.build();
return GenericBuildEvent.protoChaining(this).setCompleted(complete).build();
}
@Override
public Collection<BuildEventId> postedAfter() {
return postedAfter;
}
@Override
public Collection<NestedSet<Artifact>> reportedArtifacts() {
ImmutableSet.Builder<NestedSet<Artifact>> builder =
new ImmutableSet.Builder<NestedSet<Artifact>>();
for (ArtifactsInOutputGroup artifactsInGroup : outputs) {
builder.add(artifactsInGroup.getArtifacts());
}
if (baselineCoverageArtifacts != null) {
builder.add(baselineCoverageArtifacts);
}
return builder.build();
}
@Override
public Collection<BuildEvent> getConfigurations() {
BuildConfiguration configuration = target.getConfiguration();
if (configuration != null) {
return ImmutableList.of(target.getConfiguration());
} else {
return ImmutableList.<BuildEvent>of();
}
}
private Iterable<String> getTags() {
// We are only interested in targets that are rules.
if (!(target instanceof RuleConfiguredTarget)) {
return ImmutableList.<String>of();
}
AttributeMap attributes = ((RuleConfiguredTarget) target).getAttributeMapper();
// Every rule (implicitly) has a "tags" attribute.
return attributes.get("tags", Type.STRING_LIST);
}
private Iterable<OutputGroup> getOutputFilesByGroup(ArtifactGroupNamer namer) {
ImmutableList.Builder<OutputGroup> groups = ImmutableList.builder();
for (ArtifactsInOutputGroup artifactsInOutputGroup : outputs) {
OutputGroup.Builder groupBuilder = OutputGroup.newBuilder();
groupBuilder.setName(artifactsInOutputGroup.getOutputGroup());
groupBuilder.addFileSets(
namer.apply(
(new NestedSetView<Artifact>(artifactsInOutputGroup.getArtifacts())).identifier()));
groups.add(groupBuilder.build());
}
if (baselineCoverageArtifacts != null) {
groups.add(
OutputGroup.newBuilder()
.setName(TestFileNameConstants.BASELINE_COVERAGE)
.addFileSets(
namer.apply(
(new NestedSetView<Artifact>(baselineCoverageArtifacts).identifier())))
.build());
}
return groups.build();
}
}
|