-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
helpers.go
379 lines (323 loc) 路 9.26 KB
/
helpers.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
// 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 test
import (
"bytes"
"encoding/json"
"fmt"
"io"
"os"
"path/filepath"
"sort"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gopkg.in/yaml.v3"
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
"github.com/pulumi/pulumi/pkg/v3/codegen/testing/utils"
"github.com/pulumi/pulumi/pkg/v3/testing/integration"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/executable"
)
// GenPkgSignature corresponds to the shape of the codegen GeneratePackage functions.
type GenPkgSignature func(string, *schema.Package, map[string][]byte) (map[string][]byte, error)
// GeneratePackageFilesFromSchema loads a schema and generates files using the provided GeneratePackage function.
func GeneratePackageFilesFromSchema(schemaPath string, genPackageFunc GenPkgSignature) (map[string][]byte, error) {
// Read in, decode, and import the schema.
schemaBytes, err := os.ReadFile(schemaPath)
if err != nil {
return nil, err
}
ext := filepath.Ext(schemaPath)
var pkgSpec schema.PackageSpec
if ext == ".yaml" || ext == ".yml" {
err = yaml.Unmarshal(schemaBytes, &pkgSpec)
} else {
err = json.Unmarshal(schemaBytes, &pkgSpec)
}
if err != nil {
return nil, err
}
loader := schema.NewPluginLoader(utils.NewHost(testdataPath))
pkg, diags, err := schema.BindSpec(pkgSpec, loader)
if err != nil {
return nil, err
} else if diags.HasErrors() {
return nil, diags
}
return genPackageFunc("test", pkg, nil)
}
// LoadFiles loads the provided list of files from a directory.
func LoadFiles(dir, lang string, files []string) (map[string][]byte, error) {
result := map[string][]byte{}
for _, file := range files {
fileBytes, err := os.ReadFile(filepath.Join(dir, lang, file))
if err != nil {
return nil, err
}
result[file] = fileBytes
}
return result, nil
}
func PathExists(path string) (bool, error) {
_, err := os.Stat(path)
if os.IsNotExist(err) {
return false, nil
}
if err == nil {
return true, nil
}
return false, err
}
// `LoadBaseline` loads the contents of the given baseline directory,
// by inspecting its `codegen-manifest.json`.
func LoadBaseline(dir, lang string) (map[string][]byte, error) {
cm := &codegenManifest{}
err := cm.load(filepath.Join(dir, lang))
if err != nil {
return nil, fmt.Errorf("Failed to load codegen-manifest.json: %w", err)
}
files := make(map[string][]byte)
for _, f := range cm.EmittedFiles {
bytes, err := os.ReadFile(filepath.Join(dir, lang, f))
if err != nil {
return nil, fmt.Errorf("Failed to load file %s referenced in codegen-manifest.json: %w", f, err)
}
files[f] = bytes
}
return files, nil
}
type codegenManifest struct {
EmittedFiles []string `json:"emittedFiles"`
}
func (cm *codegenManifest) load(dir string) error {
bytes, err := os.ReadFile(filepath.Join(dir, "codegen-manifest.json"))
if err != nil {
return err
}
return json.Unmarshal(bytes, cm)
}
func (cm *codegenManifest) save(dir string) error {
sort.Strings(cm.EmittedFiles)
buf := &bytes.Buffer{}
enc := json.NewEncoder(buf)
enc.SetEscapeHTML(false)
enc.SetIndent("", " ")
err := enc.Encode(cm)
if err != nil {
return err
}
data := buf.Bytes()
return os.WriteFile(filepath.Join(dir, "codegen-manifest.json"), data, 0o600)
}
// ValidateFileEquality compares maps of files for equality.
func ValidateFileEquality(t *testing.T, actual, expected map[string][]byte) bool {
ok := true
for name, file := range expected {
_, inActual := actual[name]
if inActual {
if !assert.Equal(t, string(file), string(actual[name]), name) {
t.Logf("%s did not agree", name)
ok = false
}
} else {
t.Logf("File %s was expected but is missing from the actual fileset", name)
ok = false
}
}
for name := range actual {
if _, inExpected := expected[name]; !inExpected {
t.Logf("File %s from the actual fileset was not expected", name)
ok = false
}
}
return ok
}
// If PULUMI_ACCEPT is set, writes out actual output to the expected
// file set, so we can continue enjoying golden tests without manually
// modifying the expected output.
func RewriteFilesWhenPulumiAccept(t *testing.T, dir, lang string, actual map[string][]byte) bool {
if os.Getenv("PULUMI_ACCEPT") == "" {
return false
}
cm := &codegenManifest{}
baseline := filepath.Join(dir, lang)
// Remove the baseline directory's current contents.
_, err := os.ReadDir(baseline)
switch {
case err == nil:
err = os.RemoveAll(baseline)
require.NoError(t, err)
case os.IsNotExist(err):
// OK
default:
require.NoError(t, err)
}
for file, bytes := range actual {
relPath := filepath.FromSlash(file)
path := filepath.Join(dir, lang, relPath)
cm.EmittedFiles = append(cm.EmittedFiles, relPath)
err := writeFileEnsuringDir(path, bytes)
require.NoError(t, err)
}
err = cm.save(filepath.Join(dir, lang))
require.NoError(t, err)
return true
}
// Useful for populating code-generated destination
// `codeDir=$dir/$lang` with extra manually written files such as the
// unit test files. These files are copied from `$dir/$lang-extras`
// folder if present.
func CopyExtraFiles(t *testing.T, dir, lang string) {
codeDir := filepath.Join(dir, lang)
extrasDir := filepath.Join(dir, lang+"-extras")
gotExtras, err := PathExists(extrasDir)
if !gotExtras {
return
}
if err != nil {
require.NoError(t, err)
return
}
err = filepath.Walk(extrasDir, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if info.IsDir() {
return nil
}
relPath, err := filepath.Rel(extrasDir, path)
if err != nil {
return err
}
destPath := filepath.Join(codeDir, relPath)
bytes, err := os.ReadFile(path)
if err != nil {
return err
}
err = writeFileEnsuringDir(destPath, bytes)
if err != nil {
return err
}
t.Logf("Copied %s to %s", path, destPath)
return nil
})
require.NoError(t, err)
}
func writeFileEnsuringDir(path string, bytes []byte) error {
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil && !os.IsExist(err) {
return err
}
return os.WriteFile(path, bytes, 0o600)
}
// CheckAllFilesGenerated ensures that the set of expected and actual files generated
// are exactly equivalent.
func CheckAllFilesGenerated(t *testing.T, actual, expected map[string][]byte) {
seen := map[string]bool{}
for x := range expected {
seen[x] = true
}
for a := range actual {
assert.Contains(t, seen, a, "Unexpected file generated: %s", a)
if seen[a] {
delete(seen, a)
}
}
for s := range seen {
assert.Fail(t, "No content generated for expected file %s", s)
}
}
// Validates a transformer on a single file.
func ValidateFileTransformer(
t *testing.T,
inputFile string,
expectedOutputFile string,
transformer func(reader io.Reader, writer io.Writer) error,
) {
reader, err := os.Open(inputFile)
if err != nil {
t.Error(err)
return
}
var buf bytes.Buffer
err = transformer(reader, &buf)
if err != nil {
t.Error(err)
return
}
actualBytes := buf.Bytes()
if os.Getenv("PULUMI_ACCEPT") != "" {
err := os.WriteFile(expectedOutputFile, actualBytes, 0o600)
if err != nil {
t.Error(err)
return
}
}
actual := map[string][]byte{expectedOutputFile: actualBytes}
expectedBytes, err := os.ReadFile(expectedOutputFile)
if err != nil {
t.Error(err)
return
}
expected := map[string][]byte{expectedOutputFile: expectedBytes}
ValidateFileEquality(t, actual, expected)
}
func RunCommand(t *testing.T, name string, cwd string, exec string, args ...string) {
RunCommandWithOptions(t, &integration.ProgramTestOptions{}, name, cwd, exec, args...)
}
func RunCommandWithOptions(
t *testing.T,
opts *integration.ProgramTestOptions,
name string, cwd string, exec string, args ...string,
) {
exec, err := executable.FindExecutable(exec)
if err != nil {
t.Error(err)
t.FailNow()
}
wd, err := filepath.Abs(cwd)
require.NoError(t, err)
var stdout, stderr bytes.Buffer
opts.Stdout = &stdout
opts.Stderr = &stderr
opts.Verbose = true
err = integration.RunCommand(t,
name,
append([]string{exec}, args...),
wd,
opts)
if !assert.NoError(t, err) {
stdout := stdout.String()
stderr := stderr.String()
if len(stdout) > 0 {
t.Logf("stdout: %s", stdout)
}
if len(stderr) > 0 {
t.Logf("stderr: %s", stderr)
}
t.FailNow()
}
}
type SchemaVersion = string
// Schemas are downloaded in the makefile, and the versions specified here
// should be in sync with the makefile.
const (
AwsSchema SchemaVersion = "4.26.0"
AzureNativeSchema SchemaVersion = "1.29.0"
AzureSchema SchemaVersion = "4.18.0"
KubernetesSchema SchemaVersion = "3.7.2"
RandomSchema SchemaVersion = "4.11.2"
EksSchema SchemaVersion = "0.37.1"
)
// PulumiDotnetSDKVersion is the version of the Pulumi .NET SDK to use in program-gen tests
const PulumiDotnetSDKVersion = "3.59.0"