Skip to content

Commit 37741ac

Browse files
committed
Prefer OpenTelemetryAssertions.assertThat over dual static imports
OpenTelemetryAssertions extends org.assertj.core.api.Assertions, so all AssertJ assertThat overloads are already in scope via inheritance when OpenTelemetryAssertions.assertThat is statically imported. Importing both makes call sites harder to read and can become ambiguous if overloads overlap. Add a style-guide note and remove the redundant Assertions.assertThat static import from the three files currently doing both.
1 parent dfc6acc commit 37741ac

4 files changed

Lines changed: 4 additions & 3 deletions

File tree

docs/contributing/style-guide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,10 @@ affect end users.
203203
Prefer AssertJ assertions over JUnit assertions (assertEquals, assertTrue, etc.) for better
204204
error messages.
205205

206+
In test files that use `io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.assertThat`,
207+
do not also statically import `org.assertj.core.api.Assertions.assertThat``OpenTelemetryAssertions`
208+
extends `Assertions`, so all AssertJ `assertThat` overloads are already in scope via inheritance.
209+
206210
### JUnit
207211

208212
Test classes and test methods should generally be package-protected (no explicit visibility

instrumentation/kubernetes-client-7.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/kubernetesclient/v7_0/KubernetesClientTest.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
import static io.opentelemetry.semconv.ServerAttributes.SERVER_PORT;
1818
import static io.opentelemetry.semconv.UrlAttributes.URL_FULL;
1919
import static java.util.concurrent.TimeUnit.SECONDS;
20-
import static org.assertj.core.api.Assertions.assertThat;
2120

2221
import io.kubernetes.client.openapi.ApiCallback;
2322
import io.kubernetes.client.openapi.ApiClient;

instrumentation/kubernetes-client-7.0/javaagent/src/version20Test/java/io/opentelemetry/javaagent/instrumentation/kubernetesclient/v7_0/KubernetesClientVer20Test.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
import static io.opentelemetry.semconv.ServerAttributes.SERVER_PORT;
1818
import static io.opentelemetry.semconv.UrlAttributes.URL_FULL;
1919
import static java.util.concurrent.TimeUnit.SECONDS;
20-
import static org.assertj.core.api.Assertions.assertThat;
2120

2221
import io.kubernetes.client.openapi.ApiCallback;
2322
import io.kubernetes.client.openapi.ApiClient;

testing-common/src/main/java/io/opentelemetry/instrumentation/testing/junit/http/AbstractHttpServerTest.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@
4242
import static java.nio.charset.StandardCharsets.US_ASCII;
4343
import static java.util.Collections.singletonList;
4444
import static java.util.concurrent.TimeUnit.SECONDS;
45-
import static org.assertj.core.api.Assertions.assertThat;
4645
import static org.junit.jupiter.api.Assumptions.assumeFalse;
4746
import static org.junit.jupiter.api.Assumptions.assumeTrue;
4847

0 commit comments

Comments
 (0)