Affectation de variables dans la configuration YAML

Vous pouvez définir des variables dans un fichier de configuration YAML en utilisant l'outil CLI. Ces variables sont utilisées pour configurer divers aspects de l'outil.

Vous pouvez configurer un fichier YAML de trois manières:
  • Utilisation du même fichier YAML.
  • Utilisation de variables d'environnement
  • Utilisation des fichiers YAML de configuration externe.
Remarque: les variables doivent être placées entre deux accolades. Par exemple, "{{configs.base_url}}" ou "{{paths.basePath}}". Ces espaces réservés, au format "{{...}}", sont remplacés par les valeurs correspondantes du fichier YAML source, des variables d'environnement ou du fichier de configuration externe, en fonction de la hiérarchie de préséance.

La hiérarchie de priorité pour l'affectation de variables est la suivante:

  1. Fichier YAML de configuration externe (priorité la plus élevée)
  2. Variables d'environnement
  3. Configuration définie dans le même fichier YAML (priorité la plus basse)
Si vous configurez un fichier YAML en utilisant les trois méthodes, les variables attribuées à l'aide du fichier YAML de configuration externe sont prioritaires.

1. Configuration définie dans le même fichier YAML

Vous pouvez affecter des valeurs à des variables à partir du même fichier YAML. Pour cela, vous devez structurer votre fichier YAML de la manière suivante:

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

Ici, la clé configs est utilisée pour définir des variables telles que basePath et paths. Ces variables peuvent être utilisées dans le fichier YAML pour configurer l'outil.

2. Variables d'environnement

Vous pouvez remplacer les valeurs des variables configurées dans le fichier YAML en utilisant des variables d'environnement. Lorsqu'une variable d'environnement partage le même nom qu'une variable définie dans le fichier YAML, la valeur de la variable YAML est remplacée par la variable d'environnement correspondante. Cela permet de personnaliser les configurations en externe.

Par exemple, si une variable nommée base_url est définie dans le fichier YAML en tant que "{{configs.base_url}}"et que sa valeur est remplacée par une variable d'environnement nommée base_url. La valeur de base_url dans le fichier YAML est remplacée par la valeur de la variable d'environnement base_url .

3. Fichier YAML de configuration externe

L'outil d'interface de ligne de commande prend en charge le niveau de priorité de configuration le plus élevé via des fichiers de configuration externes. Pour utiliser un fichier de configuration externe, vous devez spécifier son chemin d'accès en utilisant l'indicateur --config-file ou -c lorsque vous utilisez l'outil CLI. Toutes les variables définies dans le fichier de configuration externe remplacent celles définies dans le fichier YAML principal ou dans les variables d'environnement.

Prenons l'exemple d'un fichier de configuration externe config.yaml dont le contenu est le suivant :

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

Lorsque vous exécutez l'outil CLI avec l'option --config-file=config.yaml , les variables définies dans le fichier config.yaml remplacent les variables correspondantes dans le fichier YAML principal ou les variables d'environnement.

Pour plus d'informations sur la façon dont le test est défini en tant que fichier YAML, voir Syntaxe de définition de test.