Archivo de resultados de prueba
WARNING
Esta página describe un formato de datos utilizado por Allure y sus adaptadores para marcos de pruebas. Entender este formato no es necesario para usar Allure en tu proyecto. Para una descripción más general del proceso de construcción de un informe, consulta Cómo funciona.
Un archivo de resultados de prueba almacena datos relacionados con una sola ejecución de una prueba individual.
Los datos se almacenan como un objeto JSON. Cada archivo se nombra {uuid}-result.json, donde {uuid} es un identificador generado aleatoriamente.
Este artículo describe las propiedades que pueden encontrarse en el objeto JSON. Algunas de estas propiedades también pueden encontrarse en los objetos que describen pasos de prueba y sub-pasos (consulta la sección de steps).
Ejemplo:
{
"uuid": "9d95e6e7-9cf6-4ca5-91b4-9b69ce0971f8",
"historyId": "2b35e31882061875031701ba05a3cd67",
"testCaseId": "43f8868a367ff70177a99838d39c5b33",
"fullName": "com.example.web.essentials.AuthenticationTest.testAuthentication",
"name": "testAuthentication()",
"links": [
{
"type": "link",
"name": "Allure Examples",
"url": "https://examples.com/"
},
{
"type": "issue",
"name": "BUG-123",
"url": "https://bugs.example.com/BUG-123"
}
],
"labels": [
{
"name": "host",
"value": "machine-1"
},
{
"name": "thread",
"value": "306681-MainThread"
},
{
"name": "language",
"value": "java"
},
{
"name": "framework",
"value": "junit-platform"
},
{
"name": "epic",
"value": "Web interface"
},
{
"name": "feature",
"value": "Essential features"
},
{
"name": "story",
"value": "Authentication"
}
],
"status": "passed",
"start": 1682358426014,
"stop": 1682358426014,
"steps": [
{
"name": "Step 1",
"status": "passed",
"start": 1682358426014,
"stop": 1682358426014
},
{
"name": "Step 2",
"status": "passed",
"start": 1682358426014,
"stop": 1682358426014
}
]
}Identificadores
uuid (string)
Un identificador único del resultado de la prueba.
historyId (string)
Un identificador utilizado por Allure Report. Dos ejecuciones de la misma prueba con el mismo conjunto de parámetros siempre tendrán el mismo historyId.
testCaseId (string)
Un identificador utilizado por Allure TestOps. Dos ejecuciones de la misma prueba siempre tendrán el mismo testCaseId.
Metadatos
name (string)
El título de la prueba o el nombre del paso.
fullName (string)
Un identificador único basado en el nombre del archivo y el nombre de la prueba. Diferentes complementos de Allure pueden usar diferentes notaciones para generar este identificador.
description (string)
La descripción de la prueba o paso en formato Markdown.
descriptionHtml (string)
La descripción de la prueba o paso en formato HTML.
links (array)
Un array de enlaces añadidos a la prueba o paso.
Cada objeto en el array tiene las siguientes propiedades:
name(string): el nombre del enlace que se mostrará en el informe de prueba.url(string): la URL completa del enlace.type(string): el tipo de enlace, por ejemplo, “issue” o “tms”.
labels (array)
Un array de varias etiquetas añadidas a la prueba o paso.
Cada objeto en el array tiene las siguientes propiedades:
name(string): el nombre de la etiqueta.value(string): el valor de la etiqueta.
Un resultado de prueba puede tener múltiples etiquetas con el mismo nombre. Por ejemplo, esto ocurre a menudo cuando un resultado de prueba tiene múltiples etiquetas.
Muchos campos de metadatos y campos relacionados con la navegación están representados en el archivo como etiquetas:
| Nombre de etiqueta | Enlace a la descripción del campo |
|---|---|
tag | Tags |
severity | Severidad |
owner | Propietario |
epic | Épica |
feature | Funcionalidad |
story | Historia |
parentSuite | Suite principal |
suite | Suite |
subSuite | Sub-suite |
package | Paquete |
Además, la mayoría de los adaptadores de Allure configuran las siguientes etiquetas para cada prueba:
| Nombre de etiqueta | Descripción |
|---|---|
host | Nombre del host de la máquina donde se ejecutó la prueba. |
thread | El identificador del hilo donde se ejecutó la prueba. |
language | El lenguaje de programación de la prueba. |
framework | El marco de prueba utilizado. |
El autor de la prueba puede establecer etiquetas adicionales con nombres arbitrarios, consulta Otras metadatos.
parameters (array)
Un array de parámetros añadidos a la prueba o paso.
Cada objeto en el array tiene las siguientes propiedades:
name(string): el nombre del parámetro.value(string): el valor del parámetro.excluded(boolean): si es verdadero, Allure no utilizará el parámetro al comparar el resultado actual con el anterior en el historial.mode(string): cómo se mostrará el parámetro en el informe:default: el parámetro y su valor se mostrarán en una tabla junto con otros parámetros.masked: el parámetro se mostrará en la tabla, pero su valor estará oculto.hidden: el parámetro y su valor no se mostrarán en el informe de la prueba.
attachments (array)
Un array de adjuntos añadidos a la prueba o paso.
El contenido de cada adjunto se almacena como un archivo en el directorio de resultados. El archivo se nombra {uuid}-attachment.{ext}, donde {uuid} es un identificador generado aleatoriamente, y {ext} es la extensión del archivo.
Cada objeto en el array tiene las siguientes propiedades:
name(string): el nombre legible del adjunto.source(string): el nombre del archivo con el contenido del adjunto.type(string): el tipo de medio del contenido.
Ejecución
status (string)
El estado con el que finalizó la prueba o paso. Los valores posibles son: “failed”, “broken”, “passed”, “skipped”, “unknown”. Consulta Estados de prueba.
statusDetails (object)
Un objeto con las siguientes propiedades:
known(boolean): indica que la prueba falla debido a un error conocido.muted(boolean): indica que el resultado no debe afectar las estadísticas. Consulta Análisis visual.flaky(boolean): indica que esta prueba o paso es conocido por ser inestable y puede no tener éxito en cada ejecución. Consulta Pruebas inestables.message(string): el mensaje de texto breve para mostrar en los detalles de la prueba, como el nombre de la excepción que causó un fallo.trace(string): el rastro completo de la pila para mostrar en los detalles de la prueba.
stage (string)
La etapa en el ciclo de vida de la prueba o paso.
Los valores posibles son: “scheduled”, “running”, “finished”, “pending”, “interrupted”.
start (integer)
El momento en que comenzó la ejecución de la prueba o paso, en formato timestamp de UNIX.
Junto con stop, este campo se utiliza para colocar la prueba en la pestaña Línea de tiempo y para calcular su duración.
stop (integer)
El momento en que finalizó la ejecución de la prueba o paso, en formato timestamp de UNIX.
Junto con start, este campo se utiliza para colocar la prueba en la pestaña Línea de tiempo y para calcular su duración.
steps (array)
Un array de pasos de prueba.
Cada paso puede contener un array de steps, lo que permite representar una estructura anidada de pasos y sub-pasos.
Los objetos en el array tienen las siguientes propiedades, cada una con el mismo formato que la propiedad correspondiente de un resultado de prueba:
- Metadatos
- Ejecución