How can I test a my rest controller that has feign clients?

Question

I have a rest controller that is using 2 fein clients, I want to write and test the Rest controller with different samples, I am not an expert at writing springboot tests.

In this scenario I have no repositories to test with, just feign clients accessed through a rest controller. Below is my testing controller code

@RestController
public class CustomerController {

    @Autowired
    private CustomerClient customerClient;

    @Autowired
    private PaymentsClient paymentsClient;

    @RequestMapping(path = "/getAllCustomers", method = RequestMethod.GET)
    public ResponseEntity<Object> getAllCustomers() {
        List<Customer> customers = customerClient.getAllCustomers();
        return new ResponseEntity<>(customers, HttpStatus.OK);

    }

    @RequestMapping(path = "/{customerId}", method = RequestMethod.GET)
    public ResponseEntity<Object> get(@PathVariable() long customerId) {
        try {
            Customer c = customerClient.getCustomerById(customerId);
            if (c != null) {
                return new ResponseEntity<>(c, HttpStatus.OK);
            } else {
                return ResponseEntity.status(HttpStatus.NOT_FOUND).body("Customer Not Found");
            }
        } catch (Exception e) {
            e.printStackTrace();
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage());
        }
    }

    @RequestMapping(path = "/{customerId}", method = RequestMethod.PATCH)
    public ResponseEntity<Object> UpdateCustomer(@PathVariable() Long customerId, @RequestBody Customer customer) {
        Customer c;
        try {
            c = customerClient.update(customerId, customer);
            if (c != null) {
                return new ResponseEntity<>(c, HttpStatus.OK);
            } else {
                return ResponseEntity.status(HttpStatus.NOT_FOUND).body("Customer Not Found");
            }
        } catch (Exception e) {
            e.printStackTrace();
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage());
        }
    }

    @RequestMapping(path = "", method = RequestMethod.POST)
    public ResponseEntity<Object> saveCustomer(@RequestBody Customer customer) {
        Customer c;
        try {
            c = customerClient.saveCustomer(customer);
            return new ResponseEntity<>(c, HttpStatus.OK);
        } catch (Exception e) {
            e.printStackTrace();
            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage());
        }
    }

    @RequestMapping(path = "/registerPayment", method = RequestMethod.POST)
    public ResponseEntity<Object> saveCustomer(@RequestBody Payment payment) {
        Payment p = null;
        Customer c = null;
        try {
            c = customerClient.getCustomerById(payment.getCustomerId());
            p = paymentsClient.saveCustomer(payment);
            return new ResponseEntity<>(p, HttpStatus.OK);
        } catch (Exception e) {
            if (null == c) {
                return ResponseEntity.status(HttpStatus.UNPROCESSABLE_ENTITY).body("Customer Does not Exist");
            } else {
                e.printStackTrace();
                return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(e.getMessage());
            }
        }
    }

Most of the tests I have seen have a repository injected in but for my case I dont have those, just fein clients, Im I doing it wrong,

Below is my current test

@RunWith(SpringRunner.class)
@SpringBootTest
@ActiveProfiles("test")
public class CustomerControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @InjectMocks
    private CustomerController customerController;

    @Before
    public void setup() {

        mockMvc = MockMvcBuilders.standaloneSetup(customerController).build();
    }

    @Test
    public void getAllCustomers() {

        try {
            this.mockMvc.perform(get("/getAllCustomers")).andExpect(status().isOk())
                    .andExpect(content().json("[{\n" + "    \"customerId\": 24,\n"
                            + "    \"firstName\": \"Benjamin\",\n" + "    \"secondName\": \" Masiga\",\n"
                            + "    \"email\": \"ben@ben.com\"\n" + "  }"));
        } catch (Exception e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

}

I'm getting the error below,

NoSuchBeanDefinitionException: No qualifying bean of type 'org.springframework.test.web.servlet.MockMvc' available: expected at least 1 bean which qualifies as autowire candidate.

I think you need to add ```@AutoConfigureMockMvc``` additionally to configure MockMvc. — Barath, Mar 28 '19 at 05:56

score 1 · Accepted Answer · answered Mar 27 '19 at 19:17

Its as simple as writing any other JUnit test.

@RunWith(SpringRunner.class)
@SpringBootTest
@ActiveProfiles("test")
public class CustomerControllerTest {

    @Mock
    private CustomerClient customerClient;

    @InjectMocks
    private CustomerController customerController;

    @Test
    public void getAllCustomers() {
        List<Customer> customers = new ArrayList<>();
        customers.add(new Customers("name"));
        Mockito.when(customerClient.getAllCustomers()).thenReturn(customers);
        Mockito.assertEquals(customers.toString(),customerController.getAllCustomers())
    }

}

The original question uses MockMvc, not calling the controller directly! — Shmarkus, Dec 01 '20 at 09:52

score 1 · Answer 2 · answered Nov 19 '20 at 20:22

You need your own feign.Client that works beyond MockMvc:

import static java.nio.charset.StandardCharsets.UTF_8;
import static java.util.function.Function.identity;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.request;

import feign.Client;
import feign.Request;
import feign.Response;
import java.io.UncheckedIOException;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URLDecoder;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Collectors;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.ResultActions;
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;

public class MockMvcFeignClient implements Client {

    private final MockMvc mockMvc;

    public MockMvcFeignClient(MockMvc mockMvc) {
        this.mockMvc = mockMvc;
    }

    @Override
    public Response execute(Request request, Request.Options options) {
        URI requestUrl = URI.create(request.url());
        List<String> uriVars = new ArrayList<>();
        String urlTemplate = fillVarsAndGetUrlTemplate(requestUrl, uriVars);
        HttpMethod method = HttpMethod.valueOf(request.method());
        byte[] body = request.body();
        HttpHeaders httpHeaders = convertHeaders(request);

        MockHttpServletRequestBuilder requestBuilder = request(method, urlTemplate, uriVars.toArray())
                .headers(httpHeaders)
                .content(body);

        MockHttpServletResponse resp;
        try {
            ResultActions resultActions = mockMvc.perform(requestBuilder);
            resp = resultActions.andReturn()
                    .getResponse();
        } catch (Exception e) {
            throw new IllegalStateException("Error while executing request", e);
        }

        return convertResponse(request, resp);
    }

    static String fillVarsAndGetUrlTemplate(URI requestUrl, List<String> uriVars) {
        StringBuilder urlTemplate = new StringBuilder(requestUrl.getPath());
        if (requestUrl.getQuery() != null) {
            urlTemplate.append('?');
            String[] pairs = requestUrl.getRawQuery().split("&");
            for (int i = 0; i < pairs.length; i++) {
                String pair = pairs[i];
                int separator = pair.indexOf('=');
                String paramName;
                String paramValue;
                if (separator < 0) {
                    paramName = pair;
                    paramValue = null;
                } else {
                    paramName = pair.substring(0, separator);
                    try {
                        paramValue = URLDecoder.decode(pair.substring(separator + 1), UTF_8.name());
                    } catch (UnsupportedEncodingException e) {
                        throw new UncheckedIOException(e);
                    }
                }
                urlTemplate.append(i == 0 ? paramName : "&" + paramName);
                if (paramValue != null) {
                    urlTemplate.append("={").append(paramName).append('}');
                    uriVars.add(paramValue);
                }
            }
        }
        return urlTemplate.toString();
    }

    private static HttpHeaders convertHeaders(Request request) {
        HttpHeaders headers = new HttpHeaders();
        request.headers().forEach((header, values) -> headers.put(header, new ArrayList<>(values)));
        return headers;
    }

    private static Response convertResponse(Request request, MockHttpServletResponse resp) {
        return Response.builder()
                .request(request)
                .status(resp.getStatus())
                .body(resp.getContentAsByteArray())
                .headers(resp.getHeaderNames().stream()
                        .collect(Collectors.toMap(identity(), resp::getHeaders)))
                .build();
    }
}

and create your feign client with it:

return Feign.builder()
        .client(new MockMvcFeignClient(mockMvc))
        ...

So for tests where you could make MockMvc integration tests, now you can call it via feign client.

score 1 · Answer 3 · answered May 30 '23 at 17:41

@InjectMocks should only be used if you want to run pure Java unit-tests that ignore the Spring Framework. When you run a @SpringBootTest, the Spring framework attempts to initialize and inject all of the beans into the application context. @InjectMocks does not do this! If you want to test that your SpringBoot application is configured correctly, you should add your FeignClients as @MockBeans. The SpringFramework will replace the real instances of your classes with mock versions. You can then modify behavior just like any other mock object. Here is an example:

Integration Test

@RunWith(SpringRunner.class)
@SpringBootTest
@ActiveProfiles("test")
public class CustomerControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private CustomerController customerController;

    @MockBean
    private CustomerClient customerClient;

    @MockBean
    private PaymentsClient paymentsClient;

    @Before
    public void setup() {

        mockMvc = MockMvcBuilders.standaloneSetup(customerController).build();
    }

    @Test
    public void getAllCustomers() {
Customer customer = new Customer();
customer.setCustomerId(24);
customer.setFirstName("Benjamin");
customer.setSecondName("Masiga");
customer.setEmail("ben@ben.com");
 Mockito.when(customerClient.getAllCustomers()).thenReturn(Arrays.asList(customer));
   
            this.mockMvc.perform(get("/getAllCustomers")).andExpect(status().isOk())
                    .andExpect(content().json("[{\n" + "    \"customerId\": 24,\n"
                            + "    \"firstName\": \"Benjamin\",\n" + "    \"secondName\": \" Masiga\",\n"
                            + "    \"email\": \"ben@ben.com\"\n" + "  }"));
   
    }

}

How can I test a my rest controller that has feign clients?

3 Answers3