Expresiones CEL en archivos de configuración
Un archivo de configuración YAML o JSON no puede contener funciones de JavaScript. En su lugar, las opciones que aceptan una función en un archivo de configuración de JavaScript, y algunas otras, aceptan una expresión escrita en CEL (Common Expression Language) envuelta en ${{ ... }}. Con expresiones, un archivo de configuración estático puede filtrar pruebas, hacer coincidir categorías y entornos, calcular nombres y leer variables de entorno.
Sintaxis
name: "${{ 'Nightly ' + date.isoDate }}"
plugins:
awesome:
options:
filter: "${{ test.status != 'skipped' }}"{
"name": "${{ 'Nightly ' + date.isoDate }}",
"plugins": {
"awesome": {
"options": {
"filter": "${{ test.status != 'skipped' }}"
}
}
}
}- El valor completo debe ser una sola expresión. Un valor con texto antes de
${{se usa como texto simple, y un valor con texto después de}}es un error. - Escribe las cadenas dentro de una expresión entre comillas simples, y pon entre comillas el valor completo en YAML. Para una expresión larga, usa un bloque plegado de YAML (
>-), que puede abarcar varias líneas. - Operadores y funciones usados con frecuencia:
==,!=,<,>,&&,||,!,condition ? a : b,+(también une cadenas),contains(),startsWith(),endsWith(),matches(),list.exists(x, condition),int(),double()ystring(). Consulta la definición del lenguaje CEL para verlos todos. matches()comprueba una expresión regular. Distingue mayúsculas y minúsculas y encuentra el patrón en cualquier parte del valor, a menos que lo delimites con^y$. Duplica las barras invertidas en el patrón, por ejemploname.matches('^internal_\\d+$'). En una cadena YAML entre comillas dobles, dupĺicalas una vez más (\\\\d), o usa un bloque>-, que no lo necesita.- Comprueba los valores opcionales con
has()antes de usarlos: variables de entorno que pueden no estar definidas, y campos del resultado de prueba que pueden faltar, comodurationo el mensaje de error. Por ejemplo,has(env.CI) && env.CI == 'true'. Leer un valor ausente es un error. - Allure comprueba las expresiones cuando lee el archivo de configuración. Si una expresión no es válida o devuelve un valor del tipo incorrecto, Allure se detiene con un error que nombra la opción, por ejemplo,
Invalid expression at hideLabels[0]: expression must return a boolean.
Las expresiones también funcionan en archivos de configuración de JavaScript, pero allí puedes usar funciones en su lugar.
Dónde puedes usar expresiones
| Opción | Variables | La expresión devuelve |
|---|---|---|
Elementos de hideLabels | name | booleano: true oculta la etiqueta |
matchers de categories | data | booleano: true pone la prueba en la categoría |
environments.<id>.matcher | labels | booleano: true pone la prueba en el entorno |
name, environments.<id>.name, name de categoría, reportName de los plugins Awesome, Classic, Dashboard y Allure2, Awesome charts[].title, Dashboard layout[].title, CSV fields[].header, TestOps launchName | env, date | cadena |
filter de los plugins Awesome, Classic, Dashboard, CSV, Log y TestOps (ver) | test, env | booleano: true incluye la prueba |
Log qualityGateFilter | result, env | booleano: true imprime el resultado del quality gate |
CSV fields[].accessor | test, env | cadena, o null para una celda vacía |
CSV sort | a, b, env | número: negativo si a va primero, positivo si va b |
qualityGate enabled | env | booleano |
Valores esperados de las reglas de qualityGate | env | el valor que espera la regla, por ejemplo un número |
filter de los conjuntos de reglas de qualityGate | test, env | booleano: true comprueba la prueba |
message y successMessage en qualityGate.use | expected, actual | cadena |
allureService.accessToken | env | cadena |
Allure toma los valores de todas las demás opciones literalmente. Por ejemplo, la opción filter del plugin TestPlan todavía necesita un archivo de configuración de JavaScript.
Las variables contienen:
env- las variables de entorno. Allure las lee una vez, cuando lee el archivo de configuración.date- la hora en que Allure leyó el archivo de configuración, en UTC:date.iso(por ejemplo,2026-11-06T09:30:00.000Z),date.isoDate(2026-11-06),date.year,date.month(1 a 12),date.dayydate.unixMs(milisegundos desde el Unix epoch).test,a,b- un resultado de prueba, con campos comoname,fullName,status,duration(en milisegundos),flaky,labels(una lista de objetos connameyvalue),parameters,error.messageyerror.trace.data- los datos que comprueba un matcher de categoría:status,flaky,labelsy, si está disponible,message,trace,duration(en milisegundos),transitionyenvironment.labels- las etiquetas del resultado de prueba, una lista de objetos connameyvalue.name- el nombre de la etiqueta.result- un resultado de quality gate, con los camposrule,success,actual,expectedymessage.expected,actual- el valor que espera la regla del quality gate y el valor que encontró.
Ejemplos
Los ejemplos de abajo son partes de un archivo de configuración.
Nombre del reporte
El nombre del reporte incluye la fecha en que se generó el reporte. Si la variable de entorno REPORT_NAME está definida, el nombre comienza con su valor, de lo contrario con "Allure Report":
name: "${{ (has(env.REPORT_NAME) ? env.REPORT_NAME : 'Allure Report') + ' ' + date.isoDate }}"Un nombre pasado con la opción de línea de comandos --name reemplaza al nombre configurado y se usa tal como está.
Ocultar etiquetas
Oculta la etiqueta owner, y todas las etiquetas cuyos nombres comiencen con internal_:
hideLabels:
- owner
- "${{ name.startsWith('internal_') }}"Categorías
La primera categoría recopila las pruebas cuyo mensaje de error contiene "timeout". La segunda recopila las pruebas de UI fallidas que se ejecutaron durante más de 5 segundos:
categories:
- name: Timeouts
matchers: "${{ has(data.message) && data.message.contains('timeout') }}"
- name: Slow UI failures
matchers: >-
${{ data.status == 'failed' && has(data.duration) && data.duration > 5000 &&
data.labels.exists(l, l.name == 'layer' && l.value == 'ui') }}Si el nombre de una categoría es una expresión, define el id de la categoría, para que la categoría permanezca igual cuando su nombre cambie.
Entornos
Pon las pruebas que se ejecutaron en Firefox en Linux en un entorno, y las pruebas que se ejecutaron en Chrome en otro:
environments:
firefox_linux:
name: Firefox on Linux
matcher: >-
${{ labels.exists(l, l.name == 'browser' && l.value == 'firefox') &&
labels.exists(l, l.name == 'os' && l.value == 'linux') }}
chrome:
name: Chrome
matcher: "${{ labels.exists(l, l.name == 'browser' && l.value == 'chrome') }}"Filtrar pruebas en los reportes
El reporte Awesome omite las pruebas omitidas. El archivo CSV solo lista las pruebas fallidas y rotas, ordenadas por duración (la más larga primero), con una columna de duración calculada y el mensaje de error. El plugin Log solo imprime las pruebas fallidas y rotas:
plugins:
awesome:
options:
filter: "${{ test.status != 'skipped' }}"
csv:
options:
fileName: failures.csv
filter: "${{ test.status == 'failed' || test.status == 'broken' }}"
fields:
- header: Name
accessor: name
- header: Duration
accessor: "${{ has(test.duration) ? dyn(string(test.duration) + ' ms') : null }}"
- header: Error
accessor: "${{ has(test.error) && has(test.error.message) ? test.error.message : null }}"
sort: "${{ (has(b.duration) ? b.duration : 0) - (has(a.duration) ? a.duration : 0) }}"
log:
options:
filter: "${{ test.status == 'failed' || test.status == 'broken' }}"Quality gate
El quality gate solo se ejecuta si la variable de entorno CI está definida, como lo está en la mayoría de los servicios de CI. El primer conjunto de reglas permite 5 pruebas fallidas, o tantas como indique la variable de entorno MAX_FAILURES. El segundo conjunto de reglas detiene la ejecución en cuanto falla una prueba con la severidad critical. La lista use cambia el mensaje de la regla maxFailures:
qualityGate:
enabled: "${{ has(env.CI) }}"
rules:
- maxFailures: "${{ has(env.MAX_FAILURES) ? int(env.MAX_FAILURES) : 5 }}"
- id: critical
maxFailures: 0
fastFail: true
filter: "${{ test.labels.exists(l, l.name == 'severity' && l.value == 'critical') }}"
use:
- rule: maxFailures
message: "${{ 'Failed tests: ' + string(actual) + ', allowed: ' + string(expected) }}"Si agregas use, reemplaza la lista de reglas que Allure conoce, así que lista cada regla que usen tus conjuntos de reglas. Para una regla incorporada, su nombre es suficiente.
Cuando el quality gate está deshabilitado, allure quality-gate omite la comprobación y sale con código de salida 0.
Token de acceso desde una variable de entorno
Lee el token de acceso de Allure Report Storage desde la variable de entorno ALLURE_SERVICE_TOKEN. Puedes elegir cualquier nombre de variable:
allureService:
accessToken: "${{ has(env.ALLURE_SERVICE_TOKEN) ? env.ALLURE_SERVICE_TOKEN : '' }}"Si la variable no está definida, la expresión devuelve una cadena vacía, y Allure funciona sin el servicio de almacenamiento. Para hacer que el token sea obligatorio, escribe "${{ env.ALLURE_SERVICE_TOKEN }}": entonces cada comando de Allure que lee el archivo de configuración se detiene con un error si la variable no está definida.