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.

Sign up for GitHub

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 support for externalDNS in sdk #1473

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat: add support for externalDNS in sdk #1473

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c60f7c
add support for external dns in sdk
denis-tingaikin Jun 25, 2023
9586b9f
fix linter issues
denis-tingaikin Jun 26, 2023
b15c8c9
apply review comments
denis-tingaikin Jun 27, 2023
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
1 change: 0 additions & 1 deletion .golangci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,6 @@ linters-settings:
- unnamedResult
- unnecessaryBlock
- underef
- unlambda
- unslice
- valSwap
- weakCond
Expand Down
15 changes: 13 additions & 2 deletions pkg/registry/chains/proxydns/server.go
View file
Open in desktop
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 Systems, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -43,6 +45,7 @@ type serverOptions struct {
authorizeNSERegistryServer registryapi.NetworkServiceEndpointRegistryServer
authorizeNSRegistryClient registryapi.NetworkServiceRegistryClient
authorizeNSERegistryClient registryapi.NetworkServiceEndpointRegistryClient
dnsresolveOptions []dnsresolve.Option
dialOptions []grpc.DialOption
}

Expand Down Expand Up @@ -89,6 +92,13 @@ func WithAuthorizeNSERegistryClient(authorizeNSERegistryClient registryapi.Netwo
}
}

// WithDNSResolveOptions overrides default dns resolve options
func WithDNSResolveOptions(opts ...dnsresolve.Option) Option {
return func(o *serverOptions) {
o.dnsresolveOptions = opts
}
}

// WithDialOptions sets grpc.DialOptions for the server
func WithDialOptions(dialOptions ...grpc.DialOption) Option {
return func(o *serverOptions) {
Expand All @@ -103,6 +113,7 @@ func NewServer(ctx context.Context, tokenGenerator token.GeneratorFunc, dnsResol
authorizeNSERegistryServer: registryauthorize.NewNetworkServiceEndpointRegistryServer(registryauthorize.Any()),
authorizeNSRegistryClient: registryauthorize.NewNetworkServiceRegistryClient(registryauthorize.Any()),
authorizeNSERegistryClient: registryauthorize.NewNetworkServiceEndpointRegistryClient(registryauthorize.Any()),
dnsresolveOptions: []dnsresolve.Option{dnsresolve.WithResolver(dnsResolver)},
}
for _, opt := range options {
opt(opts)
Expand All @@ -113,7 +124,7 @@ func NewServer(ctx context.Context, tokenGenerator token.GeneratorFunc, dnsResol
updatepath.NewNetworkServiceEndpointRegistryServer(tokenGenerator),
opts.authorizeNSERegistryServer,
begin.NewNetworkServiceEndpointRegistryServer(),
dnsresolve.NewNetworkServiceEndpointRegistryServer(dnsresolve.WithResolver(dnsResolver)),
dnsresolve.NewNetworkServiceEndpointRegistryServer(opts.dnsresolveOptions...),
connect.NewNetworkServiceEndpointRegistryServer(
chain.NewNetworkServiceEndpointRegistryClient(
clientconn.NewNetworkServiceEndpointRegistryClient(),
Expand All @@ -130,7 +141,7 @@ func NewServer(ctx context.Context, tokenGenerator token.GeneratorFunc, dnsResol
updatepath.NewNetworkServiceRegistryServer(tokenGenerator),
begin.NewNetworkServiceRegistryServer(),
opts.authorizeNSRegistryServer,
dnsresolve.NewNetworkServiceRegistryServer(dnsresolve.WithResolver(dnsResolver)),
dnsresolve.NewNetworkServiceRegistryServer(opts.dnsresolveOptions...),
connect.NewNetworkServiceRegistryServer(
chain.NewNetworkServiceRegistryClient(
clientconn.NewNetworkServiceRegistryClient(),
Expand Down
87 changes: 86 additions & 1 deletion pkg/registry/chains/proxydns/server_ns_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Copyright (c) 2020-2022 Doc.ai and/or its affiliates.
//
// Copyright (c) 2022 Cisco Systems, Inc.
// Copyright (c) 2022-2023 Cisco Systems, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
Expand Down Expand Up @@ -30,12 +30,97 @@ import (
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"

"github.com/networkservicemesh/sdk/pkg/registry"
registryclient "github.com/networkservicemesh/sdk/pkg/registry/chains/client"
"github.com/networkservicemesh/sdk/pkg/registry/chains/proxydns"
"github.com/networkservicemesh/sdk/pkg/registry/common/dnsresolve"

"github.com/networkservicemesh/sdk/pkg/tools/grpcutils"
"github.com/networkservicemesh/sdk/pkg/tools/sandbox"
"github.com/networkservicemesh/sdk/pkg/tools/token"
)

func TestInterdomainNetworkServiceRegistryWithDifferentDNSScheme(t *testing.T) {
t.Cleanup(func() { goleak.VerifyNone(t) })

ctx, cancel := context.WithTimeout(context.Background(), time.Hour*10)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we use 5s timeout?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks fixed

defer cancel()

dnsServer := sandbox.NewFakeResolver()

domain1 := sandbox.NewBuilder(ctx, t).
SetNodesCount(0).
SetDNSResolver(dnsServer).
SetRegistryProxySupplier(func(ctx context.Context, tokenGenerator token.GeneratorFunc, dnsResolver dnsresolve.Resolver, options ...proxydns.Option) registry.Registry {
return proxydns.NewServer(
ctx,
tokenGenerator,
dnsResolver,
append(options,
proxydns.WithDNSResolveOptions(
dnsresolve.WithNSMgrProxyService("nsmgr-proxy2"),
dnsresolve.WithRegistryService("registry2"),
dnsresolve.WithResolver(dnsResolver),
))...,
)
}).
Build()

dnsServer.DeleteSRVEntry(dnsresolve.DefaultNsmgrProxyService, domain1.Name)
dnsServer.DeleteSRVEntry(dnsresolve.DefaultRegistryService, domain1.Name)

require.NoError(t, dnsServer.AddSRVEntry("example.com", "nsmgr-proxy1", domain1.NSMgrProxy.URL))
require.NoError(t, dnsServer.AddSRVEntry("example.com", "registry1", domain1.Registry.URL))

domain2 := sandbox.NewBuilder(ctx, t).
SetNodesCount(0).
SetDNSResolver(dnsServer).
SetRegistryProxySupplier(func(ctx context.Context, tokenGenerator token.GeneratorFunc, dnsResolver dnsresolve.Resolver, options ...proxydns.Option) registry.Registry {
return proxydns.NewServer(
ctx,
tokenGenerator,
dnsResolver,
append(options,
proxydns.WithDNSResolveOptions(
dnsresolve.WithNSMgrProxyService("nsmgr-proxy1"),
dnsresolve.WithRegistryService("registry1"),
dnsresolve.WithResolver(dnsResolver),
))...,
)
}).
Build()

dnsServer.DeleteSRVEntry(dnsresolve.DefaultNsmgrProxyService, domain2.Name)
dnsServer.DeleteSRVEntry(dnsresolve.DefaultRegistryService, domain2.Name)

require.NoError(t, dnsServer.AddSRVEntry("example.com", "nsmgr-proxy2", domain2.NSMgrProxy.URL))
require.NoError(t, dnsServer.AddSRVEntry("example.com", "registry2", domain2.Registry.URL))

client1 := registryclient.NewNetworkServiceRegistryClient(ctx,
registryclient.WithDialOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),
registryclient.WithClientURL(domain1.Registry.URL))

client2 := registryclient.NewNetworkServiceRegistryClient(ctx,
registryclient.WithDialOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),
registryclient.WithClientURL(domain2.Registry.URL))

_, err := client2.Register(context.Background(), &registryapi.NetworkService{Name: "ns-1"})
require.NoError(t, err)

stream, err := client1.Find(ctx, &registryapi.NetworkServiceQuery{
NetworkService: &registryapi.NetworkService{
Name: "ns-1@" + "example.com",
},
})

require.Nil(t, err)

list := registryapi.ReadNetworkServiceList(stream)

require.Len(t, list, 1)
require.Equal(t, "ns-1@"+"example.com", list[0].Name)
}

/*
TestInterdomainNetworkServiceEndpointRegistry covers the next scenario:
1. local registry from domain2 has entry "ns-1"
Expand Down
101 changes: 101 additions & 0 deletions pkg/registry/chains/proxydns/server_nse_test.go
View file
Open in desktop
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 Systems, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -30,11 +32,110 @@ import (

registryapi "github.com/networkservicemesh/api/pkg/api/registry"

"github.com/networkservicemesh/sdk/pkg/registry"
registryclient "github.com/networkservicemesh/sdk/pkg/registry/chains/client"
"github.com/networkservicemesh/sdk/pkg/registry/chains/proxydns"
"github.com/networkservicemesh/sdk/pkg/registry/common/dnsresolve"
"github.com/networkservicemesh/sdk/pkg/tools/grpcutils"
"github.com/networkservicemesh/sdk/pkg/tools/sandbox"
"github.com/networkservicemesh/sdk/pkg/tools/token"
)

func TestInterdomainNetworkServiceEndpointRegistryWithDifferentDNSScheme(t *testing.T) {
t.Cleanup(func() { goleak.VerifyNone(t) })

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

dnsServer := sandbox.NewFakeResolver()

domain1 := sandbox.NewBuilder(ctx, t).
SetNodesCount(0).
SetDNSResolver(dnsServer).
SetRegistryProxySupplier(func(ctx context.Context, tokenGenerator token.GeneratorFunc, dnsResolver dnsresolve.Resolver, options ...proxydns.Option) registry.Registry {
return proxydns.NewServer(
ctx,
tokenGenerator,
dnsResolver,
append(options,
proxydns.WithDNSResolveOptions(
dnsresolve.WithNSMgrProxyService("nsmgr-proxy2"),
dnsresolve.WithRegistryService("registry2"),
dnsresolve.WithResolver(dnsResolver),
))...,
)
}).
Build()

dnsServer.DeleteSRVEntry(dnsresolve.DefaultNsmgrProxyService, domain1.Name)
dnsServer.DeleteSRVEntry(dnsresolve.DefaultRegistryService, domain1.Name)

require.NoError(t, dnsServer.AddSRVEntry("example.com", "nsmgr-proxy1", domain1.NSMgrProxy.URL))
require.NoError(t, dnsServer.AddSRVEntry("example.com", "registry1", domain1.Registry.URL))

domain2 := sandbox.NewBuilder(ctx, t).
SetNodesCount(0).
SetDNSResolver(dnsServer).
SetRegistryProxySupplier(func(ctx context.Context, tokenGenerator token.GeneratorFunc, dnsResolver dnsresolve.Resolver, options ...proxydns.Option) registry.Registry {
return proxydns.NewServer(
ctx,
tokenGenerator,
dnsResolver,
append(options,
proxydns.WithDNSResolveOptions(
dnsresolve.WithNSMgrProxyService("nsmgr-proxy1"),
dnsresolve.WithRegistryService("registry1"),
dnsresolve.WithResolver(dnsResolver),
))...,
)
}).
Build()

dnsServer.DeleteSRVEntry(dnsresolve.DefaultNsmgrProxyService, domain2.Name)
dnsServer.DeleteSRVEntry(dnsresolve.DefaultRegistryService, domain2.Name)

require.NoError(t, dnsServer.AddSRVEntry("example.com", "nsmgr-proxy2", domain2.NSMgrProxy.URL))
require.NoError(t, dnsServer.AddSRVEntry("example.com", "registry2", domain2.Registry.URL))

expirationTime := timestamppb.New(time.Now().Add(time.Hour))

registryClient := registryclient.NewNetworkServiceEndpointRegistryClient(ctx,
registryclient.WithDialOptions(grpc.WithTransportCredentials(insecure.NewCredentials())),
registryclient.WithClientURL(domain2.Registry.URL))

reg, err := registryClient.Register(
context.Background(),
&registryapi.NetworkServiceEndpoint{
Name: "nse-1",
Url: "nsmgr-url",
ExpirationTime: expirationTime,
},
)
require.Nil(t, err)

cc, err := grpc.DialContext(ctx, grpcutils.URLToTarget(domain1.Registry.URL), grpc.WithBlock(), grpc.WithTransportCredentials(insecure.NewCredentials()))
require.Nil(t, err)

defer func() {
_ = cc.Close()
}()

client := registryapi.NewNetworkServiceEndpointRegistryClient(cc)

stream, err := client.Find(ctx, &registryapi.NetworkServiceEndpointQuery{
NetworkServiceEndpoint: &registryapi.NetworkServiceEndpoint{
Name: reg.Name + "@" + "example.com",
},
})

require.Nil(t, err)

list := registryapi.ReadNetworkServiceEndpointList(stream)

require.Len(t, list, 1)
require.Equal(t, reg.Name+"@"+"example.com", list[0].Name)
}

/*
TestInterdomainNetworkServiceEndpointRegistry covers the next scenario:
1. local registry from domain2 has entry "nse-1"
Expand Down
6 changes: 4 additions & 2 deletions pkg/registry/common/dnsresolve/ns_server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
// Copyright (c) 2021-2022 Doc.ai and/or its affiliates.
//
// Copyright (c) 2023 Cisco Systems, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -59,7 +61,7 @@ func TestDNSResolve_CorrectUsecase(t *testing.T) {
u, err := url.Parse("tcp://127.0.0.1:80")
require.NoError(t, err)

require.NoError(t, sandbox.AddSRVEntry(resolver, "domain1", srv, u))
require.NoError(t, resolver.AddSRVEntry("domain1", srv, u))

s := dnsresolve.NewNetworkServiceRegistryServer(
dnsresolve.WithRegistryService(srv),
Expand All @@ -86,7 +88,7 @@ func TestDNSResolve_LoopUsecase(t *testing.T) {
u, err := url.Parse("tcp://127.0.0.1:80")
require.NoError(t, err)

require.NoError(t, sandbox.AddSRVEntry(resolver, "domain1", srv, u))
require.NoError(t, resolver.AddSRVEntry("domain1", srv, u))

s := dnsresolve.NewNetworkServiceRegistryServer(
dnsresolve.WithRegistryService(srv),
Expand Down
8 changes: 5 additions & 3 deletions pkg/registry/common/dnsresolve/nse_server_test.go
View file
Open in desktop
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 Systems, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -74,7 +76,7 @@ func assertDNSResolves(t *testing.T, registryURL string) {
u, err := url.Parse(registryURL)
require.NoError(t, err)

require.NoError(t, sandbox.AddSRVEntry(resolver, "domain1", srv, u))
require.NoError(t, resolver.AddSRVEntry("domain1", srv, u))

s := dnsresolve.NewNetworkServiceEndpointRegistryServer(
dnsresolve.WithRegistryService(srv),
Expand Down Expand Up @@ -133,12 +135,12 @@ func Test_DNSResolve_LookupNsmgrProxy(t *testing.T) {
regURL, err := url.Parse("tcp://127.0.0.1:80")
require.NoError(t, err)

require.NoError(t, sandbox.AddSRVEntry(resolver, domain, regSrv, regURL))
require.NoError(t, resolver.AddSRVEntry(domain, regSrv, regURL))

nsmgrProxyURL, err := url.Parse("tcp://127.0.0.1:81")
require.NoError(t, err)

require.NoError(t, sandbox.AddSRVEntry(resolver, domain, nsmgrProxySrv, nsmgrProxyURL))
require.NoError(t, resolver.AddSRVEntry(domain, nsmgrProxySrv, nsmgrProxyURL))

s := dnsresolve.NewNetworkServiceEndpointRegistryServer(
dnsresolve.WithRegistryService(regSrv),
Expand Down
10 changes: 6 additions & 4 deletions pkg/tools/sandbox/builder.go
View file
Open in desktop
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 Systems, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
Expand Down Expand Up @@ -54,7 +56,7 @@ type Builder struct {
setupNode SetupNodeFunc

name string
dnsResolver dnsresolve.Resolver
dnsResolver TestingResolver
generateTokenFunc token.GeneratorFunc
registryDefaultExpiration time.Duration

Expand Down Expand Up @@ -140,7 +142,7 @@ func (b *Builder) SetDNSDomainName(name string) *Builder {
}

// SetDNSResolver sets DNS resolver for proxy registries
func (b *Builder) SetDNSResolver(d dnsresolve.Resolver) *Builder {
func (b *Builder) SetDNSResolver(d TestingResolver) *Builder {
b.dnsResolver = d
return b
}
Expand Down Expand Up @@ -330,9 +332,9 @@ func (b *Builder) newNode(nodeNum int) *Node {

func (b *Builder) buildDNSServer() {
if b.domain.Registry != nil {
require.NoError(b.t, AddSRVEntry(b.dnsResolver, b.name, dnsresolve.DefaultRegistryService, CloneURL(b.domain.Registry.URL)))
require.NoError(b.t, b.dnsResolver.AddSRVEntry(b.name, dnsresolve.DefaultRegistryService, CloneURL(b.domain.Registry.URL)))
}
if b.domain.NSMgrProxy != nil {
require.NoError(b.t, AddSRVEntry(b.dnsResolver, b.name, dnsresolve.DefaultNsmgrProxyService, CloneURL(b.domain.NSMgrProxy.URL)))
require.NoError(b.t, b.dnsResolver.AddSRVEntry(b.name, dnsresolve.DefaultNsmgrProxyService, CloneURL(b.domain.NSMgrProxy.URL)))
}
}
Loading