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

Replace DescribeNetworkInterfaces with paginated version #1333

Merged
merged 3 commits into from
Dec 16, 2020
Merged

Replace DescribeNetworkInterfaces with paginated version #1333

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6da3857
Replace DescribeNetworkInterfaces with paginated version
haouc Dec 14, 2020
ecdd6f3
Refractor the filter logic into page iteration
haouc Dec 16, 2020
1b2f1f6
make format files
haouc Dec 16, 2020
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
30 changes: 27 additions & 3 deletions pkg/awsutils/awsutils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ const (

// Http client timeout env for sessions
httpTimeoutEnv = "HTTP_TIMEOUT"

// the default page size when paginating the DescribeNetworkInterfaces call
describeENIPageSize = 1000
)

var (
Expand Down Expand Up @@ -355,7 +358,7 @@ func New(useCustomNetworking bool) (*EC2InstanceMetadataCache, error) {

sess, err := session.NewSession(
&aws.Config{
Region: aws.String(cache.region),
Region: aws.String(cache.region),
MaxRetries: aws.Int(15),
HTTPClient: &http.Client{
Timeout: httpTimeoutValue,
Expand Down Expand Up @@ -1425,14 +1428,16 @@ func (cache *EC2InstanceMetadataCache) getFilteredListOfNetworkInterfaces() ([]*

input := &ec2.DescribeNetworkInterfacesInput{
Filters: []*ec2.Filter{tagFilter, statusFilter},
MaxResults: aws.Int64(describeENIPageSize),
}
result, err := cache.ec2SVC.DescribeNetworkInterfacesWithContext(context.Background(), input, userAgent)

outputENIs, err := cache.getENIsFromPaginatedDescribeNetworkInterfaces(input)
if err != nil {
return nil, errors.Wrap(err, "awsutils: unable to obtain filtered list of network interfaces")
}

networkInterfaces := make([]*ec2.NetworkInterface, 0)
for _, networkInterface := range result.NetworkInterfaces {
for _, networkInterface := range outputENIs {
// Verify the description starts with "aws-K8S-"
if !strings.HasPrefix(aws.StringValue(networkInterface.Description), eniDescriptionPrefix) {
continue
Expand Down Expand Up @@ -1515,3 +1520,22 @@ func (cache *EC2InstanceMetadataCache) IsUnmanagedENI(eniID string) bool {
}
return false
}

func (cache *EC2InstanceMetadataCache) getENIsFromPaginatedDescribeNetworkInterfaces(
input *ec2.DescribeNetworkInterfacesInput) ([]*ec2.NetworkInterface, error) {
outputENIs := make([]*ec2.NetworkInterface, 0)
haouc marked this conversation as resolved.
Show resolved Hide resolved
pageNum := 0
log.Debugf("Paginating describe ENI has page size: %d", *input.MaxResults)
pageFn := func(output *ec2.DescribeNetworkInterfacesOutput, lastPage bool) (nextPage bool) {
pageNum++
log.Debugf("EC2 DescribeNetworkInterfaces succeeded with %d results on page %d",
len(output.NetworkInterfaces), pageNum)

outputENIs = append(outputENIs, output.NetworkInterfaces...)
haouc marked this conversation as resolved.
Show resolved Hide resolved
// Loop is guided by nextToken, the func expect a false to exit.
return output.NextToken != nil
}

err := cache.ec2SVC.DescribeNetworkInterfacesPagesWithContext(context.Background(), input, pageFn, userAgent)
anguslees marked this conversation as resolved.
Show resolved Hide resolved
return outputENIs, err
}
48 changes: 30 additions & 18 deletions pkg/awsutils/awsutils_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"testing"
"time"

"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/service/ec2"
"github.com/golang/mock/gomock"
"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -711,10 +712,8 @@ func TestEC2InstanceMetadataCache_getFilteredListOfNetworkInterfaces_OneResult(t
attachment := &ec2.NetworkInterfaceAttachment{AttachmentId: &attachmentID}
cureniID := eniID

result := &ec2.DescribeNetworkInterfacesOutput{
NetworkInterfaces: []*ec2.NetworkInterface{{Attachment: attachment, Status: &status, TagSet: tag, Description: &description, NetworkInterfaceId: &cureniID}}}
mockEC2.EXPECT().DescribeNetworkInterfacesWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(result, nil)

interfaces := []*ec2.NetworkInterface{{Attachment: attachment, Status: &status, TagSet: tag, Description: &description, NetworkInterfaceId: &cureniID}}
setupDescribeNetworkInterfacesPagesWithContextMock(t, mockEC2, interfaces, nil, 1)
ins := &EC2InstanceMetadataCache{ec2SVC: mockEC2}
got, err := ins.getFilteredListOfNetworkInterfaces()
assert.NotNil(t, got)
Expand All @@ -725,10 +724,7 @@ func TestEC2InstanceMetadataCache_getFilteredListOfNetworkInterfaces_NoResult(t
ctrl, mockEC2 := setup(t)
defer ctrl.Finish()

result := &ec2.DescribeNetworkInterfacesOutput{
NetworkInterfaces: []*ec2.NetworkInterface{}}
mockEC2.EXPECT().DescribeNetworkInterfacesWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(result, nil)

setupDescribeNetworkInterfacesPagesWithContextMock(t, mockEC2, []*ec2.NetworkInterface{}, nil, 1)
ins := &EC2InstanceMetadataCache{ec2SVC: mockEC2}
got, err := ins.getFilteredListOfNetworkInterfaces()
assert.Nil(t, got)
Expand All @@ -739,7 +735,12 @@ func TestEC2InstanceMetadataCache_getFilteredListOfNetworkInterfaces_Error(t *te
ctrl, mockEC2 := setup(t)
defer ctrl.Finish()

mockEC2.EXPECT().DescribeNetworkInterfacesWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, errors.New("dummy error"))
interfaces := []*ec2.NetworkInterface{{
TagSet: []*ec2.Tag{
{Key: aws.String("foo"), Value: aws.String("foo-value")},
},
}}
setupDescribeNetworkInterfacesPagesWithContextMock(t, mockEC2, interfaces, errors.New("dummy error"), 1)

ins := &EC2InstanceMetadataCache{ec2SVC: mockEC2}
got, err := ins.getFilteredListOfNetworkInterfaces()
Expand Down Expand Up @@ -857,19 +858,30 @@ func TestEC2InstanceMetadataCache_cleanUpLeakedENIsInternal(t *testing.T) {
defer ctrl.Finish()

description := eniDescriptionPrefix + "test"
result := &ec2.DescribeNetworkInterfacesOutput{
NetworkInterfaces: []*ec2.NetworkInterface{{
Description: &description,
TagSet: []*ec2.Tag{
{Key: aws.String(eniNodeTagKey), Value: aws.String("test-value")},
},
}},
}
interfaces := []*ec2.NetworkInterface{{
Description: &description,
TagSet: []*ec2.Tag{
{Key: aws.String(eniNodeTagKey), Value: aws.String("test-value")},
},
}}

mockEC2.EXPECT().DescribeNetworkInterfacesWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(result, nil)
setupDescribeNetworkInterfacesPagesWithContextMock(t, mockEC2, interfaces, nil, 1)
mockEC2.EXPECT().CreateTagsWithContext(gomock.Any(), gomock.Any(), gomock.Any()).Return(nil, nil)

ins := &EC2InstanceMetadataCache{ec2SVC: mockEC2}
// Test checks that both mocks gets called.
ins.cleanUpLeakedENIsInternal(time.Millisecond)
}

func setupDescribeNetworkInterfacesPagesWithContextMock(
t *testing.T, mockEC2 *mock_ec2wrapper.MockEC2, interfaces []*ec2.NetworkInterface, err error, times int) {
mockEC2.EXPECT().
DescribeNetworkInterfacesPagesWithContext(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).Times(times).
DoAndReturn(func(_ context.Context, _ *ec2.DescribeNetworkInterfacesInput,
fn func(*ec2.DescribeNetworkInterfacesOutput, bool) bool, userAgent request.Option) error {
assert.Equal(t, false, fn(&ec2.DescribeNetworkInterfacesOutput{
NetworkInterfaces: interfaces,
}, true))
return err
})
}
1 change: 1 addition & 0 deletions pkg/ec2wrapper/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ type EC2 interface {
DescribeNetworkInterfacesWithContext(ctx aws.Context, input *ec2svc.DescribeNetworkInterfacesInput, opts ...request.Option) (*ec2svc.DescribeNetworkInterfacesOutput, error)
ModifyNetworkInterfaceAttributeWithContext(ctx aws.Context, input *ec2svc.ModifyNetworkInterfaceAttributeInput, opts ...request.Option) (*ec2svc.ModifyNetworkInterfaceAttributeOutput, error)
CreateTagsWithContext(ctx aws.Context, input *ec2svc.CreateTagsInput, opts ...request.Option) (*ec2svc.CreateTagsOutput, error)
DescribeNetworkInterfacesPagesWithContext(ctx aws.Context, input *ec2svc.DescribeNetworkInterfacesInput, fn func(*ec2svc.DescribeNetworkInterfacesOutput, bool) bool, opts ...request.Option) error
}

// New creates a new EC2 wrapper
Expand Down
19 changes: 19 additions & 0 deletions pkg/ec2wrapper/mocks/ec2wrapper_mocks.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.