ฉีด Mockito mocks ลงใน Spring bean

ฉันต้องการฉีดวัตถุจำลอง Mockito ลงในถั่ว Spring (3+) เพื่อวัตถุประสงค์ในการทดสอบหน่วยกับ JUnit ขณะนี้การพึ่งพาถั่วของฉันถูกฉีดโดยใช้@Autowiredคำอธิบายประกอบในฟิลด์สมาชิกส่วนตัว

ฉันได้พิจารณาการใช้ReflectionTestUtils.setFieldแต่อินสแตนซ์ bean ที่ฉันต้องการฉีดเป็นจริงพร็อกซีและดังนั้นจึงไม่ประกาศเขตข้อมูลสมาชิกส่วนตัวของคลาสเป้าหมาย ฉันไม่ต้องการสร้าง setter สาธารณะเพื่อการพึ่งพาเนื่องจากฉันจะทำการปรับเปลี่ยนอินเตอร์เฟสของฉันอย่างหมดจดเพื่อวัตถุประสงค์ในการทดสอบ

ฉันได้ทำตามคำแนะนำของชุมชน Spring แล้ว แต่การเยาะเย้ยไม่ได้เกิดขึ้นและการเดินสายอัตโนมัติล้มเหลว:

<bean id="dao" class="org.mockito.Mockito" factory-method="mock">
    <constructor-arg value="com.package.Dao" />
</bean>

ข้อผิดพลาดที่ฉันพบในขณะนี้มีดังนี้:

...
Caused by: org...NoSuchBeanDefinitionException:
    No matching bean of type [com.package.Dao] found for dependency:
    expected at least 1 bean which qualifies as autowire candidate for this dependency.
    Dependency annotations: {
        @org...Autowired(required=true),
        @org...Qualifier(value=dao)
    }
at org...DefaultListableBeanFactory.raiseNoSuchBeanDefinitionException(D...y.java:901)
at org...DefaultListableBeanFactory.doResolveDependency(D...y.java:770)

หากฉันตั้งconstructor-argค่าเป็นสิ่งที่ไม่ถูกต้องจะไม่มีข้อผิดพลาดเกิดขึ้นเมื่อเริ่มต้นบริบทของแอปพลิเคชัน

วิธีที่ดีที่สุดคือ:

<bean id="dao" class="org.mockito.Mockito" factory-method="mock"> 
    <constructor-arg value="com.package.Dao" /> 
</bean> 

อัปเดต
ในไฟล์บริบทการเยาะเย้ยนี้จะต้องแสดงรายการก่อนที่จะมีฟิลด์ที่เป็นอัตโนมัติซึ่งขึ้นอยู่กับว่ามันถูกประกาศ

@InjectMocks
private MyTestObject testObject;

@Mock
private MyDependentObject mockedObject;

@Before
public void setup() {
        MockitoAnnotations.initMocks(this);
}

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

ฉันมีวิธีง่ายๆในการใช้ Spring Java Config และ Mockito:

@Configuration
public class TestConfig {

    @Mock BeanA beanA;
    @Mock BeanB beanB;

    public TestConfig() {
        MockitoAnnotations.initMocks(this); //This is a key
    }

    //You basically generate getters and add @Bean annotation everywhere
    @Bean
    public BeanA getBeanA() {
        return beanA;
    }

    @Bean
    public BeanB getBeanB() {
        return beanB;
    }
}

ได้รับ:

@Service
public class MyService {
    @Autowired
    private MyDAO myDAO;

    // etc
}

คุณสามารถมีคลาสที่ถูกทดสอบโหลดผ่านการ autowiring จำลองการพึ่งพา Mockito แล้วใช้ ReflectionTestUtils ของ Spring เพื่อฉีดจำลองลงในคลาสที่กำลังทดสอบ

@ContextConfiguration(classes = { MvcConfiguration.class })
@RunWith(SpringJUnit4ClassRunner.class)
public class MyServiceTest {
    @Autowired
    private MyService myService;

    private MyDAO myDAOMock;

    @Before
    public void before() {
        myDAOMock = Mockito.mock(MyDAO.class);
        ReflectionTestUtils.setField(myService, "myDAO", myDAOMock);
    }

    // etc
}

โปรดทราบว่าก่อนฤดูใบไม้ผลิ 4.3.1 วิธีนี้จะไม่ทำงานกับบริการที่อยู่เบื้องหลังพร็อกซี (หมายเหตุประกอบกับ@TransactionalหรือCacheableตัวอย่าง) สิ่งนี้ได้รับการแก้ไขโดยSPR-14050 SPR-14050

สำหรับรุ่นก่อนหน้าวิธีแก้ปัญหาคือการแกะพร็อกซีดังที่อธิบายไว้ที่นี่: คำอธิบายประกอบธุรกรรมเพื่อหลีกเลี่ยงบริการที่ถูกเยาะเย้ย (ซึ่งเป็นสิ่งที่ReflectionTestUtils.setFieldทำตามค่าเริ่มต้นแล้ว)

หากคุณใช้ Spring Boot 1.4 มันเป็นวิธีที่ยอดเยี่ยมในการทำสิ่งนี้ เพียงแค่ใช้แบรนด์ใหม่@SpringBootTestในชั้นเรียนของคุณและ@MockBeanในเขตข้อมูลและ Spring Boot จะสร้างจำลองประเภทนี้และมันจะฉีดเข้าไปในบริบท (แทนการฉีดของเดิม):

@RunWith(SpringRunner.class)
@SpringBootTest
public class MyTests {

    @MockBean
    private RemoteService remoteService;

    @Autowired
    private Reverser reverser;

    @Test
    public void exampleTest() {
        // RemoteService has been injected into the reverser bean
        given(this.remoteService.someCall()).willReturn("mock");
        String reverse = reverser.reverseSomeCall();
        assertThat(reverse).isEqualTo("kcom");
    }

}

ในทางกลับกันถ้าคุณไม่ได้ใช้ Spring Boot หรือคุณกำลังใช้รุ่นก่อนหน้าคุณจะต้องทำงานอีกเล็กน้อย:

สร้าง@Configurationbean ที่แทรก mocks ของคุณในบริบท Spring:

@Configuration
@Profile("useMocks")
public class MockConfigurer {

    @Bean
    @Primary
    public MyBean myBeanSpy() {
        return mock(MyBean.class);
    }
}

การใช้ @Primaryคำอธิบายประกอบคุณกำลังบอกสปริงว่า bean นี้มีลำดับความสำคัญหากไม่มีการระบุตัวระบุ

ตรวจสอบให้แน่ใจว่าคุณใส่คำอธิบายประกอบชั้นเรียนด้วย@Profile("useMocks")เพื่อควบคุมว่าจะใช้คลาสใดจำลองและตัวไหนจะใช้จริงของถั่ว

ในการทดสอบของคุณให้เปิดใช้งานuserMocksโปรไฟล์:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = {Application.class})
@WebIntegrationTest
@ActiveProfiles(profiles={"useMocks"})
public class YourIntegrationTestIT {

    @Inject
    private MyBean myBean; //It will be the mock!


    @Test
    public void test() {
        ....
    }
}

หากคุณไม่ต้องการใช้จำลอง แต่เป็นถั่วจริงเพียงแค่เปิดใช้งานuseMocksโปรไฟล์:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = {Application.class})
@WebIntegrationTest
public class AnotherIntegrationTestIT {

    @Inject
    private MyBean myBean; //It will be the real implementation!


    @Test
    public void test() {
        ....
    }
}

ตั้งแต่1.8.3 Mockito มี@InjectMocks- มันมีประโยชน์อย่างเหลือเชื่อ การทดสอบ JUnit ของฉันและฉันสร้างวัตถุที่ตอบสนองทุกการอ้างอิงสำหรับการเรียนที่ถูกทดสอบซึ่งจะฉีดทั้งหมดเมื่อสมาชิกส่วนตัวมีการกำกับด้วย@RunWithMockitoJUnitRunner@Mock@InjectMocks

ฉัน@RunWithSpringJUnit4Runnerสำหรับการทดสอบการรวมเฉพาะตอนนี้

ฉันจะทราบว่ามันดูเหมือนจะไม่สามารถฉีดList<T>ในลักษณะเดียวกับฤดูใบไม้ผลิ มันจะค้นหาเฉพาะวัตถุจำลองที่เป็นไปตามListและจะไม่ฉีดรายการวัตถุจำลอง วิธีแก้ปัญหาสำหรับฉันคือการใช้@Spyกับรายการ instantiated ด้วยตนเองและด้วยตนเอง. เพิ่มวัตถุจำลองไปยังรายการสำหรับการทดสอบหน่วย อาจเป็นเพราะเจตนาเพราะแน่นอนว่าบังคับให้ฉันต้องใส่ใจกับสิ่งที่ถูกล้อเลียนด้วยกัน

อัปเดต:ขณะนี้มีวิธีที่ดีกว่าและสะอาดกว่าสำหรับการแก้ไขปัญหานี้ โปรดพิจารณาคำตอบอื่น ๆ ก่อน

ในที่สุดฉันก็พบคำตอบนี้โดยโรนันในบล็อกของเขา ปัญหาผมมีเป็นเพราะวิธีการประกาศประเภทการกลับมาของMockito.mock(Class c) Objectดังนั้น Spring ไม่สามารถอนุมานชนิด bean จากชนิดการคืนเมธอดของ factory

วิธีแก้ปัญหาของ Ronenคือการสร้างการFactoryBeanใช้งานที่ส่งกลับ mocks FactoryBeanอินเตอร์เฟซที่ช่วยให้ฤดูใบไม้ผลิในแบบสอบถามชนิดของวัตถุที่สร้างขึ้นโดยถั่วโรงงาน

คำจำกัดความล้อเลียนของฉันตอนนี้ดูเหมือนว่า:

<bean id="mockDaoFactory" name="dao" class="com.package.test.MocksFactory">
    <property name="type" value="com.package.Dao" />
</bean>

ตั้งแต่ Spring 3.2 นี่ไม่มีปัญหาอีกต่อไป Spring สนับสนุนการ Autowiring ผลลัพธ์ของวิธีการทั่วไปของโรงงาน ดูหัวข้อ "ทั่วไปโรงงานวิธีการ" ในการโพสต์บล็อกนี้: http://spring.io/blog/2012/11/07/spring-framework-3-2-rc1-new-testing-features/

จุดสำคัญคือ:

ในฤดูใบไม้ผลิ 3.2 ประเภทการคืนสินค้าทั่วไปสำหรับวิธีการของโรงงานได้รับการอนุมานอย่างเหมาะสมและการลงทะเบียนอัตโนมัติตามประเภทสำหรับ mocks ควรทำงานตามที่คาดไว้ ด้วยเหตุนี้การแก้ไขปัญหาที่กำหนดเองเช่น MockitoFactoryBean, EasyMockFactoryBean หรือ Springockito จึงไม่มีความจำเป็นอีกต่อไป

ซึ่งหมายความว่าควรทำงานนอกกรอบ:

<bean id="dao" class="org.mockito.Mockito" factory-method="mock">
    <constructor-arg value="com.package.Dao" />
</bean>

โค้ดด้านล่างใช้งานได้กับการเรียกใช้อัตโนมัติ - ไม่ใช่เวอร์ชันที่สั้นที่สุด แต่มีประโยชน์เมื่อมันควรใช้กับไหสปริง / ม็อกโตโตะมาตรฐานเท่านั้น

<bean id="dao" class="org.springframework.aop.framework.ProxyFactoryBean">
   <property name="target"> <bean class="org.mockito.Mockito" factory-method="mock"> <constructor-arg value="com.package.Dao" /> </bean> </property>
   <property name="proxyInterfaces"> <value>com.package.Dao</value> </property>
</bean> 

หากคุณกำลังใช้สปริง> = 3.0ให้ลองใช้@Configurationคำอธิบายประกอบของสปริงเพื่อกำหนดส่วนของบริบทแอปพลิเคชัน

@Configuration
@ImportResource("com/blah/blurk/rest-of-config.xml")
public class DaoTestConfiguration {

    @Bean
    public ApplicationService applicationService() {
        return mock(ApplicationService.class);
    }

}

หากคุณไม่ต้องการใช้ @ImportResource ก็สามารถทำได้เช่นกัน:

<beans>
    <!-- rest of your config -->

    <!-- the container recognize this as a Configuration and adds it's beans 
         to the container -->
    <bean class="com.package.DaoTestConfiguration"/>
</beans>

สำหรับข้อมูลเพิ่มเติมให้ดูที่การอ้างอิงสปริงเฟรมเวิร์ก: การกำหนดค่าคอนเทนเนอร์ที่ใช้ Java

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

ฉันสามารถทำสิ่งต่อไปนี้โดยใช้ Mockito:

<bean id="stateMachine" class="org.mockito.Mockito" factory-method="mock">
    <constructor-arg value="com.abcd.StateMachine"/>
</bean>

การโพสต์ตัวอย่างเล็ก ๆ น้อย ๆ ตามวิธีการข้างต้น

กับฤดูใบไม้ผลิ:

@ContextConfiguration(locations = { "classpath:context.xml" })
@RunWith(SpringJUnit4ClassRunner.class)
public class TestServiceTest {
    @InjectMocks
    private TestService testService;
    @Mock
    private TestService2 testService2;
}

ไม่มีฤดูใบไม้ผลิ:

@RunWith(MockitoJUnitRunner.class)
public class TestServiceTest {
    @InjectMocks
    private TestService testService = new TestServiceImpl();
    @Mock
    private TestService2 testService2;
}

อัปเดต - คำตอบใหม่ที่นี่: https://stackoverflow.com/a/19454282/411229 https://stackoverflow.com/a/19454282/411229คำตอบนี้ใช้ได้เฉพาะกับคำว่า Spring เท่านั้นก่อน 3.2

ฉันได้มองหาคำตอบที่ชัดเจนกว่านี้ โพสต์บล็อกนี้ดูเหมือนจะครอบคลุมทุกความต้องการของฉันและไม่พึ่งพาการสั่งซื้อประกาศถั่ว เครดิตทั้งหมดให้กับ Mattias Severson http://www.jayway.com/2011/11/30/spring-integration-tests-part-i-creating-mock-objects/

โดยทั่วไปใช้ FactoryBean

package com.jayway.springmock;

import org.mockito.Mockito;
import org.springframework.beans.factory.FactoryBean;

/**
 * A {@link FactoryBean} for creating mocked beans based on Mockito so that they 
 * can be {@link @Autowired} into Spring test configurations.
 *
 * @author Mattias Severson, Jayway
 *
 * @see FactoryBean
 * @see org.mockito.Mockito
 */
public class MockitoFactoryBean<T> implements FactoryBean<T> {

    private Class<T> classToBeMocked;

    /**
     * Creates a Mockito mock instance of the provided class.
     * @param classToBeMocked The class to be mocked.
     */
    public MockitoFactoryBean(Class<T> classToBeMocked) {
        this.classToBeMocked = classToBeMocked;
    }

    @Override
    public T getObject() throws Exception {
        return Mockito.mock(classToBeMocked);
    }

    @Override
    public Class<?> getObjectType() {
        return classToBeMocked;
    }

    @Override
    public boolean isSingleton() {
        return true;
    }
}

ถัดไปอัปเดตการกำหนดค่าสปริงด้วยสิ่งต่อไปนี้:

<beans...>
    <context:component-scan base-package="com.jayway.example"/>

    <bean id="someDependencyMock" class="com.jayway.springmock.MockitoFactoryBean">
        <constructor-arg name="classToBeMocked" value="com.jayway.example.SomeDependency" />
    </bean>
</beans>

ดูการพัฒนาของ Springockitoและจำนวนปัญหาเปิดฉันจะกังวลเล็กน้อยที่จะแนะนำในชุดทดสอบของฉันในปัจจุบัน ข้อเท็จจริงที่ว่าการเปิดตัวครั้งสุดท้ายเสร็จสิ้นก่อนที่ Spring 4 จะปล่อยคำถามเช่น "เป็นไปได้หรือไม่ที่จะรวมเข้ากับ Spring 4 ได้อย่างง่ายดาย" ฉันไม่รู้เพราะฉันไม่ได้ลอง ฉันชอบวิธีการสปริงบริสุทธิ์ถ้าฉันต้องการจำลองการทดสอบการรวมตัว

มีตัวเลือกในการปลอมถั่ว Spring ฤดูใบไม้ผลิที่มีคุณสมบัติเพียงธรรมดาคือ คุณจำเป็นต้องใช้@Primary, @Profileและ@ActiveProfilesคำอธิบายประกอบสำหรับมัน ฉันเขียนโพสต์บล็อกในหัวข้อ

ฉันพบคำตอบที่คล้ายกันเป็น teabot เพื่อสร้าง MockFactory ที่ให้ mocks ฉันใช้ตัวอย่างต่อไปนี้เพื่อสร้างโรงงานจำลอง (เนื่องจากลิงก์ไปยัง narkisr ตายแล้ว): http://hg.randompage.org/java/src/407e78aa08a0/projects/bookmarking/backend/spring/src/test/java/ org / randompage / บุ๊คมาร์ค / แบ็กเอนด์ / testUtils / MocksFactory.java

<bean id="someFacade" class="nl.package.test.MockFactory">
    <property name="type" value="nl.package.someFacade"/>
</bean>

สิ่งนี้ยังช่วยป้องกันไม่ให้สปริงต้องการแก้ไขการฉีดจากถั่วที่เยาะเย้ย

<bean id="mockDaoFactory" name="dao" class="com.package.test.MocksFactory">
    <property name="type" value="com.package.Dao" />
</bean>

^ นี้ทำงานได้อย่างสมบูรณ์แบบหากประกาศเป็นครั้งแรก / ต้นในไฟล์ XML Mockito 1.9.0 / Spring 3.0.5

ฉันใช้การผสมผสานของวิธีการที่ใช้ในการตอบโดย Markus T และการใช้งานตัวช่วยอย่างง่ายImportBeanDefinitionRegistrarซึ่งจะมีคำอธิบายประกอบแบบกำหนดเอง ( @MockedBeans) ซึ่งสามารถระบุได้ว่าจะให้คลาสใดถูกเยาะเย้ย ฉันเชื่อว่าวิธีการนี้ส่งผลให้มีการทดสอบหน่วยโดยย่อด้วยรหัสสำเร็จรูปบางส่วนที่เกี่ยวข้องกับการเยาะเย้ยลบออก

นี่คือลักษณะตัวอย่างของการทดสอบหน่วยด้วยวิธีการดังกล่าว:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(loader=AnnotationConfigContextLoader.class)
public class ExampleServiceIntegrationTest {

    //our service under test, with mocked dependencies injected
    @Autowired
    ExampleService exampleService;

    //we can autowire mocked beans if we need to used them in tests
    @Autowired
    DependencyBeanA dependencyBeanA;

    @Test
    public void testSomeMethod() {
        ...
        exampleService.someMethod();
        ...
        verify(dependencyBeanA, times(1)).someDependencyMethod();
    }

    /**
     * Inner class configuration object for this test. Spring will read it thanks to
     * @ContextConfiguration(loader=AnnotationConfigContextLoader.class) annotation on the test class.
     */
    @Configuration
    @Import(TestAppConfig.class) //TestAppConfig may contain some common integration testing configuration
    @MockedBeans({DependencyBeanA.class, DependencyBeanB.class, AnotherDependency.class}) //Beans to be mocked
    static class ContextConfiguration {

        @Bean
        public ExampleService exampleService() {
            return new ExampleService(); //our service under test
        }
    }
}

ในการทำให้สิ่งนี้เกิดขึ้นคุณต้องกำหนดคลาสตัวช่วยอย่างง่ายสองคลาส - หมายเหตุประกอบแบบกำหนดเอง ( @MockedBeans) และการImportBeanDefinitionRegistrarใช้งานแบบกำหนดเอง @MockedBeansคำอธิบายประกอบคำอธิบายประกอบจะต้องมีคำอธิบายประกอบด้วย@Import(CustomImportBeanDefinitionRegistrar.class)และImportBeanDefinitionRgistrarความต้องการที่จะเพิ่มคำจำกัดความถั่วจำลองไปยังการกำหนดค่าในregisterBeanDefinitionsวิธีมัน

ถ้าคุณชอบวิธีการที่คุณสามารถหาตัวอย่างการใช้งานบนของบล็อกโพสต์

ฉันพัฒนาวิธีแก้ปัญหาตามข้อเสนอของ Kresimir Nesek ฉันได้เพิ่มคำอธิบายประกอบใหม่@EnableMockedBeanเพื่อให้โค้ดเป็นบิตที่สะอาดและเป็นโมดูล

@EnableMockedBean
@SpringBootApplication
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes=MockedBeanTest.class)
public class MockedBeanTest {

    @MockedBean
    private HelloWorldService helloWorldService;

    @Autowired
    private MiddleComponent middleComponent;

    @Test
    public void helloWorldIsCalledOnlyOnce() {

        middleComponent.getHelloMessage();

        // THEN HelloWorldService is called only once
        verify(helloWorldService, times(1)).getHelloMessage();
    }

}

ฉันเขียนโพสต์เพื่ออธิบาย

ฉันขอแนะนำให้ย้ายโครงการของคุณไปที่ Spring Boot 1.4 หลังจากนั้นคุณสามารถใช้คำอธิบายประกอบใหม่@MockBeanเพื่อปลอมของคุณcom.package.Dao

วันนี้ฉันพบว่าบริบทของฤดูใบไม้ผลิที่ฉันประกาศก่อนถั่ว Mockito ไม่สามารถโหลดได้ หลังจากย้าย AFTER ไปที่ mocks บริบทของแอปจะถูกโหลดสำเร็จ ดูแล :)

สำหรับบันทึกการทดสอบทั้งหมดของฉันทำงานอย่างถูกต้องเพียงแค่ทำการฟิกซ์เจอร์สันหลังยาวที่เริ่มต้นได้เช่น:

<bean id="fixture"
      class="it.tidalwave.northernwind.rca.embeddedserver.impl.DefaultEmbeddedServer"
      lazy-init="true" /> <!-- To solve Mockito + Spring problems -->

<bean class="it.tidalwave.messagebus.aspect.spring.MessageBusAdapterFactory" />

<bean id="applicationMessageBus"
      class="org.mockito.Mockito" factory-method="mock">
    <constructor-arg value="it.tidalwave.messagebus.MessageBus" />
</bean>

<bean class="org.mockito.Mockito" factory-method="mock">
    <constructor-arg value="javax.servlet.ServletContext" />
</bean>

ฉันคิดว่าเหตุผลเป็นหนึ่งใน Mattias อธิบายที่นี่ (ที่ด้านล่างของโพสต์) ว่าการแก้ปัญหาจะเปลี่ยนลำดับถั่วประกาศ - เริ่มต้นขี้เกียจคือ "การเรียงลำดับ" มีการติดตั้งประกาศในตอนท้าย

หากคุณใช้ Controller Injection ตรวจสอบให้แน่ใจว่าตัวแปรในเครื่องของคุณไม่ใช่ "ขั้นสุดท้าย"