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
|
// 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 agreementtest produces useful functions for testing code.
package agreementtest
import (
"fmt"
"strconv"
"time"
"github.com/algorand/go-deadlock"
"github.com/algorand/go-algorand/agreement"
"github.com/algorand/go-algorand/agreement/gossip"
"github.com/algorand/go-algorand/components/mocks"
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/crypto"
"github.com/algorand/go-algorand/data/basics"
"github.com/algorand/go-algorand/logging"
"github.com/algorand/go-algorand/util/db"
"github.com/algorand/go-algorand/util/timers"
)
type instant struct {
Z0, Z1 chan struct{}
timeoutAtCalled chan struct{}
eventsQueues map[string]int
mu deadlock.Mutex
}
func makeInstant() *instant {
i := new(instant)
i.Z0 = make(chan struct{}, 1)
i.Z1 = make(chan struct{})
i.timeoutAtCalled = make(chan struct{})
i.eventsQueues = make(map[string]int)
return i
}
func (i *instant) Decode([]byte) (timers.Clock[agreement.TimeoutType], error) {
return i, nil
}
func (i *instant) Encode() []byte {
return nil
}
func (i *instant) TimeoutAt(d time.Duration, timeoutType agreement.TimeoutType) <-chan time.Time {
ta := make(chan time.Time)
select {
case <-i.timeoutAtCalled:
default:
close(i.timeoutAtCalled)
return ta
}
if timeoutType == agreement.TimeoutFilter && !i.HasPending("pseudonode") {
close(ta)
}
return ta
}
func (i *instant) Zero() timers.Clock[agreement.TimeoutType] {
i.Z0 <- struct{}{}
// pause here until runRound is called
i.Z1 <- struct{}{}
return i
}
func (i *instant) Since() time.Duration {
return 0
}
func (i *instant) runRound(r basics.Round) {
<-i.Z1 // wait until Zero is called
<-i.timeoutAtCalled
<-i.Z0
}
func (i *instant) shutdown() {
<-i.Z1
}
func (i *instant) UpdateEventsQueue(queueName string, queueLength int) {
i.mu.Lock()
defer i.mu.Unlock()
i.eventsQueues[queueName] = queueLength
}
func (i *instant) HasPending(queueName string) bool {
i.mu.Lock()
defer i.mu.Unlock()
v, has := i.eventsQueues[queueName]
if !has {
return false
}
if v == 0 {
return false
}
return true
}
type blackhole struct {
mocks.MockNetwork
}
func (b *blackhole) Address() (string, bool) {
return "blackhole", true
}
// CryptoRandomSource is a random source that is based off our crypto library.
type CryptoRandomSource struct{}
// Uint64 implements the randomness by calling the crypto library.
func (c *CryptoRandomSource) Uint64() uint64 {
return crypto.RandUint64()
}
// Simulate n rounds of agreement on the specified Ledger given the specified
// KeyManager, BlockFactory, and BlockValidator.
//
// If a nonzero roundDeadline is given, this function will return an error if
// any round does not conclude by the deadline.
//
// The KeyManager must have enough keys to form a cert-quorum.
func Simulate(dbname string, n basics.Round, roundDeadline time.Duration, ledger agreement.Ledger, keyManager agreement.KeyManager, proposalFactory agreement.BlockFactory, proposalValidator agreement.BlockValidator, log logging.Logger) error {
startRound := ledger.NextRound()
stopRound := startRound + n
// stop when ledger.NextRound() == stopRound
accessor, err := db.MakeAccessor(dbname+"_simulate_"+strconv.Itoa(int(stopRound))+"_crash.db", false, true)
if err != nil {
return err
}
defer accessor.Close()
stopwatch := makeInstant()
parameters := agreement.Parameters{
Logger: log,
Accessor: accessor,
Clock: stopwatch,
Network: gossip.WrapNetwork(new(blackhole), log, config.GetDefaultLocal()),
Ledger: ledger,
BlockFactory: proposalFactory,
BlockValidator: proposalValidator,
KeyManager: keyManager,
Local: config.Local{
CadaverSizeTarget: 200 * 1024,
},
RandomSource: &CryptoRandomSource{},
EventsProcessingMonitor: stopwatch,
}
_ = accessor
service, err := agreement.MakeService(parameters)
if err != nil {
return err
}
service.Start()
defer service.Shutdown()
defer stopwatch.shutdown()
for ledger.NextRound() < stopRound {
r := ledger.NextRound()
stopwatch.runRound(r)
deadlineCh := time.After(roundDeadline)
if roundDeadline == 0 {
deadlineCh = nil
}
select {
case <-ledger.Wait(r):
case <-deadlineCh:
return fmt.Errorf("agreementtest.Simulate: round %d failed to complete by the deadline (%v)", r, roundDeadline)
}
}
return nil
}
|
