csds client: add filter support to node id (#35)

This PR includes adding flag -filter_mode and -filter_pattern to support filter on node_id. #34

Filter modes currently supported:
- prefix
- suffix
- regex

Signed-off-by: Yutong Li <[email protected]>

Author: Rainton

csds-client/README.md

@@ -64,6 +64,10 @@ Common options are exposed/controlled via command line flags, while control plan
    * If the browser fails to open due to os version issue, you can copy the content in `config_graph.dot`, and then paste it in the edit box on the left of [Graphviz Online](https://dreampuf.github.io/GraphvizOnline/) or any other tools for [Graphviz](https://graphviz.org/) to show the graph of the dot file.
    * Each xDS node shown in the graph is labelled by index (e.g. LDS0, RDS0, RDS1,...) to make the graph more clear. The real name of xDS resource in config will show when the user hovers the mouse over each node.
    * If **the visualization mode** and **the monitor mode** are enabled together, the client will only save graph dot data for the latest response without opening the browser to avoid frequent pop-ups of the browser due to short monitor interval.
+* ***-filter_mode***: the filter mode for the filter on Client ID to be returned (e.g. prefix, suffix, regex, ...)
+   * If this flag is not specified, all Client ID will be returned.
+* ***-filter_pattern***: the filter pattern for the filter on Client ID to be returned
+   * This flag works with ***-filter_mode*** together.
 
 ## Output
 ```

csds-client/client/client.go

@@ -17,6 +17,8 @@ type ClientOptions struct {
 	ConfigFile      string
 	MonitorInterval time.Duration
 	Visualization   bool
+	FilterMode      string
+	FilterPattern   string
 }
 
 // Client implements CSDS Client of a particular version. Upon creation of the new client it is

csds-client/client/util/util.go

@@ -13,8 +13,10 @@ import (
 	"os"
 	"os/exec"
 	"path/filepath"
+	"regexp"
 	"runtime"
 	"strconv"
+	"strings"
 
 	"github.com/awalterschulze/gographviz"
 	"github.com/emirpasic/gods/sets/treeset"
@@ -39,9 +41,9 @@ import (
 	"google.golang.org/grpc/credentials/oauth"
 	"google.golang.org/protobuf/encoding/protojson"
 	"google.golang.org/protobuf/proto"
-	"google.golang.org/protobuf/types/known/anypb"
 	"google.golang.org/protobuf/reflect/protoreflect"
 	"google.golang.org/protobuf/reflect/protoregistry"
+	"google.golang.org/protobuf/types/known/anypb"
 )
 
 // IsJson checks if str is a valid json format string
@@ -124,7 +126,7 @@ func (r *TypeResolver) FindMessageByURL(url string) (protoreflect.MessageType, e
 		fileAccessLog := envoy_extensions_accesslog_v3.FileAccessLog{}
 		return fileAccessLog.ProtoReflect().Type(), nil
 	default:
-		dummy :=  anypb.Any{}
+		dummy := anypb.Any{}
 		return dummy.ProtoReflect().Type(), nil
 	}
 }
@@ -467,3 +469,23 @@ func ParseYamlStrToMap(yamlStr string) (map[string]interface{}, error) {
 	}
 	return data, nil
 }
+
+func FilterNodeId(id string, filterMode string, filterPattern string) (bool, error) {
+	switch filterMode {
+	case "prefix":
+		if strings.HasPrefix(id, filterPattern) {
+			return true, nil
+		}
+	case "suffix":
+		if strings.HasSuffix(id, filterPattern) {
+			return true, nil
+		}
+	case "regex":
+		matched, err := regexp.MatchString(filterPattern, id)
+		if err != nil {
+			return false, err
+		}
+		return matched, nil
+	}
+	return false, nil
+}

csds-client/client/v2/client.go

@@ -64,6 +64,10 @@ func (c *ClientV2) parseNodeMatcher() error {
 		return fmt.Errorf("%s platform is not supported, list of supported platforms: gcp", c.opts.Platform)
 	}
 
+	if c.opts.FilterMode != "" && c.opts.FilterMode != "prefix" && c.opts.FilterMode != "suffix" && c.opts.FilterMode != "regex" {
+		return fmt.Errorf("%s filter mode is not supported, list of supported filter modes: prefix, suffix, regex", c.opts.FilterMode)
+	}
+
 	return nil
 }
 
@@ -230,6 +234,17 @@ func printOutResponse(response *csdspb_v2.ClientStatusResponse, opts client.Clie
 			if metadata["XDS_STREAM_TYPE"] != nil {
 				xdsType = metadata["XDS_STREAM_TYPE"].(string)
 			}
+
+			// filter node id
+			if opts.FilterPattern != "" {
+				matched, err := clientutil.FilterNodeId(id, opts.FilterMode, opts.FilterPattern)
+				if err != nil {
+					return err
+				}
+				if !matched {
+					continue
+				}
+			}
 		}
 
 		if config.GetXdsConfig() == nil {

csds-client/client/v2/client_test.go

@@ -3,7 +3,7 @@ package client
 
 import (
 	"envoy-tools/csds-client/client"
-	clientutil "envoy-tools/csds-client/client/util"
+	clientUtil "envoy-tools/csds-client/client/util"
 	"io/ioutil"
 	"path/filepath"
 	"testing"
@@ -32,7 +32,7 @@ func TestParseNodeMatcherWithFile(t *testing.T) {
 		t.Errorf("Parse NodeMatcher Error: %v", err)
 	}
 
-	if !clientutil.ShouldEqualJSON(t, string(get), want) {
+	if !clientUtil.ShouldEqualJSON(t, string(get), want) {
 		t.Errorf("NodeMatcher = \n%v\n, want: \n%v\n", string(get), want)
 	}
 }
@@ -57,7 +57,7 @@ func TestParseNodeMatcherWithString(t *testing.T) {
 	if err != nil {
 		t.Errorf("Parse NodeMatcher Error: %v", err)
 	}
-	if !clientutil.ShouldEqualJSON(t, string(get), want) {
+	if !clientUtil.ShouldEqualJSON(t, string(get), want) {
 		t.Errorf("NodeMatcher = \n%v\n, want: \n%v\n", string(get), want)
 	}
 }
@@ -82,7 +82,7 @@ func TestParseNodeMatcherWithFileAndString(t *testing.T) {
 	if err != nil {
 		t.Errorf("Parse NodeMatcher Error: %v", err)
 	}
-	if !clientutil.ShouldEqualJSON(t, string(get), want) {
+	if !clientUtil.ShouldEqualJSON(t, string(get), want) {
 		t.Errorf("NodeMatcher = \n%v\n, want: \n%v\n", string(get), want)
 	}
 }
@@ -103,12 +103,16 @@ func TestParseResponseWithoutNodeId(t *testing.T) {
 	if err = protojson.Unmarshal(responsejson, &response); err != nil {
 		t.Errorf("Read From File Failure: %v", err)
 	}
-	out := clientutil.CaptureOutput(func() {
+	out := clientUtil.CaptureOutput(func() {
 		if err := printOutResponse(&response, c.opts); err != nil {
 			t.Errorf("Print out response error: %v", err)
 		}
 	})
-	want := "Client ID                                          xDS stream type                Config Status                  \ntest_node_1                                        test_stream_type1              N/A                            \ntest_node_2                                        test_stream_type2              N/A                            \ntest_node_3                                        test_stream_type3              N/A                            \n"
+	want := `Client ID                                          xDS stream type                Config Status                  
+test_node_1                                        test_stream_type1              N/A                            
+test_node_2                                        test_stream_type2              N/A                            
+test_node_3                                        test_stream_type3              N/A                            
+`
 	if out != want {
 		t.Errorf("want\n%vout\n%v", want, out)
 	}
@@ -131,12 +135,16 @@ func TestParseResponseWithNodeId(t *testing.T) {
 	if err = protojson.Unmarshal(responsejson, &response); err != nil {
 		t.Errorf("Read From File Failure: %v", err)
 	}
-	out := clientutil.CaptureOutput(func() {
+	out := clientUtil.CaptureOutput(func() {
 		if err := printOutResponse(&response, c.opts); err != nil {
 			t.Errorf("Print out response error: %v", err)
 		}
 	})
-	want := "Client ID                                          xDS stream type                Config Status                  \ntest_nodeid                                        test_stream_type1              RDS   STALE                    \n                                                                                  CDS   STALE                    \nConfig has been saved to test_config.json\n"
+	want := `Client ID                                          xDS stream type                Config Status                  
+test_nodeid                                        test_stream_type1              RDS   STALE                    
+                                                                                  CDS   STALE                    
+Config has been saved to test_config.json
+`
 	if out != want {
 		t.Errorf("want\n%vout\n%v", want, out)
 	}
@@ -146,7 +154,7 @@ func TestParseResponseWithNodeId(t *testing.T) {
 	if err != nil {
 		t.Errorf("Write config to file failure: %v", err)
 	}
-	ok, err := clientutil.EqualJSONBytes(outputjson, responsejson)
+	ok, err := clientUtil.EqualJSONBytes(outputjson, responsejson)
 	if err != nil {
 		t.Errorf("failed to parse json")
 	}
@@ -162,11 +170,123 @@ func TestVisualization(t *testing.T) {
 	if err != nil {
 		t.Errorf("Read From File Failure: %v", err)
 	}
-	if err := clientutil.Visualize(responsejson, false); err != nil {
+	if err := clientUtil.Visualize(responsejson, false); err != nil {
 		t.Errorf("Visualization Failure: %v", err)
 	}
-	want := "digraph G {\nrankdir=LR;\n\\\"test_lds_0\\\"->\\\"test_rds_0\\\"[ arrowsize=0.3, penwidth=0.3 ];\n\\\"test_lds_0\\\"->\\\"test_rds_1\\\"[ arrowsize=0.3, penwidth=0.3 ];\n\\\"test_rds_0\\\"->\\\"test_cds_0\\\"[ arrowsize=0.3, penwidth=0.3 ];\n\\\"test_rds_0\\\"->\\\"test_cds_1\\\"[ arrowsize=0.3, penwidth=0.3 ];\n\\\"test_rds_1\\\"->\\\"test_cds_1\\\"[ arrowsize=0.3, penwidth=0.3 ];\n\\\"test_cds_0\\\" [ color=\\\"#34A853\\\", fillcolor=\\\"#34A853\\\", fontcolor=white, fontname=Roboto, label=CDS0, shape=box, style=\\\"\"filled,rounded\"\\\" ];\n\\\"test_cds_1\\\" [ color=\\\"#34A853\\\", fillcolor=\\\"#34A853\\\", fontcolor=white, fontname=Roboto, label=CDS1, shape=box, style=\\\"\"filled,rounded\"\\\" ];\n\\\"test_lds_0\\\" [ color=\\\"#4285F4\\\", fillcolor=\\\"#4285F4\\\", fontcolor=white, fontname=Roboto, label=LDS0, shape=box, style=\\\"\"filled,rounded\"\\\" ];\n\\\"test_rds_0\\\" [ color=\\\"#FBBC04\\\", fillcolor=\\\"#FBBC04\\\", fontcolor=white, fontname=Roboto, label=RDS0, shape=box, style=\\\"\"filled,rounded\"\\\" ];\n\\\"test_rds_1\\\" [ color=\\\"#FBBC04\\\", fillcolor=\\\"#FBBC04\\\", fontcolor=white, fontname=Roboto, label=RDS1, shape=box, style=\\\"\"filled,rounded\"\\\" ];\n\n}\n"
-	if err := clientutil.OpenBrowser("http://dreampuf.github.io/GraphvizOnline/#" + want); err != nil {
+	want := `digraph G {
+rankdir=LR;
+"test_lds_0"->"test_rds_0"[ arrowsize=0.3, penwidth=0.3 ];
+"test_lds_0"->"test_rds_1"[ arrowsize=0.3, penwidth=0.3 ];
+"test_rds_0"->"test_cds_0"[ arrowsize=0.3, penwidth=0.3 ];
+"test_rds_0"->"test_cds_1"[ arrowsize=0.3, penwidth=0.3 ];
+"test_rds_1"->"test_cds_1"[ arrowsize=0.3, penwidth=0.3 ];
+"test_cds_0" [ color="#34A853", fillcolor="#34A853", fontcolor=white, fontname=Roboto, label=CDS0, shape=box, style="filled,rounded" ];
+"test_cds_1" [ color="#34A853", fillcolor="#34A853", fontcolor=white, fontname=Roboto, label=CDS1, shape=box, style="filled,rounded" ];
+"test_lds_0" [ color="#4285F4", fillcolor="#4285F4", fontcolor=white, fontname=Roboto, label=LDS0, shape=box, style="filled,rounded" ];
+"test_rds_0" [ color="#FBBC04", fillcolor="#FBBC04", fontcolor=white, fontname=Roboto, label=RDS0, shape=box, style="filled,rounded" ];
+"test_rds_1" [ color="#FBBC04", fillcolor="#FBBC04", fontcolor=white, fontname=Roboto, label=RDS1, shape=box, style="filled,rounded" ];
+
+}
+`
+	if err := clientUtil.OpenBrowser("http://dreampuf.github.io/GraphvizOnline/#" + want); err != nil {
 		t.Errorf("Open want graph failure: %v", err)
 	}
 }
+
+// TestNodeIdPrefixFilter tests node_id prefix filter
+func TestNodeIdPrefixFilter(t *testing.T) {
+	c := ClientV2{
+		opts: client.ClientOptions{
+			Platform:      "gcp",
+			FilterMode:    "prefix",
+			FilterPattern: "test",
+		},
+	}
+	filename, _ := filepath.Abs("./response_for_filter.json")
+	responsejson, err := ioutil.ReadFile(filename)
+	if err != nil {
+		t.Errorf("Read From File Failure: %v", err)
+	}
+	var response csdspb_v2.ClientStatusResponse
+	if err = protojson.Unmarshal(responsejson, &response); err != nil {
+		t.Errorf("Read From File Failure: %v", err)
+	}
+	out := clientUtil.CaptureOutput(func() {
+		if err := printOutResponse(&response, c.opts); err != nil {
+			t.Errorf("Print out response error: %v", err)
+		}
+	})
+	want := `Client ID                                          xDS stream type                Config Status                  
+test_node_1                                        test_stream_type1              N/A                            
+test_node_2                                        test_stream_type2              N/A                            
+test_node_3                                        test_stream_type3              N/A                            
+`
+	if out != want {
+		t.Errorf("want\n%vout\n%v", want, out)
+	}
+}
+
+// TestNodeIdSuffixFilter tests node_id suffix filter
+func TestNodeIdSuffixFilter(t *testing.T) {
+	c := ClientV2{
+		opts: client.ClientOptions{
+			Platform:      "gcp",
+			FilterMode:    "suffix",
+			FilterPattern: "3",
+		},
+	}
+	filename, _ := filepath.Abs("./response_for_filter.json")
+	responsejson, err := ioutil.ReadFile(filename)
+	if err != nil {
+		t.Errorf("Read From File Failure: %v", err)
+	}
+	var response csdspb_v2.ClientStatusResponse
+	if err = protojson.Unmarshal(responsejson, &response); err != nil {
+		t.Errorf("Read From File Failure: %v", err)
+	}
+	out := clientUtil.CaptureOutput(func() {
+		if err := printOutResponse(&response, c.opts); err != nil {
+			t.Errorf("Print out response error: %v", err)
+		}
+	})
+	want := `Client ID                                          xDS stream type                Config Status                  
+test_node_3                                        test_stream_type3              N/A                            
+node_3                                             test_stream_type4              N/A                            
+`
+	if out != want {
+		t.Errorf("want\n%vout\n%v", want, out)
+	}
+}
+
+// TestNodeIdRegexFilter tests node_id regex filter
+func TestNodeIdRegexFilter(t *testing.T) {
+	c := ClientV2{
+		opts: client.ClientOptions{
+			Platform:      "gcp",
+			FilterMode:    "regex",
+			FilterPattern: "test.*",
+		},
+	}
+	filename, _ := filepath.Abs("./response_for_filter.json")
+	responsejson, err := ioutil.ReadFile(filename)
+	if err != nil {
+		t.Errorf("Read From File Failure: %v", err)
+	}
+	var response csdspb_v2.ClientStatusResponse
+	if err = protojson.Unmarshal(responsejson, &response); err != nil {
+		t.Errorf("Read From File Failure: %v", err)
+	}
+	out := clientUtil.CaptureOutput(func() {
+		if err := printOutResponse(&response, c.opts); err != nil {
+			t.Errorf("Print out response error: %v", err)
+		}
+	})
+	want := `Client ID                                          xDS stream type                Config Status                  
+test_node_1                                        test_stream_type1              N/A                            
+test_node_2                                        test_stream_type2              N/A                            
+test_node_3                                        test_stream_type3              N/A                            
+`
+	if out != want {
+		t.Errorf("want\n%vout\n%v", want, out)
+	}
+}

csds-client/client/v2/response_for_filter.json

@@ -0,0 +1,36 @@
+{
+  "config": [
+    {
+      "node": {
+        "id": "test_node_1",
+        "metadata": {
+          "XDS_STREAM_TYPE": "test_stream_type1"
+        }
+      }
+    },
+    {
+      "node": {
+        "id": "test_node_2",
+        "metadata": {
+          "XDS_STREAM_TYPE": "test_stream_type2"
+        }
+      }
+    },
+    {
+      "node": {
+        "id": "test_node_3",
+        "metadata": {
+          "XDS_STREAM_TYPE": "test_stream_type3"
+        }
+      }
+    },
+    {
+      "node": {
+        "id": "node_3",
+        "metadata": {
+          "XDS_STREAM_TYPE": "test_stream_type4"
+        }
+      }
+    }
+  ]
+}

csds-client/client/v3/client.go

@@ -64,6 +64,10 @@ func (c *ClientV3) parseNodeMatcher() error {
 		return fmt.Errorf("%s platform is not supported, list of supported platforms: gcp", c.opts.Platform)
 	}
 
+	if c.opts.FilterMode != "" && c.opts.FilterMode != "prefix" && c.opts.FilterMode != "suffix" && c.opts.FilterMode != "regex" {
+		return fmt.Errorf("%s filter mode is not supported, list of supported filter modes: prefix, suffix, regex", c.opts.FilterMode)
+	}
+
 	return nil
 }
 
@@ -232,6 +236,17 @@ func printOutResponse(response *csdspb_v3.ClientStatusResponse, opts client.Clie
 			if metadata["XDS_STREAM_TYPE"] != nil {
 				xdsType = metadata["XDS_STREAM_TYPE"].(string)
 			}
+
+			// filter node id
+			if opts.FilterPattern != "" {
+				matched, err := clientutil.FilterNodeId(id, opts.FilterMode, opts.FilterPattern)
+				if err != nil {
+					return err
+				}
+				if !matched {
+					continue
+				}
+			}
 		}
 
 		if config.GetXdsConfig() == nil {