File: utils_test.go

package info (click to toggle)
golang-github-containernetworking-plugins 1.1.1%2Bds1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,672 kB
  • sloc: sh: 132; makefile: 11
file content (165 lines) | stat: -rw-r--r-- 5,780 bytes parent folder | download | duplicates (3)
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
// Copyright 2016 CNI authors
//
// 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 utils

import (
	"fmt"
	"strings"

	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

var _ = Describe("Utils", func() {
	Describe("FormatChainName", func() {
		It("must format a short name", func() {
			chain := FormatChainName("test", "1234")
			Expect(len(chain)).To(Equal(maxChainLength))
			Expect(chain).To(Equal("CNI-2bbe0c48b91a7d1b8a6753a8"))
		})

		It("must truncate a long name", func() {
			chain := FormatChainName("testalongnamethatdoesnotmakesense", "1234")
			Expect(len(chain)).To(Equal(maxChainLength))
			Expect(chain).To(Equal("CNI-374f33fe84ab0ed84dcdebe3"))
		})

		It("must be predictable", func() {
			chain1 := FormatChainName("testalongnamethatdoesnotmakesense", "1234")
			chain2 := FormatChainName("testalongnamethatdoesnotmakesense", "1234")
			Expect(len(chain1)).To(Equal(maxChainLength))
			Expect(len(chain2)).To(Equal(maxChainLength))
			Expect(chain1).To(Equal(chain2))
		})

		It("must change when a character changes", func() {
			chain1 := FormatChainName("testalongnamethatdoesnotmakesense", "1234")
			chain2 := FormatChainName("testalongnamethatdoesnotmakesense", "1235")
			Expect(len(chain1)).To(Equal(maxChainLength))
			Expect(len(chain2)).To(Equal(maxChainLength))
			Expect(chain1).To(Equal("CNI-374f33fe84ab0ed84dcdebe3"))
			Expect(chain1).NotTo(Equal(chain2))
		})
	})

	Describe("MustFormatChainNameWithPrefix", func() {
		It("generates a chain name with a prefix", func() {
			chain := MustFormatChainNameWithPrefix("test", "1234", "PREFIX-")
			Expect(len(chain)).To(Equal(maxChainLength))
			Expect(chain).To(Equal("CNI-PREFIX-2bbe0c48b91a7d1b8"))
		})

		It("must format a short name", func() {
			chain := MustFormatChainNameWithPrefix("test", "1234", "PREFIX-")
			Expect(len(chain)).To(Equal(maxChainLength))
			Expect(chain).To(Equal("CNI-PREFIX-2bbe0c48b91a7d1b8"))
		})

		It("must truncate a long name", func() {
			chain := MustFormatChainNameWithPrefix("testalongnamethatdoesnotmakesense", "1234", "PREFIX-")
			Expect(len(chain)).To(Equal(maxChainLength))
			Expect(chain).To(Equal("CNI-PREFIX-374f33fe84ab0ed84"))
		})

		It("must be predictable", func() {
			chain1 := MustFormatChainNameWithPrefix("testalongnamethatdoesnotmakesense", "1234", "PREFIX-")
			chain2 := MustFormatChainNameWithPrefix("testalongnamethatdoesnotmakesense", "1234", "PREFIX-")
			Expect(len(chain1)).To(Equal(maxChainLength))
			Expect(len(chain2)).To(Equal(maxChainLength))
			Expect(chain1).To(Equal(chain2))
		})

		It("must change when a character changes", func() {
			chain1 := MustFormatChainNameWithPrefix("testalongnamethatdoesnotmakesense", "1234", "PREFIX-")
			chain2 := MustFormatChainNameWithPrefix("testalongnamethatdoesnotmakesense", "1235", "PREFIX-")
			Expect(len(chain1)).To(Equal(maxChainLength))
			Expect(len(chain2)).To(Equal(maxChainLength))
			Expect(chain1).To(Equal("CNI-PREFIX-374f33fe84ab0ed84"))
			Expect(chain1).NotTo(Equal(chain2))
		})

		It("panics when prefix is too large", func() {
			longPrefix := strings.Repeat("PREFIX-", 4)
			Expect(func() {
				MustFormatChainNameWithPrefix("test", "1234", longPrefix)
			}).To(Panic())
		})
	})

	Describe("MustFormatHashWithPrefix", func() {
		It("always returns a string with the given prefix", func() {
			Expect(MustFormatHashWithPrefix(10, "AAA", "some string")).To(HavePrefix("AAA"))
			Expect(MustFormatHashWithPrefix(10, "foo", "some string")).To(HavePrefix("foo"))
			Expect(MustFormatHashWithPrefix(10, "bar", "some string")).To(HavePrefix("bar"))
		})

		It("always returns a string of the given length", func() {
			Expect(MustFormatHashWithPrefix(10, "AAA", "some string")).To(HaveLen(10))
			Expect(MustFormatHashWithPrefix(15, "AAA", "some string")).To(HaveLen(15))
			Expect(MustFormatHashWithPrefix(5, "AAA", "some string")).To(HaveLen(5))
		})

		It("is deterministic", func() {
			val1 := MustFormatHashWithPrefix(10, "AAA", "some string")
			val2 := MustFormatHashWithPrefix(10, "AAA", "some string")
			val3 := MustFormatHashWithPrefix(10, "AAA", "some string")
			Expect(val1).To(Equal(val2))
			Expect(val1).To(Equal(val3))
		})

		It("is (nearly) perfect (injective function)", func() {
			hashes := map[string]int{}

			for i := 0; i < 1000; i++ {
				name := fmt.Sprintf("string %d", i)
				hashes[MustFormatHashWithPrefix(8, "", name)]++
			}

			for key, count := range hashes {
				Expect(count).To(Equal(1), "for key "+key+" got non-unique correspondence")
			}
		})

		assertPanicWith := func(f func(), expectedErrorMessage string) {
			defer func() {
				Expect(recover()).To(Equal(expectedErrorMessage))
			}()
			f()
			Fail("function should have panicked but did not")
		}

		It("panics when prefix is longer than the length", func() {
			assertPanicWith(
				func() { MustFormatHashWithPrefix(3, "AAA", "some string") },
				"invalid length",
			)
		})

		It("panics when length is not positive", func() {
			assertPanicWith(
				func() { MustFormatHashWithPrefix(0, "", "some string") },
				"invalid length",
			)
		})

		It("panics when length is larger than MaxLen", func() {
			assertPanicWith(
				func() { MustFormatHashWithPrefix(MaxHashLen+1, "", "some string") },
				"invalid length",
			)
		})
	})

})