Spring Boot @SpringBootTest in JUnit

Introduction

The @SpringBootTest annotation helps you test your whole Spring Boot app easily. It starts the app context so you can check if everything works together.

When you want to test if your Spring Boot app loads without errors.

When you need to test multiple parts of your app working together.

When you want to test your app with real Spring beans and configurations.

When you want to check if your app's services and repositories interact correctly.

When you want to run integration tests that need the full app context.

Syntax

JUnit

@SpringBootTest
public class YourTestClass {
    // test methods here
}

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

You usually use it on a test class, not on individual methods.

Examples

Basic test to check if the Spring Boot app context loads without errors.

JUnit

@SpringBootTest
public class MyAppTests {

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

Starts the app with a random port to test web endpoints using TestRestTemplate.

JUnit

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

    @Autowired
    private TestRestTemplate restTemplate;

    @Test
    void testHomePage() {
        String body = restTemplate.getForObject("/", String.class);
        assertTrue(body.contains("Welcome"));
    }
}

Sample Program

This simple test checks if the Spring Boot application context loads without any errors. If it loads, the test passes.

JUnit

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import static org.junit.jupiter.api.Assertions.assertNotNull;

@SpringBootTest
public class SimpleSpringBootTest {

    @Test
    void contextLoads() {
        // This test will pass if the app context loads successfully
        assertNotNull(this);
    }
}

Important Notes

Use @SpringBootTest for integration tests, not for small unit tests.

Starting the full app context can make tests slower, so use it only when needed.

You can customize the environment with parameters like webEnvironment to test web layers.

Summary

@SpringBootTest starts the full Spring Boot app context for testing.

It is useful for integration tests that check how parts of your app work together.

Use it carefully because it can slow down your tests if overused.

Practice

1. What is the primary purpose of using @SpringBootTest in a test class?

easy

A. To start the full Spring Boot application context for integration testing

B. To mock all dependencies automatically

C. To run only unit tests without loading Spring context

D. To disable Spring Boot features during 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 approaches

   Unlike unit tests that mock dependencies, @SpringBootTest is used for integration tests to check how components work together.

3. Final Answer:

   To start the full Spring Boot application context for integration testing -> Option A

4. Quick Check:

   @SpringBootTest = full app context [OK]

Hint: Full app context means integration test, not mocking [OK]

Common Mistakes:

• Thinking it mocks dependencies automatically
• Using it for simple unit tests
• Assuming it disables Spring Boot features

2. Which of the following is the correct way to annotate a test class to load the Spring Boot context?

easy

A. @SpringBootApplicationTest

B. @SpringBootTestOnly

C. @TestContextLoader

D. @RunWith(SpringRunner.class) @SpringBootTest

Solution

1. Step 1: Identify the standard annotations for Spring Boot tests

   The correct annotations to load Spring Boot context in JUnit 4 are @RunWith(SpringRunner.class) and @SpringBootTest.

2. Step 2: Check the other options

   Options B, C, and D are not valid Spring Boot or JUnit annotations.

3. Final Answer:

   @RunWith(SpringRunner.class) @SpringBootTest -> Option D

4. Quick Check:

   Use @RunWith(SpringRunner.class) with @SpringBootTest [OK]

Hint: Remember: @RunWith + @SpringBootTest for context loading [OK]

Common Mistakes:

• Using non-existent annotations
• Forgetting @RunWith in JUnit 4
• Confusing with @SpringBootApplication

3. Given the following test class, what will be the output when the test runs successfully?

\@SpringBootTest
class MyServiceTest {
    \@Autowired
    private MyService myService;

    \@Test
    void testService() {
        assertNotNull(myService);
        System.out.println("Service is loaded");
    }
}

medium

A. Test passes and prints 'Service is loaded'

B. Test fails because myService is null

C. Compilation error due to missing annotations

D. Test passes but prints nothing

Solution

1. Step 1: Understand what @SpringBootTest does here

   The annotation loads the full Spring context, so myService bean is injected and not null.

2. Step 2: Analyze the test method

   The assertion assertNotNull(myService) passes, and the print statement outputs "Service is loaded".

3. Final Answer:

   Test passes and prints 'Service is loaded' -> Option A

4. Quick Check:

   Bean injected + assertNotNull = pass and print [OK]

Hint: If context loads, @Autowired bean is not null [OK]

Common Mistakes:

• Assuming myService is null without context
• Forgetting that @SpringBootTest loads beans
• Confusing compilation errors with runtime behavior

4. You have a test annotated with @SpringBootTest but it fails with a NoSuchBeanDefinitionException. What is the most likely cause?

medium

A. The test method is private

B. The test class is missing @Test annotation

C. The bean is not defined or scanned in the application context

D. The Spring Boot version is outdated

Solution

1. Step 1: Understand the exception meaning

   NoSuchBeanDefinitionException means Spring could not find a bean of the required type in the context.

2. Step 2: Identify common reasons for missing beans

   This usually happens if the bean is not defined, not annotated with @Component/@Service, or not in a scanned package.

3. Final Answer:

   The bean is not defined or scanned in the application context -> Option C

4. Quick Check:

   Missing bean definition = NoSuchBeanDefinitionException [OK]

Hint: Missing bean means not defined or scanned [OK]

Common Mistakes:

• Blaming test method visibility
• Assuming missing @Test causes bean errors
• Thinking Spring Boot version causes missing bean

5. You want to speed up your test suite by loading only a part of the Spring Boot context. Which approach can you use with @SpringBootTest to limit the loaded beans?

hard

A. Remove @SpringBootTest and use plain JUnit tests

B. Use @SpringBootTest(classes = YourConfig.class) to load only specific configuration

C. Add @MockBean to all beans manually

D. Use @SpringBootTest with @Transactional only

Solution

1. Step 1: Understand how to limit context loading

   By specifying classes attribute in @SpringBootTest, you can load only selected configuration classes, reducing context size.

2. Step 2: Evaluate other options

   Removing @SpringBootTest disables context loading, @MockBean mocks beans but does not limit context size, and @Transactional controls transactions, not context loading.

3. Final Answer:

   Use @SpringBootTest(classes = YourConfig.class) to load only specific configuration -> Option B

4. Quick Check:

   Limit context by specifying classes in @SpringBootTest [OK]

Hint: Specify classes attribute to limit context [OK]

Common Mistakes:

• Thinking @MockBean reduces context size
• Removing @SpringBootTest disables context, not limits
• Confusing @Transactional with context loading