github.com/letterj/go-ethereum@v1.8.22-0.20190204142846-520024dfd689/p2p/simulations/http_test.go (about)

     1  // Copyright 2017 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 simulations
    18  
    19  import (
    20  	"context"
    21  	"flag"
    22  	"fmt"
    23  	"math/rand"
    24  	"net/http/httptest"
    25  	"reflect"
    26  	"sync"
    27  	"sync/atomic"
    28  	"testing"
    29  	"time"
    30  
    31  	"github.com/ethereum/go-ethereum/event"
    32  	"github.com/ethereum/go-ethereum/log"
    33  	"github.com/ethereum/go-ethereum/node"
    34  	"github.com/ethereum/go-ethereum/p2p"
    35  	"github.com/ethereum/go-ethereum/p2p/enode"
    36  	"github.com/ethereum/go-ethereum/p2p/simulations/adapters"
    37  	"github.com/ethereum/go-ethereum/rpc"
    38  	"github.com/mattn/go-colorable"
    39  )
    40  
    41  var (
    42  	loglevel = flag.Int("loglevel", 2, "verbosity of logs")
    43  )
    44  
    45  func init() {
    46  	flag.Parse()
    47  
    48  	log.PrintOrigins(true)
    49  	log.Root().SetHandler(log.LvlFilterHandler(log.Lvl(*loglevel), log.StreamHandler(colorable.NewColorableStderr(), log.TerminalFormat(true))))
    50  }
    51  
    52  // testService implements the node.Service interface and provides protocols
    53  // and APIs which are useful for testing nodes in a simulation network
    54  type testService struct {
    55  	id enode.ID
    56  
    57  	// peerCount is incremented once a peer handshake has been performed
    58  	peerCount int64
    59  
    60  	peers    map[enode.ID]*testPeer
    61  	peersMtx sync.Mutex
    62  
    63  	// state stores []byte which is used to test creating and loading
    64  	// snapshots
    65  	state atomic.Value
    66  }
    67  
    68  func newTestService(ctx *adapters.ServiceContext) (node.Service, error) {
    69  	svc := &testService{
    70  		id:    ctx.Config.ID,
    71  		peers: make(map[enode.ID]*testPeer),
    72  	}
    73  	svc.state.Store(ctx.Snapshot)
    74  	return svc, nil
    75  }
    76  
    77  type testPeer struct {
    78  	testReady chan struct{}
    79  	dumReady  chan struct{}
    80  }
    81  
    82  func (t *testService) peer(id enode.ID) *testPeer {
    83  	t.peersMtx.Lock()
    84  	defer t.peersMtx.Unlock()
    85  	if peer, ok := t.peers[id]; ok {
    86  		return peer
    87  	}
    88  	peer := &testPeer{
    89  		testReady: make(chan struct{}),
    90  		dumReady:  make(chan struct{}),
    91  	}
    92  	t.peers[id] = peer
    93  	return peer
    94  }
    95  
    96  func (t *testService) Protocols() []p2p.Protocol {
    97  	return []p2p.Protocol{
    98  		{
    99  			Name:    "test",
   100  			Version: 1,
   101  			Length:  3,
   102  			Run:     t.RunTest,
   103  		},
   104  		{
   105  			Name:    "dum",
   106  			Version: 1,
   107  			Length:  1,
   108  			Run:     t.RunDum,
   109  		},
   110  		{
   111  			Name:    "prb",
   112  			Version: 1,
   113  			Length:  1,
   114  			Run:     t.RunPrb,
   115  		},
   116  	}
   117  }
   118  
   119  func (t *testService) APIs() []rpc.API {
   120  	return []rpc.API{{
   121  		Namespace: "test",
   122  		Version:   "1.0",
   123  		Service: &TestAPI{
   124  			state:     &t.state,
   125  			peerCount: &t.peerCount,
   126  		},
   127  	}}
   128  }
   129  
   130  func (t *testService) Start(server *p2p.Server) error {
   131  	return nil
   132  }
   133  
   134  func (t *testService) Stop() error {
   135  	return nil
   136  }
   137  
   138  // handshake performs a peer handshake by sending and expecting an empty
   139  // message with the given code
   140  func (t *testService) handshake(rw p2p.MsgReadWriter, code uint64) error {
   141  	errc := make(chan error, 2)
   142  	go func() { errc <- p2p.Send(rw, code, struct{}{}) }()
   143  	go func() { errc <- p2p.ExpectMsg(rw, code, struct{}{}) }()
   144  	for i := 0; i < 2; i++ {
   145  		if err := <-errc; err != nil {
   146  			return err
   147  		}
   148  	}
   149  	return nil
   150  }
   151  
   152  func (t *testService) RunTest(p *p2p.Peer, rw p2p.MsgReadWriter) error {
   153  	peer := t.peer(p.ID())
   154  
   155  	// perform three handshakes with three different message codes,
   156  	// used to test message sending and filtering
   157  	if err := t.handshake(rw, 2); err != nil {
   158  		return err
   159  	}
   160  	if err := t.handshake(rw, 1); err != nil {
   161  		return err
   162  	}
   163  	if err := t.handshake(rw, 0); err != nil {
   164  		return err
   165  	}
   166  
   167  	// close the testReady channel so that other protocols can run
   168  	close(peer.testReady)
   169  
   170  	// track the peer
   171  	atomic.AddInt64(&t.peerCount, 1)
   172  	defer atomic.AddInt64(&t.peerCount, -1)
   173  
   174  	// block until the peer is dropped
   175  	for {
   176  		_, err := rw.ReadMsg()
   177  		if err != nil {
   178  			return err
   179  		}
   180  	}
   181  }
   182  
   183  func (t *testService) RunDum(p *p2p.Peer, rw p2p.MsgReadWriter) error {
   184  	peer := t.peer(p.ID())
   185  
   186  	// wait for the test protocol to perform its handshake
   187  	<-peer.testReady
   188  
   189  	// perform a handshake
   190  	if err := t.handshake(rw, 0); err != nil {
   191  		return err
   192  	}
   193  
   194  	// close the dumReady channel so that other protocols can run
   195  	close(peer.dumReady)
   196  
   197  	// block until the peer is dropped
   198  	for {
   199  		_, err := rw.ReadMsg()
   200  		if err != nil {
   201  			return err
   202  		}
   203  	}
   204  }
   205  func (t *testService) RunPrb(p *p2p.Peer, rw p2p.MsgReadWriter) error {
   206  	peer := t.peer(p.ID())
   207  
   208  	// wait for the dum protocol to perform its handshake
   209  	<-peer.dumReady
   210  
   211  	// perform a handshake
   212  	if err := t.handshake(rw, 0); err != nil {
   213  		return err
   214  	}
   215  
   216  	// block until the peer is dropped
   217  	for {
   218  		_, err := rw.ReadMsg()
   219  		if err != nil {
   220  			return err
   221  		}
   222  	}
   223  }
   224  
   225  func (t *testService) Snapshot() ([]byte, error) {
   226  	return t.state.Load().([]byte), nil
   227  }
   228  
   229  // TestAPI provides a test API to:
   230  // * get the peer count
   231  // * get and set an arbitrary state byte slice
   232  // * get and increment a counter
   233  // * subscribe to counter increment events
   234  type TestAPI struct {
   235  	state     *atomic.Value
   236  	peerCount *int64
   237  	counter   int64
   238  	feed      event.Feed
   239  }
   240  
   241  func (t *TestAPI) PeerCount() int64 {
   242  	return atomic.LoadInt64(t.peerCount)
   243  }
   244  
   245  func (t *TestAPI) Get() int64 {
   246  	return atomic.LoadInt64(&t.counter)
   247  }
   248  
   249  func (t *TestAPI) Add(delta int64) {
   250  	atomic.AddInt64(&t.counter, delta)
   251  	t.feed.Send(delta)
   252  }
   253  
   254  func (t *TestAPI) GetState() []byte {
   255  	return t.state.Load().([]byte)
   256  }
   257  
   258  func (t *TestAPI) SetState(state []byte) {
   259  	t.state.Store(state)
   260  }
   261  
   262  func (t *TestAPI) Events(ctx context.Context) (*rpc.Subscription, error) {
   263  	notifier, supported := rpc.NotifierFromContext(ctx)
   264  	if !supported {
   265  		return nil, rpc.ErrNotificationsUnsupported
   266  	}
   267  
   268  	rpcSub := notifier.CreateSubscription()
   269  
   270  	go func() {
   271  		events := make(chan int64)
   272  		sub := t.feed.Subscribe(events)
   273  		defer sub.Unsubscribe()
   274  
   275  		for {
   276  			select {
   277  			case event := <-events:
   278  				notifier.Notify(rpcSub.ID, event)
   279  			case <-sub.Err():
   280  				return
   281  			case <-rpcSub.Err():
   282  				return
   283  			case <-notifier.Closed():
   284  				return
   285  			}
   286  		}
   287  	}()
   288  
   289  	return rpcSub, nil
   290  }
   291  
   292  var testServices = adapters.Services{
   293  	"test": newTestService,
   294  }
   295  
   296  func testHTTPServer(t *testing.T) (*Network, *httptest.Server) {
   297  	t.Helper()
   298  	adapter := adapters.NewSimAdapter(testServices)
   299  	network := NewNetwork(adapter, &NetworkConfig{
   300  		DefaultService: "test",
   301  	})
   302  	return network, httptest.NewServer(NewServer(network))
   303  }
   304  
   305  // TestHTTPNetwork tests interacting with a simulation network using the HTTP
   306  // API
   307  func TestHTTPNetwork(t *testing.T) {
   308  	// start the server
   309  	network, s := testHTTPServer(t)
   310  	defer s.Close()
   311  
   312  	// subscribe to events so we can check them later
   313  	client := NewClient(s.URL)
   314  	events := make(chan *Event, 100)
   315  	var opts SubscribeOpts
   316  	sub, err := client.SubscribeNetwork(events, opts)
   317  	if err != nil {
   318  		t.Fatalf("error subscribing to network events: %s", err)
   319  	}
   320  	defer sub.Unsubscribe()
   321  
   322  	// check we can retrieve details about the network
   323  	gotNetwork, err := client.GetNetwork()
   324  	if err != nil {
   325  		t.Fatalf("error getting network: %s", err)
   326  	}
   327  	if gotNetwork.ID != network.ID {
   328  		t.Fatalf("expected network to have ID %q, got %q", network.ID, gotNetwork.ID)
   329  	}
   330  
   331  	// start a simulation network
   332  	nodeIDs := startTestNetwork(t, client)
   333  
   334  	// check we got all the events
   335  	x := &expectEvents{t, events, sub}
   336  	x.expect(
   337  		x.nodeEvent(nodeIDs[0], false),
   338  		x.nodeEvent(nodeIDs[1], false),
   339  		x.nodeEvent(nodeIDs[0], true),
   340  		x.nodeEvent(nodeIDs[1], true),
   341  		x.connEvent(nodeIDs[0], nodeIDs[1], false),
   342  		x.connEvent(nodeIDs[0], nodeIDs[1], true),
   343  	)
   344  
   345  	// reconnect the stream and check we get the current nodes and conns
   346  	events = make(chan *Event, 100)
   347  	opts.Current = true
   348  	sub, err = client.SubscribeNetwork(events, opts)
   349  	if err != nil {
   350  		t.Fatalf("error subscribing to network events: %s", err)
   351  	}
   352  	defer sub.Unsubscribe()
   353  	x = &expectEvents{t, events, sub}
   354  	x.expect(
   355  		x.nodeEvent(nodeIDs[0], true),
   356  		x.nodeEvent(nodeIDs[1], true),
   357  		x.connEvent(nodeIDs[0], nodeIDs[1], true),
   358  	)
   359  }
   360  
   361  func startTestNetwork(t *testing.T, client *Client) []string {
   362  	// create two nodes
   363  	nodeCount := 2
   364  	nodeIDs := make([]string, nodeCount)
   365  	for i := 0; i < nodeCount; i++ {
   366  		config := adapters.RandomNodeConfig()
   367  		node, err := client.CreateNode(config)
   368  		if err != nil {
   369  			t.Fatalf("error creating node: %s", err)
   370  		}
   371  		nodeIDs[i] = node.ID
   372  	}
   373  
   374  	// check both nodes exist
   375  	nodes, err := client.GetNodes()
   376  	if err != nil {
   377  		t.Fatalf("error getting nodes: %s", err)
   378  	}
   379  	if len(nodes) != nodeCount {
   380  		t.Fatalf("expected %d nodes, got %d", nodeCount, len(nodes))
   381  	}
   382  	for i, nodeID := range nodeIDs {
   383  		if nodes[i].ID != nodeID {
   384  			t.Fatalf("expected node %d to have ID %q, got %q", i, nodeID, nodes[i].ID)
   385  		}
   386  		node, err := client.GetNode(nodeID)
   387  		if err != nil {
   388  			t.Fatalf("error getting node %d: %s", i, err)
   389  		}
   390  		if node.ID != nodeID {
   391  			t.Fatalf("expected node %d to have ID %q, got %q", i, nodeID, node.ID)
   392  		}
   393  	}
   394  
   395  	// start both nodes
   396  	for _, nodeID := range nodeIDs {
   397  		if err := client.StartNode(nodeID); err != nil {
   398  			t.Fatalf("error starting node %q: %s", nodeID, err)
   399  		}
   400  	}
   401  
   402  	// connect the nodes
   403  	for i := 0; i < nodeCount-1; i++ {
   404  		peerId := i + 1
   405  		if i == nodeCount-1 {
   406  			peerId = 0
   407  		}
   408  		if err := client.ConnectNode(nodeIDs[i], nodeIDs[peerId]); err != nil {
   409  			t.Fatalf("error connecting nodes: %s", err)
   410  		}
   411  	}
   412  
   413  	return nodeIDs
   414  }
   415  
   416  type expectEvents struct {
   417  	*testing.T
   418  
   419  	events chan *Event
   420  	sub    event.Subscription
   421  }
   422  
   423  func (t *expectEvents) nodeEvent(id string, up bool) *Event {
   424  	return &Event{
   425  		Type: EventTypeNode,
   426  		Node: &Node{
   427  			Config: &adapters.NodeConfig{
   428  				ID: enode.HexID(id),
   429  			},
   430  			Up: up,
   431  		},
   432  	}
   433  }
   434  
   435  func (t *expectEvents) connEvent(one, other string, up bool) *Event {
   436  	return &Event{
   437  		Type: EventTypeConn,
   438  		Conn: &Conn{
   439  			One:   enode.HexID(one),
   440  			Other: enode.HexID(other),
   441  			Up:    up,
   442  		},
   443  	}
   444  }
   445  
   446  func (t *expectEvents) expectMsgs(expected map[MsgFilter]int) {
   447  	actual := make(map[MsgFilter]int)
   448  	timeout := time.After(10 * time.Second)
   449  loop:
   450  	for {
   451  		select {
   452  		case event := <-t.events:
   453  			t.Logf("received %s event: %s", event.Type, event)
   454  
   455  			if event.Type != EventTypeMsg || event.Msg.Received {
   456  				continue loop
   457  			}
   458  			if event.Msg == nil {
   459  				t.Fatal("expected event.Msg to be set")
   460  			}
   461  			filter := MsgFilter{
   462  				Proto: event.Msg.Protocol,
   463  				Code:  int64(event.Msg.Code),
   464  			}
   465  			actual[filter]++
   466  			if actual[filter] > expected[filter] {
   467  				t.Fatalf("received too many msgs for filter: %v", filter)
   468  			}
   469  			if reflect.DeepEqual(actual, expected) {
   470  				return
   471  			}
   472  
   473  		case err := <-t.sub.Err():
   474  			t.Fatalf("network stream closed unexpectedly: %s", err)
   475  
   476  		case <-timeout:
   477  			t.Fatal("timed out waiting for expected events")
   478  		}
   479  	}
   480  }
   481  
   482  func (t *expectEvents) expect(events ...*Event) {
   483  	timeout := time.After(10 * time.Second)
   484  	i := 0
   485  	for {
   486  		select {
   487  		case event := <-t.events:
   488  			t.Logf("received %s event: %s", event.Type, event)
   489  
   490  			expected := events[i]
   491  			if event.Type != expected.Type {
   492  				t.Fatalf("expected event %d to have type %q, got %q", i, expected.Type, event.Type)
   493  			}
   494  
   495  			switch expected.Type {
   496  
   497  			case EventTypeNode:
   498  				if event.Node == nil {
   499  					t.Fatal("expected event.Node to be set")
   500  				}
   501  				if event.Node.ID() != expected.Node.ID() {
   502  					t.Fatalf("expected node event %d to have id %q, got %q", i, expected.Node.ID().TerminalString(), event.Node.ID().TerminalString())
   503  				}
   504  				if event.Node.Up != expected.Node.Up {
   505  					t.Fatalf("expected node event %d to have up=%t, got up=%t", i, expected.Node.Up, event.Node.Up)
   506  				}
   507  
   508  			case EventTypeConn:
   509  				if event.Conn == nil {
   510  					t.Fatal("expected event.Conn to be set")
   511  				}
   512  				if event.Conn.One != expected.Conn.One {
   513  					t.Fatalf("expected conn event %d to have one=%q, got one=%q", i, expected.Conn.One.TerminalString(), event.Conn.One.TerminalString())
   514  				}
   515  				if event.Conn.Other != expected.Conn.Other {
   516  					t.Fatalf("expected conn event %d to have other=%q, got other=%q", i, expected.Conn.Other.TerminalString(), event.Conn.Other.TerminalString())
   517  				}
   518  				if event.Conn.Up != expected.Conn.Up {
   519  					t.Fatalf("expected conn event %d to have up=%t, got up=%t", i, expected.Conn.Up, event.Conn.Up)
   520  				}
   521  
   522  			}
   523  
   524  			i++
   525  			if i == len(events) {
   526  				return
   527  			}
   528  
   529  		case err := <-t.sub.Err():
   530  			t.Fatalf("network stream closed unexpectedly: %s", err)
   531  
   532  		case <-timeout:
   533  			t.Fatal("timed out waiting for expected events")
   534  		}
   535  	}
   536  }
   537  
   538  // TestHTTPNodeRPC tests calling RPC methods on nodes via the HTTP API
   539  func TestHTTPNodeRPC(t *testing.T) {
   540  	// start the server
   541  	_, s := testHTTPServer(t)
   542  	defer s.Close()
   543  
   544  	// start a node in the network
   545  	client := NewClient(s.URL)
   546  
   547  	config := adapters.RandomNodeConfig()
   548  	node, err := client.CreateNode(config)
   549  	if err != nil {
   550  		t.Fatalf("error creating node: %s", err)
   551  	}
   552  	if err := client.StartNode(node.ID); err != nil {
   553  		t.Fatalf("error starting node: %s", err)
   554  	}
   555  
   556  	// create two RPC clients
   557  	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
   558  	defer cancel()
   559  	rpcClient1, err := client.RPCClient(ctx, node.ID)
   560  	if err != nil {
   561  		t.Fatalf("error getting node RPC client: %s", err)
   562  	}
   563  	rpcClient2, err := client.RPCClient(ctx, node.ID)
   564  	if err != nil {
   565  		t.Fatalf("error getting node RPC client: %s", err)
   566  	}
   567  
   568  	// subscribe to events using client 1
   569  	events := make(chan int64, 1)
   570  	sub, err := rpcClient1.Subscribe(ctx, "test", events, "events")
   571  	if err != nil {
   572  		t.Fatalf("error subscribing to events: %s", err)
   573  	}
   574  	defer sub.Unsubscribe()
   575  
   576  	// call some RPC methods using client 2
   577  	if err := rpcClient2.CallContext(ctx, nil, "test_add", 10); err != nil {
   578  		t.Fatalf("error calling RPC method: %s", err)
   579  	}
   580  	var result int64
   581  	if err := rpcClient2.CallContext(ctx, &result, "test_get"); err != nil {
   582  		t.Fatalf("error calling RPC method: %s", err)
   583  	}
   584  	if result != 10 {
   585  		t.Fatalf("expected result to be 10, got %d", result)
   586  	}
   587  
   588  	// check we got an event from client 1
   589  	select {
   590  	case event := <-events:
   591  		if event != 10 {
   592  			t.Fatalf("expected event to be 10, got %d", event)
   593  		}
   594  	case <-ctx.Done():
   595  		t.Fatal(ctx.Err())
   596  	}
   597  }
   598  
   599  // TestHTTPSnapshot tests creating and loading network snapshots
   600  func TestHTTPSnapshot(t *testing.T) {
   601  	// start the server
   602  	network, s := testHTTPServer(t)
   603  	defer s.Close()
   604  
   605  	var eventsDone = make(chan struct{})
   606  	count := 1
   607  	eventsDoneChan := make(chan *Event)
   608  	eventSub := network.Events().Subscribe(eventsDoneChan)
   609  	go func() {
   610  		defer eventSub.Unsubscribe()
   611  		for event := range eventsDoneChan {
   612  			if event.Type == EventTypeConn && !event.Control {
   613  				count--
   614  				if count == 0 {
   615  					eventsDone <- struct{}{}
   616  					return
   617  				}
   618  			}
   619  		}
   620  	}()
   621  
   622  	// create a two-node network
   623  	client := NewClient(s.URL)
   624  	nodeCount := 2
   625  	nodes := make([]*p2p.NodeInfo, nodeCount)
   626  	for i := 0; i < nodeCount; i++ {
   627  		config := adapters.RandomNodeConfig()
   628  		node, err := client.CreateNode(config)
   629  		if err != nil {
   630  			t.Fatalf("error creating node: %s", err)
   631  		}
   632  		if err := client.StartNode(node.ID); err != nil {
   633  			t.Fatalf("error starting node: %s", err)
   634  		}
   635  		nodes[i] = node
   636  	}
   637  	if err := client.ConnectNode(nodes[0].ID, nodes[1].ID); err != nil {
   638  		t.Fatalf("error connecting nodes: %s", err)
   639  	}
   640  
   641  	// store some state in the test services
   642  	states := make([]string, nodeCount)
   643  	for i, node := range nodes {
   644  		rpc, err := client.RPCClient(context.Background(), node.ID)
   645  		if err != nil {
   646  			t.Fatalf("error getting RPC client: %s", err)
   647  		}
   648  		defer rpc.Close()
   649  		state := fmt.Sprintf("%x", rand.Int())
   650  		if err := rpc.Call(nil, "test_setState", []byte(state)); err != nil {
   651  			t.Fatalf("error setting service state: %s", err)
   652  		}
   653  		states[i] = state
   654  	}
   655  	<-eventsDone
   656  	// create a snapshot
   657  	snap, err := client.CreateSnapshot()
   658  	if err != nil {
   659  		t.Fatalf("error creating snapshot: %s", err)
   660  	}
   661  	for i, state := range states {
   662  		gotState := snap.Nodes[i].Snapshots["test"]
   663  		if string(gotState) != state {
   664  			t.Fatalf("expected snapshot state %q, got %q", state, gotState)
   665  		}
   666  	}
   667  
   668  	// create another network
   669  	network2, s := testHTTPServer(t)
   670  	defer s.Close()
   671  	client = NewClient(s.URL)
   672  	count = 1
   673  	eventSub = network2.Events().Subscribe(eventsDoneChan)
   674  	go func() {
   675  		defer eventSub.Unsubscribe()
   676  		for event := range eventsDoneChan {
   677  			if event.Type == EventTypeConn && !event.Control {
   678  				count--
   679  				if count == 0 {
   680  					eventsDone <- struct{}{}
   681  					return
   682  				}
   683  			}
   684  		}
   685  	}()
   686  
   687  	// subscribe to events so we can check them later
   688  	events := make(chan *Event, 100)
   689  	var opts SubscribeOpts
   690  	sub, err := client.SubscribeNetwork(events, opts)
   691  	if err != nil {
   692  		t.Fatalf("error subscribing to network events: %s", err)
   693  	}
   694  	defer sub.Unsubscribe()
   695  
   696  	// load the snapshot
   697  	if err := client.LoadSnapshot(snap); err != nil {
   698  		t.Fatalf("error loading snapshot: %s", err)
   699  	}
   700  	<-eventsDone
   701  
   702  	// check the nodes and connection exists
   703  	net, err := client.GetNetwork()
   704  	if err != nil {
   705  		t.Fatalf("error getting network: %s", err)
   706  	}
   707  	if len(net.Nodes) != nodeCount {
   708  		t.Fatalf("expected network to have %d nodes, got %d", nodeCount, len(net.Nodes))
   709  	}
   710  	for i, node := range nodes {
   711  		id := net.Nodes[i].ID().String()
   712  		if id != node.ID {
   713  			t.Fatalf("expected node %d to have ID %s, got %s", i, node.ID, id)
   714  		}
   715  	}
   716  	if len(net.Conns) != 1 {
   717  		t.Fatalf("expected network to have 1 connection, got %d", len(net.Conns))
   718  	}
   719  	conn := net.Conns[0]
   720  	if conn.One.String() != nodes[0].ID {
   721  		t.Fatalf("expected connection to have one=%q, got one=%q", nodes[0].ID, conn.One)
   722  	}
   723  	if conn.Other.String() != nodes[1].ID {
   724  		t.Fatalf("expected connection to have other=%q, got other=%q", nodes[1].ID, conn.Other)
   725  	}
   726  	if !conn.Up {
   727  		t.Fatal("should be up")
   728  	}
   729  
   730  	// check the node states were restored
   731  	for i, node := range nodes {
   732  		rpc, err := client.RPCClient(context.Background(), node.ID)
   733  		if err != nil {
   734  			t.Fatalf("error getting RPC client: %s", err)
   735  		}
   736  		defer rpc.Close()
   737  		var state []byte
   738  		if err := rpc.Call(&state, "test_getState"); err != nil {
   739  			t.Fatalf("error getting service state: %s", err)
   740  		}
   741  		if string(state) != states[i] {
   742  			t.Fatalf("expected snapshot state %q, got %q", states[i], state)
   743  		}
   744  	}
   745  
   746  	// check we got all the events
   747  	x := &expectEvents{t, events, sub}
   748  	x.expect(
   749  		x.nodeEvent(nodes[0].ID, false),
   750  		x.nodeEvent(nodes[0].ID, true),
   751  		x.nodeEvent(nodes[1].ID, false),
   752  		x.nodeEvent(nodes[1].ID, true),
   753  		x.connEvent(nodes[0].ID, nodes[1].ID, false),
   754  		x.connEvent(nodes[0].ID, nodes[1].ID, true),
   755  	)
   756  }
   757  
   758  // TestMsgFilterPassMultiple tests streaming message events using a filter
   759  // with multiple protocols
   760  func TestMsgFilterPassMultiple(t *testing.T) {
   761  	// start the server
   762  	_, s := testHTTPServer(t)
   763  	defer s.Close()
   764  
   765  	// subscribe to events with a message filter
   766  	client := NewClient(s.URL)
   767  	events := make(chan *Event, 10)
   768  	opts := SubscribeOpts{
   769  		Filter: "prb:0-test:0",
   770  	}
   771  	sub, err := client.SubscribeNetwork(events, opts)
   772  	if err != nil {
   773  		t.Fatalf("error subscribing to network events: %s", err)
   774  	}
   775  	defer sub.Unsubscribe()
   776  
   777  	// start a simulation network
   778  	startTestNetwork(t, client)
   779  
   780  	// check we got the expected events
   781  	x := &expectEvents{t, events, sub}
   782  	x.expectMsgs(map[MsgFilter]int{
   783  		{"test", 0}: 2,
   784  		{"prb", 0}:  2,
   785  	})
   786  }
   787  
   788  // TestMsgFilterPassWildcard tests streaming message events using a filter
   789  // with a code wildcard
   790  func TestMsgFilterPassWildcard(t *testing.T) {
   791  	// start the server
   792  	_, s := testHTTPServer(t)
   793  	defer s.Close()
   794  
   795  	// subscribe to events with a message filter
   796  	client := NewClient(s.URL)
   797  	events := make(chan *Event, 10)
   798  	opts := SubscribeOpts{
   799  		Filter: "prb:0,2-test:*",
   800  	}
   801  	sub, err := client.SubscribeNetwork(events, opts)
   802  	if err != nil {
   803  		t.Fatalf("error subscribing to network events: %s", err)
   804  	}
   805  	defer sub.Unsubscribe()
   806  
   807  	// start a simulation network
   808  	startTestNetwork(t, client)
   809  
   810  	// check we got the expected events
   811  	x := &expectEvents{t, events, sub}
   812  	x.expectMsgs(map[MsgFilter]int{
   813  		{"test", 2}: 2,
   814  		{"test", 1}: 2,
   815  		{"test", 0}: 2,
   816  		{"prb", 0}:  2,
   817  	})
   818  }
   819  
   820  // TestMsgFilterPassSingle tests streaming message events using a filter
   821  // with a single protocol and code
   822  func TestMsgFilterPassSingle(t *testing.T) {
   823  	// start the server
   824  	_, s := testHTTPServer(t)
   825  	defer s.Close()
   826  
   827  	// subscribe to events with a message filter
   828  	client := NewClient(s.URL)
   829  	events := make(chan *Event, 10)
   830  	opts := SubscribeOpts{
   831  		Filter: "dum:0",
   832  	}
   833  	sub, err := client.SubscribeNetwork(events, opts)
   834  	if err != nil {
   835  		t.Fatalf("error subscribing to network events: %s", err)
   836  	}
   837  	defer sub.Unsubscribe()
   838  
   839  	// start a simulation network
   840  	startTestNetwork(t, client)
   841  
   842  	// check we got the expected events
   843  	x := &expectEvents{t, events, sub}
   844  	x.expectMsgs(map[MsgFilter]int{
   845  		{"dum", 0}: 2,
   846  	})
   847  }
   848  
   849  // TestMsgFilterPassSingle tests streaming message events using an invalid
   850  // filter
   851  func TestMsgFilterFailBadParams(t *testing.T) {
   852  	// start the server
   853  	_, s := testHTTPServer(t)
   854  	defer s.Close()
   855  
   856  	client := NewClient(s.URL)
   857  	events := make(chan *Event, 10)
   858  	opts := SubscribeOpts{
   859  		Filter: "foo:",
   860  	}
   861  	_, err := client.SubscribeNetwork(events, opts)
   862  	if err == nil {
   863  		t.Fatalf("expected event subscription to fail but succeeded!")
   864  	}
   865  
   866  	opts.Filter = "bzz:aa"
   867  	_, err = client.SubscribeNetwork(events, opts)
   868  	if err == nil {
   869  		t.Fatalf("expected event subscription to fail but succeeded!")
   870  	}
   871  
   872  	opts.Filter = "invalid"
   873  	_, err = client.SubscribeNetwork(events, opts)
   874  	if err == nil {
   875  		t.Fatalf("expected event subscription to fail but succeeded!")
   876  	}
   877  }