aboutsummaryrefslogtreecommitdiff
path: root/gae-interop-testing/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'gae-interop-testing/README.md')
-rw-r--r--gae-interop-testing/README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/gae-interop-testing/README.md b/gae-interop-testing/README.md
new file mode 100644
index 000000000..1f9bea364
--- /dev/null
+++ b/gae-interop-testing/README.md
@@ -0,0 +1,49 @@
+Google App Engine interop tests
+=====================================
+
+This directory contains interop tests that runs in Google App Engine
+as gRPC clients.
+
+Prerequisites
+==========================
+
+- Install the Google Cloud SDK and ensure that `gcloud` is in the path
+- Set up an [App Engine app](http://appengine.google.com) with your
+ choice of a PROJECT_ID.
+- Associate your `gcloud` environment with your app:
+ ```bash
+ # Log into Google Cloud
+ $ gcloud auth login
+
+ # Associate this codebase with a GAE project
+ $ gcloud config set project PROJECT_ID
+ ```
+
+Running the tests in GAE
+==========================
+
+You can run the gradle task to execute the interop tests.
+```bash
+# cd into either gae-jdk7 or gae-jdk8
+$ ./gradlew runInteropTestRemote
+
+# Or run one of these from the root gRPC Java directory:
+$ ./gradlew :grpc-gae-interop-testing-jdk7:runInteropTestRemote
+$ ./gradlew :grpc-gae-interop-testing-jdk8:runInteropTestRemote
+```
+
+Optional:
+
+You can also browse to `http://${PROJECT_ID}.appspot.google.com` to
+see the result of the interop test.
+
+
+Debugging
+==========================
+
+You can find the server side logs by logging into
+`http://appengine.google.com` and scrolling down to the section titled
+`Application Errors` and `Server Errors`.
+
+Click on the `/` URI to view the log entries for each test run.
+