Backup_Repos/komga
1
0
Fork 0
mirror of https://github.com/gotson/komga.git synced 2026-04-27 17:32:08 +02:00
Code Issues Projects Releases Wiki Activity

refactor(api): rework client-settings API validation

Browse source
This commit is contained in:
Gauthier Roebroeck 2025-02-10 11:15:43 +08:00
parent f90b415ab8
commit 7f55fe152b
2 changed files with 59 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
komga/src/main/kotlin/org/gotson/komga/interfaces/api/rest/ClientSettingsController.kt
View file

@ -26,7 +26,7 @@ import org.springframework.web.bind.annotation.ResponseStatus
import org.springframework.web.bind.annotation.RestController
import io.swagger.v3.oas.annotations.parameters.RequestBody as OASRequestBody
private const val KEY_REGEX = """[a-z]+(?:\.[a-z]+)*"""
private const val KEY_REGEX = """^[a-z](?:[a-z0-9_-]*[a-z0-9])*(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])*)*$"""
@RestController
@RequestMapping(value = ["api/v1/client-settings"], produces = [MediaType.APPLICATION_JSON_VALUE])

111
komga/src/test/kotlin/org/gotson/komga/interfaces/api/rest/ClientSettingsControllerTest.kt
View file

@ -9,6 +9,7 @@ import org.junit.jupiter.api.BeforeAll
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.MethodSource
import org.junit.jupiter.params.provider.ValueSource
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc
@ -32,6 +33,40 @@ class ClientSettingsControllerTest(
clientSettingsDtoDao.deleteAll()
}
fun validKeys() =
listOf(
"single",
"one.two",
"one.with-dash",
"one.with_underscore",
"one.two.three-four_five",
"start2",
"start2.0value",
"start2.value2",
"start_2.value2",
"start-2.value2",
)
fun invalidKeys() =
listOf(
"UPPERCASE",
" ",
"",
"symbols!",
"two..dots",
".start.with.dot",
"end.with.dot.",
"setting.-secondstartwithdash",
"setting.-secondstartwithunderscore",
"setting.secondendwithdash-",
"setting.secondendwithunderscore_",
"-first",
"_first",
"first-",
"first_",
".",
)
@Nested
inner class AnonymousUser {
@Test
@ -129,14 +164,15 @@ class ClientSettingsControllerTest(
}
}
@Test
@ParameterizedTest
@MethodSource("validKeys")
@WithMockCustomUser(id = "user1")
fun `given non-admin user when updating user settings then settings are updated`() {
fun `given non-admin user when updating user settings then settings are updated`(key: String) {
//language=JSON
val jsonString =
"""
{
"setting": {
"$key": {
"value": "value"
}
}
@ -155,22 +191,12 @@ class ClientSettingsControllerTest(
.andExpect {
status { isOk() }
jsonPath("$.size()") { value(1) }
jsonPath("$.setting.value") { value("value") }
jsonPath("$.['$key'].value") { value("value") }
}
}
@ParameterizedTest
@ValueSource(
strings = [
"UPPERCASE",
" ",
"",
"symbols!",
"two..dots",
".start.with.dot",
"end.with.dot.",
],
)
@MethodSource("invalidKeys")
@WithMockCustomUser(id = "user1")
fun `given non-admin user when updating user settings with invalid key then validation error is thrown`(key: String) {
//language=JSON
@ -193,17 +219,7 @@ class ClientSettingsControllerTest(
}
@ParameterizedTest
@ValueSource(
strings = [
"UPPERCASE",
" ",
"",
"symbols!",
"two..dots",
".start.with.dot",
"end.with.dot.",
],
)
@MethodSource("invalidKeys")
@WithMockCustomUser(roles = ["ADMIN"])
fun `given non-admin user when deleting user settings with invalid key then validation error is thrown`(key: String) {
//language=JSON
@ -252,6 +268,10 @@ class ClientSettingsControllerTest(
status { isBadRequest() }
}
}
private fun validKeys() = this@ClientSettingsControllerTest.validKeys()
private fun invalidKeys() = this@ClientSettingsControllerTest.invalidKeys()
}
@Nested
@ -274,14 +294,15 @@ class ClientSettingsControllerTest(
}
}
@Test
@ParameterizedTest
@MethodSource("validKeys")
@WithMockCustomUser(roles = ["ADMIN"])
fun `given admin user when updating global settings then settings are updated`() {
fun `given admin user when updating global settings then settings are updated`(key: String) {
//language=JSON
val jsonString =
"""
{
"setting": {
"$key": {
"value": "value",
"allowUnauthorized": false
}
@ -301,23 +322,13 @@ class ClientSettingsControllerTest(
.andExpect {
status { isOk() }
jsonPath("$.size()") { value(1) }
jsonPath("$.setting.value") { value("value") }
jsonPath("$.setting.allowUnauthorized") { value(false) }
jsonPath("$.['$key'].value") { value("value") }
jsonPath("$.['$key'].allowUnauthorized") { value(false) }
}
}
@ParameterizedTest
@ValueSource(
strings = [
"UPPERCASE",
" ",
"",
"symbols!",
"two..dots",
".start.with.dot",
"end.with.dot.",
],
)
@MethodSource("invalidKeys")
@WithMockCustomUser(roles = ["ADMIN"])
fun `given admin user when updating global settings with invalid key then validation error is thrown`(key: String) {
//language=JSON
@ -341,17 +352,7 @@ class ClientSettingsControllerTest(
}
@ParameterizedTest
@ValueSource(
strings = [
"UPPERCASE",
" ",
"",
"symbols!",
"two..dots",
".start.with.dot",
"end.with.dot.",
],
)
@MethodSource("invalidKeys")
@WithMockCustomUser(roles = ["ADMIN"])
fun `given admin user when deleting global settings with invalid key then validation error is thrown`(key: String) {
//language=JSON
@ -414,5 +415,9 @@ class ClientSettingsControllerTest(
status { isBadRequest() }
}
}
private fun validKeys() = this@ClientSettingsControllerTest.validKeys()
private fun invalidKeys() = this@ClientSettingsControllerTest.invalidKeys()
}
}