Browse Source
evidence: refactor evidence mocks throughout packages (#4787)
Predominantly following the discussions regarding the conventions of using mocks, I have decided to revert back to the previous state where mocks were specialized and stored in the separate packages that used them rather then have a generalized mock in the evidence package. This also was a problem as the state package were running tests too slow and occasionally timing out unnecessarily. For the replay file I renamed mockEvidencePool to emptyEvidencePool to illustrate that it was intentionally like this and not give the impression that testing software was being used in production Closes: #4786pull/4794/head
Callum Waters
5 years ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
13 changed files with 141 additions and 167 deletions
Unified View
Diff Options
-
+1 -2blockchain/v0/reactor_test.go
-
+1 -2blockchain/v1/reactor_test.go
-
+2 -3blockchain/v2/reactor_test.go
-
+1 -2consensus/common_test.go
-
+9 -2consensus/replay.go
-
+1 -2consensus/replay_file.go
-
+1 -2consensus/replay_test.go
-
+1 -2consensus/wal_generator.go
-
+0 -124evidence/mock/pool_mock.go
-
+3 -4state/execution_test.go
-
+78 -0state/mocks/evidence_pool.go
-
+10 -1state/services.go
-
+33 -21state/validation_test.go
+ 1
- 2
blockchain/v0/reactor_test.go
View File
+ 1
- 2
blockchain/v1/reactor_test.go
View File
+ 2
- 3
blockchain/v2/reactor_test.go
View File
+ 1
- 2
consensus/common_test.go
View File
+ 9
- 2
consensus/replay.go
View File
+ 1
- 2
consensus/replay_file.go
View File
+ 1
- 2
consensus/replay_test.go
View File
+ 1
- 2
consensus/wal_generator.go
View File
+ 0
- 124
evidence/mock/pool_mock.go
View File
| @ -1,124 +0,0 @@ | |||||
| package mock | |||||
| import ( | |||||
| "time" | |||||
| sm "github.com/tendermint/tendermint/state" | |||||
| "github.com/tendermint/tendermint/types" | |||||
| ) | |||||
| // A quick and easy in-memory mock implementation of the evidence pool configured with both the standard exposed | |||||
| // functions and extra helper function to set up, operate and ultimately imitate the evidence pool in a testing | |||||
| // environment. Note: this mock does no validation. Do not test with large amounts of evidence | |||||
| type EvidencePool struct { | |||||
| PendingEvidenceList []types.Evidence | |||||
| CommittedEvidenceList []types.Evidence | |||||
| ExpirationAgeTime time.Duration | |||||
| ExpirationAgeBlock int64 | |||||
| BlockHeight int64 | |||||
| BlockTime time.Time | |||||
| } | |||||
| // ------------------------ INSTANTIATION METHODS -------------------------------------- | |||||
| func NewEvidencePool(height, expiryHeight int64, currentTime time.Time, expiryTime time.Duration) *EvidencePool { | |||||
| return &EvidencePool{ | |||||
| []types.Evidence{}, | |||||
| []types.Evidence{}, | |||||
| expiryTime, | |||||
| expiryHeight, | |||||
| height, | |||||
| currentTime, | |||||
| } | |||||
| } | |||||
| func NewDefaultEvidencePool() *EvidencePool { | |||||
| return NewEvidencePool(1, 1, time.Now(), time.Millisecond) | |||||
| } | |||||
| // ----------------------- EVIDENCE POOL PUBLIC METHODS -------------------------------- | |||||
| func (p *EvidencePool) PendingEvidence(maxNum int64) []types.Evidence { | |||||
| if maxNum == -1 || maxNum >= int64(len(p.PendingEvidenceList)) { | |||||
| return p.PendingEvidenceList | |||||
| } | |||||
| return p.PendingEvidenceList[:maxNum] | |||||
| } | |||||
| func (p *EvidencePool) AddEvidence(evidence types.Evidence) error { | |||||
| p.PendingEvidenceList = append(p.PendingEvidenceList, evidence) | |||||
| return nil | |||||
| } | |||||
| func (p *EvidencePool) Update(block *types.Block, state sm.State) { | |||||
| p.BlockHeight = block.Height | |||||
| p.BlockTime = block.Time | |||||
| p.MarkEvidenceAsCommitted(block.Height, block.Time, block.Evidence.Evidence) | |||||
| p.RemoveExpiredEvidence() | |||||
| } | |||||
| func (p *EvidencePool) MarkEvidenceAsCommitted(height int64, lastBlockTime time.Time, evidence []types.Evidence) { | |||||
| for _, ev := range evidence { | |||||
| if p.IsPending(ev) { | |||||
| p.RemovePendingEvidence(ev) | |||||
| } | |||||
| p.CommittedEvidenceList = append(p.CommittedEvidenceList, ev) | |||||
| } | |||||
| } | |||||
| func (p *EvidencePool) IsPending(evidence types.Evidence) bool { | |||||
| for _, ev := range p.PendingEvidenceList { | |||||
| if ev.Equal(evidence) { | |||||
| return true | |||||
| } | |||||
| } | |||||
| return false | |||||
| } | |||||
| func (p *EvidencePool) IsCommitted(evidence types.Evidence) bool { | |||||
| for _, ev := range p.CommittedEvidenceList { | |||||
| if ev.Equal(evidence) { | |||||
| return true | |||||
| } | |||||
| } | |||||
| return false | |||||
| } | |||||
| func (p *EvidencePool) IsExpired(evidence types.Evidence) bool { | |||||
| return evidence.Height()+p.ExpirationAgeBlock < p.BlockHeight && | |||||
| evidence.Time().Add(p.ExpirationAgeTime).Before(p.BlockTime) | |||||
| } | |||||
| // ------------------------------- HELPER METHODS -------------------------------------- | |||||
| func (p *EvidencePool) RemovePendingEvidence(evidence types.Evidence) { | |||||
| for idx, ev := range p.PendingEvidenceList { | |||||
| if ev.Equal(evidence) { | |||||
| p.PendingEvidenceList[idx] = p.PendingEvidenceList[len(p.PendingEvidenceList)-1] | |||||
| p.PendingEvidenceList = p.PendingEvidenceList[:len(p.PendingEvidenceList)-1] | |||||
| return | |||||
| } | |||||
| } | |||||
| } | |||||
| func (p *EvidencePool) RemoveExpiredEvidence() { | |||||
| for _, evidence := range p.PendingEvidenceList { | |||||
| if p.IsExpired(evidence) { | |||||
| p.RemovePendingEvidence(evidence) | |||||
| } | |||||
| } | |||||
| } | |||||
| func (p *EvidencePool) AddMockEvidence(height int64, address []byte) types.Evidence { | |||||
| mock := types.MockEvidence{ | |||||
| EvidenceHeight: height, | |||||
| EvidenceTime: p.BlockTime, | |||||
| EvidenceAddress: address, | |||||
| } | |||||
| _ = p.AddEvidence(mock) | |||||
| return mock | |||||
| } | |||||
| func (p *EvidencePool) CommitEvidence(evidence types.Evidence) { | |||||
| p.MarkEvidenceAsCommitted(evidence.Height(), evidence.Time(), []types.Evidence{evidence}) | |||||
| } | |||||
+ 3
- 4
state/execution_test.go
View File
+ 78
- 0
state/mocks/evidence_pool.go
View File
| @ -0,0 +1,78 @@ | |||||
| // Code generated by mockery v1.0.0. DO NOT EDIT. | |||||
| package mocks | |||||
| import ( | |||||
| mock "github.com/stretchr/testify/mock" | |||||
| state "github.com/tendermint/tendermint/state" | |||||
| types "github.com/tendermint/tendermint/types" | |||||
| ) | |||||
| // EvidencePool is an autogenerated mock type for the EvidencePool type | |||||
| type EvidencePool struct { | |||||
| mock.Mock | |||||
| } | |||||
| // AddEvidence provides a mock function with given fields: _a0 | |||||
| func (_m *EvidencePool) AddEvidence(_a0 types.Evidence) error { | |||||
| ret := _m.Called(_a0) | |||||
| var r0 error | |||||
| if rf, ok := ret.Get(0).(func(types.Evidence) error); ok { | |||||
| r0 = rf(_a0) | |||||
| } else { | |||||
| r0 = ret.Error(0) | |||||
| } | |||||
| return r0 | |||||
| } | |||||
| // IsCommitted provides a mock function with given fields: _a0 | |||||
| func (_m *EvidencePool) IsCommitted(_a0 types.Evidence) bool { | |||||
| ret := _m.Called(_a0) | |||||
| var r0 bool | |||||
| if rf, ok := ret.Get(0).(func(types.Evidence) bool); ok { | |||||
| r0 = rf(_a0) | |||||
| } else { | |||||
| r0 = ret.Get(0).(bool) | |||||
| } | |||||
| return r0 | |||||
| } | |||||
| // IsPending provides a mock function with given fields: _a0 | |||||
| func (_m *EvidencePool) IsPending(_a0 types.Evidence) bool { | |||||
| ret := _m.Called(_a0) | |||||
| var r0 bool | |||||
| if rf, ok := ret.Get(0).(func(types.Evidence) bool); ok { | |||||
| r0 = rf(_a0) | |||||
| } else { | |||||
| r0 = ret.Get(0).(bool) | |||||
| } | |||||
| return r0 | |||||
| } | |||||
| // PendingEvidence provides a mock function with given fields: _a0 | |||||
| func (_m *EvidencePool) PendingEvidence(_a0 int64) []types.Evidence { | |||||
| ret := _m.Called(_a0) | |||||
| var r0 []types.Evidence | |||||
| if rf, ok := ret.Get(0).(func(int64) []types.Evidence); ok { | |||||
| r0 = rf(_a0) | |||||
| } else { | |||||
| if ret.Get(0) != nil { | |||||
| r0 = ret.Get(0).([]types.Evidence) | |||||
| } | |||||
| } | |||||
| return r0 | |||||
| } | |||||
| // Update provides a mock function with given fields: _a0, _a1 | |||||
| func (_m *EvidencePool) Update(_a0 *types.Block, _a1 state.State) { | |||||
| _m.Called(_a0, _a1) | |||||
| } | |||||