Json Patch e2e #1565
There are no files selected for viewing
This file contains hidden or 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,104 @@ | ||
| package com.foo.rest.examples.bb.jsonpatch | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode | ||
| import com.fasterxml.jackson.databind.ObjectMapper | ||
| import org.springframework.boot.SpringApplication | ||
| import org.springframework.boot.autoconfigure.SpringBootApplication | ||
| import org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration | ||
| import org.evomaster.e2etests.utils.CoveredTargets | ||
| import org.springframework.http.ResponseEntity | ||
| import org.springframework.web.bind.annotation.* | ||
|
|
||
| @SpringBootApplication(exclude = [SecurityAutoConfiguration::class]) | ||
| @RestController | ||
| @RequestMapping("/pets") | ||
| open class BBJsonPatchApplication { | ||
|
|
||
| companion object { | ||
| @JvmStatic | ||
| fun main(args: Array<String>) { | ||
| SpringApplication.run(BBJsonPatchApplication::class.java, *args) | ||
| } | ||
| } | ||
|
|
||
| private val store: MutableMap<Long, BBJsonPatchDto> = mutableMapOf( | ||
| 1L to BBJsonPatchDto("Dog", 3), | ||
| 2L to BBJsonPatchDto("Cat", 5) | ||
| ) | ||
|
|
||
| private val mapper = ObjectMapper() | ||
|
|
||
| @GetMapping("/{id}") | ||
| fun getPet(@PathVariable id: Long): ResponseEntity<BBJsonPatchDto> { | ||
| val pet = store[id] ?: return ResponseEntity.badRequest().build() | ||
| return ResponseEntity.ok(pet) | ||
| } | ||
|
|
||
| @PatchMapping("/{id}", consumes = ["application/json-patch+json"]) | ||
| fun patchPet(@PathVariable id: Long, @RequestBody body: String): ResponseEntity<String> { | ||
| if (parsePatchDocument(body) == null) | ||
| return ResponseEntity.badRequest().body("Patch document must be a JSON array") | ||
|
|
||
| CoveredTargets.cover("PATCHED") | ||
| return ResponseEntity.ok("patched") | ||
| } | ||
|
|
||
| @PatchMapping("/{id}/add", consumes = ["application/json-patch+json"], produces = ["text/plain"]) | ||
| fun addPet(@PathVariable id: Long, @RequestBody body: String): ResponseEntity<String> = | ||
| patchOperation(body, "add", "JSON_PATCH_ADD") | ||
|
|
||
| @PatchMapping("/{id}/remove", consumes = ["application/json-patch+json"], produces = ["text/plain"]) | ||
| fun removePet(@PathVariable id: Long, @RequestBody body: String): ResponseEntity<String> = | ||
| patchOperation(body, "remove", "JSON_PATCH_REMOVE") | ||
|
|
||
| @PatchMapping("/{id}/replace", consumes = ["application/json-patch+json"], produces = ["text/plain"]) | ||
| fun replacePet(@PathVariable id: Long, @RequestBody body: String): ResponseEntity<String> = | ||
| patchOperation(body, "replace", "JSON_PATCH_REPLACE") | ||
|
|
||
| @PatchMapping("/{id}/move", consumes = ["application/json-patch+json"], produces = ["text/plain"]) | ||
| fun movePet(@PathVariable id: Long, @RequestBody body: String): ResponseEntity<String> = | ||
| patchOperation(body, "move", "JSON_PATCH_MOVE") | ||
|
|
||
| @PatchMapping("/{id}/copy", consumes = ["application/json-patch+json"], produces = ["text/plain"]) | ||
| fun copyPet(@PathVariable id: Long, @RequestBody body: String): ResponseEntity<String> = | ||
| patchOperation(body, "copy", "JSON_PATCH_COPY") | ||
|
|
||
| @PatchMapping("/{id}/test", consumes = ["application/json-patch+json"], produces = ["text/plain"]) | ||
| fun testPet(@PathVariable id: Long, @RequestBody body: String): ResponseEntity<String> = | ||
| patchOperation(body, "test", "JSON_PATCH_TEST") | ||
|
|
||
| @PatchMapping("/{id}/sequence", consumes = ["application/json-patch+json"], produces = ["text/plain"]) | ||
| fun sequencePet(@PathVariable id: Long, @RequestBody body: String): ResponseEntity<String> { | ||
| if (!hasMultipleOperations(body)) | ||
| return ResponseEntity.badRequest().body("Patch document must contain at least two operations") | ||
|
|
||
| CoveredTargets.cover("JSON_PATCH_SEQUENCE") | ||
| return ResponseEntity.ok("sequence patched") | ||
| } | ||
|
|
||
| private fun patchOperation(body: String, operation: String, target: String): ResponseEntity<String> { | ||
| if (!hasOperation(body, operation)) | ||
| return ResponseEntity.badRequest().body("Patch document must contain a $operation operation") | ||
|
|
||
| CoveredTargets.cover(target) | ||
| return ResponseEntity.ok("$operation patched") | ||
| } | ||
|
|
||
| private fun hasOperation(body: String, operation: String): Boolean = | ||
| parsePatchDocument(body)?.any { it.path("op").asText() == operation } ?: false | ||
|
|
||
| private fun hasMultipleOperations(body: String): Boolean = | ||
| parsePatchDocument(body) | ||
| ?.takeIf { it.size() >= 2 } | ||
| ?.all { it.hasNonNull("op") } | ||
| ?: false | ||
|
|
||
| private fun parsePatchDocument(body: String): JsonNode? = | ||
| try { | ||
| mapper.readTree(body).takeIf { it.isArray } | ||
| } catch (e: Exception) { | ||
| null | ||
| } | ||
| } | ||
|
|
||
| data class BBJsonPatchDto(val name: String = "", val age: Int = 0) | ||
This file contains hidden or 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,5 @@ | ||
| package com.foo.rest.examples.bb.jsonpatch | ||
|
|
||
| import com.foo.rest.examples.bb.SpringController | ||
|
|
||
| class BBJsonPatchController : SpringController(BBJsonPatchApplication::class.java) |
This file contains hidden or 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,72 @@ | ||
| package org.evomaster.e2etests.spring.rest.bb.jsonpatch | ||
|
|
||
| import com.foo.rest.examples.bb.jsonpatch.BBJsonPatchController | ||
| import org.evomaster.core.EMConfig | ||
| import org.evomaster.core.output.OutputFormat | ||
| import org.evomaster.core.problem.rest.data.HttpVerb | ||
| import org.evomaster.e2etests.spring.rest.bb.SpringTestBase | ||
| import org.junit.jupiter.api.Assertions.assertTrue | ||
| import org.junit.jupiter.api.BeforeAll | ||
| import org.junit.jupiter.params.ParameterizedTest | ||
| import org.junit.jupiter.params.provider.EnumSource | ||
|
|
||
| class BBJsonPatchTest : SpringTestBase() { | ||
|
|
||
| companion object { | ||
| @BeforeAll | ||
| @JvmStatic | ||
| fun init() { | ||
| val config = EMConfig() | ||
| initClass(BBJsonPatchController(), config) | ||
| } | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @EnumSource | ||
| fun testBlackBoxOutput(outputFormat: OutputFormat) { | ||
| executeAndEvaluateBBTest( | ||
| outputFormat, | ||
| "BBJsonPatchEM", | ||
| 1000, | ||
| 3, | ||
| listOf( | ||
| "PATCHED", | ||
| "JSON_PATCH_ADD", | ||
| "JSON_PATCH_REMOVE", | ||
| "JSON_PATCH_REPLACE", | ||
| "JSON_PATCH_MOVE", | ||
| "JSON_PATCH_COPY", | ||
| "JSON_PATCH_TEST", | ||
| "JSON_PATCH_SEQUENCE" | ||
| ) | ||
| ) { args: MutableList<String> -> | ||
|
|
||
| val solution = initAndRun(args) | ||
|
|
||
| assertTrue(solution.individuals.size >= 1) | ||
|
|
||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 200, "/pets/{id}", "patched") | ||
|
|
||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 200, "/pets/{id}/add", "add patched") | ||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 400, "/pets/{id}/add", null) | ||
|
|
||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 200, "/pets/{id}/remove", "remove patched") | ||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 400, "/pets/{id}/remove", null) | ||
|
|
||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 200, "/pets/{id}/replace", "replace patched") | ||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 400, "/pets/{id}/replace", null) | ||
|
|
||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 200, "/pets/{id}/move", "move patched") | ||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 400, "/pets/{id}/move", null) | ||
|
|
||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 200, "/pets/{id}/copy", "copy patched") | ||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 400, "/pets/{id}/copy", null) | ||
|
|
||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 200, "/pets/{id}/test", "test patched") | ||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 400, "/pets/{id}/test", null) | ||
|
|
||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 200, "/pets/{id}/sequence", "sequence patched") | ||
| assertHasAtLeastOne(solution, HttpVerb.PATCH, 400, "/pets/{id}/sequence", null) | ||
| } | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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,106 @@ | ||
| package org.evomaster.core.problem.rest.builder | ||
|
|
||
| import io.swagger.v3.oas.models.Operation | ||
| import io.swagger.v3.oas.models.PathItem | ||
| import io.swagger.v3.oas.models.media.MediaType | ||
| import io.swagger.v3.oas.models.media.Schema | ||
| import org.evomaster.core.problem.rest.schema.RestSchema | ||
| import org.evomaster.core.problem.rest.schema.SchemaOpenAPI | ||
| import org.evomaster.core.problem.rest.schema.SchemaUtils | ||
|
|
||
| /** | ||
| * Resolves the target resource schema for a JSON Patch endpoint by inspecting | ||
| * sibling operations on the same path item. | ||
| * | ||
| * Priority: GET 2xx response → PUT requestBody → POST requestBody. | ||
| */ | ||
| object JsonPatchSchemaResolver { | ||
|
|
||
| private const val JSON_PATCH_MEDIA_TYPE = "json-patch" | ||
|
|
||
| fun resolveResourceSchema( | ||
| operation: Operation, | ||
| schemaHolder: RestSchema, | ||
| currentSchema: SchemaOpenAPI, | ||
| messages: MutableList<String> | ||
| ): Schema<*>? { | ||
| val pathItem = findPathItemForPatchOperation(operation, schemaHolder, currentSchema, messages) | ||
| ?: return null | ||
|
|
||
| return fromGetResponse(pathItem, schemaHolder, currentSchema, messages) | ||
| ?: fromRequestBody(pathItem.put, schemaHolder, currentSchema, messages) | ||
| ?: fromRequestBody(pathItem.post, schemaHolder, currentSchema, messages) | ||
| } | ||
|
|
||
| //handleBodyPayload does not have the path of the operation, we need to find it, only if it is patch | ||
| private fun findPathItemForPatchOperation( | ||
| operation: Operation, | ||
| schemaHolder: RestSchema, | ||
| currentSchema: SchemaOpenAPI, | ||
| messages: MutableList<String> | ||
| ): PathItem? { | ||
| return schemaHolder.main.schemaParsed.paths | ||
| ?.values | ||
| ?.firstNotNullOfOrNull { pathItemOrRef -> | ||
| val pathItem = if (pathItemOrRef.`$ref` != null) { | ||
| SchemaUtils.getReferencePathItem(schemaHolder, currentSchema, pathItemOrRef.`$ref`, messages) | ||
| } else { | ||
| pathItemOrRef | ||
| } | ||
|
|
||
| pathItem?.takeIf { it.patch === operation } | ||
| } | ||
| } | ||
|
|
||
| // For get, the resource is in the response | ||
| private fun fromGetResponse( | ||
| pathItem: PathItem, | ||
| schemaHolder: RestSchema, | ||
| currentSchema: SchemaOpenAPI, | ||
| messages: MutableList<String> | ||
| ): Schema<*>? { | ||
| val get = pathItem.get ?: return null | ||
| return get.responses | ||
| ?.filter { (code, _) -> code.startsWith("2") } | ||
| ?.values | ||
| ?.firstNotNullOfOrNull { response -> | ||
| val resolved = if (response.`$ref` != null) { | ||
| SchemaUtils.getReferenceResponse(schemaHolder, currentSchema, response.`$ref`, messages) | ||
| ?: return@firstNotNullOfOrNull null | ||
| } else response | ||
| extractJsonSchema(resolved.content, schemaHolder, currentSchema, messages) | ||
| } | ||
| } | ||
|
|
||
| // For put and post, the resource is in the requestBody | ||
| private fun fromRequestBody( | ||
| operation: Operation?, | ||
| schemaHolder: RestSchema, | ||
| currentSchema: SchemaOpenAPI, | ||
| messages: MutableList<String> | ||
| ): Schema<*>? { | ||
| val body = operation?.requestBody ?: return null | ||
| val resolvedBody = if (body.`$ref` != null) { | ||
| SchemaUtils.getReferenceRequestBody(schemaHolder, currentSchema, body.`$ref`, messages) | ||
| ?: return null | ||
| } else body | ||
| return extractJsonSchema(resolvedBody.content, schemaHolder, currentSchema, messages) | ||
| } | ||
|
|
||
| private fun extractJsonSchema( | ||
| content: Map<String, MediaType>?, | ||
| schemaHolder: RestSchema, | ||
| currentSchema: SchemaOpenAPI, | ||
| messages: MutableList<String> | ||
| ): Schema<*>? { | ||
| val schema = content | ||
| ?.filterKeys { mt -> mt.contains("json") && !mt.contains(JSON_PATCH_MEDIA_TYPE) } | ||
| ?.values | ||
| ?.firstOrNull() | ||
| ?.schema | ||
| ?: return null | ||
| return if (schema.`$ref` != null) { | ||
| SchemaUtils.getReferenceSchema(schemaHolder, currentSchema, schema.`$ref`, messages) | ||
| } else schema | ||
| } | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why blackbox and whitebox, I think we need only one of them for testing this functionality.