Assegnazione variabile nella configurazione YAML

È possibile definire variabili all'interno di un file di configurazione YAML utilizzando lo strumento CLI. Queste variabili vengono utilizzate per configurare vari aspetti dello strumento.

È possibile configurare un file YAML in tre modi:
  • Utilizzando lo stesso file YAML.
  • Utilizzo delle variabili di ambiente
  • Utilizzo dei file YAM di configurazione esterna.
Nota: le variabili devono essere racchiuse tra parentesi graffe doppie. Ad esempio, "{{configs.base_url}}" o "{{paths.basePath}}". Questi segnaposto, nel formato "{{...}}", vengono sostituiti con i valori corrispondenti del file YAML di partenza, delle variabili ambientali o del file di configurazione esterno, a seconda della gerarchia delle precedenze.

La gerarchia di precedenza per l'assegnazione delle variabili è la seguente:

  1. File YAML di configurazione esterna (precedenza più alta)
  2. Variabili ambientali
  3. Configurazione impostata nello stesso file YAML (precedenza più bassa)
Se si configura un file YAML utilizzando tutti e tre i metodi, viene data priorità alle variabili assegnate tramite il file YAML di configurazione esterna.

1. Configurazione impostata nello stesso file YAML

È possibile assegnare valori alle variabili dall'interno dello stesso file YAML. Per questo, è necessario strutturare il file YAML nel modo seguente:

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

In questo caso, il tasto configs viene utilizzato per definire variabili come basePath e paths. Queste variabili possono essere utilizzate in tutto il file YAML per configurare lo strumento.

2. Variabili ambientali

È possibile sovrascrivere i valori delle variabili configurate nel file YAML utilizzando le variabili ambientali. Quando una variabile di ambiente condivide lo stesso nome di una variabile definita nel file YAML, il suo valore viene sostituito dalla variabile di ambiente corrispondente. Ciò fornisce un modo per personalizzare le configurazioni esternamente.

Ad esempio, se una variabile denominata base_url è definita nel file YAML come "{{configs.base_url}}"e il suo valore viene sostituito da una variabile di ambiente denominata base_url. Il valore di base_url nel file YAML viene sovrascritto dal valore della variabile di ambiente base_url .

3. File YAML di configurazione esterna

Lo strumento CLI supporta il livello più alto di precedenza della configurazione tramite i file di configurazione esterni. Per utilizzare un file di configurazione esterno, è necessario specificare il percorso del file utilizzando il flag --config-file o -c quando si utilizza lo strumento CLI. Le variabili definite nel file di configurazione esterno sostituiscono quelle definite nel file YAML principale o nelle variabili ambientali.

Ad esempio, si consideri un file di configurazione esterno config.yaml con il seguente contenuto:

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

Quando si esegue lo strumento CLI con il flag --config-file=config.yaml , le variabili definite nel file config.yaml sostituiscono le variabili corrispondenti nel file YAML principale o nelle variabili ambientali.

Per ulteriori informazioni sul modo in cui il test è definito come un file YAML, vedi Sintassi della definizione di test.