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
|
// 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.common.base.MoreObjects;
import com.google.common.base.Objects;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.events.ExtendedEventHandler;
import com.google.devtools.build.lib.vfs.Path;
import java.util.Collection;
/**
* Interface for objects that can be posted on the public event stream.
*
* <p>Objects posted on the build-event stream will implement this interface. This allows
* pass-through of events, as well as proper chaining of events.
*/
public interface BuildEvent extends ChainableEvent, ExtendedEventHandler.Postable {
/**
* A local file that is referenced by the build event. These can be uploaded to a separate backend
* storage.
*/
final class LocalFile {
/**
* The type of the local file. This is used by uploaders to determine how long to store the
* associated files for.
*/
public enum LocalFileType {
SOURCE,
OUTPUT,
SUCCESSFUL_TEST_OUTPUT,
FAILED_TEST_OUTPUT,
STDOUT,
STDERR,
LOG,
}
public final Path path;
public final LocalFileType type;
public LocalFile(Path path, LocalFileType type) {
this.path = path;
this.type = type;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
LocalFile localFile = (LocalFile) o;
return Objects.equal(path, localFile.path) && type == localFile.type;
}
@Override
public int hashCode() {
return Objects.hashCode(path, type);
}
@Override
public String toString() {
return MoreObjects.toStringHelper(LocalFile.class)
.add("path", path)
.add("type", type)
.toString();
}
}
/**
* Returns a list of files that are referenced in the protobuf representation returned by {@link
* #asStreamProto(BuildEventContext)}.
*
* <p>This method is different from {@code EventReportingArtifacts#reportedArtifacts()} in that it
* only returns files directly referenced in the protobuf returned by {@link
* #asStreamProto(BuildEventContext)}.
*
* <p>Note the consistency requirement - you must not attempt to pass Path objects to the {@link
* PathConverter} unless you have returned a corresponding {@link LocalFile} object here.
*/
default Collection<LocalFile> referencedLocalFiles() {
return ImmutableList.of();
}
/**
* Provide a binary representation of the event.
*
* <p>Provide a presentation of the event according to the specified binary format, as appropriate
* protocol buffer.
*/
BuildEventStreamProtos.BuildEvent asStreamProto(BuildEventContext context);
}
|
