From a47d0a64787c825fe5efee465090bc11021be968 Mon Sep 17 00:00:00 2001
From: Silas Davis <silas@erisindustries.com>
Date: Mon, 12 Sep 2016 21:37:59 +0100
Subject: [PATCH] Fix some issues with waitForEvent and friends
---
rpc/tendermint/test/tests.go | 11 ++++++-----
rpc/tendermint/test/ws_helpers.go | 32 +++++++++++++++++++++----------
2 files changed, 28 insertions(+), 15 deletions(-)
diff --git a/rpc/tendermint/test/tests.go b/rpc/tendermint/test/tests.go
index 56ea89b2..43769b4b 100644
--- a/rpc/tendermint/test/tests.go
+++ b/rpc/tendermint/test/tests.go
@@ -202,7 +202,7 @@ func testNameReg(t *testing.T, typ string) {
assert.Equal(t, user[0].Address, entry.Owner)
// update the data as the owner, make sure still there
- numDesiredBlocks = int64(3)
+ numDesiredBlocks = int64(5)
const updatedData = "these are amongst the things I wish to bestow upon the youth of generations come: a safe supply of honey, and a better money. For what else shall they need"
amt = fee + numDesiredBlocks*txs.NameByteCostMultiplier*txs.NameBlockCostMultiplier*txs.NameBaseCost(name, updatedData)
tx = makeDefaultNameTx(t, typ, name, updatedData, amt, fee)
@@ -220,9 +220,11 @@ func testNameReg(t *testing.T, typ string) {
_, err := broadcastTxAndWaitForBlock(t, typ, wsc, tx)
assert.Error(t, err, "Expected error when updating someone else's unexpired"+
" name registry entry")
+ assert.Contains(t, err.Error(), "permission denied", "Error should be " +
+ "permission denied")
// Wait a couple of blocks to make sure name registration expires
- waitNBlocks(t, wsc, 2)
+ waitNBlocks(t, wsc, 3)
//now the entry should be expired, so we can update as non owner
const data2 = "this is not my beautiful house"
@@ -309,7 +311,6 @@ func testBlockchainInfo(t *testing.T, typ string) {
wsc := newWSClient(t)
nBlocks := 4
waitNBlocks(t, wsc, nBlocks)
- time.Sleep(time.Millisecond * 200)
resp, err := edbcli.BlockchainInfo(client, 0, 0)
if err != nil {
@@ -319,8 +320,8 @@ func testBlockchainInfo(t *testing.T, typ string) {
// NewBlock after saving a block
// see https://github.com/tendermint/tendermint/issues/273
//assert.Equal(t, 4, resp.LastHeight, "Last height should be 4 after waiting for first 4 blocks")
- assert.Equal(t, nBlocks, len(resp.BlockMetas),
- "Should see 4 BlockMetas after waiting for first 4 blocks")
+ assert.True(t, nBlocks <= len(resp.BlockMetas),
+ "Should see at least 4 BlockMetas after waiting for first 4 blocks")
lastBlockHash := resp.BlockMetas[nBlocks-1].Hash
for i := nBlocks - 2; i >= 0; i-- {
diff --git a/rpc/tendermint/test/ws_helpers.go b/rpc/tendermint/test/ws_helpers.go
index a13635da..1c71a72b 100644
--- a/rpc/tendermint/test/ws_helpers.go
+++ b/rpc/tendermint/test/ws_helpers.go
@@ -81,7 +81,12 @@ func broadcastTxAndWaitForBlock(t *testing.T, typ string, wsc *client.WSClient,
initialHeight = block.Height
return false
} else {
- return block.Height > initialHeight
+ // TODO: [Silas] remove the + 1 here. It is a workaround for the fact
+ // that tendermint fires the NewBlock event before it has finalised its
+ // state updates, so we have to wait for the block after the block we
+ // want in order for the Tx to be genuinely final.
+ // This should be addressed by: https://github.com/tendermint/tendermint/pull/265
+ return block.Height > initialHeight + 1
}
},
func() {
@@ -131,10 +136,11 @@ func subscribeAndWaitForNext(t *testing.T, wsc *client.WSClient, event string,
// waitForEvent will fail the test.
func waitForEvent(t *testing.T, wsc *client.WSClient, eventid string,
runner func(),
- eventDataChecker func(string, txs.EventData) (bool, error)) waitForEventError {
+ eventDataChecker func(string, txs.EventData) (bool, error)) waitForEventResult {
// go routine to wait for websocket msg
- goodCh := make(chan txs.EventData)
+ eventsCh := make(chan txs.EventData)
+ shutdownEventsCh := make(chan bool, 1)
errCh := make(chan error)
// do stuff (transactions)
@@ -146,6 +152,8 @@ func waitForEvent(t *testing.T, wsc *client.WSClient, eventid string,
LOOP:
for {
select {
+ case <-shutdownEventsCh:
+ break LOOP
case r := <-wsc.ResultsCh:
result := new(ctypes.ErisDBResult)
wire.ReadJSONPtr(result, r, &err)
@@ -155,7 +163,8 @@ func waitForEvent(t *testing.T, wsc *client.WSClient, eventid string,
}
event, ok := (*result).(*ctypes.ResultEvent)
if ok && event.Event == eventid {
- goodCh <- event.Data
+ // Keep feeding events
+ eventsCh <- event.Data
}
case err := <-wsc.ErrorsCh:
errCh <- err
@@ -166,19 +175,22 @@ func waitForEvent(t *testing.T, wsc *client.WSClient, eventid string,
}
}()
+ // Don't block up WSClient
+ defer func() { shutdownEventsCh <- true }()
+
for {
select {
// wait for an event or timeout
- case <-time.After(timeoutSeconds * time.Second*3):
- return waitForEventError{timeout: true}
- case eventData := <-goodCh:
+ case <-time.After(timeoutSeconds * time.Second):
+ return waitForEventResult{timeout: true}
+ case eventData := <-eventsCh:
// run the check
stopWaiting, err := eventDataChecker(eventid, eventData)
if err != nil {
t.Fatal(err) // Show the stack trace.
}
if stopWaiting {
- return waitForEventError{}
+ return waitForEventResult{}
}
case err := <-errCh:
t.Fatal(err)
@@ -186,12 +198,12 @@ func waitForEvent(t *testing.T, wsc *client.WSClient, eventid string,
}
}
-type waitForEventError struct {
+type waitForEventResult struct {
error
timeout bool
}
-func (err waitForEventError) Timeout() bool {
+func (err waitForEventResult) Timeout() bool {
return err.timeout
}
--
GitLab