Create Generic Attachment to decouple from ENI and save attachment st…

…ate. update
aws · Oct 20, 2023 · a9a9f4a · a9a9f4a
1 parent b8d2a7f
commit a9a9f4a
Show file tree

Hide file tree

Showing 93 changed files with 762 additions and 910 deletions.
diff --git a/agent/acs/session/attach_eni_common.go b/agent/acs/session/attach_eni_common.go
@@ -127,7 +127,7 @@ func (eniHandler *eniHandler) removeENIAttachmentData(mac string) {
 		seelog.Errorf("Unable to retrieve ENI Attachment for mac address %s: ", mac)
 		return
 	}
-	attachmentId, err := utils.GetENIAttachmentId(attachmentToRemove.AttachmentARN)
+	attachmentId, err := utils.GetAttachmentId(attachmentToRemove.AttachmentARN)
 	if err != nil {
 		seelog.Errorf("Failed to get attachment id for %s: %v", attachmentToRemove.AttachmentARN, err)
 	} else {

diff --git a/agent/acs/session/attach_eni_common_test.go b/agent/acs/session/attach_eni_common_test.go
@@ -26,7 +26,7 @@ import (
 	"github.com/aws/amazon-ecs-agent/agent/data"
 	"github.com/aws/amazon-ecs-agent/agent/engine/dockerstate"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/session/testconst"
-	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachmentinfo"
+	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment"
 	ni "github.com/aws/amazon-ecs-agent/ecs-agent/netlib/model/networkinterface"
 )
 
@@ -53,7 +53,7 @@ func testENIAckTimeout(t *testing.T, attachmentType string) {
 
 	expiresAt := time.Now().Add(time.Millisecond * testconst.WaitTimeoutMillis)
 	eniAttachment := &ni.ENIAttachment{
-		AttachmentInfo: attachmentinfo.AttachmentInfo{
+		AttachmentInfo: attachment.AttachmentInfo{
 			TaskARN:          testconst.TaskARN,
 			AttachmentARN:    attachmentArn,
 			ExpiresAt:        expiresAt,
@@ -99,7 +99,7 @@ func testENIAckWithinTimeout(t *testing.T, attachmentType string) {
 	dataClient := data.NewNoopClient()
 	expiresAt := time.Now().Add(time.Millisecond * testconst.WaitTimeoutMillis)
 	eniAttachment := &ni.ENIAttachment{
-		AttachmentInfo: attachmentinfo.AttachmentInfo{
+		AttachmentInfo: attachment.AttachmentInfo{
 			TaskARN:          testconst.TaskARN,
 			AttachmentARN:    attachmentArn,
 			ExpiresAt:        expiresAt,
@@ -141,7 +141,7 @@ func testHandleENIAttachment(t *testing.T, attachmentType, taskArn string) {
 	taskEngineState := dockerstate.NewTaskEngineState()
 	expiresAt := time.Now().Add(time.Millisecond * testconst.WaitTimeoutMillis)
 	eniAttachment := &ni.ENIAttachment{
-		AttachmentInfo: attachmentinfo.AttachmentInfo{
+		AttachmentInfo: attachment.AttachmentInfo{
 			TaskARN:          taskArn,
 			AttachmentARN:    attachmentArn,
 			ExpiresAt:        expiresAt,
@@ -188,7 +188,7 @@ func testHandleExpiredENIAttachment(t *testing.T, attachmentType, taskArn string
 	dataClient := data.NewNoopClient()
 
 	eniAttachment := &ni.ENIAttachment{
-		AttachmentInfo: attachmentinfo.AttachmentInfo{
+		AttachmentInfo: attachment.AttachmentInfo{
 			TaskARN:       taskArn,
 			AttachmentARN: attachmentArn,
 			ExpiresAt:     expiresAt,

diff --git a/agent/acs/session/attach_instance_eni_responder_test.go b/agent/acs/session/attach_instance_eni_responder_test.go
@@ -31,7 +31,7 @@ import (
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/model/ecsacs"
 	acssession "github.com/aws/amazon-ecs-agent/ecs-agent/acs/session"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/session/testconst"
-	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachmentinfo"
+	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment"
 	ni "github.com/aws/amazon-ecs-agent/ecs-agent/netlib/model/networkinterface"
 )
 
@@ -113,7 +113,7 @@ func TestInstanceENIAckSingleMessageWithDuplicateENIAttachment(t *testing.T) {
 		mockState.EXPECT().
 			ENIByMac(testconst.RandomMAC).
 			Return(&ni.ENIAttachment{
-				AttachmentInfo: attachmentinfo.AttachmentInfo{
+				AttachmentInfo: attachment.AttachmentInfo{
 					ExpiresAt: expiresAt,
 				},
 			}, true).

diff --git a/agent/acs/session/attach_task_eni_responder_test.go b/agent/acs/session/attach_task_eni_responder_test.go
@@ -31,7 +31,7 @@ import (
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/model/ecsacs"
 	acssession "github.com/aws/amazon-ecs-agent/ecs-agent/acs/session"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/session/testconst"
-	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachmentinfo"
+	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment"
 	ni "github.com/aws/amazon-ecs-agent/ecs-agent/netlib/model/networkinterface"
 )
 
@@ -113,7 +113,7 @@ func TestTaskENIAckSingleMessageWithDuplicateENIAttachment(t *testing.T) {
 		mockState.EXPECT().
 			ENIByMac(testconst.RandomMAC).
 			Return(&ni.ENIAttachment{
-				AttachmentInfo: attachmentinfo.AttachmentInfo{
+				AttachmentInfo: attachment.AttachmentInfo{
 					ExpiresAt: expiresAt,
 				},
 			}, true).

diff --git a/agent/acs/session/payload_responder_test.go b/agent/acs/session/payload_responder_test.go
@@ -34,10 +34,10 @@ import (
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/model/ecsacs"
 	acssession "github.com/aws/amazon-ecs-agent/ecs-agent/acs/session"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/session/testconst"
-	"github.com/aws/amazon-ecs-agent/ecs-agent/api/eni"
-	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/resource"
+	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment/resource"
 	apitaskstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/task/status"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/credentials"
+	ni "github.com/aws/amazon-ecs-agent/ecs-agent/netlib/model/networkinterface"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/wsclient"
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/golang/mock/gomock"
@@ -858,7 +858,7 @@ func TestHandlePayloadMessageAddedENITrunkToTask(t *testing.T) {
 			Arn: aws.String(testconst.TaskARN),
 			ElasticNetworkInterfaces: []*ecsacs.ElasticNetworkInterface{
 				{
-					InterfaceAssociationProtocol: aws.String(eni.VLANInterfaceAssociationProtocol),
+					InterfaceAssociationProtocol: aws.String(ni.VLANInterfaceAssociationProtocol),
 					AttachmentArn:                aws.String(attachmentARN),
 					Ec2Id:                        aws.String(ec2ID),
 					Ipv4Addresses: []*ecsacs.IPv4AddressAssignment{
@@ -890,7 +890,7 @@ func TestHandlePayloadMessageAddedENITrunkToTask(t *testing.T) {
 
 	// Validate the added task has the ENI trunk information as expected.
 	taskeni := addedTask.GetPrimaryENI()
-	assert.Equal(t, eni.VLANInterfaceAssociationProtocol, taskeni.InterfaceAssociationProtocol)
+	assert.Equal(t, ni.VLANInterfaceAssociationProtocol, taskeni.InterfaceAssociationProtocol)
 	assert.Equal(t, testconst.RandomMAC, taskeni.InterfaceVlanProperties.TrunkInterfaceMacAddress)
 	assert.Equal(t, vlanID, taskeni.InterfaceVlanProperties.VlanID)
 }

diff --git a/agent/api/ecsclient/client.go b/agent/api/ecsclient/client.go
@@ -427,11 +427,12 @@ func (client *APIECSClient) SubmitTaskStateChange(change api.TaskStateChange) er
 	if change.Attachment != nil {
 		var attachments []*ecs.AttachmentStateChange
 
-		eniStatus := change.Attachment.Status.String()
+		eniStatus := change.Attachment.GetAttachmentStatus()
+		statusString := eniStatus.String()
 		attachments = []*ecs.AttachmentStateChange{
 			{
-				AttachmentArn: aws.String(change.Attachment.AttachmentARN),
-				Status:        aws.String(eniStatus),
+				AttachmentArn: aws.String(change.Attachment.GetAttachmentARN()),
+				Status:        aws.String(statusString),
 			},
 		}
 
@@ -657,14 +658,14 @@ func (client *APIECSClient) SubmitContainerStateChange(change api.ContainerState
 }
 
 func (client *APIECSClient) SubmitAttachmentStateChange(change api.AttachmentStateChange) error {
-	attachmentStatus := change.Attachment.Status.String()
+	attachmentStatus := change.Attachment.GetAttachmentStatus()
 
 	req := ecs.SubmitAttachmentStateChangesInput{
 		Cluster: &client.config.Cluster,
 		Attachments: []*ecs.AttachmentStateChange{
 			{
-				AttachmentArn: aws.String(change.Attachment.AttachmentARN),
-				Status:        aws.String(attachmentStatus),
+				AttachmentArn: aws.String(change.Attachment.GetAttachmentARN()),
+				Status:        aws.String(attachmentStatus.String()),
 			},
 		},
 	}

diff --git a/agent/api/ecsclient/client_test.go b/agent/api/ecsclient/client_test.go
@@ -24,9 +24,6 @@ import (
 	"testing"
 	"time"
 
-	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachmentinfo"
-	"github.com/aws/amazon-ecs-agent/ecs-agent/api/status"
-
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -37,6 +34,8 @@ import (
 	"github.com/aws/amazon-ecs-agent/agent/config"
 	"github.com/aws/amazon-ecs-agent/agent/ec2"
 	mock_ec2 "github.com/aws/amazon-ecs-agent/agent/ec2/mocks"
+	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment"
+	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment/resource"
 	apicontainerstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/container/status"
 	apitaskstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/task/status"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/async"
@@ -1063,9 +1062,9 @@ func TestDiscoverTelemetryEndpointAfterPollEndpointCacheHit(t *testing.T) {
 	}
 }
 
-// TestSubmitTaskStateChangeWithAttachments tests the SubmitTaskStateChange API
+// TestSubmitTaskStateChangeWithENIAttachments tests the SubmitTaskStateChange API
 // also send the Attachment Status
-func TestSubmitTaskStateChangeWithAttachments(t *testing.T) {
+func TestSubmitTaskStateChangeWithENIAttachments(t *testing.T) {
 	mockCtrl := gomock.NewController(t)
 	defer mockCtrl.Finish()
 
@@ -1086,9 +1085,41 @@ func TestSubmitTaskStateChangeWithAttachments(t *testing.T) {
 	err := client.SubmitTaskStateChange(api.TaskStateChange{
 		TaskARN: "task_arn",
 		Attachment: &ni.ENIAttachment{
-			AttachmentInfo: attachmentinfo.AttachmentInfo{
+			AttachmentInfo: attachment.AttachmentInfo{
 				AttachmentARN: "eni_arn",
-				Status:        status.AttachmentAttached,
+				Status:        attachment.AttachmentAttached,
+			},
+		},
+	})
+	assert.NoError(t, err, "Unable to submit task state change with attachments")
+}
+
+// TestSubmitTaskStateChangeWithResourceAttachments tests the SubmitTaskStateChange API
+// also send the Attachment Status
+func TestSubmitTaskStateChangeWithResourceAttachments(t *testing.T) {
+	mockCtrl := gomock.NewController(t)
+	defer mockCtrl.Finish()
+
+	client, _, mockSubmitStateClient := NewMockClient(mockCtrl, ec2.NewBlackholeEC2MetadataClient(), nil)
+	mockSubmitStateClient.EXPECT().SubmitTaskStateChange(&taskSubmitInputMatcher{
+		ecs.SubmitTaskStateChangeInput{
+			Cluster: aws.String(configuredCluster),
+			Task:    aws.String("task_arn"),
+			Attachments: []*ecs.AttachmentStateChange{
+				{
+					AttachmentArn: aws.String("resource_arn"),
+					Status:        aws.String("ATTACHED"),
+				},
+			},
+		},
+	})
+
+	err := client.SubmitTaskStateChange(api.TaskStateChange{
+		TaskARN: "task_arn",
+		Attachment: &resource.ResourceAttachment{
+			AttachmentInfo: attachment.AttachmentInfo{
+				AttachmentARN: "resource_arn",
+				Status:        attachment.AttachmentAttached,
 			},
 		},
 	})

diff --git a/agent/api/statechange.go b/agent/api/statechange.go
@@ -21,6 +21,7 @@ import (
 	apicontainer "github.com/aws/amazon-ecs-agent/agent/api/container"
 	apitask "github.com/aws/amazon-ecs-agent/agent/api/task"
 	"github.com/aws/amazon-ecs-agent/agent/statechange"
+	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment"
 	apicontainerstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/container/status"
 	apitaskstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/task/status"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/logger"
@@ -73,7 +74,8 @@ type ManagedAgentStateChange struct {
 // SubmitTaskStateChange API
 type TaskStateChange struct {
 	// Attachment is the eni attachment object to send
-	Attachment *ni.ENIAttachment
+	//Attachment *ni.ENIAttachment
+	Attachment attachment.Attachment
 	// TaskArn is the unique identifier for the task
 	TaskARN string
 	// Status is the status to send
@@ -98,8 +100,7 @@ type TaskStateChange struct {
 // AttachmentStateChange represents a state change that needs to be sent to the
 // SubmitAttachmentStateChanges API
 type AttachmentStateChange struct {
-	// Attachment is the eni attachment object to send
-	Attachment *ni.ENIAttachment
+	Attachment attachment.Attachment
 }
 
 type ErrShouldNotSendEvent struct {
@@ -352,7 +353,7 @@ func (change *TaskStateChange) String() string {
 // String returns a human readable string representation of this object
 func (change *AttachmentStateChange) String() string {
 	if change.Attachment != nil {
-		return fmt.Sprintf("%s -> %s, %s", change.Attachment.AttachmentARN, change.Attachment.Status.String(),
+		return fmt.Sprintf("%s -> %v, %s", change.Attachment.GetAttachmentARN(), change.Attachment.GetAttachmentStatus(),
 			change.Attachment.String())
 	}
 

diff --git a/agent/api/task/task.go b/agent/api/task/task.go
@@ -41,9 +41,9 @@ import (
 	taskresourcevolume "github.com/aws/amazon-ecs-agent/agent/taskresource/volume"
 	"github.com/aws/amazon-ecs-agent/agent/utils"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/model/ecsacs"
+	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment/resource"
 	apicontainerstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/container/status"
 	apierrors "github.com/aws/amazon-ecs-agent/ecs-agent/api/errors"
-	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/resource"
 	apitaskstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/task/status"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/credentials"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/ecs_client/model/ecs"

diff --git a/agent/api/task/task_attachment_handler.go b/agent/api/task/task_attachment_handler.go
@@ -19,12 +19,12 @@ import (
 	"github.com/aws/amazon-ecs-agent/agent/api/serviceconnect"
 	taskresourcevolume "github.com/aws/amazon-ecs-agent/agent/taskresource/volume"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/model/ecsacs"
-	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/resource"
+	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment/resource"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/logger"
 	"github.com/aws/aws-sdk-go/aws"
 )
 
-// AttachmentHandler defines an interface to handel attachment received from ACS.
+// AttachmentHandler defines an interface to handle attachment received from ACS.
 type AttachmentHandler interface {
 	parseAttachment(acsAttachment *ecsacs.Attachment) error
 	validateAttachment(acsTask *ecsacs.Task, task *Task) error

diff --git a/agent/api/task/task_attachment_handler_test.go b/agent/api/task/task_attachment_handler_test.go
@@ -25,7 +25,7 @@ import (
 	"github.com/aws/amazon-ecs-agent/agent/api/serviceconnect"
 	taskresourcevolume "github.com/aws/amazon-ecs-agent/agent/taskresource/volume"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/model/ecsacs"
-	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/resource"
+	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment/resource"
 	"github.com/aws/aws-sdk-go/aws"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"

diff --git a/agent/api/task/task_test.go b/agent/api/task/task_test.go
@@ -48,8 +48,8 @@ import (
 	taskresourcevolume "github.com/aws/amazon-ecs-agent/agent/taskresource/volume"
 	"github.com/aws/amazon-ecs-agent/agent/utils"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/acs/model/ecsacs"
+	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment/resource"
 	apicontainerstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/container/status"
-	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/resource"
 	apitaskstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/task/status"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/credentials"
 	mock_credentials "github.com/aws/amazon-ecs-agent/ecs-agent/credentials/mocks"

diff --git a/agent/api/task/taskvolume.go b/agent/api/task/taskvolume.go
@@ -21,7 +21,7 @@ import (
 	"github.com/aws/amazon-ecs-agent/agent/taskresource/fsxwindowsfileserver"
 	taskresourcetypes "github.com/aws/amazon-ecs-agent/agent/taskresource/types"
 	taskresourcevolume "github.com/aws/amazon-ecs-agent/agent/taskresource/volume"
-	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/resource"
+	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment/resource"
 
 	"github.com/cihub/seelog"
 	"github.com/pkg/errors"

diff --git a/agent/api/task/taskvolume_test.go b/agent/api/task/taskvolume_test.go
@@ -28,8 +28,8 @@ import (
 	mock_dockerapi "github.com/aws/amazon-ecs-agent/agent/dockerclient/dockerapi/mocks"
 	"github.com/aws/amazon-ecs-agent/agent/taskresource"
 	taskresourcevolume "github.com/aws/amazon-ecs-agent/agent/taskresource/volume"
+	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment/resource"
 	apicontainerstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/container/status"
-	apiresource "github.com/aws/amazon-ecs-agent/ecs-agent/api/resource"
 
 	"github.com/docker/docker/api/types/volume"
 	"github.com/golang/mock/gomock"

diff --git a/agent/app/data_test.go b/agent/app/data_test.go
@@ -29,7 +29,7 @@ import (
 	"github.com/aws/amazon-ecs-agent/agent/engine/dockerstate"
 	"github.com/aws/amazon-ecs-agent/agent/engine/image"
 	"github.com/aws/amazon-ecs-agent/agent/statemanager"
-	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachmentinfo"
+	"github.com/aws/amazon-ecs-agent/ecs-agent/api/attachment"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/eventstream"
 	ni "github.com/aws/amazon-ecs-agent/ecs-agent/netlib/model/networkinterface"
 	"github.com/golang/mock/gomock"
@@ -76,7 +76,7 @@ var (
 	}
 
 	testENIAttachment = &ni.ENIAttachment{
-		AttachmentInfo: attachmentinfo.AttachmentInfo{
+		AttachmentInfo: attachment.AttachmentInfo{
 			AttachmentARN:    testAttachmentArn,
 			AttachStatusSent: false,
 		},