File: hasher_test.go

package info (click to toggle)
golang-k8s-sigs-kustomize-api 0.20.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,768 kB
  • sloc: makefile: 206; sh: 67
file content (357 lines) | stat: -rw-r--r-- 8,047 bytes parent folder | download | duplicates (2)
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
// Copyright 2019 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0

package hasher

import (
	"strings"
	"testing"

	"sigs.k8s.io/kustomize/kyaml/yaml"
)

func TestSortArrayAndComputeHash(t *testing.T) {
	array1 := []string{"a", "b", "c", "d"}
	array2 := []string{"c", "b", "d", "a"}
	h1, err := SortArrayAndComputeHash(array1)
	if err != nil {
		t.Errorf("unexpected error %v", err)
	}
	if h1 == "" {
		t.Errorf("failed to hash %v", array1)
	}
	h2, err := SortArrayAndComputeHash(array2)
	if err != nil {
		t.Errorf("unexpected error %v", err)
	}
	if h2 == "" {
		t.Errorf("failed to hash %v", array2)
	}
	if h1 != h2 {
		t.Errorf("hash is not consistent with reordered list: %s %s", h1, h2)
	}
}

func Test_hex256(t *testing.T) {
	// hash the empty string to be sure that sha256 is being used
	expect := "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
	sum := hex256("")
	if expect != sum {
		t.Errorf("expected hash %q but got %q", expect, sum)
	}
}

func TestConfigMapHash(t *testing.T) {
	cases := []struct {
		desc   string
		cmYaml string
		hash   string
		err    string
	}{
		// empty map
		{"empty data", `
apiVersion: v1
kind: ConfigMap`, "6ct58987ht", ""},
		// one key
		{"one key", `
apiVersion: v1
kind: ConfigMap
data:
  one: ""`, "9g67k2htb6", ""},
		// three keys (tests sorting order)
		{"three keys", `
apiVersion: v1
kind: ConfigMap
data:
  two: 2
  one: ""
  three: 3`, "7757f9kkct", ""},
		// empty binary data map
		{"empty binary data", `
apiVersion: v1
kind: ConfigMap`, "6ct58987ht", ""},
		// one key with binary data
		{"one key with binary data", `
apiVersion: v1
kind: ConfigMap
binaryData:
  one: ""`, "6mtk2m274t", ""},
		// three keys with binary data (tests sorting order)
		{"three keys with binary data", `
apiVersion: v1
kind: ConfigMap
binaryData:
  two: 2
  one: ""
  three: 3`, "9th7kc28dg", ""},
		// two keys, one with string and another with binary data
		{"two keys with one each", `
apiVersion: v1
kind: ConfigMap
data:
  one: ""
binaryData:
  two: ""`, "698h7c7t9m", ""},
	}
	h := &Hasher{}
	for _, c := range cases {
		node, err := yaml.Parse(c.cmYaml)
		if err != nil {
			t.Fatal(err)
		}
		hashed, err := h.Hash(node)
		if SkipRest(t, c.desc, err, c.err) {
			continue
		}
		if c.hash != hashed {
			t.Errorf("case %q, expect hash %q but got %q", c.desc, c.hash, h)
		}
	}
}

func TestSecretHash(t *testing.T) {
	cases := []struct {
		desc       string
		secretYaml string
		hash       string
		err        string
	}{
		// empty map
		{"empty data", `
apiVersion: v1
kind: Secret
type: my-type`, "5gmgkf8578", ""},
		// one key
		{"one key", `
apiVersion: v1
kind: Secret
type: my-type
data:
  one: ""`, "74bd68bm66", ""},
		// three keys (tests sorting order)
		{"three keys", `
apiVersion: v1
kind: Secret
type: my-type
data:
  two: 2
  one: ""
  three: 3`, "4gf75c7476", ""},
		// with stringdata
		{"stringdata", `
apiVersion: v1
kind: Secret
type: my-type
data:
  one: ""
stringData:
  two: 2`, "c4h4264gdb", ""},
		// empty stringdata
		{"empty stringdata", `
apiVersion: v1
kind: Secret
type: my-type
data:
  one: ""`, "74bd68bm66", ""},
	}
	h := &Hasher{}
	for _, c := range cases {
		node, err := yaml.Parse(c.secretYaml)
		if err != nil {
			t.Fatal(err)
		}
		hashed, err := h.Hash(node)
		if SkipRest(t, c.desc, err, c.err) {
			continue
		}
		if c.hash != hashed {
			t.Errorf("case %q, expect hash %q but got %q", c.desc, c.hash, h)
		}
	}
}

func TestBasicHash(t *testing.T) {
	cases := map[string]struct {
		res  string
		hash string
		err  string
	}{
		"minimal": {`
apiVersion: test/v1
kind: TestResource
metadata:
  name: my-resource`, "244782mkb7", ""},
		"with spec": {`
apiVersion: test/v1
kind: TestResource
metadata:
  name: my-resource
spec:
  foo: 1
  bar: abc`, "59m2mdccg4", ""},
	}
	h := &Hasher{}
	for n := range cases {
		c := cases[n]
		t.Run(n, func(t *testing.T) {
			node, err := yaml.Parse(c.res)
			if err != nil {
				t.Fatal(err)
			}
			hashed, err := h.Hash(node)
			if SkipRest(t, n, err, c.err) {
				return
			}
			if c.hash != hashed {
				t.Errorf("case %q, expect hash %q but got %q", n, c.hash, h)
			}
		})
	}
}

func TestEncodeConfigMap(t *testing.T) {
	cases := []struct {
		desc   string
		cmYaml string
		expect string
		err    string
	}{
		// empty map
		{"empty data", `
apiVersion: v1
kind: ConfigMap`, `{"data":"","kind":"ConfigMap","name":""}`, ""},
		// one key
		{"one key", `
apiVersion: v1
kind: ConfigMap
data:
  one: ""`, `{"data":{"one":""},"kind":"ConfigMap","name":""}`, ""},
		// three keys (tests sorting order)
		{"three keys", `
apiVersion: v1
kind: ConfigMap
data:
  two: 2
  one: ""
  three: 3`, `{"data":{"one":"","three":3,"two":2},"kind":"ConfigMap","name":""}`, ""},
		// empty binary map
		{"empty data", `
apiVersion: v1
kind: ConfigMap`, `{"data":"","kind":"ConfigMap","name":""}`, ""},
		// one key with binary data
		{"one key", `
apiVersion: v1
kind: ConfigMap
binaryData:
  one: ""`, `{"binaryData":{"one":""},"data":"","kind":"ConfigMap","name":""}`, ""},
		// three keys with binary data (tests sorting order)
		{"three keys", `
apiVersion: v1
kind: ConfigMap
binaryData:
  two: 2
  one: ""
  three: 3`, `{"binaryData":{"one":"","three":3,"two":2},"data":"","kind":"ConfigMap","name":""}`, ""},
		// two keys, one string and one binary values
		{"two keys with one each", `
apiVersion: v1
kind: ConfigMap
data:
  one: ""
binaryData:
  two: ""`, `{"binaryData":{"two":""},"data":{"one":""},"kind":"ConfigMap","name":""}`, ""},
	}
	for _, c := range cases {
		node, err := yaml.Parse(c.cmYaml)
		if err != nil {
			t.Fatal(err)
		}
		s, err := encodeConfigMap(node)
		if SkipRest(t, c.desc, err, c.err) {
			continue
		}
		if s != c.expect {
			t.Errorf("case %q, expect %q but got %q from encode %#v", c.desc, c.expect, s, c.cmYaml)
		}
	}
}

func TestEncodeSecret(t *testing.T) {
	cases := []struct {
		desc       string
		secretYaml string
		expect     string
		err        string
	}{
		// empty map
		{"empty data", `
apiVersion: v1
kind: Secret
type: my-type`, `{"data":"","kind":"Secret","name":"","type":"my-type"}`, ""},
		// one key
		{"one key", `
apiVersion: v1
kind: Secret
type: my-type
data:
  one: ""`, `{"data":{"one":""},"kind":"Secret","name":"","type":"my-type"}`, ""},
		// three keys (tests sorting order) - note json.Marshal base64 encodes the values because they come in as []byte
		{"three keys", `
apiVersion: v1
kind: Secret
type: my-type
data:
  two: 2
  one: ""
  three: 3`, `{"data":{"one":"","three":3,"two":2},"kind":"Secret","name":"","type":"my-type"}`, ""},
		// with stringdata
		{"stringdata", `
apiVersion: v1
kind: Secret
type: my-type
data:
  one: ""
stringData:
  two: 2`, `{"data":{"one":""},"kind":"Secret","name":"","stringData":{"two":2},"type":"my-type"}`, ""},
		// empty stringdata
		{"empty stringdata", `
apiVersion: v1
kind: Secret
type: my-type
data:
  one: ""`, `{"data":{"one":""},"kind":"Secret","name":"","type":"my-type"}`, ""},
	}
	for _, c := range cases {
		node, err := yaml.Parse(c.secretYaml)
		if err != nil {
			t.Fatal(err)
		}
		s, err := encodeSecret(node)
		if SkipRest(t, c.desc, err, c.err) {
			continue
		}
		if s != c.expect {
			t.Errorf("case %q, expect %q but got %q from encode %#v", c.desc, c.expect, s, c.secretYaml)
		}
	}
}

// SkipRest returns true if there was a non-nil error or if we expected an
// error that didn't happen, and logs the appropriate error on the test object.
// The return value indicates whether we should skip the rest of the test case
// due to the error result.
func SkipRest(t *testing.T, desc string, err error, contains string) bool {
	t.Helper()
	if err != nil {
		if len(contains) == 0 {
			t.Errorf("case %q, expect nil error but got %q", desc, err.Error())
		} else if !strings.Contains(err.Error(), contains) {
			t.Errorf("case %q, expect error to contain %q but got %q", desc, contains, err.Error())
		}
		return true
	} else if len(contains) > 0 {
		t.Errorf("case %q, expect error to contain %q but got nil error", desc, contains)
		return true
	}
	return false
}