feat: ilp-cli tool for interacting with nodes #334

bstrie · 2019-09-25T23:43:32Z

This PR adds a new command-line tool, ilp-cli. It's a beginner-friendly interface for interacting with a running interledger node. The intent is for ilp-cli to be for interledger what redis-cli is for redis-server. Right now it only includes as much functionality as is necessary (creating new accounts, posting payments, and getting account balances) to port the simple example from curl to ilp-cli. Supporting the remainder of the HTTP API will arrive in future PRs.

crates/ilp-cli/src/main.rs

Cargo.toml

crates/ilp-cli/src/main.rs

crates/interledger-api/src/lib.rs

examples/simple/README.md

emschwartz · 2019-09-26T01:54:22Z

examples/simple/README.md

-        test_equals_or_exit '{"balance":"500"}' test_http_response_body -H "Authorization: Bearer admin-a" http://localhost:7770/accounts/node_b/balance
-        test_equals_or_exit '{"balance":"-500"}' test_http_response_body -H "Authorization: Bearer admin-b" http://localhost:8770/accounts/node_a/balance
-        test_equals_or_exit '{"balance":"500"}' test_http_response_body -H "Authorization: Bearer admin-b" http://localhost:8770/accounts/bob/balance
+        test_equals_or_exit '{"balance":"-500"}' test_http_response_body -H "Authorization: Bearer admin-example" http://localhost:7770/accounts/alice/balance


Should the tests also use the CLI? @bstrie @dora-gt

Yeah I'd prefer that

hmmmm difficult question.

This simply checks, finally it worked well or not. So using cli here means mixing adulterants in. That said, actually now this is working as an integration test, using cli makes it possible to test cli itself. It might be better.

I do like the idea of using this to test the CLI as well; since this is a monorepo I think it's reasonable to make the CI test the examples and the CLI at the same time.

gakonst

added a few comments / changes above

crates/ilp-cli/src/main.rs

examples/simple/README.md

dora-gt

I just left some comments.

If we use cli in examples, we have to amend the other examples too.
I'd be happy to take it on if you want.

crates/ilp-cli/src/main.rs

dora-gt · 2019-09-26T06:15:28Z

examples/simple/README.md

-        test_equals_or_exit '{"balance":"500"}' test_http_response_body -H "Authorization: Bearer admin-a" http://localhost:7770/accounts/node_b/balance
-        test_equals_or_exit '{"balance":"-500"}' test_http_response_body -H "Authorization: Bearer admin-b" http://localhost:8770/accounts/node_a/balance
-        test_equals_or_exit '{"balance":"500"}' test_http_response_body -H "Authorization: Bearer admin-b" http://localhost:8770/accounts/bob/balance
+        test_equals_or_exit '{"balance":"-500"}' test_http_response_body -H "Authorization: Bearer admin-example" http://localhost:7770/accounts/alice/balance


hmmmm difficult question.

This simply checks, finally it worked well or not. So using cli here means mixing adulterants in. That said, actually now this is working as an integration test, using cli makes it possible to test cli itself. It might be better.

bstrie · 2019-09-26T16:01:59Z

Also note that this initial PR doesn't yet update any of the Docker side of things; wasn't sure if that ought to be left to a future PR.

bstrie · 2019-09-26T19:02:03Z

If we use cli in examples, we have to amend the other examples too.
I'd be happy to take it on if you want.

@dora-gt, I'm actually using the examples as my to-do list for which APIs to implement first, so no need. :) However, I don't intend on updating the docker side of the examples right now, and I'd be happy to have you work on that (but don't worry about doing that until after I have the examples updated).

bstrie · 2019-09-27T23:06:14Z

I've just force-pushed a rebased and squashed version with all changes since the last review.

Things not yet done:

Most of the CLI subcommands still need proper argument parsing and HTTP request logic. However, if people can confirm that the general direction of the PR looks good, this would be a very straightforward addition given how the code is currently structured.
This commit also updates the XRP settlement example, but the remaining three examples are not yet updated; I wanted to make sure that the general direction here is correct before proceeding further on that task.

emschwartz

A few comments but overall looking good

Cargo.toml

crates/ilp-cli/src/interpreter.rs

crates/ilp-cli/src/parser.rs

emschwartz · 2019-09-27T23:20:26Z

examples/simple/README.md

@@ -283,111 +288,72 @@ else
 -->

 ```bash
+# We merely use this symbolic link here to pretend that ilp-cli is installed


Suggested change

# We merely use this symbolic link here to pretend that ilp-cli is installed

# We merely use this symbolic link here to pretend that ilp-cli is installed

# You would not need this line if you installed `ilp-cli` by running `cargo install ilp-cli`

My only concern with suggesting that people use cargo install is that I worry about a situation where someone has a stale version of the CLI installed which might end up causing errors that are frustrating for users to diagnose down the road. Let me know if you think the risk here isn't worth worrying about.

Not worth it in this case. If the CLI isn't stable right now, it should be very soon

examples/simple/README.md

emschwartz · 2019-09-27T23:24:31Z

examples/xrp-settlement/README.md

@@ -385,77 +389,60 @@ else
 -->

 ```bash
+ln -s ../../target/debug/ilp-cli ilp-cli


We shouldn't do this if it doesn't work when run from a different directory

I'm not sure what the preferred alternative is; this is replacing the hideous cargo run --quiet --bin ilp-cli -- that otherwise preceded every command and served to obfuscate what the example was trying to show (and is annoyingly slower in practice, since every individual cargo run has to check to see if a recompilation should occur). We could cargo install perhaps, but that seems like a more heavyweight solution and I fear that we're going to have users accidentally managing to run old versions of the CLI and running into maddening errors.

Replacing the longer command sounds good as long as it works when called from different directories. I don't actually know if that link is relative to the file it's being called in or from the working directory. If it's the working directory, is there a way to force it to be from the perspective of the file?

examples/xrp-settlement/README.md

gakonst

Some comments, ack from me to proceed with this CLI design, its use is intuitive to me.

crates/ilp-cli/src/interpreter.rs

gakonst · 2019-10-01T14:17:52Z

crates/ilp-cli/src/interpreter.rs

-    fn put_rates(&self, matches: &ArgMatches) -> reqwest::Result<Response> {
-        unimplemented!()
+    fn put_rates(&self, matches: &ArgMatches) -> Result<Response, Error> {
+        let auth = matches.value_of("authorization_key").unwrap();


If this fails will it show that the authorization key was not found? Maybe replace the unwrap with a more verbose expect message?

I should sprinkle some more comments around here, basically the gist of this file is that anywhere you see an unwrap it's "impossible" to actually trigger a panic because if the field were omitted then Clap would have already errored out during the get_matches stage (I say "impossible" in quotes because there could always be a bug in Clap or something).

To be clear here's what the message looks like today if this field is omitted:

⌁ ./ilp-cli rates set-all -r a 1.0 error: The following required arguments were not provided: --auth <authorization_key> USAGE: ilp-cli rates set-all --auth <authorization_key> --rate <rate> <rate> For more information try --help

crates/ilp-cli/src/parser.rs

crates/ilp-cli/src/main.rs

emschwartz

Couple of comments but overall looking good

crates/ilp-cli/src/parser.rs

examples/simple/README.md

examples/xrp-settlement/README.md

refactor(ilp-cli): address low-hanging review comments docs: make nodes in simple example use different passwords refactor(ilp-cli): port simple example to new CLI interface feat(ilp-cli): skeleton of entire HTTP API refactor(ilp-cli): split out all http calls in the interpreter docs: update simple example for ilp-cli docs: update xrp example for ilp-cli

bstrie requested review from dora-gt and emschwartz September 25, 2019 23:43

emschwartz requested changes Sep 26, 2019

View reviewed changes

emschwartz requested a review from gakonst September 26, 2019 01:57

gakonst requested changes Sep 26, 2019

View reviewed changes

crates/ilp-cli/src/main.rs Outdated Show resolved Hide resolved

examples/simple/README.md Outdated Show resolved Hide resolved

dora-gt reviewed Sep 26, 2019

View reviewed changes

bstrie mentioned this pull request Sep 27, 2019

feat: allow endpoints to accept strings or numbers in JSON #347

Merged

bstrie force-pushed the bs-ilp-cli branch from 92d8068 to e2ae53d Compare September 27, 2019 22:55

emschwartz requested changes Sep 27, 2019

View reviewed changes

gakonst reviewed Sep 29, 2019

View reviewed changes

crates/ilp-cli/src/interpreter.rs Outdated Show resolved Hide resolved

crates/ilp-cli/src/interpreter.rs Outdated Show resolved Hide resolved

crates/ilp-cli/src/interpreter.rs Outdated Show resolved Hide resolved

gakonst mentioned this pull request Oct 1, 2019

Connecting to the testnet #314

Closed

bstrie force-pushed the bs-ilp-cli branch from e2ae53d to 5d2d8d8 Compare October 1, 2019 14:10

gakonst approved these changes Oct 1, 2019

View reviewed changes

emschwartz approved these changes Oct 1, 2019

View reviewed changes

bstrie force-pushed the bs-ilp-cli branch from b4f022b to aad7db9 Compare October 1, 2019 22:43

Ben Striegel and others added 8 commits October 1, 2019 15:43

feat(ilp-cli): addressing review comments and adding missing commands

c35f88d

fix: use latest secp256k1 version

6f7e9d3

feat(ilp-cli): feature-complete with tests

c27789d

docs: update simple and eth examples

8a4ea89

docs: update eth example for ilp-cli

10379d9

docs: more updates to eth example

c858152

fix(ilp-cli): last-minute tweaks

f73baf1

bstrie force-pushed the bs-ilp-cli branch from aad7db9 to f73baf1 Compare October 2, 2019 00:34

emschwartz approved these changes Oct 2, 2019

View reviewed changes

feat: quickly-assembled ilp-cli command for hackathon

d0cabf9

emschwartz approved these changes Oct 2, 2019

View reviewed changes

style: fix clippy

81f48db

bstrie merged commit eeda36c into master Oct 2, 2019

bstrie deleted the bs-ilp-cli branch October 2, 2019 02:50

emschwartz mentioned this pull request Oct 2, 2019

Add CLI functions that call HTTP API #228

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: ilp-cli tool for interacting with nodes #334

feat: ilp-cli tool for interacting with nodes #334

bstrie commented Sep 25, 2019 •

edited

Loading

emschwartz Sep 26, 2019

gakonst Sep 26, 2019

dora-gt Sep 26, 2019

bstrie Sep 26, 2019 •

edited

Loading

gakonst left a comment

dora-gt left a comment

dora-gt Sep 26, 2019

bstrie commented Sep 26, 2019

bstrie commented Sep 26, 2019

bstrie commented Sep 27, 2019

emschwartz left a comment

emschwartz Sep 27, 2019

bstrie Sep 30, 2019

emschwartz Sep 30, 2019

emschwartz Sep 27, 2019

bstrie Sep 30, 2019

emschwartz Sep 30, 2019

gakonst left a comment

gakonst Oct 1, 2019

bstrie Oct 1, 2019

bstrie Oct 1, 2019

emschwartz left a comment

	# We merely use this symbolic link here to pretend that ilp-cli is installed
	# We merely use this symbolic link here to pretend that ilp-cli is installed
	# You would not need this line if you installed `ilp-cli` by running `cargo install ilp-cli`

feat: ilp-cli tool for interacting with nodes #334

feat: ilp-cli tool for interacting with nodes #334

Conversation

bstrie commented Sep 25, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bstrie Sep 26, 2019 • edited Loading

Choose a reason for hiding this comment

gakonst left a comment

Choose a reason for hiding this comment

dora-gt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bstrie commented Sep 26, 2019

bstrie commented Sep 26, 2019

bstrie commented Sep 27, 2019

emschwartz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gakonst left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emschwartz left a comment

Choose a reason for hiding this comment

bstrie commented Sep 25, 2019 •

edited

Loading

bstrie Sep 26, 2019 •

edited

Loading