How can I test a Spring controller that uses JDBC?

Question

I have a Spring controller that looks like this:

@RestController
@RequestMapping("/foo")
public class FooController {
    @Autowired
    private NamedParameterJdbcTemplate template;

    @GetMapping("/{name}")
    public List<Foo> byName(@PathVariable String name) {
        Map<String, String> params = new HashMap<>();
        params.put("name", name);
        List<Foo> result = template.query("SELECT * FROM FOOS WHERE FOO_NM = :name", params, new FooRowMapper());
        if (result.size() == 0) {
            throw new ResponseStatusException(HttpStatus.NOT_FOUND, String.format("foo %s not found", name));
        }
        return result;
    }
}

However, I'm not sure how to test this. I can do a basic "Spring can set it up" test:

@SpringBootTest
public class FooControllerTest {
    @Autowired
    private FooController controller;

    @Test
    public void canCreate() {
        Assertions.assertNotNull(controller);
    }
}

But I'm not certain what the right way to test, for example, the byName method is. Do I need to mock something? Can I just test it like a plain Java method (call it with whatever parameters and assert the output)?

Vüsal · Accepted Answer · 2020-07-10 14:03:55Z

1

Do I need to mock something?

It depends on what exactly you need to test. If you write a unit test - then you usually mock external dependencies as you assume, that they will follow some contract.

Can I just test it like a plain Java method (call it with whatever parameters and assert the output)?

Of course, you can, but it will mean that you're testing a bean method, but not the full flow from receiving a http request and returning the response.

If you need to do an end-to-end test you need to run your app and then call your HTTP methods and verify response. For that you can use MockMvc as described in one of the answers.

answered Jul 10, 2020 at 14:03

Vüsal

2,7242 gold badges15 silver badges34 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Salavat Yalalov · Accepted Answer · 2020-07-10 15:24:41Z

It is a bad idea to make a controller that uses JDBC itself. It's much better to use Controller-Service-Repository pattern.

So your code in the Foo controller can be like:

@RestController
@RequestMapping("/foo")
public class FooController {
  @Autowired
  private FooService fooService;
  
  @GetMapping("/{name}")
  public ResponseEntity<?> byName(@PathVariable String name) {
    final List<Foo> list = fooService.getFooByName(name);
    return ResponseEntity.ok(list);
  }
}

For testing purposes it's better to use MockMvc:

// In the Foo controller
@GetMapping("/{name}")
    public ResponseEntity<?> byName(@PathVariable String name) {
        return ResponseEntity.ok("Hello, " + name);
}

// In the Test class
@SpringBootTest
@AutoConfigureMockMvc
class ControllerTests {
    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private FooController fooController;

    @Test
    public void contextLoads() {
        assertThat(fooController, is(notNullValue()));
    }

    @Test
    public void getUser() throws Exception {
        MockHttpServletResponse response = mockMvc.perform(MockMvcRequestBuilders.get("/foo/Joe"))
                .andExpect(status().isOk())
                .andDo(print())
                .andReturn().getResponse();

        assertThat(response.getContentAsString(), is("Hello, Joe"));
    }

}

c-x-berger · Accepted Answer · 2020-07-11 07:12:14Z

1

I'm not the best at all for testing my controllers (I also started not too long ago) And well, I mockup my controller.

class UserControllerTest {

@Autowired
private MockMvc mockMvc;

@Test
void addUserTest() throws Exception {
    String content = "{" +
            "\"username\": \"test\"," +
            "\"password\": \"tesT1234\"," +
            "\"email\": \"[email protected]\"" +
            "}";

    mockMvc.perform(
            MockMvcRequestBuilders.post("/users/signup")
                    .contentType(MediaType.APPLICATION_JSON)
                    .content(content))
            .andExpect(status().isCreated());
}

For example here for a signup user, I build a JSON content and send it to my mock. I check the final status to see if it creates the user.

edited Jul 11, 2020 at 7:12

c-x-berger

1,09114 silver badges36 bronze badges

answered Jul 10, 2020 at 13:56

Alexandre Couzi

382 bronze badges

Comments

k-wasilewski · Accepted Answer · 2020-07-10 13:55:56Z

0

You can test it like a regular Java method or use MockMvc to perform a get request to the relewant path.

It would be nice if you posted the body of your method (right now it’s hard to help).

answered Jul 10, 2020 at 13:55

k-wasilewski

4,6914 gold badges18 silver badges39 bronze badges

2 Comments

c-x-berger Over a year ago

I've added the method body, hope it helps.

k-wasilewski Over a year ago

As I said: learn a bit about MockMvc (it's quite straightforward) or just test it like a normal method.

c-x-berger · Accepted Answer · 2020-07-10 18:13:45Z

After a bit of research and help from the posted answers, I moved the retrieval code into a service:

@Service
public class FooService implements IFooService {
    @Autowired
    private NamedParameterJdbcTemplate template;

    // the only method of IFooService
    @Override
    public List<FormulaFunction> getAllByName(String name) {
        Map<String, String> params = new HashMap<>();
        params.put("name", name);
        return template.query("SELECT * FROM FOOS WHERE FOO_NM = :name", params, new FooRowMapper());
    }
}

In testing the controller, that service is mocked using Mockito:

@WebMvcTest(FooController.class)
public class FooControllerTest {
    @MockBean
    private IFooService service;

    @Autowired
    private FooController controller;

    @Autowired
    private MockMvc mvc;

    @Test
    public void canCreate() {
        Assertions.assertNotNull(controller);
    }

    /**
     * Test that controller properly returns 404 when no results are found
     */
    @Test
    public void test404() throws Exception {
        doReturn(new ArrayList<>()).when(service).getAllByName("bars");
        this.mvc.perform(get("/foo/bars")).andExpect(status().isNotFound());
    }
}

Collectives™ on Stack Overflow

How can I test a Spring controller that uses JDBC?

5 Answers 5

Comments

Comments

Comments

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

Comments

Comments

Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related