Wykonywanie fałszywej metody zwraca argument, który został do niej przekazany


673

Rozważ podpis metody, taki jak:

public String myFunction(String abc);

Czy Mockito może pomóc zwrócić ten sam ciąg znaków, który otrzymała metoda?


Ok, a co z jakimkolwiek frameworkiem javingowym w ogóle ... Czy jest to możliwe w przypadku innych frameworków, czy też powinienem po prostu stworzyć głupi kodeks naśladujący pożądane zachowanie?
Abhijeet Kashnia

Odpowiedzi:


1001

Możesz utworzyć odpowiedź w Mockito. Załóżmy, że mamy interfejs o nazwie Aplikacja z metodą myFunction.

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

Oto metoda testowa z odpowiedzią 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"));
}

Od wersji Mockito 1.9.5 i Java 8 można również użyć wyrażenia lambda:

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

1
Tego też szukałem. Dziękuję Ci! Mój problem był jednak inny. Chcę wyśmiewać usługę trwałości (EJB), która przechowuje obiekty i zwraca je według nazwy.
migu

7
Stworzyłem dodatkową klasę, która otacza tworzenie odpowiedzi. Więc kod brzmi jakwhen(...).then(Return.firstParameter())
SpaceTrucker

69
W lambdach Java 8 kolacja łatwo zwraca pierwszy argument, nawet dla konkretnej klasy, tj when(foo(any()).then(i -> i.getArgumentAt(0, Bar.class)). Równie dobrze możesz użyć odwołania do metody i wywołać prawdziwą metodę.
Paweł Dyda

To rozwiązuje mój problem z metodą zwrotów, Iterator<? extends ClassName>która powoduje wszelkiego rodzaju problemy z rzutowaniem w thenReturn()instrukcji.
Michael Shopsin

16
W Javie 8 i Mockito <1.9.5 odpowiedź Pawła brzmiwhen(foo(any()).thenAnswer(i -> i.getArguments()[0])
Graeme Moss

566

Jeśli masz Mockito w wersji 1.9.5 lub nowszej, istnieje nowa metoda statyczna, która może uczynić Answerobiekt dla Ciebie. Musisz napisać coś takiego

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

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

lub alternatywnie

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

Zauważ, że returnsFirstArg()metoda jest statyczna w AdditionalAnswersklasie, co jest nowością w Mockito 1.9.5; więc potrzebujesz odpowiedniego importu statycznego.


17
Uwaga: to when(...).then(returnsFirstArg()), że przez pomyłkę miałem, when(...).thenReturn(returnsFirstArg())który dałjava.lang.ClassCastException: org.mockito.internal.stubbing.answers.ReturnsArgumentAt cannot be cast to
Benedikt Köppel

1
Uwaga: returnFirstArg () zwraca odpowiedź <> zamiast wartości argumentu. Dostał „Foo (java.lang.String) nie można zastosować do” (org.mockito.stubbing.Answer <java.lang.Object>) ”podczas próby wywołania .thenReturn (new Foo (returnFirstArg ()))
Lu55

Zawsze muszę wyszukiwać w Google tę odpowiedź raz po raz przez ostatnie lata, ponieważ po prostu nie pamiętam „Dodatkowych odpowiedzi” i potrzebuję ich bardzo rzadko. Potem zastanawiam się, jak do cholery mogę zbudować ten scenariusz, ponieważ nie mogę znaleźć niezbędnych zależności. Czy nie można tego dodać bezpośrednio do mockito? : /
BAERUS

2
Odpowiedź Steve'a jest bardziej ogólna. Ten pozwala tylko zwrócić surowy argument. Jeśli chcesz przetworzyć ten argument i zwrócić wynik, wówczas reguła odpowiedzi Steve'a. Poparłem oba, ponieważ są one przydatne.
akostadinov,

Do Twojej wiadomości musimy importować static org.mockito.AdditionalAnswers.returnsFirstArg. to, aby użyć returnFirstArg. Mogę też zrobić when(myMock.myFunction(any())).then(returnsFirstArg())w Mockito 2.20. *
gtiwari333

77

W Javie 8 możliwe jest utworzenie odpowiedzi w jednym wierszu, nawet w przypadku starszej wersji Mockito:

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

Oczywiście nie jest to tak przydatne, jak użycie AdditionalAnswerssugerowane przez Davida Wallace'a, ale może być przydatne, jeśli chcesz przekształcić argument „w locie”.


1
Znakomity. Dziękuję Ci. Jeśli argumentem jest long, czy to może nadal działać z boksem i Long.class?
vikingsteve

1
.getArgumentAt (..) nie został dla mnie znaleziony, ale .getArgument (1) działał (mockito 2.6.2)
Curtis Yallop

41

Miałem bardzo podobny problem. Celem było wykpienie usługi, która utrwala Obiekty i może zwrócić je po nazwie. Usługa wygląda następująco:

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

Makieta usługi używa mapy do przechowywania instancji pokoju.

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;
    }
});

Możemy teraz uruchomić nasze testy na tej makiecie. Na przykład:

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

34

W Javie 8 odpowiedź Steve'a może się stać

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"));
}

EDYCJA: Jeszcze krótsza:

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

To dość stare pytanie, ale myślę, że nadal jest aktualne. Również zaakceptowana odpowiedź działa tylko dla String. Tymczasem jest Mockito 2.1 i niektóre importy uległy zmianie, dlatego chciałbym podzielić się moją obecną odpowiedzią:

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());

Funkcja myClass.myF wygląda następująco:

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

4

Używam czegoś podobnego (w zasadzie jest to to samo podejście). Czasami przydatne jest, aby sztuczny obiekt zwracał wstępnie zdefiniowane dane wyjściowe dla niektórych danych wejściowych. To wygląda tak:

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

Możesz użyć Verify () w połączeniu z ArgumentCaptor, aby zapewnić wykonanie testu i ArgumentCaptor do oceny argumentów:

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

Wartość argumentu jest oczywiście dostępna poprzez argument.getValue () w celu dalszej manipulacji / sprawdzania / czegokolwiek.


3

To jest trochę stare, ale przyszedłem tutaj, ponieważ miałem ten sam problem. Używam JUnit, ale tym razem w aplikacji Kotlin z mockk. Zamieszczam tutaj próbkę w celach informacyjnych i porównawczych z odpowiednikiem 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

Możesz to osiągnąć za pomocą ArgumentCaptor

Wyobraź sobie, że masz taką funkcję fasoli.

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

Następnie w klasie testowej:

//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.
    }
  });

LUB jeśli jesteś fanem lambda, po prostu wykonaj:

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


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

Podsumowanie: Użyj argumentcaptor, aby przechwycić przekazany parametr. Później w odpowiedzi zwraca wartość przechwyconą za pomocą getValue.


To nie działa (już?). W odniesieniu do dokumentów: Tę metodę należy zastosować w ramach weryfikacji. Oznacza to, że możesz uchwycić tę wartość tylko przy użyciu metody weryfikacji
Muhammed Misir

1. Nie jestem pewien, co masz na myśli przez This doesn´t work (anymore?).to, że działam w mojej instancji. 2. Przepraszam, nie mam jasności co do tego, co próbujesz zrobić. Odpowiedź jest specyficzna dla pytania OP.
Cyril Cherian
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.