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

Jump to bottom

fix: aws_lb_listener cache key #1599

Merged
merged 1 commit into from
Nov 18, 2022
Merged

fix: aws_lb_listener cache key #1599

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
7 changes: 5 additions & 2 deletions enumeration/remote/aws/repository/elbv2_repository.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package repository

import (
"fmt"

"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/elbv2"
"github.com/aws/aws-sdk-go/service/elbv2/elbv2iface"
Expand Down Expand Up @@ -45,7 +47,8 @@ func (r *elbv2Repository) ListAllLoadBalancers() ([]*elbv2.LoadBalancer, error)
}

func (r *elbv2Repository) ListAllLoadBalancerListeners(loadBalancerArn string) ([]*elbv2.Listener, error) {
if v := r.cache.Get("elbv2ListAllLoadBalancerListeners"); v != nil {
cacheKey := fmt.Sprintf("elbv2ListAllLoadBalancerListeners_%s", loadBalancerArn)
if v := r.cache.Get(cacheKey); v != nil {
return v.([]*elbv2.Listener), nil
}

Expand All @@ -60,6 +63,6 @@ func (r *elbv2Repository) ListAllLoadBalancerListeners(loadBalancerArn string) (
if err != nil {
return nil, err
}
r.cache.Put("elbv2ListAllLoadBalancerListeners", results)
r.cache.Put(cacheKey, results)
return results, err
}
205 changes: 137 additions & 68 deletions enumeration/remote/aws/repository/elbv2_repository_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
package repository

import (
"github.com/snyk/driftctl/enumeration/remote/cache"
"strings"
"testing"

"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/elbv2"
"github.com/pkg/errors"
awstest "github.com/snyk/driftctl/test/aws"
"github.com/stretchr/testify/mock"

"github.com/r3labs/diff/v2"
"github.com/snyk/driftctl/enumeration/remote/cache"
awstest "github.com/snyk/driftctl/test/aws"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
)

func Test_ELBV2Repository_ListAllLoadBalancers(t *testing.T) {
Expand Down Expand Up @@ -133,17 +132,53 @@ func Test_ELBV2Repository_ListAllLoadBalancers(t *testing.T) {
func Test_ELBV2Repository_ListAllLoadBalancerListeners(t *testing.T) {
dummyError := errors.New("dummy error")

type call struct {
loadBalancerArn string
mocks func(*awstest.MockFakeELBV2, *cache.MockCache)
want []*elbv2.Listener
wantErr error
}

tests := []struct {
name string
mocks func(*awstest.MockFakeELBV2, *cache.MockCache)
want []*elbv2.Listener
wantErr error
name string
calls []call
}{
{
name: "list load balancer listeners",
mocks: func(client *awstest.MockFakeELBV2, store *cache.MockCache) {
results := &elbv2.DescribeListenersOutput{
Listeners: []*elbv2.Listener{
calls: []call{
{
loadBalancerArn: "test-lb",
mocks: func(client *awstest.MockFakeELBV2, store *cache.MockCache) {
results := &elbv2.DescribeListenersOutput{
Listeners: []*elbv2.Listener{
{
LoadBalancerArn: aws.String("test-lb"),
ListenerArn: aws.String("test-lb-listener-1"),
},
{
LoadBalancerArn: aws.String("test-lb"),
ListenerArn: aws.String("test-lb-listener-2"),
},
},
}

store.On("Get", "elbv2ListAllLoadBalancerListeners_test-lb").Return(nil).Once()

client.On("DescribeListenersPages",
&elbv2.DescribeListenersInput{LoadBalancerArn: aws.String("test-lb")},
mock.MatchedBy(func(callback func(res *elbv2.DescribeListenersOutput, lastPage bool) bool) bool {
callback(&elbv2.DescribeListenersOutput{Listeners: []*elbv2.Listener{
results.Listeners[0],
}}, false)
callback(&elbv2.DescribeListenersOutput{Listeners: []*elbv2.Listener{
results.Listeners[1],
}}, true)
return true
})).Return(nil).Once()

store.On("Put", "elbv2ListAllLoadBalancerListeners_test-lb", results.Listeners).Return(false).Once()
},
want: []*elbv2.Listener{
{
LoadBalancerArn: aws.String("test-lb"),
ListenerArn: aws.String("test-lb-listener-1"),
Expand All @@ -153,90 +188,124 @@ func Test_ELBV2Repository_ListAllLoadBalancerListeners(t *testing.T) {
ListenerArn: aws.String("test-lb-listener-2"),
},
},
}

store.On("Get", "elbv2ListAllLoadBalancerListeners").Return(nil).Once()

client.On("DescribeListenersPages",
&elbv2.DescribeListenersInput{LoadBalancerArn: aws.String("test-lb")},
mock.MatchedBy(func(callback func(res *elbv2.DescribeListenersOutput, lastPage bool) bool) bool {
callback(&elbv2.DescribeListenersOutput{Listeners: []*elbv2.Listener{
results.Listeners[0],
}}, false)
callback(&elbv2.DescribeListenersOutput{Listeners: []*elbv2.Listener{
results.Listeners[1],
}}, true)
return true
})).Return(nil).Once()

store.On("Put", "elbv2ListAllLoadBalancerListeners", results.Listeners).Return(false).Once()
},
want: []*elbv2.Listener{
{
LoadBalancerArn: aws.String("test-lb"),
ListenerArn: aws.String("test-lb-listener-1"),
},
{
LoadBalancerArn: aws.String("test-lb"),
ListenerArn: aws.String("test-lb-listener-2"),
},
},
},
{
name: "list load balancer listeners from cache",
mocks: func(client *awstest.MockFakeELBV2, store *cache.MockCache) {
output := &elbv2.DescribeListenersOutput{
Listeners: []*elbv2.Listener{
calls: []call{
{
loadBalancerArn: "test-lb",
mocks: func(client *awstest.MockFakeELBV2, store *cache.MockCache) {
output := &elbv2.DescribeListenersOutput{
Listeners: []*elbv2.Listener{
{
LoadBalancerArn: aws.String("test-lb"),
ListenerArn: aws.String("test-lb-listener"),
},
},
}

store.On("Get", "elbv2ListAllLoadBalancerListeners_test-lb").Return(output.Listeners).Once()
},
want: []*elbv2.Listener{
{
LoadBalancerArn: aws.String("test-lb"),
ListenerArn: aws.String("test-lb-listener"),
},
},
}

store.On("Get", "elbv2ListAllLoadBalancerListeners").Return(output.Listeners).Once()
},
},
want: []*elbv2.Listener{
},
{
name: "list load balancer listeners from multiple load balancers",
calls: []call{
{
loadBalancerArn: "test-lb-1",
mocks: func(client *awstest.MockFakeELBV2, store *cache.MockCache) {
output := &elbv2.DescribeListenersOutput{
Listeners: []*elbv2.Listener{
{
LoadBalancerArn: aws.String("test-lb-1"),
ListenerArn: aws.String("test-lb-1-listener"),
},
},
}

store.On("Get", "elbv2ListAllLoadBalancerListeners_test-lb-1").Return(output.Listeners).Once()
},
want: []*elbv2.Listener{
{
LoadBalancerArn: aws.String("test-lb-1"),
ListenerArn: aws.String("test-lb-1-listener"),
},
},
},
{
LoadBalancerArn: aws.String("test-lb"),
ListenerArn: aws.String("test-lb-listener"),
loadBalancerArn: "test-lb-2",
mocks: func(client *awstest.MockFakeELBV2, store *cache.MockCache) {
output := &elbv2.DescribeListenersOutput{
Listeners: []*elbv2.Listener{
{
LoadBalancerArn: aws.String("test-lb-2"),
ListenerArn: aws.String("test-lb-2-listener"),
},
},
}

store.On("Get", "elbv2ListAllLoadBalancerListeners_test-lb-2").Return(output.Listeners).Once()
},
want: []*elbv2.Listener{
{
LoadBalancerArn: aws.String("test-lb-2"),
ListenerArn: aws.String("test-lb-2-listener"),
},
},
},
},
},
{
name: "error listing load balancer listeners",
mocks: func(client *awstest.MockFakeELBV2, store *cache.MockCache) {
store.On("Get", "elbv2ListAllLoadBalancerListeners").Return(nil).Once()
calls: []call{
{
loadBalancerArn: "test-lb",
mocks: func(client *awstest.MockFakeELBV2, store *cache.MockCache) {
store.On("Get", "elbv2ListAllLoadBalancerListeners_test-lb").Return(nil).Once()

client.On("DescribeListenersPages",
&elbv2.DescribeListenersInput{LoadBalancerArn: aws.String("test-lb")},
mock.MatchedBy(func(callback func(res *elbv2.DescribeListenersOutput, lastPage bool) bool) bool {
callback(&elbv2.DescribeListenersOutput{Listeners: []*elbv2.Listener{}}, true)
return true
})).Return(dummyError).Once()
client.On("DescribeListenersPages",
&elbv2.DescribeListenersInput{LoadBalancerArn: aws.String("test-lb")},
mock.MatchedBy(func(callback func(res *elbv2.DescribeListenersOutput, lastPage bool) bool) bool {
callback(&elbv2.DescribeListenersOutput{Listeners: []*elbv2.Listener{}}, true)
return true
})).Return(dummyError).Once()
},
wantErr: dummyError,
},
},
wantErr: dummyError,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
store := &cache.MockCache{}
client := &awstest.MockFakeELBV2{}
tt.mocks(client, store)
r := &elbv2Repository{
client: client,
cache: store,
}
got, err := r.ListAllLoadBalancerListeners("test-lb")
assert.Equal(t, tt.wantErr, err)

changelog, err := diff.Diff(got, tt.want)
assert.Nil(t, err)
if len(changelog) > 0 {
for _, change := range changelog {
t.Errorf("%s: %v -> %v", strings.Join(change.Path, "."), change.From, change.To)
for _, call := range tt.calls {
call.mocks(client, store)
r := &elbv2Repository{
client: client,
cache: store,
}
got, err := r.ListAllLoadBalancerListeners(call.loadBalancerArn)
assert.Equal(t, call.wantErr, err)

changelog, err := diff.Diff(got, call.want)
assert.Nil(t, err)
if len(changelog) > 0 {
for _, change := range changelog {
t.Errorf("%s: %v -> %v", strings.Join(change.Path, "."), change.From, change.To)
}
t.Fail()
}
t.Fail()
}
})
}
Expand Down