-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
BazelBuildEventServiceModule.java
178 lines (157 loc) · 5.84 KB
/
BazelBuildEventServiceModule.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
// Copyright 2017 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.buildeventservice;
import com.google.auth.Credentials;
import com.google.auto.value.AutoValue;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.devtools.build.lib.authandtls.AuthAndTLSOptions;
import com.google.devtools.build.lib.authandtls.GoogleAuthUtils;
import com.google.devtools.build.lib.authandtls.credentialhelper.CredentialHelperEnvironment;
import com.google.devtools.build.lib.buildeventservice.client.BuildEventServiceClient;
import com.google.devtools.build.lib.buildeventservice.client.BuildEventServiceGrpcClient;
import com.google.devtools.build.lib.runtime.CommandEnvironment;
import io.grpc.ClientInterceptor;
import io.grpc.ManagedChannel;
import io.grpc.Metadata;
import io.grpc.auth.MoreCallCredentials;
import io.grpc.stub.MetadataUtils;
import java.io.IOException;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.Set;
import javax.annotation.Nullable;
/** Bazel's BES module. */
public class BazelBuildEventServiceModule
extends BuildEventServiceModule<BuildEventServiceOptions> {
@AutoValue
abstract static class BackendConfig {
abstract String besBackend();
@Nullable
abstract String besProxy();
abstract ImmutableList<Map.Entry<String, String>> besHeaders();
abstract AuthAndTLSOptions authAndTLSOptions();
static BackendConfig create(
BuildEventServiceOptions besOptions, AuthAndTLSOptions authAndTLSOptions) {
return new AutoValue_BazelBuildEventServiceModule_BackendConfig(
besOptions.besBackend,
besOptions.besProxy,
ImmutableMap.copyOf(besOptions.besHeaders).entrySet().asList(),
authAndTLSOptions);
}
}
private BuildEventServiceClient client;
private BackendConfig config;
@Override
protected Class<BuildEventServiceOptions> optionsClass() {
return BuildEventServiceOptions.class;
}
@Override
protected BuildEventServiceClient getBesClient(
CommandEnvironment env,
BuildEventServiceOptions besOptions,
AuthAndTLSOptions authAndTLSOptions)
throws IOException {
BackendConfig newConfig = BackendConfig.create(besOptions, authAndTLSOptions);
if (client == null || !Objects.equals(config, newConfig)) {
clearBesClient();
Preconditions.checkState(config == null);
Preconditions.checkState(client == null);
Credentials credentials =
GoogleAuthUtils.newCredentials(
CredentialHelperEnvironment.newBuilder()
.setEventReporter(env.getReporter())
.setWorkspacePath(env.getWorkspace())
.setClientEnvironment(env.getClientEnv())
.setHelperExecutionTimeout(authAndTLSOptions.credentialHelperTimeout)
.build(),
env.getCommandLinePathFactory(),
env.getRuntime().getFileSystem(),
newConfig.authAndTLSOptions());
config = newConfig;
client =
new BuildEventServiceGrpcClient(
newGrpcChannel(config),
credentials != null ? MoreCallCredentials.from(credentials) : null,
makeGrpcInterceptor(config));
}
return client;
}
private static ClientInterceptor makeGrpcInterceptor(BackendConfig config) {
if (config.besHeaders().isEmpty()) {
return null;
}
return MetadataUtils.newAttachHeadersInterceptor(makeGrpcMetadata(config));
}
@VisibleForTesting
static Metadata makeGrpcMetadata(BackendConfig config) {
Metadata extraHeaders = new Metadata();
for (Entry<String, String> header : config.besHeaders()) {
extraHeaders.put(
Metadata.Key.of(header.getKey(), Metadata.ASCII_STRING_MARSHALLER), header.getValue());
}
return extraHeaders;
}
// newGrpcChannel is only defined so it can be overridden in tests to not use a real network link.
@VisibleForTesting
protected ManagedChannel newGrpcChannel(BackendConfig config) throws IOException {
return GoogleAuthUtils.newChannel(
/*executor=*/ null,
config.besBackend(),
config.besProxy(),
config.authAndTLSOptions(),
/* interceptors= */ null);
}
@Override
protected void clearBesClient() {
if (client != null) {
client.shutdown();
}
this.client = null;
this.config = null;
}
private static final ImmutableSet<String> ALLOWED_COMMANDS =
ImmutableSet.of(
"fetch",
"build",
"test",
"run",
"query",
"aquery",
"cquery",
"coverage",
"mobile-install");
@Override
protected Set<String> allowedCommands(BuildEventServiceOptions besOptions) {
return ALLOWED_COMMANDS;
}
@Override
protected String getInvocationIdPrefix() {
if (Strings.isNullOrEmpty(besOptions.besResultsUrl)) {
return "";
}
return besOptions.besResultsUrl.endsWith("/")
? besOptions.besResultsUrl
: besOptions.besResultsUrl + "/";
}
@Override
protected String getBuildRequestIdPrefix() {
return "";
}
}