이 시리즈의 첫 번째 기사에서는 Spring Boot, Cloudinary, Docker 및 PostgreSQL을 사용하여 강력한 이미지 업로더를 구축하는 방법을 살펴보았습니다. 프로젝트 설정부터 이미지와 정보를 저장하는 엔드포인트에 대한 요청까지 모든 것을 다루었습니다. 아직 해당 기사를 읽지 않았다면 여기서부터 시작하여 우리가 작업할 애플리케이션의 탄탄한 기초를 다지는 것이 좋습니다.

이제 애플리케이션이 안정적이고 시간이 지나도 무결성을 유지하는지 확인할 차례입니다. 이는 소프트웨어 개발의 중요한 측면인 테스트로 이어집니다. 이 글에서는 이미지 업로더 API에 대한 단위 테스트 작성에 중점을 둘 것입니다. 종속성을 모의하는 방법을 살펴보고 서비스의 다양한 부분을 다루는 테스트를 작성하겠습니다.

단위 테스트는 버그를 조기에 발견하는 데 도움이 될 뿐만 아니라 코드의 유지 관리 및 확장성을 보장합니다. 이 문서가 끝나면 이미지 업로더 API에 대한 포괄적인 테스트 모음을 갖게 되어 애플리케이션이 예상대로 작동하는지 확신할 수 있게 됩니다.

단위 테스트의 세계로 뛰어들어 이미지 업로더 API를 완벽하게 만들어 봅시다!

설정 중

Java용 확장 팩과 함께 VSCode를 사용하고 있습니다. 이제 테스트를 작성할 준비가 되었습니다.

다른 IDE를 사용하는 경우 JUnit5 문서에서 모든 IDE에 대한 지원을 확인하세요.

테스트

1. 서비스 테스트 예약

BookService 클래스를 마우스 오른쪽 버튼으로 클릭하고 테스트로 이동을 클릭한 다음 메뉴에서 테스트를 생성하려는 메서드를 선택합니다.

아래와 같은 유사한 파일이 생성됩니다.

import org.junit.jupiter.api.Test;

public class BookServiceTest {
    @Test
    void testAddBook() {

    }
}

이 문서에서는 AAA 패턴 테스트(정렬 - 실행 - 어설션)를 사용할 것임을 기억하세요.

1.1. 모의 속성

@ExtendWith(MockitoExtension.class)
public class BookServiceTest {

    @Mock
    private BookRepository bookRepository;

    @Mock
    private Cloudinary cloudinary;

    @Mock
    private MultipartFile multipartFile;

    @Mock
    private Uploader uploader;

    @Captor
    private ArgumentCaptor bookArgumentCaptor;

    @InjectMocks
    private BookService bookService;

}

• @Mock 주석은 클래스에서 사용할 속성 또는 종속성의 동작을 모의/시뮬레이트합니다.
• @InjectMocks 주석은 모의 객체를 생성하고 해당 필드에 주입합니다.

1.2. 테스트 작성

• 성공 사례 테스트(shouldCreateANewBook).
• 저장소 호출 테스트(shouldCallRepositorySave).
• 업로드 실패 여부 테스트(shouldFailTheUpload).

@ExtendWith(MockitoExtension.class)
public class BookServiceTest {

    @Mock
    private BookRepository bookRepository;

    @Mock
    private Cloudinary cloudinary;

    @Mock
    private MultipartFile multipartFile;

    @Mock
    private Uploader uploader;

    @Captor
    private ArgumentCaptor bookArgumentCaptor;

    @InjectMocks
    private BookService bookService;

    @Nested
    class AddBook {
        @Test
        void shouldCreateANewBook() throws Exception {
            // Arrange
            Map uploadResult = Map.of("url", "http://example.com/image.jpg");

            when(cloudinary.uploader()).thenReturn(uploader);

            when(uploader.upload(any(File.class), anyMap())).thenReturn(uploadResult);

            Book book = new Book();

            book.setName("Test Book");
            book.setImgUrl(uploadResult.get("url").toString());

            when(bookRepository.save(any(Book.class))).thenReturn(book);

            when(multipartFile.getOriginalFilename()).thenReturn("test.jpg");
            when(multipartFile.getBytes()).thenReturn("test content".getBytes());

            // Act

            Book result = bookService.addBook("Test Book", multipartFile);

            // Assert

            assertNotNull(result);
            assertEquals("Test Book", result.getName());
            assertEquals("http://example.com/image.jpg", result.getImgUrl());
        }

        @Test
        void shouldCallRepositorySave() throws Exception {
            // Arrange
            Map uploadResult = Map.of("url", "http://example.com/image.jpg");

            when(cloudinary.uploader()).thenReturn(uploader);

            when(uploader.upload(any(File.class), anyMap())).thenReturn(uploadResult);

            Book book = new Book();

            book.setName("Test Book");
            book.setImgUrl(uploadResult.get("url").toString());

            when(bookRepository.save(any(Book.class))).thenReturn(book);

            when(multipartFile.getOriginalFilename()).thenReturn("test.jpg");
            when(multipartFile.getBytes()).thenReturn("test content".getBytes());

            // Act
            bookService.addBook("Test Book", multipartFile);

            // Assert
            verify(bookRepository, times(1)).save(bookArgumentCaptor.capture());
            Book capturedBook = bookArgumentCaptor.getValue();
            assertEquals("Test Book", capturedBook.getName());
            assertEquals("http://example.com/image.jpg", capturedBook.getImgUrl());
        }

        @Test
        void shouldFailTheUpload() throws Exception {
            // Arrange
            when(multipartFile.getOriginalFilename()).thenReturn("test.jpg");
            when(multipartFile.getBytes()).thenReturn("test content".getBytes());

            when(cloudinary.uploader()).thenReturn(uploader);
            when(uploader.upload(any(File.class),
                    anyMap())).thenThrow(IOException.class);

            // Act & Assert
            ResponseStatusException exception = assertThrows(ResponseStatusException.class, () -> {
                bookService.addBook("Test Book", multipartFile);
            });

            assertEquals(HttpStatus.BAD_GATEWAY, exception.getStatusCode());
            assertEquals("Failed to upload the file.", exception.getReason());
        }
    }
}

2. 컨트롤러 테스트 예약

• 성공 사례 테스트(shouldReturnSuccess)
• 실패 사례 테스트(shouldFailToUploadImage)
• 이름 매개변수가 누락된 테스트(shouldFailWithMissingNameParameter)
• imgUrl 매개변수가 누락된 테스트(shouldFailWithMissingImageParameter)

package cloudinary.upload.imageUpload.controllers;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.mock.web.MockMultipartFile;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.server.ResponseStatusException;

import cloudinary.upload.imageUpload.configs.GlobalExceptionHandler;
import cloudinary.upload.imageUpload.entities.Book;
import cloudinary.upload.imageUpload.services.BookService;

@ExtendWith(MockitoExtension.class)
public class BookControllerTest {

    @Mock
    private BookService bookService;

    @InjectMocks
    private BookController bookController;

    private MockMvc mockMvc;

    @Nested
    class AddBook {
        @Test
        void shouldReturnSuccess() throws Exception {
            // Arrange
            MockMultipartFile image = new MockMultipartFile("imgUrl", "test.jpg", MediaType.IMAGE_JPEG_VALUE,
                    "test content".getBytes());

            Book book = new Book();
            book.setName("Test Book");
            book.setImgUrl("http://example.com/image.jpg");

            when(bookService.addBook(any(String.class), any(MockMultipartFile.class))).thenReturn(book);

            mockMvc = MockMvcBuilders.standaloneSetup(bookController).build();

            // Act & Assert
            mockMvc.perform(multipart("/addBook")
                    .file(image)
                    .param("name", "Test Book"))
                    .andExpect(status().isOk())
                    .andExpect(jsonPath("$.name").value("Test Book"))
                    .andExpect(jsonPath("$.imgUrl").value("http://example.com/image.jpg"));
        }

        @Test
        void shouldFailToUploadImage() throws Exception {
            // Arrange
            MockMultipartFile image = new MockMultipartFile("imgUrl", "test.jpg", MediaType.IMAGE_JPEG_VALUE,
                    "test content".getBytes());

            when(bookService.addBook(any(String.class), any(MockMultipartFile.class)))
                    .thenThrow(new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR,
                            "Failed to upload the file."));

            mockMvc = MockMvcBuilders.standaloneSetup(bookController).setControllerAdvice(new GlobalExceptionHandler())
                    .build();

            // Act & Assert
            mockMvc.perform(multipart("/addBook")
                    .file(image)
                    .param("name", "Test Book"))
                    .andExpect(status().isInternalServerError())
                    .andExpect(result -> result.getResponse().equals("Failed to upload the file."));
        }

        @Test
        void shouldFailWithMissingNameParameter() throws Exception {
            // Arrange
            MockMultipartFile image = new MockMultipartFile("imgUrl", "test.jpg", MediaType.IMAGE_JPEG_VALUE,
                    "test content".getBytes());

            mockMvc = MockMvcBuilders.standaloneSetup(bookController).build();

            // Act & Assert
            mockMvc.perform(multipart("/addBook")
                    .file(image))
                    .andExpect(status().isBadRequest());
        }

        @Test
        void shouldFailWithMissingImageParameter() throws Exception {
            // Arrange
            mockMvc = MockMvcBuilders.standaloneSetup(bookController).build();

            // Act & Assert
            mockMvc.perform(multipart("/addBook")
                    .param("name", "Test Book"))
                    .andExpect(status().isBadRequest());
        }
    }

}

결론

다음은 앱 테스트를 시작하기 위한 몇 가지 간단한 테스트 사례입니다. 반복을 피하기 위해 일부 팩토리를 추가하여 이러한 테스트를 리팩터링할 수 있다는 점을 기억하세요.

읽어주셔서 감사합니다.

참조

JUnit5 - 문서
Mockito - 문서