README
¶
Motivation
Evans has been created to use easier than other existing gRPC clients.
If you want to keep your product quality, you must use CI with gRPC testing, should not do use manual testing.
Evans will complete your other use cases just like:
- Manually gRPC API inspection
- To automate some tasks by scripting
The above use cases are corresponding to Evans's two modes, REPL mode, and CLI mode.
REPL mode
REPL mode is the solution for first use case.
You can use it without thinking like the package name, service name, RPC name, command usage, and so on because REPL mode has powerful completion!
CLI mode
CLI mode is a stateless mode just like grpc-ecosystem/polyglot.
It sends one request per one command as its name suggests.
So it is based on UNIX philosophy.
For example, read inputs from stdin, the command will be a filter command.
On the other hand, the command result will be outputted to stdout by JSON formatted.
So, you can format it by any commands like jq. Also, if you want to use the same command (e.g. use same JSON inputs), you can use --file (-f) option.
Table of Contents
- Installation
- Usage (REPL)
- Usage (CLI)
- Other features
- Supported IDL (interface definition language)
- Supported Codec
- Supported Compressor
- See Also
Installation
Highly recommended methods are GitHub Releases or Homebrew because these can be updated automatically by the built-in feature in Evans.
From GitHub Releases
Please see GitHub Releases.
Available binaries are:
- macOS
- Linux
- Windows
macOS
$ brew tap ktr0731/evans
$ brew install evans
[Not-recommended] go install
Go v1.16 or later is required.
$ go install github.com/ktr0731/evans@latest
Usage (REPL)
Basic usage
Evans consists of some commands in REPL mode.
The proto file which read in the demonstration and its implementation are available at ktr0731/grpc-test.
grpc-test's details can see grpc-test --help.
Enter to REPL.
$ cd grpc-test
$ evans repl api/api.proto
If your server is enabling gRPC reflection, you can launch Evans with only -r (--reflection) option.
$ evans -r repl
Also if the server requires secure TLS connections, you can launch Evans with the -t (--tls) option.
$ evans --tls --host example.com -r repl
To show package names of proto files REPL read:
> show package
+---------+
| PACKAGE |
+---------+
| api |
+---------+
To show the summary of services or messages:
> package api
> show service
+---------+----------------------+-----------------------------+----------------+
| SERVICE | RPC | REQUESTTYPE | RESPONSETYPE |
+---------+----------------------+-----------------------------+----------------+
| Example | Unary | SimpleRequest | SimpleResponse |
| | UnaryMessage | UnaryMessageRequest | SimpleResponse |
| | UnaryRepeated | UnaryRepeatedRequest | SimpleResponse |
| | UnaryRepeatedMessage | UnaryRepeatedMessageRequest | SimpleResponse |
| | UnaryRepeatedEnum | UnaryRepeatedEnumRequest | SimpleResponse |
| | UnarySelf | UnarySelfRequest | SimpleResponse |
| | UnaryMap | UnaryMapRequest | SimpleResponse |
| | UnaryMapMessage | UnaryMapMessageRequest | SimpleResponse |
| | UnaryOneof | UnaryOneofRequest | SimpleResponse |
| | UnaryEnum | UnaryEnumRequest | SimpleResponse |
| | UnaryBytes | UnaryBytesRequest | SimpleResponse |
| | ClientStreaming | SimpleRequest | SimpleResponse |
| | ServerStreaming | SimpleRequest | SimpleResponse |
| | BidiStreaming | SimpleRequest | SimpleResponse |
+---------+----------------------+-----------------------------+----------------+
> show message
+-----------------------------+
| MESSAGE |
+-----------------------------+
| SimpleRequest |
| SimpleResponse |
| Name |
| UnaryMessageRequest |
| UnaryRepeatedRequest |
| UnaryRepeatedMessageRequest |
| UnaryRepeatedEnumRequest |
| UnarySelfRequest |
| Person |
| UnaryMapRequest |
| UnaryMapMessageRequest |
| UnaryOneofRequest |
| UnaryEnumRequest |
| UnaryBytesRequest |
+-----------------------------+
To show more description of a message:
> desc SimpleRequest
+-------+-------------+
| FIELD | TYPE |
+-------+-------------+
| name | TYPE_STRING |
+-------+-------------+
Set headers for each request:
> header foo=bar
To show headers:
> show header
+-------------+-------+
| KEY | VAL |
+-------------+-------+
| foo | bar |
| grpc-client | evans |
+-------------+-------+
Note that if you want to set comma-included string to a header value, it is required to specify --raw option.
To remove the added header:
> header foo
> show header
+-------------+-------+
| KEY | VAL |
+-------------+-------+
| grpc-client | evans |
+-------------+-------+
Call a RPC:
> service Example
> call Unary
name (TYPE_STRING) => ktr
{
"message": "hello, ktr"
}
Evans constructs a gRPC request interactively and sends the request to a gRPC server.
Finally, Evans prints the JSON formatted result.
Repeated fields
repeated is an array-like data structure.
You can input some values and finish with CTRL-D
> call UnaryRepeated
<repeated> name (TYPE_STRING) => foo
<repeated> name (TYPE_STRING) => bar
<repeated> name (TYPE_STRING) => baz
<repeated> name (TYPE_STRING) =>
{
"message": "hello, foo, bar, baz"
}
Enum fields
You can select one from the proposed selections.
When CTRL-C is entered, default value 0 will be used.
When CTRL-D is entered, inputting will be aborted.
> call UnaryEnum
? UnaryEnumRequest [Use arrows to move, type to filter]
> Male
Female
{
"message": "M"
}
Bytes type fields
You can use byte literal and Unicode literal.
> call UnaryBytes
data (TYPE_BYTES) => \x46\x6f\x6f
{
"message": "received: (bytes) 46 6f 6f, (string) Foo"
}
> call UnaryBytes
data (TYPE_BYTES) => \u65e5\u672c\u8a9e
{
"message": "received: (bytes) e6 97 a5 e6 9c ac e8 aa 9e, (string) 日本語"
}
Or add the flag --bytes-from-file to read bytes from the provided relative path
> call UnaryBytes --bytes-from-file
data (TYPE_BYTES) => ../relative/path/to/file
Client streaming RPC
Client streaming RPC accepts some requests and then returns only one response.
Finish request inputting with CTRL-D
> call ClientStreaming
name (TYPE_STRING) => ktr
name (TYPE_STRING) => ktr
name (TYPE_STRING) => ktr
name (TYPE_STRING) =>
{
"message": "ktr, you greet 3 times."
}
Server streaming RPC
Server streaming RPC accepts only one request and then returns some responses. Each response is represented as another JSON formatted output.
name (TYPE_STRING) => ktr
{
"message": "hello ktr, I greet 0 times."
}
{
"message": "hello ktr, I greet 1 times."
}
Bidirectional streaming RPC
Bidirectional streaming RPC accepts some requests and returns some responses corresponding to each request. Finish request inputting with CTRL-D
> call BidiStreaming
name (TYPE_STRING) => foo
{
"message": "hello foo, I greet 0 times."
}
{
"message": "hello foo, I greet 1 times."
}
{
"message": "hello foo, I greet 2 times."
}
name (TYPE_STRING) => bar
{
"message": "hello bar, I greet 0 times."
}
name (TYPE_STRING) =>
Skip the rest of the fields
Evans recognizes CTRL-C as a special key that skips the rest of the fields in the current message type.
For example, we assume that we are inputting Request described in the following message:
message FullName {
string first_name = 1;
string last_name = 2;
}
message Request {
string nickname = 1;
FullName full_name = 2;
}
If we enter CTRL-C at the following moment, full_name field will be skipped.
nickname (TYPE_STRING) =>
The actual request value is just like this.
{}
If we enter CTRL-C at the following moment, last_name field will be skipped.
nickname (TYPE_STRING) => myamori
full_name::first_name (TYPE_STRING) => aoi
full_name::last_name (TYPE_STRING) =>
The actual request value is just like this.
{
"nickname": "myamori",
"fullName": {
"firstName": "aoi"
}
}
By default, Evans digs down each message field automatically.
For example, we assume that we are inputting Request described in the following message:
message FullName {
string first_name = 1;
string last_name = 2;
}
message Request {
FullName full_name = 1;
}
In this case, REPL prompts full_name.first_name automatically. To skip full_name itself, we can use --dig-manually option.
It asks whether dig down a message field when the prompt encountered it.
Enriched response
To display more enriched response, you can use --enrich option.
> call --enrich Unary
name (TYPE_STRING) => ktr
content-type: application/grpc
header_key1: header_val1
header_key2: header_val2
{
"message": "hello, ktr"
}
trailer_key1: trailer_val1
trailer_key2: trailer_val2
code: OK
number: 0
message: ""
Repeat the previous call
With --repeat option, you can repeat the previous call with the same input.
Note that Client/Bidirectional streaming RPC is not supported.
> call Unary
name (TYPE_STRING) => ktr
{
"message": "hello, ktr"
}
> call --repeat Unary
name (TYPE_STRING) => ktr
{
"message": "hello, ktr"
}
Usage (CLI)
Basic usage
CLI mode also has some commands.
list command provides gRPC service inspection against to the gRPC server.
$ evans -r cli list
api.Example
grpc.reflection.v1alpha.ServerReflection
If an service name is specified, it displays methods belonging to the service.
$ evans -r cli list api.Example
api.Example.Unary
api.Example.UnaryBytes
api.Example.UnaryEnum
...
desc command describes the passed symbol (service, method, message, and so on).
api.Example:
service Example {
rpc Unary ( .api.SimpleRequest ) returns ( .api.SimpleResponse );
rpc UnaryBytes ( .api.UnaryBytesRequest ) returns ( .api.SimpleResponse );
rpc UnaryEnum ( .api.UnaryEnumRequest ) returns ( .api.SimpleResponse );
...
}
call command invokes a method.
You can input requests from stdin or files.
Use --file (-f) to specify a file.
$ cat request.json
{
"name": "ktr"
}
$ evans --proto api/api.proto cli call --file request.json api.Example.Unary
{
"message": "hello, ktr"
}
If gRPC reflection is enabled, --reflection (-r) is available instead of specifying proto files.
$ evans -r cli call --file request.json api.Example.Unary
{
"message": "hello, ktr"
}
Use stdin.
$ echo '{ "name": "ktr" }' | evans cli call api.Example.Unary
{
"message": "hello, ktr"
}
If .evans.toml is exist in Git project root, you can denote default values.
[default]
protoFile = ["api/api.proto"]
package = "api"
service = "Example"
Then, the command will be more clear.
$ echo '{ "name": "ktr" }' | evans cli call Unary
{
"message": "hello, ktr"
}
Repeated fields
$ echo '{ "name": ["foo", "bar"] }' | evans -r cli call api.Example.UnaryRepeated
{
"message": "hello, foo, bar"
}
Enum fields
$ echo '{ "choice": 0 }' | evans -r cli call api.Example.UnaryEnum
{
"message": "1"
}
Bytes type fields
You need to encode bytes by Base64.
This constraint is come from Go's standard package encoding/json
$ echo 'Foo' | base64
Rm9vCg==
$ echo '{"data": "Rm9vCg=="}' | evans -r cli call api.Example.UnaryBytes
Client streaming RPC
$ echo '{ "name": "ktr" } { "name": "ktr" }' | evans -r cli call api.Example.ClientStreaming
{
"message": "ktr, you greet 2 times."
}
Server streaming RPC
$ echo '{ "name": "ktr" }' | evans -r cli call api.Example.ServerStreaming
{
"message": "hello ktr, I greet 0 times."
}
{
"message": "hello ktr, I greet 1 times."
}
{
"message": "hello ktr, I greet 2 times."
}
Bidirectional streaming RPC
$ echo '{ "name": "foo" } { "name": "bar" }' | evans -r cli call api.Example.BidiStreaming
{
"message": "hello foo, I greet 0 times."
}
{
"message": "hello foo, I greet 1 times."
}
{
"message": "hello foo, I greet 2 times."
}
{
"message": "hello foo, I greet 3 times."
}
{
"message": "hello bar, I greet 0 times."
}
Enriched response
To display more enriched response, you can use --enrich option.
$ echo '{"name": "ktr"}' | evans -r cli call --enrich api.Example.Unary ~/.ghq/src/github.com/ktr0731/grpc-test master
content-type: application/grpc
header_key1: header_val1
header_key2: header_val2
{
"message": "hello, ktr"
}
trailer_key1: trailer_val1
trailer_key2: trailer_val2
code: OK
number: 0
message: ""
JSON output is also available with --json option.
Other features
gRPC-Web
Evans also support gRPC-Web protocol.
Tested gRPC-Web implementations are:
At the moment TLS is not supported for gRPC-Web.
Supported IDL (interface definition language)
Supported Codec
Supported Compressor
See Also
Evans (DJ YOSHITAKA)
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package app provides the entrypoint for Evans.
|
Package app provides the entrypoint for Evans. |
|
Package cache provides a cache mechanism for the app.
|
Package cache provides a cache mechanism for the app. |
|
Package config provides config structures, and a mechanism that merges sources such that the global config file, a project local config file and command line flags.
|
Package config provides config structures, and a mechanism that merges sources such that the global config file, a project local config file and command line flags. |
|
Package cui defines charcter user interfaces for I/O.
|
Package cui defines charcter user interfaces for I/O. |
|
Package e2e is an E2E testing package.
|
Package e2e is an E2E testing package. |
|
e2egen
Package main provides a generator for E2E test cases.
|
Package main provides a generator for E2E test cases. |
|
Package fill provides fillers that fills each field with a value.
|
Package fill provides fillers that fills each field with a value. |
|
proto
Package proto provides a filler implementation for Protocol Buffers.
|
Package proto provides a filler implementation for Protocol Buffers. |
|
Package format provides formatting APIs for display processed result application did.
|
Package format provides formatting APIs for display processed result application did. |
|
curl
Package curl provides a curl-like formatter implementation.
|
Package curl provides a curl-like formatter implementation. |
|
json
Package json provides a JSON formatter implementation.
|
Package json provides a JSON formatter implementation. |
|
Package grpc implements gRPC clients.
|
Package grpc implements gRPC clients. |
|
grpcreflection
Package grpcreflection provides gRPC reflection client.
|
Package grpcreflection provides gRPC reflection client. |
|
Package idl represents an Interface Definition Language (IDL) for gRPC.
|
Package idl represents an Interface Definition Language (IDL) for gRPC. |
|
proto
Package proto implements idl.Spec for Protocol Buffers.
|
Package proto implements idl.Spec for Protocol Buffers. |
|
Package logger provides logging functions.
|
Package logger provides logging functions. |
|
Package mode provides entrypoints for all modes that are provided from Evans.
|
Package mode provides entrypoints for all modes that are provided from Evans. |
|
Package present defines a presenter for formatting response types represented by the codec.
|
Package present defines a presenter for formatting response types represented by the codec. |
|
json
Package json provides a JSON presenter that formatting.
|
Package json provides a JSON presenter that formatting. |
|
table
Package table provides a table like formatting.
|
Package table provides a table like formatting. |
|
Package prompt provides the prompt interface and its implementation.
|
Package prompt provides the prompt interface and its implementation. |
|
Package repl provides a REPL environment for REPL mode.
|
Package repl provides a REPL environment for REPL mode. |
|
Package usecase provides all use-case logics used from each mode.
|
Package usecase provides all use-case logics used from each mode. |