-
Notifications
You must be signed in to change notification settings - Fork 248
/
get.go
140 lines (133 loc) · 4.01 KB
/
get.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
// Copyright 2020-2023 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 bufpluginconfig
import (
"context"
"fmt"
"io"
"github.com/bufbuild/buf/private/pkg/encoding"
"github.com/bufbuild/buf/private/pkg/storage"
"github.com/bufbuild/buf/private/pkg/stringutil"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/codes"
"go.uber.org/multierr"
)
func getConfigForBucket(ctx context.Context, readBucket storage.ReadBucket, options []ConfigOption) (_ *Config, retErr error) {
ctx, span := otel.GetTracerProvider().Tracer("bufbuild/buf").Start(ctx, "get_plugin_config")
defer span.End()
defer func() {
if retErr != nil {
span.RecordError(retErr)
span.SetStatus(codes.Error, retErr.Error())
}
}()
// This will be in the order of precedence.
var foundConfigFilePaths []string
// Go through all valid config file paths and see which ones are present.
// If none are present, return the default config.
// If multiple are present, error.
for _, configFilePath := range AllConfigFilePaths {
exists, err := storage.Exists(ctx, readBucket, configFilePath)
if err != nil {
return nil, err
}
if exists {
foundConfigFilePaths = append(foundConfigFilePaths, configFilePath)
}
}
switch len(foundConfigFilePaths) {
case 0:
// Did not find anything, return the default.
return newConfig(ExternalConfig{}, options)
case 1:
readObjectCloser, err := readBucket.Get(ctx, foundConfigFilePaths[0])
if err != nil {
return nil, err
}
defer func() {
retErr = multierr.Append(retErr, readObjectCloser.Close())
}()
data, err := io.ReadAll(readObjectCloser)
if err != nil {
return nil, err
}
return getConfigForDataInternal(
ctx,
encoding.UnmarshalYAMLNonStrict,
encoding.UnmarshalYAMLStrict,
data,
readObjectCloser.ExternalPath(),
options,
)
default:
return nil, fmt.Errorf("only one plugin file can exist but found multiple plugin files: %s", stringutil.SliceToString(foundConfigFilePaths))
}
}
func getConfigForData(ctx context.Context, data []byte, options []ConfigOption) (*Config, error) {
_, span := otel.GetTracerProvider().Tracer("bufbuild/buf").Start(ctx, "get_plugin_config_for_data")
defer span.End()
config, err := getConfigForDataInternal(
ctx,
encoding.UnmarshalJSONOrYAMLNonStrict,
encoding.UnmarshalJSONOrYAMLStrict,
data,
"Plugin configuration data",
options,
)
if err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, err.Error())
}
return config, err
}
func getConfigForDataInternal(
ctx context.Context,
unmarshalNonStrict func([]byte, interface{}) error,
unmarshalStrict func([]byte, interface{}) error,
data []byte,
id string,
options []ConfigOption,
) (*Config, error) {
var externalConfigVersion externalConfigVersion
if err := unmarshalNonStrict(data, &externalConfigVersion); err != nil {
return nil, err
}
if err := validateExternalConfigVersion(externalConfigVersion, id); err != nil {
return nil, err
}
var externalConfig ExternalConfig
if err := unmarshalStrict(data, &externalConfig); err != nil {
return nil, err
}
return newConfig(externalConfig, options)
}
func validateExternalConfigVersion(externalConfigVersion externalConfigVersion, id string) error {
switch externalConfigVersion.Version {
case "":
return fmt.Errorf(
`%s has no version set. Please add "version: %s"`,
id,
V1Version,
)
case V1Version:
return nil
default:
return fmt.Errorf(
`%s has an invalid "version: %s" set. Please add "version: %s"`,
id,
externalConfigVersion.Version,
V1Version,
)
}
}