Skip to content

Commit

Permalink
GRPC => gRPC
Browse files Browse the repository at this point in the history
  • Loading branch information
rez1dent3 committed Sep 10, 2023
1 parent 6557a7c commit 64f50cf
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![GripMock](https://github.com/bavix/gripmock/assets/5111255/90119438-92e5-4479-bfc8-5cf510249b7f)

# GripMock
GripMock is a **mock server** for **GRPC** services. It's using a `.proto` file to generate implementation of gRPC service for you.
GripMock is a **mock server** for **gRPC** services. It's using a `.proto` file to generate implementation of gRPC service for you.
You can use gripmock for setting up end-to-end testing or as a dummy server in a software development phase.
The server implementation is in GoLang but the client can be any programming language that support gRPC.

Expand Down Expand Up @@ -41,10 +41,10 @@ Check [`example`](https://github.com/bavix/gripmock/tree/master/example) folder
![Running Gripmock](https://github.com/bavix/gripmock/assets/5111255/e8f74280-52b1-41bd-8582-4026904d934c)

From client perspective, GripMock has 2 main components:
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.
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.
Matched stub will be returned to gRPC service then further parse it to response the rpc call.


From technical perspective, GripMock consists of 2 binaries.
Expand All @@ -59,7 +59,7 @@ The second binary is the protoc plugin which located in folder [protoc-gen-gripm

## Stubbing

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
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 a simple REST API. HTTP stub server is running on port `:4771`
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

![GripMock](https://github.com/bavix/gripmock/assets/5111255/6417d7c5-0250-4d00-a1c0-24c592e3c812)

`GripMock` is a mock server for GRPC services.
`GripMock` is a mock server for gRPC services.

## Support

Expand Down
2 changes: 1 addition & 1 deletion docs/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

GripMock is a **mock server** for **GRPC** services. It's using a `.proto` file to generate implementation of gRPC service for you.
GripMock is a **mock server** for **gRPC** services. It's using a `.proto` file to generate implementation of gRPC service for you.
You can use gripmock for setting up end-to-end testing or as a dummy server in a software development phase.
The server implementation is in GoLang but the client can be any programming language that support gRPC.

Expand Down
2 changes: 1 addition & 1 deletion docs/quick-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Serving gRPC on tcp://:4770
```

What is important to understand?
1. GRPC Mock server started on port 4770;
1. gRPC Mock server started on port 4770;
2. HTTP server for working with the stub server is running on port 4771;

This means that everything went well. Now let's add the first stub:
Expand Down
2 changes: 1 addition & 1 deletion stub/stub.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ func RunRestServer(ch chan struct{}, opt Options) {
apiServer.ServiceReady()
}

log.Println("GRPC-service is ready to accept requests")
log.Println("gRPC-service is ready to accept requests")
}()
}

0 comments on commit 64f50cf

Please sign in to comment.