forked from gotestyourself/gotest.tools
/
golden_test.go
296 lines (225 loc) · 6.61 KB
/
golden_test.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
package golden
import (
"io/ioutil"
"os"
"path/filepath"
"testing"
"gotest.tools/v3/assert"
"gotest.tools/v3/assert/cmp"
"gotest.tools/v3/fs"
"gotest.tools/v3/internal/source"
)
type fakeT struct {
Failed bool
}
func (t *fakeT) Log(...interface{}) {
}
func (t *fakeT) FailNow() {
t.Failed = true
}
func (t *fakeT) Fail() {
t.Failed = true
}
func (t *fakeT) Helper() {}
func TestGoldenOpenInvalidFile(t *testing.T) {
fakeT := new(fakeT)
Open(fakeT, "/invalid/path")
assert.Assert(t, fakeT.Failed)
}
func TestGoldenOpenAbsolutePath(t *testing.T) {
file := fs.NewFile(t, "abs-test", fs.WithContent("content\n"))
defer file.Remove()
fakeT := new(fakeT)
f := Open(fakeT, file.Path())
assert.Assert(t, !fakeT.Failed)
f.Close()
}
func TestGoldenOpen(t *testing.T) {
filename, clean := setupGoldenFile(t, "")
defer clean()
fakeT := new(fakeT)
f := Open(fakeT, filename)
assert.Assert(t, !fakeT.Failed)
f.Close()
}
func TestGoldenGetInvalidFile(t *testing.T) {
fakeT := new(fakeT)
Get(fakeT, "/invalid/path")
assert.Assert(t, fakeT.Failed)
}
func TestGoldenGetAbsolutePath(t *testing.T) {
file := fs.NewFile(t, "abs-test", fs.WithContent("content\n"))
defer file.Remove()
fakeT := new(fakeT)
Get(fakeT, file.Path())
assert.Assert(t, !fakeT.Failed)
}
func TestGoldenGet(t *testing.T) {
expected := "content\nline1\nline2"
filename, clean := setupGoldenFile(t, expected)
defer clean()
fakeT := new(fakeT)
actual := Get(fakeT, filename)
assert.Assert(t, !fakeT.Failed)
assert.Assert(t, cmp.DeepEqual(actual, []byte(expected)))
}
func TestGoldenAssertInvalidContent(t *testing.T) {
filename, clean := setupGoldenFile(t, "content")
defer clean()
fakeT := new(fakeT)
Assert(fakeT, "foo", filename)
assert.Assert(t, fakeT.Failed)
}
func TestGoldenAssertInvalidContentUpdate(t *testing.T) {
setUpdateFlag(t)
filename, clean := setupGoldenFile(t, "content")
defer clean()
fakeT := new(fakeT)
Assert(fakeT, "foo", filename)
assert.Assert(t, !fakeT.Failed)
}
func TestGoldenAssertAbsolutePath(t *testing.T) {
file := fs.NewFile(t, "abs-test", fs.WithContent("foo"))
defer file.Remove()
fakeT := new(fakeT)
Assert(fakeT, "foo", file.Path())
assert.Assert(t, !fakeT.Failed)
}
func TestGoldenAssertInDir(t *testing.T) {
filename, clean := setupGoldenFileWithDir(t, "testdatasubdir", "foo")
defer clean()
fakeT := new(fakeT)
Assert(fakeT, "foo", filepath.Join("testdatasubdir", filename))
assert.Assert(t, !fakeT.Failed)
_, err := os.Stat("testdatasubdir")
assert.Assert(t, os.IsNotExist(err), "testdatasubdir should not exist outside of testdata")
}
func TestGoldenAssertInDir_UpdateGolden(t *testing.T) {
filename, clean := setupGoldenFileWithDir(t, "testdatasubdir", "foo")
defer clean()
setUpdateFlag(t)
fakeT := new(fakeT)
Assert(fakeT, "foo", filepath.Join("testdatasubdir", filename))
assert.Assert(t, !fakeT.Failed)
_, err := os.Stat("testdatasubdir")
assert.Assert(t, os.IsNotExist(err), "testdatasubdir should not exist outside of testdata")
}
func TestGoldenAssert(t *testing.T) {
filename, clean := setupGoldenFile(t, "foo")
defer clean()
fakeT := new(fakeT)
Assert(fakeT, "foo", filename)
assert.Assert(t, !fakeT.Failed)
}
func TestAssert_WithCarriageReturnInActual(t *testing.T) {
filename, clean := setupGoldenFile(t, "a\rfoo\nbar\n")
defer clean()
fakeT := new(fakeT)
Assert(fakeT, "a\rfoo\r\nbar\r\n", filename)
assert.Assert(t, !fakeT.Failed)
}
func TestAssert_WithCarriageReturnInActual_UpdateGolden(t *testing.T) {
filename, clean := setupGoldenFile(t, "")
defer clean()
unsetUpdateFlag := setUpdateFlag(t)
fakeT := new(fakeT)
Assert(fakeT, "a\rfoo\r\nbar\r\n", filename)
assert.Assert(t, !fakeT.Failed)
unsetUpdateFlag()
actual := Get(fakeT, filename)
assert.Equal(t, string(actual), "a\rfoo\nbar\n")
Assert(t, "a\rfoo\r\nbar\r\n", filename, "matches with carriage returns")
Assert(t, "a\rfoo\nbar\n", filename, "matches without carriage returns")
}
func TestGoldenAssertBytes(t *testing.T) {
filename, clean := setupGoldenFile(t, "foo")
defer clean()
fakeT := new(fakeT)
AssertBytes(fakeT, []byte("foo"), filename)
assert.Assert(t, !fakeT.Failed)
}
func setUpdateFlag(t *testing.T) func() {
orig := source.Update
source.Update = true
undo := func() {
source.Update = orig
}
t.Cleanup(undo)
return undo
}
func setupGoldenFileWithDir(t *testing.T, dirname, content string) (string, func()) {
dirpath := filepath.Join("testdata", dirname)
_ = os.MkdirAll(filepath.Join("testdata", dirname), 0755)
f, err := ioutil.TempFile(dirpath, t.Name()+"-")
assert.NilError(t, err, "fail to create test golden file")
defer f.Close()
_, err = f.Write([]byte(content))
assert.NilError(t, err)
return filepath.Base(f.Name()), func() {
assert.NilError(t, os.Remove(f.Name()))
assert.NilError(t, os.Remove(dirpath))
}
}
func setupGoldenFile(t *testing.T, content string) (string, func()) {
_ = os.Mkdir("testdata", 0755)
f, err := ioutil.TempFile("testdata", t.Name()+"-")
assert.NilError(t, err, "fail to create test golden file")
defer f.Close()
_, err = f.Write([]byte(content))
assert.NilError(t, err)
return filepath.Base(f.Name()), func() {
assert.NilError(t, os.Remove(f.Name()))
}
}
func TestStringFailure(t *testing.T) {
filename, clean := setupGoldenFile(t, "this is\nthe text")
defer clean()
result := String("this is\nnot the text", filename)()
assert.Assert(t, !result.Success())
assert.Equal(t, result.(failure).FailureMessage(), `
--- expected
+++ actual
@@ -1,2 +1,2 @@
this is
-the text
+not the text
`+failurePostamble(filename))
}
type failure interface {
FailureMessage() string
}
func TestBytesFailure(t *testing.T) {
filename, clean := setupGoldenFile(t, "5556")
defer clean()
result := Bytes([]byte("5555"), filename)()
assert.Assert(t, !result.Success())
assert.Equal(t, result.(failure).FailureMessage(),
`[53 53 53 53] (actual) != [53 53 53 54] (expected)`+failurePostamble(filename))
}
func TestFlagUpdate(t *testing.T) {
assert.Assert(t, !FlagUpdate())
setUpdateFlag(t)
assert.Assert(t, FlagUpdate())
}
func TestUpdate_CreatesPathsAndFile(t *testing.T) {
setUpdateFlag(t)
dir := fs.NewDir(t, t.Name())
t.Run("creates the file", func(t *testing.T) {
filename := dir.Join("filename")
err := update(filename, nil)
assert.NilError(t, err)
_, err = os.Stat(filename)
assert.NilError(t, err)
})
t.Run("creates directories", func(t *testing.T) {
filename := dir.Join("one/two/filename")
err := update(filename, nil)
assert.NilError(t, err)
_, err = os.Stat(filename)
assert.NilError(t, err)
t.Run("no error when directory exists", func(t *testing.T) {
err = update(filename, nil)
assert.NilError(t, err)
})
})
}