atomicringbuffer/ringbuffer_test.go at main · minhthong582000/atomicringbuffer · GitHub

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
package atomicringbuffer

import (
	"sync"
	"testing"

	"github.com/stretchr/testify/assert"
)

// TestNewRingBuffer tests buffer initialization
func TestNewRingBuffer(t *testing.T) {
	rb := NewRingBuffer[int64](5)

	assert.NotNil(t, rb)
	assert.Equal(t, uint64(5), rb.Capacity())
	assert.Equal(t, uint64(0), rb.Size())
	assert.Equal(t, uint64(0), rb.StartIndex())
}

// TestEnqueue tests enqueuing values into the buffer
func TestEnqueue(t *testing.T) {
	rb := NewRingBuffer[int64](3)

	// Enqueue 3 items
	assert.NoError(t, rb.PushBack(1))
	assert.NoError(t, rb.PushBack(2))
	assert.NoError(t, rb.PushBack(3))

	// Buffer should now be full
	assert.True(t, rb.IsFull())
	assert.Equal(t, uint64(3), rb.Size())

	// Attempt to enqueue beyond capacity
	assert.ErrorIs(t, rb.PushBack(4), ErrIsFull)
}

// TestDequeue tests dequeuing values from the buffer
func TestDequeue(t *testing.T) {
	rb := NewRingBuffer[string](3)

	// Dequeue from an empty buffer
	_, err := rb.PopFront()
	assert.ErrorIs(t, err, ErrIsEmpty)

	// Enqueue 2 items
	assert.NoError(t, rb.PushBack("10"))
	assert.NoError(t, rb.PushBack("20"))

	// Dequeue and validate
	value, err := rb.PopFront()
	assert.NoError(t, err)
	assert.Equal(t, "10", value)

	value, err = rb.PopFront()
	assert.NoError(t, err)
	assert.Equal(t, "20", value)

	// Buffer should now be empty
	assert.True(t, rb.IsEmpty())
}

// TestEnqueueDequeueCycle tests multiple enqueue and dequeue operations
func TestEnqueueDequeueCycle(t *testing.T) {
	rb := NewRingBuffer[int64](2)

	// Fill buffer
	assert.NoError(t, rb.PushBack(5))
	assert.NoError(t, rb.PushBack(10))
	assert.True(t, rb.IsFull())

	// Dequeue one item
	value, err := rb.PopFront()
	assert.NoError(t, err)
	assert.Equal(t, int64(5), value)

	// Add another item
	assert.NoError(t, rb.PushBack(15))

	// Dequeue remaining items
	value, err = rb.PopFront()
	assert.NoError(t, err)
	assert.Equal(t, int64(10), value)

	value, err = rb.PeekFront()
	assert.NoError(t, err)
	assert.Equal(t, int64(15), value)
	value, err = rb.PopFront()
	assert.NoError(t, err)
	assert.Equal(t, int64(15), value)

	assert.True(t, rb.IsEmpty())
}

// TestIsEmpty tests the IsEmpty method
func TestIsEmpty(t *testing.T) {
	rb := NewRingBuffer[int64](2)

	assert.True(t, rb.IsEmpty())

	assert.NoError(t, rb.PushBack(1))
	assert.False(t, rb.IsEmpty())

	_, _ = rb.PopFront()
	assert.True(t, rb.IsEmpty())
}

// TestIsFull tests the IsFull method
func TestIsFull(t *testing.T) {
	rb := NewRingBuffer[int64](2)

	assert.False(t, rb.IsFull())

	assert.NoError(t, rb.PushBack(1))
	assert.NoError(t, rb.PushBack(2))
	assert.True(t, rb.IsFull())
}

// TestPeekFront tests the PeekFront method
func TestPeekFront(t *testing.T) {
	rb := NewRingBuffer[int64](3)

	_, err := rb.PeekFront()
	assert.ErrorIs(t, err, ErrIsEmpty)

	assert.NoError(t, rb.PushBack(1))
	assert.NoError(t, rb.PushBack(2))

	value, err := rb.PeekFront()
	assert.NoError(t, err)
	assert.Equal(t, int64(1), value)
}

// TestSingleProducerSingleConsumer tests ring behavior with a single producer and consumer
func TestSingleProducerSingleConsumer(t *testing.T) {
	rb := NewRingBuffer[int](100)
	var wg sync.WaitGroup

	// Producer
	wg.Add(1)
	go func() {
		defer wg.Done()

		for i := 0; i < 10000; i++ {
			err := rb.PushBack(i)
			if err != nil {
				assert.ErrorIs(t, err, ErrIsFull)
			}
		}
	}()

	// Consumer
	wg.Add(1)
	go func() {
		defer wg.Done()

		for i := 0; i < 10000; i++ {
			value, err := rb.PopFront()
			if err != nil {
				assert.ErrorIs(t, err, ErrIsEmpty)
			}
			assert.IsType(t, int(0), value)
		}
	}()

	wg.Wait()
}