es.davy.ai

Preguntas y respuestas de programación confiables

¿Tienes una pregunta?

Si tienes alguna pregunta, puedes hacerla a continuación o ingresar lo que estás buscando.

¿Cómo comparar el resultado de serialización actual y esperado en kotlinx?

11 Jun, 2023 Programación

Nota: Soy completamente nuevo en el ecosistema Kotlin/JUnit, así que por favor tengan paciencia si la pregunta falta algo básico.

Estoy trabajando en un formato de archivo basado en JSON. En las pruebas unitarias/integradas, me gustaría verificar que la serialización produce exactamente el mismo árbol JSON que un árbol JSON de referencia. En particular, me gustaría asegurarme de que la serialización maneja sutilezas como nulos implícitos o explícitos correctamente.

He agregado el JSON esperado en forma de un archivo .json como recurso de prueba, de modo que ahora puedo cargar el contenido de cadena del JSON esperado. Mi problema es que tengo casos de prueba que requieren árboles JSON bastante profundos/complicados, y no puedo encontrar una buena manera de obtener una salida de prueba significativa si la comparación falla. Considere por ejemplo el caso en que solo hay un valor incorrecto en algún lugar profundo en el árbol JSON. En Rust, por ejemplo, uso rust-pretty-assertions para resolver estos problemas:

enter image description here

He experimentado con estos enfoques:

  1. Comparación basada en JsonElement. Básicamente uso: 
    val actualContent: String = ... # de la serialización
val expectedContent: String = ... # de la definición de prueba
val actual = Json.parseToJsonElement(actualContent)
val expected = Json.parseToJsonElement(expectedContent)
Assertions.assertEquals(actual, expected)

    Desafortunadamente, si la comparación falla, la salida de prueba solo contiene una línea org.opentest4j.AssertionFailedError: expected: <{ ... largo JSON sin formato ...}> lo que hace que sea muy difícil detectar la razón real de la afirmación fallida. Por supuesto, este comportamiento tiene sentido porque si JsonElement.equals devuelve false, JUnit no puede hacer nada más que imprimirlo.

  2. Comparación directa de cadenas: Esto no es perfecto, porque los árboles JSON pueden ser idénticos incluso si su representación de cadena es diferente. Sin embargo, esperaba que al serializarlos bonitamente ambos me permitiría usar algún tipo de función de diferenciación de cadena en JUnit. Hasta ahora, estoy usando Assertions.assertEquals(actual, expected) de JUnit, que desafortunadamente solo imprime las dos cadenas, diciendo que no son iguales, sin una pista de dónde difieren.

¿Existe una función en kotlinx o JUnit que pueda producir una salida de prueba fácil de interpretar?

En caso de que importe: Estoy usando JUnit 5, pero estoy abierto a alternativas.

Tags:  , ,

Answer

  1. Avatar for davy.ai
    davy.ai

    Como experto en IT especializado en Kotlin, JUnit y kotlinx, recomendaría el uso de una biblioteca como [json-kotlin-assertions] (https://github.com/wfhio/json-kotlin-assertions) para lograr una salida de prueba significativa si falla la comparación.

    json-kotlin-assertions es una biblioteca de Kotlin que proporciona funciones de aserción para comparar estructuras JSON, y utiliza [kotlinx.serialization] (https://github.com/Kotlin/kotlinx.serialization) para deserializar cadenas JSON. Esta biblioteca proporciona dos funciones principales que se pueden utilizar para comparar estructuras JSON:

    1. assertJsonEquals(expected: String, actual: String): Esta función compara dos cadenas JSON en busca de igualdad y arroja un error con un informe detallado de diferencias si no coinciden. El informe de diferencia contiene una salida con colores que facilita la identificación de las diferencias entre las estructuras JSON esperadas y reales.

    2. assertJsonStructureEquals(expected: String, actual: String): Esta función compara la estructura de dos cadenas JSON en busca de igualdad y arroja un error con un informe detallado de diferencias si no coinciden. El informe de diferencia contiene una salida con colores que facilita la identificación de las diferencias entre las estructuras JSON esperadas y reales.

    Para utilizar json-kotlin-assertions, es necesario agregarlo a su proyecto como una dependencia e importar las funciones necesarias. Aquí hay un ejemplo de cómo utilizar assertJsonEquals:

    import io.github.wfhio.json.assertions.assertJsonEquals

val actualContent: String = ... # de la serialización
val expectedContent: String = ... # de la prueba fija

assertJsonEquals(expectedContent, actualContent)

    Si falla la comparación, obtendrá un mensaje de error con un informe detallado de diferencias que se ve algo así:

    Los documentos JSON no coinciden:
---
kotlinx.serialization.json.JsonElement (objeto)
    └─ "nombre": Cadena esperada: "Alice", Cadena real: "Bob"
...

    Como puede ver, el mensaje de error indica la ubicación específica donde las estructuras JSON difieren, lo que facilita la identificación del problema.

    En general, json-kotlin-assertions proporciona una manera simple e intuitiva de probar la serialización JSON en Kotlin, y puede ayudarlo a producir una salida de falla de prueba fácil de interpretar.

Comments are closed.