aboutsummaryrefslogtreecommitdiffhomepage
path: root/tools/interop_matrix/README.md
diff options
context:
space:
mode:
authorGravatar Yong Ni <yongni@google.com>2017-06-26 15:24:40 -0700
committerGravatar Yong Ni <yongni@google.com>2017-06-30 09:41:31 -0700
commitb7ea4ab4d7360fd37d13e91fb0b1dd4ab407dde0 (patch)
tree9a992f89a66ac74b41494090b8aa53ba5215e5c1 /tools/interop_matrix/README.md
parent5f5415eae3acb267155a22fa9b612d43c0659676 (diff)
Created test driver to run matrix test against different docker images in GCR and generate a Junit like test result file.
Diffstat (limited to 'tools/interop_matrix/README.md')
-rw-r--r--tools/interop_matrix/README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/tools/interop_matrix/README.md b/tools/interop_matrix/README.md
index 8493099d1a..14fe82b9a1 100644
--- a/tools/interop_matrix/README.md
+++ b/tools/interop_matrix/README.md
@@ -11,7 +11,7 @@ from specific releases/tag, are used to test version compatiblity between gRPC r
- `--git_checkout` enables git checkout grpc release branch/tag.
- `--release` specifies a git release tag. Make sure it is a valid tag in the grpc github rep.
- `--language` specifies a language.
- For examle, To build all languages for all gRPC releases across all runtimes, do `tools/interop_matrix/create_matrix_images.py --git_checkout --release=all`.
+ For example, To build all languages for all gRPC releases across all runtimes, do `tools/interop_matrix/create_matrix_images.py --git_checkout --release=all`.
- Verify the newly created docker images are uploaded to GCR. For example:
- `gcloud beta container images list --repository gcr.io/grpc-testing` shows image repos.
- `gcloud beta container images list-tags gcr.io/grpc-testing/grpc_interop_go1.7` show tags for a image repo.
@@ -30,11 +30,17 @@ from specific releases/tag, are used to test version compatiblity between gRPC r
- `LANG=go KEEP_IMAGE=1 ./create_testcases.sh` will generate `./testcases/go__master` and keep the local docker image so it can be invoked simply via `./testcases/go__master`. Note: remove local docker images manually afterwards with `docker rmi <image_id>`.
- Stage and commit the generated test case file `./testcases/<lang>__<release>`.
-## Instructions for running test cases against a GCR image
+## Instructions for running test cases against GCR images
+- Run `tools/interop_matrix/run_interop_matrix_tests.py`. Useful options:
+ - `--release` specifies a git release tag. Defaults to `--release=master`. Make sure the GCR images with the tag have been created using `create_matrix_images.py` above.
+ - `--language` specifies a language. Defaults to `--language=all`.
+ For example, To test all languages for all gRPC releases across all runtimes, do `tools/interop_matrix/run_interop_matrix_test.py --release=all`.
+- The output for all the test cases is recorded in a junit style xml file (default to 'report.xml').
+
+## Instructions for running test cases against a GCR image manually
- Run test cases by specifying `docker_image` variable inline with the test case script created above.
For example:
- `docker_image=gcr.io/grpc-testing/grpc_interop_go1.7:master ./testcases/go__master` will run go__master test cases against `go1.7` with gRPC release `master` docker image in GCR.
-
Note:
- File path starting with `tools/` or `template/` are relative to the grpc repo root dir. File path starting with `./` are relative to current directory (`tools/interop_matrix`).