不要なスタブの例外を解決する方法

私のコードは以下の通りです、

@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番目に、if / switch分岐がコードのどこかに分岐しているため、モックされたメソッドが呼び出されません。

これが最初のケースである場合は、コードで使用されているメソッドのモックメソッドを常に変更する必要があります。2番目と3番目では状況によって異なります。通常、このモックが不要な場合は削除してください。ただし、パラメーター化されたテストで特定のケースが発生することもあります。この場合、この別の方法を取るか、早期に失敗します。次に、このテストを2つ以上の個別のテストに分割できますが、それが常に良いとは限りません。おそらく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
 ...

テストの実行中に、スタブメソッドの1つがテスト中のコードで実現されなかったことに注意してください。浮遊スタブは、開発者の見落とし、コピーと貼り付けのアーティファクト、またはテスト/コードを理解できない影響である可能性があります。いずれにせよ、開発者は不要なテストコードを取得することになります。コードベースをクリーンで保守可能な状態に保つには、不要なコードを削除する必要があります。それ以外の場合、テストは読みにくく、理由付けが困難です。

未使用のスタブの検出の詳細については、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ここで何かをするあなたのモックを設定します。ただし、この行以降は、このモックを使用しません（を実行することを除く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();
    }
}

必要に応じて、テストをスタブにリファクタリングすることを検討します。

代わりにこのスタイルを使用している場合：

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

に置き換えてください：

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

交換する

@RunWith(MockitoJUnitRunner.class)

と

@RunWith(MockitoJUnitRunner.Silent.class)

または削除@RunWith(MockitoJUnitRunner.class)

または、（不正なスタブとして表示される）不要なモッ​​クコールをコメントアウトする

SpyオブジェクトでメソッドUnnecessaryStubbingExceptionを使おうとしたときのことwhenです。 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);
    }
}

まあ、私の場合、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)
}

次に、whenステートメントで言及されている実際のメソッドを呼び出して、メソッドをモックしました。

行われた変更は以下の通りです 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)
}

それは今働いています。

大規模なプロジェクトの場合、これらの例外のそれぞれを修正することは困難です。同時に、使用Silentはお勧めしません。それらのリストを指定して、不要なスタブをすべて削除するスクリプトを作成しました。

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

mvn出力をコピーして貼り付け、正規表現を使用してこれらの例外のリストを記述し、スクリプトに残りの処理を任せるだけです。

モックするときにany（）を使用する場合は、@ RunWith（MockitoJUnitRunner.class）を@RunWith（MockitoJUnitRunner.Silent.class）で改造する必要があります。

モックを作成し、そのモックが使用されていない場合、未使用のスタブ例外がスローされます。あなたの場合、そのモックは実際には呼び出されません。したがって、そのエラーをスローしています。したがって、どちら@RunWith(MockitoJUnitRunner.class)を@RunWith(MockitoJUnitRunner.Silent.class)使用すればエラーは解消され ます。それでも使用したい@RunWith(MockitoJUnitRunner.class)場合は、モックした関数が実際に呼び出されているかどうかにかかわらず、ロジックをデバッグしてみてください。