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

This commit is contained in:
Jingze
2025-08-28 20:02:03 +08:00
committed by GitHub
parent 3e0a5f02a7
commit a00b810be5
138 changed files with 27695 additions and 313 deletions

View File

@@ -7,8 +7,8 @@ toolchain go1.24.4
require (
github.com/bmatcuk/doublestar/v4 v4.6.1
github.com/google/uuid v1.6.0
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
)
@@ -16,8 +16,10 @@ require (
require (
github.com/davecgh/go-spew v1.1.1 // 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
)

View File

@@ -4,14 +4,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=
@@ -21,6 +24,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=

View File

@@ -0,0 +1,569 @@
// 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"
)
// 测试配置:基本灰度配置
var basicGrayConfig = func() json.RawMessage {
data, _ := json.Marshal(map[string]interface{}{
"grayKey": "userid",
"rules": []map[string]interface{}{
{
"name": "inner-user",
"grayKeyValue": []string{
"00000001",
"00000005",
},
},
{
"name": "beta-user",
"grayKeyValue": []string{
"00000002",
"00000003",
},
"grayTagKey": "level",
"grayTagValue": []string{
"level3",
"level5",
},
},
},
"baseDeployment": map[string]interface{}{
"version": "base",
"backendVersion": "base-backend",
},
"grayDeployments": []map[string]interface{}{
{
"name": "inner-user",
"version": "gray",
"enabled": true,
"backendVersion": "gray-backend",
},
},
})
return data
}()
// 测试配置:按比例灰度配置
var weightGrayConfig = func() json.RawMessage {
data, _ := json.Marshal(map[string]interface{}{
"grayKey": "userid",
"rules": []map[string]interface{}{
{
"name": "inner-user",
"grayKeyValue": []string{
"00000001",
"00000005",
},
},
},
"baseDeployment": map[string]interface{}{
"version": "base",
"backendVersion": "base-backend",
},
"grayDeployments": []map[string]interface{}{
{
"name": "inner-user",
"version": "gray",
"enabled": true,
"backendVersion": "gray-backend",
"weight": 80,
},
},
})
return data
}()
// 测试配置:带重写的配置
var rewriteConfig = func() json.RawMessage {
data, _ := json.Marshal(map[string]interface{}{
"grayKey": "userid",
"rules": []map[string]interface{}{
{
"name": "inner-user",
"grayKeyValue": []string{
"00000001",
"00000005",
},
},
},
"rewrite": map[string]interface{}{
"host": "frontend-gray.example.com",
"indexRouting": map[string]interface{}{
"/app1": "/mfe/app1/{version}/index.html",
"/": "/mfe/app1/{version}/index.html",
},
"fileRouting": map[string]interface{}{
"/": "/mfe/app1/{version}",
"/app1/": "/mfe/app1/{version}",
},
},
"baseDeployment": map[string]interface{}{
"version": "base",
"backendVersion": "base-backend",
},
"grayDeployments": []map[string]interface{}{
{
"name": "inner-user",
"version": "gray",
"enabled": true,
"backendVersion": "gray-backend",
},
},
})
return data
}()
// 测试配置:带注入的配置
var injectionConfig = func() json.RawMessage {
data, _ := json.Marshal(map[string]interface{}{
"grayKey": "userid",
"rules": []map[string]interface{}{
{
"name": "inner-user",
"grayKeyValue": []string{
"00000001",
"00000005",
},
},
},
"baseDeployment": map[string]interface{}{
"version": "base",
"backendVersion": "base-backend",
},
"grayDeployments": []map[string]interface{}{
{
"name": "inner-user",
"version": "gray",
"enabled": true,
"backendVersion": "gray-backend",
},
},
"injection": map[string]interface{}{
"head": []string{
"<script>console.log('Header')</script>",
},
"body": map[string]interface{}{
"first": []string{
"<script>console.log('hello world before')</script>",
},
"last": []string{
"<script>console.log('hello world after')</script>",
},
},
"globalConfig": map[string]interface{}{
"enabled": true,
"key": "TEST_CONFIG",
"featureKey": "FEATURE_STATUS",
"value": "testValue",
},
},
})
return data
}()
// 测试配置:带跳过路径的配置
var skippedPathsConfig = func() json.RawMessage {
data, _ := json.Marshal(map[string]interface{}{
"grayKey": "userid",
"rules": []map[string]interface{}{
{
"name": "inner-user",
"grayKeyValue": []string{
"00000001",
"00000005",
},
},
},
"skippedPaths": []string{
"/api/**",
"/static/**",
},
"indexPaths": []string{
"/app1/**",
"/index.html",
},
"baseDeployment": map[string]interface{}{
"version": "base",
"backendVersion": "base-backend",
},
"grayDeployments": []map[string]interface{}{
{
"name": "inner-user",
"version": "gray",
"enabled": true,
"backendVersion": "gray-backend",
},
},
})
return data
}()
func TestParseConfig(t *testing.T) {
test.RunGoTest(t, func(t *testing.T) {
// 测试基本灰度配置解析
t.Run("basic gray config", func(t *testing.T) {
host, status := test.NewTestHost(basicGrayConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
config, err := host.GetMatchConfig()
require.NoError(t, err)
require.NotNil(t, config)
})
// 测试按比例灰度配置解析
t.Run("weight gray config", func(t *testing.T) {
host, status := test.NewTestHost(weightGrayConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
config, err := host.GetMatchConfig()
require.NoError(t, err)
require.NotNil(t, config)
})
// 测试带重写的配置解析
t.Run("rewrite config", func(t *testing.T) {
host, status := test.NewTestHost(rewriteConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
config, err := host.GetMatchConfig()
require.NoError(t, err)
require.NotNil(t, config)
})
// 测试带注入的配置解析
t.Run("injection config", func(t *testing.T) {
host, status := test.NewTestHost(injectionConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
config, err := host.GetMatchConfig()
require.NoError(t, err)
require.NotNil(t, config)
})
// 测试带跳过路径的配置解析
t.Run("skipped paths config", func(t *testing.T) {
host, status := test.NewTestHost(skippedPathsConfig)
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) {
// 测试基本灰度请求头处理
t.Run("basic gray request headers", func(t *testing.T) {
host, status := test.NewTestHost(basicGrayConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
// 设置请求头,包含灰度用户 ID
action := host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
require.Equal(t, types.ActionContinue, action)
// 验证是否添加了版本标签头
requestHeaders := host.GetRequestHeaders()
require.True(t, test.HasHeader(requestHeaders, "x-higress-tag"))
host.CompleteHttp()
})
// 测试按比例灰度请求头处理
t.Run("weight gray request headers", func(t *testing.T) {
host, status := test.NewTestHost(weightGrayConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
action := host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
require.Equal(t, types.ActionContinue, action)
// 验证是否添加了版本标签头
requestHeaders := host.GetRequestHeaders()
require.True(t, test.HasHeader(requestHeaders, "x-higress-tag"))
host.CompleteHttp()
})
// 测试带重写的请求头处理
t.Run("rewrite request headers", func(t *testing.T) {
host, status := test.NewTestHost(rewriteConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
action := host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/app1"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
require.Equal(t, types.ActionContinue, action)
// 验证是否添加了版本标签头
requestHeaders := host.GetRequestHeaders()
require.True(t, test.HasHeader(requestHeaders, "x-higress-tag"))
host.CompleteHttp()
})
// 测试跳过路径的请求头处理
t.Run("skipped paths request headers", func(t *testing.T) {
host, status := test.NewTestHost(skippedPathsConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
// 测试跳过路径
action := host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/api/users"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
require.Equal(t, types.ActionContinue, action)
// 跳过路径不应该添加版本标签头
requestHeaders := host.GetRequestHeaders()
require.False(t, test.HasHeader(requestHeaders, "x-higress-tag"))
host.CompleteHttp()
})
// 测试非 HTML 请求的请求头处理
t.Run("non-html request headers", func(t *testing.T) {
host, status := test.NewTestHost(basicGrayConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
action := host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/api/data"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
require.Equal(t, types.ActionContinue, action)
// 非 HTML 请求也应该添加版本标签头
requestHeaders := host.GetRequestHeaders()
require.True(t, test.HasHeader(requestHeaders, "x-higress-tag"))
host.CompleteHttp()
})
})
}
func TestOnHttpResponseHeader(t *testing.T) {
test.RunTest(t, func(t *testing.T) {
// 测试基本灰度响应头处理
t.Run("basic gray response headers", func(t *testing.T) {
host, status := test.NewTestHost(basicGrayConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
// 先处理请求头
host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
// 处理响应头
action := host.CallOnHttpResponseHeaders([][2]string{
{":status", "200"},
{"content-type", "text/html"},
})
require.Equal(t, types.ActionContinue, action)
// 验证是否添加了 Set-Cookie 头
responseHeaders := host.GetResponseHeaders()
require.True(t, test.HasHeader(responseHeaders, "Set-Cookie"))
host.CompleteHttp()
})
// 测试 404 状态码的响应头处理
t.Run("404 status response headers", func(t *testing.T) {
host, status := test.NewTestHost(basicGrayConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
// 先处理请求头
host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
// 处理响应头
action := host.CallOnHttpResponseHeaders([][2]string{
{":status", "404"},
{"content-type", "text/plain"},
})
require.Equal(t, types.ActionContinue, action)
host.CompleteHttp()
})
// 测试非首页请求的响应头处理
t.Run("non-index response headers", func(t *testing.T) {
host, status := test.NewTestHost(basicGrayConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
// 先处理请求头
host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/api/data"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
// 处理响应头
action := host.CallOnHttpResponseHeaders([][2]string{
{":status", "200"},
{"content-type", "application/json"},
})
require.Equal(t, types.ActionContinue, action)
host.CompleteHttp()
})
})
}
func TestOnHttpResponseBody(t *testing.T) {
test.RunTest(t, func(t *testing.T) {
// 测试基本灰度响应体处理
t.Run("basic gray response body", func(t *testing.T) {
host, status := test.NewTestHost(basicGrayConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
// 先处理请求头
host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
// 处理响应头
host.CallOnHttpResponseHeaders([][2]string{
{":status", "200"},
{"content-type", "text/html"},
})
// 处理响应体
htmlBody := "<html><head><title>Test</title></head><body><h1>Hello World</h1></body></html>"
action := host.CallOnHttpResponseBody([]byte(htmlBody))
require.Equal(t, types.ActionContinue, action)
host.CompleteHttp()
})
// 测试带注入的响应体处理
t.Run("injection response body", func(t *testing.T) {
host, status := test.NewTestHost(injectionConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
// 先处理请求头
host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
// 处理响应头
host.CallOnHttpResponseHeaders([][2]string{
{":status", "200"},
{"content-type", "text/html"},
})
// 处理响应体
htmlBody := "<html><head><title>Test</title></head><body><h1>Hello World</h1></body></html>"
action := host.CallOnHttpResponseBody([]byte(htmlBody))
require.Equal(t, types.ActionContinue, action)
host.CompleteHttp()
})
// 测试非 HTML 请求的响应体处理
t.Run("non-html response body", func(t *testing.T) {
host, status := test.NewTestHost(basicGrayConfig)
defer host.Reset()
require.Equal(t, types.OnPluginStartStatusOK, status)
// 先处理请求头
host.CallOnHttpRequestHeaders([][2]string{
{":authority", "example.com"},
{":path", "/api/data"},
{":method", "GET"},
{"cookie", "userid=00000001"},
})
// 处理响应头
host.CallOnHttpResponseHeaders([][2]string{
{":status", "200"},
{"content-type", "application/json"},
})
// 处理响应体
jsonBody := `{"message": "Hello World"}`
action := host.CallOnHttpResponseBody([]byte(jsonBody))
require.Equal(t, types.ActionContinue, action)
host.CompleteHttp()
})
})
}