Add v4 container metadata handler to ecs-agent module (#3720)

Author: amogh09

ecs-agent/logger/field/constants.go

@@ -14,38 +14,39 @@
 package field
 
 const (
-	TaskID             = "task"
-	TaskARN            = "taskARN"
-	Container          = "container"
-	DockerId           = "dockerId"
-	ManagedAgent       = "managedAgent"
-	KnownStatus        = "knownStatus"
-	KnownSent          = "knownSent"
-	DesiredStatus      = "desiredStatus"
-	SentStatus         = "sentStatus"
-	FailedStatus       = "failedStatus"
-	Sequence           = "seqnum"
-	Reason             = "reason"
-	Status             = "status"
-	RuntimeID          = "runtimeID"
-	Elapsed            = "elapsed"
-	Resource           = "resource"
-	Error              = "error"
-	Event              = "event"
-	Image              = "image"
-	Volume             = "volume"
-	Time               = "time"
-	NetworkMode        = "networkMode"
-	Cluster            = "cluster"
-	ServiceName        = "ServiceName"
-	TaskProtection     = "TaskProtection"
-	ImageID            = "imageID"
-	ImageNames         = "imageNames"
-	ImageSizeBytes     = "imageSizeBytes"
-	ImagePulledAt      = "imagePulledAt"
-	ImageLastUsedAt    = "imageLastUsedAt"
-	ImagePullSucceeded = "imagePullSucceeded"
-	ContainerName      = "containerName"
-	ContainerImage     = "containerImage"
-	ContainerExitCode  = "containerExitCode"
+	TaskID                  = "task"
+	TaskARN                 = "taskARN"
+	Container               = "container"
+	DockerId                = "dockerId"
+	ManagedAgent            = "managedAgent"
+	KnownStatus             = "knownStatus"
+	KnownSent               = "knownSent"
+	DesiredStatus           = "desiredStatus"
+	SentStatus              = "sentStatus"
+	FailedStatus            = "failedStatus"
+	Sequence                = "seqnum"
+	Reason                  = "reason"
+	Status                  = "status"
+	RuntimeID               = "runtimeID"
+	Elapsed                 = "elapsed"
+	Resource                = "resource"
+	Error                   = "error"
+	Event                   = "event"
+	Image                   = "image"
+	Volume                  = "volume"
+	Time                    = "time"
+	NetworkMode             = "networkMode"
+	Cluster                 = "cluster"
+	ServiceName             = "ServiceName"
+	TaskProtection          = "TaskProtection"
+	ImageID                 = "imageID"
+	ImageNames              = "imageNames"
+	ImageSizeBytes          = "imageSizeBytes"
+	ImagePulledAt           = "imagePulledAt"
+	ImageLastUsedAt         = "imageLastUsedAt"
+	ImagePullSucceeded      = "imagePullSucceeded"
+	ContainerName           = "containerName"
+	ContainerImage          = "containerImage"
+	ContainerExitCode       = "containerExitCode"
+	TMDSEndpointContainerID = "tmdsEndpointContainerID"
 )

ecs-agent/metrics/constants.go

@@ -0,0 +1,25 @@
+// 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.
+package metrics
+
+const (
+	// MetadataServer
+	metadataServerMetricNamespace  = "MetadataServer"
+	GetCredentialsMetricName       = metadataServerMetricNamespace + ".GetCredentials"
+	CrashErrorMetricName           = metadataServerMetricNamespace + ".Crash"
+	ShutdownErrorMetricName        = metadataServerMetricNamespace + ".ShutdownError"
+	InternalServerErrorMetricName  = metadataServerMetricNamespace + ".InternalServerError"
+	GetTaskProtectionMetricName    = metadataServerMetricNamespace + ".GetTaskProtection"
+	UpdateTaskProtectionMetricName = metadataServerMetricNamespace + ".UpdateTaskProtection"
+	AuthConfigMetricName           = metadataServerMetricNamespace + ".AuthConfig"
+)

ecs-agent/metrics/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/mock_entry.go -copyright_file=../../scripts/copyright_file . EntryFactory,Entry
+
+package metrics

ecs-agent/metrics/metrics.go

@@ -1,3 +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.
+
 package metrics
 
 // EntryFactory specifies the factory interface for creating new Metric Entry objects.

ecs-agent/metrics/mocks/mock_entry.go

@@ -14,6 +14,7 @@
 package utils
 
 import (
+	"encoding/json"
 	"fmt"
 	"net/http"
 
@@ -69,6 +70,22 @@ type ErrorMessage struct {
 	HTTPErrorCode int
 }
 
+// Marshals the provided response to JSON and writes it to the ResponseWriter with the provided
+// status code and application/json Content-Type header.
+// Writes an empty JSON '{}' response if JSON marshaling fails and logs the error.
+func WriteJSONResponse(
+	w http.ResponseWriter,
+	httpStatusCode int,
+	response interface{},
+	requestType string,
+) {
+	responseJSON, err := json.Marshal(response)
+	if e := WriteResponseIfMarshalError(w, err); e != nil {
+		return
+	}
+	WriteJSONToResponse(w, httpStatusCode, responseJSON, requestType)
+}
+
 // WriteJSONToResponse writes the header, JSON response to a ResponseWriter, and
 // log the error if necessary.
 func WriteJSONToResponse(w http.ResponseWriter, httpStatusCode int, responseJSON []byte, requestType string) {
@@ -133,3 +150,7 @@ func LimitReachedHandler(auditLogger audit.AuditLogger) func(http.ResponseWriter
 		auditLogger.Log(logRequest, http.StatusTooManyRequests, "")
 	}
 }
+
+func Is5XXStatus(statusCode int) bool {
+	return 500 <= statusCode && statusCode <= 599
+}

ecs-agent/tmds/handlers/utils/helpers.go

@@ -18,13 +18,15 @@ package utils
 
 import (
 	"encoding/json"
+	"fmt"
 	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
 	"testing"
 
 	mock_audit "github.com/aws/amazon-ecs-agent/ecs-agent/logger/audit/mocks"
 	"github.com/aws/amazon-ecs-agent/ecs-agent/logger/audit/request"
+	"github.com/aws/amazon-ecs-agent/ecs-agent/tmds/handlers/response"
 	"github.com/golang/mock/gomock"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -83,6 +85,32 @@ func TestWriteJSONToResponse(t *testing.T) {
 	assert.Equal(t, `"Unable to get task arn from request"`, bodyString)
 }
 
+// Tests that WriteJSONResponse marshals the provided response to JSON and writes it to
+// the response writer.
+func TestWriteJSONResponse(t *testing.T) {
+	recorder := httptest.NewRecorder()
+	res := response.PortResponse{ContainerPort: 8080, Protocol: "TCP", HostPort: 80, HostIp: "IP"}
+	WriteJSONResponse(recorder, http.StatusOK, res, RequestTypeTaskMetadata)
+
+	var actualResponse response.PortResponse
+	err := json.Unmarshal(recorder.Body.Bytes(), &actualResponse)
+	require.NoError(t, err)
+
+	assert.Equal(t, http.StatusOK, recorder.Code)
+	assert.Equal(t, res, actualResponse)
+}
+
+// Tests that an empty JSON response is written by WriteJSONResponse if the provided response
+// is not convertible to JSON.
+func TestWriteJSONResponseError(t *testing.T) {
+	recorder := httptest.NewRecorder()
+	res := func(k string) string { return k }
+	WriteJSONResponse(recorder, http.StatusOK, res, RequestTypeTaskMetadata)
+
+	assert.Equal(t, http.StatusInternalServerError, recorder.Code)
+	assert.Equal(t, "{}", recorder.Body.String())
+}
+
 func TestValueFromRequest(t *testing.T) {
 	r, _ := http.NewRequest("GET", "/v1/credentials?id=credid", nil)
 	val, ok := ValueFromRequest(r, "id")
@@ -108,3 +136,19 @@ func TestLimitReachHandler(t *testing.T) {
 	recorder := httptest.NewRecorder()
 	handler.ServeHTTP(recorder, req)
 }
+
+func TestIs5XXStatus(t *testing.T) {
+	yes := []int{500, 501, 550, http.StatusInternalServerError, http.StatusServiceUnavailable, 580, 599}
+	for _, y := range yes {
+		t.Run(fmt.Sprintf("yes %d", y), func(t *testing.T) {
+			assert.True(t, Is5XXStatus(y))
+		})
+	}
+
+	no := []int{http.StatusTooEarly, http.StatusBadRequest, http.StatusTooManyRequests, 400, 450, 600, 200, 301}
+	for _, n := range no {
+		t.Run(fmt.Sprintf("no %d", n), func(t *testing.T) {
+			assert.False(t, Is5XXStatus(n))
+		})
+	}
+}