-
Notifications
You must be signed in to change notification settings - Fork 265
/
module.go
279 lines (260 loc) · 8.6 KB
/
module.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
// Copyright 2020-2022 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 bufmodule
import (
"context"
"fmt"
"github.com/bufbuild/buf/private/bufpkg/bufcheck/bufbreaking/bufbreakingconfig"
"github.com/bufbuild/buf/private/bufpkg/bufcheck/buflint/buflintconfig"
"github.com/bufbuild/buf/private/bufpkg/bufconfig"
"github.com/bufbuild/buf/private/bufpkg/bufmodule/bufmoduleref"
breakingv1 "github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/breaking/v1"
lintv1 "github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/lint/v1"
modulev1alpha1 "github.com/bufbuild/buf/private/gen/proto/go/buf/alpha/module/v1alpha1"
"github.com/bufbuild/buf/private/pkg/normalpath"
"github.com/bufbuild/buf/private/pkg/storage"
"github.com/bufbuild/buf/private/pkg/storage/storagemem"
)
type module struct {
sourceReadBucket storage.ReadBucket
dependencyModulePins []bufmoduleref.ModulePin
moduleIdentity bufmoduleref.ModuleIdentity
commit string
documentation string
breakingConfig *bufbreakingconfig.Config
lintConfig *buflintconfig.Config
}
func newModuleForProto(
ctx context.Context,
protoModule *modulev1alpha1.Module,
options ...ModuleOption,
) (*module, error) {
if err := ValidateProtoModule(protoModule); err != nil {
return nil, err
}
// We store this as a ReadBucket as this should never be modified outside of this function.
readWriteBucket := storagemem.NewReadWriteBucket()
for _, moduleFile := range protoModule.Files {
if normalpath.Ext(moduleFile.Path) != ".proto" {
return nil, fmt.Errorf("expected .proto file but got %q", moduleFile)
}
// we already know that paths are unique from validation
if err := storage.PutPath(ctx, readWriteBucket, moduleFile.Path, moduleFile.Content); err != nil {
return nil, err
}
}
dependencyModulePins, err := bufmoduleref.NewModulePinsForProtos(protoModule.Dependencies...)
if err != nil {
return nil, err
}
breakingConfig, lintConfig, err := configsForProto(protoModule.GetBreakingConfig(), protoModule.GetLintConfig())
if err != nil {
return nil, err
}
return newModule(
ctx,
readWriteBucket,
dependencyModulePins,
nil, // The module identity is not stored on the proto. We rely on the layer above, (e.g. `ModuleReader`) to set this as needed.
protoModule.GetDocumentation(),
breakingConfig,
lintConfig,
options...,
)
}
func configsForProto(
protoBreakingConfig *breakingv1.Config,
protoLintConfig *lintv1.Config,
) (*bufbreakingconfig.Config, *buflintconfig.Config, error) {
var breakingConfig *bufbreakingconfig.Config
var breakingConfigVersion string
if protoBreakingConfig != nil {
breakingConfig = bufbreakingconfig.ConfigForProto(protoBreakingConfig)
breakingConfigVersion = breakingConfig.Version
}
var lintConfig *buflintconfig.Config
var lintConfigVersion string
if protoLintConfig != nil {
lintConfig = buflintconfig.ConfigForProto(protoLintConfig)
lintConfigVersion = lintConfig.Version
}
if lintConfigVersion != breakingConfigVersion {
return nil, nil, fmt.Errorf("mismatched breaking config version %q and lint config version %q found", breakingConfigVersion, lintConfigVersion)
}
// If there is no breaking and lint configs, we want to default to the v1 version.
if breakingConfig == nil && lintConfig == nil {
breakingConfig = &bufbreakingconfig.Config{
Version: bufconfig.V1Version,
}
lintConfig = &buflintconfig.Config{
Version: bufconfig.V1Version,
}
} else if breakingConfig == nil {
// In the case that only breaking config is nil, we'll use generated an empty default config
// using the lint config version.
breakingConfig = &bufbreakingconfig.Config{
Version: lintConfigVersion,
}
} else if lintConfig == nil {
// In the case that only lint config is nil, we'll use generated an empty default config
// using the breaking config version.
lintConfig = &buflintconfig.Config{
Version: breakingConfigVersion,
}
}
// Finally, validate the config versions are valid. This should always pass in the case of
// the default values.
if err := bufconfig.ValidateVersion(breakingConfig.Version); err != nil {
return nil, nil, err
}
if err := bufconfig.ValidateVersion(lintConfig.Version); err != nil {
return nil, nil, err
}
return breakingConfig, lintConfig, nil
}
func newModuleForBucket(
ctx context.Context,
sourceReadBucket storage.ReadBucket,
options ...ModuleOption,
) (*module, error) {
dependencyModulePins, err := bufmoduleref.DependencyModulePinsForBucket(ctx, sourceReadBucket)
if err != nil {
return nil, err
}
documentation, err := getDocumentationForBucket(ctx, sourceReadBucket)
if err != nil {
return nil, err
}
moduleConfig, err := bufconfig.GetConfigForBucket(ctx, sourceReadBucket)
if err != nil {
return nil, err
}
var moduleIdentity bufmoduleref.ModuleIdentity
// if the module config has an identity, set the module identity
if moduleConfig.ModuleIdentity != nil {
moduleIdentity = moduleConfig.ModuleIdentity
}
return newModule(
ctx,
storage.MapReadBucket(sourceReadBucket, storage.MatchPathExt(".proto")),
dependencyModulePins,
moduleIdentity,
documentation,
moduleConfig.Breaking,
moduleConfig.Lint,
options...,
)
}
// this should only be called by other newModule constructors
func newModule(
ctx context.Context,
// must only contain .proto files
sourceReadBucket storage.ReadBucket,
dependencyModulePins []bufmoduleref.ModulePin,
moduleIdentity bufmoduleref.ModuleIdentity,
documentation string,
breakingConfig *bufbreakingconfig.Config,
lintConfig *buflintconfig.Config,
options ...ModuleOption,
) (_ *module, retErr error) {
if err := bufmoduleref.ValidateModulePinsUniqueByIdentity(dependencyModulePins); err != nil {
return nil, err
}
// we rely on this being sorted here
bufmoduleref.SortModulePins(dependencyModulePins)
module := &module{
sourceReadBucket: sourceReadBucket,
dependencyModulePins: dependencyModulePins,
moduleIdentity: moduleIdentity,
documentation: documentation,
breakingConfig: breakingConfig,
lintConfig: lintConfig,
}
for _, option := range options {
option(module)
}
return module, nil
}
func (m *module) TargetFileInfos(ctx context.Context) ([]bufmoduleref.FileInfo, error) {
return m.SourceFileInfos(ctx)
}
func (m *module) SourceFileInfos(ctx context.Context) ([]bufmoduleref.FileInfo, error) {
var fileInfos []bufmoduleref.FileInfo
if walkErr := m.sourceReadBucket.Walk(ctx, "", func(objectInfo storage.ObjectInfo) error {
// super overkill but ok
if err := bufmoduleref.ValidateModuleFilePath(objectInfo.Path()); err != nil {
return err
}
fileInfo, err := bufmoduleref.NewFileInfo(
objectInfo.Path(),
objectInfo.ExternalPath(),
false,
m.moduleIdentity,
m.commit,
)
if err != nil {
return err
}
fileInfos = append(fileInfos, fileInfo)
return nil
}); walkErr != nil {
return nil, fmt.Errorf("failed to enumerate module files: %w", walkErr)
}
bufmoduleref.SortFileInfos(fileInfos)
return fileInfos, nil
}
func (m *module) GetModuleFile(ctx context.Context, path string) (ModuleFile, error) {
// super overkill but ok
if err := bufmoduleref.ValidateModuleFilePath(path); err != nil {
return nil, err
}
readObjectCloser, err := m.sourceReadBucket.Get(ctx, path)
if err != nil {
return nil, err
}
fileInfo, err := bufmoduleref.NewFileInfo(
readObjectCloser.Path(),
readObjectCloser.ExternalPath(),
false,
m.moduleIdentity,
m.commit,
)
if err != nil {
return nil, err
}
return newModuleFile(fileInfo, readObjectCloser), nil
}
func (m *module) DependencyModulePins() []bufmoduleref.ModulePin {
// already sorted in constructor
return m.dependencyModulePins
}
func (m *module) Documentation() string {
return m.documentation
}
func (m *module) BreakingConfig() *bufbreakingconfig.Config {
return m.breakingConfig
}
func (m *module) LintConfig() *buflintconfig.Config {
return m.lintConfig
}
func (m *module) getModuleIdentity() bufmoduleref.ModuleIdentity {
return m.moduleIdentity
}
func (m *module) getSourceReadBucket() storage.ReadBucket {
return m.sourceReadBucket
}
func (m *module) getCommit() string {
return m.commit
}
func (m *module) isModule() {}