akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

test: add method to dump logs of a node within the networkHarness

Browse Source 
At times when testing one requires access to the logs of a particular
node in order to aide with debugging. Before this commit, one needed to
manually modify the networkHarness code in order to print either the
location of the logs or the logs themselves. With this commit, tests
can now programmatically examine the logs of any node created within
the networkHarness.

It’s worth noting that at times the logs dumped may not be the most up
to date version of the logs files as the logging library employs
intermediate buffering.
This commit is contained in:
Olaoluwa Osuntokun 2016-09-10 13:14:28 -07:00
parent e536e1afb1
commit d2acb4336c
No known key found for this signature in database
GPG Key ID: 9CC5B105D03521A2
2 changed files with 52 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lnd_test.go
View File

@ -37,7 +37,7 @@ func testBasicChannelFunding(net *networkHarness, t *testing.T) {
// First establish a channel ween with a capacity of 0.5 BTC between // First establish a channel ween with a capacity of 0.5 BTC between
// Alice and Bob. // Alice and Bob.
chanAmt := btcutil.Amount(btcutil.SatoshiPerBitcoin / 2) chanAmt := btcutil.Amount(btcutil.SatoshiPerBitcoin / 2)
chanOpenUpdate, err := net.OpenChannel(ctxb, net.AliceClient, net.BobClient, chanAmt, 1) chanOpenUpdate, err := net.OpenChannel(ctxb, net.Alice, net.Bob, chanAmt, 1)
if err != nil { if err != nil {
t.Fatalf("unable to open channel: %v", err) t.Fatalf("unable to open channel: %v", err)
} }
@ -69,13 +69,13 @@ func testBasicChannelFunding(net *networkHarness, t *testing.T) {
Hash: *fundingTxID, Hash: *fundingTxID,
Index: fundingChanPoint.OutputIndex, Index: fundingChanPoint.OutputIndex,
} }
err = net.AssertChannelExists(ctxb, net.AliceClient, &chanPoint) err = net.AssertChannelExists(ctxb, net.Alice, &chanPoint)
if err != nil { if err != nil {
t.Fatalf("unable to assert channel existence: %v", err) t.Fatalf("unable to assert channel existence: %v", err)
} }
// Initiate a close from Alice's side. // Initiate a close from Alice's side.
closeUpdates, err := net.CloseChannel(ctxb, net.AliceClient, fundingChanPoint, false) closeUpdates, err := net.CloseChannel(ctxb, net.Alice, fundingChanPoint, false)
if err != nil { if err != nil {
t.Fatalf("unable to clsoe channel: %v", err) t.Fatalf("unable to clsoe channel: %v", err)
} }

91
networktest.go
View File

@ -68,7 +68,8 @@ func generateListeningPorts() (int, int) {
} }
// lightningNode represents an instance of lnd running within our test network // lightningNode represents an instance of lnd running within our test network
// harness. // harness. Each lightningNode instance also fully embedds an RPC client in
// order to programatically drive the node.
type lightningNode struct { type lightningNode struct {
cfg *config cfg *config
@ -82,6 +83,8 @@ type lightningNode struct {
pidFile string pidFile string
extraArgs []string extraArgs []string
lnrpc.LightningClient
} }
// newLightningNode creates a new test lightning node instance from the passed // newLightningNode creates a new test lightning node instance from the passed
@ -166,6 +169,18 @@ func (l *lightningNode) start() error {
return err return err
} }
opts := []grpc.DialOption{
grpc.WithInsecure(),
grpc.WithBlock(),
grpc.WithTimeout(time.Second * 20),
}
conn, err := grpc.Dial(l.rpcAddr, opts...)
if err != nil {
return nil
}
l.LightningClient = lnrpc.NewLightningClient(conn)
return nil return nil
} }
@ -221,11 +236,10 @@ type networkHarness struct {
activeNodes map[int]*lightningNode activeNodes map[int]*lightningNode
aliceNode *lightningNode // Alice and Bob are the initial seeder nodes that are automatically
bobNode *lightningNode // created to be the initial participants of the test network.
Alice *lightningNode
AliceClient lnrpc.LightningClient Bob *lightningNode
BobClient lnrpc.LightningClient
seenTxns chan wire.ShaHash seenTxns chan wire.ShaHash
watchRequests chan *watchRequest watchRequests chan *watchRequest
@ -254,17 +268,17 @@ func (n *networkHarness) InitializeSeedNodes(r *rpctest.Harness) error {
n.rpcConfig = nodeConfig n.rpcConfig = nodeConfig
var err error var err error
n.aliceNode, err = newLightningNode(&nodeConfig, nil) n.Alice, err = newLightningNode(&nodeConfig, nil)
if err != nil { if err != nil {
return err return err
} }
n.bobNode, err = newLightningNode(&nodeConfig, nil) n.Bob, err = newLightningNode(&nodeConfig, nil)
if err != nil { if err != nil {
return err return err
} }
n.activeNodes[n.aliceNode.nodeId] = n.aliceNode n.activeNodes[n.Alice.nodeId] = n.Alice
n.activeNodes[n.bobNode.nodeId] = n.bobNode n.activeNodes[n.Bob.nodeId] = n.Bob
return err return err
} }
@ -297,12 +311,7 @@ func (n *networkHarness) SetUp() error {
go func() { go func() {
var err error var err error
defer wg.Done() defer wg.Done()
if err = n.aliceNode.start(); err != nil { if err = n.Alice.start(); err != nil {
errChan <- err
return
}
n.AliceClient, err = initRpcClient(n.aliceNode.rpcAddr)
if err != nil {
errChan <- err errChan <- err
return return
} }
@ -310,12 +319,7 @@ func (n *networkHarness) SetUp() error {
go func() { go func() {
var err error var err error
defer wg.Done() defer wg.Done()
if err = n.bobNode.start(); err != nil { if err = n.Bob.start(); err != nil {
errChan <- err
return
}
n.BobClient, err = initRpcClient(n.bobNode.rpcAddr)
if err != nil {
errChan <- err errChan <- err
return return
} }
@ -331,7 +335,7 @@ func (n *networkHarness) SetUp() error {
// each. // each.
ctxb := context.Background() ctxb := context.Background()
addrReq := &lnrpc.NewAddressRequest{lnrpc.NewAddressRequest_WITNESS_PUBKEY_HASH} addrReq := &lnrpc.NewAddressRequest{lnrpc.NewAddressRequest_WITNESS_PUBKEY_HASH}
clients := []lnrpc.LightningClient{n.AliceClient, n.BobClient} clients := []lnrpc.LightningClient{n.Alice, n.Bob}
for _, client := range clients { for _, client := range clients {
for i := 0; i < 10; i++ { for i := 0; i < 10; i++ {
resp, err := client.NewAddress(ctxb, addrReq) resp, err := client.NewAddress(ctxb, addrReq)
@ -364,17 +368,17 @@ func (n *networkHarness) SetUp() error {
} }
// Finally, make a connection between both of the nodes. // Finally, make a connection between both of the nodes.
bobInfo, err := n.BobClient.GetInfo(ctxb, &lnrpc.GetInfoRequest{}) bobInfo, err := n.Bob.GetInfo(ctxb, &lnrpc.GetInfoRequest{})
if err != nil { if err != nil {
return err return err
} }
req := &lnrpc.ConnectPeerRequest{ req := &lnrpc.ConnectPeerRequest{
Addr: &lnrpc.LightningAddress{ Addr: &lnrpc.LightningAddress{
PubKeyHash: bobInfo.IdentityAddress, PubKeyHash: bobInfo.IdentityAddress,
Host: n.bobNode.p2pAddr, Host: n.Bob.p2pAddr,
}, },
} }
if _, err := n.AliceClient.ConnectPeer(ctxb, req); err != nil { if _, err := n.Alice.ConnectPeer(ctxb, req); err != nil {
return err return err
} }
@ -386,11 +390,11 @@ out:
for { for {
select { select {
case <-balanceTicker: case <-balanceTicker:
aliceResp, err := n.AliceClient.WalletBalance(ctxb, balReq) aliceResp, err := n.Alice.WalletBalance(ctxb, balReq)
if err != nil { if err != nil {
return err return err
} }
bobResp, err := n.BobClient.WalletBalance(ctxb, balReq) bobResp, err := n.Bob.WalletBalance(ctxb, balReq)
if err != nil { if err != nil {
return err return err
} }
@ -487,7 +491,7 @@ func (n *networkHarness) WaitForTxBroadcast(txid wire.ShaHash) {
// OpenChannel attemps to open a channel between srcNode and destNode with the // OpenChannel attemps to open a channel between srcNode and destNode with the
// passed channel funding paramters. // passed channel funding paramters.
func (n *networkHarness) OpenChannel(ctx context.Context, func (n *networkHarness) OpenChannel(ctx context.Context,
srcNode, destNode lnrpc.LightningClient, amt btcutil.Amount, srcNode, destNode *lightningNode, amt btcutil.Amount,
numConfs uint32) (lnrpc.Lightning_OpenChannelClient, error) { numConfs uint32) (lnrpc.Lightning_OpenChannelClient, error) {
// TODO(roasbeef): should pass actual id instead, will fail if more // TODO(roasbeef): should pass actual id instead, will fail if more
@ -537,7 +541,7 @@ func (n *networkHarness) WaitForChannelOpen(openChanStream lnrpc.Lightning_OpenC
// CloseChannel close channel attempts to close the channel indicated by the // CloseChannel close channel attempts to close the channel indicated by the
// passed channel point, initiated by the passed lnNode. // passed channel point, initiated by the passed lnNode.
func (n *networkHarness) CloseChannel(ctx context.Context, func (n *networkHarness) CloseChannel(ctx context.Context,
lnNode lnrpc.LightningClient, cp *lnrpc.ChannelPoint, lnNode *lightningNode, cp *lnrpc.ChannelPoint,
force bool) (lnrpc.Lightning_CloseChannelClient, error) { force bool) (lnrpc.Lightning_CloseChannelClient, error) {
closeReq := &lnrpc.CloseChannelRequest{ closeReq := &lnrpc.CloseChannelRequest{
@ -586,7 +590,7 @@ func (n *networkHarness) WaitForChannelClose(closeChanStream lnrpc.Lightning_Clo
// AssertChannelExists asserts that an active channel identified by // AssertChannelExists asserts that an active channel identified by
// channelPoint is known to exist from the point-of-view of node.. // channelPoint is known to exist from the point-of-view of node..
func (n *networkHarness) AssertChannelExists(ctx context.Context, func (n *networkHarness) AssertChannelExists(ctx context.Context,
node lnrpc.LightningClient, chanPoint *wire.OutPoint) error { node *lightningNode, chanPoint *wire.OutPoint) error {
req := &lnrpc.ListPeersRequest{} req := &lnrpc.ListPeersRequest{}
peerInfo, err := node.ListPeers(ctx, req) peerInfo, err := node.ListPeers(ctx, req)
@ -605,18 +609,21 @@ func (n *networkHarness) AssertChannelExists(ctx context.Context,
return fmt.Errorf("channel not found") return fmt.Errorf("channel not found")
} }
// initRpcClient attempts to make an rpc connection, then create a gRPC client // DumpLogs reads the current logs generated by the passed node, and returns
// connected to the specified server address. // the logs as a single string. This function is useful for examining the logs
func initRpcClient(serverAddr string) (lnrpc.LightningClient, error) { // of a particular node in the case of a test failure.
opts := []grpc.DialOption{ func (n *networkHarness) DumpLogs(node *lightningNode) (string, error) {
grpc.WithInsecure(), logFile := fmt.Sprintf("%v/simnet/lnd.log", node.cfg.LogDir)
grpc.WithBlock(), f, err := os.Open(logFile)
grpc.WithTimeout(time.Second * 20),
}
conn, err := grpc.Dial(serverAddr, opts...)
if err != nil { if err != nil {
return nil, err return "", err
}
defer f.Close()
logs, err := ioutil.ReadAll(f)
if err != nil {
return "", err
} }
return lnrpc.NewLightningClient(conn), nil return string(logs), nil
} }