feat: add gRPC loader for reading and writeing test suites (#120)

* feat: add gRPC loader for reading and writeing test suites

* complete the basic feature of gRPC plugin demo

* docs: add document about the gRPC extension

Author: LinuxSuRen

.dockerignore

@@ -0,0 +1,2 @@
+console/atest-ui/node_modules
+console/atest-ui/dist

.github/workflows/build.yaml

@@ -14,8 +14,7 @@ jobs:
       - uses: actions/[email protected]
       - name: Test
         run: |
-          go test ./... -coverprofile coverage.out
-          make test test-collector
+          make test-all
       - name: Report
         if: github.actor == 'linuxsuren'
         env:

.gitignore

@@ -1,7 +1,7 @@
 bin/
 .idea/
 coverage.out
-collector-coverage.out
+*-coverage.out
 dist/
 .vscode/launch.json
 sample.yaml

Dockerfile

@@ -1,5 +1,6 @@
 FROM golang:1.18 AS builder
 
+ARG GOPROXY
 WORKDIR /workspace
 COPY cmd/ cmd/
 COPY pkg/ pkg/
@@ -14,9 +15,10 @@ COPY main.go main.go
 COPY README.md README.md
 COPY LICENSE LICENSE
 
-RUN go mod download
-RUN CGO_ENABLE=0 go build -ldflags "-w -s" -o atest .
-RUN CGO_ENABLE=0 go build -ldflags "-w -s" -o atest-collector extensions/collector/main.go
+RUN GOPROXY=${GOPROXY} go mod download
+RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s" -o atest .
+RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s" -o atest-collector extensions/collector/main.go
+RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s" -o atest-store-orm extensions/store-orm/main.go
 
 FROM node:20-alpine3.17 AS ui
 
@@ -40,6 +42,7 @@ LABEL "Name"="API testing"
 
 COPY --from=builder /workspace/atest /usr/local/bin/atest
 COPY --from=builder /workspace/atest-collector /usr/local/bin/atest-collector
+COPY --from=builder /workspace/atest-store-orm /usr/local/bin/atest-store-orm
 COPY --from=builder /workspace/LICENSE /LICENSE
 COPY --from=builder /workspace/README.md /README.md
 

Makefile

@@ -1,3 +1,5 @@
+IMG_TOOL?=podman
+
 build:
 	mkdir -p bin
 	rm -rf bin/atest
@@ -14,9 +16,9 @@ build-embed-ui:
 goreleaser:
 	goreleaser build --rm-dist --snapshot
 build-image:
-	docker build -t ghcr.io/linuxsuren/api-testing:dev .
+	${IMG_TOOL} build -t ghcr.io/linuxsuren/api-testing:master . --build-arg GOPROXY=https://goproxy.cn,direct
 run-image:
-	docker run -p 7070:7070 -p 8080:8080 ghcr.io/linuxsuren/api-testing:dev
+	docker run -p 7070:7070 -p 8080:8080 ghcr.io/linuxsuren/api-testing:master
 run-server:
 	go run . server  --local-storage 'sample/*.yaml' --console-path console/atest-ui/dist
 copy: build
@@ -25,16 +27,26 @@ copy-restart: build
 	atest service stop
 	make copy
 	atest service restart
+
 test:
 	go test ./... -cover -v -coverprofile=coverage.out
 	go tool cover -func=coverage.out
 test-collector:
 	go test github.com/linuxsuren/api-testing/extensions/collector/./... -cover -v -coverprofile=collector-coverage.out
 	go tool cover -func=collector-coverage.out
+test-store-orm:
+	go test github.com/linuxsuren/api-testing/extensions/store-orm/./... -cover -v -coverprofile=store-orm-coverage.out
+	go tool cover -func=store-orm-coverage.out
+test-all: test test-collector test-store-orm
+
 grpc:
 	protoc --go_out=. --go_opt=paths=source_relative \
     --go-grpc_out=. --go-grpc_opt=paths=source_relative \
     pkg/server/server.proto
+
+	protoc --go_out=. --go_opt=paths=source_relative \
+    --go-grpc_out=. --go-grpc_opt=paths=source_relative \
+    pkg/testing/remote/loader.proto
 grpc-gw:
 	protoc -I . --grpc-gateway_out . \
     --grpc-gateway_opt logtostderr=true \

cmd/server.go

@@ -3,6 +3,7 @@ package cmd
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"log"
 	"net"
@@ -16,6 +17,7 @@ import (
 	"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
 	"github.com/linuxsuren/api-testing/pkg/server"
 	"github.com/linuxsuren/api-testing/pkg/testing"
+	"github.com/linuxsuren/api-testing/pkg/testing/remote"
 	"github.com/linuxsuren/api-testing/pkg/util"
 	"github.com/spf13/cobra"
 	"google.golang.org/grpc"
@@ -35,7 +37,9 @@ func createServerCmd(gRPCServer gRPCServer, httpServer server.HTTPServer) (c *co
 	flags.IntVarP(&opt.port, "port", "p", 7070, "The RPC server port")
 	flags.IntVarP(&opt.httpPort, "http-port", "", 8080, "The HTTP server port")
 	flags.BoolVarP(&opt.printProto, "print-proto", "", false, "Print the proto content and exit")
+	flags.StringVarP(&opt.storage, "storage", "", "local", "The storage type, local or etcd")
 	flags.StringVarP(&opt.localStorage, "local-storage", "", "", "The local storage path")
+	flags.StringVarP(&opt.grpcStorage, "grpc-storage", "", "", "The grpc storage address")
 	flags.StringVarP(&opt.consolePath, "console-path", "", "", "The path of the console")
 	return
 }
@@ -47,7 +51,9 @@ type serverOption struct {
 	port         int
 	httpPort     int
 	printProto   bool
+	storage      string
 	localStorage string
+	grpcStorage  string
 	consolePath  string
 }
 
@@ -72,11 +78,25 @@ func (o *serverOption) runE(cmd *cobra.Command, args []string) (err error) {
 		return
 	}
 
-	loader := testing.NewFileWriter("")
-	if o.localStorage != "" {
-		if err = loader.Put(o.localStorage); err != nil {
+	var loader testing.Writer
+	switch o.storage {
+	case "local":
+		loader = testing.NewFileWriter("")
+		if o.localStorage != "" {
+			err = loader.Put(o.localStorage)
+		}
+	case "grpc":
+		if o.grpcStorage == "" {
+			err = errors.New("grpc storage address is required")
 			return
 		}
+		loader, err = remote.NewGRPCLoader(o.grpcStorage)
+	default:
+		err = errors.New("invalid storage type")
+	}
+
+	if err != nil {
+		return
 	}
 
 	removeServer := server.NewRemoteServer(loader)

console/atest-ui/src/App.vue

@@ -19,6 +19,27 @@ const handleNodeClick = (data: Tree) => {
   if (data.children) {
     viewName.value = "testsuite"
     testSuite.value = data.label
+
+    const requestOptions = {
+        method: 'POST',
+        body: JSON.stringify({
+            name: data.label,
+        })
+    };
+    fetch('/server.Runner/ListTestCase', requestOptions)
+        .then(response => response.json())
+        .then(d => {
+          if (d.items && d.items.length > 0) {
+            data.children=[]
+            d.items.forEach((item: any) => {
+              data.children?.push({
+                id: data.label+item.name,
+                label: item.name,
+                parent: data.label,
+              } as Tree)
+            })
+          }
+        })
   } else {
     testCaseName.value = data.label
     testSuite.value = data.parent

console/atest-ui/src/views/TestCase.vue

@@ -1,6 +1,6 @@
 <script setup lang="ts">
-import { reactive, ref, watch } from 'vue'
-import type { TabsPaneContext, FormInstance } from 'element-plus'
+import { ref, watch } from 'vue'
+import type { TabsPaneContext } from 'element-plus'
 import { ElMessage } from 'element-plus'
 import { Edit, Delete } from '@element-plus/icons-vue'
 import JsonViewer from 'vue-json-viewer'
@@ -283,60 +283,6 @@ function headerChange() {
 }
 
 const radio1 = ref('1')
-
-const dialogVisible = ref(false)
-const testcaseFormRef = ref<FormInstance>()
-const testCaseForm = reactive({
-    suiteName: "",
-    name: "",
-    api: "",
-})
-function openNewTestCaseDialog() {
-    loadTestSuites()
-    dialogVisible.value = true
-}
-
-const suiteCreatingLoading = ref(false)
-const testSuiteList = ref([])
-function loadTestSuites() {
-  const requestOptions = {
-      method: 'POST'
-  };
-  fetch('/server.Runner/GetSuites', requestOptions)
-      .then(response => response.json())
-      .then(d => {
-        Object.keys(d.data).map(k => {
-          testSuiteList.value.push(k)
-        })
-      });
-}
-const submitForm = (formEl: FormInstance | undefined) => {
-  if (!formEl) return
-  suiteCreatingLoading.value = true
-
-  const requestOptions = {
-    method: 'POST',
-    body: JSON.stringify({
-        suiteName: testCaseForm.suiteName,
-        data: {
-            name: testCaseForm.name,
-            request: {
-                api: testCaseForm.api,
-                method: "GET",
-            }
-        },
-    })
-  };
-
-  fetch('/server.Runner/UpdateTestCase', requestOptions)
-      .then(response => response.json())
-      .then(() => {
-        suiteCreatingLoading.value = false
-        emit('updated', 'hello from child')
-      });
-      
-  dialogVisible.value = false
-}
 </script>
 
 <template>
@@ -345,9 +291,7 @@ const submitForm = (formEl: FormInstance | undefined) => {
             <el-header style="padding-left: 5px;">
                 <div style="margin-bottom: 5px;">
                     <el-button type="primary" @click="saveTestCase" :icon="Edit" :loading="saveLoading">Save</el-button>
-                    <el-button type="primary" @click="openNewTestCaseDialog" :icon="Edit">New</el-button>
                     <el-button type="primary" @click="deleteTestCase" :icon="Delete">Delete</el-button>
-                    <el-text class="mx-1" type="primary">{{props.name}}</el-text>
                 </div>
                 <el-select v-model="testCaseWithSuite.data.request.method" class="m-2" placeholder="Method" size="middle">
                     <el-option v-for="item in options" :key="item.value" :label="item.label" :value="item.value" />
@@ -488,37 +432,4 @@ const submitForm = (formEl: FormInstance | undefined) => {
             </el-footer>
         </el-container>
     </div>
-
-  <el-dialog v-model="dialogVisible" title="Create Test Case" width="30%" draggable>
-    <template #footer>
-      <span class="dialog-footer">
-        <el-form
-          ref="testcaseFormRef"
-          status-icon
-          label-width="120px"
-          class="demo-ruleForm"
-        >
-          <el-form-item label="Suite" prop="suite">
-            <el-select class="m-2" v-model="testCaseForm.suiteName" placeholder="Select" size="large">
-                <el-option
-                v-for="item in testSuiteList"
-                :key="item"
-                :label="item"
-                :value="item"
-                />
-            </el-select>
-          </el-form-item>
-          <el-form-item label="Name" prop="name">
-            <el-input v-model="testCaseForm.name" />
-          </el-form-item>
-          <el-form-item label="API" prop="api">
-            <el-input v-model="testCaseForm.api" placeholder="http://foo" />
-          </el-form-item>
-          <el-form-item>
-            <el-button type="primary" @click="submitForm(testcaseFormRef)" :loading="suiteCreatingLoading">Submit</el-button>
-          </el-form-item>
-        </el-form>
-      </span>
-    </template>
-  </el-dialog>
 </template>