ci: check plugin order (#804)

* ci: check plugin order Signed-off-by: spacewander <spacewanderlzx@gmail.com> * Update api/pkg/plugins/plugins_test.go Co-authored-by: zll600 <71714656+zll600@users.noreply.github.com> * fix Signed-off-by: spacewander <spacewanderlzx@gmail.com> * tweak doc Signed-off-by: spacewander <spacewanderlzx@gmail.com> --------- Signed-off-by: spacewander <spacewanderlzx@gmail.com> Co-authored-by: zll600 <71714656+zll600@users.noreply.github.com>
mosn · Dec 2, 2024 · 1ee7a36 · 1ee7a36
1 parent 855823f
commit 1ee7a36
Show file tree

Hide file tree

Showing 6 changed files with 368 additions and 35 deletions.
diff --git a/api/pkg/plugins/plugins.go b/api/pkg/plugins/plugins.go
@@ -82,6 +82,14 @@ func LoadPluginType(name string) Plugin {
 	return pluginTypes[name]
 }
 
+func IteratePluginType(f func(key string, value Plugin) bool) {
+	for k, v := range pluginTypes {
+		if !f(k, v) {
+			return
+		}
+	}
+}
+
 // We separate the plugin type storage and plugin storage, to avoid plugin type overrides the plugin by accident.
 
 func RegisterPlugin(name string, plugin Plugin) {

diff --git a/api/pkg/plugins/plugins_test.go b/api/pkg/plugins/plugins_test.go
@@ -27,6 +27,29 @@ import (
 	_ "mosn.io/htnn/api/plugins/tests/pkg/envoy" // for log implementation
 )
 
+func TestIteratePluginType(t *testing.T) {
+	plugin := &MockPlugin{}
+	RegisterPlugin("test", plugin)
+	RegisterPluginType("test2", plugin)
+
+	names := []string{}
+	IteratePluginType(func(name string, p Plugin) bool {
+		names = append(names, name)
+		assert.Equal(t, p, plugin)
+		return true
+	})
+	assert.Contains(t, names, "test")
+	assert.Contains(t, names, "test2")
+
+	names = []string{}
+	IteratePluginType(func(name string, p Plugin) bool {
+		names = append(names, name)
+		return false
+	})
+	assert.Equal(t, 1, len(names))
+	// the order is not guaranteed, it can be "test" or "test2"
+}
+
 func TestIteratePlugin(t *testing.T) {
 	plugin := &MockPlugin{}
 	RegisterPlugin("test", plugin)

diff --git a/maintainer/feature_maturity_level.yaml b/maintainer/feature_maturity_level.yaml
@@ -13,84 +13,91 @@
 # When adding a new feature, please set the experimental_since field to the next release.
 
 plugins:
-  - name: bandwidth_limit
+  # The order here is the same as the order of the plugin execution.
+  # This is guaranteed in the CI.
+  # Note: This file only shows the plugin's registered order. Some plugins may not be executed in
+  # the DecodeHeaders phase. For example, the plugin called when processing the response but is
+  # registered earlier is executed behind the plugin invoked when processing the request but is
+  # registered later.
+  - name: listenerPatch
     status: experimental
     experimental_since: 0.4.0
-  - name: buffer
+  - name: tlsInspector
     status: experimental
     experimental_since: 0.4.0
-  - name: casbin
+  - name: networkRBAC
     status: experimental
     experimental_since: 0.4.0
-  - name: cel_script
+  - name: bandwidthLimit
     status: experimental
     experimental_since: 0.4.0
-  - name: consumer_restriction
+  - name: buffer
     status: experimental
     experimental_since: 0.4.0
-  - name: cors
+  - name: localRatelimit
     status: stable
     stable_since: 0.4.0
-  - name: debug_mode
+  - name: outerExtProc
     status: experimental
     experimental_since: 0.4.0
-  - name: demo
+  - name: outerLua
     status: experimental
     experimental_since: 0.4.0
-  - name: ext_auth
+  - name: cors
     status: stable
     stable_since: 0.4.0
   - name: fault
     status: stable
     stable_since: 0.4.0
-  - name: hmac_auth
-    status: experimental
-    experimental_since: 0.4.0
-  - name: inner_ext_proc
+  - name: debugMode
     status: experimental
     experimental_since: 0.4.0
-  - name: inner_lua
+  - name: hmacAuth
     status: experimental
     experimental_since: 0.4.0
-  - name: key_auth
+  - name: keyAuth
     status: stable
     stable_since: 0.4.0
-  - name: limit_count_redis
+  - name: oidc
+    status: experimental
+    experimental_since: 0.4.0
+  - name: casbin
+    status: experimental
+    experimental_since: 0.4.0
+  - name: consumerRestriction
+    status: experimental
+    experimental_since: 0.4.0
+  - name: extAuth
     status: stable
     stable_since: 0.4.0
-  - name: limit_req
+  - name: opa
     status: experimental
     experimental_since: 0.4.0
-  - name: listener_patch
+  - name: celScript
     status: experimental
     experimental_since: 0.4.0
-  - name: local_ratelimit
+  - name: limitCountRedis
     status: stable
     stable_since: 0.4.0
-  - name: network_rbac
+  - name: limitReq
     status: experimental
     experimental_since: 0.4.0
-  - name: oidc
+  - name: sentinel
     status: experimental
-    experimental_since: 0.4.0
-  - name: opa
+    experimental_since: 0.5.0
+  - name: demo
     status: experimental
     experimental_since: 0.4.0
-  - name: outer_ext_proc
+  - name: innerExtProc
     status: experimental
     experimental_since: 0.4.0
-  - name: outer_lua
+  - name: innerLua
     status: experimental
     experimental_since: 0.4.0
-  - name: route_patch
+  - name: routePatch
     status: experimental
     experimental_since: 0.4.1
-  - name: sentinel
-    status: experimental
-    experimental_since: 0.5.0
-  - name: tls_inspector
-    status: experimental
-    experimental_since: 0.4.0
+
 registries:
   - name: consul
     status: experimental

diff --git a/tools/cmd/linter/main.go b/tools/cmd/linter/main.go
@@ -25,13 +25,18 @@ import (
 	"path/filepath"
 	"reflect"
 	"slices"
+	"sort"
 	"strings"
 
+	"github.com/pmezard/go-difflib/difflib"
 	protoparser "github.com/yoheimuta/go-protoparser/v4"
 	"github.com/yoheimuta/go-protoparser/v4/parser"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 	"gopkg.in/yaml.v3"
+
+	"mosn.io/htnn/api/pkg/plugins"
+	_ "mosn.io/htnn/types/plugins"
 )
 
 // This tool does what the third party linters don't
@@ -257,6 +262,13 @@ func snakeToCamel(s string) string {
 	return strings.Join(words, "")
 }
 
+func filenameToPluginName(name string) string {
+	if name == "network_rbac" {
+		return "networkRBAC"
+	}
+	return snakeToCamel(name)
+}
+
 func lintFilenameForDoc(root string) error {
 	return filepath.Walk(root, func(path string, info fs.FileInfo, err error) error {
 		if err != nil {
@@ -594,7 +606,7 @@ func getFeatureMaturityLevel(category string) ([]maturityLevel, error) {
 
 		name := filepath.Base(path)[:len(filepath.Base(path))-len(ext)]
 		res = append(res, maturityLevel{
-			name:     name,
+			name:     filenameToPluginName(name),
 			maturity: status,
 		})
 		return nil
@@ -641,6 +653,29 @@ func lintFeatureMaturityLevel() error {
 		}
 	}
 
+	// also check the plugin execution order documented in this file
+	type pluginWrapper struct {
+		Name string
+		plugins.Plugin
+	}
+	var pluginList []pluginWrapper
+	plugins.IteratePluginType(func(name string, p plugins.Plugin) bool {
+		pluginList = append(pluginList, pluginWrapper{
+			Name:   name,
+			Plugin: p,
+		})
+		return true
+	})
+	sort.Slice(pluginList, func(i, j int) bool {
+		return plugins.ComparePluginOrder(pluginList[i].Name, pluginList[j].Name)
+	})
+
+	var recordedOrder []string
+	var runtimeOrder []string
+	for _, p := range pluginList {
+		runtimeOrder = append(runtimeOrder, p.Name+"\n")
+	}
+
 	for category, recs := range records {
 		for _, record := range recs {
 			if record.Status == "experimental" {
@@ -670,6 +705,11 @@ func lintFeatureMaturityLevel() error {
 			if !found {
 				return fmt.Errorf("feature maturity record of %s %s is missing in the documentation", category, record.Name)
 			}
+
+			if category == "plugins" {
+				name := record.Name + "\n"
+				recordedOrder = append(recordedOrder, name)
+			}
 		}
 	}
 	for _, category := range Categories {
@@ -678,6 +718,21 @@ func lintFeatureMaturityLevel() error {
 		}
 	}
 
+	diff := difflib.UnifiedDiff{
+		A:        recordedOrder,
+		B:        runtimeOrder,
+		FromFile: "Expected",
+		ToFile:   "Actual",
+		Context:  3,
+	}
+	text, err := difflib.GetUnifiedDiffString(diff)
+	if err != nil {
+		return err
+	}
+	if text != "" {
+		return errors.New("Plugin order is not correct:\n" + text + ". Please fix the order in " + recordFile)
+	}
+
 	return nil
 }
 

diff --git a/tools/go.mod b/tools/go.mod
@@ -14,10 +14,64 @@
 
 module mosn.io/htnn/tools
 
-go 1.21
+go 1.22
 
 require (
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2
 	github.com/yoheimuta/go-protoparser/v4 v4.11.0
 	golang.org/x/text v0.20.0
 	gopkg.in/yaml.v3 v3.0.1
+	mosn.io/htnn/api v0.4.1
+	mosn.io/htnn/types v0.4.1
+)
+
+require (
+	cel.dev/expr v0.15.0 // indirect
+	github.com/OneOfOne/xxhash v1.2.8 // indirect
+	github.com/agnivade/levenshtein v1.1.1 // indirect
+	github.com/antlr4-go/antlr/v4 v4.13.0 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
+	github.com/cncf/xds/go v0.0.0-20240423153145-555b57ec207b // indirect
+	github.com/envoyproxy/envoy v1.31.0 // indirect
+	github.com/envoyproxy/go-control-plane v0.12.1-0.20240621013728-1eb8caab5155 // indirect
+	github.com/envoyproxy/protoc-gen-validate v1.0.4 // indirect
+	github.com/go-ini/ini v1.67.0 // indirect
+	github.com/go-logr/logr v1.4.2 // indirect
+	github.com/go-logr/stdr v1.2.2 // indirect
+	github.com/go-logr/zapr v1.3.0 // indirect
+	github.com/gobwas/glob v0.2.3 // indirect
+	github.com/google/cel-go v0.20.1 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/gorilla/mux v1.8.1 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/open-policy-agent/opa v0.68.0 // indirect
+	github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 // indirect
+	github.com/prometheus/client_golang v1.20.2 // indirect
+	github.com/prometheus/client_model v0.6.1 // indirect
+	github.com/prometheus/common v0.55.0 // indirect
+	github.com/prometheus/procfs v0.15.1 // indirect
+	github.com/rcrowley/go-metrics v0.0.0-20200313005456-10cdbea86bc0 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/stoewer/go-strcase v1.2.0 // indirect
+	github.com/tchap/go-patricia/v2 v2.3.1 // indirect
+	github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
+	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
+	github.com/yashtewari/glob-intersection v0.2.0 // indirect
+	go.opentelemetry.io/otel v1.28.0 // indirect
+	go.opentelemetry.io/otel/metric v1.28.0 // indirect
+	go.opentelemetry.io/otel/sdk v1.28.0 // indirect
+	go.opentelemetry.io/otel/trace v1.28.0 // indirect
+	go.opentelemetry.io/proto/otlp v1.3.1 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
+	go.uber.org/zap v1.27.0 // indirect
+	golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect
+	golang.org/x/net v0.28.0 // indirect
+	golang.org/x/sys v0.23.0 // indirect
+	google.golang.org/genproto/googleapis/api v0.0.0-20240701130421-f6361c86f094 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20240701130421-f6361c86f094 // indirect
+	google.golang.org/grpc v1.66.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	sigs.k8s.io/yaml v1.4.0 // indirect
 )