mirrored from https://chromium.googlesource.com/infra/luci/luci-go
/
client.go
154 lines (133 loc) · 4.86 KB
/
client.go
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
// Copyright 2020 The LUCI Authors.
//
// 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 cas provides remote-apis-sdks client with luci integration.
package casclient
import (
"context"
"fmt"
"runtime"
"strings"
"github.com/bazelbuild/remote-apis-sdks/go/pkg/cas"
"github.com/bazelbuild/remote-apis-sdks/go/pkg/client"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"go.chromium.org/luci/auth"
"go.chromium.org/luci/common/errors"
"go.chromium.org/luci/common/logging"
"go.chromium.org/luci/hardcoded/chromeinfra"
)
// New returns luci auth configured Client for RBE-CAS.
func New(ctx context.Context, instance string, opts auth.Options, readOnly bool) (*cas.Client, error) {
creds, err := perRPCCreds(ctx, instance, opts, readOnly)
if err != nil {
return nil, err
}
dialParams := client.DialParams{
Service: "remotebuildexecution.googleapis.com:443",
TransportCredsOnly: true,
DialOpts: []grpc.DialOption{grpc.WithPerRPCCredentials(creds)},
}
conn, err := client.Dial(ctx, dialParams.Service, dialParams)
if err != nil {
return nil, errors.Annotate(err, "failed to dial RBE").Err()
}
cl, err := cas.NewClientWithConfig(ctx, conn, instance, DefaultConfig())
if err != nil {
return nil, errors.Annotate(err, "failed to create client").Err()
}
return cl, nil
}
// DefaultConfig returns default CAS client configuration.
func DefaultConfig() cas.ClientConfig {
cfg := cas.DefaultClientConfig()
cfg.CompressedBytestreamThreshold = 0 // compress always
return cfg
}
func perRPCCreds(ctx context.Context, instance string, opts auth.Options, readOnly bool) (credentials.PerRPCCredentials, error) {
project := strings.Split(instance, "/")[1]
var role string
if readOnly {
role = "cas-read-only"
} else {
role = "cas-read-write"
}
// Construct auth.Options.
opts.ActAsServiceAccount = fmt.Sprintf("%s@%s.iam.gserviceaccount.com", role, project)
opts.ActViaLUCIRealm = fmt.Sprintf("@internal:%s/%s", project, role)
opts.Scopes = []string{"https://www.googleapis.com/auth/cloud-platform"}
if strings.HasSuffix(project, "-dev") || strings.HasSuffix(project, "-staging") {
// use dev token server for dev/staging projects.
opts.TokenServerHost = chromeinfra.TokenServerDevHost
}
creds, err := auth.NewAuthenticator(ctx, auth.SilentLogin, opts).PerRPCCredentials()
if err != nil {
return nil, errors.Annotate(err, "failed to get PerRPCCredentials").Err()
}
return creds, nil
}
// NewLegacy returns luci auth configured legacy Client for RBE.
// In general, NewClient is preferred.
// TODO(crbug.com/1225524): remove this.
func NewLegacy(ctx context.Context, instance string, opts auth.Options, readOnly bool) (*client.Client, error) {
creds, err := perRPCCreds(ctx, instance, opts, readOnly)
if err != nil {
return nil, err
}
dialParams := client.DialParams{
Service: "remotebuildexecution.googleapis.com:443",
TransportCredsOnly: true,
}
cl, err := client.NewClient(ctx, instance, dialParams, Options(creds)...)
if err != nil {
return nil, errors.Annotate(err, "failed to create client").Err()
}
return cl, nil
}
// Options returns CAS client options.
func Options(creds credentials.PerRPCCredentials) []client.Opt {
casConcurrency := runtime.NumCPU() * 2
if runtime.GOOS == "windows" {
// This is for better file write performance on Windows (http://b/171672371#comment6).
casConcurrency = runtime.NumCPU()
}
return []client.Opt{
&client.PerRPCCreds{Creds: creds},
client.CASConcurrency(casConcurrency),
client.UtilizeLocality(true),
&client.TreeSymlinkOpts{Preserved: true, FollowsTarget: false},
// Set restricted permission for written files.
client.DirMode(0700),
client.ExecutableMode(0700),
client.RegularMode(0600),
client.CompressedBytestreamThreshold(0),
// Do not set per RPC timeout.
client.RPCTimeouts{},
}
}
// ContextWithMetadata attaches RBE related metadata with tool name to the
// given context.
func ContextWithMetadata(ctx context.Context, toolName string) (context.Context, error) {
ctx, err := client.ContextWithMetadata(ctx, &client.ContextMetadata{
ToolName: toolName,
})
if err != nil {
return nil, errors.Annotate(err, "failed to attach metadata").Err()
}
m, err := client.GetContextMetadata(ctx)
if err != nil {
return nil, errors.Annotate(err, "failed to extract metadata").Err()
}
logging.Infof(ctx, "context metadata: %#+v", *m)
return ctx, nil
}