Amministratori e sviluppatori di vRealize Automation Code Stream possono utilizzare il trigger Gerrit per integrare vRealize Automation Code Stream con il ciclo di vita di revisione del codice Gerrit. L'evento attiva una pipeline da eseguire quando si crea un set di patch, si pubblicano bozze, si uniscono modifiche al codice nel progetto Gerrit o si inseriscono direttamente le modifiche nel ramo Git.

Quando si aggiunge il trigger per Gerrit, si seleziona un listener Gerrit, un progetto Gerrit nel server e si configurano gli eventi Gerrit. In questo esempio, si configura prima un listener Gerrit, quindi si utilizza tale listener in un trigger Gerrit con due eventi in tre pipeline diverse.

Prerequisiti

Procedura

  1. In vRealize Automation Code Stream, fare clic su Trigger > Gerrit.
  2. (Facoltativo) Fare clic sulla scheda Listener, quindi su Nuovo listener .
    Nota: Ignorare questo passaggio se il listener Gerrit che si intende utilizzare per il trigger Gerrit è già definito.
    1. Selezionare un progetto.
    2. Immettere un nome per il listener Gerrit.
    3. Selezionare un endpoint Gerrit
    4. Immettere il token dell'API.
      Il token dell'API CSP autentica l'utente per le connessioni API esterne con vRealize Automation Code Stream. Per ottenere il token API:
      1. Fare clic su Genera Token.
      2. Immettere l'indirizzo e-mail associato al nome utente e alla password, quindi fare clic su Genera.
        Il token generato è valido per sei mesi. È anche noto come token di aggiornamento.
        • Per mantenere il token come una variabile per un utilizzo futuro, fare clic su Crea variabile, assegnare un nome alla variabile e fare clic su Salva.
        • Per mantenere il token come valore di testo per un utilizzo futuro, fare clic su Copia e incollare il token in un file di testo da salvare in locale.
        È possibile scegliere di creare una variabile e archiviare il token in un file di testo per un utilizzo futuro.
      3. Fare clic su Chiudi.
      Se è stata creata una variabile, nel token dell'API viene visualizzato il nome della variabile immesso. Se il token è stato copiato, il token dell'API mostra il token mascherato.

      Listener Gerrit per il trigger

    5. Per convalidare i dettagli del token e dell'endpoint, fare clic su Convalida.
      Il token scade dopo 90 giorni.
    6. Fare clic su Crea.
    7. Nella scheda del listener, fare clic su Connetti.
      Il listener avvia il monitoraggio di tutte le attività nel server Gerrit e ascolta tutti i trigger abilitati in tale server. Per interrompere l'ascolto di un trigger in tale server, disabilitare il trigger.
  3. Fare clic sulla scheda Trigger, quindi su Nuovo trigger Gerrit.
  4. Selezionare un progetto nel server Gerrit.
  5. Immettere un nome.
    Il nome del trigger Gerrit deve essere univoco.
  6. Selezionare un listener Gerrit configurato.
    vRealize Automation Code Stream utilizza la selezione del listener Gerrit per fornire un elenco dei progetti Gerrit disponibili nel server.
  7. Selezionare un progetto nel server Gerrit.
  8. Immettere il ramo nel repository da monitorare.
  9. (Facoltativo) Specificare inclusioni o esclusioni di file come condizioni per il trigger.
    • È possibile specificare le inclusioni dei file per disporre di pipeline di trigger. Quando uno qualsiasi dei file in un commit corrisponde ai file specificati nel regex o nei percorsi di inclusione, vengono attivate le pipeline. Con un regex specificato, vRealize Automation Code Stream attiva solo le pipeline i cui nomi file nell'insieme di modifiche corrispondono all'espressione specificata. Il filtro regex è utile quando si configura un trigger per più pipeline in un singolo repository.
    • È possibile specificare esclusioni di file per impedire l'attivazione delle pipeline. Quando tutti file in un commit corrispondono ai file specificati nel regex o nei percorsi di esclusione, le pipeline non vengono attivate.
    • Quando attivata, Assegna priorità all'esclusione garantisce che le pipeline non vengano attivate. Le pipeline non vengono attivate anche se uno qualsiasi dei dati in un commit corrisponde ai dati specificati nel regex nei percorsi di esclusione. L'opzione è disattivata per impostazione predefinita.
    Se vengono soddisfatte sia le condizioni per l'inclusione sia quelle per l'esclusione, le pipeline non vengono attivate.

    Nell'esempio seguente sia le inclusioni che le esclusioni sono condizioni per l'attivazione.

    Esempio di inclusioni ed esclusioni di file

    • Per le inclusioni dei file, un commit con una modifica a runtime/src/main/a.java o a qualsiasi file java attiva le pipeline configurate nella configurazione dell'evento.
    • Per le esclusioni dei file, solo un commit con modifiche in entrambi i file non attiva le pipeline configurate nelle configurazioni dell'evento.
  10. Fare clic su Nuova configurazione.
    1. Per un evento Gerrit, selezionare Set di patch creato, Bozza pubblicata o Unione modifiche. In alternativa, per un inserimento diretto a Git che escluda Gerrit, selezionare Inserimento Git diretto.
    2. Selezionare la pipeline da attivare.
      Se la pipeline è stata configurata con parametri di input aggiunti personalizzati, nell'elenco Parametri di input vengono visualizzati i parametri e i valori. È possibile immettere valori per i parametri di input da trasmettere alla pipeline con l'evento trigger. In alternativa, è possibile lasciare vuoti i valori oppure utilizzare i valori predefiniti.
      Nota: Se sono definiti valori predefiniti:
      • Tutti i valori immessi per i parametri di input sostituiranno i valori predefiniti definiti nel modello della pipeline.
      • I valori predefiniti utilizzati per configurare il trigger non verranno aggiornati se i valori dei parametri nel modello della pipeline vengono modificati.

      Per informazioni sui parametri di input di invio automatico per i trigger Gerrit, vedere i Prerequisiti.

    3. Per Set di patch creato, Bozza pubblicata e Unione modifiche, alcune azioni vengono visualizzate con etichette per impostazione predefinita. È possibile modificare l'etichetta o aggiungere commenti. Quindi, quando la pipeline viene eseguita, l'etichetta o il commento vengono visualizzati nella scheda Attività come Azione intrapresa per la pipeline.
    4. Fare clic su Salva.
    Per aggiungere più eventi trigger in più pipeline, fare di nuovo clic su Nuova configurazione.
    Nell'esempio seguente è possibile visualizzare gli eventi per tre pipeline:
    • Se si verifica un evento Unione modifiche nel progetto Gerrit, viene attivata Gerrit-Pipeline.
    • Se si verifica un evento Set di patch creato nel progetto Gerrit, vengono attivate Gerrit-Trigger-Pipeline e Gerrit-Demo-Pipeline.

    Configurazione del listener e del trigger Gerrit

  11. Fare clic su Crea.
    Il trigger viene visualizzato come nuova scheda ed è disabilitato per impostazione predefinita.
  12. Nella scheda del trigger fare clic su Abilita.
    Quando il trigger è abilitato, utilizza il listener Gerrit per avviare il monitoraggio degli eventi che si verificano nel ramo del progetto Gerrit.
    Quando si crea il trigger, si include il repository in cui si verifica il commit del codice. Se si desidera creare un trigger con le stesse condizioni di inclusione o esclusione di file ma con un repository diverso, ad esempio, è possibile fare clic su Azioni > Clona nella scheda del trigger. Quindi fare clic su Apri nel nuovo trigger e modificare i parametri.

risultati

Congratulazioni! È stato configurato un trigger Gerrit con due eventi su tre pipeline diverse.

Operazioni successive

Dopo avere confermato una modifica del codice nel progetto Gerrit, selezionare la scheda Attività per l'evento Gerrit in vRealize Automation Code Stream. Verificare che l'elenco di attività includa voci corrispondenti a ogni esecuzione della pipeline configurata nel trigger. Quando si verifica un evento, verranno eseguite solo le pipeline nel trigger Gerrit correlate al tipo di evento specifico. In questo esempio, se viene creato un set di patch, vengono eseguite solo Gerrit-Trigger-Pipeline e Gerrit-Demo-Pipeline.

Le informazioni nelle colonne della scheda Attività descrivono ciascun evento del trigger Gerrit. È possibile scegliere le colonne da visualizzare.
  • Le colonne Modifica oggetto ed Esecuzione sono vuote se il trigger è un inserimento Git diretto.
  • La colonna Trigger Gerrit mostra il trigger che ha creato l'evento.
  • Il listener è disattivato per impostazione predefinita. Quando questa opzione è selezionata, viene visualizzato il listener Gerrit che ha ricevuto l'evento. Un listener può essere associato a più trigger.
  • Il tipo di trigger è disattivato per impostazione predefinita. Quando questa opzione è selezionata, mostra se il trigger è stato attivato manualmente o automaticamente.

Attività trigger Gerrit

Per controllare l'attività per un'esecuzione completata o non riuscita, fare clic sui tre puntini a sinistra di una voce nella schermata Attività.
  • Se la pipeline non viene eseguita a causa di un errore nel modello della pipeline o di un altro problema, correggere l'errore e selezionare Esegui nuovamente per eseguirla di nuovo.
  • Se la pipeline non viene eseguita a causa di un problema di connettività di rete o di un altro problema, selezionare Riprendi per riavviare la stessa esecuzione della pipeline. In questo modo si abbreviano i tempi di esecuzione.
  • Utilizzare Visualizza esecuzione per passare alla schermata Esecuzione. Vedere Come eseguire una pipeline e visualizzare i risultati.
  • Utilizzare Elimina per eliminare la voce dalla schermata Attività.
Se un evento Gerrit non riesce ad attivare una pipeline, è possibile fare clic sul pulsante Attiva manualmente e immettere il nome del trigger Gerrit e l'ID di modifica.