From 5d25fc1f16a4060e98deff007a0bda0759d4745e Mon Sep 17 00:00:00 2001 From: Stephen Whitmore Date: Wed, 27 Apr 2016 09:31:06 -0700 Subject: [PATCH] unix-friendly output for 'ipfs dht' commands (#2560) * Cleans up 'ipfs dht findpeer' output License: MIT Signed-off-by: Stephen Whitmore * Adds more docs for 'ipfs dht put'. License: MIT Signed-off-by: Stephen Whitmore * Write pretty peer ids for ipfs dht put. License: MIT Signed-off-by: Stephen Whitmore * Writes pretty peer ids for ipfs dht query. License: MIT Signed-off-by: Stephen Whitmore * Suppresses unrecognized event type for FinalPeer. License: MIT Signed-off-by: Stephen Whitmore * Improves helptext on dht commands. License: MIT Signed-off-by: Stephen Whitmore * Adds 'ipfs dht findpeer' sharness test. License: MIT Signed-off-by: Stephen Whitmore * Adds sharness tests for remaining DHT commands. License: MIT Signed-off-by: Stephen Whitmore * Uses bash tests rather than 'test' command. License: MIT Signed-off-by: Stephen Whitmore * Removes commented code. License: MIT Signed-off-by: Stephen Whitmore * Removes unneeded init_ipfs. License: MIT Signed-off-by: Stephen Whitmore * Tweaks iptb setup. License: MIT Signed-off-by: Stephen Whitmore * Tweaks wording on dht 'put' and 'get'. License: MIT Signed-off-by: Stephen Whitmore * Removes extraneous ). License: MIT Signed-off-by: Stephen Whitmore * Removes apostrophe. License: MIT Signed-off-by: Stephen Whitmore * Tests the expected peer addresses. License: MIT Signed-off-by: Stephen Whitmore * Gets peer id using iptb. License: MIT Signed-off-by: Stephen Whitmore * Checks explicitly for common put/findprovs peers. License: MIT Signed-off-by: Stephen Whitmore * Sorts expected/actual findpeer results. License: MIT Signed-off-by: Stephen Whitmore * Fix disconnect argument description License: MIT Signed-off-by: Richard Littauer * Fixes sort order in t0170-dht.sh. License: MIT Signed-off-by: Stephen Whitmore --- core/commands/dht.go | 83 +++++++++++++++++++++++++------------- test/sharness/t0170-dht.sh | 65 +++++++++++++++++++++++++++++ 2 files changed, 120 insertions(+), 28 deletions(-) create mode 100755 test/sharness/t0170-dht.sh diff --git a/core/commands/dht.go b/core/commands/dht.go index 0b005f244..36a571da4 100644 --- a/core/commands/dht.go +++ b/core/commands/dht.go @@ -35,15 +35,15 @@ var DhtCmd = &cmds.Command{ var queryDhtCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Find the closest peers to a given key by querying through the DHT.", - ShortDescription: ``, + Tagline: "Find the closest Peer IDs to a given Peer ID by querying the DHT.", + ShortDescription: "Outputs a list of newline-delimited Peer IDs.", }, Arguments: []cmds.Argument{ cmds.StringArg("peerID", true, true, "The peerID to run the query against."), }, Options: []cmds.Option{ - cmds.BoolOption("verbose", "v", "Write extra information."), + cmds.BoolOption("verbose", "v", "Write debug information."), }, Run: func(req cmds.Request, res cmds.Response) { n, err := req.InvocContext().GetNode() @@ -94,6 +94,14 @@ var queryDhtCmd = &cmds.Command{ return nil, u.ErrCast() } + pfm := pfuncMap{ + notif.PeerResponse: func(obj *notif.QueryEvent, out io.Writer, verbose bool) { + for _, p := range obj.Responses { + fmt.Fprintf(out, "%s\n", p.ID.Pretty()) + } + }, + } + marshal := func(v interface{}) (io.Reader, error) { obj, ok := v.(*notif.QueryEvent) if !ok { @@ -103,7 +111,7 @@ var queryDhtCmd = &cmds.Command{ verbose, _, _ := res.Request().Option("v").Bool() buf := new(bytes.Buffer) - printEvent(obj, buf, verbose, nil) + printEvent(obj, buf, verbose, pfm) return buf, nil } @@ -119,17 +127,15 @@ var queryDhtCmd = &cmds.Command{ var findProvidersDhtCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Run a 'FindProviders' query through the DHT.", - ShortDescription: ` -FindProviders will return a list of peers who are able to provide the value requested. -`, + Tagline: "Find peers in the DHT that can provide a specific value, given a key.", + ShortDescription: "Outputs a list of newline-delimited provider Peer IDs.", }, Arguments: []cmds.Argument{ cmds.StringArg("key", true, true, "The key to find providers for."), }, Options: []cmds.Option{ - cmds.BoolOption("verbose", "v", "Write extra information."), + cmds.BoolOption("verbose", "v", "Write debug information."), }, Run: func(req cmds.Request, res cmds.Response) { n, err := req.InvocContext().GetNode() @@ -222,12 +228,15 @@ FindProviders will return a list of peers who are able to provide the value requ var findPeerDhtCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Run a 'FindPeer' query through the DHT.", - ShortDescription: ``, + Tagline: "Query the DHT for all of the multiaddresses associated with a Peer ID.", + ShortDescription: "Outputs a list of newline-delimited multiaddresses.", }, Arguments: []cmds.Argument{ - cmds.StringArg("peerID", true, true, "The peer to search for."), + cmds.StringArg("peerID", true, true, "The ID of the peer to search for."), + }, + Options: []cmds.Option{ + cmds.BoolOption("verbose", "v", "Write debug information."), }, Run: func(req cmds.Request, res cmds.Response) { n, err := req.InvocContext().GetNode() @@ -285,12 +294,13 @@ var findPeerDhtCmd = &cmds.Command{ return nil, u.ErrCast() } + verbose, _, _ := res.Request().Option("v").Bool() + pfm := pfuncMap{ notif.FinalPeer: func(obj *notif.QueryEvent, out io.Writer, verbose bool) { pi := obj.Responses[0] - fmt.Fprintf(out, "%s\n", pi.ID) for _, a := range pi.Addrs { - fmt.Fprintf(out, "\t%s\n", a) + fmt.Fprintf(out, "%s\n", a) } }, } @@ -301,7 +311,7 @@ var findPeerDhtCmd = &cmds.Command{ } buf := new(bytes.Buffer) - printEvent(obj, buf, true, pfm) + printEvent(obj, buf, verbose, pfm) return buf, nil } @@ -317,9 +327,11 @@ var findPeerDhtCmd = &cmds.Command{ var getValueDhtCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Run a 'GetValue' query through the DHT.", + Tagline: "Given a key, query the DHT for its best value.", ShortDescription: ` -GetValue will return the value stored in the DHT at the given key. +Outputs the best value for the given key. + +There may be several different values for a given key stored in the DHT; in this context 'best' means the record that is most desirable. There is no one metric for 'best': it depends entirely on the key type. For IPNS, 'best' is the record that is both valid and has the highest sequence number (freshest). Different key types can specify other 'best' rules. `, }, @@ -327,7 +339,7 @@ GetValue will return the value stored in the DHT at the given key. cmds.StringArg("key", true, true, "The key to find a value for."), }, Options: []cmds.Option{ - cmds.BoolOption("verbose", "v", "Write extra information."), + cmds.BoolOption("verbose", "v", "Write debug information."), }, Run: func(req cmds.Request, res cmds.Response) { n, err := req.InvocContext().GetNode() @@ -420,9 +432,17 @@ GetValue will return the value stored in the DHT at the given key. var putValueDhtCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Run a 'PutValue' query through the DHT.", + Tagline: "Write a key/value pair to the DHT.", ShortDescription: ` -PutValue will store the given key value pair in the DHT. +Given a key of the form /foo/bar and a value of any form, this will write that value to the DHT with that key. + +Keys have two parts: a keytype (foo) and the key name (bar). IPNS uses the /ipns keytype, and expects the key name to be a Peer ID. IPNS entries are specifically formatted (protocol buffer). + +You may only use keytypes that are supported in your ipfs binary: currently this is only /ipns. Unless you have a relatively deep understanding of the go-ipfs DHT internals, you likely want to be using 'ipfs name publish' instead of this. + +Value is arbitrary text. Standard input can be used to provide value. + +NOTE: a value may NOT exceed 2048 bytes. `, }, @@ -431,7 +451,7 @@ PutValue will store the given key value pair in the DHT. cmds.StringArg("value", true, false, "The value to store.").EnableStdin(), }, Options: []cmds.Option{ - cmds.BoolOption("verbose", "v", "Write extra information."), + cmds.BoolOption("verbose", "v", "Write debug information."), }, Run: func(req cmds.Request, res cmds.Response) { n, err := req.InvocContext().GetNode() @@ -493,7 +513,7 @@ PutValue will store the given key value pair in the DHT. } }, notif.Value: func(obj *notif.QueryEvent, out io.Writer, verbose bool) { - fmt.Fprintf(out, "storing value at %s\n", obj.ID) + fmt.Fprintf(out, "%s\n", obj.ID.Pretty()) }, } @@ -546,13 +566,17 @@ func printEvent(obj *notif.QueryEvent, out io.Writer, verbose bool, override pfu fmt.Fprint(out, obj.Extra) } case notif.PeerResponse: - fmt.Fprintf(out, "* %s says use ", obj.ID) - for _, p := range obj.Responses { - fmt.Fprintf(out, "%s ", p.ID) + if verbose { + fmt.Fprintf(out, "* %s says use ", obj.ID) + for _, p := range obj.Responses { + fmt.Fprintf(out, "%s ", p.ID) + } + fmt.Fprintln(out) } - fmt.Fprintln(out) case notif.QueryError: - fmt.Fprintf(out, "error: %s\n", obj.Extra) + if verbose { + fmt.Fprintf(out, "error: %s\n", obj.Extra) + } case notif.DialingPeer: if verbose { fmt.Fprintf(out, "dialing peer: %s\n", obj.ID) @@ -561,8 +585,11 @@ func printEvent(obj *notif.QueryEvent, out io.Writer, verbose bool, override pfu if verbose { fmt.Fprintf(out, "adding peer to query: %s\n", obj.ID) } + case notif.FinalPeer: default: - fmt.Fprintf(out, "unrecognized event type: %d\n", obj.Type) + if verbose { + fmt.Fprintf(out, "unrecognized event type: %d\n", obj.Type) + } } } diff --git a/test/sharness/t0170-dht.sh b/test/sharness/t0170-dht.sh new file mode 100755 index 000000000..978c0272b --- /dev/null +++ b/test/sharness/t0170-dht.sh @@ -0,0 +1,65 @@ +#!/bin/sh + +test_description="Test dht command" + +. lib/test-lib.sh + +# start iptb + wait for peering +NUM_NODES=5 +test_expect_success 'init iptb' ' + iptb init -n $NUM_NODES --bootstrap=none --port=0 && + startup_cluster $NUM_NODES +' + +test_expect_success 'peer ids' ' + PEERID_0=$(iptb get id 0) && + PEERID_2=$(iptb get id 2) +' + +# ipfs dht findpeer +test_expect_success 'findpeer' ' + ipfsi 1 dht findpeer $PEERID_0 | sort >actual && + echo "$(ipfsi 0 id -f "" | cut -d / -f 1-5 | sort >expected)" + test_cmp actual expected +' + +# ipfs dht put +test_expect_success 'put' ' + ipfsi 1 dht put planet pluto | sort >putted && + [ -s putted ] || + test_fsh cat putted +' + +# ipfs dht findprovs +test_expect_success 'findprovs' ' + ipfsi 4 dht findprovs planet | sort >provs && + sort provs putted | uniq -d >actual && + [ -s actual ] || + test_fsh cat actual +' + +# ipfs dht get +test_expect_success 'get' ' + ipfsi 0 dht put bar foo >actual && + ipfsi 4 dht get -v bar >actual && + egrep "error: record key does not have selectorfunc" actual > /dev//null || + test_fsh cat actual +' + +# ipfs dht query +## We query 3 different keys, to statisically lower the chance that the queryer +## turns out to be the closest to what a key hashes to. +test_expect_success 'query' ' + ipfsi 3 dht query banana >actual && + ipfsi 3 dht query apple >>actual && + ipfsi 3 dht query pear >>actual && + PEERS=$(wc -l actual | cut -d '"'"' '"'"' -f 1) && + [ -s actual ] || + test_fsh cat actual +' + +test_expect_success 'stop iptb' ' + iptb stop +' + +test_done