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

NLB display name to OCID map #486

Closed
wants to merge 1 commit into from
Closed

NLB display name to OCID map #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/cloudprovider/providers/oci/ccm.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ func NewCloudProvider(config *providercfg.Config) (cloudprovider.Interface, erro

rateLimiter := client.NewRateLimiter(logger.Sugar(), config.RateLimiter)

c, err := client.New(logger.Sugar(), cp, &rateLimiter, config.Auth.TenancyID)
c, err := client.New(logger.Sugar(), cp, &rateLimiter, config)
if err != nil {
return nil, err
}
Expand Down
19 changes: 6 additions & 13 deletions pkg/oci/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
"context"
"time"

providercfg "github.com/oracle/oci-cloud-controller-manager/pkg/cloudprovider/providers/oci/config"
"github.com/oracle/oci-go-sdk/v65/common"
"github.com/oracle/oci-go-sdk/v65/common/auth"
"github.com/oracle/oci-go-sdk/v65/core"
Expand Down Expand Up @@ -194,7 +195,7 @@ type client struct {
}

// New constructs an OCI API client.
func New(logger *zap.SugaredLogger, cp common.ConfigurationProvider, opRateLimiter *RateLimiter, targetTenancyID string) (Interface, error) {
func New(logger *zap.SugaredLogger, cp common.ConfigurationProvider, opRateLimiter *RateLimiter, cloudProviderConfig *providercfg.Config) (Interface, error) {

compute, err := core.NewComputeClientWithConfigurationProvider(cp)
if err != nil {
Expand Down Expand Up @@ -283,23 +284,15 @@ func New(logger *zap.SugaredLogger, cp common.ConfigurationProvider, opRateLimit
RetryPolicy: newRetryPolicy(),
}

loadbalancer := loadbalancerClientStruct{
loadbalancer: lb,
requestMetadata: requestMetadata,
rateLimiter: *opRateLimiter,
}
networkloadbalancer := networkLoadbalancer{
networkloadbalancer: nlb,
requestMetadata: requestMetadata,
rateLimiter: *opRateLimiter,
}
loadbalancer := NewLBClient(lb, requestMetadata, opRateLimiter).WithEmptyNameCache()
networkloadbalancer := NewNLBClient(nlb, requestMetadata, opRateLimiter).WithEmptyNameCache()

c := &client{
compute: &compute,
network: &network,
identity: &identity,
loadbalancer: &loadbalancer,
networkloadbalancer: &networkloadbalancer,
loadbalancer: loadbalancer,
networkloadbalancer: networkloadbalancer,
bs: &bs,
filestorage: &fss,
//compartment: &compartment,
Expand Down
2 changes: 1 addition & 1 deletion pkg/oci/client/client_factory.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ func GetClient(logger *zap.SugaredLogger, cfg *config.Config) (Interface, error)

rateLimiter := NewRateLimiter(logger, cfg.RateLimiter)

c, err := New(logger, cp, &rateLimiter, cfg.Auth.TenancyID)
c, err := New(logger, cp, &rateLimiter, cfg)
return c, err
}
28 changes: 28 additions & 0 deletions pkg/oci/client/load_balancer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ const (
)

type loadbalancerClientStruct struct {
nameToOcid LBNameOcidCache
loadbalancer loadBalancerClient
requestMetadata common.RequestMetadata
rateLimiter RateLimiter
Expand Down Expand Up @@ -64,6 +65,21 @@ type GenericLoadBalancerInterface interface {
UpdateLoadBalancer(ctx context.Context, lbID string, details *GenericUpdateLoadBalancerDetails) (string, error)
}

func NewLBClient(lb loadBalancerClient, rm common.RequestMetadata, lim *RateLimiter) *loadbalancerClientStruct {
l := loadbalancerClientStruct{
loadbalancer: lb,
requestMetadata: rm,
rateLimiter: *lim,
}
return &l
}

func (c *loadbalancerClientStruct) WithEmptyNameCache() *loadbalancerClientStruct {
c.nameToOcid.Initialize()
c.nameToOcid.SetEnabled(true)
return c
}

func (c *loadbalancerClientStruct) GetLoadBalancer(ctx context.Context, id string) (*GenericLoadBalancer, error) {
if !c.rateLimiter.Reader.TryAccept() {
return nil, RateLimitError(false, "GetLoadBalancer")
Expand All @@ -83,6 +99,17 @@ func (c *loadbalancerClientStruct) GetLoadBalancer(ctx context.Context, id strin
}

func (c *loadbalancerClientStruct) GetLoadBalancerByName(ctx context.Context, compartmentID, name string) (*GenericLoadBalancer, error) {
if ocid, ok := c.nameToOcid.Get(name); ok {
lb, err := c.GetLoadBalancer(ctx, ocid)
if err == nil {
return lb, err
}

if IsNotFound(err) { // Only remove the cached value on 404, not on a 5XX
c.nameToOcid.Delete(name)
}
}

var page *string
for {
if !c.rateLimiter.Reader.TryAccept() {
Expand All @@ -101,6 +128,7 @@ func (c *loadbalancerClientStruct) GetLoadBalancerByName(ctx context.Context, co
}
for _, lb := range resp.Items {
if *lb.DisplayName == name {
c.nameToOcid.Set(name, *lb.Id)
return c.loadbalancerToGenericLoadbalancer(&lb), nil
}
}
Expand Down
76 changes: 76 additions & 0 deletions pkg/oci/client/network_load_balancer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ package client

import (
"context"
"regexp"

"go.uber.org/zap"
"k8s.io/apimachinery/pkg/util/wait"
Expand All @@ -26,15 +27,78 @@ import (
)

type networkLoadbalancer struct {
nameToOcid LBNameOcidCache
networkloadbalancer networkLoadBalancerClient
requestMetadata common.RequestMetadata
rateLimiter RateLimiter
}

const (
NetworkLoadBalancerEntityType = "NetworkLoadBalancer"
// TODO move to utils?
dns1123LabelFmt = "[a-z0-9]([-a-z0-9]*[a-z0-9])?"
uuidFmt = "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
// <ns>/<svc>/<svc UID>
LBNameRegex = "^" + dns1123LabelFmt + "/" + dns1123LabelFmt + "/" + uuidFmt + "$"
)

func NewNLBClient(nlb networkLoadBalancerClient, rm common.RequestMetadata, lim *RateLimiter) *networkLoadbalancer {
n := networkLoadbalancer{
networkloadbalancer: nlb,
requestMetadata: rm,
rateLimiter: *lim,
}
return &n
}

// WithEmptyNameCache initializes the NLB Display Name -> OCID cache. Without this, names are not cached.
func (c *networkLoadbalancer) WithEmptyNameCache() *networkLoadbalancer {
c.nameToOcid.Initialize()
c.nameToOcid.SetEnabled(true)
return c
}

// WithPrepopulatedNameCache initializes the NLB Display Name -> OCID cache and pre-fills it with ocids of all NLBs
// in a given compartment matching the expected display name format. In case of error, the cache is left on, but unpopulated
// or partially populated.
func (c *networkLoadbalancer) WithPrepopulatedNameCache(ctx context.Context, compartmentID string) *networkLoadbalancer {
c.nameToOcid.Initialize()
c.nameToOcid.SetEnabled(true)

nameRegex, err := regexp.Compile(LBNameRegex)
if err != nil {
return c
}

var page *string
for {
if !c.rateLimiter.Reader.TryAccept() {
break
}

resp, err := c.networkloadbalancer.ListNetworkLoadBalancers(ctx, networkloadbalancer.ListNetworkLoadBalancersRequest{
CompartmentId: &compartmentID,
Page: page,
RequestMetadata: c.requestMetadata,
})
incRequestCounter(err, listVerb, networkLoadBalancerResource)
if err != nil {
break
}

for _, lb := range resp.Items {
if nameRegex.MatchString(*lb.DisplayName) {
c.nameToOcid.Set(*lb.DisplayName, *lb.Id)
}
}
if page = resp.OpcNextPage; page == nil {
break
}
}

return c
}

func (c *networkLoadbalancer) GetLoadBalancer(ctx context.Context, id string) (*GenericLoadBalancer, error) {
if !c.rateLimiter.Reader.TryAccept() {
return nil, RateLimitError(false, "GetLoadBalancer")
Expand All @@ -54,6 +118,17 @@ func (c *networkLoadbalancer) GetLoadBalancer(ctx context.Context, id string) (*
}

func (c *networkLoadbalancer) GetLoadBalancerByName(ctx context.Context, compartmentID string, name string) (*GenericLoadBalancer, error) {
if ocid, ok := c.nameToOcid.Get(name); ok {
lb, err := c.GetLoadBalancer(ctx, ocid)
if err == nil {
return lb, err
}

if IsNotFound(err) { // Only remove the cached value on 404, not on a 5XX
c.nameToOcid.Delete(name)
}
}

var page *string
for {
if !c.rateLimiter.Reader.TryAccept() {
Expand All @@ -72,6 +147,7 @@ func (c *networkLoadbalancer) GetLoadBalancerByName(ctx context.Context, compart
}
for _, lb := range resp.Items {
if *lb.DisplayName == name {
c.nameToOcid.Set(name, *lb.Id)
return c.networkLoadbalancerSummaryToGenericLoadbalancer(&lb), nil
}
}
Expand Down
122 changes: 120 additions & 2 deletions pkg/oci/client/network_load_balancer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ package client
import (
"context"
"errors"
"fmt"
errors2 "github.com/pkg/errors"
"log"
"strings"
Expand Down Expand Up @@ -98,10 +99,112 @@ func TestNLB_AwaitWorkRequest(t *testing.T) {
}
}

var (
fakeNlbOcid1 = "ocid.nlb.fake1"
fakeNlbName1 = "fake display name 1"
fakeNlbOcid2 = "ocid.nlb.fake2"
fakeNlbName2 = "fake display name 2"
fakeSubnetOcid = "ocid.subnet.fake"

NLBMap = map[string]networkloadbalancer.NetworkLoadBalancer{
"ocid.nlb.fake1": networkloadbalancer.NetworkLoadBalancer{
Id: &fakeNlbOcid1,
DisplayName: &fakeNlbName1,
SubnetId: &fakeSubnetOcid,
},
"ocid.nlb.fake2": networkloadbalancer.NetworkLoadBalancer{
Id: &fakeNlbOcid2,
DisplayName: &fakeNlbName2,
SubnetId: &fakeSubnetOcid,
},
}
)

func TestGetLoadBalancerByName(t *testing.T) {
var totalListCalls int
var loadbalancer = NewNLBClient(
&MockNetworkLoadBalancerClient{debug: true, listCalls: &totalListCalls},
common.RequestMetadata{},
&RateLimiter{
Reader: flowcontrol.NewFakeAlwaysRateLimiter(),
Writer: flowcontrol.NewFakeAlwaysRateLimiter(),
}).WithEmptyNameCache()

var tests = []struct {
skip bool // set true to skip a test-case
compartment, name, testname string
want string
wantErr error
wantListCalls int
}{
{
testname: "getFirstNLBFirstTime",
compartment: "ocid.compartment.fake",
name: fakeNlbName1,
want: fakeNlbOcid1,
wantErr: nil,
wantListCalls: 1,
},
{
testname: "getFirstNLBSecondTime",
compartment: "ocid.compartment.fake",
name: fakeNlbName1,
want: fakeNlbOcid1,
wantErr: nil,
wantListCalls: 1, // totals, no new list should be performed
},
{
testname: "getSecondNLBTime",
compartment: "ocid.compartment.fake",
name: fakeNlbName2,
want: fakeNlbOcid2,
wantErr: nil,
wantListCalls: 2,
},
{
testname: "getFirstNLBThirdTime",
compartment: "ocid.compartment.fake",
name: fakeNlbName1,
want: fakeNlbOcid1,
wantErr: nil,
wantListCalls: 2,
},
{
testname: "getSecondNLBSecondTime",
compartment: "ocid.compartment.fake",
name: fakeNlbName2,
want: fakeNlbOcid2,
wantErr: nil,
wantListCalls: 2,
},
}

for _, tt := range tests {
if tt.skip {
continue
}

t.Run(tt.testname, func(t *testing.T) {
log.Println("running test ", tt.testname)
got, err := loadbalancer.GetLoadBalancerByName(context.Background(), tt.compartment, tt.name)
if got == nil || *got.Id != tt.want {
t.Errorf("Expected %v, but got %v", tt.want, got)
}
if !errors.Is(err, tt.wantErr) {
t.Errorf("Expected error = %v, but got %v", tt.wantErr, err)
}
if totalListCalls != tt.wantListCalls {
t.Errorf("Expected the total number of NLB list calls %d, but got %d", tt.wantListCalls, totalListCalls)
}
})
}
}

type MockNetworkLoadBalancerClient struct {
// MockLoadBalancerClient mocks LoadBalancer client implementation.
counter int
debug bool // set true to run tests with debug logs
counter int
debug bool // set true to run tests with debug logs
listCalls *int // number of list operations performed
}

type getNetworkLoadBalancerWorkRequestResponse struct {
Expand Down Expand Up @@ -173,12 +276,27 @@ func (c *MockNetworkLoadBalancerClient) GetWorkRequest(ctx context.Context, requ
}

func (c *MockNetworkLoadBalancerClient) GetNetworkLoadBalancer(ctx context.Context, request networkloadbalancer.GetNetworkLoadBalancerRequest) (response networkloadbalancer.GetNetworkLoadBalancerResponse, err error) {
if c.debug {
log.Println(fmt.Sprintf("Getting NLB %v", *request.NetworkLoadBalancerId))
}

response = networkloadbalancer.GetNetworkLoadBalancerResponse{
NetworkLoadBalancer: NLBMap[*request.NetworkLoadBalancerId],
}
return
}
func (c *MockNetworkLoadBalancerClient) ListWorkRequests(ctx context.Context, request networkloadbalancer.ListWorkRequestsRequest) (response networkloadbalancer.ListWorkRequestsResponse, err error) {
return
}
func (c *MockNetworkLoadBalancerClient) ListNetworkLoadBalancers(ctx context.Context, request networkloadbalancer.ListNetworkLoadBalancersRequest) (response networkloadbalancer.ListNetworkLoadBalancersResponse, err error) {
if c.debug {
log.Println(fmt.Sprintf("Lising NLBs in compartment %v", *request.CompartmentId))
}

for _, nlb := range NLBMap {
response.NetworkLoadBalancerCollection.Items = append(response.NetworkLoadBalancerCollection.Items, networkloadbalancer.NetworkLoadBalancerSummary(nlb))
}
*c.listCalls += 1
return
}
func (c *MockNetworkLoadBalancerClient) CreateNetworkLoadBalancer(ctx context.Context, request networkloadbalancer.CreateNetworkLoadBalancerRequest) (response networkloadbalancer.CreateNetworkLoadBalancerResponse, err error) {
Expand Down
Loading
Loading