Test dei DAG

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Nota: questa pagina non è ancora stata rivista per Cloud Composer 3 e mostra contenuti per Cloud Composer 2.

Prima di eseguire il deployment dei DAG in produzione, puoi eseguire i sottocomandi della CLI Airflow per analizzare il codice DAG nello stesso contesto in cui viene eseguito il DAG.

Nota: poiché Apache Airflow non fornisce un forte isolamento dei DAG, di mantenere ambienti di produzione e test separati per prevenire le interferenze DAG.

Testa i DAG localmente con lo strumento CLI di sviluppo locale di Composer

Lo strumento CLI Composer Local Development semplifica lo sviluppo di DAG Apache Airflow per Cloud Composer 2 eseguendo un ambiente Airflow in locale. Questo ambiente Airflow locale utilizza l'immagine di un una versione specifica di Cloud Composer 2.

Puoi sviluppare e testare i DAG utilizzando questo ambiente Airflow locale, quindi trasferirli nell'ambiente Cloud Composer di test. Il resto di questa guida descrive il test dei DAG in un test nell'ambiente Cloud Composer.

Nota: se utilizzi lo strumento CLI di sviluppo locale di Composer per testare i DAG, puoi eseguire i comandi Airflow CLI descritti in questa guida nel tuo ambiente Airflow locale utilizzando una sintassi diversa.

Test durante la creazione del DAG

Puoi eseguire una singola istanza di attività in locale e visualizzare l'output del log. La visualizzazione dell'output consente di verificare la presenza di errori di sintassi e delle attività. I test in locale non controllano le dipendenze né comunicano lo stato al database.

Ti consigliamo di inserire i DAG in una cartella data/test nel tuo ambiente di test.

Crea una directory di prova

Nel bucket del tuo ambiente, crea una directory di test in cui copia i DAG.

gcloud storage cp BUCKET_NAME/dags \
  BUCKET_NAME/data/test --recursive

Sostituisci quanto segue:

• BUCKET_NAME: il nome del bucket associato al tuo ambiente Cloud Composer.

Esempio:

gcloud storage cp gs://us-central1-example-environment-a12bc345-bucket/dags \
  gs://us-central1-example-environment-a12bc345-bucket/data/test --recursive

Per ulteriori informazioni sul caricamento dei DAG, vedi Aggiungi e aggiorna i DAG.

Verificare la presenza di errori di sintassi

Per verificare la presenza di errori di sintassi nei DAG caricati nella cartella /data/test , inserisci il seguente comando gcloud:

gcloud composer environments run \
  ENVIRONMENT_NAME \
  --location ENVIRONMENT_LOCATION \
  dags list -- --subdir /home/airflow/gcs/data/test

Sostituisci quanto segue:

• ENVIRONMENT_NAME: il nome dell'ambiente.
• ENVIRONMENT_LOCATION: la regione in cui si trova l'ambiente.

Verificare la presenza di errori nelle attività

Per verificare la presenza di errori specifici delle attività nei DAG che hai caricato nella cartella /data/test, esegui il seguente comando gcloud:

gcloud composer environments run \
  ENVIRONMENT_NAME \
  --location ENVIRONMENT_LOCATION \
  tasks test -- --subdir /home/airflow/gcs/data/test \
  DAG_ID TASK_ID \
  DAG_EXECUTION_DATE

Sostituisci quanto segue:

• ENVIRONMENT_NAME: il nome dell'ambiente.
• ENVIRONMENT_LOCATION: la regione in cui si trova l'ambiente.
• DAG_ID: l'ID del DAG.
• TASK_ID: l'ID dell'attività.
• DAG_EXECUTION_DATE: la data di esecuzione del DAG. Questa data è in uso per la creazione di modelli. Indipendentemente dalla data specificata qui, il DAG viene eseguito immediatamente.

Esempio:

gcloud composer environments run \
  example-environment \
  --location us-central1 \
  tasks test -- --subdir /home/airflow/gcs/data/test \
  hello_world print_date 2021-04-22

Aggiornamento e test di un DAG di cui è stato eseguito il deployment

Per testare gli aggiornamenti dei DAG nell'ambiente di test:

1. Copia in data/test il DAG di cui hai eseguito il deployment che vuoi aggiornare.
2. Aggiorna il DAG.
3. Testa il DAG.
   1. Controlla che non siano presenti errori di sintassi.
   2. Verifica la presenza di errori specifici delle attività.
4. Assicurati che il DAG venga eseguito correttamente.
5. Disattiva il DAG nell'ambiente di test.
   1. Vai alla pagina UI di Airflow > DAG.
   2. Se il DAG che stai modificando viene eseguito costantemente, disattivalo.
   3. Per velocizzare le attività in sospeso, fai clic sull'attività e su Contrassegna come completata.
6. Esegui il deployment del DAG nel tuo ambiente di produzione.
   1. Disattiva il DAG nell'ambiente di produzione.
   2. Carica il DAG aggiornato nella cartella dags/ del tuo ambiente di produzione.

Domande frequenti per i test dei DAG

Come faccio a isolare le esecuzioni del DAG nei miei ambienti di produzione e di test?

Ad esempio, Airflow dispone di un repository globale di codice sorgente in dags/ condivisa condivisa da tutte le esecuzioni dei DAG. Vuoi aggiornare il codice sorgente in produzione o testare senza interferire con i DAG in esecuzione.

Airflow non fornisce un isolamento DAG efficace. Ti consigliamo di mantenere ambienti Cloud Composer di produzione e di test separati per impedire ai DAG di test di interferire con i DAG di produzione.

Come faccio a evitare interferenze con il DAG quando eseguo test di integrazione da diversi rami di GitHub

Usa nomi univoci per le attività per evitare interferenze. Ad esempio, puoi aggiungere un prefisso gli ID attività con il nome del ramo.

Qual è una best practice per i test di integrazione con Airflow?

Ti consigliamo di utilizzare un ambiente dedicato per i test di integrazione con Airflow. Un modo per segnalare l'esito positivo dell'esecuzione del DAG è scrivere in un file in una cartella Cloud Storage e poi controllare i contenuti nei tuoi scenari di test di integrazione.

Come posso collaborare in modo efficiente con altri collaboratori DAG?

Ogni collaboratore può avere una sottodirectory nella cartella data/ per lo sviluppo.

I DAG aggiunti alla cartella data/ non vengono raccolti automaticamente Scheduler o server web Airflow

I collaboratori del DAG possono creare esecuzioni manuali del DAG utilizzando il comando gcloud composer environments run e il sottocomando test con il flag --subdir per specificare la directory di sviluppo del collaboratore.

Ad esempio:

gcloud composer environments run test-environment-name \
  tasks test -- dag-id task-id execution-date \
  --subdir /home/airflow/gcs/data/alice_dev

Come posso mantenere sincronizzati il mio ambiente di deployment e produzione?

Per gestire l'accesso:

• Per l'autenticazione, utilizza account di servizio.

• Per il controllo dell'accesso, usa Identity and Access Management e Cloud Composer ruoli e autorizzazioni.

Per eseguire il deployment dallo sviluppo alla produzione:

• Assicurati una configurazione coerente, ad esempio variabili di ambiente e PyPI pacchetti.

• Assicurati che gli argomenti DAG siano coerenti. Per evitare la programmazione a livello di codice, ti consigliamo di utilizzare le macro e le variabili Airflow.

  Ad esempio:

  gcloud composer environments run test-environment-name \
    variables set -- DATA_ENDPOINT_KEY DATA_ENDPOINT_VALUE
  

Passaggi successivi

• Risoluzione dei problemi dei DAG
• Aggiunta e aggiornamento di DAG
• Testa, sincronizza ed esegui il deployment dei DAG utilizzando il controllo della versione