feat: custom the grpc gateway restful path (#497)

Author: LinuxSuRen

.github/testing/core.yaml

@@ -1,160 +1,14 @@
 #!api-testing
 # yaml-language-server: $schema=https://linuxsuren.github.io/api-testing/api-testing-schema.json
-# https://docs.gitlab.com/ee/api/api_resources.html
 name: atest
 api: |
-  {{default "http://localhost:8080/server.Runner" (env "SERVER")}}
+  {{default "http://localhost:8080/api/v1" (env "SERVER")}}
 param:
   name: "{{randAlpha 6}}"
 items:
 - name: createSuite
   request:
-    api: /CreateTestSuite
-    method: POST
-    body: |
-      {"name": "{{.param.name}}"}
-- name: suites
-  request:
-    api: /GetSuites
-    method: POST
-- name: suite
-  request:
-    api: /GetTestSuite
-    method: POST
-    body: |
-      {"name": "{{.param.name}}"}
-  expect:
-    bodyFieldsExpect:
-      name: "{{.param.name}}"
-      api: ""
-- name: UpdateTestSuite
-  request:
-    api: /UpdateTestSuite
-    method: POST
-    body: |
-      {
-        "name": "{{.param.name}}",
-        "api": "{{randAlpha 6}}"}
-      }
-- name: DeleteTestSuiteNotFound
-  request:
-    api: /DeleteTestSuite
-    method: POST
-    body: |
-      {"name": "{{randAlpha 6}}"}
-  expect:
-    statusCode: 500
-
-- name: ListTestCase
-  request:
-    api: /ListTestCase
-    method: POST
-    body: |
-      {"name": "{{.param.name}}"}
-- name: list-testcases-not-found
-  request:
-    api: /ListTestCase
-    method: POST
-    body: |
-      {"name": "{{randAlpha 6}}"}
-  expect:
-    bodyFieldsExpect:
-      name: ""
-- name: GetSuggestedAPIs-no-testsuite-found
-  request:
-    api: /GetSuggestedAPIs
-    method: POST
-    body: |
-      {"name": "{{randAlpha 6}}"}
-  expect:
-    verify:
-      - len(data.data) == 0
-- name: get-testcase-not-found
-  request:
-    api: /GetTestCase
-    method: POST
-    body: |
-      {"name": "test"}
-  expect:
-    statusCode: 500
-    bodyFieldsExpect:
-      code: 2
-- name: get-popular-headers
-  request:
-    api: /PopularHeaders
-    method: POST
-
-- name: list-code-generators
-  request:
-    api: /ListCodeGenerator
-    method: POST
-  expect:
-    verify:
-      - len(data) == 1
-- name: GenerateCode
-  request:
-    api: /GenerateCode
-    method: POST
-    body: |
-      {
-        "TestSuite": "{{.param.name}}",
-        "TestCase": "{{randAlpha 6}}",
-        "Generator": "golang"
-      }
-  expect:
-    statusCode: 500 # no testcase found
-    verify:
-      - indexOf(data.message, "not found") != -1
-
-- name: listConverters
-  request:
-    api: /ListConverter
-    method: POST
-  expect:
-    verify:
-      - len(data) == 1
-- name: ConvertTestSuite
-  request:
-    api: /ConvertTestSuite
-    method: POST
-    body: |
-      {
-        "TestSuite": "{{.param.name}}",
-        "Generator": "jmeter"
-      }
-  expect:
-    verify:
-      - data.message != ""
-      - indexOf(data.message, "jmeterTestPlan") != -1
-
-- name: list-stores
-  request:
-    api: /GetStores
-    method: POST
-  expect:
-    verify:
-      - len(data) >= 1
-- name: query-funcs
-  request:
-    api: /FunctionsQuery
-    method: POST
-  expect:
-    verify:
-      - len(data) == 1
-- name: version
-  request:
-    api: /GetVersion
-    method: POST
-- name: GetSecrets
-  request:
-    api: /GetSecrets
-    method: POST
-  expect:
-    statusCode: 500
-
-- name: DeleteTestSuite
-  request:
-    api: /DeleteTestSuite
+    api: /suites
     method: POST
     body: |
       {"name": "{{.param.name}}"}

.github/testing/grpc.yaml

@@ -8,6 +8,7 @@ spec:
   rpc:
     import:
       - ./pkg/server
+      - ./pkg/apispec/data/proto
     protofile: server.proto
 items:
   - name: GetVersion

.github/testing/grpc_descriptor_set.yaml

@@ -6,6 +6,8 @@ api: 127.0.0.1:7070
 spec:
   kind: grpc
   rpc:
+    import:
+      - ./pkg/apispec/data/proto
     serverReflection: true
 items:
   - name: GetVersion

.github/testing/grpc_ref.yaml

@@ -50,7 +50,7 @@ jobs:
           
           # make test-ui-e2e
 
-          atest run -p '.github/testing/*.yaml' --request-ignore-error --report github --report-file bin/report.json --report-github-repo linuxsuren/api-testing --report-github-pr ${{ github.event.number }}
+          atest run -p .github/testing/grpc.yaml --request-ignore-error --report github --report-file bin/report.json --report-github-repo linuxsuren/api-testing --report-github-pr ${{ github.event.number }}
           sudo atest service status
           sudo atest service stop
           sudo atest service uninstall

.github/testing/server.pb

@@ -20,7 +20,6 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"github.com/linuxsuren/api-testing/pkg/util/home"
 	"io"
 	"net/http"
 	"os"
@@ -30,6 +29,8 @@ import (
 	"sync"
 	"time"
 
+	"github.com/linuxsuren/api-testing/pkg/util/home"
+
 	"github.com/linuxsuren/api-testing/pkg/apispec"
 	"github.com/linuxsuren/api-testing/pkg/limit"
 	"github.com/linuxsuren/api-testing/pkg/logging"
@@ -332,6 +333,7 @@ func (o *runOption) runSuite(loader testing.Loader, dataContext map[string]inter
 		return
 	}
 
+	runLogger.Info("render test suite", "name", testSuite.Name)
 	if err = testSuite.Render(dataContext); err != nil {
 		return
 	}
@@ -343,6 +345,7 @@ func (o *runOption) runSuite(loader testing.Loader, dataContext map[string]inter
 	suiteRunner.WithOutputWriter(os.Stdout)
 	suiteRunner.WithWriteLevel(o.level)
 	suiteRunner.WithSuite(testSuite)
+	runLogger.Info("run test suite", "name", testSuite.Name)
 	for _, testCase := range testSuite.Items {
 		if !testCase.InScope(o.caseItems) {
 			continue