File: ring_growing_test.go

package info (click to toggle)
golang-k8s-utils 0.0~git20250820.0af2bda-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,048 kB
  • sloc: sh: 245; makefile: 25
file content (227 lines) | stat: -rw-r--r-- 5,645 bytes parent folder | download
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
/*
Copyright 2017 The Kubernetes 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 buffer

import (
	"testing"
)

func TestGrowthGrowing(t *testing.T) {
	t.Parallel()
	tests := map[string]struct {
		ring        *TypedRingGrowing[int]
		initialSize int
	}{
		"implicit-zero": {
			ring: new(TypedRingGrowing[int]),
		},
		"explicit-zero": {
			ring:        NewTypedRingGrowing[int](RingGrowingOptions{InitialSize: 0}),
			initialSize: 0,
		},
		"nonzero": {
			ring:        NewTypedRingGrowing[int](RingGrowingOptions{InitialSize: 1}),
			initialSize: 1,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			initialSize := test.initialSize
			g := test.ring

			if expected, actual := 0, g.Len(); expected != actual {
				t.Fatalf("expected Len to be %d, got %d", expected, actual)
			}
			if expected, actual := initialSize, g.Cap(); expected != actual {
				t.Fatalf("expected Cap to be %d, got %d", expected, actual)
			}

			x := 10
			for i := 0; i < x; i++ {
				if e, a := i, g.readable; e != a {
					t.Fatalf("expected equal, got %#v, %#v", e, a)
				}
				g.WriteOne(i)
			}

			if expected, actual := x, g.Len(); expected != actual {
				t.Fatalf("expected Len to be %d, got %d", expected, actual)
			}
			if expected, actual := 16, g.Cap(); expected != actual {
				t.Fatalf("expected Cap to be %d, got %d", expected, actual)
			}

			read := 0
			for g.readable > 0 {
				v, ok := g.ReadOne()
				if !ok {
					t.Fatal("expected true")
				}
				if read != v {
					t.Fatalf("expected %#v==%#v", read, v)
				}
				read++
			}
			if x != read {
				t.Fatalf("expected to have read %d items: %d", x, read)
			}
			if expected, actual := 0, g.Len(); expected != actual {
				t.Fatalf("expected Len to be %d, got %d", expected, actual)
			}
			if expected, actual := 16, g.Cap(); expected != actual {
				t.Fatalf("expected Cap to be %d, got %d", expected, actual)
			}
		})
	}

}

func TestGrowth(t *testing.T) {
	t.Parallel()

	tests := map[string]struct {
		ring        *Ring[int]
		initialSize int
		normalSize  int
	}{
		"implicit-zero": {
			ring: new(Ring[int]),
		},
		"explicit-zero": {
			ring:        NewRing[int](RingOptions{InitialSize: 0, NormalSize: 0}),
			initialSize: 0,
			normalSize:  0,
		},
		"smaller-initial-size": {
			ring:        NewRing[int](RingOptions{InitialSize: 1, NormalSize: 2}),
			initialSize: 1,
			normalSize:  2,
		},
		"smaller-normal-size": {
			ring:        NewRing[int](RingOptions{InitialSize: 2, NormalSize: 1}),
			initialSize: 2,
			normalSize:  1,
		},
	}

	for name, test := range tests {
		t.Run(name, func(t *testing.T) {
			initialSize := test.initialSize
			normalSize := test.normalSize
			g := test.ring

			if expected, actual := 0, g.Len(); expected != actual {
				t.Fatalf("expected Len to be %d, got %d", expected, actual)
			}
			if expected, actual := initialSize, g.Cap(); expected != actual {
				t.Fatalf("expected Cap to be %d, got %d", expected, actual)
			}

			x := 10
			for i := 0; i < x; i++ {
				if e, a := i, g.growing.readable; e != a {
					t.Fatalf("expected equal, got %#v, %#v", e, a)
				}
				g.WriteOne(i)
			}

			if expected, actual := x, g.Len(); expected != actual {
				t.Fatalf("expected Len to be %d, got %d", expected, actual)
			}
			if expected, actual := 16, g.Cap(); expected != actual {
				t.Fatalf("expected Cap to be %d, got %d", expected, actual)
			}

			read := 0
			for g.growing.readable > 0 {
				v, ok := g.ReadOne()
				if !ok {
					t.Fatal("expected true")
				}
				if read != v {
					t.Fatalf("expected %#v==%#v", read, v)
				}
				read++
			}
			if x != read {
				t.Fatalf("expected to have read %d items: %d", x, read)
			}
			if expected, actual := 0, g.Len(); expected != actual {
				t.Fatalf("expected Len to be %d, got %d", expected, actual)
			}
			if expected, actual := normalSize, g.Cap(); expected != actual {
				t.Fatalf("expected Cap to be %d, got %d", expected, actual)
			}
		})
	}
}

func TestEmpty(t *testing.T) {
	t.Parallel()
	g := NewTypedRingGrowing[struct{}](RingGrowingOptions{InitialSize: 1})
	_, ok := g.ReadOne()
	if ok != false {
		t.Fatal("expected false")
	}
}

const (
	spikeSize   = 100 // Number of items to write during a spike
	normalSize  = 64  // Normal capacity for the Ring type after shrinking
	initialSize = 16  // Initial capacity for buffers
)

func BenchmarkTypedRingGrowing_Spike(b *testing.B) {
	b.ReportAllocs()
	var item int // ensure item is used

	for i := 0; i < b.N; i++ {
		buffer := NewTypedRingGrowing[int](RingGrowingOptions{InitialSize: initialSize})

		for j := 0; j < spikeSize; j++ {
			buffer.WriteOne(j)
		}

		for buffer.Len() > 0 {
			item, _ = buffer.ReadOne()
		}
	}
	_ = item // use item
}

func BenchmarkRing_Spike_And_Shrink(b *testing.B) {
	b.ReportAllocs()
	var item int // ensure item is used

	for i := 0; i < b.N; i++ {
		// Create a new buffer for each benchmark iteration
		buffer := NewRing[int](RingOptions{
			InitialSize: initialSize,
			NormalSize:  normalSize,
		})

		for j := 0; j < spikeSize; j++ {
			buffer.WriteOne(j)
		}

		for buffer.Len() > 0 {
			item, _ = buffer.ReadOne()
		}
	}
	_ = item // use item
}