Crea e testa le applicazioni Go

Questa pagina spiega come utilizzare Cloud Build per creare, testare ed eseguire il deployment di applicazioni Go.

Prima di iniziare

Le istruzioni in questa pagina presuppongono che tu abbia familiarità con Go. Inoltre:

  • Abilita le API Cloud Build, Cloud Run, and Artifact Registry.

    Abilita le API

  • Per eseguire i comandi gcloud in questa pagina, installa Google Cloud CLI.
  • Tieni a portata di mano il tuo progetto Go.
  • Se vuoi containerizzare la tua app Go con Cloud Build, avrai bisogno di un Dockerfile insieme al codice sorgente.
  • Se vuoi archiviare il container creato in Artifact Registry, crea un repository Docker in Artifact Registry.
  • Se vuoi archiviare i log di test in Cloud Storage, crea un bucket in Cloud Storage.

Autorizzazioni IAM richieste

Per istruzioni sulla concessione di questi ruoli, consulta Concessione di un ruolo utilizzando la pagina IAM.

Configurazione delle build Go

L'immagine golang pubblica di Docker Hub supporta la creazione utilizzando moduli Go. L'utilizzo di questa immagine come passaggio di build nel file di configurazione di Cloud Build ti consente di richiamare i comandi go all'interno dell'immagine. Gli argomenti passati a questo passaggio di build vengono passati direttamente allo strumento golang, consentendoti di eseguire qualsiasi comando go in questa immagine.

Questa sezione illustra un esempio di file di configurazione della build per un'app Go. Include i passaggi per creare l'app, aggiungere test delle unità e, una volta superati i test, containerizzare ed eseguire il deployment dell'app.

Per creare la tua applicazione Go:

  1. Nella directory root del progetto, crea un file di configurazione di Cloud Build denominato cloudbuild.yaml.

  2. Crea e testa: se hai definito i test delle unità nella tua applicazione, puoi configurare Cloud Build per eseguire i test aggiungendo i seguenti campi in un passaggio di build:

    • name: imposta il valore di questo campo su golang per utilizzare l'immagine golang di Docker Hub per la tua attività.
    • entrypoint: imposta il valore di questo campo su /bin/bash. Ciò consente di eseguire comandi bash multilinea direttamente dal passaggio di build.
    • args: il campo args di un passaggio di build accetta un elenco di argomenti e li passa all'immagine a cui fa riferimento il campo name. Nell'esempio seguente, il campo args accetta gli argomenti per:

      • Esecuzione del formattatore di log di test per scaricare l'output dei log di test.
      • Stampa dell'output log.
      • Salvataggio dei risultati del test in sponge.log in corso...
      • Output dei risultati in sponge.log in un file XML JUNIT. Il nome del file XML JUNIT viene creato utilizzando la versione breve dell'ID commit associato alla build. Un passaggio di build successivo salverà i log in questo file in Cloud Storage.
      steps:
        # Run tests and save to file
        - name: golang:1.21
          entrypoint: /bin/bash
          args:
            - -c
            - |
              go install github.com/jstemmer/go-junit-report/v2@latest
              2>&1 go test -timeout 1m -v ./... | /go/bin/go-junit-report -set-exit-code -iocopy -out ${SHORT_SHA}_test_log.xml
  3. Containerizzare l'app: dopo aver aggiunto il passaggio di build per assicurarti che i test siano stati superati, puoi creare l'applicazione. Cloud Build fornisce un'immagine Docker predefinita che puoi utilizzare per containerizzare la tua applicazione Go. Per containerizzare la tua app, aggiungi i seguenti campi in un passaggio di build:

    • name: imposta il valore di questo campo su gcr.io/cloud-builders/docker per utilizzare l'immagine Docker predefinita per l'attività.
    • args: aggiungi gli argomenti per il comando docker build come valori per questo campo.

    Il seguente passaggio di build crea l'immagine myimage e la tagga con la versione breve del tuo ID commit. Il passaggio di build utilizza sostituzioni per ID progetto, nome repository e valori SHA brevi, pertanto questi valori vengono sostituiti automaticamente al momento della build. Tieni presente che dovrai creare o disporre di un repository Docker in Artifact Registry per archiviare l'immagine.

    # Docker Build
    - name: 'gcr.io/cloud-builders/docker'
      args: ['build', '-t',
             'us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA', '.']
  4. Esegui il push del container in Artifact Registry: puoi archiviare il container creato in Artifact Registry, che è un servizio Google Cloud che puoi utilizzare per archiviare, gestire e proteggere gli artefatti delle build. Per farlo, devi disporre di un repository Docker esistente in Artifact Registry. Per configurare Cloud Build in modo da archiviare l'immagine in un repository Docker in Artifact Registry, aggiungi un passaggio di build con i seguenti campi:

    • name: imposta il valore di questo campo su gcr.io/cloud-builders/docker per utilizzare l'immagine ufficiale dello strumento di creazione docker per la tua attività.
    • args: aggiungi gli argomenti per il comando docker push come valori di questo campo. Per l'URL di destinazione, inserisci il repository Docker di Artifact Registry in cui vuoi archiviare l'immagine.

    Il seguente passaggio di build esegue il push dell'immagine che hai creato nel passaggio precedente ad Artifact Registry:

    # Docker push to Google Artifact Registry
    - name: 'gcr.io/cloud-builders/docker'
      args: ['push', 'us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA']
  5. Esegui il deployment del container in Cloud Run: per eseguire il deployment dell'immagine su Cloud Run, aggiungi un passaggio di build con i seguenti campi:

    • name: imposta il valore di questo campo su google/cloud-sdk per utilizzare l'immagine gcloud CLI per richiamare il comando gcloud ed eseguire il deployment dell'immagine su Cloud Run.
    • args: aggiungi gli argomenti per il comando gcloud run deploy come valori di questo campo.

    Il seguente passaggio di build esegue il deployment dell'immagine creata in precedenza in Cloud Run:

    # Deploy to Cloud Run
    - name: 'gcr.io/cloud-builders/gcloud'
      args: ['run', 'deploy', 'helloworld-${SHORT_SHA}',
             '--image=us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA',
             '--region', 'us-central1', '--platform', 'managed']
  6. Salva i log di test in Cloud Storage: puoi configurare Cloud Build in modo da archiviare qualsiasi log di test in Cloud Storage specificando la posizione di un bucket e il percorso esistenti per i log di test.

    Il seguente passaggio di build archivia i log di test salvati nel file XML JUNIT in un bucket Cloud Storage:

    # Save test logs to Google Cloud Storage
    artifacts:
      objects:
        location: gs://$_BUCKET_NAME/
        paths:
          - ${SHORT_SHA}_test_log.xml

    Lo snippet seguente mostra il file di configurazione della build completo per tutti i passaggi descritti in precedenza:

    steps:
      # Run tests and save to file
      - name: golang:1.21
        entrypoint: /bin/bash
        args:
          - -c
          - |
            go install github.com/jstemmer/go-junit-report/v2@latest
            2>&1 go test -timeout 1m -v ./... | /go/bin/go-junit-report -set-exit-code -iocopy -out ${SHORT_SHA}_test_log.xml
    
      # Docker Build
      - name: 'gcr.io/cloud-builders/docker'
        args: ['build', '-t',
               'us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA', '.']
    
      # Docker push to Google Artifact Registry
      - name: 'gcr.io/cloud-builders/docker'
        args: ['push', 'us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA']
    
      # Deploy to Cloud Run
      - name: 'gcr.io/cloud-builders/gcloud'
        args: ['run', 'deploy', 'helloworld-${SHORT_SHA}',
               '--image=us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA',
               '--region', 'us-central1', '--platform', 'managed']
    
    # Save test logs to Google Cloud Storage
    artifacts:
      objects:
        location: gs://$_BUCKET_NAME/
        paths:
          - ${SHORT_SHA}_test_log.xml
    # Store images in Google Artifact Registry
    images:
      - us-central1-docker.pkg.dev/$PROJECT_ID/$_REPO_NAME/myimage:$SHORT_SHA
  7. Avvia la build utilizzando gcloud CLI o i trigger di build. Devi specificare il nome del repository Artifact Registry all'avvio della build.

    Per specificare il repository Artifact Registry durante l'avvio della build utilizzando gcloud CLI:

    gcloud builds submit --region=us-west2 --config=cloudbuild.yaml \
        --substitutions=_REPO_NAME="REPO_NAME"
    

    Sostituisci REPO_NAME con il nome del tuo repository Artifact Registry.

    Per specificare il repository Artifact Registry durante la creazione con trigger di build, specifica il nome del repository Artifact Registry nel campo Variabili di sostituzione durante la creazione del trigger di build.

Passaggi successivi