{"id":98651,"date":"2019-09-26T13:00:15","date_gmt":"2019-09-26T10:00:15","guid":{"rendered":"https:\/\/www.javacodegeeks.com\/?p=98651"},"modified":"2019-09-25T12:24:39","modified_gmt":"2019-09-25T09:24:39","slug":"spring-boot-testing-junit-5","status":"publish","type":"post","link":"https:\/\/www.javacodegeeks.com\/2019\/09\/spring-boot-testing-junit-5.html","title":{"rendered":"Spring Boot testing with JUnit 5"},"content":{"rendered":"

JUnit 5<\/code> (JUnit Jupiter) is around for quite some time already and it is equipped with tons of features. But surprisingly JUnit 5<\/code> it is not a default test library dependency when it comes to the Spring Boot Test Starter: it is still<\/em> JUnit 4.12<\/code>, released back in 2014. If you consider using JUnit 5<\/code> in you next Spring Boot based project then this blog post is for you. You will learn about the basic setup for Gradle<\/code> and Maven<\/code> based projects with examples of Spring Boot tests for different use cases.<\/p>\n

Source code<\/h2>\n

The source code for this article can be found on Github: https:\/\/github.com\/kolorobot\/spring-boot-junit5<\/a>.<\/p>\n

Setup the project from the ground up<\/h2>\n

For the project setup you will need JDK 11 or later and Gradle or Maven (depending on your preference). The easiest way to get started with Spring Boot is to use the Initializr at https:\/\/start.spring.io<\/a>. The only dependencies to select is Spring Web<\/code>. Testing dependencies (Spring Boot Starter Test<\/code>) are always included, no matter what dependencies you use in the generated project.<\/p>\n

Build with Gradle<\/h3>\n

The default project file for Gradle build (gradle.build<\/code>) generated with Initializr<\/code>:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n<\/td>\n
\n
\n
plugins {<\/code><\/div>\n
    <\/code>id <\/code>'org.springframework.boot'<\/code> version <\/code>'2.1.8.RELEASE'<\/code><\/div>\n
    <\/code>id <\/code>'io.spring.dependency-management'<\/code> version <\/code>'1.0.8.RELEASE'<\/code><\/div>\n
    <\/code>id <\/code>'java'<\/code><\/div>\n
}<\/code><\/div>\n
 <\/div>\n
group = <\/code>'pl.codeleak.samples'<\/code><\/div>\n
version = <\/code>'0.0.1-SNAPSHOT'<\/code><\/div>\n
sourceCompatibility = <\/code>'11'<\/code><\/div>\n
 <\/div>\n
repositories {<\/code><\/div>\n
    <\/code>mavenCentral()<\/code><\/div>\n
}<\/code><\/div>\n
 <\/div>\n
dependencies {<\/code><\/div>\n
    <\/code>implementation <\/code>'org.springframework.boot:spring-boot-starter-web'<\/code><\/div>\n
    <\/code>testImplementation <\/code>'org.springframework.boot:spring-boot-starter-test'<\/code><\/div>\n
}<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

To add JUnit 5<\/code> support we need to exclude the old JUnit 4<\/code> dependency and include JUnit 5<\/code> (JUnit Jupiter) dependency:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n<\/td>\n
\n
\n
dependencies {<\/code><\/div>\n
    <\/code>implementation <\/code>'org.springframework.boot:spring-boot-starter-web'<\/code><\/div>\n
    <\/code>testImplementation(<\/code>'org.springframework.boot:spring-boot-starter-test'<\/code>) {<\/code><\/div>\n
        <\/code>exclude group: <\/code>'junit'<\/code>, module: <\/code>'junit'<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
    <\/code>testCompile <\/code>'org.junit.jupiter:junit-jupiter:5.5.2'<\/code><\/div>\n
}<\/code><\/div>\n
 <\/div>\n
test {<\/code><\/div>\n
    <\/code>useJUnitPlatform()<\/code><\/div>\n
    <\/code>testLogging {<\/code><\/div>\n
        <\/code>events <\/code>\"passed\"<\/code>, <\/code>\"skipped\"<\/code>, <\/code>\"failed\"<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
}<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Build with Maven<\/h3>\n

The default project file for Maven build (pom.xml<\/code>) generated with Initializr<\/code>:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n
24<\/div>\n
25<\/div>\n
26<\/div>\n
27<\/div>\n
28<\/div>\n
29<\/div>\n
30<\/div>\n
31<\/div>\n
32<\/div>\n
33<\/div>\n
34<\/div>\n
35<\/div>\n
36<\/div>\n
37<\/div>\n
38<\/div>\n
39<\/div>\n
40<\/div>\n
41<\/div>\n<\/td>\n
\n
\n
<?<\/code>xml<\/code> version<\/code>=<\/code>\"1.0\"<\/code> encoding<\/code>=<\/code>\"UTF-8\"<\/code>?><\/code><\/div>\n
<<\/code>project<\/code>><\/code><\/div>\n
    <\/code><<\/code>modelVersion<\/code>>4.0.0<\/<\/code>modelVersion<\/code>><\/code><\/div>\n
    <\/code><<\/code>parent<\/code>><\/code><\/div>\n
        <\/code><<\/code>groupId<\/code>>org.springframework.boot<\/<\/code>groupId<\/code>><\/code><\/div>\n
        <\/code><<\/code>artifactId<\/code>>spring-boot-starter-parent<\/<\/code>artifactId<\/code>><\/code><\/div>\n
        <\/code><<\/code>version<\/code>>2.1.8.RELEASE<\/<\/code>version<\/code>><\/code><\/div>\n
        <\/code><<\/code>relativePath<\/code>\/> <\/code><!-- lookup parent from repository --><\/code><\/div>\n
    <\/code><\/<\/code>parent<\/code>><\/code><\/div>\n
    <\/code><<\/code>groupId<\/code>>pl.codeleak.samples<\/<\/code>groupId<\/code>><\/code><\/div>\n
    <\/code><<\/code>artifactId<\/code>>spring-boot-junit5<\/<\/code>artifactId<\/code>><\/code><\/div>\n
    <\/code><<\/code>version<\/code>>0.0.1-SNAPSHOT<\/<\/code>version<\/code>><\/code><\/div>\n
    <\/code><<\/code>name<\/code>>spring-boot-junit5<\/<\/code>name<\/code>><\/code><\/div>\n
    <\/code><<\/code>description<\/code>>Demo project for Spring Boot and JUnit 5<\/<\/code>description<\/code>><\/code><\/div>\n
 <\/div>\n
    <\/code><<\/code>properties<\/code>><\/code><\/div>\n
        <\/code><<\/code>project.build.sourceEncoding<\/code>>UTF-8<\/<\/code>project.build.sourceEncoding<\/code>><\/code><\/div>\n
        <\/code><<\/code>java.version<\/code>>11<\/<\/code>java.version<\/code>><\/code><\/div>\n
    <\/code><\/<\/code>properties<\/code>><\/code><\/div>\n
 <\/div>\n
    <\/code><<\/code>dependencies<\/code>><\/code><\/div>\n
        <\/code><<\/code>dependency<\/code>><\/code><\/div>\n
            <\/code><<\/code>groupId<\/code>>org.springframework.boot<\/<\/code>groupId<\/code>><\/code><\/div>\n
            <\/code><<\/code>artifactId<\/code>>spring-boot-starter-web<\/<\/code>artifactId<\/code>><\/code><\/div>\n
        <\/code><\/<\/code>dependency<\/code>><\/code><\/div>\n
        <\/code><<\/code>dependency<\/code>><\/code><\/div>\n
            <\/code><<\/code>groupId<\/code>>org.springframework.boot<\/<\/code>groupId<\/code>><\/code><\/div>\n
            <\/code><<\/code>artifactId<\/code>>spring-boot-starter-test<\/<\/code>artifactId<\/code>><\/code><\/div>\n
            <\/code><<\/code>scope<\/code>>test<\/<\/code>scope<\/code>>  <\/code><\/div>\n
        <\/code><\/<\/code>dependency<\/code>><\/code><\/div>\n
    <\/code><\/<\/code>dependencies<\/code>><\/code><\/div>\n
 <\/div>\n
    <\/code><<\/code>build<\/code>><\/code><\/div>\n
        <\/code><<\/code>plugins<\/code>><\/code><\/div>\n
            <\/code><<\/code>plugin<\/code>><\/code><\/div>\n
                <\/code><<\/code>groupId<\/code>>org.springframework.boot<\/<\/code>groupId<\/code>><\/code><\/div>\n
                <\/code><<\/code>artifactId<\/code>>spring-boot-maven-plugin<\/<\/code>artifactId<\/code>><\/code><\/div>\n
            <\/code><\/<\/code>plugin<\/code>><\/code><\/div>\n
        <\/code><\/<\/code>plugins<\/code>><\/code><\/div>\n
    <\/code><\/<\/code>build<\/code>><\/code><\/div>\n
<\/<\/code>project<\/code>><\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

To add JUnit 5<\/code> support we need to exclude the old JUnit 4<\/code> dependency and include JUnit 5<\/code> (JUnit Jupiter) dependency:<\/p>\n

\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n
15<\/div>\n
16<\/div>\n
17<\/div>\n
18<\/div>\n
19<\/div>\n
20<\/div>\n
21<\/div>\n
22<\/div>\n
23<\/div>\n
24<\/div>\n
25<\/div>\n
26<\/div>\n
27<\/div>\n<\/td>\n
\n
\n
<<\/code>properties<\/code>><\/code><\/div>\n
    <\/code><<\/code>junit.jupiter.version<\/code>>5.5.2<\/<\/code>junit.jupiter.version<\/code>><\/code><\/div>\n
<\/<\/code>properties<\/code>><\/code><\/div>\n
 <\/div>\n
<<\/code>dependencies<\/code>><\/code><\/div>\n
    <\/code><<\/code>dependency<\/code>><\/code><\/div>\n
        <\/code><<\/code>groupId<\/code>>org.springframework.boot<\/<\/code>groupId<\/code>><\/code><\/div>\n
        <\/code><<\/code>artifactId<\/code>>spring-boot-starter-web<\/<\/code>artifactId<\/code>><\/code><\/div>\n
    <\/code><\/<\/code>dependency<\/code>><\/code><\/div>\n
    <\/code><<\/code>dependency<\/code>><\/code><\/div>\n
        <\/code><<\/code>groupId<\/code>>org.springframework.boot<\/<\/code>groupId<\/code>><\/code><\/div>\n
        <\/code><<\/code>artifactId<\/code>>spring-boot-starter-test<\/<\/code>artifactId<\/code>><\/code><\/div>\n
        <\/code><<\/code>scope<\/code>>test<\/<\/code>scope<\/code>><\/code><\/div>\n
        <\/code><<\/code>exclusions<\/code>><\/code><\/div>\n
            <\/code><<\/code>exclusion<\/code>><\/code><\/div>\n
                <\/code><<\/code>groupId<\/code>>junit<\/<\/code>groupId<\/code>><\/code><\/div>\n
                <\/code><<\/code>artifactId<\/code>>junit<\/<\/code>artifactId<\/code>><\/code><\/div>\n
            <\/code><\/<\/code>exclusion<\/code>><\/code><\/div>\n
        <\/code><\/<\/code>exclusions<\/code>><\/code><\/div>\n
    <\/code><\/<\/code>dependency<\/code>><\/code><\/div>\n
    <\/code><<\/code>dependency<\/code>><\/code><\/div>\n
        <\/code><<\/code>groupId<\/code>>org.junit.jupiter<\/<\/code>groupId<\/code>><\/code><\/div>\n
        <\/code><<\/code>artifactId<\/code>>junit-jupiter<\/<\/code>artifactId<\/code>><\/code><\/div>\n
        <\/code><<\/code>version<\/code>>${junit.jupiter.version}<\/<\/code>version<\/code>><\/code><\/div>\n
        <\/code><<\/code>scope<\/code>>test<\/<\/code>scope<\/code>><\/code><\/div>\n
    <\/code><\/<\/code>dependency<\/code>><\/code><\/div>\n
<\/<\/code>dependencies<\/code>><\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Use JUnit 5 in the test class<\/h3>\n

The test generated by the Initializr<\/code> contains automatically generated JUnit 4<\/code> test. To apply JUnit 5<\/code> we need to change the imports and replace the JUnit 4<\/code> runner by the JUnit 5<\/code> extension. We can also make the class and the test method package protected:

<\/div> <\/div><\/p>\n
\n
\n\n\n\n
\n
01<\/div>\n
02<\/div>\n
03<\/div>\n
04<\/div>\n
05<\/div>\n
06<\/div>\n
07<\/div>\n
08<\/div>\n
09<\/div>\n
10<\/div>\n
11<\/div>\n
12<\/div>\n
13<\/div>\n
14<\/div>\n<\/td>\n
\n
\n
import<\/code> org.junit.jupiter.api.Test;<\/code><\/div>\n
import<\/code> org.junit.jupiter.api.extension.ExtendWith;<\/code><\/div>\n
import<\/code> org.springframework.boot.test.context.SpringBootTest;<\/code><\/div>\n
import<\/code> org.springframework.test.context.junit.jupiter.SpringExtension;<\/code><\/div>\n
 <\/div>\n
@ExtendWith<\/code>(SpringExtension.<\/code>class<\/code>)<\/code><\/div>\n
@SpringBootTest<\/code><\/div>\n
class<\/code> SpringBootJunit5ApplicationTests {<\/code><\/div>\n
 <\/div>\n
    <\/code>@Test<\/code><\/div>\n
    <\/code>void<\/code> contextLoads() {<\/code><\/div>\n
    <\/code>}<\/code><\/div>\n
 <\/div>\n
}<\/code><\/div>\n<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n<\/div>\n

Tip: If you are new to JUnit 5 see my other posts about JUnit 5: https:\/\/blog.codeleak.pl\/search\/label\/junit 5<\/a><\/p>\n

Run the test<\/h3>\n

We can run the test either with Maven Wrapper<\/code>: .\/mvnw clean test<\/code> or with Gradle Wrapper<\/code>: .\/gradlew clean test<\/code>.<\/p>\n

Source code<\/h3>\n

Please consult this commit<\/a> for the changes related to the project setup.<\/p>\n

Sample application with a single REST controller<\/h2>\n

The sample application is containing a single REST controller with three endpoints:<\/p>\n