mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-10-14 00:59:33 +00:00
[NOD-1208] Add NetAdapterMock
This commit is contained in:
parent
658fb08c02
commit
cd10de2dce
9
netadapter/netadaptermock/log.go
Normal file
9
netadapter/netadaptermock/log.go
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
package netadaptermock
|
||||||
|
|
||||||
|
import (
|
||||||
|
"github.com/kaspanet/kaspad/logger"
|
||||||
|
"github.com/kaspanet/kaspad/util/panics"
|
||||||
|
)
|
||||||
|
|
||||||
|
var log, _ = logger.Get(logger.SubsystemTags.NTAR)
|
||||||
|
var spawn = panics.GoroutineWrapperFunc(log)
|
182
netadapter/netadaptermock/net_adapter_mock.go
Normal file
182
netadapter/netadaptermock/net_adapter_mock.go
Normal file
@ -0,0 +1,182 @@
|
|||||||
|
package netadaptermock
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sync"
|
||||||
|
|
||||||
|
"github.com/kaspanet/kaspad/netadapter/id"
|
||||||
|
"github.com/kaspanet/kaspad/util/mstime"
|
||||||
|
|
||||||
|
"github.com/kaspanet/kaspad/protocol/common"
|
||||||
|
|
||||||
|
"github.com/kaspanet/kaspad/netadapter/router"
|
||||||
|
"github.com/kaspanet/kaspad/wire"
|
||||||
|
|
||||||
|
"github.com/kaspanet/kaspad/config"
|
||||||
|
"github.com/kaspanet/kaspad/netadapter"
|
||||||
|
|
||||||
|
"github.com/pkg/errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
// NetAdapterMock allows tests and other tools to mockup a simple network adapter without implementing all the required
|
||||||
|
// supporting structures.
|
||||||
|
type NetAdapterMock struct {
|
||||||
|
lock sync.Mutex
|
||||||
|
netAdapter *netadapter.NetAdapter
|
||||||
|
routesChan <-chan *Routes
|
||||||
|
}
|
||||||
|
|
||||||
|
// New creates a new instance of a NetAdapterMock
|
||||||
|
func New(cfg *config.Config) (*NetAdapterMock, error) {
|
||||||
|
netAdapter, err := netadapter.NewNetAdapter(cfg)
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.Wrap(err, "Error starting netAdapter")
|
||||||
|
}
|
||||||
|
|
||||||
|
routerInitializer, routesChan := generateRouteInitializer()
|
||||||
|
|
||||||
|
netAdapter.SetRouterInitializer(routerInitializer)
|
||||||
|
err = netAdapter.Start()
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.Wrap(err, "Error starting netAdapter")
|
||||||
|
}
|
||||||
|
|
||||||
|
return &NetAdapterMock{
|
||||||
|
lock: sync.Mutex{},
|
||||||
|
netAdapter: netAdapter,
|
||||||
|
routesChan: routesChan,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Connect opens a connection to the given address, handles handshake, and returns the routes this connection
|
||||||
|
// To simplify usage the return type contains only two routes:
|
||||||
|
// OutgoingRoute - for all outgoing messages
|
||||||
|
// IncomingRoute - for all incoming messages (excluding handshake messages)
|
||||||
|
func (nam *NetAdapterMock) Connect(address string) (*Routes, error) {
|
||||||
|
nam.lock.Lock()
|
||||||
|
defer nam.lock.Unlock()
|
||||||
|
|
||||||
|
err := nam.netAdapter.Connect(address)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
routes := <-nam.routesChan
|
||||||
|
err = handleHandshake(routes)
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.Wrap(err, "Error in handshake")
|
||||||
|
}
|
||||||
|
|
||||||
|
spawn("netAdapterMock-handlePingPong", func() {
|
||||||
|
err := handlePingPong(routes)
|
||||||
|
if err != nil {
|
||||||
|
panic(errors.Wrap(err, "Error from ping-pong"))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
return routes, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func handlePingPong(routes *Routes) error {
|
||||||
|
for {
|
||||||
|
message, err := routes.pingRoute.Dequeue()
|
||||||
|
if err != nil {
|
||||||
|
if errors.Is(err, router.ErrRouteClosed) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
pingMessage := message.(*wire.MsgPing)
|
||||||
|
|
||||||
|
err = routes.OutgoingRoute.Enqueue(&wire.MsgPong{Nonce: pingMessage.Nonce})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func handleHandshake(routes *Routes) error {
|
||||||
|
msg, err := routes.handshakeRoute.DequeueWithTimeout(common.DefaultTimeout)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
versionMessage, ok := msg.(*wire.MsgVersion)
|
||||||
|
if !ok {
|
||||||
|
return errors.Errorf("Expected first message to be of type %s, but got %s", wire.CmdVersion, msg.Command())
|
||||||
|
}
|
||||||
|
|
||||||
|
ourID, err := id.GenerateID()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
err = routes.OutgoingRoute.Enqueue(&wire.MsgVersion{
|
||||||
|
ProtocolVersion: versionMessage.ProtocolVersion,
|
||||||
|
Services: versionMessage.Services,
|
||||||
|
Timestamp: mstime.Now(),
|
||||||
|
Address: nil,
|
||||||
|
ID: ourID,
|
||||||
|
UserAgent: "/net-adapter-mock/",
|
||||||
|
SelectedTipHash: versionMessage.SelectedTipHash,
|
||||||
|
DisableRelayTx: true,
|
||||||
|
SubnetworkID: nil,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
msg, err = routes.handshakeRoute.DequeueWithTimeout(common.DefaultTimeout)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
_, ok = msg.(*wire.MsgVerAck)
|
||||||
|
if !ok {
|
||||||
|
return errors.Errorf("Expected second message to be of type %s, but got %s", wire.CmdVerAck, msg.Command())
|
||||||
|
}
|
||||||
|
|
||||||
|
err = routes.OutgoingRoute.Enqueue(&wire.MsgVerAck{})
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func generateRouteInitializer() (netadapter.RouterInitializer, <-chan *Routes) {
|
||||||
|
everythingElse := make([]wire.MessageCommand, 0, len(wire.MessageCommandToString)-3)
|
||||||
|
for command := range wire.MessageCommandToString {
|
||||||
|
if command != wire.CmdVersion && command != wire.CmdVerAck && command != wire.CmdPing {
|
||||||
|
everythingElse = append(everythingElse, command)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
routesChan := make(chan *Routes)
|
||||||
|
|
||||||
|
routeInitializer := func(router *router.Router, netConnection *netadapter.NetConnection) {
|
||||||
|
handshakeRoute, err := router.AddIncomingRoute([]wire.MessageCommand{wire.CmdVersion, wire.CmdVerAck})
|
||||||
|
if err != nil {
|
||||||
|
panic(errors.Wrap(err, "Error registering handshake route"))
|
||||||
|
}
|
||||||
|
pingRoute, err := router.AddIncomingRoute([]wire.MessageCommand{wire.CmdPing})
|
||||||
|
if err != nil {
|
||||||
|
panic(errors.Wrap(err, "Error registering ping route"))
|
||||||
|
}
|
||||||
|
|
||||||
|
everythingElseRoute, err := router.AddIncomingRoute(everythingElse)
|
||||||
|
if err != nil {
|
||||||
|
panic(errors.Wrap(err, "Error registering everythingElseRoute"))
|
||||||
|
}
|
||||||
|
|
||||||
|
spawn("netAdapterMock-routeInitializer-sendRoutesToChan", func() {
|
||||||
|
routesChan <- &Routes{
|
||||||
|
OutgoingRoute: router.OutgoingRoute(),
|
||||||
|
IncomingRoute: everythingElseRoute,
|
||||||
|
handshakeRoute: handshakeRoute,
|
||||||
|
pingRoute: pingRoute,
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return routeInitializer, routesChan
|
||||||
|
}
|
54
netadapter/netadaptermock/routes.go
Normal file
54
netadapter/netadaptermock/routes.go
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
package netadaptermock
|
||||||
|
|
||||||
|
import (
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/pkg/errors"
|
||||||
|
|
||||||
|
"github.com/kaspanet/kaspad/netadapter/router"
|
||||||
|
"github.com/kaspanet/kaspad/wire"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Routes holds the incoming and outgoing routes of a connection created by NetAdapterMock
|
||||||
|
type Routes struct {
|
||||||
|
IncomingRoute, OutgoingRoute *router.Route
|
||||||
|
handshakeRoute *router.Route
|
||||||
|
pingRoute *router.Route
|
||||||
|
}
|
||||||
|
|
||||||
|
// WaitForMessageOfType waits for a message of requested type up to `timeout`, skipping all messages of any other type
|
||||||
|
// received while waiting
|
||||||
|
func (r *Routes) WaitForMessageOfType(command wire.MessageCommand, timeout time.Duration) (wire.Message, error) {
|
||||||
|
timeoutTime := time.Now().Add(timeout)
|
||||||
|
for {
|
||||||
|
message, err := r.IncomingRoute.DequeueWithTimeout(timeoutTime.Sub(time.Now()))
|
||||||
|
if err != nil {
|
||||||
|
return nil, errors.Wrapf(err, "Error waiting for message of type %s", command)
|
||||||
|
}
|
||||||
|
if message.Command() == command {
|
||||||
|
return message, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// WaitForDisconnect waits for a disconnect up to `timeout`, skipping all messages received while waiting
|
||||||
|
func (r *Routes) WaitForDisconnect(timeout time.Duration) error {
|
||||||
|
timeoutTime := time.Now().Add(timeout)
|
||||||
|
for {
|
||||||
|
_, err := r.IncomingRoute.DequeueWithTimeout(timeoutTime.Sub(time.Now()))
|
||||||
|
if errors.Is(err, router.ErrRouteClosed) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return errors.Wrap(err, "Error waiting for disconnect")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close closes all the routes in this Routes object
|
||||||
|
func (r *Routes) Close() {
|
||||||
|
r.IncomingRoute.Close()
|
||||||
|
r.OutgoingRoute.Close()
|
||||||
|
r.handshakeRoute.Close()
|
||||||
|
r.pingRoute.Close()
|
||||||
|
}
|
@ -16,7 +16,7 @@ const MaxMessagePayload = (1024 * 1024 * 32) // 32MB
|
|||||||
type MessageCommand uint32
|
type MessageCommand uint32
|
||||||
|
|
||||||
func (cmd MessageCommand) String() string {
|
func (cmd MessageCommand) String() string {
|
||||||
cmdString, ok := messageCommandToString[cmd]
|
cmdString, ok := MessageCommandToString[cmd]
|
||||||
if !ok {
|
if !ok {
|
||||||
cmdString = "unknown command"
|
cmdString = "unknown command"
|
||||||
}
|
}
|
||||||
@ -48,7 +48,8 @@ const (
|
|||||||
CmdTransactionNotFound
|
CmdTransactionNotFound
|
||||||
)
|
)
|
||||||
|
|
||||||
var messageCommandToString = map[MessageCommand]string{
|
// MessageCommandToString maps all MessageCommands to their string representation
|
||||||
|
var MessageCommandToString = map[MessageCommand]string{
|
||||||
CmdVersion: "Version",
|
CmdVersion: "Version",
|
||||||
CmdVerAck: "VerAck",
|
CmdVerAck: "VerAck",
|
||||||
CmdRequestAddresses: "RequestAddresses",
|
CmdRequestAddresses: "RequestAddresses",
|
||||||
|
Loading…
x
Reference in New Issue
Block a user