summaryrefslogtreecommitdiffstats
path: root/deque_test.go
blob: 4f64585c7f82cabeebe122ca6cbb748c0671b978 (plain) (blame)
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
package share_test

import (
	"fmt"
	"slices"
	"sync"
	"testing"

	"github.com/sam-rba/share"
)

func TestDequeFIFO(t *testing.T) {
	dq := share.NewDeque[string]()
	vals := []string{"foo", "bar", "baz", "xyz"}
	testFIFO(t, dq.PutTail, dq.TakeHead, vals, dq.Close)
}

func TestDequeReverseFIFO(t *testing.T) {
	dq := share.NewDeque[string]()
	vals := []string{"foo", "bar", "baz", "xyz"}
	testFIFO(t, dq.PutHead, dq.TakeTail, vals, dq.Close)
}

func testFIFO[T comparable](t *testing.T, put chan<- T, take <-chan T, vals []T, end func()) {
	var wg sync.WaitGroup
	wg.Add(2)
	go func() {
		produce(put, vals)
		end()
		wg.Done()
	}()
	go func() {
		consume(t, take, vals)
		wg.Done()
	}()
	wg.Wait()
}

func TestDequeLIFO(t *testing.T) {
	dq := share.NewDeque[string]()
	vals := []string{"foo", "bar", "baz", "xyz"}
	testLIFO(t, dq.PutTail, dq.TakeTail, vals, dq.Close)
}

func TestDequeReverseLIFO(t *testing.T) {
	dq := share.NewDeque[string]()
	vals := []string{"foo", "bar", "baz", "xyz"}
	testLIFO(t, dq.PutHead, dq.TakeHead, vals, dq.Close)
}

func testLIFO[T comparable](t *testing.T, put chan<- T, take <-chan T, vals []T, end func()) {
	var wg sync.WaitGroup

	wg.Add(1)
	go func() {
		produce(put, vals)
		end()
		wg.Done()
	}()

	want := slices.Clone(vals)
	slices.Reverse(want)
	wg.Wait()
	consume(t, take, want)
}

func produce[T any](put chan<- T, vals []T) {
	for _, v := range vals {
		put <- v
	}
}

func consume[T comparable](t *testing.T, take <-chan T, want []T) {
	i := 0
	for v := range take {
		if i >= len(want) {
			t.Fatal("received too many")
		}
		if v != want[i] {
			t.Fatalf("Index %d: %v; want %v", i, v, want[i])
		}
		i++
	}
	if i < len(want) {
		t.Fatalf("Only received %d; want %d", i, len(want))
	}
}

func TestDequePutback(t *testing.T) {
	dq := share.NewDeque[string]()

	dq.PutTail <- "foo"
	dq.PutTail <- "bar"
	dq.PutTail <- "baz"
	dq.PutTail <- "xyz"

	<-dq.TakeHead // foo
	<-dq.TakeHead // bar
	<-dq.TakeHead // baz

	dq.PutHead <- "baz"
	dq.PutHead <- "bar"

	dq.Close()

	consume(t, dq.TakeHead, []string{"bar", "baz", "xyz"})
}

func ExampleDeque() {
	// Use as a FIFO queue
	dq := share.NewDeque[string]()

	// Producer
	go func() {
		defer dq.Close()
		for _, word := range []string{"foo", "bar", "baz"} {
			dq.PutTail <- word
		}
	}()

	for word := range dq.TakeHead {
		fmt.Println(word)
	}
	// Output:
	// foo
	// bar
	// baz
}