Editing functional test in v2 metadata validator to check for tags

Author: linkar-ec2

agent/functional_tests/testdata/taskdefinitions/taskmetadata-validator-awsvpc/task-definition.json

@@ -12,6 +12,7 @@
         "retries": 2,
         "startPeriod": 1
     },
+    "command": ["$$$CHECK_TAGS$$$"],
     "logConfiguration": {
         "logDriver": "awslogs",
         "options": {

agent/functional_tests/tests/functionaltests_unix_test.go

@@ -665,6 +665,17 @@ func TestAgentIntrospectionValidator(t *testing.T) {
 
 func TestTaskMetadataValidator(t *testing.T) {
 	RequireDockerVersion(t, ">=17.06.0-ce")
+
+	// Added to test presence of tags in metadata endpoint
+	// We need long container instance ARN for tagging APIs, PutAccountSettingInput
+	// will enable long container instance ARN.
+	putAccountSettingInput := ecsapi.PutAccountSettingInput{
+		Name:  aws.String("containerInstanceLongArnFormat"),
+		Value: aws.String("enabled"),
+	}
+	_, err := ECS.PutAccountSetting(&putAccountSettingInput)
+	assert.NoError(t, err)
+
 	// Best effort to create a log group. It should be safe to even not do this
 	// as the log group gets created in the TestAWSLogsDriver functional test.
 	cwlClient := cloudwatchlogs.New(session.New(), aws.NewConfig().WithRegion(*ECS.Config.Region))
@@ -674,14 +685,18 @@ func TestTaskMetadataValidator(t *testing.T) {
 	agent := RunAgent(t, &AgentOptions{
 		EnableTaskENI: true,
 		ExtraEnvironment: map[string]string{
-			"ECS_AVAILABLE_LOGGING_DRIVERS": `["awslogs"]`,
+			"ECS_AVAILABLE_LOGGING_DRIVERS":              `["awslogs"]`,
+			"ECS_CONTAINER_INSTANCE_PROPAGATE_TAGS_FROM": "ec2_instance",
+			"ECS_CONTAINER_INSTANCE_TAGS": fmt.Sprintf(`{"%s": "%s"}`,
+				"localKey", "localValue"),
 		},
 	})
 	defer agent.Cleanup()
 	agent.RequireVersion(">1.20.1")
 
 	tdOverrides := make(map[string]string)
 	tdOverrides["$$$TEST_REGION$$$"] = *ECS.Config.Region
+	tdOverrides["$$$CHECK_TAGS$$$"] = "CheckTags" // Added to test presence of tags in metadata endpoint
 
 	task, err := agent.StartAWSVPCTask("taskmetadata-validator-awsvpc", tdOverrides)
 	require.NoError(t, err, "Unable to start task with 'awsvpc' network mode")
@@ -697,6 +712,12 @@ func TestTaskMetadataValidator(t *testing.T) {
 	exitCode, _ := task.ContainerExitcode("taskmetadata-validator")
 
 	assert.Equal(t, 42, exitCode, fmt.Sprintf("Expected exit code of 42; got %d", exitCode))
+
+	DeleteAccountSettingInput := ecsapi.DeleteAccountSettingInput{
+		Name: aws.String("containerInstanceLongArnFormat"),
+	}
+	_, err = ECS.DeleteAccountSetting(&DeleteAccountSettingInput)
+	assert.NoError(t, err)
 }
 
 // TestExecutionRole verifies that task can use the execution credentials to pull from ECR and

misc/taskmetadata-validator/taskmetadata-validator.go

@@ -25,23 +25,26 @@ import (
 )
 
 const (
-	v2MetadataEndpoint     = "http://169.254.170.2/v2/metadata"
-	v2StatsEndpoint        = "http://169.254.170.2/v2/stats"
-	maxRetries             = 4
-	durationBetweenRetries = time.Second
+	v2MetadataEndpoint         = "http://169.254.170.2/v2/metadata"
+	v2MetadataWithTagsEndpoint = "http://169.254.170.2/v2/metadataWithTags"
+	v2StatsEndpoint            = "http://169.254.170.2/v2/stats"
+	maxRetries                 = 4
+	durationBetweenRetries     = time.Second
 )
 
 // TaskResponse defines the schema for the task response JSON object
 type TaskResponse struct {
-	Cluster          string
-	TaskARN          string
-	Family           string
-	Revision         string
-	DesiredStatus    string `json:",omitempty"`
-	KnownStatus      string
-	AvailabilityZone string
-	Containers       []ContainerResponse `json:",omitempty"`
-	Limits           LimitsResponse      `json:",omitempty"`
+	Cluster               string
+	TaskARN               string
+	Family                string
+	Revision              string
+	DesiredStatus         string `json:",omitempty"`
+	KnownStatus           string
+	AvailabilityZone      string
+	Containers            []ContainerResponse `json:",omitempty"`
+	Limits                LimitsResponse      `json:",omitempty"`
+	TaskTags              map[string]string   `json:"TaskTags,omitempty"`
+	ContainerInstanceTags map[string]string   `json:"ContainerInstanceTags,omitempty"`
 }
 
 // ContainerResponse defines the schema for the container response
@@ -120,6 +123,23 @@ func taskMetadata(client *http.Client) (*TaskResponse, error) {
 	return &taskMetadata, nil
 }
 
+func taskWithTagsMetadata(client *http.Client) (*TaskResponse, error) {
+	body, err := metadataResponse(client, v2MetadataWithTagsEndpoint, "task with tags metadata")
+	if err != nil {
+		return nil, err
+	}
+
+	fmt.Printf("Received task with tags metadata: %s \n", string(body))
+
+	var taskMetadata TaskResponse
+	err = json.Unmarshal(body, &taskMetadata)
+	if err != nil {
+		return nil, fmt.Errorf("task with tags metadata: unable to parse response body: %v", err)
+	}
+
+	return &taskMetadata, nil
+}
+
 func containerMetadata(client *http.Client, id string) (*ContainerResponse, error) {
 	body, err := metadataResponse(client, v2MetadataEndpoint+"/"+id, "container metadata")
 	if err != nil {
@@ -214,6 +234,21 @@ func main() {
 	// Wait for the Health information to be ready
 	time.Sleep(5 * time.Second)
 
+	// If the image is built with option to check Tags
+	argsWithoutProg := os.Args[1:]
+	if len(argsWithoutProg) > 0 && argsWithoutProg[0] == "CheckTags" {
+		taskWithTagsMetadata, err := taskWithTagsMetadata(client)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "Unable to get task stats: %v", err)
+			os.Exit(1)
+		}
+
+		if len(taskWithTagsMetadata.ContainerInstanceTags) == 0 {
+			fmt.Fprintf(os.Stderr, "ContainerInstanceTags not found: %v", err)
+			os.Exit(1)
+		}
+	}
+
 	taskMetadata, err := taskMetadata(client)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "Unable to get task metadata: %v", err)