Asignación de variables en la configuración de YAML

Puede definir variables dentro de un archivo de configuración YAML utilizando la herramienta CLI. Estas variables se utilizan para configurar varios aspectos de la herramienta.

Puede configurar un archivo YAML de tres maneras:
  • Utilizando el mismo archivo YAML.
  • Utilización de variables de entorno
  • Utilizando los archivos YAML de configuración externa.
Nota: Las variables deben estar entre llaves dobles. Por ejemplo, "{{configs.base_url}}" o "{{paths.basePath}}". Estos marcadores de posición, con el formato de "{{...}}", se sustituyen por sus valores correspondientes del archivo YAML de origen, las variables de entorno o el archivo de configuración externo en función de la jerarquía de precedencia.

La jerarquía de prioridad para la asignación de variables es la siguiente:

  1. Archivo YAML de configuración externa (prioridad más alta)
  2. Variables de entorno
  3. Configuración establecida en el mismo archivo YAML (prioridad más baja)
Si se configura un fichero YAML utilizando los tres métodos, se da prioridad a las variables que se asignan utilizando el fichero YAML de configuración externa.

1. Configuración establecida en el mismo archivo YAML

Puede asignar valores a variables desde el mismo archivo YAML. Para ello, debe estructurar el archivo YAML de la siguiente manera:

 configs:
    basePath: ...paths:
        - basePath: ...

Aquí, la clave configs se utiliza para definir variables como basePath y paths. Estas variables se pueden utilizar en todo el archivo YAML para configurar la herramienta.

2. Variables ambientales

Puede anular los valores de las variables configuradas en el archivo YAML utilizando variables de entorno. Cuando una variable de entorno comparte el mismo nombre que una variable definida en el archivo YAML, el valor de la variable YAML se sustituye por la variable de entorno correspondiente. Esto proporciona una forma de personalizar las configuraciones externamente.

Por ejemplo, si una variable denominada base_url se define en el archivo YAML como "{{configs.base_url}}", y su valor se sustituye por una variable de entorno denominada base_url. El valor de base_url en el archivo YAML se altera temporalmente por el valor de la variable de entorno base_url .

3. Archivo YAML de configuración externa

La herramienta CLI da soporte al nivel más alto de prioridad de configuración a través de archivos de configuración externos. Para utilizar un archivo de configuración externo, debe especificar su ruta de archivo mediante el uso de la --config-file o -c bandera cuando y la herramienta CLI. Las variables definidas en el archivo de configuración externo sustituyen a las definidas en el archivo YAML principal o a través de las variables de entorno.

Por ejemplo, considere un archivo de configuración externo config.yaml con el siguiente contenido:

 external_config:
    base_url: https://example.comapi_key: your-api-key

Al ejecutar la herramienta CLI con el indicador --config-file=config.yaml , las variables definidas en el archivo config.yaml sustituyen a las variables correspondientes del archivo YAML principal o las variables de entorno.

Para obtener más información sobre cómo se define la prueba como un archivo YAML, consulte Sintaxis de definición de prueba.