Пересмешивание переменных-членов класса с использованием Mockito

Я новичок в разработке и, в частности, в модульных тестах. Я предполагаю, что мое требование довольно простое, но я очень хочу узнать мнение других по этому поводу.

Предположим, у меня есть два таких класса -

public class First {

    Second second ;

    public First(){
        second = new Second();
    }

    public String doSecond(){
        return second.doSecond();
    }
}

class Second {

    public String doSecond(){
        return "Do Something";
    }
}

Скажем, я пишу модульный тест для First.doSecond()метода тестирования . Однако, предположим, я хочу, чтобы Second.doSecond()класс Mock был таким. Для этого я использую Mockito.

public void testFirst(){
    Second sec = mock(Second.class);
    when(sec.doSecond()).thenReturn("Stubbed Second");

    First first = new First();
    assertEquals("Stubbed Second", first.doSecond());
}

Я вижу, что насмешка не действует, а утверждение не выполняется. Нет возможности издеваться над переменными-членами класса, который я хочу протестировать. ?

Вам необходимо предоставить способ доступа к переменным-членам, чтобы вы могли передать имитацию (наиболее распространенными способами были бы метод установки или конструктор, который принимает параметр).

Если в вашем коде нет возможности сделать это, значит, он неверно учтен для TDD (разработка через тестирование).

Это невозможно, если вы не можете изменить свой код. Но мне нравится внедрение зависимостей, и Mockito его поддерживает:

public class First {    
    @Resource
    Second second;

    public First() {
        second = new Second();
    }

    public String doSecond() {
        return second.doSecond();
    }
}

Ваш тест:

@RunWith(MockitoJUnitRunner.class)
public class YourTest {
   @Mock
   Second second;

   @InjectMocks
   First first = new First();

   public void testFirst(){
      when(second.doSecond()).thenReturn("Stubbed Second");
      assertEquals("Stubbed Second", first.doSecond());
   }
}

Это очень красиво и просто.

Если вы внимательно посмотрите на свой код, вы увидите, что secondсвойство в вашем тесте по-прежнему является экземпляром Second, а не макетом (вы не передаете макет firstв свой код).

Самый простой способ будет создать сеттер для secondв Firstклассе и передать ему издеваться явно.

Как это:

public class First {

Second second ;

public First(){
    second = new Second();
}

public String doSecond(){
    return second.doSecond();
}

    public void setSecond(Second second) {
    this.second = second;
    }


}

class Second {

public String doSecond(){
    return "Do Something";
}
}

....

public void testFirst(){
Second sec = mock(Second.class);
when(sec.doSecond()).thenReturn("Stubbed Second");


First first = new First();
first.setSecond(sec)
assertEquals("Stubbed Second", first.doSecond());
}

Другой вариант - передать Secondэкземпляр как Firstпараметр конструктора.

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

public void testFirst(){
    Second sec = mock(Second.class);
    when(sec.doSecond()).thenReturn("Stubbed Second");


    First first = new First();
    Field privateField = PrivateObject.class.
        getDeclaredField("second");

    privateField.setAccessible(true);

    privateField.set(first, sec);

    assertEquals("Stubbed Second", first.doSecond());
}

Но вы, вероятно, можете, поскольку редко можно проводить тесты на коде, который вы не контролируете (хотя можно представить сценарий, в котором вам нужно протестировать внешнюю библиотеку, потому что автор этого не сделал :))

Если вы не можете изменить переменную-член, то другой способ - использовать powerMockit и вызвать

Second second = mock(Second.class)
when(second.doSecond()).thenReturn("Stubbed Second");
whenNew(Second.class).withAnyArguments.thenReturn(second);

Теперь проблема в том, что ЛЮБОЙ вызов new Second вернет тот же фиктивный экземпляр. Но в вашем простом случае это сработает.

У меня была такая же проблема, когда частное значение не было установлено, потому что Mockito не вызывает суперконструкторы. Вот как я дополняю насмешку отражением.

Во-первых, я создал класс TestUtils, который содержит множество полезных утилит, включая эти методы отражения. Реализовать доступ к отражению каждый раз непросто. Я создал эти методы для тестирования кода в проектах, в которых по той или иной причине не было макета пакета, и меня не пригласили включить его.

public class TestUtils {
    // get a static class value
    public static Object reflectValue(Class<?> classToReflect, String fieldNameValueToFetch) {
        try {
            Field reflectField  = reflectField(classToReflect, fieldNameValueToFetch);
            reflectField.setAccessible(true);
            Object reflectValue = reflectField.get(classToReflect);
            return reflectValue;
        } catch (Exception e) {
            fail("Failed to reflect "+fieldNameValueToFetch);
        }
        return null;
    }
    // get an instance value
    public static Object reflectValue(Object objToReflect, String fieldNameValueToFetch) {
        try {
            Field reflectField  = reflectField(objToReflect.getClass(), fieldNameValueToFetch);
            Object reflectValue = reflectField.get(objToReflect);
            return reflectValue;
        } catch (Exception e) {
            fail("Failed to reflect "+fieldNameValueToFetch);
        }
        return null;
    }
    // find a field in the class tree
    public static Field reflectField(Class<?> classToReflect, String fieldNameValueToFetch) {
        try {
            Field reflectField = null;
            Class<?> classForReflect = classToReflect;
            do {
                try {
                    reflectField = classForReflect.getDeclaredField(fieldNameValueToFetch);
                } catch (NoSuchFieldException e) {
                    classForReflect = classForReflect.getSuperclass();
                }
            } while (reflectField==null || classForReflect==null);
            reflectField.setAccessible(true);
            return reflectField;
        } catch (Exception e) {
            fail("Failed to reflect "+fieldNameValueToFetch +" from "+ classToReflect);
        }
        return null;
    }
    // set a value with no setter
    public static void refectSetValue(Object objToReflect, String fieldNameToSet, Object valueToSet) {
        try {
            Field reflectField  = reflectField(objToReflect.getClass(), fieldNameToSet);
            reflectField.set(objToReflect, valueToSet);
        } catch (Exception e) {
            fail("Failed to reflectively set "+ fieldNameToSet +"="+ valueToSet);
        }
    }

}

Затем я могу протестировать класс с такой частной переменной. Это полезно для имитации глубоких деревьев классов, которые вы тоже не контролируете.

@Test
public void testWithRectiveMock() throws Exception {
    // mock the base class using Mockito
    ClassToMock mock = Mockito.mock(ClassToMock.class);
    TestUtils.refectSetValue(mock, "privateVariable", "newValue");
    // and this does not prevent normal mocking
    Mockito.when(mock.somthingElse()).thenReturn("anotherThing");
    // ... then do your asserts
}

Я изменил свой код из моего реального проекта здесь, на странице. Может быть проблема с компиляцией или две. Думаю, вы поняли общую идею. Не стесняйтесь брать код и использовать его, если он вам пригодится.

Многие другие уже советовали вам переосмыслить свой код, чтобы сделать его более тестируемым - хороший совет и обычно проще, чем то, что я собираюсь предложить.

Если вы не можете изменить код, чтобы сделать его более тестируемым, PowerMock: https://code.google.com/p/powermock/

PowerMock расширяет Mockito (поэтому вам не нужно изучать новую фиктивную структуру), предоставляя дополнительные функции. Это включает возможность иметь конструктор, возвращающий макет. Мощный, но немного сложный - поэтому используйте его с умом.

Вы используете другой Mock-раннер. И вам нужно подготовить класс, который будет вызывать конструктор. (Обратите внимание, что это обычная проблема - подготовьте класс, который вызывает конструктор, а не созданный класс)

@RunWith(PowerMockRunner.class)
@PrepareForTest({First.class})

Затем в вашей тестовой настройке вы можете использовать метод whenNew, чтобы конструктор возвращал макет

whenNew(Second.class).withAnyArguments().thenReturn(mock(Second.class));

Да, это можно сделать, как показывает следующий тест (написанный с помощью API-интерфейса JMockit, который я разрабатываю):

@Test
public void testFirst(@Mocked final Second sec) {
    new NonStrictExpectations() {{ sec.doSecond(); result = "Stubbed Second"; }};

    First first = new First();
    assertEquals("Stubbed Second", first.doSecond());
}

Однако с Mockito такой тест не может быть написан. Это связано с тем, как макетирование реализовано в Mockito, где создается подкласс класса, который будет издеваться; только экземпляры этого «фиктивного» подкласса могут иметь фиктивное поведение, поэтому вам нужно, чтобы тестируемый код использовал их вместо любого другого экземпляра.

Если вам нужна альтернатива ReflectionTestUtils из Spring в mockito, используйте

Whitebox.setInternalState(first, "second", sec);