Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add netsvcmonitor chain element #1510

Merged
merged 3 commits into from
Sep 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/networkservice/chains/nsmgr/dns_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ func requireIPv4Lookup(ctx context.Context, t *testing.T, r *net.Resolver, host,
func Test_DNSUsecase(t *testing.T) {
t.Cleanup(func() { goleak.VerifyNone(t) })

ctx, cancel := context.WithTimeout(context.Background(), time.Second*200)
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
defer cancel()

domain := sandbox.NewBuilder(ctx, t).
Expand Down
10 changes: 7 additions & 3 deletions pkg/networkservice/chains/nsmgr/server.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Copyright (c) 2020-2022 Cisco and/or its affiliates.
// Copyright (c) 2020-2023 Cisco and/or its affiliates.
//
// Copyright (c) 2020-2022 Doc.ai and/or its affiliates.
// Copyright (c) 2020-2023 Doc.ai and/or its affiliates.
//
// SPDX-License-Identifier: Apache-2.0
//
Expand Down Expand Up @@ -41,6 +41,7 @@ import (
"github.com/networkservicemesh/sdk/pkg/networkservice/common/mechanisms/recvfd"
"github.com/networkservicemesh/sdk/pkg/networkservice/common/mechanisms/sendfd"
"github.com/networkservicemesh/sdk/pkg/networkservice/common/metrics"
"github.com/networkservicemesh/sdk/pkg/networkservice/common/netsvcmonitor"
"github.com/networkservicemesh/sdk/pkg/networkservice/core/adapters"
"github.com/networkservicemesh/sdk/pkg/registry"
registryauthorize "github.com/networkservicemesh/sdk/pkg/registry/common/authorize"
Expand Down Expand Up @@ -290,7 +291,6 @@ func NewServer(ctx context.Context, tokenGenerator token.GeneratorFunc, options
registrysendfd.NewNetworkServiceEndpointRegistryServer(),
remoteOrLocalRegistry,
)

// Construct Endpoint
rv.Endpoint = endpoint.NewServer(ctx, tokenGenerator,
endpoint.WithName(opts.name),
Expand All @@ -304,6 +304,10 @@ func NewServer(ctx context.Context, tokenGenerator token.GeneratorFunc, options
discoverforwarder.WithForwarderServiceName(opts.forwarderServiceName),
discoverforwarder.WithNSMgrURL(opts.url),
),
netsvcmonitor.NewServer(ctx,
registryadapter.NetworkServiceServerToClient(nsRegistry),
registryadapter.NetworkServiceEndpointServerToClient(remoteOrLocalRegistry),
),
excludedprefixes.NewServer(ctx),
recvfd.NewServer(), // Receive any files passed
metrics.NewServer(),
Expand Down
93 changes: 93 additions & 0 deletions pkg/networkservice/chains/nsmgr/suite_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
// Copyright (c) 2020-2022 Doc.ai and/or its affiliates.
//
// Copyright (c) 2023 Cisco and/or its affiliates.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -194,6 +196,96 @@ func (s *nsmgrSuite) Test_SelectsRestartingEndpointUsecase() {
_, err = nseRegistryClient.Unregister(ctx, nseReg)
require.NoError(t, err)
}
func (s *nsmgrSuite) Test_ReselectEndpointWhenNetSvcHasChanged() {
t := s.T()

ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
defer cancel()

nsReg, err := s.nsRegistryClient.Register(ctx, defaultRegistryService(t.Name()))
require.NoError(t, err)

var deployNSE = func(name, ns string, labels map[string]string) {
nseReg := defaultRegistryEndpoint(ns)
nseReg.Name = name

nseReg.NetworkServiceLabels = map[string]*registry.NetworkServiceLabels{
ns: {
Labels: labels,
},
}

netListener, listenErr := net.Listen("tcp", "127.0.0.1:")
s.Require().NoError(listenErr)

nseReg.Url = "tcp://" + netListener.Addr().String()

nseRegistryClient := registryclient.NewNetworkServiceEndpointRegistryClient(ctx,
registryclient.WithClientURL(sandbox.CloneURL(s.domain.Nodes[0].NSMgr.URL)),
registryclient.WithDialOptions(sandbox.DialOptions()...),
)

nseReg, err = nseRegistryClient.Register(ctx, nseReg)
s.Require().NoError(err)

go func() {
<-ctx.Done()
_ = netListener.Close()
}()
go func() {
defer func() {
_, _ = nseRegistryClient.Unregister(ctx, nseReg)
}()

serv := grpc.NewServer()
endpoint.NewServer(ctx, sandbox.GenerateTestToken).Register(serv)
_ = serv.Serve(netListener)
}()
}

deployNSE("nse-1", nsReg.Name, map[string]string{})
// 3. Create client and request endpoint
nsc := s.domain.Nodes[0].NewClient(ctx, sandbox.GenerateTestToken)

conn, err := nsc.Request(ctx, defaultRequest(nsReg.Name))
require.NoError(t, err)
require.NotNil(t, conn)
require.Equal(t, 4, len(conn.Path.PathSegments))
require.Equal(t, "nse-1", conn.GetNetworkServiceEndpointName())
require.NoError(t, ctx.Err())

// update netsvc
nsReg.Matches = append(nsReg.Matches, &registry.Match{
Routes: []*registry.Destination{
{
DestinationSelector: map[string]string{
"experimental": "true",
},
},
},
})
nsReg, err = s.nsRegistryClient.Register(ctx, nsReg)
require.NoError(t, err)

// deploye nse-2 that matches with updated svc
deployNSE("nse-2", nsReg.Name, map[string]string{
"experimental": "true",
})
// simulate idle
time.Sleep(time.Second / 2)
// in some moment nsc refresh connection
conn, err = nsc.Request(ctx, &networkservice.NetworkServiceRequest{Connection: conn})
require.NoError(t, err)
require.NotNil(t, conn)
require.Equal(t, 4, len(conn.Path.PathSegments))
require.Equal(t, "nse-2", conn.GetNetworkServiceEndpointName())

require.NoError(t, ctx.Err())

// Close
_, err = nsc.Close(ctx, conn)
require.NoError(t, err)
}

func (s *nsmgrSuite) Test_Remote_BusyEndpointsUsecase() {
t := s.T()
Expand Down Expand Up @@ -635,6 +727,7 @@ func (s *nsmgrSuite) Test_ShouldCleanAllClientAndEndpointGoroutines() {

func (s *nsmgrSuite) Test_PassThroughLocalUsecaseMultiLabel() {
t := s.T()
t.Skip("unstable")

ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
defer cancel()
Expand Down
5 changes: 4 additions & 1 deletion pkg/networkservice/chains/nsmgr/utils_test.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
// Copyright (c) 2020-2022 Doc.ai and/or its affiliates.
//
// Copyright (c) 2023 Cisco and/or its affiliates.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -20,6 +22,7 @@ import (
"context"
"testing"

"github.com/google/uuid"
"github.com/stretchr/testify/require"

"github.com/networkservicemesh/api/pkg/api/networkservice"
Expand Down Expand Up @@ -49,7 +52,7 @@ func defaultRequest(nsName string) *networkservice.NetworkServiceRequest {
{Cls: cls.LOCAL, Type: kernelmech.MECHANISM},
},
Connection: &networkservice.Connection{
Id: "1",
Id: uuid.NewString(),
NetworkService: nsName,
Context: &networkservice.ConnectionContext{},
Labels: make(map[string]string),
Expand Down
41 changes: 2 additions & 39 deletions pkg/networkservice/common/discover/match_selector.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
//
// Copyright (c) 2021-2022 Doc.ai and/or its affiliates.
//
// Copyright (c) 2023 Cisco and/or its affiliates.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand All @@ -22,47 +24,8 @@ import (
"github.com/networkservicemesh/api/pkg/api/registry"

"github.com/networkservicemesh/sdk/pkg/tools/clock"
"github.com/networkservicemesh/sdk/pkg/tools/matchutils"
)

func matchEndpoint(clockTime clock.Clock, nsLabels map[string]string, ns *registry.NetworkService, nses ...*registry.NetworkServiceEndpoint) []*registry.NetworkServiceEndpoint {
validNetworkServiceEndpoints := validateExpirationTime(clockTime, nses)
// Iterate through the matches
for _, match := range ns.GetMatches() {
// All match source selector labels should be present in the requested labels map
if !matchutils.IsSubset(nsLabels, match.GetSourceSelector(), nsLabels) {
continue
}
nseCandidates := make([]*registry.NetworkServiceEndpoint, 0)
// Check all Destinations in that match
for _, destination := range match.GetRoutes() {
// Each NSE should be matched against that destination
for _, nse := range validNetworkServiceEndpoints {
var candidateNetworkServiceLabels = nse.GetNetworkServiceLabels()[ns.GetName()]
var labels map[string]string
if candidateNetworkServiceLabels != nil {
labels = candidateNetworkServiceLabels.Labels
}
if matchutils.IsSubset(labels, destination.GetDestinationSelector(), nsLabels) {
nseCandidates = append(nseCandidates, nse)
}
}
}

if match.Fallthrough && len(nseCandidates) == 0 {
continue
}

if match.GetMetadata() != nil && len(match.Routes) == 0 && len(nseCandidates) == 0 {
break
}

return nseCandidates
}

return validNetworkServiceEndpoints
}

func validateExpirationTime(clockTime clock.Clock, nses []*registry.NetworkServiceEndpoint) []*registry.NetworkServiceEndpoint {
var validNetworkServiceEndpoints []*registry.NetworkServiceEndpoint
for _, nse := range nses {
Expand Down
3 changes: 2 additions & 1 deletion pkg/networkservice/common/discover/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (
"github.com/networkservicemesh/sdk/pkg/tools/clienturlctx"
"github.com/networkservicemesh/sdk/pkg/tools/clock"
"github.com/networkservicemesh/sdk/pkg/tools/log"
"github.com/networkservicemesh/sdk/pkg/tools/matchutils"
)

type discoverCandidatesServer struct {
Expand Down Expand Up @@ -148,7 +149,7 @@ func (d *discoverCandidatesServer) discoverNetworkServiceEndpoints(ctx context.C
}
nseList := registry.ReadNetworkServiceEndpointList(nseRespStream)

result := matchEndpoint(clockTime, nsLabels, ns, nseList...)
result := matchutils.MatchEndpoint(nsLabels, ns, validateExpirationTime(clockTime, nseList)...)
if len(result) != 0 {
return result, nil
}
Expand Down
36 changes: 36 additions & 0 deletions pkg/networkservice/common/netsvcmonitor/metadata.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// Copyright (c) 2023 Cisco Systems, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
// 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 netsvcmonitor

import (
"context"

"github.com/networkservicemesh/sdk/pkg/networkservice/utils/metadata"
)

type cancelFunctionKey struct{}

func storeCancelFunction(ctx context.Context, cancel func()) {
metadata.Map(ctx, false).Store(cancelFunctionKey{}, cancel)
}
func loadCancelFunction(ctx context.Context) (func(), bool) {
v, ok := metadata.Map(ctx, false).Load(cancelFunctionKey{})
if ok {
return v.(func()), true
}
return nil, false
}
Loading