モックされたメソッドに渡された引数を返すようにする


673

次のようなメソッドシグネチャについて考えてみます。

public String myFunction(String abc);

Mockitoはメソッドが受け取ったのと同じ文字列を返すのを助けることができますか?


一般的なJavaモックフレームワークについてはどうですか...これは他のフレームワークでも可能ですか、それとも、私が望む動作を模倣するためにダムスタブを作成するだけですか?
Abhijeet Kashnia 2010

回答:


1000

Mockitoで回答を作成できます。仮に、メソッドmyFunctionを持つApplicationという名前のインターフェースがあるとします。

public interface Application {
  public String myFunction(String abc);
}

以下は、Mockito回答を使用したテストメソッドです。

public void testMyFunction() throws Exception {
  Application mock = mock(Application.class);
  when(mock.myFunction(anyString())).thenAnswer(new Answer<String>() {
    @Override
    public String answer(InvocationOnMock invocation) throws Throwable {
      Object[] args = invocation.getArguments();
      return (String) args[0];
    }
  });

  assertEquals("someString",mock.myFunction("someString"));
  assertEquals("anotherString",mock.myFunction("anotherString"));
}

Mockito 1.9.5とJava 8以降、ラムダ式を使用することもできます。

when(myMock.myFunction(anyString())).thenAnswer(i -> i.getArguments()[0]);

1
これも私が探していたものです。ありがとうございました!しかし、私の問題は異なっていました。オブジェクトを格納して名前で返す永続化サービス(EJB)をモックしたい。
ミグ

7
回答の作成をラップする追加のクラスを作成しました。したがって、コードは次のようになりますwhen(...).then(Return.firstParameter())
SpaceTrucker '26

69
Java 8ラムダを使用すると、特定のクラス、つまりwhen(foo(any()).then(i -> i.getArgumentAt(0, Bar.class))。また、メソッド参照を使用して実際のメソッドを呼び出すこともできます。
パヴェルDyda

これIterator<? extends ClassName>は、thenReturn()ステートメントであらゆる種類のキャストの問題を引き起こすreturn メソッドを使用して私の問題を解決します。
Michael Shopsin

16
Java 8とMockito <1.9.5の場合、Pawełの答えは次のようになりますwhen(foo(any()).thenAnswer(i -> i.getArguments()[0])
Graeme Moss

566

Mockito 1.9.5以降をお持ちの場合は、Answerオブジェクトを作成できる新しい静的メソッドがあります。あなたは次のようなものを書く必要があります

import static org.mockito.Mockito.when;
import static org.mockito.AdditionalAnswers.returnsFirstArg;

when(myMock.myFunction(anyString())).then(returnsFirstArg());

または代わりに

doAnswer(returnsFirstArg()).when(myMock).myFunction(anyString());

このreturnsFirstArg()メソッドはAdditionalAnswersクラスで静的であることに注意してください。これはMockito 1.9.5の新機能です。したがって、適切な静的インポートが必要になります。


17
注:それはwhen(...).then(returnsFirstArg())、私が誤ってwhen(...).thenReturn(returnsFirstArg())与えたものjava.lang.ClassCastException: org.mockito.internal.stubbing.answers.ReturnsArgumentAt cannot be cast to
でした

1
注:returnsFirstArg()は、引数の値ではなくAnswer <>を返します。.thenReturn(new Foo(returnsFirstArg())))を呼び出そうとしているときに 'Foo(java.lang.String)を'(org.mockito.stubbing.Answer <java.lang.Object>) 'に適用できません
Lu55

「AdditionalAnswers」を思い出せず、必要になることもほとんどないので、私は常にこの回答を何度も何度も何度もGoogleで検索する必要があります。次に、必要な依存関係を見つけることができないので、そのシナリオをどのように構築できるのでしょうか。これをmockitoに直接追加することはできませんか?:/
BAERUS

2
スティーブの答えはより一般的です。これは、生の引数を返すことのみを許可します。その引数を処理して結果を返したい場合は、スティーブの答えが決まります。どちらも役立つので、両方に賛成しました。
akostadinov 2017

参考までに、輸入しており static org.mockito.AdditionalAnswers.returnsFirstArgます。これは、returnsFirstArgを使用します。また、when(myMock.myFunction(any())).then(returnsFirstArg())Mockito 2.20で実行できます。*
gtiwari333 '30

77

Java 8では、古いバージョンのMockitoでも1行の回答を作成できます。

when(myMock.myFunction(anyString()).then(i -> i.getArgumentAt(0, String.class));

もちろん、これはAdditionalAnswers、David Wallaceによって提案された使用ほど有用ではありませんが、「オンザフライ」で引数を変換したい場合に役立ちます。


1
鮮やかさ。ありがとうございました。引数がの場合、longこれはまだボクシングで機能しLong.classますか?
vikingsteve 2016

1
.getArgumentAt(..)は私には見つかりませんでしたが、.getArgument(1)は機能しました(mockito 2.6.2)
Curtis Yallop

41

私は非常に似た問題を抱えていました。目標は、オブジェクトを永続化し、名前で返すことができるサービスを模擬することでした。サービスは次のようになります。

public class RoomService {
    public Room findByName(String roomName) {...}
    public void persist(Room room) {...}
}

サービスモックは、マップを使用してRoomインスタンスを格納します。

RoomService roomService = mock(RoomService.class);
final Map<String, Room> roomMap = new HashMap<String, Room>();

// mock for method persist
doAnswer(new Answer<Void>() {
    @Override
    public Void answer(InvocationOnMock invocation) throws Throwable {
        Object[] arguments = invocation.getArguments();
        if (arguments != null && arguments.length > 0 && arguments[0] != null) {
            Room room = (Room) arguments[0];
            roomMap.put(room.getName(), room);
        }
        return null;
    }
}).when(roomService).persist(any(Room.class));

// mock for method findByName
when(roomService.findByName(anyString())).thenAnswer(new Answer<Room>() {
    @Override
    public Room answer(InvocationOnMock invocation) throws Throwable {
        Object[] arguments = invocation.getArguments();
        if (arguments != null && arguments.length > 0 && arguments[0] != null) {
            String key = (String) arguments[0];
            if (roomMap.containsKey(key)) {
                return roomMap.get(key);
            }
        }
        return null;
    }
});

これで、このモックでテストを実行できます。例えば:

String name = "room";
Room room = new Room(name);
roomService.persist(room);
assertThat(roomService.findByName(name), equalTo(room));
assertNull(roomService.findByName("none"));

34

Java 8では、スティーブの答えは次のようになります。

public void testMyFunction() throws Exception {
    Application mock = mock(Application.class);
    when(mock.myFunction(anyString())).thenAnswer(
    invocation -> {
        Object[] args = invocation.getArguments();
        return args[0];
    });

    assertEquals("someString", mock.myFunction("someString"));
    assertEquals("anotherString", mock.myFunction("anotherString"));
}

編集:さらに短く:

public void testMyFunction() throws Exception {
    Application mock = mock(Application.class);
    when(mock.myFunction(anyString())).thenAnswer(
        invocation -> invocation.getArgument(0));

    assertEquals("someString", mock.myFunction("someString"));
    assertEquals("anotherString", mock.myFunction("anotherString"));
}

6

これはかなり古い質問ですが、私はまだ関連があると思います。また、受け入れられた回答は文字列に対してのみ機能します。一方、Mockito 2.1があり、一部のインポートが変更されたので、現在の答えを共有したいと思います。

import static org.mockito.AdditionalAnswers.returnsFirstArg;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;

@Mock
private MyClass myClass;

// this will return anything you pass, but it's pretty unrealistic
when(myClass.myFunction(any())).then(returnsFirstArg());
// it is more "life-like" to accept only the right type
when(myClass.myFunction(any(ClassOfArgument.class))).then(returnsFirstArg());

myClass.myFunctionは次のようになります。

public class MyClass {
    public ClassOfArgument myFunction(ClassOfArgument argument){
        return argument;
    }  
}

4

私は似たようなものを使用します(基本的には同じアプローチです)。特定の入力に対して事前に定義された出力をモックオブジェクトが返すと便利な場合があります。それはこのようになります:

private Hashtable<InputObject,  OutputObject> table = new Hashtable<InputObject, OutputObject>();
table.put(input1, ouput1);
table.put(input2, ouput2);

...

when(mockObject.method(any(InputObject.class))).thenAnswer(
       new Answer<OutputObject>()
       {
           @Override
           public OutputObject answer(final InvocationOnMock invocation) throws Throwable
           {
               InputObject input = (InputObject) invocation.getArguments()[0];
               if (table.containsKey(input))
               {
                   return table.get(input);
               }
               else
               {
                   return null; // alternatively, you could throw an exception
               }
           }
       }
       );

4

verify()をArgumentCaptorと組み合わせて使用​​して、テストでの実行を保証し、ArgumentCaptorを使用して引数を評価することができます。

ArgumentCaptor<String> argument = ArgumentCaptor.forClass(String.class);
verify(mock).myFunction(argument.capture());
assertEquals("the expected value here", argument.getValue());

引数の値は、argument.getValue()を介して明らかにアクセスでき、さらに操作/チェック/何でもできます。


3

これは少し古いですが、同じ問題があったのでここに来ました。私はJUnitを使用していますが、今回はmockkを使用したKotlinアプリで使用しています。参照とJavaの対応物との比較のために、ここにサンプルを投稿しています。

@Test
fun demo() {
  // mock a sample function
  val aMock: (String) -> (String) = mockk()

  // make it return the same as the argument on every invocation
  every {
    aMock.invoke(any())
  } answers {
    firstArg()
  }

  // test it
  assertEquals("senko", aMock.invoke("senko"))
  assertEquals("senko1", aMock.invoke("senko1"))
  assertNotEquals("not a senko", aMock.invoke("senko"))
}

2

これは、ArgumentCaptorを使用して実現できます。

そのようなBean関数があると想像してください。

public interface Application {
  public String myFunction(String abc);
}

次に、テストクラスで:

//Use ArgumentCaptor to capture the value
ArgumentCaptor<String> param = ArgumentCaptor.forClass(String.class);


when(mock.myFunction(param.capture())).thenAnswer(new Answer<String>() {
    @Override
    public String answer(InvocationOnMock invocation) throws Throwable {
      return param.getValue();//return the captured value.
    }
  });

または、ラムダのファンの場合は次のようにします。

//Use ArgumentCaptor to capture the value
ArgumentCaptor<String> param = ArgumentCaptor.forClass(String.class);


when(mock.myFunction(param.capture()))
    .thenAnswer((invocation) -> param.getValue());

概要: argumentcaptorを使用して、渡されたパラメーターをキャプチャします。後で、getValueを使用して取得した値を返します。


これは機能しません(もう?)。ドキュメントに関して:このメソッドは検証内で使用する必要があります。つまり、検証方法を使用する場合にのみ値を取得できることを意味します
Muhammed Misir

1. This doesn´t work (anymore?).これが私のインスタンスで機能しているという意味がわかりません。2.申し訳ありませんが、あなたが主張しようとしている点が明確ではありません。答えはOPの質問に固有です。
Cyril Cherian
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.