path: root/eth/downloader/downloader_test.go

package downloader

import (
    "encoding/binary"
    "math/big"
    "testing"
    "time"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/core/types"
)

var knownHash = common.Hash{1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0}

func createHashes(start, amount int) (hashes []common.Hash) {
    hashes = make([]common.Hash, amount+1)
    hashes[len(hashes)-1] = knownHash

    for i := range hashes[:len(hashes)-1] {
        binary.BigEndian.PutUint64(hashes[i][:8], uint64(i+2))
    }

    return
}

func createBlock(i int, prevHash, hash common.Hash) *types.Block {
    header := &types.Header{Number: big.NewInt(int64(i))}
    block := types.NewBlockWithHeader(header)
    block.HeaderHash = hash
    block.ParentHeaderHash = knownHash
    return block
}

func createBlocksFromHashes(hashes []common.Hash) map[common.Hash]*types.Block {
    blocks := make(map[common.Hash]*types.Block)

    for i, hash := range hashes {
        blocks[hash] = createBlock(len(hashes)-i, knownHash, hash)
    }

    return blocks
}

type downloadTester struct {
    downloader *Downloader
    hashes     []common.Hash
    blocks     map[common.Hash]*types.Block
    t          *testing.T
    pcount     int
    done       chan bool
}

func newTester(t *testing.T, hashes []common.Hash, blocks map[common.Hash]*types.Block) *downloadTester {
    tester := &downloadTester{t: t, hashes: hashes, blocks: blocks, done: make(chan bool)}
    downloader := New(tester.hasBlock, tester.getBlock)
    tester.downloader = downloader

    return tester
}

func (dl *downloadTester) hasBlock(hash common.Hash) bool {
    if knownHash == hash {
        return true
    }
    return false
}

func (dl *downloadTester) getBlock(hash common.Hash) *types.Block {
    return dl.blocks[knownHash]
}

func (dl *downloadTester) getHashes(hash common.Hash) error {
    dl.downloader.hashCh <- dl.hashes
    return nil
}

func (dl *downloadTester) getBlocks(id string) func([]common.Hash) error {
    return func(hashes []common.Hash) error {
        blocks := make([]*types.Block, len(hashes))
        for i, hash := range hashes {
            blocks[i] = dl.blocks[hash]
        }

        go dl.downloader.DeliverChunk(id, blocks)

        return nil
    }
}

func (dl *downloadTester) newPeer(id string, td *big.Int, hash common.Hash) {
    dl.pcount++

    dl.downloader.RegisterPeer(id, hash, dl.getHashes, dl.getBlocks(id))
}

func (dl *downloadTester) badBlocksPeer(id string, td *big.Int, hash common.Hash) {
    dl.pcount++

    // This bad peer never returns any blocks
    dl.downloader.RegisterPeer(id, hash, dl.getHashes, func([]common.Hash) error {
        return nil
    })
}

func TestDownload(t *testing.T) {
    minDesiredPeerCount = 4
    blockTtl = 1 * time.Second

    targetBlocks := 1000
    hashes := createHashes(0, targetBlocks)
    blocks := createBlocksFromHashes(hashes)
    tester := newTester(t, hashes, blocks)

    tester.newPeer("peer1", big.NewInt(10000), hashes[0])
    tester.newPeer("peer2", big.NewInt(0), common.Hash{})
    tester.badBlocksPeer("peer3", big.NewInt(0), common.Hash{})
    tester.badBlocksPeer("peer4", big.NewInt(0), common.Hash{})

    err := tester.downloader.Synchronise("peer1", hashes[0])
    if err != nil {
        t.Error("download error", err)
    }

    inqueue := len(tester.downloader.queue.blocks)
    if inqueue != targetBlocks {
        t.Error("expected", targetBlocks, "have", inqueue)
    }
}

func TestMissing(t *testing.T) {
    targetBlocks := 1000
    hashes := createHashes(0, 1000)
    extraHashes := createHashes(1001, 1003)
    blocks := createBlocksFromHashes(append(extraHashes, hashes...))
    tester := newTester(t, hashes, blocks)

    tester.newPeer("peer1", big.NewInt(10000), hashes[len(hashes)-1])

    hashes = append(extraHashes, hashes[:len(hashes)-1]...)
    tester.newPeer("peer2", big.NewInt(0), common.Hash{})

    err := tester.downloader.Synchronise("peer1", hashes[0])
    if err != nil {
        t.Error("download error", err)
    }

    inqueue := len(tester.downloader.queue.blocks)
    if inqueue != targetBlocks {
        t.Error("expected", targetBlocks, "have", inqueue)
    }
}

func TestTaking(t *testing.T) {
    minDesiredPeerCount = 4
    blockTtl = 1 * time.Second

    targetBlocks := 1000
    hashes := createHashes(0, targetBlocks)
    blocks := createBlocksFromHashes(hashes)
    tester := newTester(t, hashes, blocks)

    tester.newPeer("peer1", big.NewInt(10000), hashes[0])
    tester.newPeer("peer2", big.NewInt(0), common.Hash{})
    tester.badBlocksPeer("peer3", big.NewInt(0), common.Hash{})
    tester.badBlocksPeer("peer4", big.NewInt(0), common.Hash{})

    err := tester.downloader.Synchronise("peer1", hashes[0])
    if err != nil {
        t.Error("download error", err)
    }

    bs1 := tester.downloader.TakeBlocks()
    if len(bs1) != 1000 {
        t.Error("expected to take 1000, got", len(bs1))
    }
}