/
loaders.go
275 lines (230 loc) 路 6.83 KB
/
loaders.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
// Copyright 2016-2021, Pulumi Corporation.
//
// 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 workspace
import (
"fmt"
"os"
"strings"
"github.com/pulumi/pulumi/sdk/v3/go/common/encoding"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource/config"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
)
// readFileStripUTF8BOM wraps os.ReadFile and also strips the UTF-8 Byte-order Mark (BOM) if present.
func readFileStripUTF8BOM(path string) ([]byte, error) {
b, err := os.ReadFile(path)
if err != nil {
return nil, err
}
// Strip UTF-8 BOM bytes if present to avoid problems with downstream parsing.
// References:
// https://github.com/spkg/bom
// https://en.wikipedia.org/wiki/Byte_order_mark
if len(b) >= 3 &&
b[0] == 0xef &&
b[1] == 0xbb &&
b[2] == 0xbf {
b = b[3:]
}
return b, nil
}
// Rewrite config values to make them namespaced. Using the project name as the default namespace
// for example:
//
// config:
// instanceSize: t3.micro
//
// is valid configuration and will be rewritten in the form
//
// config:
// {projectName}:instanceSize:t3.micro
func stackConfigNamespacedWithProject(project *Project, projectStack map[string]interface{}) map[string]interface{} {
if project == nil {
// return the original config if we don't have a project
return projectStack
}
config, ok := projectStack["config"]
if ok {
configAsMap, isMap := config.(map[string]interface{})
if isMap {
modifiedConfig := make(map[string]interface{})
for key, value := range configAsMap {
if strings.Contains(key, ":") {
// key is already namespaced
// use it as is
modifiedConfig[key] = value
} else {
namespacedKey := fmt.Sprintf("%s:%s", project.Name, key)
modifiedConfig[namespacedKey] = value
}
}
projectStack["config"] = modifiedConfig
return projectStack
}
}
return projectStack
}
// LoadProject reads a project definition from a file.
func LoadProject(path string) (*Project, error) {
contract.Requiref(path != "", "path", "must not be empty")
marshaller, err := marshallerForPath(path)
if err != nil {
return nil, fmt.Errorf("can not read '%s': %w", path, err)
}
b, err := readFileStripUTF8BOM(path)
if err != nil {
return nil, fmt.Errorf("could not read '%s': %w", path, err)
}
return LoadProjectBytes(b, path, marshaller)
}
// LoadProjectBytes reads a project definition from a byte slice.
func LoadProjectBytes(b []byte, path string, marshaller encoding.Marshaler) (*Project, error) {
var raw interface{}
err := marshaller.Unmarshal(b, &raw)
if err != nil {
return nil, fmt.Errorf("could not unmarshal '%s': %w", path, err)
}
err = ValidateProject(raw)
if err != nil {
return nil, fmt.Errorf("could not validate '%s': %w", path, err)
}
// just before marshalling, we will rewrite the config values
projectDef, err := SimplifyMarshalledProject(raw)
if err != nil {
return nil, err
}
projectDef, rewriteError := RewriteConfigPathIntoStackConfigDir(projectDef)
if rewriteError != nil {
return nil, rewriteError
}
projectDef = RewriteShorthandConfigValues(projectDef)
modifiedProject, _ := marshaller.Marshal(projectDef)
var project Project
err = marshaller.Unmarshal(modifiedProject, &project)
if err != nil {
return nil, err
}
err = project.Validate()
if err != nil {
return nil, fmt.Errorf("could not unmarshal '%s': %w", path, err)
}
project.raw = b
return &project, nil
}
// LoadProjectStack reads a stack definition from a file.
func LoadProjectStack(project *Project, path string) (*ProjectStack, error) {
contract.Requiref(path != "", "path", "must not be empty")
marshaller, err := marshallerForPath(path)
if err != nil {
return nil, err
}
b, err := readFileStripUTF8BOM(path)
if os.IsNotExist(err) {
defaultProjectStack := ProjectStack{
Config: make(config.Map),
}
return &defaultProjectStack, nil
} else if err != nil {
return nil, err
}
return LoadProjectStackBytes(project, b, path, marshaller)
}
// LoadProjectStack reads a stack definition from a byte slice.
func LoadProjectStackBytes(
project *Project,
b []byte,
path string,
marshaller encoding.Marshaler,
) (*ProjectStack, error) {
var projectStackRaw interface{}
err := marshaller.Unmarshal(b, &projectStackRaw)
if err != nil {
return nil, err
}
if projectStackRaw == nil {
// for example when reading an empty stack file
defaultProjectStack := ProjectStack{
Config: make(config.Map),
}
return &defaultProjectStack, nil
}
simplifiedStackForm, err := SimplifyMarshalledProject(projectStackRaw)
if err != nil {
return nil, err
}
// rewrite config values to make them namespaced
// for example:
// config:
// instanceSize: t3.micro
//
// is valid configuration and will be rewritten in the form
//
// config:
// {projectName}:instanceSize: t3.micro
projectStackWithNamespacedConfig := stackConfigNamespacedWithProject(project, simplifiedStackForm)
modifiedProjectStack, _ := marshaller.Marshal(projectStackWithNamespacedConfig)
var projectStack ProjectStack
err = marshaller.Unmarshal(modifiedProjectStack, &projectStack)
if err != nil {
return nil, err
}
if projectStack.Config == nil {
projectStack.Config = make(config.Map)
}
projectStack.raw = b
return &projectStack, nil
}
// LoadPluginProject reads a plugin project definition from a file.
func LoadPluginProject(path string) (*PluginProject, error) {
contract.Requiref(path != "", "path", "must not be empty")
marshaller, err := marshallerForPath(path)
if err != nil {
return nil, err
}
b, err := readFileStripUTF8BOM(path)
if err != nil {
return nil, err
}
var pluginProject PluginProject
err = marshaller.Unmarshal(b, &pluginProject)
if err != nil {
return nil, err
}
err = pluginProject.Validate()
if err != nil {
return nil, err
}
return &pluginProject, nil
}
// LoadPolicyPack reads a policy pack definition from a file.
func LoadPolicyPack(path string) (*PolicyPackProject, error) {
contract.Requiref(path != "", "path", "must not be empty")
marshaller, err := marshallerForPath(path)
if err != nil {
return nil, err
}
b, err := readFileStripUTF8BOM(path)
if err != nil {
return nil, err
}
var policyPackProject PolicyPackProject
err = marshaller.Unmarshal(b, &policyPackProject)
if err != nil {
return nil, err
}
err = policyPackProject.Validate()
if err != nil {
return nil, err
}
return &policyPackProject, nil
}