change hostemulator's entrypoint signature

mathetake · mathetake · commit 04c9acd5b0f3 · 2020-10-03T16:16:15.000+09:00
Signed-off-by: mathetake &lt;takeshi@tetrate.io&gt;
diff --git a/README.md b/README.md
@@ -52,14 +52,12 @@ TinyGo's official release of WASI target will come soon, and after that you coul
  just follow https://tinygo.org/getting-started/ to install the requirement on any platform. Stay tuned!
 
 
-### compatible Envoy builds
-
-| proxy-wasm-go-sdk| proxy-wasm ABI version | envoyproxy/envoy-wasm| istio/proxyv2|
-|:-------------:|:-------------:|:-------------:|:-------------:|
-| main |  0.2.0|  N/A  |   v1.17.x |
-| v0.0.4 |  0.2.0|  N/A  |   v1.17.x |
-| v0.0.3 |  0.2.0|  N/A  |   v1.17.x |
-| v0.0.2 | 0.1.0|release/v1.15 | N/A |
+### compatible ABI / Envoy builds
+
+| proxy-wasm-go-sdk| proxy-wasm ABI version |istio/proxyv2|
+|:-------------:|:-------------:|:-------------:|
+| main |  0.2.0|   v1.17.x |
+| v0.0.4 |  0.2.0|   v1.17.x |
 
 
 ## run examples
diff --git a/examples/helloworld/main_test.go b/examples/helloworld/main_test.go
@@ -3,6 +3,9 @@ package main
 import (
 	"strings"
 	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
 
 	"github.com/stretchr/testify/assert"
 
@@ -11,22 +14,29 @@ import (
 )
 
 func TestHelloWorld_OnTick(t *testing.T) {
-	ctx := newHelloWorld(100)
-	host := proxytest.NewHostEmulator(nil, nil, newHelloWorld, nil, nil)
+	opt := proxytest.NewEmulatorOption().
+		WithNewRootContext(newHelloWorld)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
-	ctx.OnTick()
+
+	host.StartVM() // call OnVMStart
+
+	time.Sleep(time.Duration(tickMilliseconds) * 4 * time.Millisecond)
 
 	logs := host.GetLogs(types.LogLevelInfo)
+	require.Greater(t, len(logs), 0)
 	msg := logs[len(logs)-1]
 
 	assert.True(t, strings.Contains(msg, "OnTick on"))
 }
 
 func TestHelloWorld_OnVMStart(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil, newHelloWorld, nil, nil)
+	opt := proxytest.NewEmulatorOption().
+		WithNewRootContext(newHelloWorld)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
 
-	host.StartVM()
+	host.StartVM() // call OnVMStart
 	logs := host.GetLogs(types.LogLevelInfo)
 	msg := logs[len(logs)-1]
 
diff --git a/examples/http_auth_random/main_test.go b/examples/http_auth_random/main_test.go
@@ -11,7 +11,9 @@ import (
 )
 
 func TestHttpAuthRandom_OnHttpRequestHeaders(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil, nil, nil, newContext)
+	opt := proxytest.NewEmulatorOption().
+		WithNewHttpContext(newContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done()
 
 	contextID := host.HttpFilterInitContext()
@@ -32,7 +34,9 @@ func TestHttpAuthRandom_OnHttpRequestHeaders(t *testing.T) {
 }
 
 func TestHttpAuthRandom_OnHttpCallResponse(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil, nil, nil, newContext)
+	opt := proxytest.NewEmulatorOption().
+		WithNewHttpContext(newContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done()
 
 	// http://httpbin.org/uuid
diff --git a/examples/http_headers/main_test.go b/examples/http_headers/main_test.go
@@ -12,7 +12,9 @@ import (
 )
 
 func TestHttpHeaders_OnHttpRequestHeaders(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil, nil, nil, newContext)
+	opt := proxytest.NewEmulatorOption().
+		WithNewHttpContext(newContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done()
 	id := host.HttpFilterInitContext()
 
@@ -30,7 +32,9 @@ func TestHttpHeaders_OnHttpRequestHeaders(t *testing.T) {
 }
 
 func TestHttpHeaders_OnHttpResponseHeaders(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil, nil, nil, newContext)
+	opt := proxytest.NewEmulatorOption().
+		WithNewHttpContext(newContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done()
 	id := host.HttpFilterInitContext()
 
diff --git a/examples/metrics/main_test.go b/examples/metrics/main_test.go
@@ -11,9 +11,10 @@ import (
 )
 
 func TestMetric(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil,
-		newRootContext, nil, newHttpContext,
-	)
+	opt := proxytest.NewEmulatorOption().
+		WithNewHttpContext(newHttpContext).
+		WithNewRootContext(newRootContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
 
 	host.StartVM() // call OnVMStart: define metric
diff --git a/examples/network/main.go b/examples/network/main.go
@@ -59,7 +59,6 @@ func (ctx *networkContext) OnNewConnection() types.Action {
 
 func (ctx *networkContext) OnDownstreamData(dataSize int, _ bool) types.Action {
 	if dataSize == 0 {
-		panic("aa")
 		return types.ActionContinue
 	}
 
diff --git a/examples/network/main_test.go b/examples/network/main_test.go
@@ -25,8 +25,10 @@ import (
 )
 
 func TestNetwork_OnNewConnection(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil,
-		newRootContext, newNetworkContext, nil)
+	opt := proxytest.NewEmulatorOption().
+		WithNewStreamContext(newNetworkContext).
+		WithNewRootContext(newRootContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
 
 	host.StartVM() // call OnVMStart: init metric
@@ -38,8 +40,10 @@ func TestNetwork_OnNewConnection(t *testing.T) {
 }
 
 func TestNetwork_OnDownstreamClose(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil,
-		newRootContext, newNetworkContext, nil)
+	opt := proxytest.NewEmulatorOption().
+		WithNewStreamContext(newNetworkContext).
+		WithNewRootContext(newRootContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
 
 	contextID := host.NetworkFilterInitConnection()        // OnNewConnection is called
@@ -51,8 +55,10 @@ func TestNetwork_OnDownstreamClose(t *testing.T) {
 }
 
 func TestNetwork_OnDownstreamData(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil,
-		newRootContext, newNetworkContext, nil)
+	opt := proxytest.NewEmulatorOption().
+		WithNewStreamContext(newNetworkContext).
+		WithNewRootContext(newRootContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
 
 	contextID := host.NetworkFilterInitConnection() // OnNewConnection is called
@@ -66,8 +72,10 @@ func TestNetwork_OnDownstreamData(t *testing.T) {
 }
 
 func TestNetwork_OnUpstreamData(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil,
-		newRootContext, newNetworkContext, nil)
+	opt := proxytest.NewEmulatorOption().
+		WithNewStreamContext(newNetworkContext).
+		WithNewRootContext(newRootContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
 
 	contextID := host.NetworkFilterInitConnection() // OnNewConnection is called
@@ -81,8 +89,10 @@ func TestNetwork_OnUpstreamData(t *testing.T) {
 }
 
 func TestNetwork_counter(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil,
-		newRootContext, newNetworkContext, nil)
+	opt := proxytest.NewEmulatorOption().
+		WithNewStreamContext(newNetworkContext).
+		WithNewRootContext(newRootContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
 
 	host.StartVM() // call OnVMStart: init metric
diff --git a/examples/shared_data/main_test.go b/examples/shared_data/main_test.go
@@ -25,9 +25,10 @@ import (
 )
 
 func TestData(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil,
-		newRootContext, nil, newHttpContext,
-	)
+	opt := proxytest.NewEmulatorOption().
+		WithNewHttpContext(newHttpContext).
+		WithNewRootContext(newRootContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
 
 	host.StartVM() // set initial value
diff --git a/examples/shared_queue/main_test.go b/examples/shared_queue/main_test.go
@@ -27,8 +27,10 @@ import (
 )
 
 func TestQueue(t *testing.T) {
-	host := proxytest.NewHostEmulator(nil, nil,
-		newRootContext, nil, newHttpContext)
+	opt := proxytest.NewEmulatorOption().
+		WithNewHttpContext(newHttpContext).
+		WithNewRootContext(newRootContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
 
 	host.StartVM() // register the queue,set tick period
diff --git a/examples/vm_plugin_configuration/main_test.go b/examples/vm_plugin_configuration/main_test.go
@@ -29,7 +29,10 @@ import (
 func TestContext_OnPluginStart(t *testing.T) {
 	pluginConfigData := `{"name": "tinygo plugin configuration"}`
 
-	host := proxytest.NewHostEmulator([]byte(pluginConfigData), nil, newRootContext, nil, nil)
+	opt := proxytest.NewEmulatorOption().
+		WithPluginConfiguration([]byte(pluginConfigData)).
+		WithNewRootContext(newRootContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the emulation lock so that other test cases can insert their own host emulation
 
 	host.StartPlugin() // invoke OnPluginStart
@@ -42,7 +45,10 @@ func TestContext_OnPluginStart(t *testing.T) {
 
 func TestContext_OnVMStart(t *testing.T) {
 	vmConfigData := `{"name": "tinygo vm configuration"}`
-	host := proxytest.NewHostEmulator(nil, []byte(vmConfigData), newRootContext, nil, nil)
+	opt := proxytest.NewEmulatorOption().
+		WithVMConfiguration([]byte(vmConfigData)).
+		WithNewRootContext(newRootContext)
+	host := proxytest.NewHostEmulator(opt)
 	defer host.Done() // release the host emulation lock so that other test cases can insert their own host emulation
 
 	host.StartVM() // invoke OnVMStart
diff --git a/proxytest/option.go b/proxytest/option.go
@@ -0,0 +1,39 @@
+package proxytest
+
+import "github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm"
+
+type EmulatorOption struct {
+	pluginConfiguration, vmConfiguration []byte
+	newRootContext                       func(uint32) proxywasm.RootContext
+	newStreamContext                     func(uint32) proxywasm.StreamContext
+	newHttpContext                       func(uint32) proxywasm.HttpContext
+}
+
+func NewEmulatorOption() *EmulatorOption {
+	return &EmulatorOption{}
+}
+
+func (o *EmulatorOption) WithNewRootContext(f func(uint32) proxywasm.RootContext) *EmulatorOption {
+	o.newRootContext = f
+	return o
+}
+
+func (o *EmulatorOption) WithNewHttpContext(f func(uint32) proxywasm.HttpContext) *EmulatorOption {
+	o.newHttpContext = f
+	return o
+}
+
+func (o *EmulatorOption) WithNewStreamContext(f func(uint32) proxywasm.StreamContext) *EmulatorOption {
+	o.newStreamContext = f
+	return o
+}
+
+func (o *EmulatorOption) WithPluginConfiguration(data []byte) *EmulatorOption {
+	o.pluginConfiguration = data
+	return o
+}
+
+func (o *EmulatorOption) WithVMConfiguration(data []byte) *EmulatorOption {
+	o.vmConfiguration = data
+	return o
+}
diff --git a/proxytest/proxytest.go b/proxytest/proxytest.go
@@ -55,13 +55,8 @@ var (
 	nextContextID = rootContextID + 1
 )
 
-func NewHostEmulator(pluginConfiguration,
-	vmConfiguration []byte,
-	newRootContext func(uint32) proxywasm.RootContext,
-	newStreamContext func(uint32) proxywasm.StreamContext,
-	newHttpContext func(uint32) proxywasm.HttpContext,
-) HostEmulator {
-	root := newRootHostEmulator(pluginConfiguration, vmConfiguration)
+func NewHostEmulator(opt *EmulatorOption) HostEmulator {
+	root := newRootHostEmulator(opt.pluginConfiguration, opt.vmConfiguration)
 	network := newNetworkHostEmulator()
 	http := newHttpHostEmulator()
 	emulator := &hostEmulator{
@@ -75,9 +70,9 @@ func NewHostEmulator(pluginConfiguration,
 	rawhostcall.RegisterMockWASMHost(emulator)
 
 	// set up state
-	proxywasm.SetNewRootContext(newRootContext)
-	proxywasm.SetNewStreamContext(newStreamContext)
-	proxywasm.SetNewHttpContext(newHttpContext)
+	proxywasm.SetNewRootContext(opt.newRootContext)
+	proxywasm.SetNewStreamContext(opt.newStreamContext)
+	proxywasm.SetNewHttpContext(opt.newHttpContext)
 
 	// create root context: TODO: support multiple root contexts
 	proxywasm.ProxyOnContextCreate(rootContextID, 0)

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,6 @@ func (ctx *networkContext) OnNewConnection() types.Action {`
`59`	`59`
`60`	`60`	`func (ctx *networkContext) OnDownstreamData(dataSize int, _ bool) types.Action {`
`61`	`61`	`if dataSize == 0 {`
`62`		`- panic("aa")`
`63`	`62`	`return types.ActionContinue`
`64`	`63`	`}`
`65`	`64`