github.com/tacshi/go-ethereum@v0.0.0-20230616113857-84a434e20921/core/state/iterator_test.go (about)

     1  // Copyright 2016 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package state
    18  
    19  import (
    20  	"testing"
    21  
    22  	"github.com/tacshi/go-ethereum/common"
    23  	"github.com/tacshi/go-ethereum/core/rawdb"
    24  )
    25  
    26  // Tests that the node iterator indeed walks over the entire database contents.
    27  func TestNodeIteratorCoverage(t *testing.T) {
    28  	// Create some arbitrary test state to iterate
    29  	db, sdb, root, _ := makeTestState()
    30  	sdb.TrieDB().Commit(root, false)
    31  
    32  	state, err := New(root, sdb, nil)
    33  	if err != nil {
    34  		t.Fatalf("failed to create state trie at %x: %v", root, err)
    35  	}
    36  	// Gather all the node hashes found by the iterator
    37  	hashes := make(map[common.Hash]struct{})
    38  	for it := NewNodeIterator(state); it.Next(); {
    39  		if it.Hash != (common.Hash{}) {
    40  			hashes[it.Hash] = struct{}{}
    41  		}
    42  	}
    43  	// Check in-disk nodes
    44  	var (
    45  		seenNodes = make(map[common.Hash]struct{})
    46  		seenCodes = make(map[common.Hash]struct{})
    47  	)
    48  	it := db.NewIterator(nil, nil)
    49  	for it.Next() {
    50  		ok, hash := isTrieNode(sdb.TrieDB().Scheme(), it.Key(), it.Value())
    51  		if !ok {
    52  			continue
    53  		}
    54  		seenNodes[hash] = struct{}{}
    55  	}
    56  	it.Release()
    57  
    58  	// Check in-disk codes
    59  	it = db.NewIterator(nil, nil)
    60  	for it.Next() {
    61  		ok, hash := rawdb.IsCodeKey(it.Key())
    62  		if !ok {
    63  			continue
    64  		}
    65  		if _, ok := hashes[common.BytesToHash(hash)]; !ok {
    66  			t.Errorf("state entry not reported %x", it.Key())
    67  		}
    68  		seenCodes[common.BytesToHash(hash)] = struct{}{}
    69  	}
    70  	it.Release()
    71  
    72  	// Cross check the iterated hashes and the database/nodepool content
    73  	for hash := range hashes {
    74  		_, ok := seenNodes[hash]
    75  		if !ok {
    76  			_, ok = seenCodes[hash]
    77  		}
    78  		if !ok {
    79  			t.Errorf("failed to retrieve reported node %x", hash)
    80  		}
    81  	}
    82  }
    83  
    84  // isTrieNode is a helper function which reports if the provided
    85  // database entry belongs to a trie node or not.
    86  func isTrieNode(scheme string, key, val []byte) (bool, common.Hash) {
    87  	if scheme == rawdb.HashScheme {
    88  		if len(key) == common.HashLength {
    89  			return true, common.BytesToHash(key)
    90  		}
    91  	}
    92  	return false, common.Hash{}
    93  }