今さら聞けないMaven - JUnit5のテストクラスがなぜか実行されない

| 5 min read
Author: toshio-ogiwara toshio-ogiwaraの画像

JUnit5のテストクラスをEclipseなどのIDEからは問題なく実行できるのにMavenコマンドから実行するとなぜかテストクラスが検出されず実行されなくなる。そんなお困りの事象と対処方法について今回は説明します。とりあえずどうすればいいかだけ教えて!という方は対処からどうぞ。

今さら聞けないMaven

Mavenが誕生してから早20年ですが、開発で使っていると未だにハマってしまうことやコレってどうやるのだろう?と思うことがあったりします。そんなハマった!できた!こうやった!的な今さら大きな声で聞けない、言えないMavenのあれこれを備忘を兼ねライトに紹介してきたいと思います。

Contents

実行されない症状

#

Eclispseでは問題なく実行できるJUnit5のテストクラスがMavenで実行すると以下のようにrunが0件となりテストが実行されない。
コンソールログ1

アノテーションはJUnit5のorg.junit.jupiter.api.Testを使っていること、dependencyにもJUnit5のjunit-jupiter-engineを指定していることは確認しているが、実行すると次のようなログが出力されSurefireプラグインがなぜかJUni4モードで実行されているように見える。
コンソールログ2

症状の原因

#

Surefireプラグインはクラスパス上に存在するJUnitのライブラリから実行するテストフレームワークのプロバイダーを自動で決定します[1]。コンソールログにUsing auto detected provider org.apache.maven.Surefire.junit4.JUnit4Providerと出力されている場合、その原因はクラスパス上にJUnit4のなんらかのクラスが存在し、それによりSurefireプラグインでJUnit4のプロバイダーが選択され、結果JUnit5のテストモジュールが検出されず1件も実行されないためとなります。

筆者がハマったケースは、テストスイートクラスだけはEclipseのJUnit4のテストランナーで実行する必要があるため、dependencyにJUnitPlatform runnerを追加していたのが原因でした。この原因となったテストスイートとdependencyは次のようなものです。

import org.junit.platform.runner.JUnitPlatform;
import org.junit.platform.suite.api.SelectPackages;
import org.junit.runner.RunWith;

@RunWith(JUnitPlatform.class) // JUnitPlatform runner
@SelectPackages("io.extact.maven.sample")
public class AllTestSuite {
}
<dependencies>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.8.2</version>
<scope>test</scope>
</dependency>
<!-- ↓↓↓ 原因となったdependency ↓↓↓ -->
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-runner</artifactId>
<version>1.8.2</version>
<scope>test</scope>
</dependency>
...
</dependencies>

JUnitPlatform runner(junit-platform-runner)はJUnit5のテストクラスをJUnit4環境で実行できるようにするものです。このため、推移的依存にJUnit4のjunit-4.x.jarを含みます。筆者がハマったケースではこの推移的依存があるために、SurefireプラグインがJUnit4のプロバイダーを誤検出する要因となっていました。

と、原因が分かると、JUnitPlatform runnerをdependencyに含めてるのでJUnit4のランタイムが入るのは当たり前じゃん!と思われるかも知れませんが、言い訳をさせてもらうとクラス名が”Test”で終わらないxxxSuiteクラスはテスト実行の対象とならないため、このクラスがSurefireのテスト実行に副作用を与えるとは思っていませんでした・・

また、それ以前にそもそもテストスイートを実行するのになんでJUnitPlatform runnerを使ってるの?と思われる方は最後のコラムをみていただければと思います。

症状への対処

#

一番本質的な対処方法はJUnit4ライブラリの依存を排除することですが、筆者がそうであったようになんらかの理由により排除することができない場合があると思います。その場合はSurefireプラグインに次のように<dependency>の設定を追加し、強制的にJUnit5のプロバイダーが利用されるようにします。

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.0.0-M7</version>
<!-- ↓↓↓ dependencyを追加する ↓↓↓ -->
<dependencies>
<dependency>
<groupId>org.apache.maven.surefire</groupId>
<artifactId>surefire-junit-platform</artifactId>
<version>3.0.0-M7</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>

これにより次のように常にJUnit5のプロバイダー(JUnitPlatformProvider)が検出されるようになり、JUnit5のテストクラスが実行されるようになります。

コンソールログ3

対処は以上となります。サンプルコードの全量は以下のGitHubに格納してあります。

JUnit5におけるテストスイートの実行

JUnit5でも当然テストスイートの機能はサポートされており、JUnit5ネイティブな機能を使う場合、JUnitPlatform runnerは使わず次のように@Suitejunit-platform-suite-apijunit-platform-suite-engineを使います。

import org.junit.platform.suite.api.SelectPackages;
import org.junit.platform.suite.api.Suite;

@Suite
@SelectPackages("io.extact.maven.sample")
public class AllTestSuite {
}
<dependencies>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
...
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-runner</artifactId>
...
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-suite-api</artifactId>
<version>1.8.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-suite-engine</artifactId>
<version>1.8.2</version>
<scope>test</scope>
</dependency>
...
</dependencies>

が、このようにJUnit5ネイティブでテストスイートを定義した場合、Eclipseはテストモジュールと認識してくれなくなり、コンテキストメニューからのテスト実行ができなくなります(要はEclipseから普通にテストスイートの実行ができなくなります)。この問題に対処するため、筆者はテストスイートだけはJUnitPlatform runnerの機能を使うようにしています。

一方でVSCodeではJUnit5ネイティブなテストスイートを問題なく実行することができるところから、原因は恐らくEclipseのJUnitランナー実装が@Suiteに対応していないためではないかと思います。


参考資料


  1. 公式ドキュメント: Maven Surefire Plugin - Selecting Providers ↩︎

豆蔵デベロッパーサイト - 先週のアクセスランキング
  1. 自然言語処理初心者が「GPT2-japanese」で遊んでみた (2022-07-08)
  2. Tauri でデスクトップアプリ開発を始める (2022-07-08)
  3. Deno による Slack プラットフォーム(オープンベータ) (2022-09-27)
  4. Jest再入門 - 関数・モジュールモック編 (2022-07-03)
  5. ORマッパーのTypeORMをTypeScriptで使う (2022-07-27)
  6. 第1回 OpenAPI Generator を使ったコード生成 (2022-06-04)
  7. 直感が理性に大反抗!「モンティ・ホール問題」 (2022-07-04)
  8. Rust によるデスクトップアプリケーションフレームワーク Tauri (2022-03-06)
  9. 箱ひげ図で外れ値を確認する (2022-05-18)
  10. Nuxt3入門(第1回) - Nuxtがサポートするレンダリングモードを理解する (2022-09-25)