feat: add grpc server support

Author: LinuxSuRen

.gitignore

@@ -1,3 +1,4 @@
 bin/
 .idea/
 coverage.out
+dist/

.goreleaser.yaml

@@ -12,6 +12,10 @@ builds:
       - linux
       - windows
       - darwin
+    ldflags:
+      - -w
+      - -s
+      - -X github.com/linuxsuren/api-testing/cmd.version={{.Version}}
 archives:
   - name_template: "{{ .Binary }}-{{ .Os }}-{{ .Arch }}"
     format_overrides:

Makefile

@@ -2,9 +2,24 @@ build:
 	mkdir -p bin
 	rm -rf bin/atest
 	go build -o bin/atest main.go
-
+goreleaser:
+	goreleaser build --rm-dist --snapshot
 copy: build
 	sudo cp bin/atest /usr/local/bin/
 test:
 	go test ./... -cover -v -coverprofile=coverage.out
 	go tool cover -func=coverage.out
+grpc:
+	protoc --go_out=. --go_opt=paths=source_relative \
+    --go-grpc_out=. --go-grpc_opt=paths=source_relative \
+    pkg/server/server.proto
+grpc-js:
+	protoc -I=pkg/server server.proto \
+    --js_out=import_style=commonjs:bin \
+    --grpc-web_out=import_style=commonjs,mode=grpcwebtext:bin
+grpc-java:
+	protoc --plugin=protoc-gen-grpc-java=/usr/local/bin/protoc-gen-grpc-java \
+    --grpc-java_out=bin --proto_path=pkg/server server.proto
+install-tool:
+	go install google.golang.org/protobuf/cmd/[email protected]
+	go install google.golang.org/grpc/cmd/[email protected]

cmd/root.go

@@ -2,13 +2,18 @@ package cmd
 
 import "github.com/spf13/cobra"
 
+// should be injected during the build process
+var version string
+
 // NewRootCmd creates the root command
 func NewRootCmd() (c *cobra.Command) {
 	c = &cobra.Command{
 		Use:   "atest",
 		Short: "API testing tool",
 	}
+	c.Version = version
 	c.AddCommand(createInitCommand(),
-		createRunCommand(), createSampleCmd())
+		createRunCommand(), createSampleCmd(),
+		createServerCmd())
 	return
 }

cmd/root_test.go

@@ -45,4 +45,8 @@ func TestCreateRunCommand(t *testing.T) {
 
 	init := createInitCommand()
 	assert.Equal(t, "init", init.Use)
+
+	server := createServerCmd()
+	assert.NotNil(t, server)
+	assert.Equal(t, "server", server.Use)
 }

cmd/run.go

@@ -32,6 +32,7 @@ type runOption struct {
 	reporter           runner.TestReporter
 	reportWriter       runner.ReportResultWriter
 	report             string
+	reportIgnore       bool
 }
 
 func newDefaultRunOption() *runOption {
@@ -71,14 +72,22 @@ See also https://github.com/LinuxSuRen/api-testing/tree/master/sample`,
 	flags.Int64VarP(&opt.thread, "thread", "", 1, "Threads of the execution")
 	flags.Int32VarP(&opt.qps, "qps", "", 5, "QPS")
 	flags.Int32VarP(&opt.burst, "burst", "", 5, "burst")
-	flags.StringVarP(&opt.report, "report", "", "", "The type of target report")
+	flags.StringVarP(&opt.report, "report", "", "", "The type of target report. Supported: markdown, md, discard, std")
 	return
 }
 
 func (o *runOption) preRunE(cmd *cobra.Command, args []string) (err error) {
+	writer := cmd.OutOrStdout()
+
 	switch o.report {
 	case "markdown", "md":
-		o.reportWriter = runner.NewMarkdownResultWriter(cmd.OutOrStdout())
+		o.reportWriter = runner.NewMarkdownResultWriter(writer)
+	case "discard":
+		o.reportWriter = runner.NewDiscardResultWriter()
+	case "", "std":
+		o.reportWriter = runner.NewResultWriter(writer)
+	default:
+		err = fmt.Errorf("not supported report type: '%s'", o.report)
 	}
 	return
 }
@@ -97,17 +106,18 @@ func (o *runOption) runE(cmd *cobra.Command, args []string) (err error) {
 		for i := range files {
 			item := files[i]
 			if err = o.runSuiteWithDuration(item); err != nil {
-				return
+				break
 			}
 		}
 	}
 
 	// print the report
-	if err == nil {
-		var results []runner.ReportResult
-		if results, err = o.reporter.ExportAllReportResults(); err == nil {
-			err = o.reportWriter.Output(results)
+	if results, reportErr := o.reporter.ExportAllReportResults(); reportErr == nil {
+		if reportErr = o.reportWriter.Output(results); reportErr != nil {
+			cmd.Println("failed to Output all reports", reportErr)
 		}
+	} else {
+		cmd.Println("failed to export all reports", reportErr)
 	}
 	return
 }
@@ -205,6 +215,7 @@ func (o *runOption) runSuite(suite string, dataContext map[string]interface{}, c
 			simpleRunner := runner.NewSimpleTestCaseRunner()
 			simpleRunner.WithTestReporter(o.reporter)
 			if output, err = simpleRunner.RunTestCase(&testCase, dataContext, ctxWithTimeout); err != nil && !o.requestIgnoreError {
+				err = fmt.Errorf("failed to run '%s', %v", testCase.Name, err)
 				return
 			} else {
 				err = nil

cmd/run_test.go

@@ -107,3 +107,72 @@ func TestRootCmd(t *testing.T) {
 	assert.NotNil(t, c)
 	assert.Equal(t, "atest", c.Use)
 }
+
+func TestPreRunE(t *testing.T) {
+	tests := []struct {
+		name   string
+		opt    *runOption
+		verify func(*testing.T, *runOption, error)
+	}{{
+		name: "markdown report",
+		opt: &runOption{
+			report: "markdown",
+		},
+		verify: func(t *testing.T, ro *runOption, err error) {
+			assert.Nil(t, err)
+			assert.NotNil(t, ro.reportWriter)
+		},
+	}, {
+		name: "md report",
+		opt: &runOption{
+			report: "md",
+		},
+		verify: func(t *testing.T, ro *runOption, err error) {
+			assert.Nil(t, err)
+			assert.NotNil(t, ro.reportWriter)
+		},
+	}, {
+		name: "discard report",
+		opt: &runOption{
+			report: "discard",
+		},
+		verify: func(t *testing.T, ro *runOption, err error) {
+			assert.Nil(t, err)
+			assert.NotNil(t, ro.reportWriter)
+		},
+	}, {
+		name: "std report",
+		opt: &runOption{
+			report: "std",
+		},
+		verify: func(t *testing.T, ro *runOption, err error) {
+			assert.Nil(t, err)
+			assert.NotNil(t, ro.reportWriter)
+		},
+	}, {
+		name: "empty report",
+		opt: &runOption{
+			report: "",
+		},
+		verify: func(t *testing.T, ro *runOption, err error) {
+			assert.Nil(t, err)
+			assert.NotNil(t, ro.reportWriter)
+		},
+	}, {
+		name: "invalid report",
+		opt: &runOption{
+			report: "fake",
+		},
+		verify: func(t *testing.T, ro *runOption, err error) {
+			assert.NotNil(t, err)
+			assert.Nil(t, ro.reportWriter)
+		},
+	}}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			c := &cobra.Command{}
+			err := tt.opt.preRunE(c, nil)
+			tt.verify(t, tt.opt, err)
+		})
+	}
+}

cmd/server.go

@@ -0,0 +1,43 @@
+// Package cmd provides all the commands
+package cmd
+
+import (
+	"fmt"
+	"log"
+	"net"
+
+	"github.com/linuxsuren/api-testing/pkg/server"
+	"github.com/spf13/cobra"
+	"google.golang.org/grpc"
+)
+
+func createServerCmd() (c *cobra.Command) {
+	opt := &serverOption{}
+	c = &cobra.Command{
+		Use:   "server",
+		Short: "Run as a server mode",
+		RunE:  opt.runE,
+	}
+	flags := c.Flags()
+	flags.IntVarP(&opt.port, "port", "p", 9090, "The RPC server port")
+	return
+}
+
+type serverOption struct {
+	port int
+}
+
+func (o *serverOption) runE(cmd *cobra.Command, args []string) (err error) {
+	var lis net.Listener
+
+	lis, err = net.Listen("tcp", fmt.Sprintf(":%d", o.port))
+	if err != nil {
+		return
+	}
+
+	s := grpc.NewServer()
+	server.RegisterRunnerServer(s, server.NewRemoteServer())
+	log.Printf("server listening at %v", lis.Addr())
+	s.Serve(lis)
+	return
+}

go.mod

@@ -6,19 +6,21 @@ require (
 	github.com/Masterminds/sprig/v3 v3.2.3
 	github.com/andreyvit/diff v0.0.0-20170406064948-c7f18ee00883
 	github.com/antonmedv/expr v1.12.1
+	github.com/golang/protobuf v1.5.2
 	github.com/h2non/gock v1.2.0
 	github.com/linuxsuren/unstructured v0.0.1
 	github.com/spf13/cobra v1.6.1
 	github.com/stretchr/testify v1.8.2
 	golang.org/x/sync v0.1.0
+	google.golang.org/grpc v1.54.0
 	gopkg.in/yaml.v2 v2.4.0
 )
 
 require (
 	github.com/Masterminds/goutils v1.1.1 // indirect
 	github.com/Masterminds/semver/v3 v3.2.0 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/google/uuid v1.1.1 // indirect
+	github.com/google/uuid v1.3.0 // indirect
 	github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 // indirect
 	github.com/huandu/xstrings v1.3.3 // indirect
 	github.com/imdario/mergo v0.3.11 // indirect
@@ -31,5 +33,10 @@ require (
 	github.com/spf13/cast v1.3.1 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	golang.org/x/crypto v0.3.0 // indirect
+	golang.org/x/net v0.8.0 // indirect
+	golang.org/x/sys v0.6.0 // indirect
+	golang.org/x/text v0.8.0 // indirect
+	google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f // indirect
+	google.golang.org/protobuf v1.30.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )