Increase test coverage of some ACS responders

ecs-agent/acs/session/attach_instance_eni_responder_test.go

@@ -18,12 +18,15 @@ package session
 
 import (
 	"fmt"
+	"sync"
 	"testing"
 
 	"github.com/aws/aws-sdk-go/aws"
+	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/assert"
 
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/model/ecsacs"
+	mock_session "github.com/aws/amazon-ecs-agent/ecs-agent/acs/session/mocks"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/session/testconst"
 	apieni "github.com/aws/amazon-ecs-agent/ecs-agent/api/eni"
 )
@@ -193,3 +196,42 @@ func TestAttachInstanceENIMessageWithMissingTimeout(t *testing.T) {
 
 	testAttachInstanceENIMessage.WaitTimeoutMs = tempWaitTimeoutMs
 }
+
+// TestInstanceENIAckHappyPath tests the happy path for a typical AttachInstanceNetworkInterfacesMessage and confirms
+// expected ACK request is made
+func TestInstanceENIAckHappyPath(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+
+	ackSent := make(chan *ecsacs.AckRequest)
+
+	// WaitGroup is necessary to wait for function to be called in separate goroutine before exiting the test.
+	wg := sync.WaitGroup{}
+	wg.Add(len(testAttachInstanceENIMessage.ElasticNetworkInterfaces))
+
+	mockENIHandler := mock_session.NewMockENIHandler(ctrl)
+	mockENIHandler.EXPECT().
+		HandleENIAttachment(gomock.Any()).
+		Times(len(testAttachInstanceENIMessage.ElasticNetworkInterfaces)).
+		Return(nil).
+		Do(func(arg0 interface{}) {
+			defer wg.Done() // decrement WaitGroup counter now that HandleENIAttachment function has been called
+		})
+
+	testResponseSender := func(response interface{}) error {
+		resp := response.(*ecsacs.AckRequest)
+		ackSent <- resp
+		return nil
+	}
+	testAttachInstanceENIResponder := NewAttachInstanceENIResponder(
+		mockENIHandler,
+		testResponseSender)
+
+	handleAttachMessage :=
+		testAttachInstanceENIResponder.HandlerFunc().(func(*ecsacs.AttachInstanceNetworkInterfacesMessage))
+	go handleAttachMessage(testAttachInstanceENIMessage)
+
+	attachInstanceEniAckSent := <-ackSent
+	wg.Wait()
+	assert.Equal(t, aws.StringValue(attachInstanceEniAckSent.MessageId), testconst.MessageID)
+}

ecs-agent/acs/session/attach_resource_responder_test.go

@@ -17,8 +17,12 @@
 package session
 
 import (
+	"sync"
 	"testing"
 
+	mock_session "github.com/aws/amazon-ecs-agent/ecs-agent/acs/session/mocks"
+	"github.com/aws/amazon-ecs-agent/ecs-agent/metrics"
+	mock_metrics "github.com/aws/amazon-ecs-agent/ecs-agent/metrics/mocks"
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/require"
@@ -109,6 +113,13 @@ func TestValidateAttachResourceMessage(t *testing.T) {
 	_, err = validateAttachResourceMessage(&confirmAttachmentMessageCopy)
 
 	require.Error(t, err)
+
+	confirmAttachmentMessageCopy = *testConfirmAttachmentMessage
+	confirmAttachmentMessageCopy.Attachment.AttachmentArn = aws.String("incorrectArn")
+
+	_, err = validateAttachResourceMessage(&confirmAttachmentMessageCopy)
+
+	require.Error(t, err)
 }
 
 func TestValidateAttachmentAndReturnProperties(t *testing.T) {
@@ -145,3 +156,49 @@ func TestValidateAttachmentAndReturnProperties(t *testing.T) {
 		})
 	}
 }
+
+// TestResourceAckHappyPath tests the happy path for a typical ConfirmAttachmentMessage and confirms expected
+// ACK request is made
+func TestResourceAckHappyPath(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+
+	confirmAttachmentMessageCopy := *testConfirmAttachmentMessage
+
+	ackSent := make(chan *ecsacs.AckRequest)
+
+	_, err := validateAttachmentAndReturnProperties(&confirmAttachmentMessageCopy)
+	require.NoError(t, err)
+
+	// WaitGroup is necessary to wait for function to be called in separate goroutine before exiting the test.
+	wg := sync.WaitGroup{}
+	wg.Add(1)
+
+	mockMetricsFactory := mock_metrics.NewMockEntryFactory(ctrl)
+	mockEntry := mock_metrics.NewMockEntry(ctrl)
+	mockEntry.EXPECT().Done(err)
+	mockMetricsFactory.EXPECT().New(metrics.ResourceValidationMetricName).Return(mockEntry)
+	mockResourceHandler := mock_session.NewMockResourceHandler(ctrl)
+	mockResourceHandler.EXPECT().
+		HandleResourceAttachment(gomock.Any()).
+		Do(func(arg0 interface{}) {
+			defer wg.Done() // decrement WaitGroup counter now that HandleResourceAttachment function has been called
+		})
+
+	testResponseSender := func(response interface{}) error {
+		resp := response.(*ecsacs.AckRequest)
+		ackSent <- resp
+		return nil
+	}
+	testResourceResponder := NewAttachResourceResponder(
+		mockResourceHandler,
+		mockMetricsFactory,
+		testResponseSender)
+
+	handleAttachMessage := testResourceResponder.HandlerFunc().(func(*ecsacs.ConfirmAttachmentMessage))
+	go handleAttachMessage(&confirmAttachmentMessageCopy)
+
+	attachResourceAckSent := <-ackSent
+	wg.Wait()
+	require.Equal(t, aws.StringValue(attachResourceAckSent.MessageId), testconst.MessageID)
+}

ecs-agent/acs/session/attach_task_eni_responder_test.go

@@ -18,9 +18,12 @@ package session
 
 import (
 	"fmt"
+	"sync"
 	"testing"
 
+	mock_session "github.com/aws/amazon-ecs-agent/ecs-agent/acs/session/mocks"
 	"github.com/aws/aws-sdk-go/aws"
+	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/assert"
 
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/model/ecsacs"
@@ -203,3 +206,41 @@ func TestAttachTaskENIMessageWithMissingTimeout(t *testing.T) {
 
 	testAttachTaskENIMessage.WaitTimeoutMs = tempWaitTimeoutMs
 }
+
+// TestTaskENIAckHappyPath tests the happy path for a typical AttachTaskNetworkInterfacesMessage and confirms expected
+// ACK request is made
+func TestTaskENIAckHappyPath(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish()
+
+	ackSent := make(chan *ecsacs.AckRequest)
+
+	// WaitGroup is necessary to wait for function to be called in separate goroutine before exiting the test.
+	wg := sync.WaitGroup{}
+	wg.Add(len(testAttachTaskENIMessage.ElasticNetworkInterfaces))
+
+	mockENIHandler := mock_session.NewMockENIHandler(ctrl)
+	mockENIHandler.EXPECT().
+		HandleENIAttachment(gomock.Any()).
+		Times(len(testAttachTaskENIMessage.ElasticNetworkInterfaces)).
+		Return(nil).
+		Do(func(arg0 interface{}) {
+			defer wg.Done() // decrement WaitGroup counter now that HandleENIAttachment function has been called
+		})
+
+	testResponseSender := func(response interface{}) error {
+		resp := response.(*ecsacs.AckRequest)
+		ackSent <- resp
+		return nil
+	}
+	testAttachTaskENIResponder := NewAttachTaskENIResponder(
+		mockENIHandler,
+		testResponseSender)
+
+	handleAttachMessage := testAttachTaskENIResponder.HandlerFunc().(func(*ecsacs.AttachTaskNetworkInterfacesMessage))
+	go handleAttachMessage(testAttachTaskENIMessage)
+
+	attachTaskEniAckSent := <-ackSent
+	wg.Wait()
+	assert.Equal(t, aws.StringValue(attachTaskEniAckSent.MessageId), testconst.MessageID)
+}

ecs-agent/acs/session/generate_mocks.go

@@ -0,0 +1,16 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//	http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file 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.
+
+//go:generate mockgen -destination=mocks/session_mock.go -copyright_file=../../../scripts/copyright_file . ENIHandler,ResourceHandler
+
+package session

ecs-agent/acs/session/testconst/test_const.go

@@ -17,7 +17,7 @@ package testconst
 // should only be called in test files.
 const (
 	ClusterName          = "default"
-	ContainerInstanceARN = "instance"
+	ContainerInstanceARN = "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
 	TaskARN              = "arn:aws:ecs:us-west-2:1234567890:task/test-cluster/abc"
 	MessageID            = "123"
 	RandomMAC            = "00:0a:95:9d:68:16"