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
|
// Copyright (C) 2019-2023 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 testing
import (
"crypto/rand"
"fmt"
"testing"
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/protocol"
"github.com/stretchr/testify/require"
)
var consensusByNumber = []protocol.ConsensusVersion{
"", "", "", "", "", "", "",
protocol.ConsensusV7,
protocol.ConsensusV8,
protocol.ConsensusV9,
protocol.ConsensusV10,
protocol.ConsensusV11, // first with viable payset commit type
protocol.ConsensusV12,
protocol.ConsensusV13,
protocol.ConsensusV14,
protocol.ConsensusV15, // rewards in AD
protocol.ConsensusV16,
protocol.ConsensusV17,
protocol.ConsensusV18,
protocol.ConsensusV19,
protocol.ConsensusV20,
protocol.ConsensusV21,
protocol.ConsensusV22,
protocol.ConsensusV23,
protocol.ConsensusV24, // AVM v2 (apps)
protocol.ConsensusV25,
protocol.ConsensusV26, // AVM v3
protocol.ConsensusV27,
protocol.ConsensusV28, // AVM v4 (direct refs)
protocol.ConsensusV29,
protocol.ConsensusV30, // AVM v5 (inner txs)
protocol.ConsensusV31, // AVM v6 (inner txs with appls)
protocol.ConsensusV32, // unlimited assets and apps
protocol.ConsensusV33, // 320 rounds
protocol.ConsensusV34, // AVM v7, stateproofs
protocol.ConsensusV35, // minor, double upgrade withe v34
protocol.ConsensusV36, // AVM v8, box storage
protocol.ConsensusV37,
protocol.ConsensusV38, // AVM v9, ECDSA pre-check, stateproofs recoverability
protocol.ConsensusV39, // AVM v10, logicsig opcode budget pooling, elliptic curve ops, dynamic round times
protocol.ConsensusFuture,
}
func versionStringFromIndex(index int) string {
var version string
if index == len(consensusByNumber)-1 {
version = "vFuture"
} else {
version = fmt.Sprintf("v%d", index)
}
return version
}
// randBool samples randomness for TestConsensusRange,
// which tests with or without LRU Cache in ledger
func randBool(t *testing.T) bool {
var byteBuffer [1]byte
_, err := rand.Read(byteBuffer[:])
require.NoError(t, err)
return byteBuffer[0]%2 == 0
}
// TestConsensusRange allows for running tests against a range of consensus
// versions. Generally `start` will be the version that introduced the feature,
// and `stop` will be 0 to indicate it should work right on up through vFuture.
// `stop` will be an actual version number if we're confirming that something
// STOPS working as of a particular version. When writing the test for a new
// feature that is currently in vFuture, use the expected version number as
// `start`. That will correspond to vFuture until a new consensus version is
// created and inserted in consensusByNumber. At that point, your feature is
// probably active in that version. (If it's being held in vFuture, just
// increment your `start`.)
func TestConsensusRange(t *testing.T, start, stop int, test func(t *testing.T, ver int, cv protocol.ConsensusVersion, cfg config.Local)) {
if stop == 0 { // Treat 0 as "future"
stop = len(consensusByNumber) - 1
}
require.LessOrEqual(t, start, stop)
cfg := config.GetDefaultLocal()
for i := start; i <= stop; i++ {
version := versionStringFromIndex(i)
disable := randBool(t)
t.Run(fmt.Sprintf("cv=%s,LRU-cache-disable=%t", version, disable), func(t *testing.T) {
cfg.DisableLedgerLRUCache = disable
test(t, i, consensusByNumber[i], cfg)
})
}
}
// BenchConsensusRange is for getting benchmarks across consensus versions.
func BenchConsensusRange(b *testing.B, start, stop int, bench func(t *testing.B, ver int, cv protocol.ConsensusVersion)) {
if stop == 0 { // Treat 0 as "future"
stop = len(consensusByNumber) - 1
}
for i := start; i <= stop; i++ {
version := versionStringFromIndex(i)
b.Run(fmt.Sprintf("cv=%s", version), func(b *testing.B) {
bench(b, i, consensusByNumber[i])
})
}
}
|
