User Manual

awaBerry | Testen: MethodeTest

Testen Sie einzelne MCP-Methoden auf dem awaBerry-Server – verifizieren Sie, dass jedes bereitgestellte Werkzeug korrekt auf Methodenaufrufe mit erwarteten...

Testen: methodtest

Zusammenfassung

Dieses Dokument beschreibt die technischen Verfahren zur Ausführung lokaler Integrationstests für die Methoden connectToDevice und executeCommand unter Verwendung des awaBerry Connect Agenten. Es behandelt wesentliche Voraussetzungen wie die Installation von awaBerry Connect und die Einrichtung eines Kontos, die Konfiguration der Umgebung über eine .env-Datei für Projekt-Anmeldedaten und Gerätedetails sowie Schritte zur Installation von Abhängigkeiten. Detaillierte Anweisungen werden für das Testen der Gerätekonnektivität, die Ausführung beliebiger Befehle und die Verwaltung langlaufender Befehle durch Abfragen zusätzlicher Ergebnisse bereitgestellt, um eine robuste Validierung der Kernfunktionalitäten des Agenten zu gewährleisten.

Beschreibung

Diese Anleitung erklärt, wie die lokalen Methodentests für connectToDevice und executeCommand ausgeführt werden.

Voraussetzungen

Stellen Sie vor der Ausführung der Tests sicher, dass Sie Folgendes haben:

  • awaBerry Connect Installiert: Der awaBerry Connect Agent muss auf dem Gerät installiert sein, mit dem Sie eine Verbindung herstellen möchten. Sie können ihn unter download.awaberry.com herunterladen.
  • awaBerry Remote Konto: Sie benötigen ein Konto unter app.awaberry.com mit webbasiertem Zugriff auf Ihr Gerät.
  • awaBerry Agentic Projekt: Sie müssen ein Projekt im Abschnitt "awaBerry Agentic" der App erstellt haben. Aus diesem Projekt benötigen Sie Ihren <projectKey> und <projectSecret>.

Konfiguration

  1. Erstellen Sie die .env-Datei:
    Erstellen Sie im Stammverzeichnis dieses Projekts eine Datei namens .env.
  2. Fügen Sie Anmeldedaten hinzu:
    Fügen Sie den folgenden Inhalt zur .env-Datei hinzu und ersetzen Sie die Platzhalterwerte durch Ihre tatsächlichen Projekt-Anmeldedaten und den Gerätenamen:
    projectKey=your_project_key
    projectSecret=your_project_secret
    deviceName=your_device_name
    
  3. Installieren Sie Abhängigkeiten:
    Öffnen Sie Ihr Terminal im Stammverzeichnis des Projekts und führen Sie aus:
    npm install
    

Ausführen der Tests

Führen Sie die Testdateien vom Stammverzeichnis Ihres Projekts aus.

1. Testen der Geräteverbindung

Dieser Test versucht, eine Verbindung zu Ihrem angegebenen Gerät herzustellen.

Die Datei testConnectToDevice.js liest die Verbindungsinformationen aus einer .env-Datei im Projektstammverzeichnis und verwendet diese, um die Funktion connectToDevice aufzurufen. Nach erfolgreicher Verbindung aktualisiert sie die .env-Datei mit dem erhaltenen sessionToken und deviceuuid.

Um diesen Test auszuführen:

node test/methodtest/testConnectToDevice.js

Erwartetes Ende der Testausgabe:

✅ Method execution was succesful

2. Testen der Befehlsausführung

Wenn der Verbindungstest erfolgreich ist, können Sie diesen Befehl verwenden, um einen Testbefehl auf dem verbundenen Gerät auszuführen.

Die Datei testExecuteCommand.js liest sessionToken und deviceuuid aus einer .env-Datei, fordert den Benutzer über die Konsole zu einem Befehl auf und ruft dann die Funktion executeCommand auf. Stellen Sie sicher, dass diese Werte gesetzt sind, typischerweise nach einem erfolgreichen Verbindungstest.

Um diesen Test auszuführen:

node test/methodtest/testExecuteCommand.js

Geben Sie einen einfachen Befehl wie 'date' oder 'ls' ein, um die Befehlsausführung zu testen. Bei Erfolg wird das JSON-Ergebnis des Befehls ausgegeben, endend mit:

✅ Method execution was succesful

3. Testen zusätzlicher Befehlsergebnisse (langlaufende Befehle)

Dieser Test ist darauf ausgelegt, langlaufende Befehle zu verarbeiten, indem ein Befehl ausgeführt und dann kontinuierlich auf zusätzliche Ergebnisse abgefragt wird, bis der Befehl im Terminal abgeschlossen ist oder der Benutzer ihn explizit beendet. Er bietet auch die Möglichkeit, einen 'Stop-Befehl' zu senden, falls der ursprüngliche Befehl noch läuft, wenn der Benutzer beenden möchte.

Die Datei testGetAdditionalCommandResults.js erfordert, dass sessionToken und deviceuuid in Ihrer .env-Datei gesetzt sind, ähnlich wie beim Befehlsausführungstest.

Um diesen Test auszuführen:

node test/methodtest/testGetAdditionalCommandResults.js

Während der Ausführung können Sie 'q' drücken, um die Abfrageschleife zu beenden, und optional einen Stoppbefehl senden.

Fehlerbehebung

  • Fehlende oder ungültige Eingaben:
    Überprüfen Sie die angegebenen Werte für projectKey und projectSecret und versuchen Sie es erneut.
  • Gerät mit dem Namen '...' nicht gefunden:
    Stellen Sie sicher, dass der deviceName in Ihrer .env-Datei mit einem aktiven Gerät übereinstimmt, das Ihrem awaBerry Agentic Projekt zugeordnet ist.

Support

Für Dokumentation und Fragen: