-
-
Notifications
You must be signed in to change notification settings - Fork 235
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(api): add limited content negotiation for getBookPage API
Closes: #1219
- Loading branch information
Showing
2 changed files
with
218 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
176 changes: 176 additions & 0 deletions
176
komga/src/test/kotlin/org/gotson/komga/interfaces/api/rest/BookControllerPageTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| package org.gotson.komga.interfaces.api.rest | ||
|
|
||
| import com.ninjasquad.springmockk.MockkBean | ||
| import com.ninjasquad.springmockk.SpykBean | ||
| import io.mockk.every | ||
| import org.gotson.komga.domain.model.BookPage | ||
| import org.gotson.komga.domain.model.BookPageContent | ||
| import org.gotson.komga.domain.model.Media | ||
| import org.gotson.komga.domain.model.makeBook | ||
| import org.gotson.komga.domain.model.makeLibrary | ||
| import org.gotson.komga.domain.model.makeSeries | ||
| import org.gotson.komga.domain.persistence.BookRepository | ||
| import org.gotson.komga.domain.persistence.KomgaUserRepository | ||
| import org.gotson.komga.domain.persistence.LibraryRepository | ||
| import org.gotson.komga.domain.persistence.MediaRepository | ||
| import org.gotson.komga.domain.persistence.SeriesRepository | ||
| import org.gotson.komga.domain.service.BookAnalyzer | ||
| import org.gotson.komga.domain.service.BookLifecycle | ||
| import org.gotson.komga.domain.service.KomgaUserLifecycle | ||
| import org.gotson.komga.domain.service.LibraryLifecycle | ||
| import org.gotson.komga.domain.service.SeriesLifecycle | ||
| import org.junit.jupiter.api.AfterAll | ||
| import org.junit.jupiter.api.AfterEach | ||
| import org.junit.jupiter.api.BeforeAll | ||
| import org.junit.jupiter.params.ParameterizedTest | ||
| import org.junit.jupiter.params.provider.Arguments | ||
| import org.junit.jupiter.params.provider.MethodSource | ||
| import org.springframework.beans.factory.annotation.Autowired | ||
| import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc | ||
| import org.springframework.boot.test.context.SpringBootTest | ||
| import org.springframework.http.HttpHeaders | ||
| import org.springframework.http.MediaType | ||
| import org.springframework.test.web.servlet.MockMvc | ||
| import org.springframework.test.web.servlet.get | ||
| import java.util.stream.Stream | ||
|
|
||
| @SpringBootTest | ||
| @AutoConfigureMockMvc(printOnlyOnFailure = false) | ||
| class BookControllerPageTest( | ||
| @Autowired private val seriesRepository: SeriesRepository, | ||
| @Autowired private val seriesLifecycle: SeriesLifecycle, | ||
| @Autowired private val mediaRepository: MediaRepository, | ||
| @Autowired private val libraryRepository: LibraryRepository, | ||
| @Autowired private val libraryLifecycle: LibraryLifecycle, | ||
| @Autowired private val bookRepository: BookRepository, | ||
| @Autowired private val userRepository: KomgaUserRepository, | ||
| @Autowired private val userLifecycle: KomgaUserLifecycle, | ||
| @Autowired private val mockMvc: MockMvc, | ||
| ) { | ||
| @MockkBean | ||
| private lateinit var mockAnalyzer: BookAnalyzer | ||
|
|
||
| @SpykBean | ||
| private lateinit var bookLifecycle: BookLifecycle | ||
|
|
||
| private val library = makeLibrary(id = "1") | ||
|
|
||
| @BeforeAll | ||
| fun `setup library`() { | ||
| libraryRepository.insert(library) | ||
| } | ||
|
|
||
| @AfterAll | ||
| fun teardown() { | ||
| libraryRepository.findAll().forEach { | ||
| libraryLifecycle.deleteLibrary(it) | ||
| } | ||
| } | ||
|
|
||
| @AfterEach | ||
| fun `clear repository`() { | ||
| seriesLifecycle.deleteMany(seriesRepository.findAll()) | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("arguments") | ||
| @WithMockCustomUser | ||
| fun `given pdf book when getting page with Accept header then returns page in correct format`(bookType: String, acceptTypes: List<MediaType>, success: Boolean, resultType: String?) { | ||
| makeSeries(name = "series", libraryId = library.id).let { series -> | ||
| seriesLifecycle.createSeries(series).let { created -> | ||
| val books = listOf(makeBook("1", libraryId = library.id)) | ||
| seriesLifecycle.addBooks(created, books) | ||
| } | ||
| } | ||
|
|
||
| val book = bookRepository.findAll().first() | ||
| mediaRepository.findById(book.id).let { | ||
| mediaRepository.update( | ||
| it.copy( | ||
| status = Media.Status.READY, | ||
| mediaType = bookType, | ||
| pages = listOf(BookPage("file", "image/jpeg")), | ||
| ), | ||
| ) | ||
| } | ||
|
|
||
| every { mockAnalyzer.getPageContentRaw(any(), 1) } returns BookPageContent(ByteArray(0), "application/pdf") | ||
| every { bookLifecycle.getBookPage(any(), 1, any(), any()) } returns BookPageContent(ByteArray(0), "image/jpeg") | ||
|
|
||
| mockMvc.get("/api/v1/books/${book.id}/pages/1") { | ||
| if (acceptTypes.isNotEmpty()) accept(*acceptTypes.toTypedArray()) | ||
| } | ||
| .andExpect { | ||
| status { if (success) isOk() else isBadRequest() } | ||
| if (resultType != null) | ||
| header { string(HttpHeaders.CONTENT_TYPE, resultType) } | ||
| } | ||
| } | ||
|
|
||
| fun arguments(): Stream<Arguments> = | ||
| Stream.of( | ||
| // PDF book: request nothing, get image | ||
| Arguments.of( | ||
| "application/pdf", | ||
| emptyList<MediaType>(), | ||
| true, | ||
| "image/jpeg", | ||
| ), | ||
| // PDF book: request PDF, get PDF | ||
| Arguments.of( | ||
| "application/pdf", | ||
| listOf(MediaType.APPLICATION_PDF), | ||
| true, | ||
| "application/pdf", | ||
| ), | ||
| // PDF book: request PDF + others, get PDF | ||
| Arguments.of( | ||
| "application/pdf", | ||
| listOf(MediaType.APPLICATION_PDF, MediaType("image")), | ||
| true, | ||
| "application/pdf", | ||
| ), | ||
| // PDF book: request image, get image | ||
| Arguments.of( | ||
| "application/pdf", | ||
| listOf(MediaType("image")), | ||
| true, | ||
| "image/jpeg", | ||
| ), | ||
| // PDF book: request unhandled image, still get image. We don't check image subtypes. | ||
| Arguments.of( | ||
| "application/pdf", | ||
| listOf(MediaType("image", "avif")), | ||
| true, | ||
| "image/jpeg", | ||
| ), | ||
| // PDF book: request random, get image. We ignore non-pdf types. | ||
| Arguments.of( | ||
| "application/pdf", | ||
| listOf(MediaType.APPLICATION_ATOM_XML), | ||
| true, | ||
| "image/jpeg", | ||
| ), | ||
| // PDF book: request PDF with lower priority than image, get image | ||
| Arguments.of( | ||
| "application/pdf", | ||
| listOf(MediaType.IMAGE_JPEG, MediaType.APPLICATION_PDF), | ||
| true, | ||
| "image/jpeg", | ||
| ), | ||
| // PDF book: request PDF with lower quality than image, get image | ||
| Arguments.of( | ||
| "application/pdf", | ||
| listOf(MediaType("application", "pdf", 0.5), MediaType.IMAGE_JPEG), | ||
| true, | ||
| "image/jpeg", | ||
| ), | ||
| // PDF book: request PDF with higher quality than image, get pdf | ||
| Arguments.of( | ||
| "application/pdf", | ||
| listOf(MediaType("image", "jpeg", 0.5), MediaType("application", "pdf", 0.8)), | ||
| true, | ||
| "application/pdf", | ||
| ), | ||
| ) | ||
| } |