Skip to content

Add support for constraints on nested fields. #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 29, 2019
Merged

Add support for constraints on nested fields. #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31585c7
Add support for constraints on nested fields.
Nov 22, 2019
85d6ae4
Removed needless blank lines in ConstrainedFieldsTest.
Nov 22, 2019
2dee63d
Fixed that constraint nesting is only working for one level of nesting.
Nov 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion restdocs-api-spec/src/main/kotlin/com/epages/restdocs/apispec/ConstrainedFields.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class ConstrainedFields(private val classHoldingConstraints: Class<*>) {
* @param path json path of the field
*/
fun withPath(path: String): FieldDescriptor =
withMappedPath(path, path)
withMappedPath(path, beanPropertyNameFromPath(path))

/**
*
Expand All @@ -38,7 +38,10 @@ class ConstrainedFields(private val classHoldingConstraints: Class<*>) {
.value(this.validatorConstraintResolver.resolveForProperty(beanPropertyName, classHoldingConstraints))
)

private fun beanPropertyNameFromPath(jsonPath: String) = jsonPath.substringAfterLast(DOT_NOTATION_DELIMITER)

companion object {
private const val CONSTRAINTS_KEY = "validationConstraints"
private const val DOT_NOTATION_DELIMITER = "."
}
}
29 changes: 26 additions & 3 deletions restdocs-api-spec/src/test/kotlin/com/epages/restdocs/apispec/ConstrainedFieldsTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,43 @@ import javax.validation.constraints.NotEmpty

internal class ConstrainedFieldsTest {

val fields = ConstrainedFields(SomeWithConstraints::class.java)

@Test
@Suppress("UNCHECKED_CAST")
fun `should resolve constraints`() {
val fields = ConstrainedFields(SomeWithConstraints::class.java)
val descriptor = fields.withPath("nonEmpty")

then(descriptor.attributes).containsKey("validationConstraints")
then((descriptor.attributes["validationConstraints"] as List<Constraint>).map { it.name })
.containsExactly(NotEmpty::class.java.name)
}

@Test
@Suppress("UNCHECKED_CAST")
fun `should resolve one level nested constraints`() {
val fields = ConstrainedFields(SomeWithConstraints::class.java)
val descriptor = fields.withPath("nested.nonEmpty")

then(descriptor.attributes).containsKey("validationConstraints")
then((descriptor.attributes["validationConstraints"] as List<Constraint>).map { it.name })
.containsExactly(NotEmpty::class.java.name)
}

@Test
@Suppress("UNCHECKED_CAST")
fun `should resolve two level nested constraints`() {
val fields = ConstrainedFields(SomeWithConstraints::class.java)
val descriptor = fields.withPath("nested.nested.nonEmpty")

then(descriptor.attributes).containsKey("validationConstraints")
then((descriptor.attributes["validationConstraints"] as List<Constraint>).map { it.name })
.containsExactly(NotEmpty::class.java.name)
}

private data class SomeWithConstraints(
@field:NotEmpty
val nonEmpty: String
val nonEmpty: String,

val nested: SomeWithConstraints?
)
}