Is there any special configuration to use SpringRunner with junit5?

Question

My micro-service project based on spring-boot framework and all my unit test running with spring runner.

@RunWith(SpringRunner.class)

adding this annotations, imports the following library:

import org.springframework.test.context.junit4.SpringRunner;

How can I set my test classes to run with junit5 ?

Answer 1

Remove JUnit4 from your build Path.

For example :

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
@TestPropertySource(locations = "classpath:application-local.properties")
public class MyTest {
    @Before
    public void setUp() {
        ...
    }

    @Test
    public void testMethod() {
        Assert.assertTrue(...);
    }
}

will become

@SpringBootTest(classes = Application.class)
@TestPropertySource(locations = "classpath:application-local.properties")
public class MyTest {
    @BeforeEach
    public void setUp() {
        ...
    }
    @Test
    public void testMethod() {
       Assertions.assertTrue(...);
    }
}

Answer 2

Using JUnit Jupiter (aka JUnit 5) no longer requires ˋ @RunWith(SpringRunner.class)ˋ since this is a JUnit 4 mechanism. With recent versions of Spring/Spring Boot JUnit 5 support comes out of the box eg through using ˋspring-boot-starter-testˋ.

I recommend to exclude dependencies on JUnit 4 in your Maven/Gradle file to make confusing JUnit 4 and 5 features less likely.

Here’s an article that shows the basics: https://howtodoinjava.com/spring-boot2/testing/junit5-with-spring-boot2/

Answer 3

Spring 2.4 seems to include JUnit 5 and make it the default out of the box.

Besides updating @RunWith(SpringJUnit4ClassRunner.class) to @ExtendWith(SpringExtension.class) I had to add the following to build.gradle for the tests to actually run:

test {
    useJUnitPlatform {}
}

This last step may have been due to JUnit 4 being a dependency of one of my dependencies, but every other thing I read didn't suggest this was needed.