-
Notifications
You must be signed in to change notification settings - Fork 36
/
parser.go
292 lines (251 loc) · 9.09 KB
/
parser.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
package manifest
import (
"bytes"
"fmt"
"github.com/hashicorp/go-version"
"gopkg.in/yaml.v3"
"github.com/cloudfoundry/cloud-service-broker/v2/internal/brokerpak/platform"
"github.com/cloudfoundry/cloud-service-broker/v2/internal/tfproviderfqn"
"github.com/cloudfoundry/cloud-service-broker/v2/pkg/validation"
)
// parser is used to parse the brokerpak manifest.
// In code, we should use the Manifest type
type parser struct {
PackVersion int `yaml:"packversion"`
Name string `yaml:"name"`
Version string `yaml:"version"`
Metadata map[string]string `yaml:"metadata"`
Platforms []platform.Platform `yaml:"platforms"`
TerraformResources []TerraformResource `yaml:"terraform_binaries"`
ServiceDefinitions []string `yaml:"service_definitions"`
Parameters []Parameter `yaml:"parameters"`
RequiredEnvVars []string `yaml:"required_env_variables"`
EnvConfigMapping map[string]string `yaml:"env_config_mapping"`
TerraformUpgradePath []TerraformUpgradePath `yaml:"terraform_upgrade_path,omitempty"`
TerraformStateProviderReplacements map[string]string `yaml:"terraform_state_provider_replacements,omitempty"`
}
const binaryName = "tofu"
func Parse(input []byte) (*Manifest, error) {
decoder := yaml.NewDecoder(bytes.NewReader(input))
decoder.KnownFields(true)
var receiver parser
if err := decoder.Decode(&receiver); err != nil {
return nil, fmt.Errorf("error parsing manifest: %w", err)
}
var result Manifest
result.PackVersion = receiver.PackVersion
result.Name = receiver.Name
result.Version = receiver.Version
result.Metadata = receiver.Metadata
result.Platforms = receiver.Platforms
result.ServiceDefinitions = receiver.ServiceDefinitions
result.Parameters = receiver.Parameters
result.RequiredEnvVars = receiver.RequiredEnvVars
result.EnvConfigMapping = receiver.EnvConfigMapping
result.TerraformStateProviderReplacements = receiver.TerraformStateProviderReplacements
steps := []func() *validation.FieldError{
func() (errs *validation.FieldError) {
return receiver.Validate()
},
func() (errs *validation.FieldError) {
result.TerraformUpgradePath, errs = parseTerraformUpgradePath(receiver)
return
},
func() (errs *validation.FieldError) {
result.TerraformVersions, result.TerraformProviders, result.Binaries, errs = parseTerraformResources(receiver)
return
},
}
var errs *validation.FieldError
for _, p := range steps {
errs = errs.Also(p())
}
if errs != nil {
return nil, fmt.Errorf("error validating manifest: %w", errs)
}
return &result, nil
}
func parseTerraformUpgradePath(p parser) (result []*version.Version, errs *validation.FieldError) {
availableTerraformVersions := make(map[string]bool)
for _, v := range p.TerraformResources {
if v.Name == binaryName {
availableTerraformVersions[v.Version] = v.Default
}
}
cur := version.Must(version.NewVersion("0.0.0"))
for i, v := range p.TerraformUpgradePath {
isDefault, available := availableTerraformVersions[v.Version]
ver, err := version.NewVersion(v.Version)
switch {
case err != nil:
errs = errs.Also(validation.ErrInvalidValue(v.Version, "version")).ViaFieldIndex("terraform_upgrade_path", i)
case !ver.GreaterThan(cur):
errs = errs.Also((&validation.FieldError{
Message: fmt.Sprintf("expect versions to be in ascending order: %q <= %q", v.Version, cur.String()),
Paths: []string{"version"},
}).ViaFieldIndex("terraform_upgrade_path", i))
case !available:
errs = errs.Also((&validation.FieldError{
Message: fmt.Sprintf("no corresponding terrafom resource for tofu version %q", v.Version),
Paths: []string{"version"},
}).ViaFieldIndex("terraform_upgrade_path", i))
case i == len(p.TerraformUpgradePath)-1 && !isDefault:
errs = errs.Also((&validation.FieldError{
Message: "upgrade path does not terminate at default version",
Paths: []string{"version"},
}).ViaFieldIndex("terraform_upgrade_path", i))
}
cur = ver
result = append(result, ver)
}
return result, errs
}
func parseTerraformResources(p parser) (versions []TerraformVersion, providers []TerraformProvider, binaries []Binary, errs *validation.FieldError) {
if len(p.TerraformResources) == 0 {
return nil, nil, nil, validation.ErrMissingField("terraform_binaries")
}
terraformVersionCache := make(map[string]struct{})
for i, r := range p.TerraformResources {
var (
ver *version.Version
providerFQN tfproviderfqn.TfProviderFQN
err error
)
errs = errs.Also(
validation.ErrIfBlank(r.Name, "name").ViaFieldIndex("terraform_binaries", i),
validation.ErrIfBlank(r.Version, "version").ViaFieldIndex("terraform_binaries", i),
)
if r.resourceType() == terraformProvider {
providerFQN, err = tfproviderfqn.New(r.Name, r.Provider)
if err != nil {
errs = errs.Also((&validation.FieldError{
Message: err.Error(),
Paths: []string{"provider"},
}).ViaFieldIndex("terraform_binaries", i))
}
}
if r.Default && r.resourceType() != terraformVersion {
errs = errs.Also((&validation.FieldError{
Message: "This field is only valid for `tofu`",
Paths: []string{"default"},
}).ViaFieldIndex("terraform_binaries", i))
}
ver, err = version.NewVersion(r.Version)
if err != nil && (r.resourceType() == terraformVersion || r.resourceType() == terraformProvider) {
errs = errs.Also((&validation.FieldError{
Message: err.Error(),
Paths: []string{"version"},
}).ViaFieldIndex("terraform_binaries", i))
}
if r.resourceType() == terraformVersion {
errs = errs.Also(validation.ErrIfDuplicate(r.Version, "version", terraformVersionCache))
}
switch r.resourceType() {
case terraformVersion:
versions = append(versions, TerraformVersion{
Version: ver,
Default: r.Default,
Source: r.Source,
URLTemplate: r.URLTemplate,
})
case terraformProvider:
providers = append(providers, TerraformProvider{
Name: r.Name,
Version: ver,
Source: r.Source,
Provider: providerFQN,
URLTemplate: r.URLTemplate,
})
case otherBinary:
binaries = append(binaries, Binary{
Name: r.Name,
Version: r.Version,
Source: r.Source,
URLTemplate: r.URLTemplate,
})
}
}
var defaultTerraformVersions []*version.Version
highestTerraformVersion := version.Must(version.NewVersion("0.0.0"))
for _, v := range versions {
if v.Default {
defaultTerraformVersions = append(defaultTerraformVersions, v.Version)
}
if v.Version != nil && v.Version.GreaterThan(highestTerraformVersion) {
highestTerraformVersion = v.Version
}
}
switch {
case len(versions) > 1 && len(defaultTerraformVersions) == 0:
errs = errs.Also(&validation.FieldError{
Message: "multiple Tofu versions, but none marked as default",
Paths: []string{"terraform_binaries"},
})
case len(versions) > 1 && len(defaultTerraformVersions) > 1:
errs = errs.Also(&validation.FieldError{
Message: "multiple Tofu versions, and multiple marked as default",
Paths: []string{"terraform_binaries"},
})
case len(defaultTerraformVersions) == 1 && !defaultTerraformVersions[0].Equal(highestTerraformVersion):
errs = errs.Also(&validation.FieldError{
Message: "default version of Tofu must be the highest version",
Paths: []string{"terraform_binaries"},
})
}
return versions, providers, binaries, errs
}
var _ validation.Validatable = (*parser)(nil)
func (m *parser) Validate() (errs *validation.FieldError) {
validators := []func() *validation.FieldError{
m.validatePackageVersion,
m.validateName,
m.validateVersion,
m.validatePlatforms,
m.validateServiceDefinitions,
m.validateParameters,
}
for _, v := range validators {
if err := v(); err != nil {
errs = errs.Also(err)
}
}
return errs
}
func (m *parser) validatePackageVersion() *validation.FieldError {
switch m.PackVersion {
case 0:
return validation.ErrMissingField("packversion")
case 1:
return nil
default:
return validation.ErrInvalidValue(m.PackVersion, "packversion")
}
}
func (m *parser) validateName() *validation.FieldError {
return validation.ErrIfBlank(m.Name, "name")
}
func (m *parser) validateVersion() *validation.FieldError {
return validation.ErrIfBlank(m.Version, "version")
}
func (m *parser) validatePlatforms() *validation.FieldError {
if len(m.Platforms) == 0 {
return validation.ErrMissingField("platforms")
}
var errs *validation.FieldError
for i, p := range m.Platforms {
errs = errs.Also(p.Validate().ViaFieldIndex("platforms", i))
}
return errs
}
func (m *parser) validateServiceDefinitions() *validation.FieldError {
if len(m.ServiceDefinitions) == 0 {
return validation.ErrMissingField("service_definitions")
}
return nil
}
func (m *parser) validateParameters() (errs *validation.FieldError) {
for i, parameter := range m.Parameters {
errs = errs.Also(parameter.Validate().ViaFieldIndex("parameters", i))
}
return errs
}