Pré-requisitos Crie um diretório de pacotes de teste Crie arquivos de configuração Obtenha o SDK do cliente do IDT Crie o executável do caso de teste Configurar as informações do dispositivo para o IDT Execute o pacote de teste Solução de problemas

Tutorial: desenvolva um pacote de teste simples do IDT

Um pacote de teste combina o seguinte:

Executáveis de teste que contêm a lógica de teste
Arquivos de configuração que descrevem o pacote de teste

Este tutorial mostra como usar o IDT para FreeRTOS para desenvolver um pacote de teste em Python contendo um caso de teste único. Embora este tutorial use SSH, é útil aprender a usar AWS IoT Device Tester com dispositivos FreeRTOS.

Neste tutorial, você concluirá as seguintes etapas:

Crie um diretório de pacotes de teste
Crie arquivos de configuração
Crie o executável do caso de teste
Execute o pacote de teste

Pré-requisitos

Para concluir este tutorial, você precisará do seguinte:

Requisitos do computador host
- Versão mais recente do AWS IoT Device Tester
- Python 3.7 ou posterior
  
  Para verificar a versão do Python instalada em seu computador, execute o seguinte comando:
```
python3 --version
```
  No Windows, se o uso deste comando retornar um erro, use python --version. Se o número da versão retornada for 3.7 ou superior, execute o seguinte comando em um terminal do Powershell para definir python3 como um alias para seu comando python.
```
Set-Alias -Name "python3" -Value "python"
```
  Se nenhuma informação sobre versão for retornada ou se o número da versão for menor do que 3.7, siga as instruções em Fazer download do Python para instalar o Python 3.7+. Para obter mais informações, consulte a Documentação do Python.
- urllib3
  
  Para verificar se urllib3 está instalado corretamente, execute o seguinte comando:
```
python3 -c 'import urllib3'
```
  Se o urllib3 não estiver instalado, execute o comando a seguir para instalá-lo:
```
python3 -m pip install urllib3
```
Requisitos do dispositivo
- Um dispositivo com sistema operacional Linux e uma conexão de rede com a mesma rede do seu computador host.
  
  É recomendado o uso de um Raspberry Pi com o sistema operacional Raspberry Pi. Certifique-se de configurar o SSH no seu Raspberry Pi para se conectar remotamente a ele.

Crie um diretório de pacotes de teste

O IDT separa logicamente os casos de teste em grupos de teste dentro de cada pacote de teste. Cada caso de teste deve estar dentro de um grupo de teste. Para este tutorial, crie uma pasta chamada MyTestSuite_1.0.0 e crie a seguinte árvore de diretórios nesta pasta:


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

Crie arquivos de configuração

Seu pacote de teste deve conter os seguintes arquivos de configuração necessários:

Arquivos necessários

suite.json: Contém informações sobre o pacote de teste. Consulte Configurar suite.json.
group.json: Contém informações sobre um grupo de teste. É preciso criar um arquivo group.json para cada grupo de teste em seu pacote de teste. Consulte Configurar group.json.
test.json: Contém informações sobre um caso de teste. É preciso criar um arquivo test.json para cada caso de teste em seu pacote de teste. Consulte Configurar test.json.

Na pasta MyTestSuite_1.0.0/suite, crie um arquivo suite.json com a seguinte estrutura:


{
    "id": "MyTestSuite_1.0.0",
    "title": "My Test Suite",
    "details": "This is my test suite.",
    "userDataRequired": false
}

Na pasta MyTestSuite_1.0.0/myTestGroup, crie um arquivo group.json com a seguinte estrutura:


{
    "id": "MyTestGroup",
    "title": "My Test Group",
    "details": "This is my test group.",
    "optional": false
}

Na pasta MyTestSuite_1.0.0/myTestGroup/myTestCase, crie um arquivo test.json com a seguinte estrutura:


{
    "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"
            ]
        }
    }
}

Agora, a árvore de diretórios da pasta MyTestSuite_1.0.0 deve ser semelhante à seguinte:


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

Obtenha o SDK do cliente do IDT

Use o SDK de cliente do IDT para permitir que o IDT interaja com o dispositivo testado e relate os resultados do teste. Neste tutorial, use a versão em Python do SDK.

Na pasta <device-tester-extract-location>/sdks/python/, copie a pasta idt_client para sua pasta MyTestSuite_1.0.0/suite/myTestGroup/myTestCase.

Para verificar se o SDK foi copiado com êxito, execute o comando a seguir.


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

Crie o executável do caso de teste

Os executáveis do caso de teste contêm a lógica de teste que você deseja executar. Um pacote de teste pode conter vários executáveis de casos de teste. Para este tutorial, crie somente um executável de caso de teste.

Crie o arquivo do pacote de teste.

Na pasta MyTestSuite_1.0.0/suite/myTestGroup/myTestCase, crie um arquivo myTestCase.py com o seguinte conteúdo:


from idt_client import *

def main():
    # Use the client SDK to communicate with IDT
    client = Client()

if __name__ == "__main__":
    main()

Use as funções do SDK de cliente para adicionar a seguinte lógica de teste ao seu arquivo myTestCase.py:

Execute um comando SSH no dispositivo em teste.


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()

Envie o resultado do teste para o 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()

Configurar as informações do dispositivo para o IDT

Configure as informações do seu dispositivo para o IDT executar o teste. É preciso atualizar o modelo device.json localizado na pasta <device-tester-extract-location>/configs com as informações a seguir.


[
  {
    "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>"
            }
          }
        }
      }
    ]
  }
]

No objeto devices, forneça as seguintes informações:

id

Um identificador exclusivo, definido pelo usuário, para o seu dispositivo.

connectivity.ip

O endereço IP do seu dispositivo.

connectivity.port

Opcional. O número da porta que deve ser usado nas conexões SSH ao seu dispositivo.

connectivity.auth

Informações de autenticação da conexão.

Essa propriedade será aplicada somente se connectivity.protocol estiver definido como ssh.

connectivity.auth.method

O método de autenticação usado para acessar um dispositivo pelo protocolo de conectividade indicado.

Os valores compatíveis são:

pki
password

connectivity.auth.credentials

As credenciais usadas para autenticação.

connectivity.auth.credentials.user

O nome de usuário usado para fazer login no seu dispositivo.

connectivity.auth.credentials.privKeyPath

O caminho completo para a chave privada usada para fazer login no dispositivo.

Esse valor se aplica somente se connectivity.auth.method estiver definido como pki.

devices.connectivity.auth.credentials.password

A senha usada para fazer login no dispositivo.

Esse valor se aplica somente se connectivity.auth.method estiver definido como password.

nota

Especifique privKeyPath somente se method estiver definido como pki.

Especifique password somente se method estiver definido como password.

Execute o pacote de teste

Depois de criar o pacote de teste, verifique se ele funciona conforme o esperado. Conclua as etapas a seguir para executar o pacote de teste em seu grupo de dispositivos existente.

Copie sua pasta MyTestSuite_1.0.0 em <device-tester-extract-location>/tests.

Execute os seguintes comandos:


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

O IDT executa seu pacote de teste e transmite os resultados para o console. Quando a execução do teste é concluída, são vistas as seguintes informações:


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

Solução de problemas

Use as informações a seguir para ajudar a resolver os problemas ao concluir o tutorial.

O caso de teste não foi executado com êxito

Se o teste não for executado, o IDT transmitirá os logs de erro para o console e isso pode ajudar a solucionar o problema de execução do teste. Antes de verificar os logs de erro, verifique o seguinte:

O SDK de cliente do IDT está na pasta correta, conforme descrito nesta etapa.
Você atende a todos os pré-requisitos deste tutorial.

Não é possível se conectar ao dispositivo em teste

Verifique o seguinte:

Seu arquivo device.json contém o endereço IP, a porta e as informações de autenticação corretos.
Também é possível se conectar ao seu dispositivo via SSH do seu computador host.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Tutorial: compile e execute o pacote de teste de amostra do IDT

Crie arquivos de configuração do pacote de teste do IDT