From e56862a347cb3e86a4d7cee68526e55d5eb05c5f Mon Sep 17 00:00:00 2001 From: Yonas Date: Wed, 3 Mar 2021 15:21:51 +0800 Subject: [PATCH] Fix grammar in README (#60) * Fix grammar in README * Fix typo --- Readme.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/Readme.md b/Readme.md index 44845a05..03163adf 100644 --- a/Readme.md +++ b/Readme.md @@ -1,25 +1,25 @@ # GripMock -GripMock is a **mock server** for **GRPC** services. It's using `.proto` file to generate implementation of gRPC service for you. -If you already familiar with [Apiary](https://apiary.io) or [WireMock](http://wiremock.org) for mocking API service and looking for similiar thing for GRPC then this is the perfect fit for that. +GripMock is a **mock server** for **GRPC** services. It's using a `.proto` file to generate implementation of gRPC service for you. +If you are already familiar with [Apiary](https://apiary.io) or [WireMock](http://wiremock.org) for mocking API service and looking for similiar thing for GRPC then this is the perfect fit for that. ## How It Works GripMock has 2 main components: -1. GRPC server that serving on `tcp://localhost:4770`. It's main job is to serve incoming rpc call from client then parse the input so that can be posted to Stub service to find the perfect stub match. -2. Stub server that serving on `http://localhost:4771`. It's main job is to store all the stub mapping. We can add a new stub or list existing stub using http request. +1. GRPC server that serves on `tcp://localhost:4770`. Its main job is to serve incoming rpc call from client and then parse the input so that it can be posted to Stub service to find the perfect stub match. +2. Stub server that serves on `http://localhost:4771`. Its main job is to store all the stub mapping. We can add a new stub or list existing stub using http request. Matched stub will be returned to GRPC service then further parse it to response the rpc call. ## Quick Usage -First, prepare your `.proto` file. or you can use `hello.proto` in `example/pb/` folder. Suppose you put it in `/mypath/hello.proto`. We gonna use Docker image for easier example test. +First, prepare your `.proto` file. Or you can use `hello.proto` in `example/pb/` folder. Suppose you put it in `/mypath/hello.proto`. We are gonna use Docker image for easier example test. basic syntax to run GripMock is `gripmock ` - Install [Docker](https://docs.docker.com/install/) - Run `docker pull tkpd/gripmock` to pull the image -- We gonna mount `/mypath/hello.proto` (it must a fullpath) into container and also we expose ports needed. Run `docker run -p 4770:4770 -p 4771:4771 -v /mypath:/proto tkpd/gripmock /proto/hello.proto` -- On separate terminal we gonna add stub into stub service. Run `curl -X POST -d '{"service":"Greeter","method":"SayHello","input":{"equals":{"name":"gripmock"}},"output":{"data":{"message":"Hello GripMock"}}}' localhost:4771/add ` -- Now we are ready to test it with our client. you can find client example file under `example/client/`. Execute one of your preferred language. Example for go: `go run example/client/go/*.go` +- We are gonna mount `/mypath/hello.proto` (it must be a fullpath) into a container and also we expose ports needed. Run `docker run -p 4770:4770 -p 4771:4771 -v /mypath:/proto tkpd/gripmock /proto/hello.proto` +- On a separate terminal we are gonna add a stub into the stub service. Run `curl -X POST -d '{"service":"Greeter","method":"SayHello","input":{"equals":{"name":"gripmock"}},"output":{"data":{"message":"Hello GripMock"}}}' localhost:4771/add ` +- Now we are ready to test it with our client. You can find a client example file under `example/simple/client/`. Execute one of your preferred language. Example for go: `go run example/simple/client/go/*.go` Check [`example`](https://github.com/tokopedia/gripmock/tree/master/example) folder for various usecase of gripmock. @@ -28,14 +28,14 @@ Check [`example`](https://github.com/tokopedia/gripmock/tree/master/example) fol Stubbing is the essential mocking of GripMock. It will match and return the expected result into GRPC service. This is where you put all your request expectation and response ### Dynamic stubbing -You could add stubbing on the fly with simple REST. HTTP stub server running on port `:4771` +You could add stubbing on the fly with a simple REST API. HTTP stub server is running on port `:4771` - `GET /` Will list all stubs mapping. - `POST /add` Will add stub with provided stub data - `POST /find` Find matching stub with provided input. see [Input Matching](#input_matching) below. - `GET /clear` Clear stub mappings. -Stub Format is JSON text format. It has skeleton like below: +Stub Format is JSON text format. It has a skeleton as follows: ``` { "service":"", // name of service defined in proto @@ -52,7 +52,7 @@ Stub Format is JSON text format. It has skeleton like below: } ``` -For our `hello` service example we put stub with below text: +For our `hello` service example we put a stub with the text below: ``` { "service":"Greeter", @@ -72,14 +72,14 @@ For our `hello` service example we put stub with below text: ### Static stubbing You could initialize gripmock with stub json files and provide the path using `--stub` argument. For example you may -mount your stub file in `/mystubs` folder then mount it to docker like +mount your stub file in `/mystubs` folder then mount it to docker like `docker run -p 4770:4770 -p 4771:4771 -v /mypath:/proto -v /mystubs:/stub tkpd/gripmock --stub=/stub /proto/hello.proto` -Please note that Gripmock still serve http stubbing to modify stored stubs on the fly. +Please note that Gripmock still serves http stubbing to modify stored stubs on the fly. ## Input Matching -Stub will responding the expected response if only requested with matching rule of input. Stub service will serve `/find` endpoint with format: +Stub will respond with the expected response only if the request matches any rule. Stub service will serve `/find` endpoint with format: ``` { "service":"", @@ -89,7 +89,7 @@ Stub will responding the expected response if only requested with matching rule } } ``` -So if you do `curl -X POST -d '{"service":"Greeter","method":"SayHello","data":{"name":"gripmock"}}' localhost:4771/find` stub service will find a match from listed stubs stored there. +So if you do a `curl -X POST -d '{"service":"Greeter","method":"SayHello","data":{"name":"gripmock"}}' localhost:4771/find` stub service will find a match from listed stubs stored there. ### Input Matching Rule Input matching has 3 rules to match an input. which is **equals**,**contains** and **regex**