feat(wasm-go): add wasm go plugin unit test and ci workflow (#2809)

2026-06-07 03:37:28 +08:00 · 2025-08-28 20:02:03 +08:00
parent 3e0a5f02a7
commit a00b810be5
138 changed files with 27695 additions and 313 deletions
--- a/plugins/wasm-go/extensions/http-call/go.mod
+++ b/plugins/wasm-go/extensions/http-call/go.mod
@@ -5,14 +5,20 @@ go 1.24.1
 toolchain go1.24.4

 require (
-	github.com/higress-group/proxy-wasm-go-sdk v0.0.0-20250611100342-5654e89a7a80
-	github.com/higress-group/wasm-go v1.0.0
+	github.com/higress-group/proxy-wasm-go-sdk v0.0.0-20250822030947-8345453fddd0
+	github.com/higress-group/wasm-go v1.0.2-0.20250821081215-b573359becf8
+	github.com/stretchr/testify v1.9.0
 	github.com/tidwall/gjson v1.18.0
 )

 require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/google/uuid v1.6.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/tetratelabs/wazero v1.7.2 // indirect
 	github.com/tidwall/match v1.1.1 // indirect
 	github.com/tidwall/pretty v1.2.1 // indirect
 	github.com/tidwall/resp v0.1.1 // indirect
+	github.com/tidwall/sjson v1.2.5 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
--- a/plugins/wasm-go/extensions/http-call/go.sum
+++ b/plugins/wasm-go/extensions/http-call/go.sum
@@ -2,14 +2,17 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
 github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
-github.com/higress-group/proxy-wasm-go-sdk v0.0.0-20250611100342-5654e89a7a80 h1:xqmtTZI0JQ2O+Lg9/CE6c+Tw9KD6FnvWw8EpLVuuvfg=
-github.com/higress-group/proxy-wasm-go-sdk v0.0.0-20250611100342-5654e89a7a80/go.mod h1:tRI2LfMudSkKHhyv1uex3BWzcice2s/l8Ah8axporfA=
-github.com/higress-group/wasm-go v1.0.0 h1:4Ik5n3FsJ5+r13KLQl2ky+8NuAE8dfWQwoKxXYD2KAw=
-github.com/higress-group/wasm-go v1.0.0/go.mod h1:ODBV27sjmhIW8Cqv3R74EUcTnbdkE69bmXBQFuRkY1M=
+github.com/higress-group/proxy-wasm-go-sdk v0.0.0-20250822030947-8345453fddd0 h1:YGdj8KBzVjabU3STUfwMZghB+VlX6YLfJtLbrsWaOD0=
+github.com/higress-group/proxy-wasm-go-sdk v0.0.0-20250822030947-8345453fddd0/go.mod h1:tRI2LfMudSkKHhyv1uex3BWzcice2s/l8Ah8axporfA=
+github.com/higress-group/wasm-go v1.0.2-0.20250821081215-b573359becf8 h1:rs+AH1wfZy4swzuAyiRXT7xPUm8gycXt9Gwy0tqOq0o=
+github.com/higress-group/wasm-go v1.0.2-0.20250821081215-b573359becf8/go.mod h1:9k7L730huS/q4V5iH9WLDgf5ZUHEtfhM/uXcegKDG/M=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
 github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/tetratelabs/wazero v1.7.2 h1:1+z5nXJNwMLPAWaTePFi49SSTL0IMx/i3Fg8Yc25GDc=
+github.com/tetratelabs/wazero v1.7.2/go.mod h1:ytl6Zuh20R/eROuyDaGPkp82O9C/DJfXAwJfQ3X6/7Y=
+github.com/tidwall/gjson v1.14.2/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
 github.com/tidwall/gjson v1.18.0 h1:FIDeeyB800efLX89e5a8Y0BNH+LOngJyGrIWxG2FKQY=
 github.com/tidwall/gjson v1.18.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
 github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
@@ -19,5 +22,9 @@ github.com/tidwall/pretty v1.2.1 h1:qjsOFOWWQl+N3RsoF5/ssm1pHmJJwhjlSbZ51I6wMl4=
 github.com/tidwall/pretty v1.2.1/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
 github.com/tidwall/resp v0.1.1 h1:Ly20wkhqKTmDUPlyM1S7pWo5kk0tDu8OoC/vFArXmwE=
 github.com/tidwall/resp v0.1.1/go.mod h1:3/FrruOBAxPTPtundW0VXgmsQ4ZBA0Aw714lVYgwFa0=
+github.com/tidwall/sjson v1.2.5 h1:kLy8mja+1c9jlljvWTlSazM7cKDRfJuR/bOJhcY5NcY=
+github.com/tidwall/sjson v1.2.5/go.mod h1:Fvgq9kS/6ociJEDnK0Fk1cpYF4FIW6ZF7LAe+6jwd28=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
--- a/plugins/wasm-go/extensions/http-call/main_test.go
+++ b/plugins/wasm-go/extensions/http-call/main_test.go
@@ -0,0 +1,384 @@
+// Copyright (c) 2022 Alibaba Group Holding Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/higress-group/proxy-wasm-go-sdk/proxywasm/types"
+	"github.com/higress-group/wasm-go/pkg/test"
+	"github.com/stretchr/testify/require"
+)
+
+// 测试k8s服务源配置
+var k8sTestConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"bodyHeader":    "x-response-body",
+		"tokenHeader":   "x-auth-token",
+		"requestPath":   "/api/auth",
+		"serviceSource": "k8s",
+		"serviceName":   "auth-service",
+		"servicePort":   8080,
+		"namespace":     "default",
+	})
+	return data
+}()
+
+// 测试nacos服务源配置
+var nacosTestConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"bodyHeader":    "x-response-body",
+		"tokenHeader":   "x-auth-token",
+		"requestPath":   "/api/auth",
+		"serviceSource": "nacos",
+		"serviceName":   "auth-service",
+		"servicePort":   8080,
+		"namespace":     "public",
+	})
+	return data
+}()
+
+// 测试ip服务源配置
+var ipTestConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"bodyHeader":    "x-response-body",
+		"tokenHeader":   "x-auth-token",
+		"requestPath":   "/api/auth",
+		"serviceSource": "ip",
+		"serviceName":   "auth-service",
+		"servicePort":   8080,
+	})
+	return data
+}()
+
+// 测试dns服务源配置
+var dnsTestConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"bodyHeader":    "x-response-body",
+		"tokenHeader":   "x-auth-token",
+		"requestPath":   "/api/auth",
+		"serviceSource": "dns",
+		"serviceName":   "auth-service",
+		"servicePort":   8080,
+		"domain":        "auth.example.com",
+	})
+	return data
+}()
+
+// 测试缺少bodyHeader的配置
+var missingBodyHeaderConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"tokenHeader":   "x-auth-token",
+		"requestPath":   "/api/auth",
+		"serviceSource": "k8s",
+		"serviceName":   "auth-service",
+		"servicePort":   8080,
+		"namespace":     "default",
+	})
+	return data
+}()
+
+// 测试缺少tokenHeader的配置
+var missingTokenHeaderConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"bodyHeader":    "x-response-body",
+		"requestPath":   "/api/auth",
+		"serviceSource": "k8s",
+		"serviceName":   "auth-service",
+		"servicePort":   8080,
+		"namespace":     "default",
+	})
+	return data
+}()
+
+// 测试缺少requestPath的配置
+var missingRequestPathConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"bodyHeader":    "x-response-body",
+		"tokenHeader":   "x-auth-token",
+		"serviceSource": "k8s",
+		"serviceName":   "auth-service",
+		"servicePort":   8080,
+		"namespace":     "default",
+	})
+	return data
+}()
+
+// 测试无效服务源的配置
+var invalidServiceSourceConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"bodyHeader":    "x-response-body",
+		"tokenHeader":   "x-auth-token",
+		"requestPath":   "/api/auth",
+		"serviceSource": "invalid",
+		"serviceName":   "auth-service",
+		"servicePort":   8080,
+		"namespace":     "default",
+	})
+	return data
+}()
+
+func TestParseConfig(t *testing.T) {
+	test.RunGoTest(t, func(t *testing.T) {
+		// 测试k8s服务源配置
+		t.Run("k8s service source", func(t *testing.T) {
+			host, status := test.NewTestHost(k8sTestConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err)
+			require.NotNil(t, config)
+
+			httpCallConfig := config.(*HttpCallConfig)
+			require.Equal(t, "x-response-body", httpCallConfig.bodyHeader)
+			require.Equal(t, "x-auth-token", httpCallConfig.tokenHeader)
+			require.Equal(t, "/api/auth", httpCallConfig.requestPath)
+			require.NotNil(t, httpCallConfig.client)
+		})
+
+		// 测试nacos服务源配置
+		t.Run("nacos service source", func(t *testing.T) {
+			host, status := test.NewTestHost(nacosTestConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err)
+			require.NotNil(t, config)
+
+			httpCallConfig := config.(*HttpCallConfig)
+			require.Equal(t, "x-response-body", httpCallConfig.bodyHeader)
+			require.Equal(t, "x-auth-token", httpCallConfig.tokenHeader)
+			require.Equal(t, "/api/auth", httpCallConfig.requestPath)
+			require.NotNil(t, httpCallConfig.client)
+		})
+
+		// 测试ip服务源配置
+		t.Run("ip service source", func(t *testing.T) {
+			host, status := test.NewTestHost(ipTestConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err)
+			require.NotNil(t, config)
+
+			httpCallConfig := config.(*HttpCallConfig)
+			require.Equal(t, "x-response-body", httpCallConfig.bodyHeader)
+			require.Equal(t, "x-auth-token", httpCallConfig.tokenHeader)
+			require.Equal(t, "/api/auth", httpCallConfig.requestPath)
+			require.NotNil(t, httpCallConfig.client)
+		})
+
+		// 测试dns服务源配置
+		t.Run("dns service source", func(t *testing.T) {
+			host, status := test.NewTestHost(dnsTestConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err)
+			require.NotNil(t, config)
+
+			httpCallConfig := config.(*HttpCallConfig)
+			require.Equal(t, "x-response-body", httpCallConfig.bodyHeader)
+			require.Equal(t, "x-auth-token", httpCallConfig.tokenHeader)
+			require.Equal(t, "/api/auth", httpCallConfig.requestPath)
+			require.NotNil(t, httpCallConfig.client)
+		})
+
+		// 测试缺少bodyHeader的配置
+		t.Run("missing bodyHeader", func(t *testing.T) {
+			host, status := test.NewTestHost(missingBodyHeaderConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusFailed, status)
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err) // 框架不会返回错误，而是返回nil配置
+			require.Nil(t, config)  // 配置解析失败时返回nil
+		})
+
+		// 测试缺少tokenHeader的配置
+		t.Run("missing tokenHeader", func(t *testing.T) {
+			host, status := test.NewTestHost(missingTokenHeaderConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusFailed, status)
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err) // 框架不会返回错误，而是返回nil配置
+			require.Nil(t, config)  // 配置解析失败时返回nil
+		})
+
+		// 测试缺少requestPath的配置
+		t.Run("missing requestPath", func(t *testing.T) {
+			host, status := test.NewTestHost(missingRequestPathConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusFailed, status)
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err) // 框架不会返回错误，而是返回nil配置
+			require.Nil(t, config)  // 配置解析失败时返回nil
+		})
+
+		// 测试无效服务源的配置
+		t.Run("invalid service source", func(t *testing.T) {
+			host, status := test.NewTestHost(invalidServiceSourceConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusFailed, status)
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err) // 框架不会返回错误，而是返回nil配置
+			require.Nil(t, config)  // 配置解析失败时返回nil
+		})
+	})
+}
+
+func TestK8sOnHttpRequestHeaders(t *testing.T) {
+	test.RunTest(t, func(t *testing.T) {
+		// 使用k8s配置进行测试
+		host, status := test.NewTestHost(k8sTestConfig)
+		defer host.Reset()
+		require.Equal(t, types.OnPluginStartStatusOK, status)
+
+		// 模拟HTTP请求头
+		action := host.CallOnHttpRequestHeaders([][2]string{
+			{":authority", "test.com"},
+			{":path", "/api/test"},
+			{":method", "GET"},
+		})
+
+		// 验证返回的action
+		require.Equal(t, types.HeaderStopAllIterationAndWatermark, action)
+
+		// 模拟外部服务的HTTP调用响应
+		// 模拟成功响应
+		host.CallOnHttpCall([][2]string{
+			{":status", "200"},
+			{"x-auth-token", "test-token-123"},
+			{"content-type", "application/json"},
+		}, []byte(`{"message": "success", "data": "test-data"}`))
+
+		// 验证请求头是否正确设置
+		requestHeaders := host.GetRequestHeaders()
+
+		// 查找bodyHeader
+		bodyHeaderFound := false
+		tokenHeaderFound := false
+
+		for _, header := range requestHeaders {
+			if header[0] == "x-response-body" {
+				bodyHeaderFound = true
+				// 验证响应体内容（换行符被替换为#）
+				expectedBody := `{"message": "success", "data": "test-data"}`
+				require.Equal(t, expectedBody, header[1])
+			}
+			if header[0] == "x-auth-token" {
+				tokenHeaderFound = true
+				require.Equal(t, "test-token-123", header[1])
+			}
+		}
+
+		require.True(t, bodyHeaderFound, "bodyHeader should be set")
+		require.True(t, tokenHeaderFound, "tokenHeader should be set")
+		require.Equal(t, types.ActionContinue, host.GetHttpStreamAction())
+		host.CompleteHttp()
+	})
+}
+
+func TestK8sOnHttpRequestHeadersWithError(t *testing.T) {
+	test.RunTest(t, func(t *testing.T) {
+		// 使用k8s配置进行测试
+		host, status := test.NewTestHost(k8sTestConfig)
+		defer host.Reset()
+		require.Equal(t, types.OnPluginStartStatusOK, status)
+
+		// 模拟HTTP请求头
+		action := host.CallOnHttpRequestHeaders([][2]string{
+			{":authority", "test.com"},
+			{":path", "/api/test"},
+			{":method", "GET"},
+		})
+
+		// 验证返回的action
+		require.Equal(t, types.HeaderStopAllIterationAndWatermark, action)
+
+		// 模拟外部服务返回错误状态码
+		host.CallOnHttpCall([][2]string{
+			{":status", "500"},
+			{"content-type", "application/json"},
+		}, []byte(`{"error": "internal server error"}`))
+
+		// 验证请求头不应该被设置（因为状态码不是200）
+		requestHeaders := host.GetRequestHeaders()
+
+		bodyHeaderFound := false
+		tokenHeaderFound := false
+
+		for _, header := range requestHeaders {
+			if header[0] == "x-response-body" {
+				bodyHeaderFound = true
+			}
+			if header[0] == "x-auth-token" {
+				tokenHeaderFound = true
+			}
+		}
+
+		require.False(t, bodyHeaderFound, "bodyHeader should not be set when status code is not 200")
+		require.False(t, tokenHeaderFound, "tokenHeader should not be set when status code is not 200")
+		require.Equal(t, types.ActionContinue, host.GetHttpStreamAction())
+		host.CompleteHttp()
+	})
+}
+
+func TestK8sOnHttpRequestHeadersWithNewlines(t *testing.T) {
+	test.RunTest(t, func(t *testing.T) {
+		// 使用k8s配置进行测试
+		host, status := test.NewTestHost(k8sTestConfig)
+		defer host.Reset()
+		require.Equal(t, types.OnPluginStartStatusOK, status)
+
+		// 模拟HTTP请求头
+		action := host.CallOnHttpRequestHeaders([][2]string{
+			{":authority", "test.com"},
+			{":path", "/api/test"},
+			{":method", "GET"},
+		})
+
+		// 验证返回的action
+		require.Equal(t, types.HeaderStopAllIterationAndWatermark, action)
+
+		// 模拟外部服务响应包含换行符
+		responseBody := `{"message": "success",
+"data": "test-data",
+"description": "multi-line response"}`
+
+		host.CallOnHttpCall([][2]string{
+			{":status", "200"},
+			{"x-auth-token", "test-token-456"},
+			{"content-type", "application/json"},
+		}, []byte(responseBody))
+
+		// 验证请求头是否正确设置，换行符应该被替换为#
+		requestHeaders := host.GetRequestHeaders()
+
+		bodyHeaderFound := false
+		expectedBody := `{"message": "success",#"data": "test-data",#"description": "multi-line response"}`
+
+		for _, header := range requestHeaders {
+			if header[0] == "x-response-body" {
+				bodyHeaderFound = true
+				require.Equal(t, expectedBody, header[1])
+			}
+		}
+
+		require.True(t, bodyHeaderFound, "bodyHeader should be set with newlines replaced by #")
+		require.Equal(t, types.ActionContinue, host.GetHttpStreamAction())
+		host.CompleteHttp()
+	})
+}