aboutsummaryrefslogtreecommitdiffstats
path: root/integration_test/utils.go
blob: 2fbfa1a71dcdd906107c7cd839b2656c2c3bf007 (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
129
130
131
132
133
134
135
136
137
138
139
140
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus library is free software: you can redistribute it
// and/or modify it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// The dexon-consensus library 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 Lesser
// General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the dexon-consensus library. If not, see
// <http://www.gnu.org/licenses/>.

package integration

import (
    "errors"
    "time"

    "github.com/dexon-foundation/dexon-consensus/core"
    "github.com/dexon-foundation/dexon-consensus/core/crypto"
    "github.com/dexon-foundation/dexon-consensus/core/db"
    "github.com/dexon-foundation/dexon-consensus/core/test"
    "github.com/dexon-foundation/dexon-consensus/core/types"
)

func genRoundEndTimes(
    configs []*types.Config, dMoment time.Time) (ends []time.Time) {
    now := dMoment
    for _, config := range configs {
        now = now.Add(config.RoundInterval)
        ends = append(ends, now)
    }
    return
}

// loadAllConfigs loads all prepared configuration from governance,
// starts from round 0.
func loadAllConfigs(gov core.Governance) (configs []*types.Config) {
    var round uint64
    for {
        config := gov.Configuration(round)
        if config == nil {
            break
        }
        configs = append(configs, config)
        round++
    }
    return
}

// decideOwnChains compute which chainIDs belongs to this node.
func decideOwnChains(numChains uint32, numNodes, id int) (own []uint32) {
    var cur = uint32(id)
    if numNodes == 0 {
        panic(errors.New("attempt to arrange chains on 0 nodes"))
    }
    for {
        if cur >= numChains {
            break
        }
        own = append(own, cur)
        cur += uint32(numNodes)
    }
    return
}

// PrepareNodes setups nodes for testing.
func PrepareNodes(
    gov *test.Governance,
    prvKeys []crypto.PrivateKey,
    maxNumChains uint32,
    networkLatency, proposingLatency test.LatencyModel) (
    nodes map[types.NodeID]*Node, err error) {
    if maxNumChains == 0 {
        err = errors.New("zero NumChains is unexpected")
        return
    }
    // Setup nodes, count of nodes is derived from the count of private keys
    // hold in Governance.
    nodes = make(map[types.NodeID]*Node)
    dMoment := time.Now().UTC()
    broadcastTargets := make(map[types.NodeID]struct{})
    for idx, prvKey := range prvKeys {
        nID := types.NewNodeID(prvKey.PublicKey())
        broadcastTargets[nID] = struct{}{}
        // Decides which chains are owned by this node.
        if nodes[nID], err = newNode(
            gov,
            prvKey,
            dMoment,
            decideOwnChains(maxNumChains, len(prvKeys), idx),
            networkLatency,
            proposingLatency); err != nil {
            return
        }
    }
    // Assign broadcast targets.
    for _, n := range nodes {
        n.setBroadcastTargets(broadcastTargets)
        n.gov().State().SwitchToRemoteMode()
    }
    return
}

// VerifyApps is a helper to check delivery between test.Apps
func VerifyApps(apps map[types.NodeID]*test.App) (err error) {
    for vFrom, fromApp := range apps {
        if err = fromApp.Verify(); err != nil {
            return
        }
        for vTo, toApp := range apps {
            if vFrom == vTo {
                continue
            }
            if err = fromApp.Compare(toApp); err != nil {
                return
            }
        }
    }
    return
}

// CollectAppAndDBFromNodes collects test.App and db.Database
// from nodes.
func CollectAppAndDBFromNodes(nodes map[types.NodeID]*Node) (
    apps map[types.NodeID]*test.App,
    dbs map[types.NodeID]db.Database) {
    apps = make(map[types.NodeID]*test.App)
    dbs = make(map[types.NodeID]db.Database)
    for nID, node := range nodes {
        apps[nID] = node.app()
        dbs[nID] = node.db()
    }
    return
}