Skip to main content

Mock unit testing with Mockito and Spring (Ejb and Rest service)

In this tutorial we are going to learn about mock unit testing. We are using here Mockito with Spring to write unit tests. We will also see how to mock an EJB session bean inside mocked service without constructor/setters injection.

What is mocking

Mocking is a technique to replace the actual implementation with some dummy or provided code chunk during unit testing. For example if we need to unit test some service which persist data to database then we can mock that persist method to add it to some in-memory collection. Also we can mock data retrieval to get the data from same collection or so. Mockito provide various class and features to implement the mocking seamlessly.

Maven dependency

We are using Spring (XML base configuration) and mockito for mock testing. Below dependencies are required.
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>4.1.9.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
        <version>4.1.9.RELEASE</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-core</artifactId>
        <version>1.10.19</version>
        <scope>test</scope>
    </dependency>

Spring configuration XML

Below is our configuration for spring where we enable annotation based processing. Also we are creating a bean for EJB session bean.
  1. Spring namespace and schema declaration

  2. <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:mvc="http://www.springframework.org/schema/mvc"
        xmlns:jee="http://www.springframework.org/schema/jee"
    
        xsi:schemaLocation="http://www.springframework.org/schema/beans
                http://www.springframework.org/schema/beans/spring-beans.xsd
                http://www.springframework.org/schema/schema/context
                http://www.springframework.org/schema/context/spring-context.xsd
                http://www.springframework.org/schema/mvc
                http://www.springframework.org/schema/mvc/spring-mvc.xsd
                http://www.springframework.org/schema/jee
                http://www.springframework.org/schema/jee/spring-jee.xsd">
    
  3. Configure annotation processing

  4.     <context:component-scan base-package="com.ttj.rest"/>
        <context:component-scan base-package="com.ttj.misc"/>
    
        <mvc:annotation-driven/>
    
  5. Bean declaration for EJB Session Bean

  6.     <jee-local-slsb id="ejbSessionBean" jndi-name="ejb/MyEjbSessionBean"
            business-interface="com.ttj.ejb.MyBusinessInterface" />
    

Rest Service

Below is the Rest service where we inject the ejb session bean using business interface. We invoke the method on EJB bean and then return the same response as a service call response.
@RestController
public class MyController{
    @Resource(name="ejbSessionBean")
    private MyBusinessInterface ejbSessionBean;

    @RequestMapping(value="/message", method=RequestMethod.GET,
                produces=MediaType.APPLICATION_JSON_VALUE)
    public String getUserMessageFromEjb(){
        return ejbSessionBean.getUserMessage();
    }
}

Unit Test using Mockito

Now we will create out unit test using mockito where we will mock the EJB session bean which will be injected in Rest service. Then this rest service will use mocked ejb bean to provide the response.
  1. Required annotations

  2. Here we are using @RunWith annotation to enable the Spring's dependency injection and @ContextConfiguration to makes Spring to scan mentioned classes. Please note that Spring will not load context configuration XML from WEB-INF by default, so we need to configure the scanning of required classes.
    @RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(class={MyController.class, MyControllerTest.class})
    public class MyControllerTest{
    
  3. Mocking EJB bean

  4. In below code we are creating a mocked bean which will automatically bind with controller class as controller class binds it using the bean ID.
        @Bean
        public MyBusinessInterface ejbSessionBean(){
            MyBusinessInterface bean = Mockito.mock(MyBusinessInterface.class);
            Mockito.when(bean.getUserMessage()).thenReturn("Dummy message");
            return bean;
        } 
    
  5. Writing Test case

  6. In below code we autowire the controller class and then uses it to write the unit test.
        @Autowired
        private MyController controller;
    
        @Test
        public void getUserMessageFromEjbTest(){
            String exp = "Dummy message");
            Assert.assertEquals(exp, controller.getUserMessageFromEjb());
        }
    
Now you can execute the maven build to run the test.

Comments

Post a Comment

Popular Posts

Setting up kerberos in Mac OS X

Kerberos in MAC OS X Kerberos authentication allows the computers in same domain network to authenticate certain services with prompting the user for credentials. MAC OS X comes with Heimdal Kerberos which is an alternate implementation of the kerberos and uses LDAP as identity management database. Here we are going to learn how to setup a kerberos on MAC OS X which we will configure latter in our application. Installing Kerberos In MAC we can use Homebrew for installing any software package. Homebrew makes it very easy to install the kerberos by just executing a simple command as given below. brew install krb5 Once installation is complete, we need to set the below export commands in user's profile which will make the kerberos utility commands and compiler available to execute from anywhere. Open user's bash profile: vi ~/.bash_profile Add below lines: export PATH=/usr/local/opt/krb5/bin:$PATH export PATH=/usr/local/opt/krb5/sbin:$PATH export LDFLAGS=&

SpringBoot - @ConditionalOnProperty example for conditional bean initialization

@ConditionalOnProperty annotation is used to check if specified property available in the environment or it matches some specific value so it can control the execution of some part of code like bean creation. It may be useful in many cases for example enable/disable service if specific property is available. Below are the attributes which can be used for property check. havingValue - Provide the value which need to check against specified property otherwise it will check that value should not be false. matchIfMissing - If true it will match the condition and execute the annotated code when property itself is not available in environment. name - Name of the property to be tested. If you want to test single property then you can directly put the property name as string like "property.name" and if you have multiple properties to test then you can put the names like {"prop.name1","prop.name2"} prefix - It can be use when you want to apply some prefix to

Multiple data source with Spring boot, batch and cloud task

Here we will see how we can configure different datasource for application and batch. By default, Spring batch stores the job details and execution details in database. If separate data source is not configured for spring batch then it will use the available data source in your application if configured and create batch related tables there. Which may be the unwanted burden on application database and we would like to configure separate database for spring batch. To overcome this situation we will configure the different datasource for spring batch using in-memory database, since we don't want to store batch job details permanently. Other thing is the configuration of  spring cloud task in case of multiple datasource and it must point to the same data source which is pointed by spring batch. In below sections, we will se how to configure application, batch and cloud task related data sources. Application Data Source Define the data source in application properties or yml con

Entity to DTO conversion in Java using Jackson

It's very common to have the DTO class for a given entity in any application. When persisting data, we use entity objects and when we need to provide the data to end user/application we use DTO class. Due to this we may need to have similar properties on DTO class as we have in our Entity class and to share the data we populate DTO objects using entity objects. To do this we may need to call getter on entity and then setter on DTO for the same data which increases number of code line. Also if number of DTOs are high then we need to write lot of code to just get and set the values or vice-versa. To overcome this problem we are going to use Jackson API and will see how to do it with minimal code only. Maven dependency <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.9</version> </dependency> Entity class Below is