higress/plugins/wasm-cpp/README_EN.md

Intro

This SDK is used to develop the WASM Plugins for Higress in Go.

Quick build with Higress wasm-go builder

The wasm-go plugin can be built quickly with the following command:

$ PLUGIN_NAME=request_block make build

Output

DOCKER_BUILDKIT=1 docker build --build-arg PLUGIN_NAME=request_block 

-t request_block:20230721-141120-aa17e95 

--output extensions/request_block 

.
[+] Building 2.3s (10/10) FINISHED
output wasm file: extensions/request_block/plugin.wasm

This command eventually builds a wasm file and a Docker image. This local wasm file is exported to the specified plugin's directory and can be used directly for debugging.

Environmental parameters

Name	Optional/Required	Default	meaning
PLUGIN_NAME	Optional	hello-world	The name of the plugin to build.
IMG	Optional	If it is empty, it is generated based on the repository address, plugin name, build time, and git commit id.	The generated image tag will override the REGISTRY parameter if it is not empty.

Apply WasmPlugin API

Read this document to learn more about wasmplugin.

Create a WasmPlugin API resource:

apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
metadata:
  name: request-block
  namespace: higress-system
spec:
  defaultConfig:
    block_urls:
    - "swagger.html"
  url: oci://<your_registry_hub>/request-block:1.0.0

When the resource is applied on the Kubernetes cluster with kubectl apply -f <your-wasm-plugin-yaml>, the request will be blocked if the string swagger.html in the url.

curl <your_gateway_address>/api/user/swagger.html

HTTP/1.1 403 Forbidden
date: Wed, 09 Nov 2022 12:12:32 GMT
server: istio-envoy
content-length: 0

route-level & domain-level takes effect

apiVersion: extensions.higress.io/v1alpha1
kind: WasmPlugin
metadata:
  name: request-block
  namespace: higress-system
spec:
  defaultConfig:
   # this config will take effect globally (all incoming requests not matched by rules below)
   block_urls:
   - "swagger.html"
  matchRules:
  # ingress-level takes effect
  - ingress:
    - default/foo
    # the ingress foo in namespace default will use this config
    config:
      block_bodies:
      - "foo"
  - ingress:
    - default/bar
    # the ingress bar in namespace default will use this config
    config:
      block_bodies:
      - "bar"
  # domain-level takes effect
  - domain:
    - "*.example.com"
    # if the request's domain matched, this config will be used
    config:
      block_bodies:
       - "foo"
       - "bar"
  url: oci://<your_registry_hub>/request-block:1.0.0

The rules will be matched in the order of configuration. If one match is found, it will stop, and the matching configuration will take effect.

E2E test

When you complete a GO plug-in function, you can create associated e2e test cases at the same time, and complete the test verification of the plug-in function locally.

step1. write test cases

In the directory of ./ test/e2e/conformance/tests/, add the xxx.yaml file and xxx.go file. Such as test for request-block wasm-plugin,

./test/e2e/conformance/tests/request-block.yaml

apiVersion: networking.k8s.io/v1
kind: Ingress
...
...
spec:
  defaultConfig:
    block_urls:
    - "swagger.html"
  url: file:///opt/plugins/wasm-go/extensions/request-block/plugin.wasm

Above of the url, the name of after extensions indicates the name of the folder where the plug-in resides.

./test/e2e/conformance/tests/request-block.go

step2. add test cases

Add the test cases written above to the e2e test list,

./test/e2e/e2e_test.go

...
cSuite.Setup(t)
	var higressTests []suite.ConformanceTest

	if *isWasmPluginTest {
		if strings.Compare(*wasmPluginType, "CPP") == 0 {
			m := make(map[string]suite.ConformanceTest)
			m["request_block"] = tests.CPPWasmPluginsRequestBlock
			m["key_auth"] = tests.CPPWasmPluginsKeyAuth
        //Add your newly written case method name here

			higressTests = []suite.ConformanceTest{
				m[*wasmPluginName],
			}
		} else {
			higressTests = []suite.ConformanceTest{
				tests.WasmPluginsRequestBlock,
			}
		}
	} else {
...

step3. compile and run test cases

Considering that building wasm locally is time-consuming, we support building only the plug-ins that need to be tested (at the same time, you can also temporarily modify the list of test cases in the second small step above, and only execute your newly written cases).

PLUGIN_TYPE=CPP PLUGIN_NAME=request_block make higress-wasmplugin-test