👩‍💻

#160 Mockitoでチェーンメソッドをモックする際のNullPointerException対策

に公開

はじめに

Mockitoは、Javaのユニットテストにおいて依存関係をモック化し、簡潔にテスト対象の振る舞いを検証できる便利なライブラリです。しかし、Mockitoを使用してrequestをモックする際に、request.getSession().getAttribute()などから値を取り出した際の動作を決めようとするとNullPointerExceptionが生じることがあります。
調べてみると、Mockitoではチェーンメソッドをそのままスタブ化するとうまく動作しないことがあるようです。このようなケースの原因と解決策について整理してみました。

モックがnullを返す例と原因

たとえば、この簡易なUserServiceクラスをテストしたいとします。

UserService.java
public class UserService {

  public String getUserName(HttpServletRequest request) {
    HttpSession session = request.getSession();
    String userName = (String) session.getAttribute("userName");
    // もしセッションにユーザ名が設定されていなければゲスト扱いにする
    if (userName == null) {
      userName = "ゲスト";
    }
    return userName;
  }

  public void setUserName(HttpServletRequest request, String userName) {
    HttpSession session = request.getSession();
    session.setAttribute("userName", userName);
  }
}

以下はチェーンメソッド部分で例外が生じるパターンの例です。

UserServiceTest.java
  // 途中でNullになっているテスト
  @Test
  public void testGetUserNameChain() {
    // リクエストをモックする
    HttpServletRequest request = mock(HttpServletRequest.class);
        
    //リクエストからユーザー名を取り出す動作の値を定義したいがエラーになる
    when(request.getSession().getAttribute("userName")).thenReturn("こむぎ"); // →NullPointerException発生
        
    // UserServiceのインスタンスを作成
    UserService userService = new UserService();
    String userName = userService.getUserName(request);
        
    assertEquals("こむぎ", userName);
  }

この状態でテストを実行すると、java.lang.NullPointerExceptionのエラーメッセージが表示されます。

Mockitoでは、チェーンメソッドによるスタブ設定において、各呼び出し先のオブジェクトを自動的にモック化してくれません。上記の例だと、requestをモックしてもgetSession()の戻り値は自動的にはモックされないので、以下のような動作になっています。

  1. まず、request.getSession() を呼び出します。この呼び出しの戻り値はrequestに紐づくsessionオブジェクトの値となるはずですが、sessionは特にモックされていないので、デフォルト値としてnullが返されます。

  2. 1の戻り値がnullだったので、request.getSession().getAttribute(userName) はnull.getAttribute(userName)になります。nullに対してメソッド呼び出しが行われることになるので、NullPointerExceptionが発生します。

チェーンメソッドを正しくスタブ化する方法

mockitoのモック使用時はチェーンの各段階ごとに個別のモックを設定する必要があります。
先ほどまでの例では、チェーンメソッドの途中であるgetSession()のモック化が抜けているために戻り値がnullになってしまっています。中間オブジェクトであるHttpSessionを個別にモックして、request.getSession()の戻り値として定義することで、チェーン全体の呼び出しが正常に行えるようになります。

例えば、以下のように段階に分けてモックします。

UserServiceTest.java
  @Test
  public void testGetUserNameWithSession() {
        // リクエストをモックする
    HttpServletRequest request = mock(HttpServletRequest.class);
    // HttpSessionオブジェクトをモック(これが必要)
    HttpSession session = mock(HttpSession.class);
        
    // チェーンメソッドを分解する
    // request.getSession()の戻り値にHttpSessionのモックを使用
    when(request.getSession()).thenReturn(session);
    // 上記のセッションの戻り値を使って名前を取り出す処理をスタブ化
    when(session.getAttribute("userName")).thenReturn("こむぎ");
        
    // UserServiceのインスタンスを作成
    UserService userService = new UserService();
    String userName = userService.getUserName(request);
        
    assertEquals("こむぎ", userName);
  }

getSession()の戻り値としてsessionのモックを返すようにしたので、request.getSession().getAttribute("userName")が行えるようになりました。

セッター/ゲッターの注意点

チェーンメソッド以外に、ゲッターとセッターの関係でも注意が必要です。
以下の例は一見正しく動きそうですが、思った通りにはなりません。

UserServiceTest.java
  @Test
  public void testSetUserName() {
    // リクエストをモック
    HttpServletRequest request = mock(HttpServletRequest.class);
        
    // 名前をセット
    UserService userService = new UserService();
    userService.setUserName(request, "こむぎ");

    // 正しい名前が取り出せるか確認
    assertEquals("こむぎ", userService.getUserName(request)); // こむぎが取り出せるはず?→ゲストになってしまう
  }

setName()をモックに対して行っても、getName()で取り出す値には反映されるわけではありません。セッターとゲッターはそれぞれ明示的なスタブ化が必要になります。

おわりに

今回はシンプルな例で紹介しましたが、オブジェクトの依存関係が深くなるほど気づきにくくなるのでより注意が必要になるようです。Mockitoを使用する際は明示的に定義しない限りどのオブジェクトも存在しないことを忘れず、慎重にオブジェクト同士の関係を考えていきたいなと思います。
最後までご覧いただきありがとうございました。

使用した環境

記事中では以下の環境で動作の確認を行いました。

  • Apache Maven 3.8.7
  • openjdk 21.0.6
  • 5.15.167.4-microsoft-standard-WSL2
  • 21.0.6+7-Ubuntu-124.04.1

参考

参考書籍:
中山清喬(2024)『スッキリわかるJava入門実践編第4版』インプレス

参考記事:
https://stackoverflow.com/questions/33124153/mockito-nullpointerexception-when-stubbing-method
https://www.baeldung.com/java-httpservletrequest-mock
https://stackoverflow.com/questions/16570029/mockito-mock-objects-returns-null

Discussion