Mock grpc server

nhatthm · Nov 20, 2021 · 9dd1790 · 9dd1790
1 parent f46eecd
commit 9dd1790
Show file tree

Hide file tree

Showing 102 changed files with 12,094 additions and 271 deletions.
diff --git a/Makefile b/Makefile
@@ -18,7 +18,7 @@ test: test-unit
 ## Run unit tests
 test-unit:
 	@echo ">> unit test"
-	@$(GO) test -gcflags=-l -coverprofile=unit.coverprofile -covermode=atomic -race ./...
+	@$(GO) test -gcflags=-l -coverprofile=unit.coverprofile -covermode=atomic -race ./... -tags testcoverage
 
 #test-integration:
 #	@echo ">> integration test"

diff --git a/README.md b/README.md
@@ -9,18 +9,207 @@
 
 Test gRPC service and client like a pro.
 
+## Table of Contents
+
+- [Prerequisites](#prerequisites)
+- [Install](#install)
+- [Usage](#usage)
+    - [Mock a gRPC server](#mock-a-grpc-server)
+        - [Unary Method](#unary-method)
+        - [Client-Stream Method](#client-stream-method)
+        - [Server-Stream Method](#server-stream-method)
+        - [Bidirectional-Stream Method](#bidirectional-stream-method)
+    - [Invoke a gRPC method](#invoke-a-grpc-method)
+        - [Unary Method](#unary-method-1)
+        - [Client-Stream Method](#client-stream-method-1)
+        - [Server-Stream Method](#server-stream-method-1)
+        - [Bidirectional-Stream Method](#bidirectional-stream-method-1)
+
 ## Prerequisites
 
 - `Go >= 1.17`
 
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
 ## Install
 
 ```bash
 go get github.com/nhatthm/grpcmock
 ```
 
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
 ## Usage
 
+### Mock a gRPC server
+
+Read more about [mocking a gRPC server](SERVER.md)
+
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
+#### Unary Method
+
+Read more about [mocking a Unary Method](SERVER.md#mock-a-unary-method)
+
+```go
+package main
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/nhatthm/grpcmock"
+	grpcAssert "github.com/nhatthm/grpcmock/assert"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGetItems(t *testing.T) {
+	t.Parallel()
+
+	expected := &Item{Id: 42, Name: "Item 42"}
+
+	_, d := grpcmock.MockAndStartServer(
+		grpcmock.RegisterService(RegisterItemServiceServer),
+		func(s *grpcmock.Server) {
+			s.ExpectUnary("myservice/GetItem").
+				WithHeader("locale", "en-US").
+				WithPayload(&GetItemRequest{Id: 42}).
+				Return(expected)
+		},
+	)(t)
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
+	defer cancel()
+
+	out := &Item{}
+
+	err := grpcmock.InvokeUnary(ctx,
+		"myservice/GetItem",
+		&GetItemRequest{Id: 42}, out,
+		grpcmock.WithHeader("locale", "en-US"),
+		grpcmock.WithContextDialer(d),
+		grpcmock.WithInsecure(),
+	)
+
+	grpcAssert.EqualMessage(t, expected, out)
+	assert.NoError(t, err)
+}
+```
+
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
+#### Client-Stream Method
+
+Read more about [mocking a Client-Stream Method](SERVER.md#mock-a-client-stream-method)
+
+```go
+package main
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/nhatthm/grpcmock"
+	grpcAssert "github.com/nhatthm/grpcmock/assert"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestCreateItems(t *testing.T) {
+	t.Parallel()
+
+	expected := &CreateItemsResponse{NumItems: 1}
+
+	_, d := grpcmock.MockAndStartServer(
+		grpcmock.RegisterService(RegisterItemServiceServer),
+		func(s *grpcmock.Server) {
+			s.ExpectClientStream("myservice/CreateItems").
+				WithPayload([]*Item{{Id: 42}}).
+				Return(expected)
+		},
+	)(t)
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
+	defer cancel()
+
+	out := &CreateItemsResponse{}
+	err := grpcmock.InvokeClientStream(ctx, "myservice/CreateItems",
+		grpcmock.SendAll([]*Item{{Id: 42}}), out,
+		grpcmock.WithContextDialer(d),
+		grpcmock.WithInsecure(),
+	)
+
+	grpcAssert.EqualMessage(t, expected, out)
+	assert.NoError(t, err)
+}
+```
+
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
+#### Server-Stream Method
+
+Read more about [mocking a Server-Stream Method](SERVER.md#mock-a-server-stream-method)
+
+```go
+package main
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/nhatthm/grpcmock"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestListItems(t *testing.T) {
+	t.Parallel()
+
+	expected := []*Item{
+		{Id: 41, Name: "Item 41"},
+		{Id: 42, Name: "Item 42"},
+	}
+
+	_, d := grpcmock.MockAndStartServer(
+		grpcmock.RegisterService(RegisterItemServiceServer),
+		func(s *grpcmock.Server) {
+			s.ExpectServerStream("myservice/ListItems").
+				WithPayload(&ListItemsRequest{}).
+				Return(expected)
+		},
+	)(t)
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Millisecond*50)
+	defer cancel()
+
+	actual := make([]*Item, 0)
+
+	err := grpcmock.InvokeServerStream(ctx,
+		"myservice/ListItems",
+		&ListItemsRequest{},
+		grpcmock.RecvAll(&out),
+		grpcmock.WithContextDialer(d),
+		grpcmock.WithInsecure(),
+	)
+
+	assert.NoError(t, err)
+	assert.Len(t, actual, len(expected))
+
+	for i := 0; i < len(expected); i++ {
+		grpcAssert.EqualMessage(t, expected[i], actual[i])
+	}
+}
+```
+
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
+#### Bidirectional-Stream Method
+
+Coming soon by EOY 2021.
+
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
 ### Invoke a gRPC method
 
 #### Unary Method
@@ -52,7 +241,9 @@ func getItem(l *bufconn.Listener, id int32) (*Item, error) {
 }
 ```
 
-### Client-Stream Method
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
+#### Client-Stream Method
 
 ```go
 package main
@@ -100,7 +291,7 @@ func createItems(l *bufconn.Listener, items []*Item) (*CreateItemsResponse, erro
 
 	out := &CreateItemsResponse{}
 	err := grpcmock.InvokeClientStream(ctx, "myservice/CreateItems",
-		func(stream grpc.ClientStream) error {
+		func(s grpc.ClientStream) error {
 			// Handle the stream here.
 			return nil
 		},
@@ -113,7 +304,9 @@ func createItems(l *bufconn.Listener, items []*Item) (*CreateItemsResponse, erro
 }
 ```
 
-### Server-Stream Method
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
+#### Server-Stream Method
 
 ```go
 package main
@@ -163,7 +356,7 @@ func listItems(l *bufconn.Listener) ([]*Item, error) {
 	out := make([]*Item, 0)
 	err := grpcmock.InvokeServerStream(ctx, "myservice/ListItems",
 		&ListItemsRequest{},
-		func(stream grpc.ClientStream) error {
+		func(s grpc.ClientStream) error {
 			// Handle the stream here.
 			return nil
 		},
@@ -175,7 +368,9 @@ func listItems(l *bufconn.Listener) ([]*Item, error) {
 }
 ```
 
-### Bidirectional-Stream Method
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
+#### Bidirectional-Stream Method
 
 ```go
 package main
@@ -223,7 +418,7 @@ func transformItems(l *bufconn.Listener, in []*Item) ([]*Item, error) {
 
 	out := make([]*Item, 0)
 	err := grpcmock.InvokeBidirectionalStream(ctx, "myservice/TransformItems",
-		func(stream grpc.ClientStream) error {
+		func(s grpc.ClientStream) error {
 			// Handle the stream here.
 			return nil
 		},
@@ -235,14 +430,20 @@ func transformItems(l *bufconn.Listener, in []*Item) ([]*Item, error) {
 }
 ```
 
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
 ## Donation
 
 If this project help you reduce time to develop, you can give me a cup of coffee :)
 
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)
+
 ### Paypal donation
 
 [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY)
 
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or scan this
 
 <img src="https://user-images.githubusercontent.com/1154587/113494222-ad8cb200-94e6-11eb-9ef3-eb883ada222a.png" width="147px" />
+
+[<sub><sup>[table of contents]</sup></sub>](#table-of-contents)