Skip to content

Commit ebc9f56

Browse files
committed
Initial export.
0 parents  commit ebc9f56

33 files changed

+2396
-0
lines changed

.gitignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.idea
2+
*.iml
3+
*.ipr
4+
*.iws
5+
6+
.gradle/
7+
build/
8+
target/
9+
out/
10+
11+
hs_err*.log
12+
13+
.DS_Store
14+

LICENSE

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Copyright 2017 ModelBox Inc.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at
6+
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
9+
Unless required by applicable law or agreed to in writing, software
10+
distributed under the License is distributed on an "AS IS" BASIS,
11+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
See the License for the specific language governing permissions and
13+
limitations under the License.
14+

README.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# GRPC REPL
2+
3+
This is a general-purpose read-eval-print loop tool for interacting with GRPC services for
4+
debugging and testing in an ad-hoc manner.
5+
6+
Notable features includes:
7+
* Supports RPC services defined across many `.proto` files by using a `FileDescriptorSet`
8+
as the basis for messages and methods.
9+
* Interactive tab-completion / suggestion support for message names, methods,
10+
and **message contents**.
11+
* Supports self-signed or private-CA SSL certificates.
12+
13+
## Quickstart
14+
15+
Compile your `.proto` files with `protoc` the way you normally do, but with a couple of
16+
extra flags: `--descriptor_set_out=my_protos.pb --include_imports --include_source_info` to produce
17+
a self-contained `FileDescriptorSet`.
18+
19+
Download and unpack the repl tool:
20+
21+
```sh
22+
unzip grpc-repl-0.1.zip
23+
./grpc-repl-0.1/bin/grpc-repl \
24+
-d /path/to/my_protos.pb \
25+
-t https://my.server
26+
```
27+
28+
![Demo Screencast](demo.gif)
29+
30+
## Current Status
31+
32+
Right now, this tool is pretty basic, intended mainly for creating ad-hoc queries or helping you
33+
create example payloads for documentation. The output of the help command is displayed here, which
34+
should give you an overview of what's currently possible.
35+
36+
```
37+
edit
38+
| Edit a message.
39+
|
40+
| Usage:
41+
| * edit - List all editable messages
42+
| * edit <variable> - Update an existing message
43+
| * edit <variable> <message type> - Create / replace the named message
44+
45+
header
46+
| Set a header.
47+
|
48+
| Usage:
49+
| * header - List all currently-set headers
50+
| * header <header> - Show the current value of the header
51+
| * header <header> "new value" - Set the header
52+
|
53+
| If the header name ends with "-bin", the value will be
54+
| interpreted as a base64-encoded value.
55+
56+
help
57+
| Display this message
58+
59+
messages
60+
| Describe messages types.
61+
|
62+
| TODO: Display the SourceInfo in the descriptor set
63+
|
64+
| Usage:
65+
| * messages - To print all message names
66+
| * messages mdlbx.Stat - To print message schema
67+
68+
print
69+
| Print a variable.
70+
|
71+
| Usage:
72+
| * print - List all messages
73+
| * print <variable> - Print an existing message
74+
75+
quit
76+
| Exit the tool
77+
78+
rpc
79+
| Execute an RPC call.
80+
|
81+
| If the RPC is a client-streaming message, the outgoing stream will be completed
82+
| when you type ^D. The call will be cancelled on a ^C.
83+
|
84+
| Usage:
85+
| * rpc - List all RPC methods
86+
| * rpc <method> - Call the method using an interactive editor
87+
| * rpc <method> <variable> - Call the method using the named variable
88+
| * rpc <method> <variable> <variable> .... - Call a client-streaming message
89+
90+
```

build.gradle

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
buildscript {
2+
ext.dagger_version = "2.9"
3+
ext.grpc_version = "1.3.0"
4+
ext.kotlin_version = "1.1.2"
5+
}
6+
7+
plugins {
8+
id "org.jetbrains.kotlin.jvm" version "1.1.2"
9+
id "org.jetbrains.kotlin.kapt" version "1.1.2"
10+
id "com.github.hierynomus.license" version "0.14.0"
11+
}
12+
13+
description = "ModelBox GRPC REPL"
14+
15+
apply plugin: "application"
16+
apply plugin: "idea"
17+
18+
mainClassName = "io.modelbox.repl.Repl"
19+
version = "0.1"
20+
21+
dependencies {
22+
compile "org.jetbrains.kotlin:kotlin-stdlib-jre8"
23+
compile 'org.jetbrains.kotlinx:kotlinx-coroutines-core:0.15'
24+
25+
compile "com.google.dagger:dagger:$dagger_version"
26+
kapt "com.google.dagger:dagger-compiler:$dagger_version"
27+
28+
compile 'com.google.code.gson:gson:2.8.0'
29+
compile "io.grpc:grpc-protobuf:$grpc_version"
30+
compile "io.grpc:grpc-stub:$grpc_version"
31+
compile "io.grpc:grpc-netty:$grpc_version"
32+
compile 'io.netty:netty-tcnative-boringssl-static:1.1.33.Fork26'
33+
compile 'org.jline:jline:3.3.0'
34+
}
35+
36+
idea {
37+
module {
38+
// Add the kapt output and mark it as generated
39+
sourceDirs += file("$buildDir/generated/source/kapt/main")
40+
testSourceDirs += file("$buildDir/generated/source/kapt/test")
41+
42+
generatedSourceDirs += file("$buildDir/generated/source/kapt/main")
43+
generatedSourceDirs += file("$buildDir/generated/source/kapt/test")
44+
}
45+
}
46+
47+
kotlin {
48+
experimental {
49+
coroutines "enable"
50+
}
51+
}
52+
53+
repositories {
54+
jcenter()
55+
}
56+
57+
/**
58+
* Used for development, since the gradle run task won't allow IO to be inherited.
59+
* https://github.com/jline/jline3/issues/77
60+
*/
61+
task fatJar(type: Jar) {
62+
manifest {
63+
attributes "Name": project.group,
64+
"Main-Class": project.mainClassName,
65+
"Version": project.version
66+
}
67+
classifier = 'all'
68+
from {
69+
configurations.runtime.collect { it.isDirectory() ? it : zipTree(it) }
70+
} {
71+
exclude "META-INF/*.SF"
72+
exclude "META-INF/*.DSA"
73+
exclude "META-INF/*.RSA"
74+
}
75+
with jar
76+
}

demo.gif

304 KB
Loading

gradle/wrapper/gradle-wrapper.jar

53.5 KB
Binary file not shown.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#Mon Jun 05 12:43:08 EDT 2017
2+
distributionBase=GRADLE_USER_HOME
3+
distributionPath=wrapper/dists
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists
6+
distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-all.zip

gradlew

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
#!/usr/bin/env sh
2+
3+
##############################################################################
4+
##
5+
## Gradle start up script for UN*X
6+
##
7+
##############################################################################
8+
9+
# Attempt to set APP_HOME
10+
# Resolve links: $0 may be a link
11+
PRG="$0"
12+
# Need this for relative symlinks.
13+
while [ -h "$PRG" ] ; do
14+
ls=`ls -ld "$PRG"`
15+
link=`expr "$ls" : '.*-> \(.*\)$'`
16+
if expr "$link" : '/.*' > /dev/null; then
17+
PRG="$link"
18+
else
19+
PRG=`dirname "$PRG"`"/$link"
20+
fi
21+
done
22+
SAVED="`pwd`"
23+
cd "`dirname \"$PRG\"`/" >/dev/null
24+
APP_HOME="`pwd -P`"
25+
cd "$SAVED" >/dev/null
26+
27+
APP_NAME="Gradle"
28+
APP_BASE_NAME=`basename "$0"`
29+
30+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31+
DEFAULT_JVM_OPTS=""
32+
33+
# Use the maximum available, or set MAX_FD != -1 to use that value.
34+
MAX_FD="maximum"
35+
36+
warn ( ) {
37+
echo "$*"
38+
}
39+
40+
die ( ) {
41+
echo
42+
echo "$*"
43+
echo
44+
exit 1
45+
}
46+
47+
# OS specific support (must be 'true' or 'false').
48+
cygwin=false
49+
msys=false
50+
darwin=false
51+
nonstop=false
52+
case "`uname`" in
53+
CYGWIN* )
54+
cygwin=true
55+
;;
56+
Darwin* )
57+
darwin=true
58+
;;
59+
MINGW* )
60+
msys=true
61+
;;
62+
NONSTOP* )
63+
nonstop=true
64+
;;
65+
esac
66+
67+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68+
69+
# Determine the Java command to use to start the JVM.
70+
if [ -n "$JAVA_HOME" ] ; then
71+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72+
# IBM's JDK on AIX uses strange locations for the executables
73+
JAVACMD="$JAVA_HOME/jre/sh/java"
74+
else
75+
JAVACMD="$JAVA_HOME/bin/java"
76+
fi
77+
if [ ! -x "$JAVACMD" ] ; then
78+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79+
80+
Please set the JAVA_HOME variable in your environment to match the
81+
location of your Java installation."
82+
fi
83+
else
84+
JAVACMD="java"
85+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86+
87+
Please set the JAVA_HOME variable in your environment to match the
88+
location of your Java installation."
89+
fi
90+
91+
# Increase the maximum file descriptors if we can.
92+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93+
MAX_FD_LIMIT=`ulimit -H -n`
94+
if [ $? -eq 0 ] ; then
95+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96+
MAX_FD="$MAX_FD_LIMIT"
97+
fi
98+
ulimit -n $MAX_FD
99+
if [ $? -ne 0 ] ; then
100+
warn "Could not set maximum file descriptor limit: $MAX_FD"
101+
fi
102+
else
103+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104+
fi
105+
fi
106+
107+
# For Darwin, add options to specify how the application appears in the dock
108+
if $darwin; then
109+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110+
fi
111+
112+
# For Cygwin, switch paths to Windows format before running java
113+
if $cygwin ; then
114+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116+
JAVACMD=`cygpath --unix "$JAVACMD"`
117+
118+
# We build the pattern for arguments to be converted via cygpath
119+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120+
SEP=""
121+
for dir in $ROOTDIRSRAW ; do
122+
ROOTDIRS="$ROOTDIRS$SEP$dir"
123+
SEP="|"
124+
done
125+
OURCYGPATTERN="(^($ROOTDIRS))"
126+
# Add a user-defined pattern to the cygpath arguments
127+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129+
fi
130+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
131+
i=0
132+
for arg in "$@" ; do
133+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135+
136+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138+
else
139+
eval `echo args$i`="\"$arg\""
140+
fi
141+
i=$((i+1))
142+
done
143+
case $i in
144+
(0) set -- ;;
145+
(1) set -- "$args0" ;;
146+
(2) set -- "$args0" "$args1" ;;
147+
(3) set -- "$args0" "$args1" "$args2" ;;
148+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154+
esac
155+
fi
156+
157+
# Escape application args
158+
save ( ) {
159+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160+
echo " "
161+
}
162+
APP_ARGS=$(save "$@")
163+
164+
# Collect all arguments for the java command, following the shell quoting and substitution rules
165+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166+
167+
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168+
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169+
cd "$(dirname "$0")"
170+
fi
171+
172+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)