summaryrefslogtreecommitdiff
path: root/ledger/bulletin_test.go
blob: 69bc2525d84c9235aa741a9e4bbedb8234f407b9 (plain)
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
// Copyright (C) 2019-2024 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.

package ledger

import (
	"testing"
	"time"

	"github.com/algorand/go-algorand/data/basics"
	"github.com/algorand/go-algorand/test/partitiontest"
	"github.com/stretchr/testify/require"
)

const epsilon = 5 * time.Millisecond

func TestBulletin(t *testing.T) {
	partitiontest.PartitionTest(t)

	bul := makeBulletin()

	bul.committedUpTo(1)
	<-bul.Wait(1) // Should finish immediately
	<-bul.Wait(1) // Should finish immediately

	select {
	case <-bul.Wait(2):
		t.Errorf("<-Wait(2) finished early")
		t.FailNow()
	default:
		// Correct
	}

	bul.committedUpTo(2)

	select {
	case <-bul.Wait(2):
		// Correct
	case <-time.After(epsilon):
		t.Errorf("<-Wait(2) finished late")
	}

	eventSequence := make(chan string, 3)
	go func() {
		<-bul.Wait(3)
		eventSequence <- "A: Finished waiting on 3"
	}()
	go func() {
		<-bul.Wait(3)
		eventSequence <- "B: Finished waiting on 3"
	}()
	go func() {
		time.Sleep(epsilon)
		eventSequence <- "Notifying 3"
		bul.committedUpTo(3)
	}()

	<-bul.Wait(3)
	e1, e2, e3 := <-eventSequence, <-eventSequence, <-eventSequence
	if e1 != "Notifying 3" {
		t.Errorf("Wrong order: %v, %v, %v", e1, e2, e3)
	}

	select {
	case <-bul.Wait(5):
		t.Errorf("<-Wait(5) finished early")
		t.FailNow()
	default:
		// Correct
	}

	bul.committedUpTo(7)

	select {
	case <-bul.Wait(6):
		// Correct
	case <-time.After(epsilon):
		t.Errorf("<-Wait(6) finished late")
	}

	go func() {
		time.Sleep(epsilon)
		bul.committedUpTo(20)
	}()
	select {
	case <-bul.Wait(10):
		// Correct
	case <-time.After(time.Second):
		t.Errorf("<-Wait(10) finished late")
	}
}

func TestCancelWait(t *testing.T) {
	partitiontest.PartitionTest(t)

	bul := makeBulletin()

	// Calling Wait before CancelWait
	waitCh := bul.Wait(5)
	bul.CancelWait(5)
	bul.committedUpTo(5)
	select {
	case <-waitCh:
		t.Errorf("<-Wait(5) should have been cancelled")
	case <-time.After(epsilon):
		// Correct
	}
	require.NotContains(t, bul.pendingNotificationRequests, basics.Round(5))

	// Calling CancelWait before Wait
	bul.CancelWait(6)
	select {
	case <-bul.Wait(6):
		t.Errorf("<-Wait(6) should have been cancelled")
	case <-time.After(epsilon):
		// Correct
	}
	require.Contains(t, bul.pendingNotificationRequests, basics.Round(6))
	require.Equal(t, bul.pendingNotificationRequests[basics.Round(6)].count, 1)
	bul.CancelWait(6)
	require.NotContains(t, bul.pendingNotificationRequests, basics.Round(6))

	// Two Waits, one cancelled
	waitCh1 := bul.Wait(7)
	waitCh2 := bul.Wait(7)
	require.Equal(t, waitCh1, waitCh2)
	bul.CancelWait(7)
	select {
	case <-waitCh1:
		t.Errorf("<-Wait(7) should not be notified yet")
	case <-time.After(epsilon):
		// Correct
	}
	// Still one waiter
	require.Contains(t, bul.pendingNotificationRequests, basics.Round(7))
	require.Equal(t, bul.pendingNotificationRequests[basics.Round(7)].count, 1)

	bul.committedUpTo(7)
	select {
	case <-waitCh1:
		// Correct
	case <-time.After(epsilon):
		t.Errorf("<-Wait(7) should have been notified")
	}
	require.NotContains(t, bul.pendingNotificationRequests, basics.Round(7))

	// Wait followed by Cancel for a round that already completed
	waitCh = bul.Wait(5)
	bul.CancelWait(5)
	require.NotContains(t, bul.pendingNotificationRequests, basics.Round(5))
	select {
	case <-waitCh:
		// Correct
	case <-time.After(epsilon):
		t.Errorf("<-Wait(5) should have been notified right away")
	}

	// Cancel Wait after Wait triggered
	waitCh = bul.Wait(8)
	require.Contains(t, bul.pendingNotificationRequests, basics.Round(8))
	require.Equal(t, bul.pendingNotificationRequests[basics.Round(8)].count, 1)
	bul.committedUpTo(8)
	require.NotContains(t, bul.pendingNotificationRequests, basics.Round(8))
	select {
	case <-waitCh:
		// Correct
	case <-time.After(epsilon):
		t.Errorf("<-Wait(8) should have been notified")
	}
	require.NotContains(t, bul.pendingNotificationRequests, basics.Round(8))
	bul.CancelWait(8) // should do nothing

	// Cancel Wait after Wait triggered, but before Wait returned
	waitCh = bul.Wait(9)
	require.Contains(t, bul.pendingNotificationRequests, basics.Round(9))
	require.Equal(t, bul.pendingNotificationRequests[basics.Round(9)].count, 1)
	bul.committedUpTo(9)
	require.NotContains(t, bul.pendingNotificationRequests, basics.Round(9))
	bul.CancelWait(9) // should do nothing
	select {
	case <-waitCh:
		// Correct
	case <-time.After(epsilon):
		t.Errorf("<-Wait(9) should have been notified")
	}
	require.NotContains(t, bul.pendingNotificationRequests, basics.Round(9))

	// Two waits, both cancelled
	waitCh1 = bul.Wait(10)
	waitCh2 = bul.Wait(10)
	require.Equal(t, waitCh1, waitCh2)
	bul.CancelWait(10)
	require.Contains(t, bul.pendingNotificationRequests, basics.Round(10))
	require.Equal(t, bul.pendingNotificationRequests[basics.Round(10)].count, 1)
	bul.CancelWait(10)
	require.NotContains(t, bul.pendingNotificationRequests, basics.Round(10))
}