-
Notifications
You must be signed in to change notification settings - Fork 265
/
fetch.go
528 lines (463 loc) · 13.9 KB
/
fetch.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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
// Copyright 2020 Buf Technologies, Inc.
//
// 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 fetch
import (
"context"
"io"
"net/http"
"github.com/bufbuild/buf/internal/pkg/app"
"github.com/bufbuild/buf/internal/pkg/git"
"github.com/bufbuild/buf/internal/pkg/httpauth"
"github.com/bufbuild/buf/internal/pkg/storage"
"go.uber.org/zap"
)
const (
// FileSchemeHTTP is the http file scheme.
FileSchemeHTTP FileScheme = iota + 1
// FileSchemeHTTPS is the https file scheme.
FileSchemeHTTPS
// FileSchemeLocal is the local file scheme.
FileSchemeLocal
// FileSchemeStdio is the stdio file scheme.
//
// This can reference either stdin or stdout depending on if we are
// reading or writing.
FileSchemeStdio
// FileSchemeStdin is the stdin file scheme.
FileSchemeStdin
// FileSchemeStdout is the stdout file scheme.
FileSchemeStdout
// FileSchemeNull is the null file scheme.
FileSchemeNull
// GitSchemeHTTP is the http git scheme.
GitSchemeHTTP GitScheme = iota + 1
// GitSchemeHTTPS is the https git scheme.
GitSchemeHTTPS
// GitSchemeLocal is the local git scheme.
GitSchemeLocal
// GitSchemeSSH is the ssh git scheme.
GitSchemeSSH
// ArchiveTypeTar is a tar archive.
ArchiveTypeTar ArchiveType = iota + 1
// ArchiveTypeZip is a zip archive.
ArchiveTypeZip
// CompressionTypeNone is no compression.
CompressionTypeNone CompressionType = iota + 1
// CompressionTypeGzip is gzip compression.
CompressionTypeGzip
// CompressionTypeZstd is zstd compression.
CompressionTypeZstd
)
// FileScheme is a file scheme.
type FileScheme int
// GitScheme is a git scheme.
type GitScheme int
// ArchiveType is a archive type.
type ArchiveType int
// CompressionType is a compression type.
type CompressionType int
// Ref is a reference.
type Ref interface {
// Path is the path to.
//
// This will be the non-empty path minus the scheme for http and https files.
// This will be the non-empty normalized file path for local files.
// This will be empty for stdio and null files.
// This will be the non-empty normalized directory path for directories.
// This will be the non-empty path minus the scheme for http, https, and ssh git repositories.
// This will be the non-empty normalized directory path for local git repositories.
Path() string
ref()
}
// FileRef is a file reference.
type FileRef interface {
Ref
FileScheme() FileScheme
CompressionType() CompressionType
fileRef()
}
// BucketRef is a bucket reference.
type BucketRef interface {
Ref
bucketRef()
}
// SingleRef is a non-archive file reference.
type SingleRef interface {
FileRef
singleRef()
}
// NewSingleRef returns a new SingleRef.
func NewSingleRef(path string, compressionType CompressionType) (SingleRef, error) {
return newSingleRef("", path, compressionType)
}
// ArchiveRef is an archive reference.
//
// An ArchiveRef is a special type of reference that can be either a FileRef or a BucketRef.
// Note that if ArchiveType is ArchiveTypeZip, CompressionType will always be CompressionTypeNone.
type ArchiveRef interface {
FileRef
BucketRef
ArchiveType() ArchiveType
StripComponents() uint32
archiveRef()
}
// NewArchiveRef returns a new ArchiveRef.
func NewArchiveRef(
path string,
archiveType ArchiveType,
compressionType CompressionType,
stripComponents uint32,
) (ArchiveRef, error) {
return newArchiveRef("", path, archiveType, compressionType, stripComponents)
}
// DirRef is a local directory reference.
type DirRef interface {
BucketRef
dirRef()
}
// NewDirRef returns a new DirRef.
func NewDirRef(path string) (DirRef, error) {
return newDirRef("", path)
}
// GitRef is a git reference.
type GitRef interface {
BucketRef
GitScheme() GitScheme
// Optional. May be nil, in which case clone the default branch.
GitName() git.Name
// Will always be >= 1
Depth() uint32
RecurseSubmodules() bool
gitRef()
}
// NewGitRef returns a new GitRef.
func NewGitRef(
path string,
gitName git.Name,
depth uint32,
recurseSubmodules bool,
) (GitRef, error) {
return newGitRef("", path, gitName, depth, recurseSubmodules)
}
// HasFormat is an object that has a format.
type HasFormat interface {
Format() string
}
// ParsedRef is a parsed Ref.
type ParsedRef interface {
Ref
HasFormat
}
// ParsedFileRef is a parsed FileRef.
type ParsedFileRef interface {
FileRef
HasFormat
}
// ParsedBucketRef is a parsed BucketRef.
type ParsedBucketRef interface {
BucketRef
HasFormat
}
// ParsedSingleRef is a parsed SingleRef.
type ParsedSingleRef interface {
SingleRef
HasFormat
}
// ParsedArchiveRef is a parsed ArchiveRef.
type ParsedArchiveRef interface {
ArchiveRef
HasFormat
}
// ParsedDirRef is a parsed DirRef.
type ParsedDirRef interface {
DirRef
HasFormat
}
// ParsedGitRef is a parsed GitRef.
type ParsedGitRef interface {
GitRef
HasFormat
}
// RefParser parses references.
type RefParser interface {
// GetParsedRef gets the ParsedRef for the value.
//
// The returned ParsedRef will be either a ParsedSingleRef, ParsedArchiveRef, ParsedDirRef, or ParsedGitRef.
//
// The options should be used to validate that you are getting one of the correct formats.
GetParsedRef(ctx context.Context, value string, options ...GetParsedRefOption) (ParsedRef, error)
}
// NewRefParser returns a new RefParser.
func NewRefParser(logger *zap.Logger, options ...RefParserOption) RefParser {
return newRefParser(logger, options...)
}
// Reader is a reader.
type Reader interface {
// GetFile gets the file.
// SingleRefs and ArchiveRefs will result in decompressed files unless KeepFileCompression is set.
GetFile(
ctx context.Context,
container app.EnvStdinContainer,
fileRef FileRef,
options ...GetFileOption,
) (io.ReadCloser, error)
// GetBucket gets the bucket .
GetBucket(
ctx context.Context,
container app.EnvStdinContainer,
bucketRef BucketRef,
options ...GetBucketOption,
) (storage.ReadBucketCloser, error)
}
// NewReader returns a new Reader.
func NewReader(
logger *zap.Logger,
options ...ReaderOption,
) Reader {
return newReader(
logger,
options...,
)
}
// Writer is a writer.
type Writer interface {
// PutFile puts the file.
PutFile(
ctx context.Context,
container app.EnvStdoutContainer,
fileRef FileRef,
options ...PutFileOption,
) (io.WriteCloser, error)
}
// NewWriter returns a new Writer.
func NewWriter(
logger *zap.Logger,
options ...WriterOption,
) Writer {
return newWriter(
logger,
options...,
)
}
// RawRef is an unprocessed ref used for WithRefProcessor.
//
// A RawRefProcessor will allow modifications to a RawRef before continuing parsing.
// This allows defaults to be inferred from the path.
//
// The Path will be the only value set when the RawRefProcessor is invoked, and is not normalized.
// After the RawRefProcessor is called, options will be parsed.
type RawRef struct {
// Will always be set
// Not normalized yet
Path string
// Will always be set
// Set via RawRefProcessor if not explicitly set
Format string
// Only set for single, archive formats
// Cannot be set for zip archives
CompressionType CompressionType
// Only set for git formats
// Only one of GitBranch and GitTag will be set
GitBranch string
// Only set for git formats
// Only one of GitBranch and GitTag will be set
GitTag string
// Only set for git formats
// Specifies an exact git reference to use with git checkout.
// Can be used on its own or with GitBranch. Not allowed with GitTag.
// This is defined as anything that can be given to git checkout.
GitRef string
// Only set for git formats
GitRecurseSubmodules bool
// Only set for git formats.
// The depth to use when cloning a repository. Only allowed when GitRef
// is set. Defaults to 50 if unset.
GitDepth uint32
// Only set for archive formats
ArchiveStripComponents uint32
}
// RefParserOption is an RefParser option.
type RefParserOption func(*refParser)
// WithRawRefProcessor attaches the given RawRefProcessor.
//
// If format is not manually specified, the RefParser will use this format parser
// with the raw path, that is not normalized.
func WithRawRefProcessor(rawRefProcessor func(*RawRef) error) RefParserOption {
return func(refParser *refParser) {
refParser.rawRefProcessor = rawRefProcessor
}
}
// WithSingleFormat attaches the given format as a single format.
//
// It is up to the user to not incorrectly attached a format twice.
func WithSingleFormat(format string, options ...SingleFormatOption) RefParserOption {
return func(refParser *refParser) {
format = normalizeFormat(format)
if format == "" {
return
}
singleFormatInfo := newSingleFormatInfo()
for _, option := range options {
option(singleFormatInfo)
}
refParser.singleFormatToInfo[format] = singleFormatInfo
}
}
// WithArchiveFormat attaches the given format as an archive format.
//
// It is up to the user to not incorrectly attached a format twice.
func WithArchiveFormat(format string, archiveType ArchiveType, options ...ArchiveFormatOption) RefParserOption {
return func(refParser *refParser) {
format = normalizeFormat(format)
if format == "" {
return
}
archiveFormatInfo := newArchiveFormatInfo(archiveType)
for _, option := range options {
option(archiveFormatInfo)
}
refParser.archiveFormatToInfo[format] = archiveFormatInfo
}
}
// WithDirFormat attaches the given format as a dir format.
//
// It is up to the user to not incorrectly attached a format twice.
func WithDirFormat(format string, options ...DirFormatOption) RefParserOption {
return func(refParser *refParser) {
format = normalizeFormat(format)
if format == "" {
return
}
dirFormatInfo := newDirFormatInfo()
for _, option := range options {
option(dirFormatInfo)
}
refParser.dirFormatToInfo[format] = dirFormatInfo
}
}
// WithGitFormat attaches the given format as a git format.
//
// It is up to the user to not incorrectly attached a format twice.
func WithGitFormat(format string, options ...GitFormatOption) RefParserOption {
return func(refParser *refParser) {
format = normalizeFormat(format)
if format == "" {
return
}
gitFormatInfo := newGitFormatInfo()
for _, option := range options {
option(gitFormatInfo)
}
refParser.gitFormatToInfo[format] = gitFormatInfo
}
}
// SingleFormatOption is a single format option.
type SingleFormatOption func(*singleFormatInfo)
// WithSingleDefaultCompressionType sets the default compression type.
func WithSingleDefaultCompressionType(defaultCompressionType CompressionType) SingleFormatOption {
return func(singleFormatInfo *singleFormatInfo) {
singleFormatInfo.defaultCompressionType = defaultCompressionType
}
}
// ArchiveFormatOption is a archive format option.
type ArchiveFormatOption func(*archiveFormatInfo)
// WithArchiveDefaultCompressionType sets the default compression type.
//
// Note this should never be set for zip.
func WithArchiveDefaultCompressionType(defaultCompressionType CompressionType) ArchiveFormatOption {
return func(archiveFormatInfo *archiveFormatInfo) {
archiveFormatInfo.defaultCompressionType = defaultCompressionType
}
}
// DirFormatOption is a dir format option.
type DirFormatOption func(*dirFormatInfo)
// GitFormatOption is a git format option.
type GitFormatOption func(*gitFormatInfo)
// ReaderOption is an Reader option.
type ReaderOption func(*reader)
// WithReaderHTTP enables HTTP.
func WithReaderHTTP(httpClient *http.Client, httpAuthenticator httpauth.Authenticator) ReaderOption {
return func(reader *reader) {
reader.httpEnabled = true
reader.httpClient = httpClient
reader.httpAuthenticator = httpAuthenticator
}
}
// WithReaderGit enables Git.
func WithReaderGit(gitCloner git.Cloner) ReaderOption {
return func(reader *reader) {
reader.gitEnabled = true
reader.gitCloner = gitCloner
}
}
// WithReaderLocal enables local.
func WithReaderLocal() ReaderOption {
return func(reader *reader) {
reader.localEnabled = true
}
}
// WithReaderStdio enables stdio.
func WithReaderStdio() ReaderOption {
return func(reader *reader) {
reader.stdioEnabled = true
}
}
// WriterOption is an Writer option.
type WriterOption func(*writer)
// WithWriterLocal enables local.
func WithWriterLocal() WriterOption {
return func(writer *writer) {
writer.localEnabled = true
}
}
// WithWriterStdio enables stdio.
func WithWriterStdio() WriterOption {
return func(writer *writer) {
writer.stdioEnabled = true
}
}
// GetParsedRefOption is a GetParsedRef option
type GetParsedRefOption func(*getParsedRefOptions)
// WithAllowedFormats limits the allowed formats to the given formats.
func WithAllowedFormats(formats ...string) GetParsedRefOption {
return func(getParsedRefOptions *getParsedRefOptions) {
for _, format := range formats {
getParsedRefOptions.allowedFormats[normalizeFormat(format)] = struct{}{}
}
}
}
// GetFileOption is a GetFile option
type GetFileOption func(*getFileOptions)
// WithGetFileKeepFileCompression says to return s compressed.
func WithGetFileKeepFileCompression() GetFileOption {
return func(getFileOptions *getFileOptions) {
getFileOptions.keepFileCompression = true
}
}
// GetBucketOption is a GetBucket option
type GetBucketOption func(*getBucketOptions)
// WithGetBucketMapper returns a GetBucketOption that adds the Mapper.
func WithGetBucketMapper(mapper storage.Mapper) GetBucketOption {
return func(getBucketOptions *getBucketOptions) {
getBucketOptions.mapper = mapper
}
}
// PutFileOption is a PutFile option
type PutFileOption func(*putFileOptions)
// WithPutFileNoFileCompression says to put s uncompressed.
func WithPutFileNoFileCompression() PutFileOption {
return func(putFileOptions *putFileOptions) {
putFileOptions.noFileCompression = true
}
}