Skip to content

Commit

Permalink
Migrate servicetalk-opentracing-http tests to JUnit 5 (#1568) (#1604)
Browse files Browse the repository at this point in the history 
Motivation:

- JUnit 5 leverages features from Java 8 or later, such as lambda functions, making tests more powerful and easier to maintain.
- JUnit 5 has added some very useful new features for describing, organizing, and executing tests. For instance, tests get better display names and can be organized hierarchically.
- JUnit 5 is organized into multiple libraries, so only the features you need are imported into your project. With build systems such as Maven and Gradle, including the right libraries is easy.
- JUnit 5 can use more than one extension at a time, which JUnit 4 could not (only one runner could be used at a time). This means you can easily combine the Spring extension with other extensions (such as your own custom extension).

Modifications:

- Unit tests have been migrated from JUnit 4 to JUnit 5

Result:

Module servicetalk-opentracing-http now runs tests using JUnit 5
  • Loading branch information
@kashike
kashike authored Jun 3, 2021
1 parent e4e1704 commit 6fd2e31
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 50 deletions.
5 changes: 4 additions & 1 deletion servicetalk-opentracing-http/build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ dependencies {
testImplementation project(":servicetalk-opentracing-log4j2")
testImplementation "org.apache.logging.log4j:log4j-slf4j-impl:$log4jVersion"
testImplementation "org.apache.logging.log4j:log4j-core:$log4jVersion"
testImplementation "junit:junit:$junitVersion"
testImplementation "org.hamcrest:hamcrest-library:$hamcrestVersion"
testImplementation "org.junit.jupiter:junit-jupiter-api:$junit5Version"
testImplementation "org.mockito:mockito-core:$mockitoCoreVersion"
testImplementation "org.mockito:mockito-junit-jupiter:$mockitoCoreVersion"

testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junit5Version"
}
4 changes: 2 additions & 2 deletions servicetalk-opentracing-http/src/test/java/io/servicetalk/opentracing/http/TestUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import javax.annotation.Nullable;

import static io.servicetalk.log4j2.mdc.utils.LoggerStringWriter.assertContainsMdcPair;
import static org.junit.Assert.assertTrue;
import static org.junit.jupiter.api.Assertions.assertTrue;

final class TestUtils {
static final String[] TRACING_TEST_LOG_LINE_PREFIX = new String[] {
Expand Down Expand Up @@ -79,7 +79,7 @@ static void verifyTraceIdPresentInLogs(String logs, String requestPath, String t
break;
}
}
assertTrue("could not find log line with prefix: " + prefix, foundMatch);
assertTrue(foundMatch, "could not find log line with prefix: " + prefix);
}
}

Expand Down
46 changes: 20 additions & 26 deletions ...ng-http/src/test/java/io/servicetalk/opentracing/http/TracingHttpRequesterFilterTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

import io.servicetalk.concurrent.PublisherSource;
import io.servicetalk.concurrent.api.Single;
import io.servicetalk.concurrent.internal.ServiceTalkTestTimeout;
import io.servicetalk.data.jackson.JacksonSerializationProvider;
import io.servicetalk.http.api.FilterableStreamingHttpClient;
import io.servicetalk.http.api.HttpClient;
Expand All @@ -39,13 +38,12 @@

import io.opentracing.Scope;
import io.opentracing.Tracer;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.rules.Timeout;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -80,40 +78,36 @@
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.equalToIgnoringCase;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.rules.ExpectedException.none;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
import static org.mockito.MockitoAnnotations.initMocks;

public class TracingHttpRequesterFilterTest {
@ExtendWith(MockitoExtension.class)
class TracingHttpRequesterFilterTest {
private static final Logger LOGGER = LoggerFactory.getLogger(TracingHttpRequesterFilterTest.class);
private static final HttpSerializationProvider httpSerializer = jsonSerializer(new JacksonSerializationProvider());

@Rule
public final Timeout timeout = new ServiceTalkTestTimeout();
@Rule
public final ExpectedException expected = none();

@Mock
private Tracer mockTracer;

@Before
@BeforeEach
public void setup() {
initMocks(this);
LoggerStringWriter.reset();
}

@After
@AfterEach
public void tearDown() {
LoggerStringWriter.remove();
}

@Test
public void testInjectWithNoParent() throws Exception {
void testInjectWithNoParent() throws Exception {
final String requestUrl = "/";
CountingInMemorySpanEventListener spanListener = new CountingInMemorySpanEventListener();
DefaultInMemoryTracer tracer = new DefaultInMemoryTracer.Builder(SCOPE_MANAGER)
Expand Down Expand Up @@ -149,7 +143,7 @@ public void testInjectWithNoParent() throws Exception {
}

@Test
public void testInjectWithParent() throws Exception {
void testInjectWithParent() throws Exception {
final String requestUrl = "/foo";
CountingInMemorySpanEventListener spanListener = new CountingInMemorySpanEventListener();
DefaultInMemoryTracer tracer = new DefaultInMemoryTracer.Builder(SCOPE_MANAGER)
Expand Down Expand Up @@ -193,16 +187,16 @@ public void testInjectWithParent() throws Exception {
}

@Test
public void tracerThrowsReturnsErrorResponse() throws Exception {
void tracerThrowsReturnsErrorResponse() throws Exception {
when(mockTracer.buildSpan(any())).thenThrow(DELIBERATE_EXCEPTION);
try (ServerContext context = buildServer()) {
try (HttpClient client = forSingleAddress(serverHostAndPort(context))
.appendConnectionFilter(
new TracingHttpRequesterFilter(mockTracer, "testClient")).build()) {
HttpRequest request = client.get("/");
expected.expect(ExecutionException.class);
expected.expectCause(is(DELIBERATE_EXCEPTION));
client.request(request).toFuture().get();
ExecutionException ex = assertThrows(ExecutionException.class,
() -> client.request(request).toFuture().get());
assertThat(ex.getCause(), is(DELIBERATE_EXCEPTION));
}
}
}
Expand Down
39 changes: 18 additions & 21 deletions ...cing-http/src/test/java/io/servicetalk/opentracing/http/TracingHttpServiceFilterTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

import io.servicetalk.concurrent.PublisherSource;
import io.servicetalk.concurrent.api.Single;
import io.servicetalk.concurrent.internal.ServiceTalkTestTimeout;
import io.servicetalk.data.jackson.JacksonSerializationProvider;
import io.servicetalk.http.api.HttpClient;
import io.servicetalk.http.api.HttpRequest;
Expand All @@ -38,12 +37,12 @@
import io.servicetalk.transport.api.ServerContext;

import io.opentracing.Tracer;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.Timeout;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -81,32 +80,30 @@
import static org.hamcrest.Matchers.equalToIgnoringCase;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.not;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
import static org.mockito.MockitoAnnotations.initMocks;

public class TracingHttpServiceFilterTest {
@ExtendWith(MockitoExtension.class)
class TracingHttpServiceFilterTest {
private static final Logger LOGGER = LoggerFactory.getLogger(TracingHttpServiceFilterTest.class);
private static final HttpSerializationProvider httpSerializer = jsonSerializer(new JacksonSerializationProvider());

@Rule
public final Timeout timeout = new ServiceTalkTestTimeout();

@Mock
private Tracer mockTracer;

@Before
@BeforeEach
public void setup() {
initMocks(this);
LoggerStringWriter.reset();
}

@After
@AfterEach
public void tearDown() {
LoggerStringWriter.remove();
}
Expand Down Expand Up @@ -134,7 +131,7 @@ private static ServerContext buildServer(CountingInMemorySpanEventListener spanL
}

@Test
public void testRequestWithTraceKey() throws Exception {
void testRequestWithTraceKey() throws Exception {
CountingInMemorySpanEventListener spanListener = new CountingInMemorySpanEventListener();
try (ServerContext context = buildServer(spanListener)) {
try (HttpClient client = forSingleAddress(serverHostAndPort(context)).build()) {
Expand Down Expand Up @@ -167,7 +164,7 @@ public void testRequestWithTraceKey() throws Exception {
}

@Test
public void testRequestWithoutTraceKey() throws Exception {
void testRequestWithoutTraceKey() throws Exception {
final String requestUrl = "/foo";
CountingInMemorySpanEventListener spanListener = new CountingInMemorySpanEventListener();
try (ServerContext context = buildServer(spanListener)) {
Expand Down Expand Up @@ -198,7 +195,7 @@ public void testRequestWithoutTraceKey() throws Exception {
}

@Test
public void tracerThrowsReturnsErrorResponse() throws Exception {
void tracerThrowsReturnsErrorResponse() throws Exception {
when(mockTracer.buildSpan(any())).thenThrow(DELIBERATE_EXCEPTION);
try (ServerContext context = HttpServers.forAddress(localAddress(0))
.appendServiceFilter(new TracingHttpServiceFilter(mockTracer, "testServer"))
Expand All @@ -212,7 +209,7 @@ public void tracerThrowsReturnsErrorResponse() throws Exception {
}

@Test
public void verifyAsyncContext() throws Exception {
void verifyAsyncContext() throws Exception {
final DefaultInMemoryTracer tracer = new DefaultInMemoryTracer.Builder(SCOPE_MANAGER).build();
verifyServerFilterAsyncContextVisibility(new TracingHttpServiceFilter(tracer, "testServer"));
}
Expand Down

0 comments on commit 6fd2e31

Please sign in to comment.