Added unit and integration tests

Nilanchal Panigrahy · Nilanchal Panigrahy · commit cb1269bf81f2 · 2024-02-03T13:33:13.000Z
diff --git a/testing-movies-api/movies-api-swagger.png b/testing-movies-api/movies-api-swagger.png
diff --git a/testing-movies-api/pom.xml b/testing-movies-api/pom.xml
@@ -34,6 +34,11 @@
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
diff --git a/testing-movies-api/readme.md b/testing-movies-api/readme.md
@@ -0,0 +1,10 @@
+# Testing Spring Boot RESTFul API
+
+Example code that demonstrates how to test RESTFul API in spring boot using Mockito, MockMVC.
+
+#### Movies API Docs:
+
+The Swagger UI page is available at http://localhost:8080/swagger-ui/index.html and the OpenAPI 
+description is available at http://localhost:8080/api-docs.
+
+![Movies API - Spring Boot](movies-api-swagger.png "Movies API Docs")
diff --git a/testing-movies-api/src/main/java/com/stacktips/movies/api/GlobalExceptionHandler.java b/testing-movies-api/src/main/java/com/stacktips/movies/api/GlobalExceptionHandler.java
@@ -1,17 +1,24 @@
 package com.stacktips.movies.api;
 
 import com.stacktips.movies.exception.MovieNotFoundException;
+import com.stacktips.movies.models.ApiError;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.ResponseBody;
+
+import java.util.List;
 
 @ControllerAdvice
 public class GlobalExceptionHandler {
 
+    @ResponseBody
     @ExceptionHandler(MovieNotFoundException.class)
-    ResponseEntity<Void> handleNotFoundException(MovieNotFoundException ex) {
-        return ResponseEntity.notFound()
-                .build();
+    ResponseEntity<List<ApiError>> handleNotFoundException(MovieNotFoundException ex) {
+        final ApiError apiError = new ApiError(HttpStatus.NOT_FOUND.name(), ex.getMessage());
+
+        return new ResponseEntity<>(List.of(apiError), HttpStatus.NOT_FOUND);
     }
 
 }
diff --git a/testing-movies-api/src/main/java/com/stacktips/movies/api/MoviesController.java b/testing-movies-api/src/main/java/com/stacktips/movies/api/MoviesController.java
@@ -28,7 +28,7 @@ public MoviesController(MovieService movieService) {
         this.movieService = movieService;
     }
 
-    @GetMapping
+    @GetMapping(produces = {MediaType.APPLICATION_JSON_VALUE}, consumes = {MediaType.APPLICATION_JSON_VALUE})
     public List<Movie> getMovies() {
         return movieService.getMovies();
     }
diff --git a/testing-movies-api/src/main/java/com/stacktips/movies/api/SearchController.java b/testing-movies-api/src/main/java/com/stacktips/movies/api/SearchController.java
@@ -7,6 +7,7 @@
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 import java.util.List;
@@ -22,10 +23,10 @@ public SearchController(SearchService searchService) {
         this.searchService = searchService;
     }
 
-//    @GetMapping
-//    public List<Movie> searchByLanguage(@RequestParam(name = "language") String language) {
-//        return searchService.searchMovieByLanguage(language);
-//    }
+    @GetMapping(path = "/language")
+    public List<Movie> searchByLanguage(@RequestParam(name = "language") String language) {
+        return searchService.searchMovieByLanguage(language);
+    }
 
     @GetMapping
     public List<Movie> search(SearchRequest searchRequest) {
diff --git a/testing-movies-api/src/main/java/com/stacktips/movies/dto/MovieDto.java b/testing-movies-api/src/main/java/com/stacktips/movies/dto/MovieDto.java
@@ -1,12 +1,17 @@
 package com.stacktips.movies.dto;
 
 import com.stacktips.movies.models.ContentRating;
+import jakarta.validation.constraints.NotEmpty;
+import jakarta.validation.constraints.NotNull;
 
 import java.util.List;
 
 public class MovieDto {
 
+    @NotEmpty
+    @NotNull
     private String title;
+
     private String headline;
     private String thumbnail;
     private String language;
diff --git a/testing-movies-api/src/main/java/com/stacktips/movies/models/ApiError.java b/testing-movies-api/src/main/java/com/stacktips/movies/models/ApiError.java
@@ -0,0 +1,29 @@
+package com.stacktips.movies.models;
+
+public class ApiError {
+
+    String code;
+    String message;
+
+    public ApiError(String code, String message) {
+        this.code = code;
+        this.message = message;
+    }
+
+    public String getCode() {
+        return code;
+    }
+
+    public void setCode(String code) {
+        this.code = code;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public void setMessage(String message) {
+        this.message = message;
+    }
+}
+
diff --git a/testing-movies-api/src/main/resources/application.properties b/testing-movies-api/src/main/resources/application.properties
@@ -2,5 +2,8 @@ spring.data.mongodb.uri=mongodb://localhost:27017/movies?locale=en
 spring.data.mongodb.username=
 spring.data.mongodb.password=
 
-#open API path
-springdoc.api-docs.path=/api-docs
+#Setting Open API path
+springdoc.api-docs.path=/api-docs
+
+#Expose all actuator endpoints
+management.endpoints.web.exposure.include=*
diff --git a/testing-movies-api/src/test/java/actuators.http b/testing-movies-api/src/test/java/actuators.http
@@ -0,0 +1,14 @@
+###
+GET http://127.0.0.1:8080/actuator/health
+
+###
+GET http://127.0.0.1:8080/actuator
+
+###
+GET http://127.0.0.1:8080/actuator/info
+
+###
+GET http://127.0.0.1:8080/actuator/beans
+
+###
+
diff --git a/testing-movies-api/src/test/java/apidocs.http b/testing-movies-api/src/test/java/apidocs.http
@@ -0,0 +1,25 @@
+GET http://127.0.0.1:8080/api-docs/1.1/projects
+
+<> 2023-10-09T142605.500.json
+
+###
+
+GET http://127.0.0.1:8080/api-docs2/v3/api-docs
+Accept: application/json
+
+<> 2023-10-11T000413.200.json
+
+###
+
+GET http://127.0.0.1:8080/api-docs2/swagger-ui.html
+
+<> 2023-10-11T000432.200.html
+
+###
+
+GET http://127.0.0.1:8080/api-docs2/
+
+<> 2023-10-11T090801.200.html
+
+###
+
diff --git a/testing-movies-api/src/test/java/com/stacktips/movies/api/MoviesControllerTest.java b/testing-movies-api/src/test/java/com/stacktips/movies/api/MoviesControllerTest.java
@@ -0,0 +1,161 @@
+package com.stacktips.movies.api;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.stacktips.movies.dto.MovieDto;
+import com.stacktips.movies.exception.MovieNotFoundException;
+import com.stacktips.movies.models.ContentRating;
+import com.stacktips.movies.models.Movie;
+import com.stacktips.movies.services.MovieService;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.http.MediaType;
+import org.springframework.test.web.servlet.MockMvc;
+
+import java.util.Arrays;
+import java.util.List;
+
+import static com.stacktips.movies.models.ContentRating.PG;
+import static com.stacktips.movies.models.ContentRating.PG13;
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.notNullValue;
+import static org.hamcrest.Matchers.containsInAnyOrder;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+
+@WebMvcTest(MoviesController.class)
+class MoviesControllerTest {
+
+    @Autowired
+    private MockMvc mockMvc;
+
+    @MockBean
+    private MovieService movieService;
+
+    private ObjectMapper objectMapper;
+
+    private List<Movie> movies;
+
+    @BeforeEach
+    void setUp() {
+        objectMapper = new ObjectMapper();
+
+        movies = Arrays.asList(
+                mockMovie("64b152e16a386772c6453c94", "Iron Man", "EN", List.of("David Kaye", "Ian McKellen"),
+                        PG),
+                mockMovie("64b15c378c24e95ffcbe7870", "Mission Impossible", "FR", List.of("Tom Cruise"),
+                        PG13)
+        );
+    }
+
+
+    @Test
+    void testGetMovies() throws Exception {
+        when(movieService.getMovies()).thenReturn(movies);
+
+        mockMvc.perform(get("/api/1.0/movies").contentType(MediaType.APPLICATION_JSON))
+                .andExpect(status().isOk())
+                .andExpect(content().contentType(MediaType.APPLICATION_JSON))
+                .andExpect(jsonPath("$[0].id", is("64b152e16a386772c6453c94")))
+                .andExpect(jsonPath("$[0].title", is("Iron Man")))
+                .andExpect(jsonPath("$[0].language", is("EN")))
+                .andExpect(jsonPath("$[0].actors", containsInAnyOrder("Ian McKellen", "David Kaye")));
+        verify(movieService).getMovies();
+    }
+
+
+    @Test
+    void testGetMoviesWhenXmlContentType() throws Exception {
+        when(movieService.getMovies()).thenReturn(movies);
+
+        mockMvc.perform(get("/api/1.0/movies").contentType(MediaType.APPLICATION_XML))
+                .andExpect(status().isUnsupportedMediaType());
+    }
+
+
+    @Test
+    void testGetMovie() throws Exception {
+        String movieId = "test_id";
+
+        Movie movie = mockMovie(movieId, "Iron Man", "EN", List.of("David Kaye", "Ian McKellen"), PG13);
+        when(movieService.getMovie(movieId)).thenReturn(movie);
+
+        mockMvc.perform(get("/api/1.0/movies/{movieId}", movieId))
+                .andExpect(status().isOk())
+                .andExpect(content().contentType(MediaType.APPLICATION_JSON))
+                .andExpect(jsonPath("$.id", is(notNullValue())))
+                .andExpect(jsonPath("$.title", is("Iron Man")))
+                .andExpect(jsonPath("$.language", is("EN")))
+                .andExpect(jsonPath("$.actors", containsInAnyOrder("Ian McKellen", "David Kaye")));
+
+        verify(movieService).getMovie(movieId);
+    }
+
+
+    @Test
+    void testGetMovieWhenMovieNotFound() throws Exception {
+        String movieId = "test_id";
+        when(movieService.getMovie(movieId)).thenThrow(new MovieNotFoundException("Movie not found"));
+
+        mockMvc.perform(get("/api/1.0/movies/{movieId}", movieId))
+                .andExpect(status().isNotFound())
+                .andExpect(content().contentType(MediaType.APPLICATION_JSON))
+                .andExpect(jsonPath("$[0].code", is("NOT_FOUND")))
+                .andExpect(jsonPath("$[0].message", is("Movie not found")));
+
+        verify(movieService).getMovie(movieId);
+    }
+
+
+    @Test
+    void createMovieTest() throws Exception {
+        MovieDto movieDto = mockMovieDto("Iron Man", "EN", List.of("David Kaye", "Ian McKellen"), PG13);
+        Movie movie = mockMovie("test_id", "Iron Man", "EN", List.of("David Kaye", "Ian McKellen"),
+                PG13);
+        when(movieService.createMovie(any(MovieDto.class))).thenReturn(movie);
+
+        mockMvc.perform(post("/api/1.0/movies")
+                        .contentType(MediaType.APPLICATION_JSON)
+                        .content(objectMapper.writeValueAsString(movieDto)))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("$.id", is(notNullValue())))
+                .andExpect(jsonPath("$.title", is("Iron Man")))
+                .andExpect(jsonPath("$.language", is("EN")))
+                .andExpect(jsonPath("$.actors", containsInAnyOrder("Ian McKellen", "David Kaye")));
+
+        verify(movieService).createMovie(any(MovieDto.class));
+    }
+
+    private Movie mockMovie(String id, String title, String language, List<String> actors, ContentRating rating) {
+        Movie movie = new Movie();
+        movie.setId(id);
+        movie.setTitle(title);
+        movie.setHeadline("");
+        movie.setThumbnail("");
+        movie.setLanguage(language);
+        movie.setRegion("");
+        movie.setActors(actors);
+        movie.setGenres(List.of("Action", "Comedy"));
+        movie.setRating(rating);
+        return movie;
+    }
+
+    private MovieDto mockMovieDto(String title, String language, List<String> actors, ContentRating rating) {
+        MovieDto movieDto = new MovieDto();
+        movieDto.setTitle(title);
+        movieDto.setLanguage(language);
+        movieDto.setActors(actors);
+        movieDto.setGenres(List.of("Action", "Comedy"));
+        movieDto.setRating(rating);
+        return movieDto;
+    }
+}
diff --git a/testing-movies-api/src/test/java/com/stacktips/movies/services/MovieServiceTest.java b/testing-movies-api/src/test/java/com/stacktips/movies/services/MovieServiceTest.java
diff --git a/testing-movies-api/src/test/java/integration/MoviesAPITest.java b/testing-movies-api/src/test/java/integration/MoviesAPITest.java
diff --git a/testing-movies-api/src/test/java/movies-api.http b/testing-movies-api/src/test/java/movies-api.http

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public MoviesController(MovieService movieService) {`
`28`	`28`	`this.movieService = movieService;`
`29`	`29`	`}`
`30`	`30`
`31`		`- @GetMapping`
	`31`	`+ @GetMapping(produces = {MediaType.APPLICATION_JSON_VALUE}, consumes = {MediaType.APPLICATION_JSON_VALUE})`
`32`	`32`	`public List<Movie> getMovies() {`
`33`	`33`	`return movieService.getMovies();`
`34`	`34`	`}`