Add network service to MonitorScopeSelector (#178)

Allow MonitorScopeSelector to filter connections based
on network service as well.

Signed-off-by: Lugossy Zoltan <[email protected]>

Author: zolug

pkg/api/networkservice/connection.pb.go

@@ -1,5 +1,6 @@
 // Copyright 2018 Red Hat, Inc.
 // Copyright (c) 2018 Cisco and/or its affiliates.
+// Copyright (c) 2024 Nordix Foundation.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -91,6 +92,7 @@ message ConnectionEvent {
 
 message MonitorScopeSelector {
   repeated PathSegment path_segments = 1;
+  repeated string network_services = 2;
 }
 
 service MonitorConnection {

pkg/api/networkservice/connection.proto

@@ -4,6 +4,8 @@
 //
 // Copyright (c) 2023-2024 Cisco and/or its affiliates.
 //
+// Copyright (c) 2024 Nordix Foundation.
+//
 // SPDX-License-Identifier: Apache-2.0
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -37,12 +39,38 @@ func (x *Connection) Clone() *Connection {
 	return proto.Clone(x).(*Connection)
 }
 
+// Iterates through the selector.NetworkServices array looking for a network service
+// that matches the Connection.NetworkService. Treats an empty selector.NetworkService
+// array as a wildcard - Returns true on match
+func (x *Connection) matchesNetworkService(networkServices []string) bool {
+	if len(networkServices) == 0 {
+		return true
+	}
+
+	for _, v := range networkServices {
+		if v == x.GetNetworkService() {
+			// matched network service
+			return true
+		}
+	}
+
+	return false
+}
+
 // MatchesMonitorScopeSelector - Returns true of the connection matches the selector
 func (x *Connection) MatchesMonitorScopeSelector(selector *MonitorScopeSelector) bool {
 	if x == nil {
 		return false
 	}
 	// Note: Empty selector always matches a non-nil Connection
+	if len(selector.GetPathSegments()) == 0 && len(selector.GetNetworkServices()) == 0 {
+		return true
+	}
+	// Compare network service names first
+	if !x.matchesNetworkService(selector.GetNetworkServices()) {
+		return false
+	}
+	// Empty PathSegments in selector, treat as wildcard
 	if len(selector.GetPathSegments()) == 0 {
 		return true
 	}

pkg/api/networkservice/connection_helpers.go

@@ -1,5 +1,7 @@
 // Copyright (c) 2023 Cisco and/or its affiliates.
 //
+// Copyright (c) 2024 Nordix Foundation.
+//
 // SPDX-License-Identifier: Apache-2.0
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -99,3 +101,161 @@ func TestMonitorScopeSelector(t *testing.T) {
 		})
 	}
 }
+
+// nolint: funlen
+func TestNetworkServiceMonitorScopeSelector(t *testing.T) {
+	cases := []struct {
+		testname string
+		conn     *networkservice.Connection
+		selector *networkservice.MonitorScopeSelector
+		matches  bool
+	}{
+		{
+			testname: "EmptySelector",
+			conn: &networkservice.Connection{
+				Path: &networkservice.Path{
+					PathSegments: []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				},
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{},
+			matches:  true,
+		},
+		{
+			testname: "IdenticalPathsAndNetworkService",
+			conn: &networkservice.Connection{
+				Path: &networkservice.Path{
+					PathSegments: []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				},
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{
+				PathSegments:    []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				NetworkServices: []string{"ns1"},
+			},
+			matches: true,
+		},
+		{
+			testname: "IdenticalPathsAndDifferentNetworkService",
+			conn: &networkservice.Connection{
+				Path: &networkservice.Path{
+					PathSegments: []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				},
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{
+				PathSegments:    []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				NetworkServices: []string{"ns2"},
+			},
+			matches: false,
+		},
+		{
+			testname: "IdenticalPathsAndMatchingNetworkServiceList",
+			conn: &networkservice.Connection{
+				Path: &networkservice.Path{
+					PathSegments: []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				},
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{
+				PathSegments:    []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				NetworkServices: []string{"ns2", "ns1", "ns3"},
+			},
+			matches: true,
+		},
+		{
+			testname: "IdenticalPathsAndNonMatchingNetworkServiceList",
+			conn: &networkservice.Connection{
+				Path: &networkservice.Path{
+					PathSegments: []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				},
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{
+				PathSegments:    []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				NetworkServices: []string{"ns2", "ns3", "ns0"},
+			},
+			matches: false,
+		},
+		{
+			testname: "IdenticalNetworkService",
+			conn: &networkservice.Connection{
+				Path: &networkservice.Path{
+					PathSegments: []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				},
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{
+				NetworkServices: []string{"ns1"},
+			},
+			matches: true,
+		},
+		{
+			testname: "IdenticalNetworkServiceEmptyConnectionPath",
+			conn: &networkservice.Connection{
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{
+				NetworkServices: []string{"ns1"},
+			},
+			matches: true,
+		},
+		{
+			testname: "DifferentNetworkService",
+			conn: &networkservice.Connection{
+				Path: &networkservice.Path{
+					PathSegments: []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				},
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{
+				NetworkServices: []string{"ns2"},
+			},
+			matches: false,
+		},
+		{
+			testname: "DifferentNetworkServiceEmptyConnectionPath",
+			conn: &networkservice.Connection{
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{
+				NetworkServices: []string{"ns2"},
+			},
+			matches: false,
+		},
+		{
+			testname: "MatchingNetworkServiceList",
+			conn: &networkservice.Connection{
+				Path: &networkservice.Path{
+					PathSegments: []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				},
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{
+				NetworkServices: []string{"ns2", "ns1", "ns3"},
+			},
+			matches: true,
+		},
+		{
+			testname: "NonMatchingNetworkServiceList",
+			conn: &networkservice.Connection{
+				Path: &networkservice.Path{
+					PathSegments: []*networkservice.PathSegment{{Name: "s1", Id: "id1", Token: "t1"}, {Name: "s2", Id: "id2", Token: "t2"}},
+				},
+				NetworkService: "ns1",
+			},
+			selector: &networkservice.MonitorScopeSelector{
+				NetworkServices: []string{"ns2", "ns3", "ns0"},
+			},
+			matches: false,
+		},
+	}
+
+	for _, testCase := range cases {
+		c := testCase
+		t.Run(c.testname, func(t *testing.T) {
+
+			require.Equal(t, c.conn.MatchesMonitorScopeSelector(c.selector), c.matches)
+		})
+	}
+}