feat: support to run a specific test case via grpc (#28)

Co-authored-by: Rick <[email protected]>

Author: LinuxSuRen

.goreleaser.yaml

@@ -15,7 +15,7 @@ builds:
     ldflags:
       - -w
       - -s
-      - -X github.com/linuxsuren/api-testing/cmd.version={{.Version}}
+      - -X github.com/linuxsuren/api-testing/pkg/version.version={{.Version}}
 archives:
   - name_template: "{{ .Binary }}-{{ .Os }}-{{ .Arch }}"
     format_overrides:

README.md

@@ -8,6 +8,8 @@ This is a API testing tool.
 * Response Body fields equation check  
 * Response Body [eval](https://expr.medv.io/)  
 * Output reference between TestCase  
+* Run in server mode, and provide the gRPC endpoint
+* [VS Code extension](https://github.com/LinuxSuRen/vscode-api-testing) support
 
 ## Template
 The following fields are templated with [sprig](http://masterminds.github.io/sprig/):

cmd/root.go

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

go.mod

@@ -6,20 +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
+	google.golang.org/protobuf v1.30.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/golang/protobuf v1.5.2 // 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
@@ -37,6 +38,5 @@ require (
 	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
 )

pkg/server/remote_server.go

@@ -10,6 +10,7 @@ import (
 	"github.com/linuxsuren/api-testing/pkg/render"
 	"github.com/linuxsuren/api-testing/pkg/runner"
 	"github.com/linuxsuren/api-testing/pkg/testing"
+	"github.com/linuxsuren/api-testing/pkg/version"
 )
 
 type server struct {
@@ -41,6 +42,28 @@ func (s *server) Run(ctx context.Context, task *TestTask) (reply *HelloReply, er
 		suite = &testing.TestSuite{
 			Items: []testing.TestCase{*testCase},
 		}
+	case "testcaseInSuite":
+		if suite, err = testing.ParseFromData([]byte(task.Data)); err != nil {
+			return
+		} else if suite == nil || suite.Items == nil {
+			err = fmt.Errorf("no test suite found")
+			return
+		}
+
+		var targetTestcase *testing.TestCase
+		for _, item := range suite.Items {
+			if item.Name == task.CaseName {
+				targetTestcase = &item
+				break
+			}
+		}
+
+		if targetTestcase != nil {
+			suite.Items = []testing.TestCase{*targetTestcase}
+		} else {
+			err = fmt.Errorf("cannot found testcase %s", task.CaseName)
+			return
+		}
 	default:
 		err = fmt.Errorf("not support '%s'", task.Kind)
 		return
@@ -77,3 +100,9 @@ func (s *server) Run(ctx context.Context, task *TestTask) (reply *HelloReply, er
 	reply = &HelloReply{Message: buf.String()}
 	return
 }
+
+// GetVersion returns the version
+func (s *server) GetVersion(ctx context.Context, in *Empty) (reply *HelloReply, err error) {
+	reply = &HelloReply{Message: version.GetVersion()}
+	return
+}

pkg/server/remote_server_test.go

@@ -18,6 +18,7 @@ func TestRemoteServer(t *testing.T) {
 	})
 	assert.NotNil(t, err)
 
+	gock.New("http://foo").Get("/").Reply(http.StatusOK).JSON(&server)
 	gock.New("http://foo").Get("/").Reply(http.StatusOK).JSON(&server)
 	_, err = server.Run(context.TODO(), &TestTask{
 		Kind: "suite",
@@ -31,6 +32,27 @@ func TestRemoteServer(t *testing.T) {
 		Data: simpleTestCase,
 	})
 	assert.Nil(t, err)
+
+	gock.New("http://foo").Get("/").Reply(http.StatusOK).JSON(&server)
+	_, err = server.Run(context.TODO(), &TestTask{
+		Kind:     "testcaseInSuite",
+		Data:     simpleSuite,
+		CaseName: "get",
+	})
+	assert.Nil(t, err)
+
+	gock.New("http://foo").Get("/").Reply(http.StatusOK).JSON(&server)
+	_, err = server.Run(context.TODO(), &TestTask{
+		Kind:     "testcaseInSuite",
+		Data:     simpleSuite,
+		CaseName: "fake",
+	})
+	assert.NotNil(t, err)
+
+	var ver *HelloReply
+	ver, err = server.GetVersion(context.TODO(), &Empty{})
+	assert.Empty(t, ver.Message)
+	assert.Nil(t, err)
 }
 
 //go:embed testdata/simple.yaml