Python-Anwendungen erstellen und testen

Auf dieser Seite wird beschrieben, wie Sie Cloud Build konfigurieren, um Python-Anwendungen zu erstellen und zu testen, Ihre Artefakte in Artifact Registry hochzuladen, Informationen zur Herkunft zu generieren und Ihre Testlogs in Cloud Storage zu speichern.

Mit Cloud Build können Sie jedes öffentlich verfügbare Container-Image zur Ausführung Ihrer Aufgaben verwenden. Im öffentlichen python-Image aus Docker Hub sind die Tools python und pip vorinstalliert. Sie können Cloud Build zum Installieren von Abhängigkeiten sowie zum Erstellen und Ausführen von Einheitentests mit diesen Tools konfigurieren.

Hinweise

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

Erforderliche IAM-Berechtigungen

Eine Anleitung zum Zuweisen dieser Rollen finden Sie unter Rolle über die IAM-Seite zuweisen.

Python-Builds konfigurieren

Dieser Abschnitt enthält eine Beispiel-Build-Konfigurationsdatei für eine Python-Anwendung. Er enthält Build-Schritte, um Anforderungen zu installieren, Einheitentests hinzuzufügen und die Anwendung nach dem Bestehen der Tests zu erstellen und bereitzustellen.

  1. Erstellen Sie im Stammverzeichnis des Projekts eine Build-Konfigurationsdatei mit dem Namen cloudbuild.yaml.

  2. Anforderungen für die Installation: Beim Image python von Docker Hub ist pip vorinstalliert. Fügen Sie einen Build-Schritt mit den folgenden Feldern hinzu, um Abhängigkeiten aus pip zu installieren:

    • name: Legen Sie den Wert dieses Felds auf python oder python:<tag> fest, um das Python-Image aus Docker Hub für diese Aufgabe zu verwenden. Eine Liste der verfügbaren Tags für andere Python-Images finden Sie in der Docker Hub-Referenz zum Python-Image.
    • entrypoint: Wenn Sie dieses Feld festlegen, wird der Standardeinstiegspunkt des Image überschrieben, auf das in name verwiesen wird. Legen Sie den Wert dieses Felds auf pip fest, um pip als Einstiegspunkt für den Build-Schritt aufzurufen und pip-Befehle auszufü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. Übergeben Sie die Argumente, um den Befehl pip install in diesem Feld auszuführen. Das Flag --user im Befehl pip install sorgt dafür, dass die nachfolgenden Build-Schritte auf die in diesem Build-Schritt installierten Module zugreifen können.

    Im folgenden Build-Schritt werden Argumente für die Installationsanforderungen hinzugefügt:

     steps:
    - name: 'python'
      entrypoint: 'python'
      args: ['-m', 'pip', 'install', '--upgrade', 'pip']
    - name: python
      entrypoint: python
      args: ['-m', 'pip', 'install', 'build', 'pytest', 'Flask', '--user']

  3. Einheitentests hinzufügen: Wenn Sie in Ihrer Anwendung Einheitentests mit einem Test-Framework wie pytest definiert haben, können Sie Cloud Build so konfigurieren, dass die Tests ausgeführt werden: Fügen Sie folgende Felder in einem Build-Schritt hinzu:

    • name: Legen Sie den Wert dieses Felds auf python fest, um das Python-Image von Docker Hub für Ihre Aufgabe zu verwenden.
    • entrypoint: Legen Sie den Wert dieses Felds auf python fest, um python-Befehle auszuführen.
    • args: Fügen Sie die Argumente zum Ausführen des Befehls python pytest hinzu.

    Mit dem folgenden Build-Schritt wird die Logausgabe von pytest in einer JUnit-XML-Datei gespeichert. Der Name dieser Datei wird mit $SHORT_SHA erstellt, der Kurzversion der mit Ihrem Build verknüpften Commit-ID. Bei einem nachfolgenden Build-Schritt werden die Logs in dieser Datei in Cloud Storage gespeichert.

        - name: 'python'
      entrypoint: 'python'
      args: ['-m', 'pytest', '--junitxml=${SHORT_SHA}_test_log.xml']

  4. Build: Definieren Sie in Ihrer Build-Konfigurationsdatei den Builder und die args, um Ihre Anwendung zu erstellen:

    • name: Legen Sie den Wert dieses Felds auf python fest, um das Python-Image von Docker Hub für Ihre Aufgabe zu verwenden.
    • entrypoint: Legen Sie den Wert dieses Felds auf python fest, um python-Befehle auszuführen.
    • args: Fügen Sie die Argumente zum Ausführen des Builds hinzu.

    Der folgende Build-Schritt startet den Build:

        - name: 'python'
      entrypoint: 'python'
      args: ['-m', 'build']

  5. In Artifact Registry hochladen:

    Cloud Build generiert Supply Chain Levels for Software Artifacts (SLSA)-Builds mit Informationen zur Herkunft für eigenständige Python-Pakete, wenn Sie Artefakte mithilfe der python_packages-Felder in der Cloud Build-Konfigurationsdatei in Artifact Registry hochladen.

    Fügen Sie in Ihrer Konfigurationsdatei das Feld pythonPackages hinzu und geben Sie Ihr Python-Repository in Artifact Registry an:

        artifacts:
       pythonPackages:
       - repository: 'https://LOCATION-python.pkg.dev/PROJECT-ID/REPOSITORY'
          paths: ['dist/*']

    Ersetzen Sie die folgenden Werte:

    • PROJECT-ID ist die ID des Google Cloud-Projekts, das Ihr Artifact Registry-Repository enthält.
    • REPOSITORY ist die ID des Repositorys.
    • LOCATION ist der regionale oder multiregionale Standort für das Repository.

  6. Optional: Herkunft für regionale Builds aktivieren

    Wenn Sie einen regionalen Build verwenden, fügen Sie in der Build-Konfigurationsdatei das Feld requestedVerifyOption in options ein. Legen Sie den Wert auf VERIFIED fest, um das Generieren von Herkunftsmetadaten zu aktivieren. Wenn Sie requestedVerifyOption: VERIFIED nicht hinzufügen, generiert Cloud Build die Herkunft nur für globale Builds.

    options:
  requestedVerifyOption: VERIFIED

  7. 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:

        artifacts:
    objects:
       location: 'gs://${_BUCKET_NAME}/'
       paths:
          - '${SHORT_SHA}_test_log.xml'

  8. Build starten: manuell oder mit Build-Triggern

    Sobald der Build abgeschlossen ist, können Sie die Repository-Details in Artifact Registry ansehen.

    Sie können auch Build-Metadaten aufrufen und Herkunft prüfen, um Ihre Softwarelieferkette zu schützen.

Nächste Schritte