-
Notifications
You must be signed in to change notification settings - Fork 42
Expand file tree
/
Copy pathcache_test.go
More file actions
288 lines (256 loc) · 6.37 KB
/
cache_test.go
File metadata and controls
288 lines (256 loc) · 6.37 KB
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
package cache
import (
"errors"
"os"
"path/filepath"
"testing"
"github.com/google/go-cmp/cmp"
"github.com/google/uuid"
"github.com/stackitcloud/stackit-cli/internal/pkg/auth"
)
func overwriteCacheDir(t *testing.T) func() {
cacheDirOverwrite = t.TempDir()
return func() {
cacheDirOverwrite = ""
}
}
func TestGetObjectErrors(t *testing.T) {
defer overwriteCacheDir(t)()
if err := Init(); err != nil {
t.Fatalf("cache init failed: %s", err)
}
tests := []struct {
description string
identifier string
expectedErr error
}{
{
description: "identifier does not exist",
identifier: "test-cache-get-not-exists",
expectedErr: os.ErrNotExist,
},
{
description: "identifier is invalid",
identifier: "in../../valid",
expectedErr: ErrorInvalidCacheIdentifier,
},
}
for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
id := tt.identifier + "-" + uuid.NewString()
// test
file, err := GetObject(id)
if !errors.Is(err, tt.expectedErr) {
t.Fatalf("returned error (%q) does not match %q", err.Error(), tt.expectedErr.Error())
}
if len(file) > 0 {
t.Fatalf("didn't expect a file, but byte array is not empty (len %d)", len(file))
}
})
}
}
func TestPutObject(t *testing.T) {
defer overwriteCacheDir(t)()
if err := Init(); err != nil {
t.Fatalf("cache init failed: %s", err)
}
tests := []struct {
description string
identifier string
existingFile bool
expectFile bool
expectedErr error
customPath string
}{
{
description: "identifier already exists",
identifier: "test-cache-put-exists",
existingFile: true,
expectFile: true,
expectedErr: nil,
},
{
description: "identifier does not exist",
identifier: "test-cache-put-not-exists",
expectFile: true,
expectedErr: nil,
},
{
description: "identifier is invalid",
identifier: "in../../valid",
expectFile: false,
expectedErr: ErrorInvalidCacheIdentifier,
},
{
description: "directory does not yet exist",
identifier: "test-cache-put-folder-not-exists",
expectFile: true,
expectedErr: nil,
customPath: "/tmp/stackit-cli-test",
},
}
for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
id := tt.identifier + "-" + uuid.NewString()
if tt.customPath != "" {
cacheFolderPath = tt.customPath
} else {
cacheDir, _ := os.UserCacheDir()
cacheFolderPath = filepath.Join(cacheDir, "stackit")
}
path := filepath.Join(cacheFolderPath, id)
// setup
if tt.existingFile {
err := os.MkdirAll(cacheFolderPath, 0o750)
if err != nil {
t.Fatalf("create cache folder: %s", err.Error())
}
if err := os.WriteFile(path, []byte("dummy"), 0o600); err != nil {
t.Fatalf("setup: WriteFile (%s) failed", path)
}
}
// test
err := PutObject(id, []byte("dummy"))
if !errors.Is(err, tt.expectedErr) {
t.Fatalf("returned error (%q) does not match %q", err.Error(), tt.expectedErr.Error())
}
if tt.expectFile {
if _, err := os.Stat(path); errors.Is(err, os.ErrNotExist) {
t.Fatalf("expected file (%q) to exist", path)
}
}
})
}
}
func TestDeleteObject(t *testing.T) {
defer overwriteCacheDir(t)()
if err := Init(); err != nil {
t.Fatalf("cache init failed: %s", err)
}
tests := []struct {
description string
identifier string
existingFile bool
expectedErr error
}{
{
description: "identifier exists",
identifier: "test-cache-delete-exists",
existingFile: true,
expectedErr: nil,
},
{
description: "identifier does not exist",
identifier: "test-cache-delete-not-exists",
existingFile: false,
expectedErr: nil,
},
{
description: "identifier is invalid",
identifier: "in../../valid",
existingFile: false,
expectedErr: ErrorInvalidCacheIdentifier,
},
}
for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
id := tt.identifier + "-" + uuid.NewString()
path := filepath.Join(cacheFolderPath, id)
// setup
if tt.existingFile {
if err := os.MkdirAll(cacheFolderPath, 0o700); err != nil {
t.Fatalf("setup: MkdirAll (%s) failed: %v", path, err)
}
if err := os.WriteFile(path, []byte("dummy"), 0o600); err != nil {
t.Fatalf("setup: WriteFile (%s) failed: %v", path, err)
}
}
// test
err := DeleteObject(id)
if !errors.Is(err, tt.expectedErr) {
t.Fatalf("returned error (%q) does not match %q", err.Error(), tt.expectedErr.Error())
}
if tt.existingFile {
if _, err := os.Stat(path); !errors.Is(err, os.ErrNotExist) {
t.Fatalf("expected file (%q) to not exist", path)
}
}
})
}
}
func clearKeys(t *testing.T) {
t.Helper()
err := auth.DeleteAuthField(auth.CACHE_ENCRYPTION_KEY)
if err != nil {
t.Fatalf("delete cache encryption key: %v", err)
}
err = auth.DeleteAuthField(auth.CACHE_ENCRYPTION_KEY_AGE)
if err != nil {
t.Fatalf("delete cache encryption key age: %v", err)
}
}
func TestWriteAndRead(t *testing.T) {
for _, tt := range []struct {
name string
clearKeys bool
}{
{
name: "normal",
},
{
name: "fresh keys",
clearKeys: true,
},
} {
t.Run(tt.name, func(t *testing.T) {
defer overwriteCacheDir(t)()
if tt.clearKeys {
clearKeys(t)
}
if err := Init(); err != nil {
t.Fatalf("cache init failed: %s", err)
}
id := "test-cycle-" + uuid.NewString()
data := []byte("test-data")
err := PutObject(id, data)
if err != nil {
t.Fatalf("putobject failed: %v", err)
}
readData, err := GetObject(id)
if err != nil {
t.Fatalf("getobject failed: %v", err)
}
diff := cmp.Diff(data, readData)
if diff != "" {
t.Fatalf("unexpected data diff: %v", diff)
}
})
}
}
func TestCacheCleanup(t *testing.T) {
defer overwriteCacheDir(t)()
if err := Init(); err != nil {
t.Fatalf("cache init failed: %s", err)
}
id := "test-cycle-" + uuid.NewString()
data := []byte("test-data")
err := PutObject(id, data)
if err != nil {
t.Fatalf("putobject failed: %v", err)
}
clearKeys(t)
// initialize again to trigger cache cleanup
if err := Init(); err != nil {
t.Fatalf("cache init failed: %s", err)
}
_, err = GetObject(id)
if !errors.Is(err, os.ErrNotExist) {
t.Fatalf("getobject failed with unexpected error: %v", err)
}
}
func TestInit(t *testing.T) {
// test that init without cache directory overwrite works
if err := Init(); err != nil {
t.Fatalf("cache init failed: %s", err)
}
}