วิธีแก้ไขข้อยกเว้น Stubbing ที่ไม่จำเป็น

รหัสของฉันมีดังต่อไปนี้

@RunWith(MockitoJUnitRunner.class)
public class MyClass {

    private static final String code ="Test";

    @Mock
     private MyClassDAO dao;

    @InjectMocks
     private MyClassService Service = new MyClassServiceImpl();

    @Test
     public void testDoSearch() throws Exception {
         final String METHOD_NAME = logger.getName().concat(".testDoSearchEcRcfInspections()");
         CriteriaDTO dto = new CriteriaDTO();
         dto.setCode(code);
         inspectionService.searchEcRcfInspections(dto);
         List<SearchCriteriaDTO> summaryList = new ArrayList<SearchCriteriaDTO>();
         inspectionsSummaryList.add(dto);
         when(dao.doSearch(dto)).thenReturn(inspectionsSummaryList);//got error in this line
         verify(dao).doSearchInspections(dto);

      }
}

ฉันได้รับข้อยกเว้นต่ำกว่า

org.mockito.exceptions.misusing.UnnecessaryStubbingException: 
Unnecessary stubbings detected in test class: Test
Clean & maintainable test code requires zero unnecessary code.
Following stubbings are unnecessary (click to navigate to relevant line of code):
  1. -> at service.Test.testDoSearch(Test.java:72)
Please remove unnecessary stubbings or use 'silent' option. More info: javadoc for UnnecessaryStubbingException class.
  at org.mockito.internal.exceptions.Reporter.formatUnncessaryStubbingException(Reporter.java:838)
  at org.mockito.internal.junit.UnnecessaryStubbingsReporter.validateUnusedStubs(UnnecessaryStubbingsReporter.java:34)
  at org.mockito.internal.runners.StrictRunner.run(StrictRunner.java:49)
  at org.mockito.junit.MockitoJUnitRunner.run(MockitoJUnitRunner.java:103)
  at org.eclipse.jdt.internal.junit4.runner.JUnit4TestReference.run(JUnit4TestReference.java:86)
  at org.eclipse.jdt.internal.junit.runner.TestExecution.run(TestExecution.java:38)
  at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:459)
  at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:675)
  at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.run(RemoteTestRunner.java:382)
  at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java:192)

โปรดช่วยฉันวิธีแก้ไข

แทนที่@RunWith(MockitoJUnitRunner.class)ด้วย@RunWith(MockitoJUnitRunner.Silent.class).

ในตอนแรกคุณควรตรวจสอบตรรกะการทดสอบของคุณ โดยปกติจะมี 3 กรณี ขั้นแรกคุณกำลังล้อเลียนวิธีการที่ไม่ถูกต้อง (คุณพิมพ์ผิดหรือมีคนเปลี่ยนรหัสทดสอบเพื่อไม่ให้ใช้วิธีการจำลองอีกต่อไป) ประการที่สองการทดสอบของคุณล้มเหลวก่อนที่จะเรียกวิธีนี้ ประการที่สามตรรกะของคุณผิดพลาดหาก / เปลี่ยนสาขาที่ใดที่หนึ่งในโค้ดเพื่อไม่ให้มีการเรียกวิธีการเยาะเย้ย

หากเป็นกรณีแรกคุณต้องการเปลี่ยนวิธีจำลองสำหรับวิธีที่ใช้ในรหัสเสมอ ขึ้นอยู่กับที่สองและสาม โดยปกติคุณควรลบการเยาะเย้ยนี้หากไม่มีประโยชน์ แต่บางครั้งก็มีบางกรณีในการทดสอบแบบพารามีทริกซึ่งควรใช้เส้นทางที่แตกต่างกันนี้หรือล้มเหลวก่อนหน้านี้ จากนั้นคุณสามารถแบ่งการทดสอบนี้ออกเป็นสองรายการหรือมากกว่านั้นแยกกัน แต่ก็ไม่ได้ดูดีเสมอไป วิธีการทดสอบ 3 วิธีที่มีผู้ให้บริการอาร์กิวเมนต์ 3 ตัวสามารถทำให้คุณทดสอบดูไม่สามารถอ่านได้ ในกรณีนั้นสำหรับ JUnit 4 คุณจะปิดข้อยกเว้นนี้ด้วย

@RunWith(MockitoJUnitRunner.Silent.class) 

คำอธิบายประกอบหรือหากคุณกำลังใช้แนวทางกฎ

@Rule
public MockitoRule rule = MockitoJUnit.rule().strictness(Strictness.LENIENT);

หรือ (พฤติกรรมเดียวกัน)

@Rule
public MockitoRule rule = MockitoJUnit.rule().silent();

สำหรับการทดสอบ JUnit 5 คุณสามารถปิดเสียงข้อยกเว้นนี้โดยใช้คำอธิบายประกอบที่ให้มาในmockito-junit-jupiterแพ็คเกจ

@ExtendWith(MockitoExtension.class)
@MockitoSettings(strictness = Strictness.LENIENT)
class JUnit5MockitoTest {
}

การเงียบไม่ใช่วิธีแก้ปัญหา คุณต้องแก้ไขการเยาะเย้ยในการทดสอบของคุณ ดูเอกสารอย่างเป็นทางการที่นี่

ต้นขั้วที่ไม่จำเป็นคือการเรียกเมธอดที่ไม่ได้รับรู้ในระหว่างการดำเนินการทดสอบ (ดู MockitoHint ด้วย) เช่น:

//code under test:
 ...
 String result = translator.translate("one")
 ...

 //test:
 ...
 when(translator.translate("one")).thenReturn("jeden"); // <- stubbing realized during code execution
 when(translator.translate("two")).thenReturn("dwa"); // <- stubbing never realized
 ...

โปรดสังเกตว่าไม่เคยมีวิธีการที่ถูกตรึงไว้ในโค้ดภายใต้การทดสอบระหว่างการดำเนินการทดสอบ การลอกแบบหลงทางอาจเป็นการควบคุมดูแลของผู้พัฒนาสิ่งประดิษฐ์ของการคัดลอกวางหรือผลกระทบที่ไม่เข้าใจการทดสอบ / โค้ด ไม่ว่าจะด้วยวิธีใดก็ตามผู้พัฒนาพบกับโค้ดทดสอบที่ไม่จำเป็น เพื่อให้โค้ดเบสสะอาดและบำรุงรักษาได้จำเป็นต้องลบโค้ดที่ไม่จำเป็นออก การทดสอบอย่างอื่นจะอ่านและหาเหตุผลได้ยากกว่า

หากต้องการข้อมูลเพิ่มเติมเกี่ยวกับการตรวจหาต้นขั้วที่ไม่ได้ใช้โปรดดู MockitoHint

สำหรับฉันทั้งข้อเสนอแนะ@Ruleหรือ@RunWith(MockitoJUnitRunner.Silent.class)ข้อเสนอแนะไม่ได้ผล เป็นโครงการเดิมที่เราอัปเกรดเป็น mockito-core 2.23.0

เราสามารถกำจัดUnnecessaryStubbingExceptionโดยใช้:

Mockito.lenient().when(mockedService.getUserById(any())).thenReturn(new User());

แทน:

when(mockedService.getUserById(any())).thenReturn(new User());

ไม่จำเป็นต้องบอกว่าคุณควรดูรหัสทดสอบ แต่เราจำเป็นต้องรวบรวมสิ่งต่างๆและการทดสอบทำงานก่อนอื่น;)

 when(dao.doSearch(dto)).thenReturn(inspectionsSummaryList);//got error in this line
 verify(dao).doSearchInspections(dto);

whenที่นี่กำหนดค่าจำลองของคุณทำอะไร อย่างไรก็ตามคุณไม่ได้ใช้การเยาะเย้ยนี้ในทางใด ๆ อีกต่อไปหลังจากบรรทัดนี้ (นอกเหนือจากการทำ a verify) Mockito เตือนคุณว่าwhenเส้นนั้นไม่มีจุดหมาย บางทีคุณอาจทำผิดพลาดทางตรรกะ?

ดูส่วนหนึ่งของการติดตามสแต็กดูเหมือนว่าคุณกำลังขีดฆ่าที่dao.doSearch()อื่น เช่นเดียวกับการสร้างต้นขั้วของวิธีการเดิมซ้ำ ๆ

Following stubbings are unnecessary (click to navigate to relevant line of code):
  1. -> at service.Test.testDoSearch(Test.java:72)
Please remove unnecessary stubbings or use 'silent' option. More info: javadoc for UnnecessaryStubbingException class.

ลองพิจารณาคลาสทดสอบด้านล่างตัวอย่างเช่น:

@RunWith(MockitoJUnitRunner.class)
public class SomeTest {
    @Mock
    Service1 svc1Mock1;

    @Mock
    Service2 svc2Mock2;

    @InjectMock
    TestClass class;

    //Assume you have many dependencies and you want to set up all the stubs 
    //in one place assuming that all your tests need these stubs.

    //I know that any initialization code for the test can/should be in a 
    //@Before method. Lets assume there is another method just to create 
    //your stubs.

    public void setUpRequiredStubs() {
        when(svc1Mock1.someMethod(any(), any())).thenReturn(something));
        when(svc2Mock2.someOtherMethod(any())).thenReturn(somethingElse);
    }

    @Test
    public void methodUnderTest_StateUnderTest_ExpectedBehavior() {
        // You forget that you defined the stub for svcMock1.someMethod or 
        //thought you could redefine it. Well you cannot. That's going to be 
        //a problem and would throw your UnnecessaryStubbingException.
       when(svc1Mock1.someMethod(any(),any())).thenReturn(anyThing);//ERROR!
       setUpRequiredStubs();
    }
}

ฉันอยากจะพิจารณาปรับโครงสร้างการทดสอบของคุณให้แตกในกรณีที่จำเป็น

ในกรณีของฉันข้อผิดพลาด Mockito กำลังบอกให้ฉันเรียกใช้วิธีการจริงหลังจากwhenหรือwheneverต้นขั้ว เนื่องจากเราไม่ได้เรียกใช้เงื่อนไขที่เราเพิ่งล้อเลียน Mockito จึงรายงานว่าเป็นส่วนที่ไม่จำเป็นหรือรหัส

นี่คือสิ่งที่เป็นเหมือนเมื่อข้อผิดพลาดเกิดขึ้น:

@Test
fun `should return error when item list is empty for getStockAvailability`() {
    doAnswer(
        Answer<Void> { invocation ->
            val callback =
                invocation.arguments[1] as GetStockApiCallback<StockResultViewState.Idle, StockResultViewState.Error>
            callback.onApiCallError(stockResultViewStateError)
            null
        }
    ).whenever(stockViewModelTest)
        .getStockAvailability(listOf(), getStocksApiCallBack)
}

จากนั้นฉันก็เรียกวิธีการจริงที่กล่าวถึงเมื่อคำสั่งเพื่อล้อเลียนวิธีการ

การเปลี่ยนแปลงที่ทำมีดังต่อไปนี้ stockViewModelTest.getStockAvailability(listOf(), getStocksApiCallBack)

@Test
fun `should return error when item list is empty for getStockAvailability`() {
    doAnswer(
        Answer<Void> { invocation ->
            val callback =
                invocation.arguments[1] as GetStockApiCallback<StockResultViewState.Idle, StockResultViewState.Error>
            callback.onApiCallError(stockResultViewStateError)
            null
        }
    ).whenever(stockViewModelTest)
        .getStockAvailability(listOf(), getStocksApiCallBack)
    //called the actual method here
    stockViewModelTest.getStockAvailability(listOf(), getStocksApiCallBack)
}

มันใช้งานได้แล้ว

หากคุณใช้รูปแบบนี้แทน:

@Rule
public MockitoRule rule = MockitoJUnit.rule().strictness(Strictness.STRICT_STUBS);

แทนที่ด้วย:

@Rule
public MockitoRule rule = MockitoJUnit.rule().silent();

ฉันเคยUnnecessaryStubbingExceptionพยายามใช้whenวิธีการบนวัตถุ Spy Mockito.lenient()ปิดเสียงข้อยกเว้น แต่ผลการทดสอบไม่ถูกต้อง

ในกรณีของวัตถุ Spy เราต้องเรียกใช้วิธีการโดยตรง

@ExtendWith(MockitoExtension.class)
@RunWith(JUnitPlatform.class)
class ArithmTest {

    @Spy
    private Arithm arithm;

    @Test
    void testAddition() {

        int res = arithm.add(2, 5);

        // doReturn(7).when(arithm).add(2, 5);
        assertEquals(res, 7);
    }
}

แทนที่

@RunWith(MockitoJUnitRunner.class)

ด้วย

@RunWith(MockitoJUnitRunner.Silent.class)

หรือลบ@RunWith(MockitoJUnitRunner.class)

หรือเพียงแค่แสดงความคิดเห็นเกี่ยวกับการโทรล้อเลียนที่ไม่ต้องการ

ในกรณีที่เป็นโครงการขนาดใหญ่การแก้ไขข้อยกเว้นเหล่านี้แต่ละข้อทำได้ยาก ในเวลาเดียวกันSilentไม่แนะนำให้ใช้ ฉันได้เขียนสคริปต์เพื่อลบส่วนที่ไม่จำเป็นทั้งหมดตามรายการ

https://gist.github.com/cueo/da1ca49e92679ac49f808c7ef594e75b

เราเพียงแค่ต้องคัดลอก - วางmvnผลลัพธ์และเขียนรายการข้อยกเว้นเหล่านี้โดยใช้ regex และปล่อยให้สคริปต์ดูแลส่วนที่เหลือ

เมื่อคุณสร้างการเยาะเย้ยและไม่ได้ใช้การจำลองนั้นจะทำให้เกิดข้อยกเว้นที่ไม่ได้ใช้ ในกรณีของคุณที่ล้อเลียนไม่ได้เรียกว่าจริง ดังนั้นจึงเป็นการโยนข้อผิดพลาดนั้น ดังนั้น relpace @RunWith(MockitoJUnitRunner.class)ด้วย @RunWith(MockitoJUnitRunner.Silent.class)ซึ่งจะลบข้อผิดพลาด หากคุณยังต้องการใช้@RunWith(MockitoJUnitRunner.class)ให้ลองแก้จุดบกพร่องตรรกะของคุณว่าฟังก์ชันที่คุณล้อเลียนนั้นถูกเรียกใช้จริงหรือไม่

หากคุณใช้ใด ๆ () เมื่อเยาะเย้ยคุณต้อง relpace กับ@RunWith(MockitoJUnitRunner.class) @RunWith(MockitoJUnitRunner.Silent.class)