Используя Mockito, как мне сопоставить пару ключ-значение на карте?

Question

Мне нужно отправить определенное значение из фиктивного объекта на основе определенного значения ключа.

Из конкретного класса:

map.put("xpath", "PRICE");
search(map);

Из теста:

IOurXMLDocument mock = mock(IOurXMLDocument.class);
when(mock.search(.....need help here).thenReturn("$100.00");

Как мне смоделировать вызов этого метода для этой пары ключ-значение?

Answer 1

Я обнаружил, что пытался решить аналогичную проблему, создав заглушку Mockito с параметром Map. Я не хотел писать пользовательские сопоставления для рассматриваемой карты, а затем нашел более элегантное решение: используйте дополнительные сопоставители в hamcrest-library с argThat mockito:

when(mock.search(argThat(hasEntry("xpath", "PRICE"))).thenReturn("$100.00");

Если вам нужно проверить несколько записей, вы можете использовать другие вкусности хамкреста:

when(mock.search(argThat(allOf(hasEntry("xpath", "PRICE"), hasEntry("otherKey", "otherValue")))).thenReturn("$100.00");

Это начинает становиться длинным с нетривиальными картами, поэтому я закончил тем, что извлек методы для сбора совпадений входа и вставил их в наш TestUtils:

import static org.hamcrest.Matchers.allOf;
import static org.hamcrest.Matchers.anyOf;
import static org.hamcrest.Matchers.hasEntry;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import org.hamcrest.Matcher;
---------------------------------
public static <K, V> Matcher<Map<K, V>> matchesEntriesIn(Map<K, V> map) {
    return allOf(buildMatcherArray(map));
}

public static <K, V> Matcher<Map<K, V>> matchesAnyEntryIn(Map<K, V> map) {
    return anyOf(buildMatcherArray(map));
}

@SuppressWarnings("unchecked")
private static <K, V> Matcher<Map<? extends K, ? extends V>>[] buildMatcherArray(Map<K, V> map) {
    List<Matcher<Map<? extends K, ? extends V>>> entries = new ArrayList<Matcher<Map<? extends K, ? extends V>>>();
    for (K key : map.keySet()) {
        entries.add(hasEntry(key, map.get(key)));
    }
    return entries.toArray(new Matcher[entries.size()]);
}

Итак, у меня осталось:

when(mock.search(argThat(matchesEntriesIn(map))).thenReturn("$100.00");
when(mock.search(argThat(matchesAnyEntryIn(map))).thenReturn("$100.00");

С дженериками связано какое-то уродство, и я подавляю одно предупреждение, но, по крайней мере, оно СУХОЕ и скрыто в TestUtil.

Последнее замечание, остерегайтесь проблем с встроенным подколенным сухожилием в JUnit 4.10 . С Maven я рекомендую сначала импортировать библиотеку hamcrest, а затем JUnit 4.11 (теперь 4.12) и исключить ядро ​​hamcrest из JUnit просто для хорошей меры:

<dependency>
    <groupId>org.hamcrest</groupId>
    <artifactId>hamcrest-library</artifactId>
    <version>1.3</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-core</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.mockito</groupId>
    <artifactId>mockito-all</artifactId>
    <version>1.9.5</version>
    <scope>test</scope>
</dependency>

---

Редактировать: 1 сентября 2017 г. - В некоторых комментариях я обновил свой ответ, чтобы показать мою зависимость от Mockito, мой импорт в утилите test и junit, который работает зеленым на сегодняшний день:

import static blah.tool.testutil.TestUtil.matchesAnyEntryIn;
import static blah.tool.testutil.TestUtil.matchesEntriesIn;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.is;
import static org.mockito.Matchers.argThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import java.util.HashMap;
import java.util.Map;

import org.junit.Test;

public class TestUtilTest {

    @Test
    public void test() {
        Map<Integer, String> expected = new HashMap<Integer, String>();
        expected.put(1, "One");
        expected.put(3, "Three");

        Map<Integer, String> actual = new HashMap<Integer, String>();
        actual.put(1, "One");
        actual.put(2, "Two");

        assertThat(actual, matchesAnyEntryIn(expected));

        expected.remove(3);
        expected.put(2, "Two");
        assertThat(actual, matchesEntriesIn(expected));
    }

    @Test
    public void mockitoTest() {
        SystemUnderTest sut = mock(SystemUnderTest.class);
        Map<Integer, String> expected = new HashMap<Integer, String>();
        expected.put(1, "One");
        expected.put(3, "Three");

        Map<Integer, String> actual = new HashMap<Integer, String>();
        actual.put(1, "One");

        when(sut.search(argThat(matchesAnyEntryIn(expected)))).thenReturn("Response");
        assertThat(sut.search(actual), is("Response"));
    }

    protected class SystemUnderTest {
        // We don't really care what this does
        public String search(Map<Integer, String> map) {
            if (map == null) return null;
            return map.get(0);
        }
    }
}

Answer 2

Если вы просто хотите «сопоставить» с определенной картой, вы можете использовать некоторые из приведенных выше ответов, или пользовательский «сопоставитель», расширяющий Map, или ArgumentCaptor, например:

ArgumentCaptor<Map> argumentsCaptured = ArgumentCaptor.forClass(Map.class);
verify(mock, times(1)).method((Map<String, String>) argumentsCaptured.capture());
assert argumentsCaptured.getValue().containsKey("keyname"); 
// .getValue() will be the Map it called it with.

См. Также другие ответы здесь: Проверка значения атрибута объекта с помощью mockito

Answer 3

Разве это не работает?

Map<String, String> map = new HashMap<String, String>();
map.put("xpath", "PRICE");
when(mock.search(map)).thenReturn("$100.00");

Параметр Map должен вести себя так же, как и другие параметры.

Answer 4

Похоже, что вам нужно это Answer:

IOurXMLDocument doc = mock(IOurXMLDocument.class);
when(doc.search(Matchers.<Map<String,String>>any())).thenAnswer(new Answer<String>() {
    @Override
    public String answer(InvocationOnMock invocation) throws Throwable {
        Map<String, String> map = (Map<String, String>) invocation.getArguments()[0];
        String value = map.get("xpath");
        if ("PRICE".equals(value)) {
            return "$100.00";
        } else if ("PRODUCTNAME".equals(value)) {
            return "Candybar";
        } else {
            return null;
        }
    }
});

Но лучше кажется, что лучше не использовать примитив Map в качестве параметра для вашего метода поиска - вы могли бы преобразовать этоКарта в Pojo с price и productName атрибутами.Просто идея:)