Skip to content

add end to end test for declarative config for aws #2047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions aws-resources/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,25 @@ dependencies {
implementation("com.squareup.okhttp3:okhttp")

testImplementation("io.opentelemetry:opentelemetry-sdk-extension-autoconfigure")
testImplementation("io.opentelemetry:opentelemetry-sdk-extension-incubator")
testImplementation("io.opentelemetry:opentelemetry-api-incubator")
testImplementation("io.opentelemetry:opentelemetry-sdk-testing")
testImplementation("io.opentelemetry:opentelemetry-exporter-logging")

testImplementation("com.linecorp.armeria:armeria-junit5")
testRuntimeOnly("org.bouncycastle:bcpkix-jdk15on")
testImplementation("com.google.guava:guava")
testImplementation("org.skyscreamer:jsonassert")
testImplementation("org.junit-pioneer:junit-pioneer")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is this added dependency used for?

}

tasks {
withType<Test>().configureEach {
environment(
"AWS_REGION" to "us-east-1",
"AWS_LAMBDA_FUNCTION_NAME" to "my-function",
"AWS_LAMBDA_FUNCTION_VERSION" to "1.2.3"
)
jvmArgs("-Dotel.experimental.config.file=${project.projectDir.resolve("src/test/resources/config.yaml")}")
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,13 @@

import static org.assertj.core.api.Assertions.assertThat;

import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.common.ComponentLoader;
import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
import io.opentelemetry.sdk.autoconfigure.spi.internal.ComponentProvider;
import io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions;
import io.opentelemetry.semconv.incubating.CloudIncubatingAttributes;
import org.assertj.core.api.InstanceOfAssertFactory;
import org.junit.jupiter.api.Test;

class ResourceComponentProviderTest {
Expand All @@ -19,6 +24,22 @@ void providerIsLoaded() {
Iterable<ComponentProvider> providers =
ComponentLoader.forClassLoader(ResourceComponentProviderTest.class.getClassLoader())
.load(ComponentProvider.class);
assertThat(providers).extracting(ComponentProvider::getName).containsExactly("aws");
assertThat(providers).extracting(ComponentProvider::getName).contains("aws");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was curious about the need for changing containsExactly to contains so i tried to put this back to containsExactly to see what would happen, and noticed that in the test failure it lists console 3 times, plus an additional service:

Expecting actual:
  ["aws", "console", "console", "console", "service"]
to contain exactly (and in same order):
  ["aws"]
but some elements were not expected:
  ["console", "console", "console", "service"]

I changed the test code to get some insights into what was actually loaded to see. Looks like this is because declarative configuration is automatically adding additional console exporters for metrics and logs plus the service resource detector.

Expecting actual:
  [io.opentelemetry.contrib.aws.resource.internal.AwsResourceDetector,
    io.opentelemetry.exporter.logging.internal.ConsoleMetricExporterComponentProvider,
    io.opentelemetry.exporter.logging.internal.ConsoleSpanExporterComponentProvider,
    io.opentelemetry.exporter.logging.internal.ConsoleLogRecordExporterComponentProvider,
    io.opentelemetry.sdk.extension.incubator.fileconfig.ServiceResourceDetector]

This surprised me a bit because I thought if the metric and log exporters weren't explicitly defined, they wouldn't be configured. Is my understanding off here?

}

@Test
void endToEnd() {
assertThat(
AutoConfiguredOpenTelemetrySdk.initialize()
.getOpenTelemetrySdk()
.getSdkTracerProvider())
.extracting("sharedState")
.extracting("resource")
.extracting(
"attributes",
new InstanceOfAssertFactory<>(Attributes.class, OpenTelemetryAssertions::assertThat))
.containsEntry(
CloudIncubatingAttributes.CLOUD_PROVIDER,
CloudIncubatingAttributes.CloudProviderIncubatingValues.AWS);
}
}
10 changes: 10 additions & 0 deletions aws-resources/src/test/resources/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
file_format: "1.0-rc.1"
resource:
detection/development:
detectors:
- aws:
tracer_provider:
processors:
- simple:
exporter:
console:
Loading