[User management] Rename --max-users-page-size flag to conform to established pattern [DPP-944] (#13130)

changelog_begin
changelog_end
This commit is contained in:
pbatko-da 2022-03-03 23:09:20 +01:00 committed by GitHub
parent 56306eb387
commit e6db32719b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 20 additions and 16 deletions

View File

@ -656,7 +656,7 @@ object Config {
config.withUserManagementConfig(_.copy(maxCacheSize = value))
)
opt[Int]("max-users-page-size")
opt[Int]("user-management-max-users-page-size")
.optional()
.text(
s"Maximum number of users that the server can return in a single response. " +
@ -670,7 +670,9 @@ object Config {
if (v == 0 || v >= 100) {
success
} else {
failure(s"max-users-page-size must be either 0 or greater than 99, was: $v")
failure(
s"user-management-max-users-page-size must be either 0 or greater than 99, was: $v"
)
}
})

View File

@ -315,37 +315,37 @@ final class ConfigSpec
).value.userManagementConfig.cacheExpiryAfterWriteInSeconds shouldBe 123
}
it should "handle '--max-users-page-size' flag correctly" in {
it should "handle '--user-management-max-users-page-size' flag correctly" in {
// missing value
configParserSimple(
Seq("--max-users-page-size")
Seq("--user-management-max-users-page-size")
) shouldBe None
// default
configParserSimple().value.userManagementConfig.maxUsersPageSize shouldBe 1000
// custom value
configParserSimple(
Seq(
"--max-users-page-size",
"--user-management-max-users-page-size",
"123",
)
).value.userManagementConfig.maxUsersPageSize shouldBe 123
// values in range [1, 99] are disallowed
checkOptionFail(
Array(
"--max-users-page-size",
"--user-management-max-users-page-size",
"1",
)
)
checkOptionFail(
Array(
"--max-users-page-size",
"--user-management-max-users-page-size",
"99",
)
)
// negative values are disallowed
checkOptionFail(
Array(
"--max-users-page-size",
"--user-management-max-users-page-size",
"-1",
)
)

View File

@ -409,7 +409,7 @@ class CommonCliBase(name: LedgerName) {
config.withUserManagementConfig(_.copy(maxCacheSize = value))
)
opt[Int]("max-users-page-size")
opt[Int]("user-management-max-users-page-size")
.optional()
.text(
s"Maximum number of users that the server can return in a single response. " +
@ -423,7 +423,9 @@ class CommonCliBase(name: LedgerName) {
if (v == 0 || v >= 100) {
success
} else {
failure(s"max-users-page-size must be either 0 or greater than 99, was: $v")
failure(
s"user-management-max-users-page-size must be either 0 or greater than 99, was: $v"
)
}
})

View File

@ -411,10 +411,10 @@ abstract class CommonCliSpecBase(
)
}
"handle '--max-users-page-size' flag correctly" in {
"handle '--user-management-max-users-page-size' flag correctly" in {
// missing value
checkOptionFail(
Array("--max-users-page-size")
Array("--user-management-max-users-page-size")
)
// default
checkOption(
@ -424,7 +424,7 @@ abstract class CommonCliSpecBase(
// custom value
checkOption(
Array(
"--max-users-page-size",
"--user-management-max-users-page-size",
"123",
),
_.withUserManagementConfig(_.copy(maxUsersPageSize = 123)),
@ -432,20 +432,20 @@ abstract class CommonCliSpecBase(
// values in range [1, 99] are disallowed
checkOptionFail(
Array(
"--max-users-page-size",
"--user-management-max-users-page-size",
"1",
)
)
checkOptionFail(
Array(
"--max-users-page-size",
"--user-management-max-users-page-size",
"99",
)
)
// negative values are disallowed
checkOptionFail(
Array(
"--max-users-page-size",
"--user-management-max-users-page-size",
"-1",
)
)