Skip to content

Commit ba18df8

Browse files
traskAlex Kats
trask
authored and
Alex Kats
committed
Improve database semconv stability test formatting (open-telemetry#12580)
1 parent 61c6eed commit ba18df8

File tree

10 files changed

+85
-177
lines changed

10 files changed

+85
-177
lines changed

‎instrumentation/cassandra/cassandra-3.0/javaagent/src/test/java/CassandraClientTest.java‎

Lines changed: 17 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6+
import static io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil.maybeStable;
67
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
78
import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_PEER_ADDRESS;
89
import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_PEER_PORT;
@@ -22,7 +23,6 @@
2223
import io.opentelemetry.api.trace.SpanKind;
2324
import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
2425
import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
25-
import io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil;
2626
import java.net.InetAddress;
2727
import java.net.InetSocketAddress;
2828
import java.net.UnknownHostException;
@@ -108,9 +108,7 @@ void syncTest(Parameter parameter) {
108108
equalTo(NETWORK_PEER_ADDRESS, cassandraIp),
109109
equalTo(NETWORK_PEER_PORT, cassandraPort),
110110
equalTo(DB_SYSTEM, "cassandra"),
111-
equalTo(
112-
SemconvStabilityUtil.getAttributeKey(DB_STATEMENT),
113-
"USE " + parameter.keyspace))),
111+
equalTo(maybeStable(DB_STATEMENT), "USE " + parameter.keyspace))),
114112
trace ->
115113
trace.hasSpansSatisfyingExactly(
116114
span ->
@@ -124,18 +122,10 @@ void syncTest(Parameter parameter) {
124122
equalTo(NETWORK_PEER_ADDRESS, cassandraIp),
125123
equalTo(NETWORK_PEER_PORT, cassandraPort),
126124
equalTo(DB_SYSTEM, "cassandra"),
127-
equalTo(
128-
SemconvStabilityUtil.getAttributeKey(DB_NAME),
129-
parameter.keyspace),
130-
equalTo(
131-
SemconvStabilityUtil.getAttributeKey(DB_STATEMENT),
132-
parameter.expectedStatement),
133-
equalTo(
134-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
135-
parameter.operation),
136-
equalTo(
137-
SemconvStabilityUtil.getAttributeKey(DB_CASSANDRA_TABLE),
138-
parameter.table))));
125+
equalTo(maybeStable(DB_NAME), parameter.keyspace),
126+
equalTo(maybeStable(DB_STATEMENT), parameter.expectedStatement),
127+
equalTo(maybeStable(DB_OPERATION), parameter.operation),
128+
equalTo(maybeStable(DB_CASSANDRA_TABLE), parameter.table))));
139129
} else {
140130
testing.waitAndAssertTraces(
141131
trace ->
@@ -151,15 +141,9 @@ void syncTest(Parameter parameter) {
151141
equalTo(NETWORK_PEER_ADDRESS, cassandraIp),
152142
equalTo(NETWORK_PEER_PORT, cassandraPort),
153143
equalTo(DB_SYSTEM, "cassandra"),
154-
equalTo(
155-
SemconvStabilityUtil.getAttributeKey(DB_STATEMENT),
156-
parameter.expectedStatement),
157-
equalTo(
158-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
159-
parameter.operation),
160-
equalTo(
161-
SemconvStabilityUtil.getAttributeKey(DB_CASSANDRA_TABLE),
162-
parameter.table))));
144+
equalTo(maybeStable(DB_STATEMENT), parameter.expectedStatement),
145+
equalTo(maybeStable(DB_OPERATION), parameter.operation),
146+
equalTo(maybeStable(DB_CASSANDRA_TABLE), parameter.table))));
163147
}
164148

165149
session.close();
@@ -196,9 +180,7 @@ void asyncTest(Parameter parameter) {
196180
equalTo(NETWORK_PEER_ADDRESS, cassandraIp),
197181
equalTo(NETWORK_PEER_PORT, cassandraPort),
198182
equalTo(DB_SYSTEM, "cassandra"),
199-
equalTo(
200-
SemconvStabilityUtil.getAttributeKey(DB_STATEMENT),
201-
"USE " + parameter.keyspace))),
183+
equalTo(maybeStable(DB_STATEMENT), "USE " + parameter.keyspace))),
202184
trace ->
203185
trace.hasSpansSatisfyingExactly(
204186
span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(),
@@ -213,18 +195,10 @@ void asyncTest(Parameter parameter) {
213195
equalTo(NETWORK_PEER_ADDRESS, cassandraIp),
214196
equalTo(NETWORK_PEER_PORT, cassandraPort),
215197
equalTo(DB_SYSTEM, "cassandra"),
216-
equalTo(
217-
SemconvStabilityUtil.getAttributeKey(DB_NAME),
218-
parameter.keyspace),
219-
equalTo(
220-
SemconvStabilityUtil.getAttributeKey(DB_STATEMENT),
221-
parameter.expectedStatement),
222-
equalTo(
223-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
224-
parameter.operation),
225-
equalTo(
226-
SemconvStabilityUtil.getAttributeKey(DB_CASSANDRA_TABLE),
227-
parameter.table)),
198+
equalTo(maybeStable(DB_NAME), parameter.keyspace),
199+
equalTo(maybeStable(DB_STATEMENT), parameter.expectedStatement),
200+
equalTo(maybeStable(DB_OPERATION), parameter.operation),
201+
equalTo(maybeStable(DB_CASSANDRA_TABLE), parameter.table)),
228202
span ->
229203
span.hasName("callbackListener")
230204
.hasKind(SpanKind.INTERNAL)
@@ -245,15 +219,9 @@ void asyncTest(Parameter parameter) {
245219
equalTo(NETWORK_PEER_ADDRESS, cassandraIp),
246220
equalTo(NETWORK_PEER_PORT, cassandraPort),
247221
equalTo(DB_SYSTEM, "cassandra"),
248-
equalTo(
249-
SemconvStabilityUtil.getAttributeKey(DB_STATEMENT),
250-
parameter.expectedStatement),
251-
equalTo(
252-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
253-
parameter.operation),
254-
equalTo(
255-
SemconvStabilityUtil.getAttributeKey(DB_CASSANDRA_TABLE),
256-
parameter.table)),
222+
equalTo(maybeStable(DB_STATEMENT), parameter.expectedStatement),
223+
equalTo(maybeStable(DB_OPERATION), parameter.operation),
224+
equalTo(maybeStable(DB_CASSANDRA_TABLE), parameter.table)),
257225
span ->
258226
span.hasName("callbackListener")
259227
.hasKind(SpanKind.INTERNAL)

‎instrumentation/cassandra/cassandra-4-common/testing/src/main/java/io/opentelemetry/cassandra/v4/common/AbstractCassandraTest.java‎

Lines changed: 9 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
package io.opentelemetry.cassandra.v4.common;
77

8+
import static io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil.maybeStable;
89
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
910
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies;
1011
import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_PEER_ADDRESS;
@@ -33,7 +34,6 @@
3334
import com.datastax.oss.driver.internal.core.config.typesafe.DefaultDriverConfigLoader;
3435
import io.opentelemetry.api.trace.SpanKind;
3536
import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
36-
import io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil;
3737
import java.net.InetAddress;
3838
import java.net.InetSocketAddress;
3939
import java.net.UnknownHostException;
@@ -113,15 +113,9 @@ void syncTest(Parameter parameter) {
113113
equalTo(NETWORK_PEER_ADDRESS, cassandraIp),
114114
equalTo(NETWORK_PEER_PORT, cassandraPort),
115115
equalTo(DB_SYSTEM, "cassandra"),
116-
equalTo(
117-
SemconvStabilityUtil.getAttributeKey(DB_NAME),
118-
parameter.keyspace),
119-
equalTo(
120-
SemconvStabilityUtil.getAttributeKey(DB_STATEMENT),
121-
parameter.expectedStatement),
122-
equalTo(
123-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
124-
parameter.operation),
116+
equalTo(maybeStable(DB_NAME), parameter.keyspace),
117+
equalTo(maybeStable(DB_STATEMENT), parameter.expectedStatement),
118+
equalTo(maybeStable(DB_OPERATION), parameter.operation),
125119
equalTo(DB_CASSANDRA_CONSISTENCY_LEVEL, "LOCAL_ONE"),
126120
equalTo(DB_CASSANDRA_COORDINATOR_DC, "datacenter1"),
127121
satisfies(
@@ -132,9 +126,7 @@ void syncTest(Parameter parameter) {
132126
val -> val.isInstanceOf(Boolean.class)),
133127
equalTo(DB_CASSANDRA_PAGE_SIZE, 5000),
134128
equalTo(DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT, 0),
135-
equalTo(
136-
SemconvStabilityUtil.getAttributeKey(DB_CASSANDRA_TABLE),
137-
parameter.table))));
129+
equalTo(maybeStable(DB_CASSANDRA_TABLE), parameter.table))));
138130

139131
session.close();
140132
}
@@ -175,15 +167,9 @@ void asyncTest(Parameter parameter) throws Exception {
175167
equalTo(NETWORK_PEER_ADDRESS, cassandraIp),
176168
equalTo(NETWORK_PEER_PORT, cassandraPort),
177169
equalTo(DB_SYSTEM, "cassandra"),
178-
equalTo(
179-
SemconvStabilityUtil.getAttributeKey(DB_NAME),
180-
parameter.keyspace),
181-
equalTo(
182-
SemconvStabilityUtil.getAttributeKey(DB_STATEMENT),
183-
parameter.expectedStatement),
184-
equalTo(
185-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
186-
parameter.operation),
170+
equalTo(maybeStable(DB_NAME), parameter.keyspace),
171+
equalTo(maybeStable(DB_STATEMENT), parameter.expectedStatement),
172+
equalTo(maybeStable(DB_OPERATION), parameter.operation),
187173
equalTo(DB_CASSANDRA_CONSISTENCY_LEVEL, "LOCAL_ONE"),
188174
equalTo(DB_CASSANDRA_COORDINATOR_DC, "datacenter1"),
189175
satisfies(
@@ -194,9 +180,7 @@ void asyncTest(Parameter parameter) throws Exception {
194180
val -> val.isInstanceOf(Boolean.class)),
195181
equalTo(DB_CASSANDRA_PAGE_SIZE, 5000),
196182
equalTo(DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT, 0),
197-
equalTo(
198-
SemconvStabilityUtil.getAttributeKey(DB_CASSANDRA_TABLE),
199-
parameter.table)),
183+
equalTo(maybeStable(DB_CASSANDRA_TABLE), parameter.table)),
200184
span ->
201185
span.hasName("child")
202186
.hasKind(SpanKind.INTERNAL)

‎instrumentation/cassandra/cassandra-4.4/testing/src/main/java/io/opentelemetry/testing/cassandra/v4_4/AbstractCassandra44Test.java‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
package io.opentelemetry.testing.cassandra.v4_4;
77

8+
import static io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil.maybeStable;
89
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
910
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.satisfies;
1011
import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_PEER_ADDRESS;
@@ -29,7 +30,6 @@
2930
import com.datastax.oss.driver.api.core.CqlSession;
3031
import io.opentelemetry.api.trace.SpanKind;
3132
import io.opentelemetry.cassandra.v4.common.AbstractCassandraTest;
32-
import io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil;
3333
import java.util.stream.Stream;
3434
import org.junit.jupiter.params.ParameterizedTest;
3535
import org.junit.jupiter.params.provider.Arguments;
@@ -73,15 +73,9 @@ void reactiveTest(Parameter parameter) {
7373
equalTo(NETWORK_PEER_ADDRESS, cassandraIp),
7474
equalTo(NETWORK_PEER_PORT, cassandraPort),
7575
equalTo(DB_SYSTEM, "cassandra"),
76-
equalTo(
77-
SemconvStabilityUtil.getAttributeKey(DB_NAME),
78-
parameter.keyspace),
79-
equalTo(
80-
SemconvStabilityUtil.getAttributeKey(DB_STATEMENT),
81-
parameter.expectedStatement),
82-
equalTo(
83-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
84-
parameter.operation),
76+
equalTo(maybeStable(DB_NAME), parameter.keyspace),
77+
equalTo(maybeStable(DB_STATEMENT), parameter.expectedStatement),
78+
equalTo(maybeStable(DB_OPERATION), parameter.operation),
8579
equalTo(DB_CASSANDRA_CONSISTENCY_LEVEL, "LOCAL_ONE"),
8680
equalTo(DB_CASSANDRA_COORDINATOR_DC, "datacenter1"),
8781
satisfies(
@@ -92,9 +86,7 @@ void reactiveTest(Parameter parameter) {
9286
val -> val.isInstanceOf(Boolean.class)),
9387
equalTo(DB_CASSANDRA_PAGE_SIZE, 5000),
9488
equalTo(DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT, 0),
95-
equalTo(
96-
SemconvStabilityUtil.getAttributeKey(DB_CASSANDRA_TABLE),
97-
parameter.table)),
89+
equalTo(maybeStable(DB_CASSANDRA_TABLE), parameter.table)),
9890
span ->
9991
span.hasName("child")
10092
.hasKind(SpanKind.INTERNAL)

‎instrumentation/couchbase/couchbase-common/testing/src/main/java/io/opentelemetry/instrumentation/couchbase/AbstractCouchbaseAsyncClientTest.java‎

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
package io.opentelemetry.instrumentation.couchbase;
77

8+
import static io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil.maybeStable;
89
import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo;
910
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_OPERATION;
1011
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_SYSTEM;
@@ -23,7 +24,6 @@
2324
import io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension;
2425
import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
2526
import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
26-
import io.opentelemetry.instrumentation.testing.junit.db.SemconvStabilityUtil;
2727
import io.opentelemetry.semconv.incubating.DbIncubatingAttributes;
2828
import java.util.Collections;
2929
import java.util.concurrent.CompletableFuture;
@@ -93,9 +93,7 @@ void hasBucket(BucketSettings bucketSettings)
9393
equalTo(
9494
DB_SYSTEM,
9595
DbIncubatingAttributes.DbSystemIncubatingValues.COUCHBASE),
96-
equalTo(
97-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
98-
"Cluster.openBucket")),
96+
equalTo(maybeStable(DB_OPERATION), "Cluster.openBucket")),
9997
span ->
10098
assertCouchbaseSpan(span, "ClusterManager.hasBucket")
10199
.hasParent(trace.getSpan(0))));
@@ -136,9 +134,7 @@ void upsert(BucketSettings bucketSettings)
136134
equalTo(
137135
DB_SYSTEM,
138136
DbIncubatingAttributes.DbSystemIncubatingValues.COUCHBASE),
139-
equalTo(
140-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
141-
"Cluster.openBucket")),
137+
equalTo(maybeStable(DB_OPERATION), "Cluster.openBucket")),
142138
span ->
143139
assertCouchbaseSpan(span, "Bucket.upsert", bucketSettings.name())
144140
.hasParent(trace.getSpan(1))));
@@ -186,9 +182,7 @@ void upsertAndGet(BucketSettings bucketSettings)
186182
equalTo(
187183
DB_SYSTEM,
188184
DbIncubatingAttributes.DbSystemIncubatingValues.COUCHBASE),
189-
equalTo(
190-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
191-
"Cluster.openBucket")),
185+
equalTo(maybeStable(DB_OPERATION), "Cluster.openBucket")),
192186
span ->
193187
assertCouchbaseSpan(span, "Bucket.upsert", bucketSettings.name())
194188
.hasParent(trace.getSpan(1)),
@@ -233,9 +227,7 @@ void query() throws ExecutionException, InterruptedException, TimeoutException {
233227
equalTo(
234228
DB_SYSTEM,
235229
DbIncubatingAttributes.DbSystemIncubatingValues.COUCHBASE),
236-
equalTo(
237-
SemconvStabilityUtil.getAttributeKey(DB_OPERATION),
238-
"Cluster.openBucket")),
230+
equalTo(maybeStable(DB_OPERATION), "Cluster.openBucket")),
239231
span ->
240232
assertCouchbaseSpan(
241233
span,

0 commit comments

Comments
 (0)