@SpringBootTest for integration tests

Introduction

@SpringBootTest helps you run your whole Spring Boot app in a test. It makes sure all parts work together, not just small pieces.

When you want to test if your app starts correctly with all settings.

When you need to check if different parts of your app work together.

When you want to test your database connection and data access.

When you want to test your REST controllers with real HTTP calls.

When you want to verify your app’s full behavior, not just one class.

Syntax

Spring Boot

@SpringBootTest
public class YourTestClass {

    @Test
    void testSomething() {
        // test code here
    }
}

This annotation tells Spring Boot to start the full application context for tests.

You can add properties or specify web environment if needed.

Examples

Basic test to check if Spring Boot app starts without errors.

Spring Boot

@SpringBootTest
public class SimpleIntegrationTest {

    @Test
    void contextLoads() {
        // test if app context starts
    }
}

Starts app with a random port to test web endpoints.

Spring Boot

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class WebIntegrationTest {

    @LocalServerPort
    private int port;

    @Test
    void testHttpCall() {
        // use port to call REST endpoints
    }
}

Overrides properties for testing with an in-memory database.

Spring Boot

@SpringBootTest(properties = {"spring.datasource.url=jdbc:h2:mem:testdb"})
public class DatabaseIntegrationTest {

    @Autowired
    private UserRepository userRepository;

    @Test
    void testDatabase() {
        // test database access
    }
}

Sample Program

This test starts the full Spring Boot app on a random port. It uses RestTemplate to call the /greeting endpoint and checks if the response contains "Hello, World".

Spring Boot

package com.example.demo;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.web.client.RestTemplate;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class GreetingIntegrationTest {

    @LocalServerPort
    private int port;

    @Autowired
    private RestTemplate restTemplate;

    @Test
    void greetingShouldReturnDefaultMessage() {
        String url = "http://localhost:" + port + "/greeting";
        String response = restTemplate.getForObject(url, String.class);
        assertThat(response).contains("Hello, World");
    }
}

Important Notes

Use @SpringBootTest only for integration tests because it starts the whole app and can be slow.

For faster tests of small parts, use @WebMvcTest or @DataJpaTest instead.

Remember to clean up or isolate data when testing with databases.

Summary

@SpringBootTest runs your full Spring Boot app for testing.

It helps check if all parts work together correctly.

Use it mainly for integration tests, not small unit tests.

Practice

1. What is the main purpose of using @SpringBootTest in a Spring Boot project?

easy

A. To configure database connections only

B. To mock all dependencies automatically

C. To run unit tests without loading Spring context

D. To load the full application context for integration testing

Solution

1. Step 1: Understand what @SpringBootTest does

   This annotation loads the entire Spring Boot application context, allowing tests to run with all beans and configurations loaded.

2. Step 2: Compare with other testing annotations

   Unlike unit tests or mocks, @SpringBootTest is used for integration tests that need the full app context.

3. Final Answer:

   To load the full application context for integration testing -> Option D

4. Quick Check:

   @SpringBootTest = full app context load [OK]

Hint: Remember: @SpringBootTest loads full app context for integration [OK]

Common Mistakes:

• Thinking it mocks all dependencies automatically
• Confusing it with unit test annotations
• Assuming it only configures database connections

2. Which of the following is the correct way to use @SpringBootTest to start the web environment on a random port?

easy

A. @SpringBootTest(webEnv = RANDOM_PORT)

B. @SpringBootTest(webEnvironment = "random")

C. @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)

D. @SpringBootTest(port = RANDOM_PORT)

Solution

1. Step 1: Recall the correct attribute name and value

   The attribute to set the web environment is webEnvironment, and the enum value for random port is WebEnvironment.RANDOM_PORT.

2. Step 2: Check syntax correctness

   @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) uses the correct attribute and enum syntax. Other options use incorrect attribute names or string values.

3. Final Answer:

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

4. Quick Check:

   Correct attribute and enum = @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT) [OK]

Hint: Use webEnvironment = WebEnvironment.RANDOM_PORT exactly [OK]

Common Mistakes:

• Using wrong attribute name like webEnv
• Passing string instead of enum
• Trying to set port directly in annotation

3. Given the following test class snippet, what will be the output when running the test?

\@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
class MyIntegrationTest {
  \@Autowired
  private TestRestTemplate restTemplate;

  \@Test
  void testHelloEndpoint() {
    String response = restTemplate.getForObject("/hello", String.class);
    System.out.println(response);
  }
}

Assuming the /hello endpoint returns "Hello, Spring!".

medium

A. Hello, Spring!

B. null

C. 404 Not Found error

D. Test fails with context load error

Solution

1. Step 1: Understand the test setup

   The test uses @SpringBootTest with RANDOM_PORT and injects TestRestTemplate, which allows calling the real HTTP endpoint.

2. Step 2: Predict the endpoint call result

   The /hello endpoint returns "Hello, Spring!" so the call will return this string and print it.

3. Final Answer:

   Hello, Spring! -> Option A

4. Quick Check:

   TestRestTemplate calls real endpoint = "Hello, Spring!" [OK]

Hint: TestRestTemplate calls real endpoint in @SpringBootTest [OK]

Common Mistakes:

• Expecting null because of missing mocks
• Assuming 404 because of wrong port
• Thinking context fails to load

4. You wrote this test but it fails with a NoSuchBeanDefinitionException for TestRestTemplate. What is the likely cause?

\@SpringBootTest
class MyTest {
  \@Autowired
  private TestRestTemplate restTemplate;

  \@Test
  void test() {
    // test code
  }
}

medium

A. TestRestTemplate is not a Spring bean

B. Missing webEnvironment setting to start web server

C. Forgot to add @Autowired annotation

D. Test class must be public

Solution

1. Step 1: Identify why TestRestTemplate bean is missing

   By default, @SpringBootTest does not start the web server unless webEnvironment is set, so TestRestTemplate bean is not created.

2. Step 2: Fix by adding webEnvironment

   Adding webEnvironment = WebEnvironment.RANDOM_PORT or DEFINED_PORT starts the server and creates the bean.

3. Final Answer:

   Missing webEnvironment setting to start web server -> Option B

4. Quick Check:

   webEnvironment needed for TestRestTemplate bean [OK]

Hint: Add webEnvironment to enable TestRestTemplate bean [OK]

Common Mistakes:

• Assuming TestRestTemplate is always available
• Forgetting to set webEnvironment in @SpringBootTest
• Thinking @Autowired is missing

5. You want to write an integration test that loads the full Spring Boot context but disables the web server startup to speed up tests. Which @SpringBootTest configuration should you use?

hard

A. @SpringBootTest(webEnvironment = WebEnvironment.NONE)

B. @SpringBootTest(webEnvironment = WebEnvironment.MOCK)

C. @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)

D. @SpringBootTest(webEnvironment = WebEnvironment.DEFINED_PORT)

Solution

1. Step 1: Understand webEnvironment options

   WebEnvironment.NONE disables web server startup but loads full context. MOCK uses mock servlet environment, RANDOM_PORT and DEFINED_PORT start real servers.

2. Step 2: Choose option that disables web server

   To speed up tests without web server, use WebEnvironment.NONE.

3. Final Answer:

   @SpringBootTest(webEnvironment = WebEnvironment.NONE) -> Option A

4. Quick Check:

   Disable web server with WebEnvironment.NONE [OK]

Hint: Use WebEnvironment.NONE to skip web server startup [OK]

Common Mistakes:

• Using MOCK which still sets up servlet environment
• Starting real server with RANDOM_PORT or DEFINED_PORT
• Confusing NONE with MOCK