opentelemetry-java-contrib/aws-resources/src/test/java/io/opentelemetry/contrib/aws/resource/EcsResourceTest.java at 7c017cf5a75bfe55a5aaec66e5b9f919b147763c · danielcompton/opentelemetry-java-contrib · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.contrib.aws.resource;

import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat;
import static io.opentelemetry.semconv.incubating.AwsIncubatingAttributes.AWS_ECS_CLUSTER_ARN;
import static io.opentelemetry.semconv.incubating.AwsIncubatingAttributes.AWS_ECS_CONTAINER_ARN;
import static io.opentelemetry.semconv.incubating.AwsIncubatingAttributes.AWS_ECS_LAUNCHTYPE;
import static io.opentelemetry.semconv.incubating.AwsIncubatingAttributes.AWS_ECS_TASK_ARN;
import static io.opentelemetry.semconv.incubating.AwsIncubatingAttributes.AWS_ECS_TASK_FAMILY;
import static io.opentelemetry.semconv.incubating.AwsIncubatingAttributes.AWS_ECS_TASK_REVISION;
import static io.opentelemetry.semconv.incubating.AwsIncubatingAttributes.AWS_LOG_GROUP_ARNS;
import static io.opentelemetry.semconv.incubating.AwsIncubatingAttributes.AWS_LOG_GROUP_NAMES;
import static io.opentelemetry.semconv.incubating.AwsIncubatingAttributes.AWS_LOG_STREAM_ARNS;
import static io.opentelemetry.semconv.incubating.AwsIncubatingAttributes.AWS_LOG_STREAM_NAMES;
import static io.opentelemetry.semconv.incubating.CloudIncubatingAttributes.CLOUD_ACCOUNT_ID;
import static io.opentelemetry.semconv.incubating.CloudIncubatingAttributes.CLOUD_AVAILABILITY_ZONE;
import static io.opentelemetry.semconv.incubating.CloudIncubatingAttributes.CLOUD_PLATFORM;
import static io.opentelemetry.semconv.incubating.CloudIncubatingAttributes.CLOUD_PROVIDER;
import static io.opentelemetry.semconv.incubating.CloudIncubatingAttributes.CLOUD_REGION;
import static io.opentelemetry.semconv.incubating.CloudIncubatingAttributes.CLOUD_RESOURCE_ID;
import static io.opentelemetry.semconv.incubating.ContainerIncubatingAttributes.CONTAINER_ID;
import static io.opentelemetry.semconv.incubating.ContainerIncubatingAttributes.CONTAINER_IMAGE_NAME;
import static io.opentelemetry.semconv.incubating.ContainerIncubatingAttributes.CONTAINER_IMAGE_TAGS;
import static io.opentelemetry.semconv.incubating.ContainerIncubatingAttributes.CONTAINER_NAME;
import static java.util.Collections.singletonList;
import static org.assertj.core.api.Assertions.entry;
import static org.mockito.Mockito.when;

import com.google.common.io.Resources;
import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.semconv.SchemaUrls;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.ServiceLoader;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

@ExtendWith(MockitoExtension.class)
class EcsResourceTest {
  private static final String ECS_METADATA_KEY_V4 = "ECS_CONTAINER_METADATA_URI_V4";
  private static final String ECS_METADATA_KEY_V3 = "ECS_CONTAINER_METADATA_URI";

  @Mock private SimpleHttpClient mockHttpClient;

  @Test
  void testCreateAttributesV3() throws IOException {
    Map<String, String> mockSysEnv = new HashMap<>();
    mockSysEnv.put(ECS_METADATA_KEY_V3, "ecs_metadata_v3_uri");
    when(mockHttpClient.fetchString("GET", "ecs_metadata_v3_uri", Collections.emptyMap(), null))
        .thenReturn(readResourceJson("ecs-container-metadata-v3.json"));
    when(mockHttpClient.fetchString(
            "GET", "ecs_metadata_v3_uri/task", Collections.emptyMap(), null))
        .thenReturn(readResourceJson("ecs-task-metadata-v3.json"));

    Resource resource = EcsResource.buildResource(mockSysEnv, mockHttpClient);
    Attributes attributes = resource.getAttributes();

    assertThat(resource.getSchemaUrl()).isEqualTo(SchemaUrls.V1_25_0);
    assertThat(attributes)
        .containsOnly(
            entry(CLOUD_PROVIDER, "aws"),
            entry(CLOUD_PLATFORM, "aws_ecs"),
            entry(CLOUD_ACCOUNT_ID, "012345678910"),
            entry(CLOUD_REGION, "us-east-2"),
            entry(CLOUD_AVAILABILITY_ZONE, "us-east-2b"),
            entry(CONTAINER_NAME, "ecs-nginx-5-nginx-curl-ccccb9f49db0dfe0d901"),
            entry(CONTAINER_ID, "43481a6ce4842eec8fe72fc28500c6b52edcc0917f105b83379f88cac1ff3946"),
            entry(CONTAINER_IMAGE_NAME, "nrdlngr/nginx-curl"),
            entry(CONTAINER_IMAGE_TAGS, singletonList("latest")),
            entry(AWS_ECS_CLUSTER_ARN, "arn:aws:ecs:us-east-2:012345678910:cluster/default"),
            entry(
                AttributeKey.stringKey("aws.ecs.container.image.id"),
                "sha256:2e00ae64383cfc865ba0a2ba37f61b50a120d2d9378559dcd458dc0de47bc165"),
            entry(
                AWS_ECS_TASK_ARN,
                "arn:aws:ecs:us-east-2:012345678910:task/9781c248-0edd-4cdb-9a93-f63cb662a5d3"),
            entry(AWS_ECS_TASK_FAMILY, "nginx"),
            entry(AWS_ECS_TASK_REVISION, "5"));
  }

  @Test
  void testCreateAttributesV4() throws IOException {
    Map<String, String> mockSysEnv = new HashMap<>();
    mockSysEnv.put(ECS_METADATA_KEY_V4, "ecs_metadata_v4_uri");
    when(mockHttpClient.fetchString("GET", "ecs_metadata_v4_uri", Collections.emptyMap(), null))
        .thenReturn(readResourceJson("ecs-container-metadata-v4.json"));
    when(mockHttpClient.fetchString(
            "GET", "ecs_metadata_v4_uri/task", Collections.emptyMap(), null))
        .thenReturn(readResourceJson("ecs-task-metadata-v4.json"));

    Resource resource = EcsResource.buildResource(mockSysEnv, mockHttpClient);
    Attributes attributes = resource.getAttributes();

    assertThat(resource.getSchemaUrl()).isEqualTo(SchemaUrls.V1_25_0);
    assertThat(attributes)
        .containsOnly(
            entry(CLOUD_PROVIDER, "aws"),
            entry(CLOUD_PLATFORM, "aws_ecs"),
            entry(CLOUD_ACCOUNT_ID, "111122223333"),
            entry(CLOUD_REGION, "us-west-2"),
            entry(
                CLOUD_RESOURCE_ID,
                "arn:aws:ecs:us-west-2:111122223333:container/0206b271-b33f-47ab-86c6-a0ba208a70a9"),
            entry(CLOUD_AVAILABILITY_ZONE, "us-west-2d"),
            entry(CONTAINER_NAME, "ecs-curltest-26-curl-cca48e8dcadd97805600"),
            entry(CONTAINER_ID, "ea32192c8553fbff06c9340478a2ff089b2bb5646fb718b4ee206641c9086d66"),
            entry(CONTAINER_IMAGE_NAME, "111122223333.dkr.ecr.us-west-2.amazonaws.com/curltest"),
            entry(CONTAINER_IMAGE_TAGS, singletonList("latest")),
            entry(
                AttributeKey.stringKey("aws.ecs.container.image.id"),
                "sha256:d691691e9652791a60114e67b365688d20d19940dde7c4736ea30e660d8d3553"),
            entry(AWS_ECS_CLUSTER_ARN, "arn:aws:ecs:us-west-2:111122223333:cluster/default"),
            entry(
                AWS_ECS_CONTAINER_ARN,
                "arn:aws:ecs:us-west-2:111122223333:container/0206b271-b33f-47ab-86c6-a0ba208a70a9"),
            entry(AWS_LOG_GROUP_NAMES, singletonList("/ecs/metadata")),
            entry(
                AWS_LOG_GROUP_ARNS,
                singletonList("arn:aws:logs:us-west-2:111122223333:log-group:/ecs/metadata")),
            entry(AWS_LOG_STREAM_NAMES, singletonList("ecs/curl/8f03e41243824aea923aca126495f665")),
            entry(
                AWS_LOG_STREAM_ARNS,
                singletonList(
                    "arn:aws:logs:us-west-2:111122223333:log-group:/ecs/metadata:log-stream:ecs/curl/8f03e41243824aea923aca126495f665")),
            entry(
                AWS_ECS_TASK_ARN,
                "arn:aws:ecs:us-west-2:111122223333:task/default/158d1c8083dd49d6b527399fd6414f5c"),
            entry(AWS_ECS_LAUNCHTYPE, "ec2"),
            entry(AWS_ECS_TASK_FAMILY, "curltest"),
            entry(AWS_ECS_TASK_REVISION, "26"));
  }

  @Test
  void testNotOnEcs() {
    Map<String, String> mockSysEnv = new HashMap<>();
    mockSysEnv.put(ECS_METADATA_KEY_V3, "");
    mockSysEnv.put(ECS_METADATA_KEY_V4, "");
    Attributes attributes = EcsResource.buildResource(mockSysEnv, mockHttpClient).getAttributes();
    assertThat(attributes).isEmpty();
  }

  @Test
  void inServiceLoader() {
    // No practical way to test the attributes themselves so at least check the service loader picks
    // it up.
    assertThat(ServiceLoader.load(ResourceProvider.class))
        .anyMatch(EcsResourceProvider.class::isInstance);
  }

  String readResourceJson(String resourceName) throws IOException {
    return Resources.toString(Resources.getResource(resourceName), StandardCharsets.UTF_8);
  }

  @Test
  void testImageWithSha256Digest() throws IOException {
    // Create a minimal JSON with just the Image field containing a SHA256 digest
    String json =
        "{\"Image\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/myapp:a635776144e10255377fa15957781eb11f59daa7@sha256:ca8528f563912012ee19777fad134b9abbe305c5d7fcf62c4c351a4eb8656dd8\"}";

    Map<String, String> mockSysEnv = new HashMap<>();
    mockSysEnv.put(ECS_METADATA_KEY_V4, "ecs_metadata_uri");

    when(mockHttpClient.fetchString("GET", "ecs_metadata_uri", Collections.emptyMap(), null))
        .thenReturn(json);
    when(mockHttpClient.fetchString("GET", "ecs_metadata_uri/task", Collections.emptyMap(), null))
        .thenReturn("{}");

    Resource resource = EcsResource.buildResource(mockSysEnv, mockHttpClient);
    Attributes attributes = resource.getAttributes();

    assertThat(attributes.get(CONTAINER_IMAGE_NAME))
        .isEqualTo("111122223333.dkr.ecr.us-east-1.amazonaws.com/myapp");
    assertThat(attributes.get(CONTAINER_IMAGE_TAGS))
        .isEqualTo(singletonList("a635776144e10255377fa15957781eb11f59daa7"));
  }
}