-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
config.go
192 lines (164 loc) 路 5.41 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
package workspace
import (
"encoding/json"
"fmt"
"sort"
"strings"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource/config"
)
func formatMissingKeys(missingKeys []string) string {
if len(missingKeys) == 1 {
return fmt.Sprintf("'%v'", missingKeys[0])
}
sort.Strings(missingKeys)
formattedMissingKeys := ""
for index, key := range missingKeys {
// if last index, then use and before the key
if index == len(missingKeys)-1 {
formattedMissingKeys += fmt.Sprintf("and '%s'", key)
} else if index == len(missingKeys)-2 {
// no comma before the last key
formattedMissingKeys += fmt.Sprintf("'%s' ", key)
} else {
formattedMissingKeys += fmt.Sprintf("'%s', ", key)
}
}
return formattedMissingKeys
}
func missingStackConfigurationKeysError(missingKeys []string, stackName string) error {
valueOrValues := "value"
if len(missingKeys) > 1 {
valueOrValues = "values"
}
return fmt.Errorf(
"Stack '%v' is missing configuration %v %v",
stackName,
valueOrValues,
formatMissingKeys(missingKeys))
}
func missingProjectConfigurationKeysError(missingProjectKeys []string, stackName string) error {
valueOrValues := "value"
if len(missingProjectKeys) > 1 {
valueOrValues = "values"
}
isOrAre := "is"
if len(missingProjectKeys) > 1 {
isOrAre = "are"
}
return fmt.Errorf(
"Stack '%v' uses configuration %v %v which %v not defined by the project configuration",
stackName,
valueOrValues,
formatMissingKeys(missingProjectKeys),
isOrAre)
}
func ValidateStackConfigAndApplyProjectConfig(
stackName string,
project *Project,
stackConfig config.Map,
dec config.Decrypter) error {
if len(project.Config) > 0 {
// only when the project defines config values, do we need to validate the stack config
// for each stack config key, check if it is in the project config
stackConfigKeysNotDefinedByProject := []string{}
for key := range stackConfig {
namespacedKey := fmt.Sprintf("%s:%s", key.Namespace(), key.Name())
if key.Namespace() == string(project.Name) {
// then the namespace is implied and can be omitted
namespacedKey = key.Name()
}
if _, ok := project.Config[namespacedKey]; !ok {
stackConfigKeysNotDefinedByProject = append(stackConfigKeysNotDefinedByProject, namespacedKey)
}
}
if len(stackConfigKeysNotDefinedByProject) > 0 {
return missingProjectConfigurationKeysError(stackConfigKeysNotDefinedByProject, stackName)
}
}
missingConfigurationKeys := make([]string, 0)
for projectConfigKey, projectConfigType := range project.Config {
var key config.Key
if strings.Contains(projectConfigKey, ":") {
// key is already namespaced
parsedKey, parseError := config.ParseKey(projectConfigKey)
if parseError != nil {
return parseError
}
key = parsedKey
} else {
// key is not namespaced
// use the project as namespace
key = config.MustMakeKey(string(project.Name), projectConfigKey)
}
stackValue, found, err := stackConfig.Get(key, true)
if err != nil {
return fmt.Errorf("Error while getting stack config value for key '%v': %v", key.String(), err)
}
hasDefault := projectConfigType.Default != nil
if !found && !hasDefault {
// add it to the list to collect all missing configuration keys,
// then return them as a single error
missingConfigurationKeys = append(missingConfigurationKeys, projectConfigKey)
} else if !found && hasDefault {
// not found at the stack level
// but has a default value at the project level
// assign the value to the stack
var configValue config.Value
if projectConfigType.Type == "array" {
// for array types, JSON-ify the default value
configValueJSON, jsonError := json.Marshal(projectConfigType.Default)
if jsonError != nil {
return jsonError
}
configValue = config.NewObjectValue(string(configValueJSON))
} else {
// for primitive types
// pass the values as is
configValueContent := fmt.Sprintf("%v", projectConfigType.Default)
configValue = config.NewValue(configValueContent)
}
setError := stackConfig.Set(key, configValue, true)
if setError != nil {
return setError
}
} else {
// found value on the stack level
// retrieve it and validate it against
// the config defined at the project level
// First check if the project says this should be secret, and if so that the stack value is
// secure.
if projectConfigType.Secret && !stackValue.Secure() {
validationError := fmt.Errorf(
"Stack '%v' with configuration key '%v' must be encrypted as it's secret",
stackName,
projectConfigKey)
return validationError
}
jsonContent, err := stackValue.Value(dec)
if err != nil {
return err
}
// Content will be a JSON string, so marshal that back into an actual structure
var content interface{}
err = json.Unmarshal([]byte(jsonContent), &content)
if err != nil {
return err
}
if !ValidateConfigValue(projectConfigType.Type, projectConfigType.Items, content) {
typeName := InferFullTypeName(projectConfigType.Type, projectConfigType.Items)
validationError := fmt.Errorf(
"Stack '%v' with configuration key '%v' must be of type '%v'",
stackName,
projectConfigKey,
typeName)
return validationError
}
}
}
if len(missingConfigurationKeys) > 0 {
// there are missing configuration keys in the stack
// return them as a single error.
return missingStackConfigurationKeysError(missingConfigurationKeys, stackName)
}
return nil
}