Tutorial: Verwenden Sie einen Konfidenztest aus der Konfidenztestsuite - AWS IoT Greengrass

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Tutorial: Verwenden Sie einen Konfidenztest aus der Konfidenztestsuite

AWS IoT Greengrass Testing Framework (GTF) und Greengrass Development Kit (GDK) bieten Entwicklern Möglichkeiten, end-to-end Tests durchzuführen. Sie können dieses Tutorial abschließen, um ein GDK-Projekt mit einer Komponente zu initialisieren, ein GDK-Projekt mit einem end-to-end Testmodul zu initialisieren und einen Zuverlässigkeitstest aus der Konfidenztestsuite zu verwenden. Nachdem Sie Ihren benutzerdefinierten Testfall erstellt haben, können Sie den Test ausführen.

Ein Zuverlässigkeitstest ist ein generischer Test, der von Greengrass bereitgestellt wird und das grundlegende Komponentenverhalten validiert. Diese Tests können an spezifischere Komponentenanforderungen angepasst oder erweitert werden.

Für dieses Tutorial verwenden wir eine - HelloWorld Komponente. Wenn Sie eine andere Komponente verwenden, ersetzen Sie die HelloWorld Komponente durch Ihre Komponente.

In diesem Tutorial führen Sie folgende Aufgaben aus:

  1. Initialisieren Sie ein GDK-Projekt mit einer Komponente.

  2. Initialisieren Sie ein GDK-Projekt mit einem - end-to-end Testmodul.

  3. Verwenden Sie einen Test aus der Konfidenztestsuite.

  4. Fügen Sie dem neuen Testfall ein Tag hinzu.

  5. Erstellen Sie das Test-JAR.

  6. Führen Sie den Test aus.

Voraussetzungen

Zum Durcharbeiten dieses Tutorials ist Folgendes erforderlich:

  • GDK Version 1.6.0 oder höher

  • Java

  • Maven

  • Git

Schritt 1: Initialisieren eines GDK-Projekts mit einer Komponente

  • Initialisieren Sie einen leeren Ordner mit einem GDK-Projekt. Laden Sie die in Python implementierte HelloWorld Komponente herunter, indem Sie den folgenden Befehl ausführen.

    gdk component init -t HelloWorld -l python -n HelloWorld

    Dieser Befehl erstellt ein neues Verzeichnis mit dem Namen HelloWorld im aktuellen Verzeichnis.

Schritt 2: Initialisieren eines GDK-Projekts mit einem end-to-end Testmodul

  • Mit GDK können Sie die Testmodulvorlage herunterladen, die aus einer Feature- und Schrittimplementierung besteht. Führen Sie den folgenden Befehl aus, um das HelloWorld Verzeichnis zu öffnen und das vorhandene GDK-Projekt mit einem Testmodul zu initialisieren.

    cd HelloWorld gdk test-e2e init

    Dieser Befehl erstellt ein neues Verzeichnis mit dem Namen gg-e2e-tests innerhalb des HelloWorld Verzeichnisses . Dieses Testverzeichnis ist ein Maven-Projekt, das von der eigenständigen Greengrass-Test-JAR abhängig ist.

Schritt 3: Verwenden eines Tests aus der Konfidenztestsuite

Das Schreiben eines Konfidenztestfalls besteht aus der Verwendung der bereitgestellten Feature-Datei und bei Bedarf der Änderung der Szenarien. Ein Beispiel für die Verwendung eines Zuverlässigkeitstests finden Sie unter Beispiel: Erstellen eines benutzerdefinierten Testfalls. Gehen Sie wie folgt vor, um einen Zuverlässigkeitstest zu verwenden:

  • Verwenden Sie die bereitgestellte Feature-Datei.

    Navigieren Sie zum gg-e2e-tests/src/main/resources/greengrass/features Ordner im aktuellen Verzeichnis. Öffnen Sie die confidenceTest.feature Beispieldatei, um den Zuverlässigkeitstest zu verwenden.

Schritt 4: Hinzufügen eines Tags zum neuen Testfall

  • Sie können den Funktionen und Szenarien Tags zuweisen, um den Testprozess zu organisieren. Sie können Tags verwenden, um die Teilmengen von Szenarien zu kategorisieren und auch Hooks bedingt für die Ausführung auszuwählen. Funktionen und Szenarien können mehrere Tags haben, die durch ein Leerzeichen getrennt sind.

    In diesem Beispiel verwenden wir die -HelloWorldKomponente.

    Jedes Szenario ist mit gekennzeichnet@ConfidenceTest. Ändern oder fügen Sie Tags hinzu, wenn Sie nur eine Teilmenge der Testsuite ausführen möchten. Jedes Testszenario wird oben in jedem Zuverlässigkeitstest beschrieben. Das Szenario besteht aus einer Reihe von Schritten, die dabei helfen, die Interaktionen und die erwarteten Ergebnisse jedes Testfalls zu verstehen. Sie können diese Tests erweitern, indem Sie Ihre eigenen Schritte hinzufügen oder die vorhandenen ändern.

    @ConfidenceTest Scenario: As a Developer, I can deploy GDK_COMPONENT_NAME to my device and see it is working as expected ....

Schritt 5: Erstellen des Test-JAR

  1. Erstellen Sie die Komponente. Sie müssen die Komponente erstellen, bevor Sie das Testmodul erstellen.

    gdk component build
  2. Erstellen Sie das Testmodul mit dem folgenden Befehl. Mit diesem Befehl wird das Test-JAR im greengrass-build Ordner erstellt.

    gdk test-e2e build

Schritt 6: Ausführen des Tests

Wenn Sie einen Zuverlässigkeitstest durchführen, automatisiert die GTF den Lebenszyklus des Tests sowie die Verwaltung von Ressourcen, die während des Tests erstellt wurden. Es stellt zunächst ein getestetes Gerät (DUT) als -AWS IoTObjekt bereit und installiert darauf die Greengrass-Core-Software. Anschließend wird eine neue Komponente mit dem Namen unter HelloWorld Verwendung des in diesem Pfad angegebenen Rezepts erstellt. Die HelloWorld Komponente wird dann über eine Greengrass-Objektbereitstellung auf dem Core-Gerät bereitgestellt. Sie wird dann überprüft, wenn die Bereitstellung erfolgreich ist. Der Bereitstellungsstatus ändert sich COMPLETED innerhalb von 3 Minuten in , wenn die Bereitstellung erfolgreich ist.

  1. Gehen Sie zur gdk-config.json Datei im Projektverzeichnis, um die Tests mit dem ConfidenceTest Tag oder dem in Schritt 4 angegebenen Tag io8u abzuzielen. Aktualisieren Sie den test-e2e Schlüssel mit dem folgenden Befehl.

    "test-e2e":{ "gtf_options" : { "tags":"ConfidenceTest" } }
  2. Bevor Sie die Tests ausführen, müssen Sie dem Host-Gerät AWS Anmeldeinformationen bereitstellen. GTF verwendet diese Anmeldeinformationen, um die AWS Ressourcen während des Testprozesses zu verwalten. Stellen Sie sicher, dass die von Ihnen bereitgestellte Rolle über Berechtigungen zur Automatisierung der erforderlichen Operationen verfügt, die im Test enthalten sind.

    Führen Sie die folgenden Befehle aus, um die AWS Anmeldeinformationen bereitzustellen.

    1. Linux or Unix
      export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
      Windows Command Prompt (CMD)
      set AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE set AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
      PowerShell
      $env:AWS_ACCESS_KEY_ID="AKIAIOSFODNN7EXAMPLE" $env:AWS_SECRET_ACCESS_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
  3. Führen Sie den Test mit dem folgenden Befehl aus.

    gdk test-e2e run

    Dieser Befehl lädt die neueste Version des Greengrass-Kerns im greengrass-build Ordner herunter und führt Tests mit diesem aus. Dieser Befehl zielt auch nur auf die Szenarien mit dem -ConfidenceTestTag ab und generiert einen Bericht für diese Szenarien. Die AWS Ressourcen, die während dieses Tests erstellt wurden, werden am Ende des Tests verworfen.

Beispiel: Verwenden eines Zuverlässigkeitstests

Das heruntergeladene Testmodul im Projekt GDK besteht aus einer bereitgestellten Feature-Datei.

Im folgenden Beispiel verwenden wir eine Feature-Datei zum Testen der Objektbereitstellungsfunktion der Greengrass-Software. Wir testen die Funktionalität dieser Funktion teilweise mit einem Szenario, das die Bereitstellung einer Komponente über die Greengrass- durchführtAWS Cloud. Dies ist eine Reihe von Schritten, die uns helfen, die Interaktionen und die erwarteten Ergebnisse dieses Anwendungsfalls zu verstehen.

  • Verwenden Sie die bereitgestellte Feature-Datei.

    Navigieren Sie zum gg-e2e-tests/src/main/resources/greengrass/features Ordner im aktuellen Verzeichnis. Sie finden das BeispielconfidenceTest.feature, das wie im folgenden Beispiel aussieht.

    Feature: Confidence Test Suite Background: Given my device is registered as a Thing And my device is running Greengrass @ConfidenceTest Scenario: As a Developer, I can deploy GDK_COMPONENT_NAME to my device and see it is working as expected When I create a Greengrass deployment with components | GDK_COMPONENT_NAME | GDK_COMPONENT_RECIPE_FILE | | aws.greengrass.Cli | LATEST | And I deploy the Greengrass deployment configuration Then the Greengrass deployment is COMPLETED on the device after 180 seconds # Update component state accordingly. Possible states: {RUNNING, FINISHED, BROKEN, STOPPING} And I verify the GDK_COMPONENT_NAME component is RUNNING using the greengrass-cli

    Jedes Testszenario wird oben in jedem Zuverlässigkeitstest beschrieben. Das Szenario besteht aus einer Reihe von Schritten, die dabei helfen, die Interaktionen und die erwarteten Ergebnisse jedes Testfalls zu verstehen. Sie können diese Tests erweitern, indem Sie Ihre eigenen Schritte hinzufügen oder die vorhandenen ändern. Jedes der Szenarien enthält Kommentare, die Ihnen helfen, diese Anpassungen vorzunehmen.