JUnit 5 Maven Dependency

This page shows you how to configure JUnit 5 with maven, its different modules and how to use them to create and execute tests. You can also download the JUnit 5 dependency, the link given at the "Download JAR File" section.

1. JUnit 5 Maven Dependency

To run JUnit 5 tests through maven, you will need a minimum of two dependencies.

JUnit Jupiter Engine Dependency

Copy below JUnit Jupiter Engine maven dependency and paste in your project pom.xml file:

<!-- https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-engine -->
<dependency>
    <groupId>org.junit.jupiter</groupId>
    <artifactId>junit-jupiter-engine</artifactId>
    <version>5.5.2</version>
    <scope>test</scope>
</dependency>

For more details about the proper version to use, check out the following maven link:
https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-engine.

JUnit Platform Runner Dependency

Copy below JUnit Platform Runner dependency and paste in your project pom.xml file:

<!-- https://mvnrepository.com/artifact/org.junit.platform/junit-platform-runner -->
<dependency>
    <groupId>org.junit.platform</groupId>
    <artifactId>junit-platform-runner</artifactId>
    <version>1.5.2</version>
    <scope>test</scope>
</dependency>

For more details about the proper version to use, check out the following maven link:
https://mvnrepository.com/artifact/org.junit.platform/junit-platform-runner

2. Download JAR Files

• JUnit Jupiter Engine - Download JUnit Jupiter Engine.
• JUnit Platform Runner - Download JUnit Platform Runner

3. Check for Latest Release

• https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-engine
• https://mvnrepository.com/artifact/org.junit.platform/junit-platform-runner

4. Reference

• https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-engine
• https://mvnrepository.com/artifact/org.junit.platform/junit-platform-runner

5. Complete pom.xml

A sample pom.xml file for running tests built with JUnit 5 is as follow:

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
        http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.howtodoinjava</groupId>
    <artifactId>JUnit5Examples</artifactId>
 
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
 
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>${maven.compiler.source}</maven.compiler.target>
        <junit.jupiter.version>5.5.2</junit.jupiter.version>
        <junit.platform.version>1.5.2</junit.platform.version>
    </properties>
 
    <dependencies>
        <dependency>
            <groupId>org.junit.jupiter</groupId>
            <artifactId>junit-jupiter-engine</artifactId>
            <version>${junit.jupiter.version}</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.junit.platform</groupId>
            <artifactId>junit-platform-runner</artifactId>
            <version>${junit.platform.version}</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
 
    <build>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
            </plugin>
            <plugin>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.22.2</version>
            </plugin>
        </plugins>
    </build>
</project>