-
Notifications
You must be signed in to change notification settings - Fork 71
/
filestore.go
303 lines (256 loc) · 7.1 KB
/
filestore.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
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
/*
Copyright 2019 The Kubernetes 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 file
import (
"context"
"fmt"
"io"
"net/url"
"sort"
"strings"
"cloud.google.com/go/storage"
"github.com/sirupsen/logrus"
"google.golang.org/api/option"
api "sigs.k8s.io/promo-tools/v4/api/files"
)
// FilestorePromoter manages the promotion of files.
type FilestorePromoter struct {
Source *api.Filestore
Dest *api.Filestore
Files []api.File
// Confirm, if set, will trigger a PRODUCTION artifact promotion.
Confirm bool
// UseServiceAccount must be true, for service accounts to be used
// This gives some protection against a hostile manifest.
UseServiceAccount bool
}
//counterfeiter:generate . syncFilestore
type syncFilestore interface {
// OpenReader opens an io.ReadCloser for the specified file
OpenReader(ctx context.Context, name string) (io.ReadCloser, error)
// UploadFile uploads a local file to the specified destination
UploadFile(ctx context.Context, dest string, localFile string) error
// ListFiles returns all the file artifacts in the filestore, recursively.
ListFiles(ctx context.Context) (map[string]*SyncFileInfo, error)
}
var supportedProviders = []Provider{
GoogleCloudStorage,
S3Storage,
}
func openFilestore(
ctx context.Context,
filestore *api.Filestore,
useServiceAccount, confirm bool,
) (syncFilestore, error) {
for _, provider := range supportedProviders {
scheme := provider.Scheme()
if strings.HasPrefix(filestore.Base, scheme+api.Backslash) {
return provider.OpenFilestore(ctx, filestore, useServiceAccount, confirm)
}
}
expected := []string{}
for _, provider := range supportedProviders {
expected = append(expected, provider.Scheme())
}
sort.Strings(expected)
return nil, fmt.Errorf(
"unrecognized scheme %q (supported schemes: %s)",
filestore.Base,
strings.Join(expected, ", "),
)
}
// openGCSFilestore opens a filestore backed by Google Cloud Storage (GCS)
func (p *gcsProvider) OpenFilestore(
ctx context.Context,
filestore *api.Filestore,
useServiceAccount, confirm bool,
) (syncFilestore, error) {
u, err := url.Parse(filestore.Base)
if err != nil {
return nil, fmt.Errorf(
"error parsing filestore base %q: %v",
filestore.Base,
err,
)
}
if u.Scheme != p.Scheme() {
return nil, fmt.Errorf("unrecognized scheme %q, expected %s", filestore.Base, p.Scheme())
}
withAuth, err := useStorageClientAuth(filestore, useServiceAccount, confirm)
if err != nil {
return nil, err
}
var opts []option.ClientOption
if withAuth {
logrus.Infof(
"requesting an authenticated storage client for %s",
filestore.Base,
)
ts := &gcloudTokenSource{ServiceAccount: filestore.ServiceAccount}
opts = append(opts, option.WithTokenSource(ts))
} else {
logrus.Warnf(
"requesting an UNAUTHENTICATED storage client for %s",
filestore.Base,
)
opts = append(opts, option.WithoutAuthentication())
}
client, err := storage.NewClient(ctx, opts...)
if err != nil {
return nil, fmt.Errorf("error building GCS client: %v", err)
}
prefix := strings.TrimPrefix(u.Path, "/")
if prefix != "" && !strings.HasSuffix(prefix, "/") {
prefix += "/"
}
bucket := u.Host
s := &gcsSyncFilestore{
provider: p,
filestore: filestore,
client: client,
bucket: bucket,
prefix: prefix,
}
return s, nil
}
func useStorageClientAuth(
filestore *api.Filestore,
useServiceAccount, confirm bool,
) (bool, error) {
withAuth := false
// Source filestores should be world-readable, so authentication should
// not be required.
if filestore.Src {
return withAuth, nil
}
if confirm {
if filestore.ServiceAccount == "" {
return withAuth, fmt.Errorf("cannot execute a production file promotion without a service account")
}
withAuth = true
} else if useServiceAccount {
if filestore.ServiceAccount == "" {
return withAuth, fmt.Errorf("requested an authenticated file promotion, but a service account was not specified")
}
withAuth = true
}
return withAuth, nil
}
// computeNeededOperations determines the list of files that need to be copied
func (p *FilestorePromoter) computeNeededOperations(
source, dest map[string]*SyncFileInfo,
destFilestore syncFilestore,
) ([]SyncFileOp, error) {
ops := make([]SyncFileOp, 0)
for i := range p.Files {
f := &p.Files[i]
relativePath := f.Name
sourceFile := source[relativePath]
if sourceFile == nil {
absolutePath := joinFilepath(p.Source, relativePath)
logrus.Debugf(
"file %q not found in source (%q)",
relativePath,
absolutePath,
)
continue
}
destFile := dest[relativePath]
if destFile == nil {
destFile = &SyncFileInfo{}
destFile.RelativePath = sourceFile.RelativePath
destFile.AbsolutePath = joinFilepath(
p.Dest,
sourceFile.RelativePath)
destFile.filestore = destFilestore
ops = append(ops, ©FileOp{
Source: sourceFile,
Dest: destFile,
ManifestFile: f,
})
continue
}
changed := false
if destFile.MD5 != sourceFile.MD5 {
logrus.Warnf("MD5 mismatch on source %q vs dest %q: %q vs %q",
sourceFile.AbsolutePath,
destFile.AbsolutePath,
sourceFile.MD5,
destFile.MD5)
changed = true
}
if destFile.Size != sourceFile.Size {
logrus.Warnf("Size mismatch on source %q vs dest %q: %d vs %d",
sourceFile.AbsolutePath,
destFile.AbsolutePath,
sourceFile.Size,
destFile.Size)
changed = true
}
if !changed {
logrus.Infof("metadata match for %q", destFile.AbsolutePath)
continue
}
ops = append(ops, ©FileOp{
Source: sourceFile,
Dest: destFile,
ManifestFile: f,
})
}
return ops, nil
}
func joinFilepath(filestore *api.Filestore, relativePath string) string {
s := strings.TrimSuffix(filestore.Base, "/")
s += "/"
s += strings.TrimPrefix(relativePath, "/")
return s
}
// BuildOperations builds the required operations to sync from the
// Source Filestore to the Dest Filestore.
func (p *FilestorePromoter) BuildOperations(
ctx context.Context,
) ([]SyncFileOp, error) {
sourceFilestore, err := openFilestore(
ctx,
p.Source,
p.UseServiceAccount,
p.Confirm,
)
if err != nil {
return nil, err
}
if sourceFilestore == nil {
return nil, fmt.Errorf("source filestore cannot be nil")
}
destFilestore, err := openFilestore(
ctx,
p.Dest,
p.UseServiceAccount,
p.Confirm,
)
if err != nil {
return nil, err
}
if destFilestore == nil {
return nil, fmt.Errorf("destination filestore cannot be nil")
}
sourceFiles, err := sourceFilestore.ListFiles(ctx)
if err != nil {
return nil, err
}
destFiles, err := destFilestore.ListFiles(ctx)
if err != nil {
return nil, err
}
return p.computeNeededOperations(sourceFiles, destFiles, destFilestore)
}