-
Notifications
You must be signed in to change notification settings - Fork 445
/
golden.go
158 lines (137 loc) · 4.25 KB
/
golden.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
/**
* Copyright 2022 Google LLC
*
* 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 assertd 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 golden helps manage goldenfiles.
package golden
import (
"fmt"
"os"
"path"
"strings"
"github.com/GoogleCloudPlatform/cloud-foundation-toolkit/infra/blueprint-test/pkg/gcloud"
"github.com/GoogleCloudPlatform/cloud-foundation-toolkit/infra/blueprint-test/pkg/utils"
"github.com/mitchellh/go-testing-interface"
"github.com/stretchr/testify/assert"
"github.com/tidwall/gjson"
)
const (
gfDir = "testdata"
gfPerms = 0755
gfUpdateEnvVar = "UPDATE_GOLDEN"
)
type GoldenFile struct {
dir string
fileName string
sanitizers []Sanitizer
t testing.TB
}
type Sanitizer func(string) string
// StringSanitizer replaces all occurrences of old string with new string
func StringSanitizer(old, new string) Sanitizer {
return func(s string) string {
return strings.ReplaceAll(s, old, new)
}
}
// ProjectIDSanitizer replaces all occurrences of current gcloud project ID with PROJECT_ID string
func ProjectIDSanitizer(t testing.TB) Sanitizer {
return func(s string) string {
projectID := gcloud.Run(t, "config get-value project")
if projectID.String() == "[]" {
t.Logf("no project ID currently set, skipping ProjectIDSanitizer: %s", projectID.String())
return s
}
return strings.ReplaceAll(s, projectID.String(), "PROJECT_ID")
}
}
type goldenFileOption func(*GoldenFile)
func WithDir(dir string) goldenFileOption {
return func(g *GoldenFile) {
g.dir = dir
}
}
func WithFileName(fn string) goldenFileOption {
return func(g *GoldenFile) {
g.fileName = fn
}
}
func WithSanitizer(s Sanitizer) goldenFileOption {
return func(g *GoldenFile) {
g.sanitizers = append(g.sanitizers, s)
}
}
func WithStringSanitizer(old, new string) goldenFileOption {
return func(g *GoldenFile) {
g.sanitizers = append(g.sanitizers, StringSanitizer(old, new))
}
}
func NewOrUpdate(t testing.TB, data string, opts ...goldenFileOption) *GoldenFile {
g := &GoldenFile{
dir: gfDir,
fileName: fmt.Sprintf("%s.json", strings.ReplaceAll(t.Name(), "/", "-")),
sanitizers: []Sanitizer{ProjectIDSanitizer(t)},
t: t,
}
for _, opt := range opts {
opt(g)
}
g.update(data)
return g
}
// update updates goldenfile data iff gfUpdateEnvVar is true
func (g *GoldenFile) update(data string) {
// exit early if gfUpdateEnvVar is not set or true
if strings.ToLower(os.Getenv(gfUpdateEnvVar)) != "true" {
return
}
fp := g.GetName()
err := os.MkdirAll(path.Dir(fp), gfPerms)
if err != nil {
g.t.Fatalf("error updating result: %v", err)
}
// apply sanitizers on data
data = g.ApplySanitizers(data)
err = os.WriteFile(fp, []byte(data), gfPerms)
if err != nil {
g.t.Fatalf("error updating result: %v", err)
}
}
// GetName return path of the goldenfile
func (g *GoldenFile) GetName() string {
return path.Join(g.dir, g.fileName)
}
// ApplySanitizers returns sanitized string
func (g *GoldenFile) ApplySanitizers(s string) string {
for _, sanitizer := range g.sanitizers {
s = sanitizer(s)
}
return s
}
// GetSanitizedJSON returns sanitizes and returns JSON result
func (g *GoldenFile) GetSanitizedJSON(s gjson.Result) gjson.Result {
resultStr := s.String()
resultStr = g.ApplySanitizers(resultStr)
return utils.ParseJSONResult(g.t, resultStr)
}
// GetJSON returns goldenfile as parsed json
func (g *GoldenFile) GetJSON() gjson.Result {
return utils.LoadJSON(g.t, g.GetName())
}
// JSONEq asserts that json content in jsonPath for got and goldenfile is the same
func (g *GoldenFile) JSONEq(a *assert.Assertions, got gjson.Result, jsonPath string) {
gf := g.GetJSON()
gotData := g.ApplySanitizers(got.Get(jsonPath).String())
gfData := gf.Get(jsonPath).String()
a.Equal(gfData, gotData, fmt.Sprintf("expected %s to match fixture %s", jsonPath, gfData))
}