81

In unit test, what are the differences between @Runwith(SpringRunner.class) & @SpringBootTest?

Can you explain to me the use cases of each one?

jonrsharpe
  • 115,751
  • 26
  • 228
  • 437
zouari
  • 967
  • 1
  • 6
  • 13

3 Answers3

112

@RunWith(SpringRunner.class) : You need this annotation to just enable spring boot features like @Autowire, @MockBean etc.. during junit testing

is used to provide a bridge between Spring Boot test features and JUnit. Whenever we are using any Spring Boot testing features in our JUnit tests, this annotation will be required.

@SpringBootTest : This annotation is used to load complete application context for end to end integration testing

The @SpringBootTest annotation can be used when we need to bootstrap the entire container. The annotation works by creating the ApplicationContext that will be utilized in our tests.

Here is the article with clear examples on both scenarios Baeldung

Ryuzaki L
  • 37,302
  • 12
  • 68
  • 98
  • The Baeldung link is one of the best ones explaining the concept, however its dependencies are not correct and hence not working. Although I included all the dependencies in my pom, I get "Class cannot be resolved to a type". – Cagin Uludamar Dec 09 '22 at 05:40
54

@RunWith is an old annotation from JUnit 4 to use test runners. If you're using JUnit 5 (Jupiter), you should use @ExtendWith to use JUnit extensions

See https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-testing

"If you are using JUnit 4, don’t forget to also add @RunWith(SpringRunner.class) to your test, otherwise the annotations will be ignored. If you are using JUnit 5, there’s no need to add the equivalent @ExtendWith(SpringExtension.class) as @SpringBootTest and the other @…Test annotations are already annotated with it.

  • 2
    I just dropped the RunWith annotation when I converted to JUnit 5. Seems to be no need to use ExtendWith either as your quote from the Spring docs makes clear. – Tony B Jul 22 '21 at 15:03
16

From spring.io :

@RunWith(SpringRunner.class) tells JUnit to run using Spring’s testing support. SpringRunner is the new name for SpringJUnit4ClassRunner, it’s just a bit easier on the eye.

@SpringBootTest is saying “bootstrap with Spring Boot’s support” (e.g. load application.properties and give me all the Spring Boot goodness)

So if you don't need everything that Spring Boot loads for your integration test, you may not need @SpringBootTest

Xavier FRANCOIS
  • 652
  • 4
  • 15