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

2026-04-21 20:17:29 +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/cors/go.mod
+++ b/plugins/wasm-go/extensions/cors/go.mod
@@ -5,8 +5,8 @@ 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
 )
@@ -15,8 +15,10 @@ 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/cors/go.sum
+++ b/plugins/wasm-go/extensions/cors/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,6 +22,8 @@ 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=
--- a/plugins/wasm-go/extensions/cors/main_test.go
+++ b/plugins/wasm-go/extensions/cors/main_test.go
@@ -0,0 +1,432 @@
+// 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"
+)
+
+// 测试配置：基本 CORS 配置
+var basicCorsConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"allow_origins": []string{
+			"http://example.com",
+			"https://example.com",
+		},
+		"allow_methods": []string{
+			"GET",
+			"POST",
+			"OPTIONS",
+		},
+		"allow_headers": []string{
+			"Content-Type",
+			"Authorization",
+		},
+		"expose_headers": []string{
+			"X-Custom-Header",
+		},
+		"allow_credentials": false,
+		"max_age":           3600,
+	})
+	return data
+}()
+
+// 测试配置：允许所有 Origin 的配置
+var allowAllOriginsConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"allow_origins": []string{
+			"*",
+		},
+		"allow_methods": []string{
+			"*",
+		},
+		"allow_headers": []string{
+			"*",
+		},
+		"expose_headers": []string{
+			"*",
+		},
+		"allow_credentials": false,
+		"max_age":           7200,
+	})
+	return data
+}()
+
+// 测试配置：带模式匹配的配置
+var patternMatchConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"allow_origin_patterns": []string{
+			"http://*.example.com",
+			"http://*.example.org:[8080,9090]",
+		},
+		"allow_methods": []string{
+			"GET",
+			"POST",
+			"PUT",
+			"DELETE",
+		},
+		"allow_headers": []string{
+			"Content-Type",
+			"Token",
+			"Authorization",
+		},
+		"expose_headers": []string{
+			"X-Custom-Header",
+			"X-Env-UTM",
+		},
+		"allow_credentials": true,
+		"max_age":           1800,
+	})
+	return data
+}()
+
+// 测试配置：允许凭据的配置
+var credentialsConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{
+		"allow_origin_patterns": []string{
+			"*",
+		},
+		"allow_methods": []string{
+			"GET",
+			"POST",
+		},
+		"allow_headers": []string{
+			"Content-Type",
+			"Authorization",
+		},
+		"expose_headers": []string{
+			"X-Custom-Header",
+		},
+		"allow_credentials": true,
+		"max_age":           86400,
+	})
+	return data
+}()
+
+// 测试配置：默认值配置
+var defaultConfig = func() json.RawMessage {
+	data, _ := json.Marshal(map[string]interface{}{})
+	return data
+}()
+
+func TestParseConfig(t *testing.T) {
+	test.RunGoTest(t, func(t *testing.T) {
+		// 测试基本 CORS 配置解析
+		t.Run("basic cors config", func(t *testing.T) {
+			host, status := test.NewTestHost(basicCorsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err)
+			require.NotNil(t, config)
+		})
+
+		// 测试允许所有 Origin 的配置解析
+		t.Run("allow all origins config", func(t *testing.T) {
+			host, status := test.NewTestHost(allowAllOriginsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err)
+			require.NotNil(t, config)
+		})
+
+		// 测试带模式匹配的配置解析
+		t.Run("pattern match config", func(t *testing.T) {
+			host, status := test.NewTestHost(patternMatchConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err)
+			require.NotNil(t, config)
+		})
+
+		// 测试允许凭据的配置解析
+		t.Run("credentials config", func(t *testing.T) {
+			host, status := test.NewTestHost(credentialsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err)
+			require.NotNil(t, config)
+		})
+
+		// 测试默认值配置解析
+		t.Run("default config", func(t *testing.T) {
+			host, status := test.NewTestHost(defaultConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			config, err := host.GetMatchConfig()
+			require.NoError(t, err)
+			require.NotNil(t, config)
+		})
+	})
+}
+
+func TestOnHttpRequestHeaders(t *testing.T) {
+	test.RunTest(t, func(t *testing.T) {
+		// 测试简单 CORS 请求头处理
+		t.Run("simple cors request headers", func(t *testing.T) {
+			host, status := test.NewTestHost(basicCorsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			// 设置请求头，包含 Origin
+			action := host.CallOnHttpRequestHeaders([][2]string{
+				{":authority", "example.com"},
+				{":path", "/api/test"},
+				{":method", "GET"},
+				{"origin", "http://example.com"},
+			})
+
+			// 有效的 CORS 请求应该返回 ActionContinue
+			require.Equal(t, types.ActionContinue, action)
+
+			host.CompleteHttp()
+		})
+
+		// 测试预检请求头处理
+		t.Run("preflight request headers", func(t *testing.T) {
+			host, status := test.NewTestHost(basicCorsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			// 设置预检请求头
+			action := host.CallOnHttpRequestHeaders([][2]string{
+				{":authority", "example.com"},
+				{":path", "/api/test"},
+				{":method", "OPTIONS"},
+				{"origin", "http://example.com"},
+				{"access-control-request-method", "POST"},
+				{"access-control-request-headers", "Content-Type, Authorization"},
+			})
+
+			// 预检请求应该返回 ActionPause
+			require.Equal(t, types.ActionPause, action)
+
+			host.CompleteHttp()
+		})
+
+		// 测试无效 Origin 的请求头处理
+		t.Run("invalid origin request headers", func(t *testing.T) {
+			host, status := test.NewTestHost(basicCorsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			// 设置请求头，包含无效的 Origin
+			action := host.CallOnHttpRequestHeaders([][2]string{
+				{":authority", "example.com"},
+				{":path", "/api/test"},
+				{":method", "GET"},
+				{"origin", "http://invalid.com"},
+			})
+
+			// 无效的 CORS 请求应该返回 ActionPause
+			require.Equal(t, types.ActionPause, action)
+
+			host.CompleteHttp()
+		})
+
+		// 测试允许所有 Origin 的请求头处理
+		t.Run("allow all origins request headers", func(t *testing.T) {
+			host, status := test.NewTestHost(allowAllOriginsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			// 设置请求头，包含任意 Origin
+			action := host.CallOnHttpRequestHeaders([][2]string{
+				{":authority", "example.com"},
+				{":path", "/api/test"},
+				{":method", "GET"},
+				{"origin", "http://any-domain.com"},
+			})
+
+			// 允许所有 Origin 的配置应该返回 ActionContinue
+			require.Equal(t, types.ActionContinue, action)
+
+			host.CompleteHttp()
+		})
+
+		// 测试模式匹配的请求头处理
+		t.Run("pattern match request headers", func(t *testing.T) {
+			host, status := test.NewTestHost(patternMatchConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			// 设置请求头，包含匹配模式的 Origin
+			action := host.CallOnHttpRequestHeaders([][2]string{
+				{":authority", "example.com"},
+				{":path", "/api/test"},
+				{":method", "GET"},
+				{"origin", "http://sub.example.com"},
+			})
+
+			// 匹配模式的 Origin 应该返回 ActionContinue
+			require.Equal(t, types.ActionContinue, action)
+
+			host.CompleteHttp()
+		})
+
+		// 测试非 CORS 请求头处理
+		t.Run("non-cors request headers", func(t *testing.T) {
+			host, status := test.NewTestHost(basicCorsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			// 设置请求头，不包含 Origin
+			action := host.CallOnHttpRequestHeaders([][2]string{
+				{":authority", "example.com"},
+				{":path", "/api/test"},
+				{":method", "GET"},
+			})
+
+			// 非 CORS 请求应该返回 ActionContinue
+			require.Equal(t, types.ActionContinue, action)
+
+			host.CompleteHttp()
+		})
+	})
+}
+
+func TestOnHttpResponseHeaders(t *testing.T) {
+	test.RunTest(t, func(t *testing.T) {
+		// 测试 CORS 响应头处理
+		t.Run("cors response headers", func(t *testing.T) {
+			host, status := test.NewTestHost(basicCorsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			// 先处理请求头
+			host.CallOnHttpRequestHeaders([][2]string{
+				{":authority", "example.com"},
+				{":path", "/api/test"},
+				{":method", "GET"},
+				{"origin", "http://example.com"},
+			})
+
+			// 处理响应头
+			action := host.CallOnHttpResponseHeaders([][2]string{
+				{":status", "200"},
+				{"content-type", "application/json"},
+			})
+
+			// 应该返回 ActionContinue
+			require.Equal(t, types.ActionContinue, action)
+
+			// 验证是否添加了 CORS 响应头
+			responseHeaders := host.GetResponseHeaders()
+			require.True(t, test.HasHeader(responseHeaders, "access-control-allow-origin"))
+			require.True(t, test.HasHeader(responseHeaders, "access-control-expose-headers"))
+
+			// 对于简单请求，不添加 AllowMethods 和 AllowHeaders（这些只在预检请求时添加）
+			require.False(t, test.HasHeader(responseHeaders, "access-control-allow-methods"))
+			require.False(t, test.HasHeader(responseHeaders, "access-control-allow-headers"))
+
+			host.CompleteHttp()
+		})
+
+		// 测试非 CORS 请求的响应头处理
+		t.Run("non-cors response headers", func(t *testing.T) {
+			host, status := test.NewTestHost(basicCorsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			// 先处理请求头，不包含 Origin
+			host.CallOnHttpRequestHeaders([][2]string{
+				{":authority", "example.com"},
+				{":path", "/api/test"},
+				{":method", "GET"},
+			})
+
+			// 处理响应头
+			action := host.CallOnHttpResponseHeaders([][2]string{
+				{":status", "200"},
+				{"content-type", "application/json"},
+			})
+
+			// 应该返回 ActionContinue
+			require.Equal(t, types.ActionContinue, action)
+
+			// 验证是否没有添加 CORS 响应头
+			responseHeaders := host.GetResponseHeaders()
+			require.False(t, test.HasHeader(responseHeaders, "access-control-allow-origin"))
+			require.False(t, test.HasHeader(responseHeaders, "access-control-expose-headers"))
+
+			host.CompleteHttp()
+		})
+
+		// 测试允许凭据的响应头处理
+		t.Run("credentials response headers", func(t *testing.T) {
+			host, status := test.NewTestHost(credentialsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			// 先处理请求头
+			host.CallOnHttpRequestHeaders([][2]string{
+				{":authority", "example.com"},
+				{":path", "/api/test"},
+				{":method", "GET"},
+				{"origin", "http://any-domain.com"},
+			})
+
+			// 处理响应头
+			action := host.CallOnHttpResponseHeaders([][2]string{
+				{":status", "200"},
+				{"content-type", "application/json"},
+			})
+
+			// 应该返回 ActionContinue
+			require.Equal(t, types.ActionContinue, action)
+
+			// 验证是否添加了允许凭据的响应头
+			responseHeaders := host.GetResponseHeaders()
+			require.True(t, test.HasHeaderWithValue(responseHeaders, "access-control-allow-credentials", "true"))
+
+			host.CompleteHttp()
+		})
+
+		// 测试预检请求的响应头处理
+		t.Run("preflight response headers", func(t *testing.T) {
+			host, status := test.NewTestHost(basicCorsConfig)
+			defer host.Reset()
+			require.Equal(t, types.OnPluginStartStatusOK, status)
+
+			// 先处理预检请求头
+			action := host.CallOnHttpRequestHeaders([][2]string{
+				{":authority", "example.com"},
+				{":path", "/api/test"},
+				{":method", "OPTIONS"},
+				{"origin", "http://example.com"},
+				{"access-control-request-method", "POST"},
+				{"access-control-request-headers", "Content-Type, Authorization"},
+			})
+
+			// 预检请求应该返回 ActionPause
+			require.Equal(t, types.ActionPause, action)
+
+			host.CompleteHttp()
+		})
+	})
+}