Diese Seite wurde von der Cloud Translation API übersetzt.

Go-Anwendungen erstellen und testen

Auf dieser Seite wird erläutert, wie Sie mit Cloud Build Ihre Go-Anwendungen erstellen und testen, Ihre Artefakte in Artifact Registry hochladen, Herkunftsinformationen generieren und Ihre Testlogs in Cloud Storage speichern.

Hinweise

Die Anleitung auf dieser Seite setzt voraus, dass Sie mit Go vertraut sind. Außerdem gilt:

Enable the Cloud Build, Cloud Run, and Artifact Registry APIs.
Enable the APIs
Zum Ausführen der gcloud-Befehle auf dieser Seite müssen Sie die Google Cloud CLI installieren.
Halten Sie Ihr Go-Projekt bereit.
Sie haben ein Go-Repository in Artifact Registry. Wenn Sie noch keines haben, erstellen Sie ein neues Repository.
Wenn Sie Testlogs in Cloud Storage speichern möchten, erstellen Sie einen Bucket in Cloud Storage.

Dienstkonto konfigurieren

In den Beispielen in diesem Dokument wird ein vom Nutzer angegebenes Dienstkonto verwendet. Führen Sie den folgenden Befehl in der Google Cloud CLI aus, um das von Cloud Build verwendete Dienstkonto zu erstellen:

gcloud iam service-accounts create cloud-build-go \
--description="Build and test Go applications" \
--display-name="Cloud Build Go" \
--project="PROJECT_ID"

Das Compute-Standarddienstkonto (das von Cloud Run verwendet wird) benötigt die Berechtigung, als das neue Dienstkonto zu agieren. Ermitteln Sie zuerst den Namen des Compute-Dienstkontos in Ihrem Projekt:

gcloud iam service-accounts list --filter="email:-compute@developer.gserviceaccount.com"

Weisen Sie als Nächstes die Rolle Dienstkontonutzerroles/iam.serviceAccountUser () zu:

gcloud iam service-accounts add-iam-policy-binding \
COMPUTE_SERVICE_ACCOUNT_EMAIL  \
--member="serviceAccount:cloud-build-go@PROJECT_ID.iam.gserviceaccount.com" \
--role="roles/iam.serviceAccountUser"

Ersetzen Sie COMPUTE_SERVICE_ACCOUNT_EMAIL durch die E-Mail-Adresse des Standarddienstkontos für Compute, die vom vorherigen Befehl ausgegeben wurde.

IAM-Berechtigungen konfigurieren

Prüfen Sie, ob Sie die erforderlichen Berechtigungen haben:

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Cloud Build-Dienstkonto (roles/cloudbuild.builds.builder) für Ihr Build-Dienstkonto zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Ausführen von Builds in Cloud Build benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Bitten Sie Ihren Administrator, Ihnen für Ihr Build-Dienstkonto die IAM-Rolle Artifact Registry Writer (roles/artifactregistry.writer) zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Speichern erstellter Artefakte in Artifact Registry benötigen.

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Storage Object Creator (roles/storage.objectCreator) für Ihr Build-Dienstkonto zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Speichern von Testlogs in Logging benötigen.

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Cloud Run-Entwickler (roles/run.developer) für Ihr Build-Dienstkonto zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Bereitstellen der Anwendung in Cloud Run benötigen.

Go-Builds konfigurieren

Das öffentliche golang-Image aus Docker Hub unterstützt das Erstellen mithilfe von Go-Modulen. Wenn Sie dieses Image als Build-Schritt in Ihrer Cloud Build-Konfigurationsdatei verwenden, können Sie im Image go-Befehle aufrufen. Argumente, die an diesen Build-Schritt übergeben werden, werden direkt an das golang-Tool weitergegeben, sodass Sie in diesem Image alle go-Befehle ausführen können.

In diesem Abschnitt wird gezeigt, wie Sie eine Beispiel-Build-Konfigurationsdatei für eine Go-Anwendung aus dem Git-Repository cloud-build-samples erstellen. Die Build-Konfigurationsdatei enthält Schritte zum Erstellen der App, zum Hinzufügen von Einheitentests und zum Bereitstellen der App, nachdem die Tests bestanden wurden.

So erstellen Sie die Beispiel-Go-Anwendung:

Einheitentests konfigurieren: Wenn Sie in Ihrer Anwendung Einheitentests definiert haben, können Sie Cloud Build so konfigurieren, dass die Tests ausgeführt werden. Fügen Sie dazu die folgenden Felder in einem Build-Schritt hinzu:
- name: Legen Sie den Wert dieses Felds auf golang fest, um das Golang-Image von Docker Hub für Ihre Aufgabe zu verwenden.
- entrypoint: Legen Sie den Wert dieses Felds auf /bin/bash fest. Auf diese Weise können Sie mehrzeilige Bash-Befehle direkt aus dem Build-Schritt ausführen.
- args: Im Feld args eines Build-Schritts wird eine Liste von Argumenten abgerufen und an das Image übergeben, auf das im Feld name verwiesen wird. Im folgenden Beispiel verwendet das Feld args die Argumente für:
  - Ausführen des Testlog-Formatierers zum Herunterladen der Testlogausgabe.
  - Ausgeben der Logausgabe.
  - Speichern der Testergebnisse in sponge.log.
  - Ausgabe der Ergebnisse in sponge.log in eine JUnit-XML-Datei Der Name der JUnit-XML-Datei wird mit der kurzen Version der Commit-ID erstellt, die Ihrem Build zugeordnet ist. Bei einem nachfolgenden Build-Schritt werden die Logs in dieser Datei in Cloud Storage gespeichert.
```
steps:
  # Run tests and save to file
  - name: golang:1.23
    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
```
In Artifact Registry hochladen: Geben Sie in Ihrer Konfigurationsdatei mit dem Feld goModules den Anwendungspfad und Ihr Go-Repository in Artifact Registry an:
```
# Upload Go module to artifact registry
artifacts:
  goModules:
    repositoryName: 'repositoryName'
    repositoryLocation: 'location'
    repositoryProjectId: 'projectId'
    sourcePath: 'sourcePath'
    modulePath: 'appPath'
    moduleVersion: 'version'
```
Ersetzen Sie die folgenden Werte:
- repositoryName: der Name Ihres Go-Repositorys in Artifact Registry.
- location: der Speicherort für Ihr Repository in Artifact Registry.
- projectId: die ID des Google Cloud Projekts, das Ihr Artifact Registry-Repository enthält.
- sourcePath: der Pfad zur go.mod-Datei im Arbeitsbereich des Builds.
- appPath: der Pfad zu Ihrer verpackten Anwendung.
- version: Die Versionsnummer Ihrer Anwendung, formatiert in Zahlen und Punkten wie v1.0.1.
Optional: Provenienzgenerierung aktivieren

Cloud Build kann überprüfbare Supply Chain Levels for Software Artifacts (SLSA)-Build-Herkunftsmetadaten generieren, um Ihre Continuous Integration-Pipeline zu schützen.

Fügen Sie requestedVerifyOption: VERIFIED dem Abschnitt options in Ihrer Konfigurationsdatei hinzu, um die Generierung von Herkunftsnachweisen zu aktivieren.

Nach Abschluss des Builds können Sie Repository-Details in Artifact Registry aufrufen.

Sie können auch Metadaten zur Build-Herkunft ansehen und die Herkunft validieren.

Testlogs in Cloud Storage speichern: Sie können Cloud Build so konfigurieren, dass alle Testlogs in Cloud Storage gespeichert werden. Geben Sie dazu einen vorhandenen Bucket-Speicherort und einen Pfad zu den Testlogs an.

Mit dem folgenden Build-Schritt werden die Testlogs, die Sie in der JUNIT-XML-Datei gespeichert haben, in einem Cloud Storage-Bucket gespeichert:

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

Das folgende Snippet zeigt die vollständige Build-Konfigurationsdatei für die vorherigen Schritte:

  steps:
    # Run tests and save to file
    - name: golang:1.23
      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

  # Store golang modules in Google Artifact Registry
  artifacts:
    goModules:
      repositoryName: 'repositoryName'
      repositoryLocation: 'location'
      repositoryProject_id: 'projectId'
      sourcePath: 'sourcePath'
      modulePath: 'appPath'
      moduleVersion: 'version'

Starten Sie den Build mit der gcloud CLI oder erstellen Sie einen Build-Trigger:

Google Cloud CLI

 gcloud builds submit --region=us-west2 --config=cloudbuild.yaml \
     --substitutions=_AR_REPO_NAME="AR_REPO_NAME"

Build-Trigger

Folgen Sie der Anleitung unter Build-Trigger erstellen. Im Feld Substitutionsvariablen müssen Sie auch den Namen Ihres Artifact Registry-Repositorys und den Namen Ihres Cloud Storage-Bucket für Testlogs angeben.

Go-Anwendungen erstellen und testen Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.