path: root/p2p/discv5/database_test.go

// Copyright 2015 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum 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 go-ethereum 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 go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package discv5

import (
    "bytes"
    "io/ioutil"
    "net"
    "os"
    "path/filepath"
    "reflect"
    "testing"
    "time"
)

var nodeDBKeyTests = []struct {
    id    NodeID
    field string
    key   []byte
}{
    {
        id:    NodeID{},
        field: "version",
        key:   []byte{0x76, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e}, // field
    },
    {
        id:    MustHexID("0x1dd9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439"),
        field: ":discover",
        key: []byte{0x6e, 0x3a, // prefix
            0x1d, 0xd9, 0xd6, 0x5c, 0x45, 0x52, 0xb5, 0xeb, // node id
            0x43, 0xd5, 0xad, 0x55, 0xa2, 0xee, 0x3f, 0x56, //
            0xc6, 0xcb, 0xc1, 0xc6, 0x4a, 0x5c, 0x8d, 0x65, //
            0x9f, 0x51, 0xfc, 0xd5, 0x1b, 0xac, 0xe2, 0x43, //
            0x51, 0x23, 0x2b, 0x8d, 0x78, 0x21, 0x61, 0x7d, //
            0x2b, 0x29, 0xb5, 0x4b, 0x81, 0xcd, 0xef, 0xb9, //
            0xb3, 0xe9, 0xc3, 0x7d, 0x7f, 0xd5, 0xf6, 0x32, //
            0x70, 0xbc, 0xc9, 0xe1, 0xa6, 0xf6, 0xa4, 0x39, //
            0x3a, 0x64, 0x69, 0x73, 0x63, 0x6f, 0x76, 0x65, 0x72, // field
        },
    },
}

func TestNodeDBKeys(t *testing.T) {
    for i, tt := range nodeDBKeyTests {
        if key := makeKey(tt.id, tt.field); !bytes.Equal(key, tt.key) {
            t.Errorf("make test %d: key mismatch: have 0x%x, want 0x%x", i, key, tt.key)
        }
        id, field := splitKey(tt.key)
        if !bytes.Equal(id[:], tt.id[:]) {
            t.Errorf("split test %d: id mismatch: have 0x%x, want 0x%x", i, id, tt.id)
        }
        if field != tt.field {
            t.Errorf("split test %d: field mismatch: have 0x%x, want 0x%x", i, field, tt.field)
        }
    }
}

var nodeDBInt64Tests = []struct {
    key   []byte
    value int64
}{
    {key: []byte{0x01}, value: 1},
    {key: []byte{0x02}, value: 2},
    {key: []byte{0x03}, value: 3},
}

func TestNodeDBInt64(t *testing.T) {
    db, _ := newNodeDB("", Version, NodeID{})
    defer db.close()

    tests := nodeDBInt64Tests
    for i := 0; i < len(tests); i++ {
        // Insert the next value
        if err := db.storeInt64(tests[i].key, tests[i].value); err != nil {
            t.Errorf("test %d: failed to store value: %v", i, err)
        }
        // Check all existing and non existing values
        for j := 0; j < len(tests); j++ {
            num := db.fetchInt64(tests[j].key)
            switch {
            case j <= i && num != tests[j].value:
                t.Errorf("test %d, item %d: value mismatch: have %v, want %v", i, j, num, tests[j].value)
            case j > i && num != 0:
                t.Errorf("test %d, item %d: value mismatch: have %v, want %v", i, j, num, 0)
            }
        }
    }
}

func TestNodeDBFetchStore(t *testing.T) {
    node := NewNode(
        MustHexID("0x1dd9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439"),
        net.IP{192, 168, 0, 1},
        30303,
        30303,
    )
    inst := time.Now()
    num := 314

    db, _ := newNodeDB("", Version, NodeID{})
    defer db.close()

    // Check fetch/store operations on a node ping object
    if stored := db.lastPing(node.ID); stored.Unix() != 0 {
        t.Errorf("ping: non-existing object: %v", stored)
    }
    if err := db.updateLastPing(node.ID, inst); err != nil {
        t.Errorf("ping: failed to update: %v", err)
    }
    if stored := db.lastPing(node.ID); stored.Unix() != inst.Unix() {
        t.Errorf("ping: value mismatch: have %v, want %v", stored, inst)
    }
    // Check fetch/store operations on a node pong object
    if stored := db.lastPong(node.ID); stored.Unix() != 0 {
        t.Errorf("pong: non-existing object: %v", stored)
    }
    if err := db.updateLastPong(node.ID, inst); err != nil {
        t.Errorf("pong: failed to update: %v", err)
    }
    if stored := db.lastPong(node.ID); stored.Unix() != inst.Unix() {
        t.Errorf("pong: value mismatch: have %v, want %v", stored, inst)
    }
    // Check fetch/store operations on a node findnode-failure object
    if stored := db.findFails(node.ID); stored != 0 {
        t.Errorf("find-node fails: non-existing object: %v", stored)
    }
    if err := db.updateFindFails(node.ID, num); err != nil {
        t.Errorf("find-node fails: failed to update: %v", err)
    }
    if stored := db.findFails(node.ID); stored != num {
        t.Errorf("find-node fails: value mismatch: have %v, want %v", stored, num)
    }
    // Check fetch/store operations on an actual node object
    if stored := db.node(node.ID); stored != nil {
        t.Errorf("node: non-existing object: %v", stored)
    }
    if err := db.updateNode(node); err != nil {
        t.Errorf("node: failed to update: %v", err)
    }
    if stored := db.node(node.ID); stored == nil {
        t.Errorf("node: not found")
    } else if !reflect.DeepEqual(stored, node) {
        t.Errorf("node: data mismatch: have %v, want %v", stored, node)
    }
}

var nodeDBSeedQueryNodes = []struct {
    node *Node
    pong time.Time
}{
    // This one should not be in the result set because its last
    // pong time is too far in the past.
    {
        node: NewNode(
            MustHexID("0x84d9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439"),
            net.IP{127, 0, 0, 3},
            30303,
            30303,
        ),
        pong: time.Now().Add(-3 * time.Hour),
    },
    // This one shouldn't be in in the result set because its
    // nodeID is the local node's ID.
    {
        node: NewNode(
            MustHexID("0x57d9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439"),
            net.IP{127, 0, 0, 3},
            30303,
            30303,
        ),
        pong: time.Now().Add(-4 * time.Second),
    },

    // These should be in the result set.
    {
        node: NewNode(
            MustHexID("0x22d9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439"),
            net.IP{127, 0, 0, 1},
            30303,
            30303,
        ),
        pong: time.Now().Add(-2 * time.Second),
    },
    {
        node: NewNode(
            MustHexID("0x44d9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439"),
            net.IP{127, 0, 0, 2},
            30303,
            30303,
        ),
        pong: time.Now().Add(-3 * time.Second),
    },
    {
        node: NewNode(
            MustHexID("0xe2d9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439"),
            net.IP{127, 0, 0, 3},
            30303,
            30303,
        ),
        pong: time.Now().Add(-1 * time.Second),
    },
}

func TestNodeDBSeedQuery(t *testing.T) {
    db, _ := newNodeDB("", Version, nodeDBSeedQueryNodes[1].node.ID)
    defer db.close()

    // Insert a batch of nodes for querying
    for i, seed := range nodeDBSeedQueryNodes {
        if err := db.updateNode(seed.node); err != nil {
            t.Fatalf("node %d: failed to insert: %v", i, err)
        }
        if err := db.updateLastPong(seed.node.ID, seed.pong); err != nil {
            t.Fatalf("node %d: failed to insert lastPong: %v", i, err)
        }
    }

    // Retrieve the entire batch and check for duplicates
    seeds := db.querySeeds(len(nodeDBSeedQueryNodes)*2, time.Hour)
    have := make(map[NodeID]struct{})
    for _, seed := range seeds {
        have[seed.ID] = struct{}{}
    }
    want := make(map[NodeID]struct{})
    for _, seed := range nodeDBSeedQueryNodes[2:] {
        want[seed.node.ID] = struct{}{}
    }
    if len(seeds) != len(want) {
        t.Errorf("seed count mismatch: have %v, want %v", len(seeds), len(want))
    }
    for id, _ := range have {
        if _, ok := want[id]; !ok {
            t.Errorf("extra seed: %v", id)
        }
    }
    for id, _ := range want {
        if _, ok := have[id]; !ok {
            t.Errorf("missing seed: %v", id)
        }
    }
}

func TestNodeDBPersistency(t *testing.T) {
    root, err := ioutil.TempDir("", "nodedb-")
    if err != nil {
        t.Fatalf("failed to create temporary data folder: %v", err)
    }
    defer os.RemoveAll(root)

    var (
        testKey = []byte("somekey")
        testInt = int64(314)
    )

    // Create a persistent database and store some values
    db, err := newNodeDB(filepath.Join(root, "database"), Version, NodeID{})
    if err != nil {
        t.Fatalf("failed to create persistent database: %v", err)
    }
    if err := db.storeInt64(testKey, testInt); err != nil {
        t.Fatalf("failed to store value: %v.", err)
    }
    db.close()

    // Reopen the database and check the value
    db, err = newNodeDB(filepath.Join(root, "database"), Version, NodeID{})
    if err != nil {
        t.Fatalf("failed to open persistent database: %v", err)
    }
    if val := db.fetchInt64(testKey); val != testInt {
        t.Fatalf("value mismatch: have %v, want %v", val, testInt)
    }
    db.close()

    // Change the database version and check flush
    db, err = newNodeDB(filepath.Join(root, "database"), Version+1, NodeID{})
    if err != nil {
        t.Fatalf("failed to open persistent database: %v", err)
    }
    if val := db.fetchInt64(testKey); val != 0 {
        t.Fatalf("value mismatch: have %v, want %v", val, 0)
    }
    db.close()
}

var nodeDBExpirationNodes = []struct {
    node *Node
    pong time.Time
    exp  bool
}{
    {
        node: NewNode(
            MustHexID("0x01d9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439"),
            net.IP{127, 0, 0, 1},
            30303,
            30303,
        ),
        pong: time.Now().Add(-nodeDBNodeExpiration + time.Minute),
        exp:  false,
    }, {
        node: NewNode(
            MustHexID("0x02d9d65c4552b5eb43d5ad55a2ee3f56c6cbc1c64a5c8d659f51fcd51bace24351232b8d7821617d2b29b54b81cdefb9b3e9c37d7fd5f63270bcc9e1a6f6a439"),
            net.IP{127, 0, 0, 2},
            30303,
            30303,
        ),
        pong: time.Now().Add(-nodeDBNodeExpiration - time.Minute),
        exp:  true,
    },
}

func TestNodeDBExpiration(t *testing.T) {
    db, _ := newNodeDB("", Version, NodeID{})
    defer db.close()

    // Add all the test nodes and set their last pong time
    for i, seed := range nodeDBExpirationNodes {
        if err := db.updateNode(seed.node); err != nil {
            t.Fatalf("node %d: failed to insert: %v", i, err)
        }
        if err := db.updateLastPong(seed.node.ID, seed.pong); err != nil {
            t.Fatalf("node %d: failed to update pong: %v", i, err)
        }
    }
    // Expire some of them, and check the rest
    if err := db.expireNodes(); err != nil {
        t.Fatalf("failed to expire nodes: %v", err)
    }
    for i, seed := range nodeDBExpirationNodes {
        node := db.node(seed.node.ID)
        if (node == nil && !seed.exp) || (node != nil && seed.exp) {
            t.Errorf("node %d: expiration mismatch: have %v, want %v", i, node, seed.exp)
        }
    }
}

func TestNodeDBSelfExpiration(t *testing.T) {
    // Find a node in the tests that shouldn't expire, and assign it as self
    var self NodeID
    for _, node := range nodeDBExpirationNodes {
        if !node.exp {
            self = node.node.ID
            break
        }
    }
    db, _ := newNodeDB("", Version, self)
    defer db.close()

    // Add all the test nodes and set their last pong time
    for i, seed := range nodeDBExpirationNodes {
        if err := db.updateNode(seed.node); err != nil {
            t.Fatalf("node %d: failed to insert: %v", i, err)
        }
        if err := db.updateLastPong(seed.node.ID, seed.pong); err != nil {
            t.Fatalf("node %d: failed to update pong: %v", i, err)
        }
    }
    // Expire the nodes and make sure self has been evacuated too
    if err := db.expireNodes(); err != nil {
        t.Fatalf("failed to expire nodes: %v", err)
    }
    node := db.node(self)
    if node != nil {
        t.Errorf("self not evacuated")
    }
}