TestRestTemplate for full integration in Spring Boot

Introduction

TestRestTemplate helps you test your whole Spring Boot app by making real HTTP calls to your running server. It shows if your app works end-to-end.

You want to check if your REST API endpoints respond correctly.

You need to test how your app handles real HTTP requests and responses.

You want to verify the integration of controllers, services, and repositories together.

You want to test your app with real data and HTTP status codes.

You want to simulate client calls to your Spring Boot app in tests.

Syntax

Spring Boot

@Autowired
private TestRestTemplate restTemplate;

ResponseEntity<Type> response = restTemplate.getForEntity("/api/path", Type.class);

Use @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT) to start the server on a random port for testing.

TestRestTemplate is injected automatically by Spring Boot in test classes.

Examples

This example tests a GET request to the /hello endpoint and checks the response status and body.

Spring Boot

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class MyIntegrationTest {

  @Autowired
  private TestRestTemplate restTemplate;

  @Test
  void testGet() {
    ResponseEntity<String> response = restTemplate.getForEntity("/hello", String.class);
    assertEquals(HttpStatus.OK, response.getStatusCode());
    assertEquals("Hello World", response.getBody());
  }
}

This sends a POST request with newItem and expects a MyObject response.

Spring Boot

ResponseEntity<MyObject> response = restTemplate.postForEntity("/api/items", newItem, MyObject.class);

Sample Program

This full example shows a simple Spring Boot app with a /hello endpoint. The test uses TestRestTemplate to call the endpoint and check the response.

Spring Boot

@SpringBootApplication
public class DemoApplication {
  public static void main(String[] args) {
    SpringApplication.run(DemoApplication.class, args);
  }
}

@RestController
class HelloController {
  @GetMapping("/hello")
  public String sayHello() {
    return "Hello World";
  }
}

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class HelloControllerIntegrationTest {

  @Autowired
  private TestRestTemplate restTemplate;

  @Test
  void testHelloEndpoint() {
    ResponseEntity<String> response = restTemplate.getForEntity("/hello", String.class);
    assertEquals(HttpStatus.OK, response.getStatusCode());
    assertEquals("Hello World", response.getBody());
  }
}

Important Notes

TestRestTemplate works only in tests with a running Spring Boot server.

Use webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT to avoid port conflicts.

You can test all HTTP methods: GET, POST, PUT, DELETE using TestRestTemplate methods.

Summary

TestRestTemplate lets you test your app like a real client using HTTP calls.

It helps verify your full app integration, not just parts of it.

Use it in Spring Boot tests with a running server on a random port.

Practice

1. What is the main purpose of TestRestTemplate in a Spring Boot application?

easy

A. To perform real HTTP requests for full integration testing

B. To mock database calls during unit tests

C. To replace the main application context

D. To generate API documentation automatically

Solution

1. Step 1: Understand TestRestTemplate's role

   TestRestTemplate is designed to send HTTP requests to the running Spring Boot app during tests.

2. Step 2: Compare with other testing tools

   Unlike mocks or stubs, it tests the full app stack by making real HTTP calls.

3. Final Answer:

   To perform real HTTP requests for full integration testing -> Option A

4. Quick Check:

   TestRestTemplate = real HTTP requests [OK]

Hint: Remember: TestRestTemplate tests full app via HTTP [OK]

Common Mistakes:

• Confusing TestRestTemplate with mocking tools
• Thinking it replaces application context
• Assuming it auto-generates docs

2. Which annotation combination is correct to enable TestRestTemplate with a random port in a Spring Boot test?

easy

A. @SpringBootTest(webEnvironment = WebEnvironment.MOCK)

B. @SpringBootTest(webEnvironment = WebEnvironment.NONE)

C. @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)

D. @SpringBootTest(webEnvironment = WebEnvironment.DEFINED_PORT)

Solution

1. Step 1: Identify webEnvironment for real HTTP tests

   Using RANDOM_PORT starts the server on a random port for real HTTP calls.

2. Step 2: Understand other options

   NONE disables web environment, MOCK uses mock servlet environment, DEFINED_PORT uses fixed port.

3. Final Answer:

   @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) -> Option C

4. Quick Check:

   RANDOM_PORT enables real HTTP server [OK]

Hint: Use RANDOM_PORT for real HTTP server in tests [OK]

Common Mistakes:

• Using MOCK disables real HTTP server
• Choosing NONE disables web environment
• Assuming DEFINED_PORT is random

3. Given this test snippet using TestRestTemplate:

var response = restTemplate.getForEntity("/api/greet", String.class);
System.out.println(response.getStatusCodeValue());
System.out.println(response.getBody());

If the endpoint /api/greet returns HTTP 200 and body "Hello!", what will be printed?

medium

A. 200\nnull

B. 404\nNot Found

C. 500\nInternal Server Error

D. 200\nHello!

Solution

1. Step 1: Understand getForEntity behavior

   It sends GET request and returns response with status and body.

2. Step 2: Match expected endpoint response

   The endpoint returns 200 status and "Hello!" body, so these print exactly.

3. Final Answer:

   200\nHello! -> Option D

4. Quick Check:

   Status 200 and body "Hello!" printed [OK]

Hint: Response status and body print as returned by endpoint [OK]

Common Mistakes:

• Assuming 404 if endpoint not found in test
• Expecting null body when response is valid
• Confusing status code with body content

4. Consider this test code snippet:

@Autowired
private TestRestTemplate restTemplate;

@Test
public void testGetUser() {
  var response = restTemplate.getForEntity("/users/1", User.class);
  assertEquals(200, response.getStatusCodeValue());
}

If the test fails with a NullPointerException on restTemplate.getForEntity, what is the most likely cause?

medium

A. The test method is missing @Test annotation

B. TestRestTemplate was not injected because @SpringBootTest annotation is missing

C. User class is not serializable

D. The endpoint /users/1 does not exist

Solution

1. Step 1: Identify cause of NullPointerException

   NullPointerException on restTemplate means it was never set (null).

2. Step 2: Check test setup annotations

   Without @SpringBootTest, Spring does not create context or inject beans like TestRestTemplate.

3. Final Answer:

   TestRestTemplate was not injected because @SpringBootTest annotation is missing -> Option B

4. Quick Check:

   Missing @SpringBootTest causes null injection [OK]

Hint: NullPointer on restTemplate means missing @SpringBootTest [OK]

Common Mistakes:

• Blaming missing endpoint for NullPointerException
• Assuming serialization error causes NPE
• Forgetting to add @Test annotation

5. You want to write a full integration test using TestRestTemplate that posts JSON data to /api/items and verifies the created item's ID is returned. Which code snippet correctly performs this test?

hard

A. var item = new Item(null, "Book");
var response = restTemplate.postForEntity("/api/items", item, Item.class);
assertEquals(201, response.getStatusCodeValue());
assertNotNull(response.getBody().getId());

B. var item = new Item(null, "Book");
var response = restTemplate.getForEntity("/api/items", Item.class);
assertEquals(201, response.getStatusCodeValue());

C. var item = new Item(null, "Book");
var response = restTemplate.postForObject("/api/items", item, Item.class);
assertEquals(404, response.getStatusCodeValue());

D. var item = new Item(null, "Book");
var response = restTemplate.exchange("/api/items", HttpMethod.GET, null, Item.class);
assertEquals(201, response.getStatusCodeValue());

Solution

1. Step 1: Identify correct HTTP method for creating resource

   POST is used to create new items, so postForEntity is appropriate.

2. Step 2: Verify response status and body

   201 status means created; response body should contain new item's ID, so assertNotNull on getId() is correct.

3. Final Answer:

   Code snippet using postForEntity with POST and checking 201 and ID -> Option A

4. Quick Check:

   POST + 201 + returned ID = correct test [OK]

Hint: Use postForEntity and check 201 plus returned ID [OK]

Common Mistakes:

• Using GET instead of POST for creation
• Expecting 404 instead of 201 status
• Using postForObject without status check