Testing Strategy

Relevant source files

The following files were used as context for generating this wiki page:

• complete/src/test/java/com/example/restservice/GreetingControllerTests.java
• initial/src/test/java/com/example/restservice/RestServiceApplicationTests.java
• complete/pom.xml
• test/run.sh
• complete/src/main/java/com/example/restservice/GreetingController.java
• README.adoc

The testing strategy for the gs-rest-service project leverages the Spring Boot testing framework to ensure the RESTful web service functions correctly. The approach combines high-level integration tests that validate the Spring application context with more focused tests for the REST controller layer. This ensures both the application's configuration and the API endpoint's logic are verified.

Testing is primarily implemented using JUnit 5 and Spring's MockMvc for server-less REST endpoint testing. The build process, managed by both Maven and Gradle, incorporates a test execution phase, ensuring that tests are run as part of the standard build lifecycle. A shell script further automates the build and test execution for both build systems.

Test Dependencies and Configuration

The project's testing capabilities are enabled through the spring-boot-starter-test dependency, which is defined in the Maven project configuration. This starter brings in a suite of essential testing libraries.

Sources: complete/pom.xml:28-32

Group ID	Artifact ID	Scope	Description
org.springframework.boot	spring-boot-starter-test	test	The primary dependency that bundles key testing libraries like JUnit 5, Spring Test, and Mockito.

Sources: complete/pom.xml:28-32

Application Context Testing

A fundamental part of the strategy is a sanity check to ensure that the Spring application context can be loaded successfully. This is handled by the RestServiceApplicationTests class.

Sources: initial/src/test/java/com/example/restservice/RestServiceApplicationTests.java

RestServiceApplicationTests

This test class uses the @SpringBootTest annotation to load the full application context. The contextLoads() test method is empty; its purpose is simply to pass if the application context is loaded without any exceptions or configuration errors.

// initial/src/test/java/com/example/restservice/RestServiceApplicationTests.java:8-13
@SpringBootTest
public class RestServiceApplicationTests {

	@Test
	public void contextLoads() {
	}

}

Sources: initial/src/test/java/com/example/restservice/RestServiceApplicationTests.java:8-13

REST Controller Testing

The core of the API testing is focused on the GreetingController. The GreetingControllerTests class is responsible for verifying the behavior of the /greeting endpoint.

Sources: complete/src/test/java/com/example/restservice/GreetingControllerTests.java

Test Setup

The test class is annotated with @SpringBootTest and @AutoConfigureMockMvc.

• @SpringBootTest: Loads the Spring application context for the test.
• @AutoConfigureMockMvc: Configures MockMvc, a framework for testing Spring MVC controllers without needing to start a full HTTP server.

The MockMvc instance is autowired into the test class, providing the entry point for performing requests.

// complete/src/test/java/com/example/restservice/GreetingControllerTests.java:28-34
@SpringBootTest
@AutoConfigureMockMvc
public class GreetingControllerTests {

	@Autowired
	private MockMvc mockMvc;

Sources: complete/src/test/java/com/example/restservice/GreetingControllerTests.java:28-34

The following diagram illustrates the relationship between the test class, MockMvc, and the controller under test.

Test Cases

Two specific scenarios are tested for the /greeting endpoint.

Test Method	Description	Endpoint	Parameters	Expected Status	Expected JSON Content
noParamGreetingShouldReturnDefaultMessage()	Verifies the response when no name parameter is provided.	GET /greeting	None	200 OK	{"content":"Hello, World!"}
paramGreetingShouldReturnTailoredMessage()	Verifies the response when a name parameter is provided.	GET /greeting	name=Spring Community	200 OK	{"content":"Hello, Spring Community!"}

Sources: complete/src/test/java/com/example/restservice/GreetingControllerTests.java:37-49

The flow for a single test case using MockMvc is shown below. The test initiates a request, which MockMvc dispatches to the GreetingController. The controller returns a Greeting object, which is serialized to JSON, and the test then asserts the response status and content.

Build and Test Execution

The test/run.sh script automates the build and testing process for both Maven and Gradle, ensuring consistency. The script executes the standard build commands which inherently trigger the test phase.

Sources: test/run.sh

The script performs the following key steps for the complete project:

1. Executes ./mvnw clean package to clean the project, compile, run tests, and package the application.
2. Executes ./gradlew build to perform the equivalent build and test process using Gradle.

The following flowchart visualizes the execution path of the run.sh script.

Summary

The testing strategy for gs-rest-service is a practical and effective implementation of standard Spring Boot testing practices. It ensures the application context is valid through a simple context-loading test. More importantly, it uses MockMvc to conduct focused, server-less integration tests on the REST controller, verifying endpoint logic for different request parameters. The entire process is automated and integrated into both Maven and Gradle build cycles, as demonstrated by the run.sh script, providing a reliable and repeatable verification mechanism.