add tcp proxy support (#692)

LinuxSuRen · web-flow · commit f989857aec1d · 2025-05-23T21:06:45.000+08:00
* add tcp proxy support

* fix the fake runtime compitable issues

* upgrade go version from 1.22 to 1.23

---------

Co-authored-by: rick &lt;LinuxSuRen@users.noreply.github.com&gt;
diff --git a/Dockerfile b/Dockerfile
@@ -5,7 +5,7 @@ COPY console/atest-ui .
 RUN npm install --ignore-scripts --registry=https://registry.npmmirror.com
 RUN npm run build-only
 
-FROM docker.io/golang:1.22.4 AS builder
+FROM docker.io/golang:1.23 AS builder
 
 ARG VERSION
 ARG GOPROXY
diff --git a/cmd/convert_test.go b/cmd/convert_test.go
@@ -32,7 +32,7 @@ import (
 )
 
 func TestConvert(t *testing.T) {
-	c := cmd.NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"},
+	c := cmd.NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"},
 		server.NewFakeHTTPServer())
 	c.SetOut(io.Discard)
 
diff --git a/cmd/function_test.go b/cmd/function_test.go
@@ -64,7 +64,7 @@ func TestCreateFunctionCommand(t *testing.T) {
 	}}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			c := cmd.NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"},
+			c := cmd.NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"},
 				server.NewFakeHTTPServer())
 
 			buf := new(bytes.Buffer)
diff --git a/cmd/jsonschema_test.go b/cmd/jsonschema_test.go
@@ -28,7 +28,7 @@ import (
 )
 
 func TestJSONSchemaCmd(t *testing.T) {
-	c := cmd.NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"},
+	c := cmd.NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"},
 		server.NewFakeHTTPServer())
 
 	buf := new(bytes.Buffer)
diff --git a/cmd/mock-compose.go b/cmd/mock-compose.go
@@ -17,52 +17,49 @@ limitations under the License.
 package cmd
 
 import (
-	"os"
-	"os/signal"
-	"syscall"
-
-	"github.com/linuxsuren/api-testing/pkg/mock"
-	"github.com/spf13/cobra"
+    "github.com/linuxsuren/api-testing/pkg/mock"
+    "github.com/spf13/cobra"
+    "os"
+    "os/signal"
+    "syscall"
 )
 
 func createMockComposeCmd() (c *cobra.Command) {
-	c = &cobra.Command{
-		Use:   "mock-compose",
-		Short: "Mock multiple servers",
-		Args:  cobra.ExactArgs(1),
-		RunE: func(cmd *cobra.Command, args []string) (err error) {
-			reader := mock.NewLocalFileReader(args[0])
+    c = &cobra.Command{
+        Use:   "mock-compose",
+        Short: "Mock multiple servers",
+        Args:  cobra.ExactArgs(1),
+        RunE: func(cmd *cobra.Command, args []string) (err error) {
+            reader := mock.NewLocalFileReader(args[0])
 
-			var server *mock.Server
-			if server, err = reader.Parse(); err != nil {
-				return
-			}
+            var server *mock.Server
+            if server, err = reader.Parse(); err != nil {
+                return
+            }
 
-			var subServers []mock.DynamicServer
-			for _, proxy := range server.Proxies {
-				subProxy := &mock.Server{
-					Proxies: []mock.Proxy{proxy},
-				}
+            var subServers []mock.DynamicServer
+            for _, proxy := range server.Proxies {
+                subProxy := &mock.Server{
+                    Proxies: []mock.Proxy{proxy},
+                }
 
-				subReader := mock.NewObjectReader(subProxy)
-				subServer := mock.NewInMemoryServer(c.Context(), proxy.Port)
-				if err = subServer.Start(subReader, proxy.Prefix); err != nil {
-					return
-				}
-				subServers = append(subServers, subServer)
-			}
+                subReader := mock.NewObjectReader(subProxy)
+                subServer := mock.NewInMemoryServer(c.Context(), proxy.Port)
+                go subServer.Start(subReader, proxy.Prefix)
+                subServers = append(subServers, subServer)
+            }
 
-			clean := make(chan os.Signal, 1)
-			signal.Notify(clean, syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP, syscall.SIGQUIT)
-			select {
-			case <-c.Context().Done():
-			case <-clean:
-			}
-			for _, server := range subServers {
-				server.Stop()
-			}
-			return
-		},
-	}
-	return
+            clean := make(chan os.Signal, 1)
+            signal.Notify(clean, syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP, syscall.SIGQUIT)
+            select {
+            case <-c.Context().Done():
+            case <-clean:
+            }
+            for _, server := range subServers {
+                server.Stop()
+            }
+            return
+        },
+    }
+    return
 }
diff --git a/cmd/mock_test.go b/cmd/mock_test.go
@@ -49,7 +49,7 @@ func TestMockCommand(t *testing.T) {
 	}
 	for _, tc := range tt {
 		t.Run(tc.name, func(t *testing.T) {
-			root := NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())
+			root := NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())
 			root.SetOut(io.Discard)
 			root.SetArgs(tc.args)
 			ctx, cancel := context.WithCancel(context.TODO())
diff --git a/cmd/root_test.go b/cmd/root_test.go
@@ -26,7 +26,7 @@ import (
 )
 
 func TestCreateRunCommand(t *testing.T) {
-	execer := fakeruntime.FakeExecer{}
+	execer := &fakeruntime.FakeExecer{}
 
 	cmd := createRunCommand()
 	assert.Equal(t, "run", cmd.Use)
@@ -45,7 +45,7 @@ func TestCreateRunCommand(t *testing.T) {
 }
 
 func TestRootCmd(t *testing.T) {
-	c := NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())
+	c := NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())
 	assert.NotNil(t, c)
 	assert.Equal(t, "atest", c.Use)
 }
diff --git a/cmd/sample_test.go b/cmd/sample_test.go
@@ -28,7 +28,7 @@ import (
 )
 
 func TestSampleCmd(t *testing.T) {
-	c := cmd.NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"},
+	c := cmd.NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"},
 		server.NewFakeHTTPServer())
 
 	buf := new(bytes.Buffer)
diff --git a/cmd/server_test.go b/cmd/server_test.go
@@ -80,7 +80,7 @@ func TestPrintProto(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			buf := new(bytes.Buffer)
-			root := NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())
+			root := NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())
 			root.SetOut(buf)
 			root.SetArgs(append(tt.args, "--dry-run"))
 			err := root.Execute()
@@ -182,7 +182,7 @@ func TestFrontEndHandlerWithLocation(t *testing.T) {
 
 	t.Run("download atest", func(t *testing.T) {
 		opt := &serverOption{
-			execer: fakeruntime.FakeExecer{
+			execer: &fakeruntime.FakeExecer{
 				ExpectOS:            "linux",
 				ExpectLookPathError: errors.New("fake"),
 			},
@@ -199,7 +199,7 @@ func TestFrontEndHandlerWithLocation(t *testing.T) {
 
 	t.Run("download atest, failed to read", func(t *testing.T) {
 		opt := &serverOption{
-			execer: fakeruntime.FakeExecer{
+			execer: &fakeruntime.FakeExecer{
 				ExpectOS: "linux",
 			},
 		}
@@ -268,7 +268,7 @@ func TestOAuth(t *testing.T) {
 	}}
 	for i, tt := range tests {
 		buf := new(bytes.Buffer)
-		root := NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())
+		root := NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())
 		root.SetOut(buf)
 		root.SetArgs(append(tt.args, "--dry-run"))
 		err := root.Execute()
@@ -294,7 +294,7 @@ func TestStartPlugins(t *testing.T) {
 		}
 		rootCmd.SetOut(io.Discard)
 		rootCmd.AddCommand(createServerCmd(
-			fakeruntime.FakeExecer{ExpectOS: "linux", ExpectLookPathError: errors.New("not-found")},
+			&fakeruntime.FakeExecer{ExpectOS: "linux", ExpectLookPathError: errors.New("not-found")},
 			server.NewFakeHTTPServer(),
 		))
 
@@ -310,7 +310,7 @@ func TestStartPlugins(t *testing.T) {
 		}
 		rootCmd.SetOut(io.Discard)
 		rootCmd.AddCommand(createServerCmd(
-			fakeruntime.FakeExecer{ExpectOS: "linux", ExpectLookPathError: errors.New("not-found")},
+			&fakeruntime.FakeExecer{ExpectOS: "linux", ExpectLookPathError: errors.New("not-found")},
 			httpServer,
 		))
 
diff --git a/docs/site/content/zh/latest/tasks/mock.md b/docs/site/content/zh/latest/tasks/mock.md
@@ -38,7 +38,7 @@ docker pull localhost:6060/repo/name:tag
 * 面向对象的 CRUD
 * 自定义 HTTP 服务
 
-### 面对对象
+### 面向对象
 
 ```yaml
 #!api-testing-mock
@@ -160,6 +160,16 @@ proxies:
     target: http://192.168.123.58:9200
 ```
 
+## TCP 协议代理
+
+```yaml
+proxies:
+  - protocol: tcp
+    port: 3306
+    path: /
+    target: 192.168.123.58:33060
+```
+
 ## 代理多个服务
 
 ```shell
@@ -178,6 +188,12 @@ proxies:
     port: 17001
     path: /{path:.*}
     target: http://192.168.123.58:17001
+  - protocol: tcp
+    port: 33060
+    path: /
+    target: 192.168.123.58:33060
 ```
 
+当前代理支持 HTTP 和 TCP 协议，上面的例子中代理了 MySQL 的 `33060` 端口。
+
 > 更多 URL 中通配符的用法，请参考 https://github.com/gorilla/mux
diff --git a/pkg/mock/in_memory.go b/pkg/mock/in_memory.go
diff --git a/pkg/mock/types.go b/pkg/mock/types.go
diff --git a/pkg/runner/http_test.go b/pkg/runner/http_test.go
diff --git a/pkg/server/store_ext_manager_test.go b/pkg/server/store_ext_manager_test.go
diff --git a/tools/github-actions/setup-deps/action.yml b/tools/github-actions/setup-deps/action.yml

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ import (`
`32`	`32`	`)`
`33`	`33`
`34`	`34`	`func TestConvert(t *testing.T) {`
`35`		`- c := cmd.NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"},`
	`35`	`+ c := cmd.NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"},`
`36`	`36`	`server.NewFakeHTTPServer())`
`37`	`37`	`c.SetOut(io.Discard)`
`38`	`38`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ import (`
`28`	`28`	`)`
`29`	`29`
`30`	`30`	`func TestJSONSchemaCmd(t *testing.T) {`
`31`		`- c := cmd.NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"},`
	`31`	`+ c := cmd.NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"},`
`32`	`32`	`server.NewFakeHTTPServer())`
`33`	`33`
`34`	`34`	`buf := new(bytes.Buffer)`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ func TestMockCommand(t *testing.T) {`
`49`	`49`	`}`
`50`	`50`	`for _, tc := range tt {`
`51`	`51`	`t.Run(tc.name, func(t *testing.T) {`
`52`		`- root := NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())`
	`52`	`+ root := NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())`
`53`	`53`	`root.SetOut(io.Discard)`
`54`	`54`	`root.SetArgs(tc.args)`
`55`	`55`	`ctx, cancel := context.WithCancel(context.TODO())`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import (`
`26`	`26`	`)`
`27`	`27`
`28`	`28`	`func TestCreateRunCommand(t *testing.T) {`
`29`		`- execer := fakeruntime.FakeExecer{}`
	`29`	`+ execer := &fakeruntime.FakeExecer{}`
`30`	`30`
`31`	`31`	`cmd := createRunCommand()`
`32`	`32`	`assert.Equal(t, "run", cmd.Use)`
`@@ -45,7 +45,7 @@ func TestCreateRunCommand(t *testing.T) {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`func TestRootCmd(t *testing.T) {`
`48`		`- c := NewRootCmd(fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())`
	`48`	`+ c := NewRootCmd(&fakeruntime.FakeExecer{ExpectOS: "linux"}, server.NewFakeHTTPServer())`
`49`	`49`	`assert.NotNil(t, c)`
`50`	`50`	`assert.Equal(t, "atest", c.Use)`
`51`	`51`	`}`