Skip to content

Commit

Permalink
add unit tests to verify resource attributes mapping
Browse files Browse the repository at this point in the history
  • Loading branch information
@psx95
psx95 committed Jan 5, 2024
1 parent ec479f5 commit de8d26a
Showing 1 changed file with 220 additions and 51 deletions.
271 changes: 220 additions & 51 deletions ...urces/src/test/java/com/google/cloud/opentelemetry/detectors/GCPResourceProviderTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,86 +15,130 @@
*/
package com.google.cloud.opentelemetry.detectors;

import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GCE_CLOUD_REGION;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GCE_INSTANCE_ID;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GCE_INSTANCE_NAME;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GCE_MACHINE_TYPE;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GCE_PROJECT_ID;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GKE_CLUSTER_LOCATION;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GKE_CLUSTER_LOCATION_TYPE;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GKE_CLUSTER_NAME;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GKE_CONTAINER_NAME;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GKE_LOCATION_TYPE_REGION;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GKE_LOCATION_TYPE_ZONE;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GKE_NAMESPACE;
import static com.google.cloud.opentelemetry.detectors.AttributeKeys.GKE_POD_NAME;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;

import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.semconv.ResourceAttributes;
import java.util.HashMap;
import java.util.Map;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
import org.mockito.Mockito;

import java.util.EnumSet;
import java.util.HashMap;
import java.util.Map;

import static com.google.cloud.opentelemetry.detectors.AttributeKeys.*;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

@RunWith(JUnit4.class)
public class GCPResourceProviderTest {

private final ConfigProperties mockConfigProps = Mockito.mock(ConfigProperties.class);
private final Map<String, String> mockGKECommonAttributes =
new HashMap<>() {
{
put(GKE_POD_NAME, "gke-pod-123");
put(GKE_NAMESPACE, "gke-namespace-default");
put(GKE_CONTAINER_NAME, "gke-container-2");
put(GKE_CLUSTER_NAME, "gke-cluster");
}
};

// Mock Platforms
private DetectedPlatform generateMockGCEPlatform() {
return new DetectedPlatform() {
@Override
public GCPPlatformDetector.SupportedPlatform getSupportedPlatform() {
return GCPPlatformDetector.SupportedPlatform.GOOGLE_COMPUTE_ENGINE;
}

@Override
public Map<String, String> getAttributes() {
return new HashMap<>() {
Map<String, String> mockAttributes =
new HashMap<>() {
{
put(GCE_PROJECT_ID, "test-project-id");
put(GCE_CLOUD_REGION, "australia-southeast1");
put(GCE_AVAILABILITY_ZONE, "australia-southeast1-b");
put(GCE_INSTANCE_ID, "random-id");
put(GCE_INSTANCE_NAME, "instance-name");
put(GCE_MACHINE_TYPE, "gce-m2");
}
};
}
};
DetectedPlatform mockGCEPlatform = Mockito.mock(DetectedPlatform.class);
Mockito.when(mockGCEPlatform.getSupportedPlatform())
.thenReturn(GCPPlatformDetector.SupportedPlatform.GOOGLE_COMPUTE_ENGINE);
Mockito.when(mockGCEPlatform.getAttributes()).thenReturn(mockAttributes);
return mockGCEPlatform;
}

private DetectedPlatform generateMockGKEPlatform(String gkeClusterLocationType) {
String gkeClusterLocation;
Map<String, String> mockAttributes = new HashMap<>(mockGKECommonAttributes);
if (gkeClusterLocationType.equals(GKE_LOCATION_TYPE_ZONE)) {
gkeClusterLocation = "australia-southeast1-a";
} else {
gkeClusterLocation = "australia-southeast1";
mockAttributes.put(GKE_CLUSTER_LOCATION, "australia-southeast1-a");
} else if (gkeClusterLocationType.equals(GKE_LOCATION_TYPE_REGION)) {
mockAttributes.put(GKE_CLUSTER_LOCATION, "australia-southeast1");
}
mockAttributes.put(GKE_CLUSTER_LOCATION_TYPE, gkeClusterLocationType);

DetectedPlatform mockGKEPlatform = Mockito.mock(DetectedPlatform.class);
Mockito.when(mockGKEPlatform.getSupportedPlatform())
.thenReturn(GCPPlatformDetector.SupportedPlatform.GOOGLE_KUBERNETES_ENGINE);
Mockito.when(mockGKEPlatform.getAttributes()).thenReturn(mockAttributes);
return mockGKEPlatform;
}

private DetectedPlatform generateMockServerlessPlatform(
GCPPlatformDetector.SupportedPlatform platform) {
final EnumSet<GCPPlatformDetector.SupportedPlatform> serverlessPlatforms =
EnumSet.of(
GCPPlatformDetector.SupportedPlatform.GOOGLE_CLOUD_RUN,
GCPPlatformDetector.SupportedPlatform.GOOGLE_CLOUD_FUNCTIONS);
if (!serverlessPlatforms.contains(platform)) {
throw new IllegalArgumentException();
}
return new DetectedPlatform() {
@Override
public GCPPlatformDetector.SupportedPlatform getSupportedPlatform() {
return GCPPlatformDetector.SupportedPlatform.GOOGLE_KUBERNETES_ENGINE;
}

@Override
public Map<String, String> getAttributes() {
return new HashMap<>() {
Map<String, String> mockAttributes =
new HashMap<>() {
{
put(SERVERLESS_COMPUTE_NAME, "serverless-app");
put(SERVERLESS_COMPUTE_REVISION, "v2");
put(SERVERLESS_COMPUTE_INSTANCE_ID, "serverless-instance-id");
put(SERVERLESS_COMPUTE_CLOUD_REGION, "us-central1");
put(SERVERLESS_COMPUTE_AVAILABILITY_ZONE, "us-central1-b");
}
};
DetectedPlatform mockServerlessPlatform = Mockito.mock(DetectedPlatform.class);
Mockito.when(mockServerlessPlatform.getSupportedPlatform()).thenReturn(platform);
Mockito.when(mockServerlessPlatform.getAttributes()).thenReturn(mockAttributes);
return mockServerlessPlatform;
}

private DetectedPlatform generateMockGAEPlatform() {
Map<String, String> mockAttributes =
new HashMap<>() {
{
put(GAE_MODULE_NAME, "gae-app");
put(GAE_APP_VERSION, "v1");
put(GAE_INSTANCE_ID, "gae-instance-id");
put(GAE_CLOUD_REGION, "us-central1");
put(GAE_AVAILABILITY_ZONE, "us-central1-b");
}
};
DetectedPlatform mockGAEPlatform = Mockito.mock(DetectedPlatform.class);
Mockito.when(mockGAEPlatform.getSupportedPlatform())
.thenReturn(GCPPlatformDetector.SupportedPlatform.GOOGLE_APP_ENGINE);
Mockito.when(mockGAEPlatform.getAttributes()).thenReturn(mockAttributes);
return mockGAEPlatform;
}

private DetectedPlatform generateMockUnknownPlatform() {
Map<String, String> mockAttributes =
new HashMap<>() {
{
put(GKE_POD_NAME, "gke-pod-123");
put(GKE_NAMESPACE, "gke-namespace-default");
put(GKE_CONTAINER_NAME, "gke-container-2");
put(GKE_CLUSTER_NAME, "gke-cluster");
put(GKE_CLUSTER_LOCATION_TYPE, gkeClusterLocationType);
put(GKE_CLUSTER_LOCATION, gkeClusterLocation);
put(GCE_INSTANCE_ID, "instance-id");
put(GCE_CLOUD_REGION, "australia-southeast1");
}
};
}
};

DetectedPlatform mockUnknownPlatform = Mockito.mock(DetectedPlatform.class);
Mockito.when(mockUnknownPlatform.getSupportedPlatform())
.thenReturn(GCPPlatformDetector.SupportedPlatform.UNKNOWN_PLATFORM);
Mockito.when(mockUnknownPlatform.getAttributes()).thenReturn(mockAttributes);
return mockUnknownPlatform;
}

@Test
Expand Down Expand Up @@ -123,7 +167,9 @@ public void testGCEResourceAttributesMapping() {
assertEquals(
mockPlatform.getAttributes().get(GCE_MACHINE_TYPE),
gotResource.getAttributes().get(ResourceAttributes.HOST_TYPE));
assertNull(gotResource.getAttributes().get(ResourceAttributes.CLOUD_AVAILABILITY_ZONE));
assertEquals(
mockPlatform.getAttributes().get(GCE_AVAILABILITY_ZONE),
gotResource.getAttributes().get(ResourceAttributes.CLOUD_AVAILABILITY_ZONE));
assertEquals(
mockPlatform.getAttributes().get(GCE_CLOUD_REGION),
gotResource.getAttributes().get(ResourceAttributes.CLOUD_REGION));
Expand Down Expand Up @@ -159,6 +205,39 @@ public void testGKEResourceAttributesMapping_LocationTypeZone() {
gotResource.getAttributes().get(ResourceAttributes.CLOUD_AVAILABILITY_ZONE));
}

@Test
public void testGKEResourceAttributesMapping_LocationTypeInvalid() {
Map<String, String> mockGKEAttributes = new HashMap<>(mockGKECommonAttributes);
mockGKEAttributes.put(GKE_CLUSTER_LOCATION_TYPE, "INVALID");
mockGKEAttributes.put(GKE_CLUSTER_LOCATION, "some-location");

GCPPlatformDetector mockDetector = Mockito.mock(GCPPlatformDetector.class);
DetectedPlatform mockPlatform = Mockito.mock(DetectedPlatform.class);
Mockito.when(mockPlatform.getSupportedPlatform())
.thenReturn(GCPPlatformDetector.SupportedPlatform.GOOGLE_KUBERNETES_ENGINE);
Mockito.when(mockPlatform.getAttributes()).thenReturn(mockGKEAttributes);
Mockito.when(mockDetector.detectPlatform()).thenReturn(mockPlatform);

Resource gotResource = new GCPResourceProvider(mockDetector).createResource(mockConfigProps);

verifyGKEMapping(gotResource, mockPlatform);
assertNull(gotResource.getAttributes().get(ResourceAttributes.CLOUD_REGION));
assertNull(gotResource.getAttributes().get(ResourceAttributes.CLOUD_AVAILABILITY_ZONE));
}

@Test
public void testGKEResourceAttributesMapping_LocationMissing() {
GCPPlatformDetector mockDetector = Mockito.mock(GCPPlatformDetector.class);
DetectedPlatform mockPlatform = generateMockGKEPlatform("");
Mockito.when(mockDetector.detectPlatform()).thenReturn(mockPlatform);

Resource gotResource = new GCPResourceProvider(mockDetector).createResource(mockConfigProps);

verifyGKEMapping(gotResource, mockPlatform);
assertNull(gotResource.getAttributes().get(ResourceAttributes.CLOUD_REGION));
assertNull(gotResource.getAttributes().get(ResourceAttributes.CLOUD_AVAILABILITY_ZONE));
}

private void verifyGKEMapping(Resource gotResource, DetectedPlatform detectedPlatform) {
assertEquals(
ResourceAttributes.CloudPlatformValues.GCP_KUBERNETES_ENGINE,
Expand All @@ -176,4 +255,94 @@ private void verifyGKEMapping(Resource gotResource, DetectedPlatform detectedPla
detectedPlatform.getAttributes().get(GKE_CONTAINER_NAME),
gotResource.getAttributes().get(ResourceAttributes.K8S_CONTAINER_NAME));
}

@Test
public void testGCRResourceAttributesMapping() {
GCPPlatformDetector mockDetector = Mockito.mock(GCPPlatformDetector.class);
DetectedPlatform mockPlatform =
generateMockServerlessPlatform(GCPPlatformDetector.SupportedPlatform.GOOGLE_CLOUD_RUN);
Mockito.when(mockDetector.detectPlatform()).thenReturn(mockPlatform);

Resource gotResource = new GCPResourceProvider(mockDetector).createResource(mockConfigProps);
assertEquals(
ResourceAttributes.CloudPlatformValues.GCP_CLOUD_RUN,
gotResource.getAttributes().get(ResourceAttributes.CLOUD_PLATFORM));
verifyServerlessMapping(gotResource, mockPlatform);
}

@Test
public void testGCFResourceAttributeMapping() {
GCPPlatformDetector mockDetector = Mockito.mock(GCPPlatformDetector.class);
DetectedPlatform mockPlatform =
generateMockServerlessPlatform(
GCPPlatformDetector.SupportedPlatform.GOOGLE_CLOUD_FUNCTIONS);
Mockito.when(mockDetector.detectPlatform()).thenReturn(mockPlatform);

Resource gotResource = new GCPResourceProvider(mockDetector).createResource(mockConfigProps);
assertEquals(
ResourceAttributes.CloudPlatformValues.GCP_CLOUD_FUNCTIONS,
gotResource.getAttributes().get(ResourceAttributes.CLOUD_PLATFORM));
verifyServerlessMapping(gotResource, mockPlatform);
}

private void verifyServerlessMapping(Resource gotResource, DetectedPlatform detectedPlatform) {
assertEquals(
ResourceAttributes.CloudProviderValues.GCP,
gotResource.getAttributes().get(ResourceAttributes.CLOUD_PROVIDER));
assertEquals(
detectedPlatform.getAttributes().get(SERVERLESS_COMPUTE_NAME),
gotResource.getAttributes().get(ResourceAttributes.FAAS_NAME));
assertEquals(
detectedPlatform.getAttributes().get(SERVERLESS_COMPUTE_REVISION),
gotResource.getAttributes().get(ResourceAttributes.FAAS_VERSION));
assertEquals(
detectedPlatform.getAttributes().get(SERVERLESS_COMPUTE_INSTANCE_ID),
gotResource.getAttributes().get(ResourceAttributes.FAAS_INSTANCE));
assertEquals(
detectedPlatform.getAttributes().get(SERVERLESS_COMPUTE_AVAILABILITY_ZONE),
gotResource.getAttributes().get(ResourceAttributes.CLOUD_AVAILABILITY_ZONE));
assertEquals(
detectedPlatform.getAttributes().get(SERVERLESS_COMPUTE_CLOUD_REGION),
gotResource.getAttributes().get(ResourceAttributes.CLOUD_REGION));
}

@Test
public void testGAEResourceAttributeMapping() {
GCPPlatformDetector mockDetector = Mockito.mock(GCPPlatformDetector.class);
DetectedPlatform mockPlatform = generateMockGAEPlatform();
Mockito.when(mockDetector.detectPlatform()).thenReturn(mockPlatform);

Resource gotResource = new GCPResourceProvider(mockDetector).createResource(mockConfigProps);
assertEquals(
ResourceAttributes.CloudPlatformValues.GCP_APP_ENGINE,
gotResource.getAttributes().get(ResourceAttributes.CLOUD_PLATFORM));
assertEquals(
ResourceAttributes.CloudProviderValues.GCP,
gotResource.getAttributes().get(ResourceAttributes.CLOUD_PROVIDER));
assertEquals(
mockPlatform.getAttributes().get(GAE_MODULE_NAME),
gotResource.getAttributes().get(ResourceAttributes.FAAS_NAME));
assertEquals(
mockPlatform.getAttributes().get(GAE_APP_VERSION),
gotResource.getAttributes().get(ResourceAttributes.FAAS_VERSION));
assertEquals(
mockPlatform.getAttributes().get(GAE_INSTANCE_ID),
gotResource.getAttributes().get(ResourceAttributes.FAAS_INSTANCE));
assertEquals(
mockPlatform.getAttributes().get(GAE_AVAILABILITY_ZONE),
gotResource.getAttributes().get(ResourceAttributes.CLOUD_AVAILABILITY_ZONE));
assertEquals(
mockPlatform.getAttributes().get(GAE_CLOUD_REGION),
gotResource.getAttributes().get(ResourceAttributes.CLOUD_REGION));
}

@Test
public void testUnknownPlatformResourceAttributesMapping() {
GCPPlatformDetector mockDetector = Mockito.mock(GCPPlatformDetector.class);
DetectedPlatform mockPlatform = generateMockUnknownPlatform();
Mockito.when(mockDetector.detectPlatform()).thenReturn(mockPlatform);

Resource gotResource = new GCPResourceProvider(mockDetector).createResource(mockConfigProps);
assertTrue("no attributes for unknown platform", gotResource.getAttributes().isEmpty());
}
}

0 comments on commit de8d26a

Please sign in to comment.