TestRestTemplate for full integration in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is TestRestTemplate used for in Spring Boot testing?

<p><code>TestRestTemplate</code> is a helper class in Spring Boot used to perform full integration tests by sending HTTP requests to a running server and receiving responses. It simulates real client calls to your REST API.</p>

beginner

How do you inject TestRestTemplate in a Spring Boot test?

<p>You can inject <code>TestRestTemplate</code> by adding it as a field with <code>@Autowired</code> in a test class annotated with <code>@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)</code>.</p>

intermediate

What does SpringBootTest.WebEnvironment.RANDOM_PORT do?

This setting starts the Spring Boot application on a random free port during tests. It allows TestRestTemplate to send real HTTP requests to the running server without port conflicts.

beginner

How do you send a GET request using TestRestTemplate?

<p>Use the method <code>getForEntity(url, responseType)</code> where <code>url</code> is the endpoint and <code>responseType</code> is the expected class of the response body.</p>

intermediate

Why is TestRestTemplate preferred over RestTemplate in Spring Boot integration tests?

TestRestTemplate is configured automatically for tests, supports authentication, and integrates with Spring Boot's test environment, making it easier and safer to use in integration tests than the standard RestTemplate.

Which annotation is required to start a Spring Boot app on a random port for TestRestTemplate?

A @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)

B @WebMvcTest

C @DataJpaTest

D @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.MOCK)

Only @SpringBootTest with RANDOM_PORT starts the full app on a random port for real HTTP calls.

How do you perform a POST request with TestRestTemplate?

A postForEntity(url, requestBody, responseType)

B getForEntity(url, responseType)

C exchange(url, HttpMethod.GET, null, responseType)

D delete(url)

Use postForEntity to send POST requests with a body.

What does getForEntity return?

A A raw HTTP connection

B ResponseEntity with status, headers, and body

C Only the HTTP status code

D Only the response body

getForEntity returns a ResponseEntity that contains status, headers, and body.

Which of these is NOT a benefit of using TestRestTemplate?

A Automatic integration with Spring Boot test context

B Supports authentication easily

C Runs tests without starting the server

D Sends real HTTP requests to the app

TestRestTemplate requires the server to be running; it does not mock or skip server startup.

How do you inject TestRestTemplate in your test class?

A Using <code>@MockBean</code>

B Using <code>@Value</code> annotation

C Manually creating new instance

D Using <code>@Autowired</code> annotation

@Autowired injects the configured TestRestTemplate bean automatically.

Explain how TestRestTemplate helps in full integration testing of a Spring Boot REST API.

Think about how a real client talks to your app during tests.

Describe the steps to set up and use TestRestTemplate in a Spring Boot integration test.

Focus on annotations, injection, and usage.

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