正常な在庫照会でだけ使うstubをテストごとに分ける記事のアイキャッチ

設計・テスト・レビュー

MockitoのUnnecessaryStubbingExceptionを直す|使わないstubをテストから外す

倉庫へ在庫を問い合わせる処理に、商品コードが空白なら入力エラーにするテストを追加しました。例外の型とメッセージは期待どおりです。ところがMavenの結果には UnnecessaryStubbingException が出て、空白のテストがエラーになります。ログに出た availableUnits をたどると、例外を確認する行から離れた @BeforeEach の when(...).thenReturn(...) が見つかります。

共通の @BeforeEach で倉庫の応答を設定すると、倉庫へ問い合わせないテストにも、その設定が作られます。この例は、在庫数を返すテストでだけ戻り値を用意し、空白のテストでは「倉庫に一度も問い合わせない」を検証すると直ります。

この記事でわかること

  • 期待した例外が出ていても、Mockitoが後からエラーを出す理由
  • ログに出たメソッド名からstubを探し、テストが通る分岐と照らす手順
  • 必要なstubだけを作り、入力不備で外部へ問い合わせないことを守るテスト

記事と同じコードを実行する

JDK 17とMaven 3.9系で、在庫照会の本体、修正前後のJUnitテスト、pom.xml、モックの設定、READMEを実行・確認できます。通常実行で修正版が動き、-Dtest=SharedStockStubbingSpec を付けると意図したエラーを再現できます。

サンプルZIPをダウンロード GitHubでコード全文と実行手順を見る

空白のテストだけが落ち、ログに未使用のメソッドが出る

倉庫側から在庫数をもらう正常ケースに、外部へ問い合わせず入力エラーを返すケースを加えた場面を再現します。ZIPを展開し、pom.xml のある場所で mvn -Dtest=SharedStockStubbingSpec test を実行します。正常ケースと空白ケースの2件が動き、正常ケースは通ります。空白ケースは期待した IllegalArgumentException を受け取った後、Mockitoの終了時チェックでエラーになります。

共通stubが未使用になったときのログ抜粋

mvn -Dtest=SharedStockStubbingSpec test
[INFO] Running info.syachiku.stock.SharedStockStubbingSpec
[ERROR]   SharedStockStubbingSpec.rejectsBlankWithoutContactingWarehouse » UnnecessaryStubbing
Unnecessary stubbings detected.
  1. -> at jdk.proxy2/jdk.proxy2.$Proxy13.availableUnits(Unknown Source)
[ERROR] Tests run: 2, Failures: 0, Errors: 1, Skipped: 0

ログでは、先にエラーになったテスト名 rejectsBlankWithoutContactingWarehouse を見ます。次に、未使用の一覧に出た availableUnits を見ます。このサンプルのモックはプロキシで作るため、ログに Unknown Source と出ます。その場合はエラーになったテストクラスを開き、warehouse.availableUnits を when に渡している場所を探します。再現版では SharedStockStubbingSpec.setUp の24行目に、SKU-100 を問い合わせたら8個を返す設定があります。

SharedStockStubbingSpec.java(全文)
package info.syachiku.stock;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.when;

@ExtendWith(MockitoExtension.class)
class SharedStockStubbingSpec {
    @Mock
    private StockGateway warehouse;
    private StockInquiryService service;

    @BeforeEach
    void setUp() {
        service = new StockInquiryService(warehouse);
        when(warehouse.availableUnits("SKU-100")).thenReturn(8);
    }

    @Test
    void returnsEightForKnownProduct() {
        assertEquals(8, service.availableUnits("SKU-100"));
        verify(warehouse).availableUnits("SKU-100");
    }

    @Test
    void rejectsBlankWithoutContactingWarehouse() {
        var error = assertThrows(IllegalArgumentException.class,
                () -> service.availableUnits("   "));
        assertEquals("商品コードを入力してください", error.getMessage());
        verifyNoInteractions(warehouse);
    }
}

mvn -Dtest=SharedStockStubbingSpec#returnsEightForKnownProduct test で正常ケースだけを動かすと1件成功します。再現用のクラス名は末尾を Spec にしています。このPOMのSurefire既定パターンでは通常の mvn test に含まれず、通常実行は修正版だけを動かします。-Dtest で再現用クラスを明示したとき、意図したエラーを観察できます。

仕様を「返す結果」と「倉庫に問い合わせるか」に分ける

在庫照会の担当と「商品コードが空白なら倉庫を呼ぶ前に止める」と決めた例です。倉庫への照会は別のシステムを呼ぶ処理です。たとえば入力フォームから空白の問い合わせが繰り返されると、結果を表示できない依頼で倉庫側の処理枠を使います。エラーが返ることと、外部への問い合わせが起きないことを別に確認します。

商品コードServiceの結果倉庫への問い合わせ
SKU-100倉庫が返した8個SKU-100 で1回
空白3文字IllegalArgumentException。「商品コードを入力してください」0回

本体の StockInquiryService.availableUnits は、商品コードが null または空白なら先に例外を投げます。それ以外は StockGateway.availableUnits にコードを渡します。テストでは StockGateway のみモックに置き換え、StockInquiryService は実物を使います。ここで扱うのは表にある正常と空白の2ケースです。

StockInquiryService.java(全文)

package info.syachiku.stock;

public final class StockInquiryService {
    private final StockGateway warehouse;

    public StockInquiryService(StockGateway warehouse) {
        this.warehouse = warehouse;
    }

    public int availableUnits(String productCode) {
        if (productCode == null || productCode.isBlank()) {
            throw new IllegalArgumentException("商品コードを入力してください");
        }
        return warehouse.availableUnits(productCode);
    }
}
StockGateway.java(全文)
package info.syachiku.stock;

public interface StockGateway {
    int availableUnits(String productCode);
}

stubの行と、失敗したテストが通った分岐を照らす

stubは、モックに対して「このメソッドがこの引数で呼ばれたら、こう答える」と用意する設定です。共通 @BeforeEach はテストごとに実行されます。正常のテスト用に作ったstubは正常の呼び出しで使われます。空白のテスト用に作ったstubは、そのテストが先に例外を投げるため使われません。正常のテストで使われた事実は、空白のテストで作り直したstubには引き継がれません。

8個を返す設定は、倉庫まで進むケースでだけ使う
正常SKU-100
Service倉庫に問い合わせる
共通に置いた場合設定した8個が使われる
修正後このテストの中で8個を設定
入力不備空白3文字
Service入力エラーで止まる
共通に置いた場合設定が未使用になりエラー
修正後設定なし。倉庫の呼び出し0回

このサンプルの MockitoExtension はテスト単位で初期化し、テスト終了時に既定の STRICT_STUBS で検査します。今回のエラーは assertThrows の中で投げられる例外とは別です。assertThrows が入力エラーを確認し、テスト本体を抜けた後に、Mockitoが未使用の設定を報告します。Mockito 5.17.0のJUnit 5拡張とStrictnessの公式APIで、この扱いを確認できます。

自分のテストで同じ名前の例外が出たら、ログが指すstubと実際に通るべき分岐を先に比べます。仕様上そこで処理が止まるなら、そのテストにstubは不要です。逆に、倉庫へ問い合わせるはずのケースなら、本体がどの条件で先に戻ったか、実際のコードをstubと同じ引数で渡したかを調べます。Mockitoは引数のずれを別のエラーで知らせる場合もあります。anyString() に広げたり検査を緩めたりする前に、入力と期待した呼び出しが一致するかを確かめます。

関連記事Spring BootのServiceをJUnit・Mockitoでテストする方法|Repositoryをモックする基本 モックを準備し、Serviceの戻り値と依存先への呼び出しをどのように検証するか、Repositoryを例に確認できます。 記事を読む

共通のsetUpに本体の生成を残し、stubを正常ケースへ移す

どちらのテストにも StockInquiryService が必要なので、生成は @BeforeEach に残します。when(warehouse.availableUnits("SKU-100")).thenReturn(8) だけを、倉庫から8個を受け取るテストへ移します。このようにすると、正常ケースを開いたとき、どの入力でどの在庫数が返る前提かをメソッド内で読めます。

StockInquiryServiceTest.java(全文)
package info.syachiku.stock;

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.when;

@ExtendWith(MockitoExtension.class)
class StockInquiryServiceTest {
    @Mock
    private StockGateway warehouse;
    private StockInquiryService service;

    @BeforeEach
    void setUp() {
        service = new StockInquiryService(warehouse);
    }

    @Test
    void returnsEightForKnownProduct() {
        when(warehouse.availableUnits("SKU-100")).thenReturn(8);

        assertEquals(8, service.availableUnits("SKU-100"));
        verify(warehouse).availableUnits("SKU-100");
    }

    @Test
    void rejectsBlankWithoutContactingWarehouse() {
        var error = assertThrows(IllegalArgumentException.class,
                () -> service.availableUnits("   "));
        assertEquals("商品コードを入力してください", error.getMessage());
        verifyNoInteractions(warehouse);
    }
}

正常ケースの assertEquals は8個が返ること、verify(warehouse).availableUnits("SKU-100") はそのコードで1回問い合わせることを確認します。空白ケースの assertThrows は入力エラーを確認し、verifyNoInteractions(warehouse) はこの倉庫のモックに呼び出しが一度もなかったことを確認します。空白ケースでstubを削除するだけでは、後日コードが先に倉庫へ問い合わせても、例外の型とメッセージの検証だけが通る可能性があります。

verifyNoInteractions を付ける根拠は、倉庫を呼ばないことがここでは仕様だからです。実装の中でたまたま呼ばないだけの処理までゼロ回に固定すると、仕様を守る内部変更にもテストが反応します。外部への通信や書き込みが起きないこと自体に意味がある場面で、対象のモックを絞って使います。

修正版で2件成功し、誤って問い合わせる変更は空白のテストが止める

mvn test を実行し、StockInquiryServiceTest の2件が動き、失敗・エラー・スキップがすべて0件であることを確認します。次に修正版の検出力を確かめるため、サンプルを別の場所に展開し、StockInquiryService.java の入力エラーを投げる直前へ warehouse.availableUnits(productCode); を1行だけ足します。入力エラーの型とメッセージを変えていなくても、空白ケースの verifyNoInteractions が失敗します。試し終えたら、その1行を戻します。

修正版と誤って倉庫に問い合わせる変更のログ抜粋

修正版の mvn test
[INFO] Running info.syachiku.stock.StockInquiryServiceTest
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0

入力不備でも倉庫に問い合わせる版の mvn test
[ERROR]   StockInquiryServiceTest.rejectsBlankWithoutContactingWarehouse:39
But found these interactions on mock 'warehouse':
[ERROR] Tests run: 2, Failures: 1, Errors: 0, Skipped: 0

実行環境はJDK 17、Maven 3.9系、JUnit Jupiter 5.12.2、Mockito 5.17.0、Surefire 3.5.3です。ZIPのテスト用リソース mockito-extensions/org.mockito.plugins.MockMaker には mock-maker-proxy を指定しました。対象の StockGateway はインターフェースなので、Javaのプロキシでモックを作るための設定です。MockMakersの公式APIに対象が記載されています。未使用stubの検査設定とは別です。

pom.xml(全文)
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>info.syachiku</groupId>
  <artifactId>mockito-unnecessary-stubbing-sample</artifactId>
  <version>1.0.0</version>
  <properties>
    <maven.compiler.release>17</maven.compiler.release>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <junit.version>5.12.2</junit.version>
    <byte-buddy.version>1.17.8</byte-buddy.version>
  </properties>
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>org.junit</groupId>
        <artifactId>junit-bom</artifactId>
        <version>${junit.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
      <dependency>
        <groupId>net.bytebuddy</groupId>
        <artifactId>byte-buddy</artifactId>
        <version>${byte-buddy.version}</version>
      </dependency>
      <dependency>
        <groupId>net.bytebuddy</groupId>
        <artifactId>byte-buddy-agent</artifactId>
        <version>${byte-buddy.version}</version>
      </dependency>
    </dependencies>
  </dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.mockito</groupId>
      <artifactId>mockito-junit-jupiter</artifactId>
      <version>5.17.0</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>3.3.1</version>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.14.1</version>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>3.5.3</version>
      </plugin>
    </plugins>
  </build>
</project>
org.mockito.plugins.MockMaker(全文)
mock-maker-proxy

レビューでは、共通stubを残す理由と外部呼び出しの期待値を確認する

レビューコメント例「空白では倉庫に問い合わせない仕様なので、このテストに SKU-100 の応答は不要です。8個を使う正常ケースにstubを移し、空白のケースでは倉庫の呼び出しが0回であることを確かめましょう。例外のチェックも残してください。」

複数のテストで同じ応答を使うなら、共通化しても各ケースの前提が見えるかを確認します。正常系が二つあり、入力エラーも同じクラスにあるなら、まず正常系が呼ぶヘルパーにだけ設定を置けます。すべてのテストが同じ応答を必要とするクラスなら、共通の @BeforeEach に残せます。判断材料はstubの行数より、その値を使うテストの範囲です。

古い大きなテストで共通設定をすぐ分けられない場合は、どのstubを例外扱いにするか、その理由をコメントで限定できます。Mockitoの lenient() は特定のstubに適用できます。クラス全体の Strictness.LENIENT は他のstubの未使用や引数のずれを見つける手掛かりにも影響するため、この例のように使う場所が一つに決まっている場合は、stubを移すだけで解決できます。未使用stubに関するMockito公式APIも、例外扱いの範囲を分けて説明しています。

提出前に、外部へ問い合わせるケースと止めるケースを実行する

  • エラーになったテスト名を読み、未使用一覧のメソッド名からstubの設定箇所を確認した。
  • ケースごとに戻り値・例外と、外部呼び出しの有無を決めた。
  • 正常系のstubは、必要なテストからだけ作るようにした。
  • 空白のテストは、入力エラーの型とメッセージに加え、倉庫に問い合わせないことを確認する。
  • 通常実行の件数を見て、直した2件が動いたと確認した。

どの呼び出しをテストで守るべきか迷うなら、『単体テストの考え方/使い方』のモックと壊れやすさを扱う章が参考になります。コード例はC#で、外部との約束として確認する呼び出しと、実装を変えたときまで縛る呼び出しを分けて考えられます。

書籍「単体テストの考え方/使い方」の表紙
商品画像:Amazon.co.jp
PR テストを学ぶ若手向け

単体テストの考え方/使い方

Vladimir Khorikov (著), 須田智之 (翻訳)

単体テストで「何を検証するか」の判断基準を学ぶ。

モックの使いどころや壊れにくいテストの考え方を整理できます。コード例はC#です。JUnitの操作入門ではなく、テストの設計と価値を深める本です。

  • テスト対象の切り分けに迷っている
  • 保守しやすい単体テストを書きたい

当サイトはAmazonアソシエイト・プログラムの参加者です。価格・在庫・配送条件はAmazonでご確認ください。

関連記事テストケースの作り方|仕様・境界値・期待結果をJUnitと対応させる実例 仕様にある入力と期待結果を対応させ、戻り値や処理後の状態をテストに落とし込む手順を学べます。 記事を読む 関連記事JUnit 5入門|Mavenで最初のテストを実行し、失敗を直す JUnitの実行と結果の読み方を確認したいときに、送料計算の成功例と失敗例を比べられます。 記事を読む

まとめ

UnnecessaryStubbingException が出たら、落ちたテストを開き、ログのメソッド名からstubを特定して、そのケースが外部へ問い合わせる仕様か確認します。倉庫を呼ぶケースにだけ応答を用意し、入力不備では例外と呼び出し0回を確認します。通常の mvn test で2件が動いたら、どちらの約束も維持できています。

-設計・テスト・レビュー
-, ,