chore: add http body example & implement proxytest set buffer bytes method

Author: Wim Spaargaren

examples/http_body/README.md

@@ -0,0 +1,9 @@
+## http_headers
+
+this example replaces the request body
+
+```
+2020/10/12 13:41:31 proxy_info_log: body size: 29
+2020/10/12 13:41:31 proxy_info_log: initial request body: { "initial": "request body" }
+2020/10/12 13:41:31 proxy_info_log: on http request body finished
+```

examples/http_body/envoy.yaml

@@ -0,0 +1,82 @@
+static_resources:
+  listeners:
+    - name: main
+      address:
+        socket_address:
+          address: 0.0.0.0
+          port_value: 18000
+      filter_chains:
+        - filters:
+            - name: envoy.http_connection_manager
+              config:
+                stat_prefix: ingress_http
+                codec_type: auto
+                route_config:
+                  name: local_route
+                  virtual_hosts:
+                    - name: local_service
+                      domains:
+                        - "*"
+                      routes:
+                        - match:
+                            prefix: "/"
+                          route:
+                            cluster: web_service
+                http_filters:
+                  - name: envoy.filters.http.wasm
+                    config:
+                      config:
+                        name: "my_plugin"
+                        root_id: "my_root_id"
+                        vm_config:
+                          vm_id: "my_vm_id"
+                          runtime: "envoy.wasm.runtime.v8"
+                          code:
+                            local:
+                              filename: "./examples/http_headers/main.go.wasm"
+                          allow_precompiled: true
+                  - name: envoy.router
+                    config: {}
+    - name: staticreply
+      address:
+        socket_address:
+          address: 127.0.0.1
+          port_value: 8099
+      filter_chains:
+        - filters:
+            - name: envoy.http_connection_manager
+              config:
+                stat_prefix: ingress_http
+                codec_type: auto
+                route_config:
+                  name: local_route
+                  virtual_hosts:
+                    - name: local_service
+                      domains:
+                        - "*"
+                      routes:
+                        - match:
+                            prefix: "/"
+                          direct_response:
+                            status: 200
+                            body:
+                              inline_string: "example body\n"
+                http_filters:
+                  - name: envoy.router
+                    config: {}
+
+  clusters:
+    - name: web_service
+      connect_timeout: 0.25s
+      type: static
+      lb_policy: round_robin
+      hosts:
+        - socket_address:
+            address: 127.0.0.1
+            port_value: 8099
+admin:
+  access_log_path: "/dev/null"
+  address:
+    socket_address:
+      address: 0.0.0.0
+      port_value: 8001

examples/http_body/main.go

@@ -0,0 +1,57 @@
+// Copyright 2020 Tetrate
+//
+// 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 (
+	"github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm"
+	"github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm/types"
+)
+
+func main() {
+	proxywasm.SetNewHttpContext(newContext)
+}
+
+type httpBody struct {
+	// you must embed the default context so that you need not to reimplement all the methods by yourself
+	proxywasm.DefaultHttpContext
+	contextID uint32
+}
+
+func newContext(rootContextID, contextID uint32) proxywasm.HttpContext {
+	return &httpBody{contextID: contextID}
+}
+
+// override
+func (ctx *httpBody) OnHttpRequestBody(bodySize int, endOfStream bool) types.Action {
+	proxywasm.LogInfof("body size: %d", bodySize)
+
+	b, err := proxywasm.GetHttpRequestBody(0, bodySize)
+	if err != nil {
+		proxywasm.LogErrorf("failed to get request body: %v", err)
+		return types.ActionContinue
+	}
+
+	proxywasm.LogInfof("initial request body: %s", string(b))
+
+	err = proxywasm.SetHttpRequestBody([]byte(`{"test":"data"}`))
+	if err != nil {
+		proxywasm.LogErrorf("failed to get request body: %v", err)
+		return types.ActionContinue
+	}
+
+	proxywasm.LogInfof("on http request body finished")
+
+	return types.ActionContinue
+}

examples/http_body/main_test.go

@@ -0,0 +1,30 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"github.com/tetratelabs/proxy-wasm-go-sdk/proxytest"
+	"github.com/tetratelabs/proxy-wasm-go-sdk/proxywasm/types"
+)
+
+func TestHttpHeaders_OnHttpRequestHeaders(t *testing.T) {
+	opt := proxytest.NewEmulatorOption().
+		WithNewHttpContext(newContext)
+	host := proxytest.NewHostEmulator(opt)
+	defer host.Done()
+
+	id := host.HttpFilterInitContext()
+	host.HttpFilterPutRequestBody(id, []byte(`{ "initial": "request body" }`))
+
+	res := host.HttpFilterGetRequestBody(id)
+	assert.Equal(t, `{"test":"data"}`, string(res))
+
+	logs := host.GetLogs(types.LogLevelInfo)
+	require.Greater(t, len(logs), 1)
+
+	assert.Equal(t, "on http request body finished", logs[len(logs)-1])
+	assert.Equal(t, `initial request body: { "initial": "request body" }`, logs[len(logs)-2])
+	assert.Equal(t, "body size: 29", logs[len(logs)-3])
+}

proxytest/http.go

@@ -76,6 +76,22 @@ func (h *httpHostEmulator) httpHostEmulatorProxyGetBufferBytes(bt types.BufferTy
 	return types.StatusOK
 }
 
+func (h *httpHostEmulator) httpHostEmulatorProxySetBufferBytes(bt types.BufferType, start int, maxSize int,
+	bufferData *byte, bufferSize int) types.Status {
+	body := proxywasm.RawBytePtrToByteSlice(bufferData, bufferSize)
+	active := proxywasm.VMStateGetActiveContextID()
+	stream := h.httpStreams[active]
+	switch bt {
+	case types.BufferTypeHttpRequestBody:
+		stream.requestBody = body
+	case types.BufferTypeHttpResponseBody:
+		stream.responseBody = body
+	default:
+		panic("unreachable: maybe a bug in this host emulation or SDK")
+	}
+	return types.StatusOK
+}
+
 // impl rawhostcall.ProxyWASMHost: delegated from hostEmulator
 func (h *httpHostEmulator) httpHostEmulatorProxyGetHeaderMapValue(mapType types.MapType, keyData *byte,
 	keySize int, returnValueData **byte, returnValueSize *int) types.Status {
@@ -351,6 +367,15 @@ func (h *httpHostEmulator) HttpFilterPutRequestBody(contextID uint32, body []byt
 		len(body), false) // TODO: allow for specifying end_of_stream
 }
 
+func (h *httpHostEmulator) HttpFilterGetRequestBody(contextID uint32) []byte {
+	cs, ok := h.httpStreams[contextID]
+	if !ok {
+		log.Fatalf("invalid context id: %d", contextID)
+	}
+
+	return cs.requestBody
+}
+
 // impl HostEmulator
 func (h *httpHostEmulator) HttpFilterPutResponseBody(contextID uint32, body []byte) {
 	cs, ok := h.httpStreams[contextID]
@@ -363,6 +388,15 @@ func (h *httpHostEmulator) HttpFilterPutResponseBody(contextID uint32, body []by
 		len(body), false) // TODO: allow for specifying end_of_stream
 }
 
+func (h *httpHostEmulator) HttpFilterGetResponseBody(contextID uint32) []byte {
+	cs, ok := h.httpStreams[contextID]
+	if !ok {
+		log.Fatalf("invalid context id: %d", contextID)
+	}
+
+	return cs.responseBody
+}
+
 // impl HostEmulator
 func (h *httpHostEmulator) HttpFilterCompleteHttpStream(contextID uint32) {
 	proxywasm.ProxyOnDone(contextID)

proxytest/proxytest.go

@@ -41,7 +41,9 @@ type HostEmulator interface {
 	HttpFilterPutRequestTrailers(contextID uint32, headers [][2]string)
 	HttpFilterPutResponseTrailers(contextID uint32, headers [][2]string)
 	HttpFilterPutRequestBody(contextID uint32, body []byte)
+	HttpFilterGetRequestBody(contextID uint32) []byte
 	HttpFilterPutResponseBody(contextID uint32, body []byte)
+	HttpFilterGetResponseBody(contextID uint32) []byte
 	HttpFilterCompleteHttpStream(contextID uint32)
 	HttpFilterGetCurrentStreamAction(contextID uint32) types.Action
 	HttpFilterGetSentLocalResponse(contextID uint32) *LocalHttpResponse
@@ -117,8 +119,12 @@ func (h *hostEmulator) ProxyGetBufferBytes(bt types.BufferType, start int, maxSi
 }
 
 func (h *hostEmulator) ProxySetBufferBytes(bt types.BufferType, start int, maxSize int, bufferData *byte, bufferSize int) types.Status {
-	// TODO: implement host emulator set buffer bytes
-	return types.StatusOK
+	switch bt {
+	case types.BufferTypeHttpRequestBody, types.BufferTypeHttpResponseBody:
+		return h.httpHostEmulatorProxySetBufferBytes(bt, start, maxSize, bufferData, bufferSize)
+	default:
+		panic("unreachable: maybe a bug in this host emulation or SDK")
+	}
 }
 
 // impl rawhostcall.ProxyWASMHost