การล้อเลียนตัวแปรสมาชิกของคลาสโดยใช้ 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";
    }
}

สมมติว่าฉันกำลังเขียน unit test เพื่อทดสอบFirst.doSecond()method อย่างไรก็ตามสมมติว่าฉันต้องการ Mock Second.doSecond()class เช่นนั้น ฉันใช้ Mockito เพื่อทำสิ่งนี้

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

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

ฉันเห็นว่าการเยาะเย้ยไม่เกิดผลและการยืนยันล้มเหลว ไม่มีวิธีล้อเลียนตัวแปรสมาชิกของคลาสที่ฉันต้องการทดสอบ เหรอ?

คุณต้องระบุวิธีการเข้าถึงตัวแปรสมาชิกเพื่อที่คุณจะสามารถส่งต่อได้ (วิธีทั่วไปส่วนใหญ่จะเป็นเมธอด setter หรือ constructor ซึ่งรับพารามิเตอร์)

หากโค้ดของคุณไม่มีวิธีดำเนินการแสดงว่ารหัสนั้นไม่ถูกต้องสำหรับ TDD (Test Driven Development)

ไม่สามารถทำได้หากคุณไม่สามารถเปลี่ยนรหัสได้ แต่ฉันชอบการฉีดแบบพึ่งพาและ 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ในรหัสของคุณ)

วิธีที่ง่ายที่สุดคือสร้าง setter สำหรับ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);

ตอนนี้ปัญหาคือการเรียกไปที่วินาทีใหม่ใด ๆ จะส่งคืนอินสแตนซ์ที่เยาะเย้ยเหมือนกัน แต่ในกรณีง่ายๆของคุณสิ่งนี้จะได้ผล

ฉันมีปัญหาเดียวกันกับที่ไม่ได้ตั้งค่าส่วนตัวเนื่องจาก 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 (ดังนั้นคุณไม่จำเป็นต้องเรียนรู้กรอบการทำงานจำลองใหม่) ซึ่งมีฟังก์ชันเพิ่มเติม ซึ่งรวมถึงความสามารถในการให้คอนสตรัคเตอร์ส่งคืนการจำลอง มีประสิทธิภาพ แต่มีความซับซ้อนเล็กน้อยดังนั้นจงใช้อย่างรอบคอบ

คุณใช้นักวิ่งจำลองคนอื่น และคุณต้องเตรียมคลาสที่จะเรียกใช้คอนสตรัคเตอร์ (โปรดทราบว่านี่เป็น gotcha ทั่วไป - เตรียมคลาสที่เรียกตัวสร้างไม่ใช่คลาสที่สร้างขึ้น)

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

จากนั้นในการตั้งค่าการทดสอบของคุณคุณสามารถใช้เมธอด whenNew เพื่อให้ตัวสร้างส่งคืนการจำลอง

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

ใช่สิ่งนี้สามารถทำได้ดังที่การทดสอบต่อไปนี้แสดง (เขียนด้วย JMockit mocking API ซึ่งฉันพัฒนา):

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

คุณสามารถล้อเลียนตัวแปรสมาชิกของ Mockito Mock ด้วย ReflectionTestUtils

ReflectionTestUtils.setField(yourMock, "memberFieldName", value);