A few minor code inspection fixes (#18393)

* swarm/network: fix code inspection problems

- typos
- redundant import alias

* p2p/simulations: fix code inspection problems

- typos
- unused function parameters
- redundant import alias
- code style issue: snake case

* swarm/network: fix unused method parameters inspections
This commit is contained in:
Ferenc Szabo 2019-01-06 11:58:57 +01:00 committed by Viktor Trón
parent 072c95fb74
commit fe03b76ffe
14 changed files with 42 additions and 40 deletions

View File

@ -46,7 +46,7 @@ import (
func init() { func init() {
// Register a reexec function to start a simulation node when the current binary is // Register a reexec function to start a simulation node when the current binary is
// executed as "p2p-node" (rather than whataver the main() function would normally do). // executed as "p2p-node" (rather than whatever the main() function would normally do).
reexec.Register("p2p-node", execP2PNode) reexec.Register("p2p-node", execP2PNode)
} }

View File

@ -130,7 +130,7 @@ func (s *SimAdapter) Dial(dest *enode.Node) (conn net.Conn, err error) {
return nil, err return nil, err
} }
// this is simulated 'listening' // this is simulated 'listening'
// asynchronously call the dialed destintion node's p2p server // asynchronously call the dialed destination node's p2p server
// to set up connection on the 'listening' side // to set up connection on the 'listening' side
go srv.SetupConn(pipe1, 0, nil) go srv.SetupConn(pipe1, 0, nil)
return pipe2, nil return pipe2, nil

View File

@ -25,6 +25,7 @@ import (
) )
func newTestNetwork(t *testing.T, nodeCount int) (*Network, []enode.ID) { func newTestNetwork(t *testing.T, nodeCount int) (*Network, []enode.ID) {
t.Helper()
adapter := adapters.NewSimAdapter(adapters.Services{ adapter := adapters.NewSimAdapter(adapters.Services{
"noopwoop": func(ctx *adapters.ServiceContext) (node.Service, error) { "noopwoop": func(ctx *adapters.ServiceContext) (node.Service, error) {
return NewNoopService(nil), nil return NewNoopService(nil), nil

View File

@ -35,7 +35,7 @@ import (
"github.com/ethereum/go-ethereum/p2p/enode" "github.com/ethereum/go-ethereum/p2p/enode"
"github.com/ethereum/go-ethereum/p2p/simulations/adapters" "github.com/ethereum/go-ethereum/p2p/simulations/adapters"
"github.com/ethereum/go-ethereum/rpc" "github.com/ethereum/go-ethereum/rpc"
colorable "github.com/mattn/go-colorable" "github.com/mattn/go-colorable"
) )
var ( var (
@ -294,6 +294,7 @@ var testServices = adapters.Services{
} }
func testHTTPServer(t *testing.T) (*Network, *httptest.Server) { func testHTTPServer(t *testing.T) (*Network, *httptest.Server) {
t.Helper()
adapter := adapters.NewSimAdapter(testServices) adapter := adapters.NewSimAdapter(testServices)
network := NewNetwork(adapter, &NetworkConfig{ network := NewNetwork(adapter, &NetworkConfig{
DefaultService: "test", DefaultService: "test",

View File

@ -15,7 +15,7 @@
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
// Package simulations simulates p2p networks. // Package simulations simulates p2p networks.
// A mokcer simulates starting and stopping real nodes in a network. // A mocker simulates starting and stopping real nodes in a network.
package simulations package simulations
import ( import (
@ -135,13 +135,13 @@ func TestMocker(t *testing.T) {
wg.Wait() wg.Wait()
//check there are nodeCount number of nodes in the network //check there are nodeCount number of nodes in the network
nodes_info, err := client.GetNodes() nodesInfo, err := client.GetNodes()
if err != nil { if err != nil {
t.Fatalf("Could not get nodes list: %s", err) t.Fatalf("Could not get nodes list: %s", err)
} }
if len(nodes_info) != nodeCount { if len(nodesInfo) != nodeCount {
t.Fatalf("Expected %d number of nodes, got: %d", nodeCount, len(nodes_info)) t.Fatalf("Expected %d number of nodes, got: %d", nodeCount, len(nodesInfo))
} }
//stop the mocker //stop the mocker
@ -160,12 +160,12 @@ func TestMocker(t *testing.T) {
} }
//now the number of nodes in the network should be zero //now the number of nodes in the network should be zero
nodes_info, err = client.GetNodes() nodesInfo, err = client.GetNodes()
if err != nil { if err != nil {
t.Fatalf("Could not get nodes list: %s", err) t.Fatalf("Could not get nodes list: %s", err)
} }
if len(nodes_info) != 0 { if len(nodesInfo) != 0 {
t.Fatalf("Expected empty list of nodes, got: %d", len(nodes_info)) t.Fatalf("Expected empty list of nodes, got: %d", len(nodesInfo))
} }
} }

View File

@ -518,7 +518,7 @@ func (net *Network) getConn(oneID, otherID enode.ID) *Conn {
return net.Conns[i] return net.Conns[i]
} }
// InitConn(one, other) retrieves the connectiton model for the connection between // InitConn(one, other) retrieves the connection model for the connection between
// peers one and other, or creates a new one if it does not exist // peers one and other, or creates a new one if it does not exist
// the order of nodes does not matter, i.e., Conn(i,j) == Conn(j, i) // the order of nodes does not matter, i.e., Conn(i,j) == Conn(j, i)
// it checks if the connection is already up, and if the nodes are running // it checks if the connection is already up, and if the nodes are running
@ -564,8 +564,8 @@ func (net *Network) Shutdown() {
close(net.quitc) close(net.quitc)
} }
//Reset resets all network properties: // Reset resets all network properties:
//emtpies the nodes and the connection list // empties the nodes and the connection list
func (net *Network) Reset() { func (net *Network) Reset() {
net.lock.Lock() net.lock.Lock()
defer net.lock.Unlock() defer net.lock.Unlock()

View File

@ -21,7 +21,7 @@ import "github.com/ethereum/go-ethereum/p2p/enode"
// BucketKey is the type that should be used for keys in simulation buckets. // BucketKey is the type that should be used for keys in simulation buckets.
type BucketKey string type BucketKey string
// NodeItem returns an item set in ServiceFunc function for a particualar node. // NodeItem returns an item set in ServiceFunc function for a particular node.
func (s *Simulation) NodeItem(id enode.ID, key interface{}) (value interface{}, ok bool) { func (s *Simulation) NodeItem(id enode.ID, key interface{}) (value interface{}, ok bool) {
s.mu.Lock() s.mu.Lock()
defer s.mu.Unlock() defer s.mu.Unlock()

View File

@ -24,7 +24,7 @@ import (
"github.com/ethereum/go-ethereum/p2p/simulations/adapters" "github.com/ethereum/go-ethereum/p2p/simulations/adapters"
) )
// TestServiceBucket tests all bucket functionalities using subtests. // TestServiceBucket tests all bucket functionality using subtests.
// It constructs a simulation of two nodes by adding items to their buckets // It constructs a simulation of two nodes by adding items to their buckets
// in ServiceFunc constructor, then by SetNodeItem. Testing UpNodesItems // in ServiceFunc constructor, then by SetNodeItem. Testing UpNodesItems
// is done by stopping one node and validating availability of its items. // is done by stopping one node and validating availability of its items.

View File

@ -25,7 +25,7 @@ import (
// Every node can have a Kademlia associated using the node bucket under // Every node can have a Kademlia associated using the node bucket under
// BucketKeyKademlia key. This allows to use WaitTillHealthy to block until // BucketKeyKademlia key. This allows to use WaitTillHealthy to block until
// all nodes have the their Kadmlias healthy. // all nodes have the their Kademlias healthy.
func ExampleSimulation_WaitTillHealthy() { func ExampleSimulation_WaitTillHealthy() {
log.Error("temporarily disabled as simulations.WaitTillHealthy cannot be trusted") log.Error("temporarily disabled as simulations.WaitTillHealthy cannot be trusted")

View File

@ -28,7 +28,7 @@ import (
) )
// BucketKeyKademlia is the key to be used for storing the kademlia // BucketKeyKademlia is the key to be used for storing the kademlia
// instance for particuar node, usually inside the ServiceFunc function. // instance for particular node, usually inside the ServiceFunc function.
var BucketKeyKademlia BucketKey = "kademlia" var BucketKeyKademlia BucketKey = "kademlia"
// WaitTillHealthy is blocking until the health of all kademlias is true. // WaitTillHealthy is blocking until the health of all kademlias is true.

View File

@ -195,9 +195,9 @@ func (s *Simulation) AddNodesAndConnectStar(count int, opts ...AddNodeOption) (i
return ids, nil return ids, nil
} }
//UploadSnapshot uploads a snapshot to the simulation // UploadSnapshot uploads a snapshot to the simulation
//This method tries to open the json file provided, applies the config to all nodes // This method tries to open the json file provided, applies the config to all nodes
//and then loads the snapshot into the Simulation network // and then loads the snapshot into the Simulation network
func (s *Simulation) UploadSnapshot(snapshotFile string, opts ...AddNodeOption) error { func (s *Simulation) UploadSnapshot(snapshotFile string, opts ...AddNodeOption) error {
f, err := os.Open(snapshotFile) f, err := os.Open(snapshotFile)
if err != nil { if err != nil {

View File

@ -28,7 +28,7 @@ import (
"github.com/ethereum/go-ethereum/node" "github.com/ethereum/go-ethereum/node"
"github.com/ethereum/go-ethereum/p2p/simulations" "github.com/ethereum/go-ethereum/p2p/simulations"
"github.com/ethereum/go-ethereum/p2p/simulations/adapters" "github.com/ethereum/go-ethereum/p2p/simulations/adapters"
colorable "github.com/mattn/go-colorable" "github.com/mattn/go-colorable"
) )
var ( var (
@ -177,7 +177,7 @@ var noopServiceFuncMap = map[string]ServiceFunc{
} }
// a helper function for most basic noop service // a helper function for most basic noop service
func noopServiceFunc(ctx *adapters.ServiceContext, b *sync.Map) (node.Service, func(), error) { func noopServiceFunc(_ *adapters.ServiceContext, _ *sync.Map) (node.Service, func(), error) {
return newNoopService(), nil, nil return newNoopService(), nil, nil
} }
@ -188,7 +188,7 @@ func newNoopService() node.Service {
// a helper function for most basic Noop service // a helper function for most basic Noop service
// of a different type then NoopService to test // of a different type then NoopService to test
// multiple services on one node. // multiple services on one node.
func noopService2Func(ctx *adapters.ServiceContext, b *sync.Map) (node.Service, func(), error) { func noopService2Func(_ *adapters.ServiceContext, _ *sync.Map) (node.Service, func(), error) {
return new(noopService2), nil, nil return new(noopService2), nil, nil
} }

View File

@ -442,17 +442,17 @@ func TestStreamerDownstreamChunkDeliveryMsgExchange(t *testing.T) {
} }
func TestDeliveryFromNodes(t *testing.T) { func TestDeliveryFromNodes(t *testing.T) {
testDeliveryFromNodes(t, 2, 1, dataChunkCount, true) testDeliveryFromNodes(t, 2, dataChunkCount, true)
testDeliveryFromNodes(t, 2, 1, dataChunkCount, false) testDeliveryFromNodes(t, 2, dataChunkCount, false)
testDeliveryFromNodes(t, 4, 1, dataChunkCount, true) testDeliveryFromNodes(t, 4, dataChunkCount, true)
testDeliveryFromNodes(t, 4, 1, dataChunkCount, false) testDeliveryFromNodes(t, 4, dataChunkCount, false)
testDeliveryFromNodes(t, 8, 1, dataChunkCount, true) testDeliveryFromNodes(t, 8, dataChunkCount, true)
testDeliveryFromNodes(t, 8, 1, dataChunkCount, false) testDeliveryFromNodes(t, 8, dataChunkCount, false)
testDeliveryFromNodes(t, 16, 1, dataChunkCount, true) testDeliveryFromNodes(t, 16, dataChunkCount, true)
testDeliveryFromNodes(t, 16, 1, dataChunkCount, false) testDeliveryFromNodes(t, 16, dataChunkCount, false)
} }
func testDeliveryFromNodes(t *testing.T, nodes, conns, chunkCount int, skipCheck bool) { func testDeliveryFromNodes(t *testing.T, nodes, chunkCount int, skipCheck bool) {
sim := simulation.New(map[string]simulation.ServiceFunc{ sim := simulation.New(map[string]simulation.ServiceFunc{
"streamer": func(ctx *adapters.ServiceContext, bucket *sync.Map) (s node.Service, cleanup func(), err error) { "streamer": func(ctx *adapters.ServiceContext, bucket *sync.Map) (s node.Service, cleanup func(), err error) {
node := ctx.Config.Node() node := ctx.Config.Node()
@ -609,7 +609,7 @@ func BenchmarkDeliveryFromNodesWithoutCheck(b *testing.B) {
b.Run( b.Run(
fmt.Sprintf("nodes=%v,chunks=%v", i, chunks), fmt.Sprintf("nodes=%v,chunks=%v", i, chunks),
func(b *testing.B) { func(b *testing.B) {
benchmarkDeliveryFromNodes(b, i, 1, chunks, true) benchmarkDeliveryFromNodes(b, i, chunks, true)
}, },
) )
} }
@ -622,14 +622,14 @@ func BenchmarkDeliveryFromNodesWithCheck(b *testing.B) {
b.Run( b.Run(
fmt.Sprintf("nodes=%v,chunks=%v", i, chunks), fmt.Sprintf("nodes=%v,chunks=%v", i, chunks),
func(b *testing.B) { func(b *testing.B) {
benchmarkDeliveryFromNodes(b, i, 1, chunks, false) benchmarkDeliveryFromNodes(b, i, chunks, false)
}, },
) )
} }
} }
} }
func benchmarkDeliveryFromNodes(b *testing.B, nodes, conns, chunkCount int, skipCheck bool) { func benchmarkDeliveryFromNodes(b *testing.B, nodes, chunkCount int, skipCheck bool) {
sim := simulation.New(map[string]simulation.ServiceFunc{ sim := simulation.New(map[string]simulation.ServiceFunc{
"streamer": func(ctx *adapters.ServiceContext, bucket *sync.Map) (s node.Service, cleanup func(), err error) { "streamer": func(ctx *adapters.ServiceContext, bucket *sync.Map) (s node.Service, cleanup func(), err error) {
node := ctx.Config.Node() node := ctx.Config.Node()

View File

@ -43,10 +43,10 @@ import (
const dataChunkCount = 200 const dataChunkCount = 200
func TestSyncerSimulation(t *testing.T) { func TestSyncerSimulation(t *testing.T) {
testSyncBetweenNodes(t, 2, 1, dataChunkCount, true, 1) testSyncBetweenNodes(t, 2, dataChunkCount, true, 1)
testSyncBetweenNodes(t, 4, 1, dataChunkCount, true, 1) testSyncBetweenNodes(t, 4, dataChunkCount, true, 1)
testSyncBetweenNodes(t, 8, 1, dataChunkCount, true, 1) testSyncBetweenNodes(t, 8, dataChunkCount, true, 1)
testSyncBetweenNodes(t, 16, 1, dataChunkCount, true, 1) testSyncBetweenNodes(t, 16, dataChunkCount, true, 1)
} }
func createMockStore(globalStore mock.GlobalStorer, id enode.ID, addr *network.BzzAddr) (lstore storage.ChunkStore, datadir string, err error) { func createMockStore(globalStore mock.GlobalStorer, id enode.ID, addr *network.BzzAddr) (lstore storage.ChunkStore, datadir string, err error) {
@ -67,7 +67,7 @@ func createMockStore(globalStore mock.GlobalStorer, id enode.ID, addr *network.B
return lstore, datadir, nil return lstore, datadir, nil
} }
func testSyncBetweenNodes(t *testing.T, nodes, conns, chunkCount int, skipCheck bool, po uint8) { func testSyncBetweenNodes(t *testing.T, nodes, chunkCount int, skipCheck bool, po uint8) {
sim := simulation.New(map[string]simulation.ServiceFunc{ sim := simulation.New(map[string]simulation.ServiceFunc{
"streamer": func(ctx *adapters.ServiceContext, bucket *sync.Map) (s node.Service, cleanup func(), err error) { "streamer": func(ctx *adapters.ServiceContext, bucket *sync.Map) (s node.Service, cleanup func(), err error) {