JUnit5のApache Mavenでの利用手順

2021年3月2日

step1JUnit5のサイトにアクセス

JUnitとは、オープンソースのJava言語での開発でよく用いられるテストフレームワークです。JUnit5ではJDK8以上をサポートしています。

2021年2月現在の最新バージョンは「5.7.1」です。

必要に応じてドキュメントを参照してください。

JUnit5：https://junit.org/junit5/

step2Mavenのフォルダ構成（簡易版）

Mavenの簡易ディレクトリ構成は以下になります。そのほかにもありますが、ここでは必要最小限のものを紹介します。

sampleProject
├── pom.xml
└── src
  ├── main
  │ ├── filters
  │ ├── java
  │ ├── resources
  │ └── webapp
  └── test
    ├── filters
    ├── java
    └── resources

ファイル・フォルダ名	説明
pom.xml	プロジェクトの構成情報を管理するファイル
src/main/java	ソースファイルを配置するフォルダ
src/main/resources	プロパティファイルを配置するフォルダ
src/main/filters	プロパティに適用するフィルターを配置するフォルダ
src/main/webapp	Webアプリ用のファイルを配置するフォルダ
src/test/java	テスト用のソースコードを配置するフォルダ
src/test/resources	テスト用のプロパティファイルを配置するフォルダ
src/test/filters	テスト用のプロパティに適用するファイルを配置するフォルダ

step3MavenでのJUnit5の利用手順

Mavenを利用したJavaプロジェクトを作成します。ここではターミナルを使用した方法を紹介しますが、Finderから実行してもらっても構いません。

（Mavenを用意されていない場合はMavenのインストールを以下のサイトから行ってください。）

https://devnote.jp/maven

本サイトでは最小構成での手順紹介のため、適当なディレクトリで以下のコマンドを実行してください。

mkdir sampleProject

cd sampleProject

touch pom.xml

mkdir -p src/main/java

mkdir -p src/test/java

以下のコマンドでプロジェクト作成することも可能です。

参考

mvn archetype:generate

step4pom.xmlへの記述

pom.xmlに以下のように記述します。(必要に応じて追記等してください。)

pom.xmlの例

<project>  
<modelVersion>4.0.0</modelVersion>

<groupId>jp.miyabilink.sukkiri</groupId>
<artifactId>sukkiri-test</artifactId>
<version>1.0.0</version>

<properties>
  <maven.compiler.target>11</maven.compiler.target>
  <maven.compiler.source>11</maven.compiler.source>
</properties>

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-surefire-plugin</artifactId>
      <version>3.0.0-M5</version>
    </plugin>
  </plugins>
</build>

<dependencies>  
<dependency>  
<groupId>org.junit.jupiter</groupId>  
<artifactId>junit-jupiter-engine</artifactId>  
<version>5.7.1</version>  
<scope>test</scope>  
</dependency>  
<dependency>  
<groupId>org.junit.jupiter</groupId>  
<artifactId>junit-jupiter-api</artifactId>  
<version>5.7.1</version>  
<scope>test</scope>  
</dependency>  
</dependencies>  
</project>

そして、ソースファイルをsrc/main/javaにテスト用のソースファイルをsrc/test/javaに配置します。

以下のコマンドを実行するとテストが実行できます。

mvn test

JUnit

JUnit5のApache Mavenでの利用手順

step1JUnit5のサイトにアクセス

step2Mavenのフォルダ構成（簡易版）

step3MavenでのJUnit5の利用手順

step4pom.xmlへの記述

関連記事

JUnit5のeclipseでの利用手順

JUnit4のインストール手順