Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà. # Tutorial: Sviluppa una semplice suite di test IDT Una suite di test combina quanto segue: + Eseguibili di test che contengono la logica di test + File di configurazione che descrivono la suite di test Questo tutorial mostra come usare IDT per AWS IoT Greengrass sviluppare una suite di test Python che contenga un singolo test case. In questo tutorial, completerai i seguenti passaggi: 1. [Crea una directory per la suite di test](#test-suite-dir) 1. [Crea file di configurazione](#test-suite-json) 1. [Crea l'eseguibile del test case](#test-suite-exe) 1. [Esegui la suite di test](#run-test-suite) ## Prerequisiti Per completare questo tutorial, è necessario quanto segue: + **Requisiti del computer host** + Versione più recente di AWS IoT Device Tester + [Python 3.7](https://www.python.org/downloads/) o successivo Per verificare la versione di Python installata sul tuo computer, esegui il seguente comando: ``` python3 --version ``` In Windows, se l'utilizzo di questo comando restituisce un errore, usalo `python --version` invece. Se il numero di versione restituito è 3.7 o superiore, esegui il comando seguente in un terminale Powershell da impostare `python3` come alias per il comando. `python` ``` Set-Alias -Name "python3" -Value "python" ``` Se non viene restituita alcuna informazione sulla versione o se il numero di versione è inferiore a 3.7, segui le istruzioni in [Downloading Python per installare Python](https://wiki.python.org/moin/BeginnersGuide/Download) 3.7\$1. Per ulteriori informazioni, consulta la documentazione di [Python](https://docs.python.org). + [urllib3](https://urllib3.readthedocs.io/en/latest/) Per verificare che `urllib3` sia installato correttamente, esegui il seguente comando: ``` python3 -c 'import urllib3' ``` Se non `urllib3` è installato, esegui il seguente comando per installarlo: ``` python3 -m pip install urllib3 ``` + **Requisiti per il dispositivo** + Un dispositivo con un sistema operativo Linux e una connessione di rete alla stessa rete del computer host. Ti consigliamo di utilizzare un [Raspberry Pi](https://www.raspberrypi.org/) con sistema operativo Raspberry Pi. Assicurati di aver configurato [SSH](https://www.raspberrypi.org/documentation/remote-access/ssh/) sul tuo Raspberry Pi per connetterti in remoto ad esso. ## Crea una directory per la suite di test IDT separa logicamente i casi di test in gruppi di test all'interno di ciascuna suite di test. Ogni test case deve essere all'interno di un gruppo di test. Per questo tutorial, crea una cartella chiamata `MyTestSuite_1.0.0` e crea il seguente albero di directory all'interno di questa cartella: ``` MyTestSuite_1.0.0 └── suite └── myTestGroup └── myTestCase ``` ## Crea file di configurazione La tua suite di test deve contenere i seguenti [file di configurazione](idt-json-config.md) richiesti:File di configurazione richiesti `suite.json` Contiene informazioni sulla suite di test. Per informazioni, consulta [Configura suite.json](idt-json-config.md#suite-json). `group.json` Contiene informazioni su un gruppo di test. È necessario creare un `group.json` file per ogni gruppo di test nella suite di test. Per informazioni, consulta [Configura group.json](idt-json-config.md#group-json). `test.json` Contiene informazioni su un test case. È necessario creare un `test.json` file per ogni test case nella suite di test. Per informazioni, consulta [Configura test.json](idt-json-config.md#test-json). 1. Nella `MyTestSuite_1.0.0/suite` cartella, create un `suite.json` file con la seguente struttura: ``` { "id": "MyTestSuite_1.0.0", "title": "My Test Suite", "details": "This is my test suite.", "userDataRequired": false } ``` 1. Nella `MyTestSuite_1.0.0/myTestGroup` cartella, create un `group.json` file con la seguente struttura: ``` { "id": "MyTestGroup", "title": "My Test Group", "details": "This is my test group.", "optional": false } ``` 1. Nella `MyTestSuite_1.0.0/myTestGroup/myTestCase` cartella, create un `test.json` file con la seguente struttura: ``` { "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" ] } } } ``` L'albero delle cartelle della `MyTestSuite_1.0.0` cartella dovrebbe ora avere il seguente aspetto: ``` MyTestSuite_1.0.0 └── suite ├── suite.json └── myTestGroup ├── group.json └── myTestCase └── test.json ``` ## Scarica l'SDK del client IDT Utilizzi l'[SDK del client IDT](create-test-executables.md#idt-client-sdk) per consentire a IDT di interagire con il dispositivo sottoposto a test e di riportare i risultati del test. Per questo tutorial, utilizzerai la versione Python dell'SDK. Dalla `/sdks/python/` cartella, copia la `idt_client` cartella nella tua `MyTestSuite_1.0.0/suite/myTestGroup/myTestCase` cartella. Per verificare che l'SDK sia stato copiato correttamente, esegui il comando seguente. ``` cd MyTestSuite_1.0.0/suite/myTestGroup/myTestCase python3 -c 'import idt_client' ``` ## Crea l'eseguibile del test case Gli eseguibili del test case contengono la logica di test che si desidera eseguire. Una suite di test può contenere più eseguibili di test case. Per questo tutorial, creerai un solo eseguibile di test case. 1. Crea il file della suite di test. Nella `MyTestSuite_1.0.0/suite/myTestGroup/myTestCase` cartella, crea un `myTestCase.py` file con il seguente contenuto: ``` from idt_client import * def main(): # Use the client SDK to communicate with IDT client = Client() if __name__ == "__main__": main() ``` 1. Utilizza le funzioni dell'SDK del client per aggiungere la seguente logica di test al tuo `myTestCase.py` file: 1. Esegui un comando SSH sul dispositivo sottoposto a test. ``` 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() ``` 1. Invia il risultato del test a 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() ``` ## Configura le informazioni sul dispositivo per IDT Configura le informazioni sul dispositivo per consentire a IDT di eseguire il test. È necessario aggiornare il `device.json` modello che si trova nella `/configs` cartella con le seguenti informazioni. ``` [ { "id": "pool", "sku": "N/A", "devices": [ { "id": "", "connectivity": { "protocol": "ssh", "ip": "", "port": "", "auth": { "method": "pki | password", "credentials": { "user": "", "privKeyPath": "/path/to/private/key", "password": "" } } } } ] } ] ``` Nell'`devices`oggetto, fornite le seguenti informazioni: `id` Un identificatore univoco definito dall'utente per il dispositivo. `connectivity.ip` L'indirizzo IP del dispositivo. `connectivity.port` Opzionale. Il numero di porta da utilizzare per le connessioni SSH al dispositivo. `connectivity.auth` Informazioni di autenticazione per la connessione. Questa proprietà si applica solo se `connectivity.protocol` è impostata su `ssh`. `connectivity.auth.method` Il metodo di autorizzazione utilizzato per accedere a un dispositivo con un determinato protocollo di connettività. I valori supportati sono: + `pki` + `password` `connectivity.auth.credentials` Le credenziali utilizzate per l'autenticazione. `connectivity.auth.credentials.user` Il nome utente utilizzato per accedere al dispositivo. `connectivity.auth.credentials.privKeyPath` Il percorso completo della chiave privata utilizzata per accedere al dispositivo. Questo valore si applica solo se `connectivity.auth.method` è impostato su `pki`. `devices.connectivity.auth.credentials.password` La password utilizzata per accedere al dispositivo. Questo valore si applica solo se `connectivity.auth.method` è impostato su `password`. **Nota** Specificare `privKeyPath` solo se `method` è impostato su `pki`. Specificare `password` solo se `method` è impostato su `password`. ## Esegui la suite di test Dopo aver creato la suite di test, devi assicurarti che funzioni come previsto. Completa i seguenti passaggi per eseguire la suite di test con il pool di dispositivi esistente a tale scopo. 1. Copia la `MyTestSuite_1.0.0` cartella in`/tests`. 1. Esegui i comandi seguenti: ``` cd /bin ./devicetester_[linux | mac | win_x86-64] run-suite --suite-id MyTestSuite ``` IDT esegue la tua suite di test e trasmette i risultati alla console. Al termine dell'esecuzione del test, vengono visualizzate le seguenti informazioni: ``` 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 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 ``` ## Risoluzione dei problemi Utilizza le seguenti informazioni per risolvere eventuali problemi relativi al completamento del tutorial. **Il test case non viene eseguito correttamente** Se il test non viene eseguito correttamente, IDT trasmette i log degli errori alla console per aiutarti a risolvere i problemi relativi all'esecuzione del test. Prima di controllare i log degli errori, verifica quanto segue: + [L'SDK del client IDT si trova nella cartella corretta, come descritto in questo passaggio.](#add-idt-sdk) + Soddisfi tutti i [prerequisiti](#prereqs-tutorial-custom) per questo tutorial. **Impossibile connettersi al dispositivo in prova** Verificare quanto segue: + Il `device.json` file contiene l'indirizzo IP, la porta e le informazioni di autenticazione corretti. + Puoi connetterti al tuo dispositivo tramite SSH dal tuo computer host.