Skip to content

Commit

Permalink
Merge pull request #806 from upsidedownsmile/main
Browse files Browse the repository at this point in the history 
Add Application Signals contract test for JDBC using postgres
  • Loading branch information
@thpierce
thpierce authored May 23, 2024
2 parents f1ad3d0 + e513c7b commit e8f1e8c
Show file tree
Hide file tree
Showing 7 changed files with 358 additions and 8 deletions.
6 changes: 6 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,9 @@ atlassian-ide-plugin.xml

# rust
tools/cp-utility/target

# lsp
**/.project
**/.classpath
**/.settings
**/bin
1 change: 1 addition & 0 deletions appsignals-tests/contract-tests/build.gradle.kts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ dependencies {
testImplementation(kotlin("test"))
implementation(project(":appsignals-tests:images:grpc:grpc-base"))
testImplementation("org.testcontainers:kafka:1.19.3")
testImplementation("org.testcontainers:postgresql:1.19.3")
}

project.evaluationDependsOn(":otelagent")
Expand Down
21 changes: 19 additions & 2 deletions ...ntelemetry/appsignals/test/jdbc/JDBC.java → ...etry/appsignals/test/jdbc/JdbcH2Test.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import io.opentelemetry.proto.common.v1.KeyValue;
import io.opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInstance;
Expand All @@ -33,11 +34,12 @@

@Testcontainers(disabledWithoutDocker = true)
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
public class JDBC extends ContractTestBase {
public class JdbcH2Test extends ContractTestBase {

private static final String DB_SYSTEM = "h2";
private static final String DB_NAME = "testdb";
private static final String DB_USER = "sa";
private static final String DB_PASSWORD = "password";
private static final String DB_OPERATION = "SELECT";

@Test
Expand Down Expand Up @@ -69,7 +71,7 @@ public void testFault() {
var path = "fault";
var method = "GET";
var otelStatusCode = "STATUS_CODE_ERROR";
var dbSqlTable = "user";
var dbSqlTable = "userrr";
var response = appClient.get(path).aggregate().join();
assertThat(response.status().isServerError()).isTrue();

Expand Down Expand Up @@ -98,6 +100,21 @@ protected String getApplicationWaitPattern() {
return ".*Application Ready.*";
}

@Override
protected Map<String, String> getApplicationExtraEnvironmentVariables() {
return Map.of(
"DB_URL",
String.format("jdbc:h2:mem:%s", DB_NAME),
"DB_DRIVER",
"org.h2.Driver",
"DB_USERNAME",
DB_USER,
"DB_PASSWORD",
DB_PASSWORD,
"DB_PLATFORM",
"org.hibernate.dialect.H2Dialect");
}

protected void assertAwsSpanAttributes(
List<ResourceScopeSpan> resourceScopeSpans, String method, String path) {
assertThat(resourceScopeSpans)
Expand Down
325 changes: 325 additions & 0 deletions ...ts/src/test/java/software/amazon/opentelemetry/appsignals/test/jdbc/JdbcPostgresTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,325 @@
/*
* Copyright Amazon.com, Inc. or its affiliates.
*
* 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 software.amazon.opentelemetry.appsignals.test.jdbc;

import static io.opentelemetry.proto.trace.v1.Span.SpanKind.SPAN_KIND_CLIENT;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.Assert.assertThat;

import io.opentelemetry.proto.common.v1.KeyValue;
import io.opentelemetry.proto.metrics.v1.ExponentialHistogramDataPoint;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInstance;
import org.testcontainers.containers.PostgreSQLContainer;
import org.testcontainers.containers.wait.strategy.Wait;
import org.testcontainers.images.PullPolicy;
import org.testcontainers.junit.jupiter.Testcontainers;
import org.testcontainers.lifecycle.Startable;
import software.amazon.opentelemetry.appsignals.test.base.ContractTestBase;
import software.amazon.opentelemetry.appsignals.test.utils.AppSignalsConstants;
import software.amazon.opentelemetry.appsignals.test.utils.ResourceScopeMetric;
import software.amazon.opentelemetry.appsignals.test.utils.ResourceScopeSpan;
import software.amazon.opentelemetry.appsignals.test.utils.SemanticConventionsConstants;

@Testcontainers(disabledWithoutDocker = true)
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
public class JdbcPostgresTest extends ContractTestBase {

private static final String DB_SYSTEM = "postgresql";
private static final String DB_NAME = "testdb";
private static final String DB_USER = "sa";
private static final String DB_PASSWORD = "password";
private static final String DB_OPERATION = "SELECT";

private static final String NETWORK_ALIAS = "postgres";

private PostgreSQLContainer<?> postgreSqlContainer;

@AfterEach
public void afterEach() {
// dependent containers are not stopped between tests, only the application container.
postgreSqlContainer.stop();
}

@Test
public void testSuccess() {
var path = "success";
var method = "GET";
var otelStatusCode = "STATUS_CODE_UNSET";
var dbSqlTable = "employee";
var response = appClient.get(path).aggregate().join();
assertThat(response.status().isSuccess()).isTrue();

var traces = mockCollectorClient.getTraces();
assertAwsSpanAttributes(traces, method, path);
assertSemanticConventionsSpanAttributes(traces, otelStatusCode, dbSqlTable);

var metrics =
mockCollectorClient.getMetrics(
Set.of(
AppSignalsConstants.LATENCY_METRIC,
AppSignalsConstants.ERROR_METRIC,
AppSignalsConstants.FAULT_METRIC));
assertMetricAttributes(metrics, method, path, AppSignalsConstants.LATENCY_METRIC, 5000.0);
assertMetricAttributes(metrics, method, path, AppSignalsConstants.ERROR_METRIC, 0.0);
assertMetricAttributes(metrics, method, path, AppSignalsConstants.FAULT_METRIC, 0.0);
}

@Test
public void testFault() {
var path = "fault";
var method = "GET";
var otelStatusCode = "STATUS_CODE_ERROR";
var dbSqlTable = "userrr";
var response = appClient.get(path).aggregate().join();
assertThat(response.status().isServerError()).isTrue();

var traces = mockCollectorClient.getTraces();
assertAwsSpanAttributes(traces, method, path);
assertSemanticConventionsSpanAttributes(traces, otelStatusCode, dbSqlTable);

var metrics =
mockCollectorClient.getMetrics(
Set.of(
AppSignalsConstants.LATENCY_METRIC,
AppSignalsConstants.ERROR_METRIC,
AppSignalsConstants.FAULT_METRIC));
assertMetricAttributes(metrics, method, path, AppSignalsConstants.LATENCY_METRIC, 5000.0);
assertMetricAttributes(metrics, method, path, AppSignalsConstants.ERROR_METRIC, 0.0);
assertMetricAttributes(metrics, method, path, AppSignalsConstants.FAULT_METRIC, 1.0);
}

@Override
protected String getApplicationImageName() {
return "aws-appsignals-tests-jdbc-app";
}

@Override
protected String getApplicationWaitPattern() {
return ".*Application Ready.*";
}

@Override
protected Map<String, String> getApplicationExtraEnvironmentVariables() {
return Map.of(
"DB_URL",
String.format("jdbc:postgresql://%s:5432/%s", NETWORK_ALIAS, DB_NAME),
"DB_DRIVER",
"org.postgresql.Driver",
"DB_USERNAME",
DB_USER,
"DB_PASSWORD",
DB_PASSWORD,
"DB_PLATFORM",
"org.hibernate.dialect.PostgreSQLDialect");
}

@Override
protected List<Startable> getApplicationDependsOnContainers() {
this.postgreSqlContainer =
new PostgreSQLContainer<>("postgres:16.3")
.withImagePullPolicy(PullPolicy.alwaysPull())
.withUsername(DB_USER)
.withPassword(DB_PASSWORD)
.withDatabaseName(DB_NAME)
.withNetworkAliases(NETWORK_ALIAS)
.withNetwork(network)
.waitingFor(
Wait.forLogMessage(".*database system is ready to accept connections.*", 1));
return List.of(postgreSqlContainer);
}

protected void assertAwsSpanAttributes(
List<ResourceScopeSpan> resourceScopeSpans, String method, String path) {
assertThat(resourceScopeSpans)
.satisfiesOnlyOnce(
rss -> {
assertThat(rss.getSpan().getKind()).isEqualTo(SPAN_KIND_CLIENT);
var attributesList = rss.getSpan().getAttributesList();
assertAwsAttributes(attributesList, method, path);
});
}

protected void assertAwsAttributes(
List<KeyValue> attributesList, String method, String endpoint) {
assertThat(attributesList)
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(AppSignalsConstants.AWS_LOCAL_OPERATION);
assertThat(attribute.getValue().getStringValue())
.isEqualTo(String.format("%s /%s", method, endpoint));
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(AppSignalsConstants.AWS_LOCAL_SERVICE);
assertThat(attribute.getValue().getStringValue())
.isEqualTo(getApplicationOtelServiceName());
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(AppSignalsConstants.AWS_REMOTE_SERVICE);
assertThat(attribute.getValue().getStringValue()).isEqualTo(DB_SYSTEM);
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(AppSignalsConstants.AWS_REMOTE_OPERATION);
assertThat(attribute.getValue().getStringValue()).isEqualTo(DB_OPERATION);
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(AppSignalsConstants.AWS_SPAN_KIND);
assertThat(attribute.getValue().getStringValue()).isEqualTo("CLIENT");
});
}

protected void assertSemanticConventionsSpanAttributes(
List<ResourceScopeSpan> resourceScopeSpans, String otelStatusCode, String dbSqlTable) {
assertThat(resourceScopeSpans)
.satisfiesOnlyOnce(
rss -> {
assertThat(rss.getSpan().getKind()).isEqualTo(SPAN_KIND_CLIENT);
assertThat(rss.getSpan().getName())
.isEqualTo(String.format("%s %s.%s", DB_OPERATION, DB_NAME, dbSqlTable));
assertThat(rss.getSpan().getStatus().getCode().equals(otelStatusCode));
var attributesList = rss.getSpan().getAttributesList();
assertSemanticConventionsAttributes(attributesList, dbSqlTable);
});
}

protected void assertSemanticConventionsAttributes(
List<KeyValue> attributesList, String dbSqlTable) {
assertThat(attributesList)
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(SemanticConventionsConstants.THREAD_ID);
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(SemanticConventionsConstants.THREAD_NAME);
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey())
.isEqualTo(SemanticConventionsConstants.DB_CONNECTION_STRING);
assertThat(attribute.getValue().getStringValue())
.isEqualTo(String.format("postgresql://%s:5432", NETWORK_ALIAS));
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(SemanticConventionsConstants.DB_NAME);
assertThat(attribute.getValue().getStringValue()).isEqualTo(DB_NAME);
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(SemanticConventionsConstants.DB_SQL_TABLE);
assertThat(attribute.getValue().getStringValue()).isEqualTo(dbSqlTable);
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(SemanticConventionsConstants.DB_STATEMENT);
assertThat(attribute.getValue().getStringValue())
.isEqualTo(
String.format("%s count(*) from %s", DB_OPERATION.toLowerCase(), dbSqlTable));
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(SemanticConventionsConstants.DB_USER);
assertThat(attribute.getValue().getStringValue()).isEqualTo(DB_USER);
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(SemanticConventionsConstants.DB_OPERATION);
assertThat(attribute.getValue().getStringValue()).isEqualTo(DB_OPERATION);
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey()).isEqualTo(SemanticConventionsConstants.DB_SYSTEM);
assertThat(attribute.getValue().getStringValue()).isEqualTo(DB_SYSTEM);
});
}

protected void assertMetricAttributes(
List<ResourceScopeMetric> resourceScopeMetrics,
String method,
String path,
String metricName,
Double expectedSum) {
assertThat(resourceScopeMetrics)
.anySatisfy(
metric -> {
assertThat(metric.getMetric().getName()).isEqualTo(metricName);
List<ExponentialHistogramDataPoint> dpList =
metric.getMetric().getExponentialHistogram().getDataPointsList();
assertThat(dpList)
.satisfiesOnlyOnce(
dp -> {
List<KeyValue> attributesList = dp.getAttributesList();
assertThat(attributesList).isNotNull();
assertThat(attributesList)
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey())
.isEqualTo(AppSignalsConstants.AWS_SPAN_KIND);
assertThat(attribute.getValue().getStringValue())
.isEqualTo("CLIENT");
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey())
.isEqualTo(AppSignalsConstants.AWS_LOCAL_OPERATION);
assertThat(attribute.getValue().getStringValue())
.isEqualTo(String.format("%s /%s", method, path));
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey())
.isEqualTo(AppSignalsConstants.AWS_LOCAL_SERVICE);
assertThat(attribute.getValue().getStringValue())
.isEqualTo(getApplicationOtelServiceName());
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey())
.isEqualTo(AppSignalsConstants.AWS_REMOTE_SERVICE);
assertThat(attribute.getValue().getStringValue())
.isEqualTo(DB_SYSTEM);
})
.satisfiesOnlyOnce(
attribute -> {
assertThat(attribute.getKey())
.isEqualTo(AppSignalsConstants.AWS_REMOTE_OPERATION);
assertThat(attribute.getValue().getStringValue())
.isEqualTo(DB_OPERATION);
});

if (expectedSum != null) {
double actualSum = dp.getSum();
switch (metricName) {
case AppSignalsConstants.LATENCY_METRIC:
assertThat(actualSum).isStrictlyBetween(0.0, expectedSum);
break;
default:
assertThat(actualSum).isEqualTo(expectedSum);
}
}
});
});
}
}
Loading

0 comments on commit e8f1e8c

Please sign in to comment.