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
|
// 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.buildeventstream;
import com.google.devtools.build.lib.causes.Cause;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.vfs.Path;
import com.google.protobuf.TextFormat;
import java.io.Serializable;
import java.util.List;
import java.util.Objects;
import javax.annotation.concurrent.Immutable;
/**
* Class of identifiers for publically posted events.
*
* <p>Since event identifiers need to be created before the actual event, the event IDs are highly
* structured so that equal identifiers can easily be generated. The main way of pregenerating event
* identifiers that do not accidentally coincide is by providing a target or a target pattern;
* therefore, those (if provided) are made specially visible.
*/
@Immutable
public final class BuildEventId implements Serializable {
private final BuildEventStreamProtos.BuildEventId protoid;
private BuildEventId(BuildEventStreamProtos.BuildEventId protoid) {
this.protoid = protoid;
}
@Override
public int hashCode() {
return Objects.hash(protoid);
}
@Override
public boolean equals(Object other) {
if (other == null || !other.getClass().equals(getClass())) {
return false;
}
BuildEventId that = (BuildEventId) other;
return Objects.equals(this.protoid, that.protoid);
}
@Override
public String toString() {
return "BuildEventId {" + TextFormat.printToString(protoid) + "}";
}
public BuildEventStreamProtos.BuildEventId asStreamProto() {
return protoid;
}
public static BuildEventId unknownBuildEventId(String details) {
BuildEventStreamProtos.BuildEventId.UnknownBuildEventId id =
BuildEventStreamProtos.BuildEventId.UnknownBuildEventId.newBuilder()
.setDetails(details)
.build();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setUnknown(id).build());
}
public static BuildEventId progressId(int count) {
BuildEventStreamProtos.BuildEventId.ProgressId id =
BuildEventStreamProtos.BuildEventId.ProgressId.newBuilder().setOpaqueCount(count).build();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setProgress(id).build());
}
public static BuildEventId buildStartedId() {
BuildEventStreamProtos.BuildEventId.BuildStartedId startedId =
BuildEventStreamProtos.BuildEventId.BuildStartedId.getDefaultInstance();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setStarted(startedId).build());
}
public static BuildEventId commandlineId() {
BuildEventStreamProtos.BuildEventId.CommandLineId commandLineId =
BuildEventStreamProtos.BuildEventId.CommandLineId.getDefaultInstance();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setCommandLine(commandLineId).build());
}
public static BuildEventId optionsParsedId() {
BuildEventStreamProtos.BuildEventId.OptionsParsedId optionsParsedId =
BuildEventStreamProtos.BuildEventId.OptionsParsedId.getDefaultInstance();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setOptionsParsed(optionsParsedId).build());
}
private static BuildEventId targetPatternExpanded(List<String> targetPattern, boolean skipped) {
BuildEventStreamProtos.BuildEventId.PatternExpandedId patternId =
BuildEventStreamProtos.BuildEventId.PatternExpandedId.newBuilder()
.addAllPattern(targetPattern)
.build();
BuildEventStreamProtos.BuildEventId.Builder builder =
BuildEventStreamProtos.BuildEventId.newBuilder();
if (skipped) {
builder.setPatternSkipped(patternId);
} else {
builder.setPattern(patternId);
}
return new BuildEventId(builder.build());
}
public static BuildEventId targetPatternExpanded(List<String> targetPattern) {
return targetPatternExpanded(targetPattern, false);
}
public static BuildEventId targetPatternSkipped(List<String> targetPattern) {
return targetPatternExpanded(targetPattern, true);
}
public static BuildEventId targetCompleted(Label target) {
BuildEventStreamProtos.BuildEventId.TargetCompletedId targetId =
BuildEventStreamProtos.BuildEventId.TargetCompletedId.newBuilder()
.setLabel(target.toString())
.build();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setTargetCompleted(targetId).build());
}
public static BuildEventId aspectCompleted(Label target, String aspect) {
BuildEventStreamProtos.BuildEventId.TargetCompletedId targetId =
BuildEventStreamProtos.BuildEventId.TargetCompletedId.newBuilder()
.setLabel(target.toString())
.setAspect(aspect)
.build();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setTargetCompleted(targetId).build());
}
public static BuildEventId fromCause(Cause cause) {
return new BuildEventId(cause.getIdProto());
}
public static BuildEventId actionCompleted(Path path) {
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder()
.setActionCompleted(
BuildEventStreamProtos.BuildEventId.ActionCompletedId.newBuilder()
.setPrimaryOutput(path.toString())
.build())
.build());
}
public static BuildEventId fromArtifactGroupName(String name) {
BuildEventStreamProtos.BuildEventId.NamedSetOfFilesId namedSetId =
BuildEventStreamProtos.BuildEventId.NamedSetOfFilesId.newBuilder().setId(name).build();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setNamedSet(namedSetId).build());
}
public static BuildEventId testResult(Label target, Integer run, Integer shard, Integer attempt) {
BuildEventStreamProtos.BuildEventId.TestResultId resultId =
BuildEventStreamProtos.BuildEventId.TestResultId.newBuilder()
.setLabel(target.toString())
.setRun(run + 1)
.setShard(shard + 1)
.setAttempt(attempt)
.build();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setTestResult(resultId).build());
}
public static BuildEventId testResult(Label target, Integer run, Integer shard) {
return testResult(target, run, shard, 1);
}
public static BuildEventId testSummary(Label target) {
BuildEventStreamProtos.BuildEventId.TestSummaryId summaryId =
BuildEventStreamProtos.BuildEventId.TestSummaryId.newBuilder()
.setLabel(target.toString())
.build();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setTestSummary(summaryId).build());
}
public static BuildEventId buildFinished() {
BuildEventStreamProtos.BuildEventId.BuildFinishedId finishedId =
BuildEventStreamProtos.BuildEventId.BuildFinishedId.getDefaultInstance();
return new BuildEventId(
BuildEventStreamProtos.BuildEventId.newBuilder().setBuildFinished(finishedId).build());
}
}
|