Tutorial: Entwickeln Sie eine einfache IDT-Testsuite - Kostenlos RTOS

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: Entwickeln Sie eine einfache IDT-Testsuite

Eine Testsuite kombiniert Folgendes:

  • Testdateien, die die Testlogik enthalten

  • Konfigurationsdateien, die die Testsuite beschreiben

Dieses Tutorial zeigt Ihnen, wie Sie IDT for FreeRTOS verwenden, um eine Python-Testsuite zu entwickeln, die einen einzigen Testfall enthält. Obwohl dieses Tutorial SSH verwendet, ist es hilfreich zu lernen, wie man es AWS IoT Device Tester mit FreeRTOS-Geräten verwendet.

In diesem Tutorial werden Sie die folgenden Schritte ausführen:

Voraussetzungen

Zum Durcharbeiten dieses Tutorials ist Folgendes erforderlich:

  • Anforderungen an den Host-Computer

    • Aktuelle Version von AWS IoT Device Tester

    • Python 3.7 oder höher

      Führen Sie den folgenden Befehl aus, um die auf Ihrem Computer installierte Version von Python zu überprüfen:

      python3 --version

      Wenn die Verwendung dieses Befehls unter Windows einen Fehler zurückgibt, verwenden Sie python --version stattdessen. Wenn die zurückgegebene Versionsnummer 3.7 oder höher ist, führen Sie den folgenden Befehl in einem Powershell-Terminal aus, um ihn python3 als Alias für Ihren python Befehl festzulegen.

      Set-Alias -Name "python3" -Value "python"

      Wenn keine Versionsinformationen zurückgegeben werden oder wenn die Versionsnummer kleiner als 3.7 ist, folgen Sie den Anweisungen unter Python herunterladen, um Python 3.7+ zu installieren. Weitere Informationen finden Sie in der Python-Dokumentation.

    • urllib3

      Führen Sie den folgenden Befehl aus, um zu überprüfen, ob die Installation korrekt urllib3 ist:

      python3 -c 'import urllib3'

      Wenn urllib3 es nicht installiert ist, führen Sie den folgenden Befehl aus, um es zu installieren:

      python3 -m pip install urllib3
  • Anforderungen an Speichergeräte

    • Ein Gerät mit einem Linux-Betriebssystem und einer Netzwerkverbindung zu demselben Netzwerk wie Ihr Host-Computer.

      Wir empfehlen Ihnen, einen Raspberry Pi mit Raspberry Pi OS zu verwenden. Stellen Sie sicher, dass Sie SSH auf Ihrem Raspberry Pi eingerichtet haben, um eine Remoteverbindung herzustellen.

Erstellen Sie ein Testsuite-Verzeichnis

IDT unterteilt Testfälle innerhalb jeder Testsuite logisch in Testgruppen. Jeder Testfall muss sich innerhalb einer Testgruppe befinden. Erstellen Sie für dieses Tutorial einen Ordner mit dem Namen MyTestSuite_1.0.0 und erstellen Sie in diesem Ordner den folgenden Verzeichnisbaum:

MyTestSuite_1.0.0 └── suite └── myTestGroup └── myTestCase

Erstellen Sie Konfigurationsdateien

Ihre Testsuite muss die folgenden erforderlichen Konfigurationsdateien enthalten:

Erforderliche Dateien

suite.json

Enthält Informationen über die Testsuite. Siehe Konfigurieren Sie suite.json.

group.json

Enthält Informationen über eine Testgruppe. Sie müssen für jede Testgruppe in Ihrer Testsuite eine group.json Datei erstellen. Siehe Konfigurieren Sie group.json.

test.json

Enthält Informationen zu einem Testfall. Sie müssen für jeden Testfall in Ihrer Testsuite eine test.json Datei erstellen. Siehe Konfigurieren Sie test.json.

  1. Erstellen Sie in dem MyTestSuite_1.0.0/suite Ordner eine suite.json Datei mit der folgenden Struktur:

    { "id": "MyTestSuite_1.0.0", "title": "My Test Suite", "details": "This is my test suite.", "userDataRequired": false }
  2. Erstellen Sie in dem MyTestSuite_1.0.0/myTestGroup Ordner eine group.json Datei mit der folgenden Struktur:

    { "id": "MyTestGroup", "title": "My Test Group", "details": "This is my test group.", "optional": false }
  3. Erstellen Sie in dem MyTestSuite_1.0.0/myTestGroup/myTestCase Ordner eine test.json Datei mit der folgenden Struktur:

    { "id": "MyTestCase", "title": "My Test Case", "details": "This is my test case.", "execution": { "timeout": 300000, "linux": { "cmd": "python3", "args": [ "myTestCase.py" ] }, "mac": { "cmd": "python3", "args": [ "myTestCase.py" ] }, "win": { "cmd": "python3", "args": [ "myTestCase.py" ] } } }

Der Verzeichnisbaum für Ihren MyTestSuite_1.0.0 Ordner sollte jetzt wie folgt aussehen:

MyTestSuite_1.0.0 └── suite ├── suite.json └── myTestGroup ├── group.json └── myTestCase └── test.json

Holen Sie sich das IDT-Client-SDK

Sie verwenden das IDT-Client-SDK, damit IDT mit dem zu testenden Gerät interagieren und Testergebnisse melden kann. Für dieses Tutorial verwenden Sie die Python-Version des SDK.

Kopieren Sie den <device-tester-extract-location>/sdks/python/ Ordner aus dem idt_client Ordner in Ihren MyTestSuite_1.0.0/suite/myTestGroup/myTestCase Ordner.

Führen Sie den folgenden Befehl aus, um zu überprüfen, ob das SDK erfolgreich kopiert wurde.

cd MyTestSuite_1.0.0/suite/myTestGroup/myTestCase python3 -c 'import idt_client'

Erstellen Sie die ausführbare Testfalldatei

Die ausführbaren Testfalldateien enthalten die Testlogik, die Sie ausführen möchten. Eine Testsuite kann mehrere ausführbare Testfalldateien enthalten. Für dieses Tutorial erstellen Sie nur eine ausführbare Testfalldatei.

  1. Erstellen Sie die Testsuite-Datei.

    Erstellen Sie in dem MyTestSuite_1.0.0/suite/myTestGroup/myTestCase Ordner eine myTestCase.py Datei mit dem folgenden Inhalt:

    from idt_client import * def main(): # Use the client SDK to communicate with IDT client = Client() if __name__ == "__main__": main()
  2. Verwenden Sie die Funktionen des Client-SDK, um Ihrer myTestCase.py Datei die folgende Testlogik hinzuzufügen:

    1. Führen Sie auf dem zu testenden Gerät einen SSH-Befehl aus.

      from idt_client import * def main(): # Use the client SDK to communicate with IDT client = Client() # Create an execute on device request exec_req = ExecuteOnDeviceRequest(ExecuteOnDeviceCommand("echo 'hello world'")) # Run the command exec_resp = client.execute_on_device(exec_req) # Print the standard output print(exec_resp.stdout) if __name__ == "__main__": main()
    2. Senden Sie das Testergebnis an IDT.

      from idt_client import * def main(): # Use the client SDK to communicate with IDT client = Client() # Create an execute on device request exec_req = ExecuteOnDeviceRequest(ExecuteOnDeviceCommand("echo 'hello world'")) # Run the command exec_resp = client.execute_on_device(exec_req) # Print the standard output print(exec_resp.stdout) # Create a send result request sr_req = SendResultRequest(TestResult(passed=True)) # Send the result client.send_result(sr_req) if __name__ == "__main__": main()

Geräteinformationen für IDT konfigurieren

Konfigurieren Sie Ihre Geräteinformationen für IDT, um den Test auszuführen. Sie müssen die device.json Vorlage im <device-tester-extract-location>/configs Ordner mit den folgenden Informationen aktualisieren.

[ { "id": "pool", "sku": "N/A", "devices": [ { "id": "<device-id>", "connectivity": { "protocol": "ssh", "ip": "<ip-address>", "port": "<port>", "auth": { "method": "pki | password", "credentials": { "user": "<user-name>", "privKeyPath": "/path/to/private/key", "password": "<password>" } } } } ] } ]

Geben Sie im devices Objekt die folgenden Informationen ein:

id

Eine benutzerdefinierte eindeutige Kennung für Ihr Gerät.

connectivity.ip

Die IP-Adresse Ihres Geräts.

connectivity.port

Optional. Die Portnummer, die für SSH-Verbindungen zu Ihrem Gerät verwendet werden soll.

connectivity.auth

Authentifizierungsinformationen für die Verbindung.

Diese Eigenschaft gilt nur, wenn connectivity.protocol auf ssh festgelegt ist.

connectivity.auth.method

Die Authentifizierungsmethode, die für den Zugriff über ein bestimmtes Verbindungsprotokoll auf ein Gerät verwendet wird.

Unterstützte Werte sind:

  • pki

  • password

connectivity.auth.credentials

Die für die Authentifizierung verwendeten Anmeldeinformationen.

connectivity.auth.credentials.user

Der Benutzername, mit dem Sie sich auf Ihrem Gerät angemeldet haben.

connectivity.auth.credentials.privKeyPath

Der vollständige Pfad zu dem privaten Schlüssel, mit dem Sie sich auf Ihrem Gerät angemeldet haben.

Dieser Wert gilt nur, wenn connectivity.auth.method auf pki festgelegt ist.

devices.connectivity.auth.credentials.password

Das Passwort, mit dem Sie sich auf Ihrem Gerät angemeldet haben.

Dieser Wert gilt nur, wenn connectivity.auth.method auf password festgelegt ist.

Anmerkung

Geben Sie privKeyPath nur an, wenn method auf pki gesetzt ist.

Geben Sie password nur an, wenn method auf password gesetzt ist.

Führen Sie die Testsuite aus

Nachdem Sie Ihre Testsuite erstellt haben, möchten Sie sicherstellen, dass sie wie erwartet funktioniert. Führen Sie dazu die folgenden Schritte aus, um die Testsuite mit Ihrem vorhandenen Gerätepool auszuführen.

  1. Kopieren Sie Ihren MyTestSuite_1.0.0 Ordner in<device-tester-extract-location>/tests.

  2. Führen Sie die folgenden Befehle aus:

    cd <device-tester-extract-location>/bin ./devicetester_[linux | mac | win_x86-64] run-suite --suite-id MyTestSuite

IDT führt Ihre Testsuite aus und streamt die Ergebnisse an die Konsole. Wenn der Test abgeschlossen ist, sehen Sie die folgenden Informationen:

time="2020-10-19T09:24:47-07:00" level=info msg=Using pool: pool time="2020-10-19T09:24:47-07:00" level=info msg=Using test suite "MyTestSuite_1.0.0" for execution time="2020-10-19T09:24:47-07:00" level=info msg=b'hello world\n' suiteId=MyTestSuite groupId=myTestGroup testCaseId=myTestCase deviceId=my-device executionId=9a52f362-1227-11eb-86c9-8c8590419f30 time="2020-10-19T09:24:47-07:00" level=info msg=All tests finished. executionId=9a52f362-1227-11eb-86c9-8c8590419f30 time="2020-10-19T09:24:48-07:00" level=info msg= ========== Test Summary ========== Execution Time: 1s Tests Completed: 1 Tests Passed: 1 Tests Failed: 0 Tests Skipped: 0 ---------------------------------- Test Groups: myTestGroup: PASSED ---------------------------------- Path to AWS IoT Device Tester Report: /path/to/devicetester/results/9a52f362-1227-11eb-86c9-8c8590419f30/awsiotdevicetester_report.xml Path to Test Execution Logs: /path/to/devicetester/results/9a52f362-1227-11eb-86c9-8c8590419f30/logs Path to Aggregated JUnit Report: /path/to/devicetester/results/9a52f362-1227-11eb-86c9-8c8590419f30/MyTestSuite_Report.xml

Fehlerbehebung

Verwenden Sie die folgenden Informationen, um Probleme beim Abschließen des Tutorials zu lösen.

Der Testfall wird nicht erfolgreich ausgeführt

Wenn der Test nicht erfolgreich ausgeführt wird, streamt IDT die Fehlerprotokolle an die Konsole, die Ihnen bei der Problembehandlung des Testlaufs helfen kann. Bevor Sie die Fehlerprotokolle überprüfen, überprüfen Sie Folgendes:

  • Das IDT-Client-SDK befindet sich im richtigen Ordner, wie in diesem Schritt beschrieben.

  • Sie erfüllen alle Voraussetzungen für dieses Tutorial.

Es kann keine Verbindung zu dem zu testenden Gerät hergestellt werden

Überprüfen Sie Folgendes:

  • Ihre device.json Datei enthält die richtige IP-Adresse, den richtigen Port und die richtigen Authentifizierungsinformationen.

  • Sie können von Ihrem Host-Computer aus eine Verbindung zu Ihrem Gerät über SSH herstellen.