教程:构建并运行示例 IDT 测试套件 - AWS IoT Greengrass
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

教程:构建并运行示例 IDT 测试套件

AWS AWS IoT Device Tester 下载包含示例测试套件的源代码。您可以完成本教程以构建并运行示例测试套件,以了解如何使用适用于 AWS IoT IoT Greengrass 的 IDT 运行自定义测试套件。

在本教程中,您将完成以下步骤:

  1. 构建示例测试套件

  2. 使用 IDT 运行示例测试套件

Prerequisites

要完成本教程,您需要:

  • 主机要求

    • AWS AWS IoT Device Tester 的最新版本

    • Python 3.7 或更高版本

      要检查计算机上安装的 Python 版本,请运行以下命令:

      python3 --version

      在 Windows 上,如果使用此命令返回错误,请python --version改用 。如果返回的版本号为 3.7 或更高,请在 Powershell 终端中运行以下命令,以将 python3 设置为您的python命令的别名。

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

      如果未返回版本信息,或者版本号低于 3.7,请按照下载 Python 中的说明安装 Python 3.7+。有关更多信息,请参阅 Python 文档

    • urllib3

      要验证 urllib3 是否已正确安装,请运行以下命令:

      python3 -c 'import urllib3'

      如果未urllib3安装 ,请运行以下命令进行安装:

      python3 -m pip install urllib3
  • 设备要求

    • 一台设备,具有 Linux 操作系统和到主机所在网络的网络连接。

      我们建议您将 Raspberry Pi 与 Raspberry Pi OS 结合使用。确保在 Raspberry Pi 上设置 SSH 以远程连接到它。

为 IDT 配置设备信息

为 IDT 配置设备信息以运行测试。您必须使用以下信息更新位于 device.json 文件夹中的<device-tester-extract-location>/configs模板。

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

devices 对象中,提供以下信息:

id

设备的用户定义的唯一标识符。

connectivity.ip

设备的 IP 地址。

connectivity.port

可选。用于与设备进行 SSH 连接的端口号。

connectivity.auth

连接的身份验证信息。

此属性仅在 connectivity.protocol 设置为 ssh 时适用。

connectivity.auth.method

用于通过给定的连接协议访问设备的身份验证方法。

支持的值为:

  • pki

  • password

connectivity.auth.credentials

用于身份验证的凭证。

connectivity.auth.credentials.user

用于登录设备的用户名。

connectivity.auth.credentials.privKeyPath

用于登录设备的私有密钥的完整路径。

此值仅在 connectivity.auth.method 设置为 pki 时适用。

devices.connectivity.auth.credentials.password

用于登录设备的密码。

此值仅在 connectivity.auth.method 设置为 password 时适用。

注意

privKeyPath 仅当 设置为 method 时,才指定 pki

password 仅当 设置为 method 时,才指定 password

构建示例测试套件

<device-tester-extract-location>/samples/python 文件夹包含示例配置文件、源代码以及 IDT 客户端开发工具包,您可以使用提供的构建脚本将其合并到测试套件中。以下目录树显示了这些示例文件的位置:

<device-tester-extract-location> ├── ... ├── tests ├── samples │ ├── ... │ └── python │ ├── configuration │ ├── src │ └── build-scripts │ ├── build.sh │ └── build.ps1 └── sdks ├── ... └── python └── idt_client

要构建测试套件,请在主机上运行以下命令:

Windows
cd <device-tester-extract-location>/samples/python/build-scripts ./build.ps1
Linux, macOS, or UNIX
cd <device-tester-extract-location>/samples/python/build-scripts ./build.sh

这将在 IDTSampleSuitePython_1.0.0 文件夹中的 文件夹中创建示例测试套件<device-tester-extract-location>/tests。查看 IDTSampleSuitePython_1.0.0 文件夹中的文件以了解示例测试套件的结构,并查看测试用例可执行文件和测试配置 JSON 文件的各种示例。

下一步:使用 IDT 运行您创建的示例测试套件

使用 IDT 运行示例测试套件

要运行示例测试套件,请在主机上运行以下命令:

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

IDT 运行示例测试套件并将结果流式传输到 控制台。当测试完成运行时,您将看到以下信息:

========== Test Summary ========== Execution Time: 5s Tests Completed: 4 Tests Passed: 4 Tests Failed: 0 Tests Skipped: 0 ---------------------------------- Test Groups: sample_group: PASSED ---------------------------------- Path to AWS IoT Device Tester Report: /path/to/devicetester/results/87e673c6-1226-11eb-9269-8c8590419f30/awsiotdevicetester_report.xml Path to Test Execution Logs: /path/to/devicetester/results/87e673c6-1226-11eb-9269-8c8590419f30/logs Path to Aggregated JUnit Report: /path/to/devicetester/results/87e673c6-1226-11eb-9269-8c8590419f30/IDTSampleSuitePython_Report.xml

Troubleshooting

使用以下信息帮助解决有关完成本教程的任何问题。

测试用例未成功运行

如果测试未成功运行,IDT 会将错误日志流式传输到 控制台,以帮助您排查测试运行问题。确保您满足本教程的所有先决条件

无法连接到所测试设备

请验证以下内容:

  • 您的 device.json 文件包含正确的 IP 地址、端口和身份验证信息。

  • 您可以从主机通过 SSH 连接到您的设备。