8d04154691
* swarm/network/simulation: test cases refactored * swarm/pss: minor refactoring * swarm/simulation: UploadSnapshot updated * swarm/network: style fix * swarm/pss: bugfix
322 lines
9.5 KiB
Go
322 lines
9.5 KiB
Go
// Copyright 2018 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 stream
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"sync"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/ethereum/go-ethereum/node"
|
|
"github.com/ethereum/go-ethereum/p2p/enode"
|
|
"github.com/ethereum/go-ethereum/p2p/simulations/adapters"
|
|
"github.com/ethereum/go-ethereum/swarm/log"
|
|
"github.com/ethereum/go-ethereum/swarm/network/simulation"
|
|
"github.com/ethereum/go-ethereum/swarm/state"
|
|
"github.com/ethereum/go-ethereum/swarm/storage"
|
|
"github.com/ethereum/go-ethereum/swarm/testutil"
|
|
)
|
|
|
|
//constants for random file generation
|
|
const (
|
|
minFileSize = 2
|
|
maxFileSize = 40
|
|
)
|
|
|
|
//This test is a retrieval test for nodes.
|
|
//A configurable number of nodes can be
|
|
//provided to the test.
|
|
//Files are uploaded to nodes, other nodes try to retrieve the file
|
|
//Number of nodes can be provided via commandline too.
|
|
func TestFileRetrieval(t *testing.T) {
|
|
var nodeCount []int
|
|
|
|
if *nodes != 0 {
|
|
nodeCount = []int{*nodes}
|
|
} else {
|
|
nodeCount = []int{16}
|
|
|
|
if *longrunning {
|
|
nodeCount = append(nodeCount, 32, 64)
|
|
} else if testutil.RaceEnabled {
|
|
nodeCount = []int{4}
|
|
}
|
|
|
|
}
|
|
|
|
for _, nc := range nodeCount {
|
|
if err := runFileRetrievalTest(nc); err != nil {
|
|
t.Error(err)
|
|
}
|
|
}
|
|
}
|
|
|
|
//This test is a retrieval test for nodes.
|
|
//One node is randomly selected to be the pivot node.
|
|
//A configurable number of chunks and nodes can be
|
|
//provided to the test, the number of chunks is uploaded
|
|
//to the pivot node and other nodes try to retrieve the chunk(s).
|
|
//Number of chunks and nodes can be provided via commandline too.
|
|
func TestRetrieval(t *testing.T) {
|
|
//if nodes/chunks have been provided via commandline,
|
|
//run the tests with these values
|
|
if *nodes != 0 && *chunks != 0 {
|
|
err := runRetrievalTest(t, *chunks, *nodes)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
} else {
|
|
nodeCnt := []int{16}
|
|
chnkCnt := []int{32}
|
|
|
|
if *longrunning {
|
|
nodeCnt = []int{16, 32, 64}
|
|
chnkCnt = []int{4, 32, 256}
|
|
} else if testutil.RaceEnabled {
|
|
nodeCnt = []int{4}
|
|
chnkCnt = []int{4}
|
|
}
|
|
|
|
for _, n := range nodeCnt {
|
|
for _, c := range chnkCnt {
|
|
t.Run(fmt.Sprintf("TestRetrieval_%d_%d", n, c), func(t *testing.T) {
|
|
err := runRetrievalTest(t, c, n)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
var retrievalSimServiceMap = map[string]simulation.ServiceFunc{
|
|
"streamer": func(ctx *adapters.ServiceContext, bucket *sync.Map) (s node.Service, cleanup func(), err error) {
|
|
addr, netStore, delivery, clean, err := newNetStoreAndDelivery(ctx, bucket)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
syncUpdateDelay := 1 * time.Second
|
|
if *longrunning {
|
|
syncUpdateDelay = 3 * time.Second
|
|
}
|
|
|
|
r := NewRegistry(addr.ID(), delivery, netStore, state.NewInmemoryStore(), &RegistryOptions{
|
|
Retrieval: RetrievalEnabled,
|
|
Syncing: SyncingAutoSubscribe,
|
|
SyncUpdateDelay: syncUpdateDelay,
|
|
}, nil)
|
|
|
|
cleanup = func() {
|
|
r.Close()
|
|
clean()
|
|
}
|
|
|
|
return r, cleanup, nil
|
|
},
|
|
}
|
|
|
|
/*
|
|
The test loads a snapshot file to construct the swarm network,
|
|
assuming that the snapshot file identifies a healthy
|
|
kademlia network. Nevertheless a health check runs in the
|
|
simulation's `action` function.
|
|
|
|
The snapshot should have 'streamer' in its service list.
|
|
*/
|
|
func runFileRetrievalTest(nodeCount int) error {
|
|
sim := simulation.New(retrievalSimServiceMap)
|
|
defer sim.Close()
|
|
|
|
log.Info("Initializing test config", "node count", nodeCount)
|
|
|
|
conf := &synctestConfig{}
|
|
//map of discover ID to indexes of chunks expected at that ID
|
|
conf.idToChunksMap = make(map[enode.ID][]int)
|
|
//map of overlay address to discover ID
|
|
conf.addrToIDMap = make(map[string]enode.ID)
|
|
//array where the generated chunk hashes will be stored
|
|
conf.hashes = make([]storage.Address, 0)
|
|
|
|
ctx, cancelSimRun := context.WithTimeout(context.Background(), 3*time.Minute)
|
|
defer cancelSimRun()
|
|
|
|
filename := fmt.Sprintf("testing/snapshot_%d.json", nodeCount)
|
|
err := sim.UploadSnapshot(ctx, filename)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
log.Info("Starting simulation")
|
|
|
|
result := sim.Run(ctx, func(ctx context.Context, sim *simulation.Simulation) error {
|
|
nodeIDs := sim.UpNodeIDs()
|
|
for _, n := range nodeIDs {
|
|
//get the kademlia overlay address from this ID
|
|
a := n.Bytes()
|
|
//append it to the array of all overlay addresses
|
|
conf.addrs = append(conf.addrs, a)
|
|
//the proximity calculation is on overlay addr,
|
|
//the p2p/simulations check func triggers on enode.ID,
|
|
//so we need to know which overlay addr maps to which nodeID
|
|
conf.addrToIDMap[string(a)] = n
|
|
}
|
|
|
|
//an array for the random files
|
|
var randomFiles []string
|
|
//channel to signal when the upload has finished
|
|
//uploadFinished := make(chan struct{})
|
|
//channel to trigger new node checks
|
|
|
|
conf.hashes, randomFiles, err = uploadFilesToNodes(sim)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
log.Info("network healthy, start file checks")
|
|
|
|
// File retrieval check is repeated until all uploaded files are retrieved from all nodes
|
|
// or until the timeout is reached.
|
|
REPEAT:
|
|
for {
|
|
for _, id := range nodeIDs {
|
|
//for each expected file, check if it is in the local store
|
|
item, ok := sim.NodeItem(id, bucketKeyFileStore)
|
|
if !ok {
|
|
return fmt.Errorf("No filestore")
|
|
}
|
|
fileStore := item.(*storage.FileStore)
|
|
//check all chunks
|
|
for i, hash := range conf.hashes {
|
|
reader, _ := fileStore.Retrieve(context.TODO(), hash)
|
|
//check that we can read the file size and that it corresponds to the generated file size
|
|
if s, err := reader.Size(ctx, nil); err != nil || s != int64(len(randomFiles[i])) {
|
|
log.Debug("Retrieve error", "err", err, "hash", hash, "nodeId", id)
|
|
time.Sleep(500 * time.Millisecond)
|
|
continue REPEAT
|
|
}
|
|
log.Debug(fmt.Sprintf("File with root hash %x successfully retrieved", hash))
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
})
|
|
|
|
log.Info("Simulation terminated")
|
|
|
|
if result.Error != nil {
|
|
return result.Error
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
/*
|
|
The test generates the given number of chunks.
|
|
|
|
The test loads a snapshot file to construct the swarm network,
|
|
assuming that the snapshot file identifies a healthy
|
|
kademlia network. Nevertheless a health check runs in the
|
|
simulation's `action` function.
|
|
|
|
The snapshot should have 'streamer' in its service list.
|
|
*/
|
|
func runRetrievalTest(t *testing.T, chunkCount int, nodeCount int) error {
|
|
t.Helper()
|
|
sim := simulation.New(retrievalSimServiceMap)
|
|
defer sim.Close()
|
|
|
|
conf := &synctestConfig{}
|
|
//map of discover ID to indexes of chunks expected at that ID
|
|
conf.idToChunksMap = make(map[enode.ID][]int)
|
|
//map of overlay address to discover ID
|
|
conf.addrToIDMap = make(map[string]enode.ID)
|
|
//array where the generated chunk hashes will be stored
|
|
conf.hashes = make([]storage.Address, 0)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), 2*time.Minute)
|
|
defer cancel()
|
|
|
|
filename := fmt.Sprintf("testing/snapshot_%d.json", nodeCount)
|
|
err := sim.UploadSnapshot(ctx, filename)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
result := sim.Run(ctx, func(ctx context.Context, sim *simulation.Simulation) error {
|
|
nodeIDs := sim.UpNodeIDs()
|
|
for _, n := range nodeIDs {
|
|
//get the kademlia overlay address from this ID
|
|
a := n.Bytes()
|
|
//append it to the array of all overlay addresses
|
|
conf.addrs = append(conf.addrs, a)
|
|
//the proximity calculation is on overlay addr,
|
|
//the p2p/simulations check func triggers on enode.ID,
|
|
//so we need to know which overlay addr maps to which nodeID
|
|
conf.addrToIDMap[string(a)] = n
|
|
}
|
|
|
|
//this is the node selected for upload
|
|
node := sim.Net.GetRandomUpNode()
|
|
item, ok := sim.NodeItem(node.ID(), bucketKeyStore)
|
|
if !ok {
|
|
return fmt.Errorf("No localstore")
|
|
}
|
|
lstore := item.(*storage.LocalStore)
|
|
conf.hashes, err = uploadFileToSingleNodeStore(node.ID(), chunkCount, lstore)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// File retrieval check is repeated until all uploaded files are retrieved from all nodes
|
|
// or until the timeout is reached.
|
|
REPEAT:
|
|
for {
|
|
for _, id := range nodeIDs {
|
|
//for each expected chunk, check if it is in the local store
|
|
//check on the node's FileStore (netstore)
|
|
item, ok := sim.NodeItem(id, bucketKeyFileStore)
|
|
if !ok {
|
|
return fmt.Errorf("No filestore")
|
|
}
|
|
fileStore := item.(*storage.FileStore)
|
|
//check all chunks
|
|
for _, hash := range conf.hashes {
|
|
reader, _ := fileStore.Retrieve(context.TODO(), hash)
|
|
//check that we can read the chunk size and that it corresponds to the generated chunk size
|
|
if s, err := reader.Size(ctx, nil); err != nil || s != int64(chunkSize) {
|
|
log.Debug("Retrieve error", "err", err, "hash", hash, "nodeId", id, "size", s)
|
|
time.Sleep(500 * time.Millisecond)
|
|
continue REPEAT
|
|
}
|
|
log.Debug(fmt.Sprintf("Chunk with root hash %x successfully retrieved", hash))
|
|
}
|
|
}
|
|
// all nodes and files found, exit loop and return without error
|
|
return nil
|
|
}
|
|
})
|
|
|
|
if result.Error != nil {
|
|
return result.Error
|
|
}
|
|
|
|
return nil
|
|
}
|