aboutsummaryrefslogtreecommitdiffstats
path: root/core/db/memory_test.go
blob: b210c8d4ebfa132946debb75b42982cceba9f419 (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
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
// 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 db

import (
    "bytes"
    "os"
    "testing"

    "github.com/dexon-foundation/dexon-consensus/common"
    "github.com/dexon-foundation/dexon-consensus/core/crypto/dkg"
    "github.com/dexon-foundation/dexon-consensus/core/types"
    "github.com/stretchr/testify/suite"
)

type MemBackedDBTestSuite struct {
    suite.Suite

    v0            types.NodeID
    b00, b01, b02 *types.Block
}

func (s *MemBackedDBTestSuite) SetupSuite() {
    s.v0 = types.NodeID{Hash: common.NewRandomHash()}

    genesisHash := common.NewRandomHash()
    s.b00 = &types.Block{
        ProposerID: s.v0,
        ParentHash: genesisHash,
        Hash:       genesisHash,
        Position: types.Position{
            Height: 0,
        },
        Acks: common.NewSortedHashes(common.Hashes{}),
    }
    s.b01 = &types.Block{
        ProposerID: s.v0,
        ParentHash: s.b00.Hash,
        Hash:       common.NewRandomHash(),
        Position: types.Position{
            Height: 1,
        },
        Acks: common.NewSortedHashes(common.Hashes{s.b00.Hash}),
    }
    s.b02 = &types.Block{
        ProposerID: s.v0,
        ParentHash: s.b01.Hash,
        Hash:       common.NewRandomHash(),
        Position: types.Position{
            Height: 2,
        },
        Acks: common.NewSortedHashes(common.Hashes{s.b01.Hash}),
    }
}

func (s *MemBackedDBTestSuite) TestSaveAndLoad() {
    // Make sure we are able to save/load from file.
    dbPath := "test-save-and-load.db"

    // Make sure the file pointed by 'dbPath' doesn't exist.
    _, err := os.Stat(dbPath)
    s.Require().Error(err)

    dbInst, err := NewMemBackedDB(dbPath)
    s.Require().NoError(err)
    s.Require().NotNil(dbInst)
    defer func() {
        if dbInst != nil {
            s.NoError(os.Remove(dbPath))
            dbInst = nil
        }
    }()

    s.NoError(dbInst.PutBlock(*s.b00))
    s.NoError(dbInst.PutBlock(*s.b01))
    s.NoError(dbInst.PutBlock(*s.b02))
    s.NoError(dbInst.Close())

    // Load the json file back to check if all inserted blocks
    // exists.
    dbInst, err = NewMemBackedDB(dbPath)
    s.Require().NoError(err)
    s.Require().NotNil(dbInst)
    s.True(dbInst.HasBlock(s.b00.Hash))
    s.True(dbInst.HasBlock(s.b01.Hash))
    s.True(dbInst.HasBlock(s.b02.Hash))
    s.NoError(dbInst.Close())
}

func (s *MemBackedDBTestSuite) TestIteration() {
    // Make sure the file pointed by 'dbPath' doesn't exist.
    dbInst, err := NewMemBackedDB()
    s.Require().NoError(err)
    s.Require().NotNil(dbInst)

    // Setup database.
    s.NoError(dbInst.PutBlock(*s.b00))
    s.NoError(dbInst.PutBlock(*s.b01))
    s.NoError(dbInst.PutBlock(*s.b02))

    // Check if we can iterate all 3 blocks.
    iter, err := dbInst.GetAllBlocks()
    s.Require().NoError(err)
    touched := common.Hashes{}
    for {
        b, err := iter.NextBlock()
        if err == ErrIterationFinished {
            break
        }
        s.Require().NoError(err)
        touched = append(touched, b.Hash)
    }
    s.Len(touched, 3)
    s.Contains(touched, s.b00.Hash)
    s.Contains(touched, s.b01.Hash)
    s.Contains(touched, s.b02.Hash)
}

func (s *MemBackedDBTestSuite) TestCompactionChainTipInfo() {
    dbInst, err := NewMemBackedDB()
    s.Require().NoError(err)
    s.Require().NotNil(dbInst)
    // Save some tip info.
    hash := common.NewRandomHash()
    s.Require().NoError(dbInst.PutCompactionChainTipInfo(hash, 1))
    // Get it back to check.
    hashBack, height := dbInst.GetCompactionChainTipInfo()
    s.Require().Equal(hash, hashBack)
    s.Require().Equal(height, uint64(1))
    // Unable to put compaction chain tip info with lower height.
    err = dbInst.PutCompactionChainTipInfo(hash, 0)
    s.Require().Equal(err.Error(), ErrInvalidCompactionChainTipHeight.Error())
    // Unable to put compaction chain tip info with height not incremental by 1.
    err = dbInst.PutCompactionChainTipInfo(hash, 3)
    s.Require().Equal(err.Error(), ErrInvalidCompactionChainTipHeight.Error())
    // It's OK to put compaction chain tip info with height incremental by 1.
    s.Require().NoError(dbInst.PutCompactionChainTipInfo(hash, 2))
}

func (s *MemBackedDBTestSuite) TestDKGPrivateKey() {
    dbInst, err := NewMemBackedDB()
    s.Require().NoError(err)
    s.Require().NotNil(dbInst)
    p := dkg.NewPrivateKey()
    // Check existence.
    exists, err := dbInst.HasDKGPrivateKey(1)
    s.Require().NoError(err)
    s.Require().False(exists)
    // We should be unable to get it, too.
    _, err = dbInst.GetDKGPrivateKey(1)
    s.Require().Equal(err.Error(), ErrDKGPrivateKeyDoesNotExist.Error())
    // Put it.
    s.Require().NoError(dbInst.PutDKGPrivateKey(1, *p))
    // Put it again, should not success.
    err = dbInst.PutDKGPrivateKey(1, *p)
    s.Require().Equal(err.Error(), ErrDKGPrivateKeyExists.Error())
    // Get it back.
    tmpPrv, err := dbInst.GetDKGPrivateKey(1)
    s.Require().NoError(err)
    s.Require().Equal(bytes.Compare(p.Bytes(), tmpPrv.Bytes()), 0)
}

func TestMemBackedDB(t *testing.T) {
    suite.Run(t, new(MemBackedDBTestSuite))
}