Skip to content

Commit

Permalink
Initial export.
Browse files Browse the repository at this point in the history
  • Loading branch information
bobvawter committed Jun 5, 2017
0 parents commit ebc9f56
Show file tree
Hide file tree
Showing 33 changed files with 2,396 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.idea
*.iml
*.ipr
*.iws

.gradle/
build/
target/
out/

hs_err*.log

.DS_Store

14 changes: 14 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Copyright 2017 ModelBox Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

90 changes: 90 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# GRPC REPL

This is a general-purpose read-eval-print loop tool for interacting with GRPC services for
debugging and testing in an ad-hoc manner.

Notable features includes:
* Supports RPC services defined across many `.proto` files by using a `FileDescriptorSet`
as the basis for messages and methods.
* Interactive tab-completion / suggestion support for message names, methods,
and **message contents**.
* Supports self-signed or private-CA SSL certificates.

## Quickstart

Compile your `.proto` files with `protoc` the way you normally do, but with a couple of
extra flags: `--descriptor_set_out=my_protos.pb --include_imports --include_source_info` to produce
a self-contained `FileDescriptorSet`.

Download and unpack the repl tool:

```sh
unzip grpc-repl-0.1.zip
./grpc-repl-0.1/bin/grpc-repl \
-d /path/to/my_protos.pb \
-t https://my.server
```

![Demo Screencast](demo.gif)

## Current Status

Right now, this tool is pretty basic, intended mainly for creating ad-hoc queries or helping you
create example payloads for documentation. The output of the help command is displayed here, which
should give you an overview of what's currently possible.

```
edit
| Edit a message.
|
| Usage:
| * edit - List all editable messages
| * edit <variable> - Update an existing message
| * edit <variable> <message type> - Create / replace the named message
header
| Set a header.
|
| Usage:
| * header - List all currently-set headers
| * header <header> - Show the current value of the header
| * header <header> "new value" - Set the header
|
| If the header name ends with "-bin", the value will be
| interpreted as a base64-encoded value.
help
| Display this message
messages
| Describe messages types.
|
| TODO: Display the SourceInfo in the descriptor set
|
| Usage:
| * messages - To print all message names
| * messages mdlbx.Stat - To print message schema
print
| Print a variable.
|
| Usage:
| * print - List all messages
| * print <variable> - Print an existing message
quit
| Exit the tool
rpc
| Execute an RPC call.
|
| If the RPC is a client-streaming message, the outgoing stream will be completed
| when you type ^D. The call will be cancelled on a ^C.
|
| Usage:
| * rpc - List all RPC methods
| * rpc <method> - Call the method using an interactive editor
| * rpc <method> <variable> - Call the method using the named variable
| * rpc <method> <variable> <variable> .... - Call a client-streaming message
```
76 changes: 76 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
buildscript {
ext.dagger_version = "2.9"
ext.grpc_version = "1.3.0"
ext.kotlin_version = "1.1.2"
}

plugins {
id "org.jetbrains.kotlin.jvm" version "1.1.2"
id "org.jetbrains.kotlin.kapt" version "1.1.2"
id "com.github.hierynomus.license" version "0.14.0"
}

description = "ModelBox GRPC REPL"

apply plugin: "application"
apply plugin: "idea"

mainClassName = "io.modelbox.repl.Repl"
version = "0.1"

dependencies {
compile "org.jetbrains.kotlin:kotlin-stdlib-jre8"
compile 'org.jetbrains.kotlinx:kotlinx-coroutines-core:0.15'

compile "com.google.dagger:dagger:$dagger_version"
kapt "com.google.dagger:dagger-compiler:$dagger_version"

compile 'com.google.code.gson:gson:2.8.0'
compile "io.grpc:grpc-protobuf:$grpc_version"
compile "io.grpc:grpc-stub:$grpc_version"
compile "io.grpc:grpc-netty:$grpc_version"
compile 'io.netty:netty-tcnative-boringssl-static:1.1.33.Fork26'
compile 'org.jline:jline:3.3.0'
}

idea {
module {
// Add the kapt output and mark it as generated
sourceDirs += file("$buildDir/generated/source/kapt/main")
testSourceDirs += file("$buildDir/generated/source/kapt/test")

generatedSourceDirs += file("$buildDir/generated/source/kapt/main")
generatedSourceDirs += file("$buildDir/generated/source/kapt/test")
}
}

kotlin {
experimental {
coroutines "enable"
}
}

repositories {
jcenter()
}

/**
* Used for development, since the gradle run task won't allow IO to be inherited.
* https://github.com/jline/jline3/issues/77
*/
task fatJar(type: Jar) {
manifest {
attributes "Name": project.group,
"Main-Class": project.mainClassName,
"Version": project.version
}
classifier = 'all'
from {
configurations.runtime.collect { it.isDirectory() ? it : zipTree(it) }
} {
exclude "META-INF/*.SF"
exclude "META-INF/*.DSA"
exclude "META-INF/*.RSA"
}
with jar
}
Binary file added demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
6 changes: 6 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#Mon Jun 05 12:43:08 EDT 2017
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-all.zip
172 changes: 172 additions & 0 deletions gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
#!/usr/bin/env sh

##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################

# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null

APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"

warn ( ) {
echo "$*"
}

die ( ) {
echo
echo "$*"
echo
exit 1
}

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar

# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi

# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi

# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`

# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option

if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi

# Escape application args
save ( ) {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")

# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"

# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi

exec "$JAVACMD" "$@"
Loading

0 comments on commit ebc9f56

Please sign in to comment.