-
Notifications
You must be signed in to change notification settings - Fork 245
/
config.go
440 lines (425 loc) · 15.1 KB
/
config.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
// Copyright 2020-2024 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 (
"errors"
"fmt"
"strings"
"github.com/bufbuild/buf/private/bufpkg/bufplugin/bufpluginref"
"github.com/bufbuild/buf/private/gen/data/dataspdx"
"golang.org/x/mod/modfile"
"golang.org/x/mod/semver"
)
func newConfig(externalConfig ExternalConfig, options []ConfigOption) (*Config, error) {
opts := &configOptions{}
for _, option := range options {
option(opts)
}
pluginIdentity, err := pluginIdentityForStringWithOverrideRemote(externalConfig.Name, opts.overrideRemote)
if err != nil {
return nil, err
}
pluginVersion := externalConfig.PluginVersion
if pluginVersion == "" {
return nil, errors.New("a plugin_version is required")
}
if !semver.IsValid(pluginVersion) {
return nil, fmt.Errorf("plugin_version %q must be a valid semantic version", externalConfig.PluginVersion)
}
var dependencies []bufpluginref.PluginReference
if len(externalConfig.Deps) > 0 {
existingDeps := make(map[string]struct{})
for _, dependency := range externalConfig.Deps {
reference, err := pluginReferenceForStringWithOverrideRemote(dependency.Plugin, dependency.Revision, opts.overrideRemote)
if err != nil {
return nil, err
}
if reference.Remote() != pluginIdentity.Remote() {
return nil, fmt.Errorf("plugin dependency %q must use same remote as plugin %q", dependency, pluginIdentity.Remote())
}
if _, ok := existingDeps[reference.IdentityString()]; ok {
return nil, fmt.Errorf("plugin dependency %q was specified more than once", dependency)
}
existingDeps[reference.IdentityString()] = struct{}{}
dependencies = append(dependencies, reference)
}
}
registryConfig, err := newRegistryConfig(externalConfig.Registry)
if err != nil {
return nil, err
}
spdxLicenseID := externalConfig.SPDXLicenseID
if spdxLicenseID != "" {
if licenseInfo, ok := dataspdx.GetLicenseInfo(spdxLicenseID); ok {
spdxLicenseID = licenseInfo.ID()
} else {
return nil, fmt.Errorf("unknown SPDX License ID %q", spdxLicenseID)
}
}
return &Config{
Name: pluginIdentity,
PluginVersion: pluginVersion,
Dependencies: dependencies,
Registry: registryConfig,
SourceURL: externalConfig.SourceURL,
Description: externalConfig.Description,
OutputLanguages: externalConfig.OutputLanguages,
SPDXLicenseID: spdxLicenseID,
LicenseURL: externalConfig.LicenseURL,
IntegrationGuideURL: externalConfig.IntegrationGuideURL,
}, nil
}
func newRegistryConfig(externalRegistryConfig ExternalRegistryConfig) (*RegistryConfig, error) {
var (
isGoEmpty = externalRegistryConfig.Go == nil
isNPMEmpty = externalRegistryConfig.NPM == nil
isMavenEmpty = externalRegistryConfig.Maven == nil
isSwiftEmpty = externalRegistryConfig.Swift == nil
isPythonEmpty = externalRegistryConfig.Python == nil
isCargoEmpty = externalRegistryConfig.Cargo == nil
)
var registryCount int
for _, isEmpty := range []bool{
isGoEmpty,
isNPMEmpty,
isMavenEmpty,
isSwiftEmpty,
isPythonEmpty,
isCargoEmpty,
} {
if !isEmpty {
registryCount++
}
if registryCount > 1 {
// We might eventually want to support multiple runtime configuration,
// but it's safe to start with an error for now.
return nil, fmt.Errorf("%s configuration contains multiple registry configurations", ExternalConfigFilePath)
}
}
if registryCount == 0 {
// It's possible that the plugin doesn't have any runtime dependencies.
return nil, nil
}
options := OptionsSliceToPluginOptions(externalRegistryConfig.Opts)
switch {
case !isGoEmpty:
goRegistryConfig, err := newGoRegistryConfig(externalRegistryConfig.Go)
if err != nil {
return nil, err
}
return &RegistryConfig{
Go: goRegistryConfig,
Options: options,
}, nil
case !isNPMEmpty:
npmRegistryConfig, err := newNPMRegistryConfig(externalRegistryConfig.NPM)
if err != nil {
return nil, err
}
return &RegistryConfig{
NPM: npmRegistryConfig,
Options: options,
}, nil
case !isMavenEmpty:
mavenRegistryConfig, err := newMavenRegistryConfig(externalRegistryConfig.Maven)
if err != nil {
return nil, err
}
return &RegistryConfig{
Maven: mavenRegistryConfig,
Options: options,
}, nil
case !isSwiftEmpty:
swiftRegistryConfig, err := newSwiftRegistryConfig(externalRegistryConfig.Swift)
if err != nil {
return nil, err
}
return &RegistryConfig{
Swift: swiftRegistryConfig,
Options: options,
}, nil
case !isPythonEmpty:
pythonRegistryConfig, err := newPythonRegistryConfig(externalRegistryConfig.Python)
if err != nil {
return nil, err
}
return &RegistryConfig{
Python: pythonRegistryConfig,
Options: options,
}, nil
case !isCargoEmpty:
cargoRegistryConfig, err := newCargoRegistryConfig(externalRegistryConfig.Cargo)
if err != nil {
return nil, err
}
return &RegistryConfig{
Cargo: cargoRegistryConfig,
Options: options,
}, nil
default:
return nil, errors.New("unknown registry configuration")
}
}
func newNPMRegistryConfig(externalNPMRegistryConfig *ExternalNPMRegistryConfig) (*NPMRegistryConfig, error) {
if externalNPMRegistryConfig == nil {
return nil, nil
}
var dependencies []*NPMRegistryDependencyConfig
for _, dep := range externalNPMRegistryConfig.Deps {
if dep.Package == "" {
return nil, errors.New("npm runtime dependency requires a non-empty package name")
}
if dep.Version == "" {
return nil, errors.New("npm runtime dependency requires a non-empty version name")
}
// TODO: Note that we don't have NPM-specific validation yet - any
// non-empty string will work for the package and version.
//
// For a complete set of the version syntax we need to support, see
// https://docs.npmjs.com/cli/v6/using-npm/semver
//
// https://github.com/Masterminds/semver might be a good candidate for
// this, but it might not support all of the constraints supported
// by NPM.
dependencies = append(
dependencies,
&NPMRegistryDependencyConfig{
Package: dep.Package,
Version: dep.Version,
},
)
}
switch externalNPMRegistryConfig.ImportStyle {
case "module", "commonjs":
default:
return nil, errors.New(`npm registry config import_style must be one of: "module" or "commonjs"`)
}
return &NPMRegistryConfig{
RewriteImportPathSuffix: externalNPMRegistryConfig.RewriteImportPathSuffix,
Deps: dependencies,
ImportStyle: externalNPMRegistryConfig.ImportStyle,
}, nil
}
func newGoRegistryConfig(externalGoRegistryConfig *ExternalGoRegistryConfig) (*GoRegistryConfig, error) {
if externalGoRegistryConfig == nil {
return nil, nil
}
if externalGoRegistryConfig.MinVersion != "" && !modfile.GoVersionRE.MatchString(externalGoRegistryConfig.MinVersion) {
return nil, fmt.Errorf("the go minimum version %q must be a valid semantic version in the form of <major>.<minor>", externalGoRegistryConfig.MinVersion)
}
var dependencies []*GoRegistryDependencyConfig
for _, dep := range externalGoRegistryConfig.Deps {
if dep.Module == "" {
return nil, errors.New("go runtime dependency requires a non-empty module name")
}
if dep.Version == "" {
return nil, errors.New("go runtime dependency requires a non-empty version name")
}
if !semver.IsValid(dep.Version) {
return nil, fmt.Errorf("go runtime dependency %s:%s does not have a valid semantic version", dep.Module, dep.Version)
}
dependencies = append(
dependencies,
&GoRegistryDependencyConfig{
Module: dep.Module,
Version: dep.Version,
},
)
}
return &GoRegistryConfig{
MinVersion: externalGoRegistryConfig.MinVersion,
Deps: dependencies,
}, nil
}
func newMavenRegistryConfig(externalMavenRegistryConfig *ExternalMavenRegistryConfig) (*MavenRegistryConfig, error) {
if externalMavenRegistryConfig == nil {
return nil, nil
}
var dependencies []MavenDependencyConfig
for _, externalDep := range externalMavenRegistryConfig.Deps {
dep, err := mavenExternalDependencyToDependencyConfig(externalDep)
if err != nil {
return nil, err
}
dependencies = append(dependencies, dep)
}
var additionalRuntimes []MavenRuntimeConfig
for _, runtime := range externalMavenRegistryConfig.AdditionalRuntimes {
var deps []MavenDependencyConfig
for _, externalDep := range runtime.Deps {
dep, err := mavenExternalDependencyToDependencyConfig(externalDep)
if err != nil {
return nil, err
}
deps = append(deps, dep)
}
config := MavenRuntimeConfig{
Name: runtime.Name,
Deps: deps,
Options: runtime.Opts,
}
additionalRuntimes = append(additionalRuntimes, config)
}
return &MavenRegistryConfig{
Compiler: MavenCompilerConfig{
Java: MavenCompilerJavaConfig{
Encoding: externalMavenRegistryConfig.Compiler.Java.Encoding,
Release: externalMavenRegistryConfig.Compiler.Java.Release,
Source: externalMavenRegistryConfig.Compiler.Java.Source,
Target: externalMavenRegistryConfig.Compiler.Java.Target,
},
Kotlin: MavenCompilerKotlinConfig{
APIVersion: externalMavenRegistryConfig.Compiler.Kotlin.APIVersion,
JVMTarget: externalMavenRegistryConfig.Compiler.Kotlin.JVMTarget,
LanguageVersion: externalMavenRegistryConfig.Compiler.Kotlin.LanguageVersion,
Version: externalMavenRegistryConfig.Compiler.Kotlin.Version,
},
},
Deps: dependencies,
AdditionalRuntimes: additionalRuntimes,
}, nil
}
func newSwiftRegistryConfig(externalSwiftRegistryConfig *ExternalSwiftRegistryConfig) (*SwiftRegistryConfig, error) {
if externalSwiftRegistryConfig == nil {
return nil, nil
}
var dependencies []SwiftRegistryDependencyConfig
for _, externalDependency := range externalSwiftRegistryConfig.Deps {
dependency, err := swiftExternalDependencyToDependencyConfig(externalDependency)
if err != nil {
return nil, err
}
dependencies = append(dependencies, dependency)
}
return &SwiftRegistryConfig{
Dependencies: dependencies,
}, nil
}
func swiftExternalDependencyToDependencyConfig(externalDep ExternalSwiftRegistryDependencyConfig) (SwiftRegistryDependencyConfig, error) {
if externalDep.Source == "" {
return SwiftRegistryDependencyConfig{}, errors.New("swift runtime dependency requires a non-empty source")
}
if externalDep.Package == "" {
return SwiftRegistryDependencyConfig{}, errors.New("swift runtime dependency requires a non-empty package name")
}
if externalDep.Version == "" {
return SwiftRegistryDependencyConfig{}, errors.New("swift runtime dependency requires a non-empty version name")
}
// Swift SemVers are typically not prefixed with a "v". The Golang semver library requires a "v" prefix.
if !semver.IsValid(fmt.Sprintf("v%s", externalDep.Version)) {
return SwiftRegistryDependencyConfig{}, fmt.Errorf("swift runtime dependency %s:%s does not have a valid semantic version", externalDep.Package, externalDep.Version)
}
return SwiftRegistryDependencyConfig{
Source: externalDep.Source,
Package: externalDep.Package,
Version: externalDep.Version,
Products: externalDep.Products,
SwiftVersions: externalDep.SwiftVersions,
Platforms: SwiftRegistryDependencyPlatformConfig{
MacOS: externalDep.Platforms.MacOS,
IOS: externalDep.Platforms.IOS,
TVOS: externalDep.Platforms.TVOS,
WatchOS: externalDep.Platforms.WatchOS,
},
}, nil
}
func newPythonRegistryConfig(externalPythonRegistryConfig *ExternalPythonRegistryConfig) (*PythonRegistryConfig, error) {
if externalPythonRegistryConfig == nil {
return nil, nil
}
var dependencySpecifications []string
for _, externalDependencySpecification := range externalPythonRegistryConfig.Deps {
if externalDependencySpecification == "" {
return nil, fmt.Errorf("python registry config cannot have an empty dependency specification")
}
dependencySpecifications = append(dependencySpecifications, externalDependencySpecification)
}
switch externalPythonRegistryConfig.PackageType {
case "runtime", "stub-only":
default:
return nil, errors.New(`python registry config package_type must be one of: "runtime" or "stub-only"`)
}
return &PythonRegistryConfig{
Deps: dependencySpecifications,
RequiresPython: externalPythonRegistryConfig.RequiresPython,
PackageType: externalPythonRegistryConfig.PackageType,
}, nil
}
func newCargoRegistryConfig(externalCargoRegistryConfig *ExternalCargoRegistryConfig) (*CargoRegistryConfig, error) {
if externalCargoRegistryConfig == nil {
return nil, nil
}
config := &CargoRegistryConfig{
RustVersion: externalCargoRegistryConfig.RustVersion,
}
for _, dependency := range externalCargoRegistryConfig.Deps {
if dependency.Name == "" {
return nil, fmt.Errorf("cargo registry dependency cannot have empty name")
}
if dependency.VersionRequirement == "" {
return nil, fmt.Errorf("cargo registry dependency cannot have empty req")
}
config.Deps = append(config.Deps, CargoRegistryDependency(dependency))
}
return config, nil
}
func pluginIdentityForStringWithOverrideRemote(identityStr string, overrideRemote string) (bufpluginref.PluginIdentity, error) {
identity, err := bufpluginref.PluginIdentityForString(identityStr)
if err != nil {
return nil, err
}
if len(overrideRemote) == 0 {
return identity, nil
}
return bufpluginref.NewPluginIdentity(overrideRemote, identity.Owner(), identity.Plugin())
}
func pluginReferenceForStringWithOverrideRemote(
referenceStr string,
revision int,
overrideRemote string,
) (bufpluginref.PluginReference, error) {
reference, err := bufpluginref.PluginReferenceForString(referenceStr, revision)
if err != nil {
return nil, err
}
if len(overrideRemote) == 0 {
return reference, nil
}
overrideIdentity, err := pluginIdentityForStringWithOverrideRemote(reference.IdentityString(), overrideRemote)
if err != nil {
return nil, err
}
return bufpluginref.NewPluginReference(overrideIdentity, reference.Version(), reference.Revision())
}
func mavenExternalDependencyToDependencyConfig(dependency string) (MavenDependencyConfig, error) {
// <groupId>:<artifactId>:<version>[:<classifier>][@<type>]
dependencyWithoutExtension, extension, _ := strings.Cut(dependency, "@")
components := strings.Split(dependencyWithoutExtension, ":")
if len(components) < 3 {
return MavenDependencyConfig{}, fmt.Errorf("invalid dependency %q: missing required groupId:artifactId:version fields", dependency)
}
if len(components) > 4 {
return MavenDependencyConfig{}, fmt.Errorf("invalid dependency %q: maximum 4 fields before optional type", dependency)
}
config := MavenDependencyConfig{
GroupID: components[0],
ArtifactID: components[1],
Version: components[2],
Extension: extension,
}
if len(components) == 4 {
config.Classifier = components[3]
}
return config, nil
}