创建 IDT 测试套件配置文件 - Amazon IoT Greengrass
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

您正在查看Amazon IoT Greengrass Version 1.Amazon IoT Greengrass Version 2是最新的主要版本Amazon IoT Greengrass. 有关使用Amazon IoT Greengrass V2,请参阅Amazon IoT Greengrass Version 2开发人员指南.

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

创建 IDT 测试套件配置文件

本节介绍在编写自定义测试套件时创建 JSON 配置文件所使用的格式。

所需的 JSON 文件

suite.json

包含有关测试套件的信息。请参阅 配置套件 .json

group.json

包含有关测试组的信息。您必须创建group.json文件中的每个测试组。请参阅 配置组 .json

test.json

包含有关测试用例的信息。您必须创建test.json文件,用于测试套件中的每个测试用例。请参阅 配置测试 .json

可选 JSON 文件

state_machine.json

定义 IDT 运行测试套件时测试的运行方式。请参阅 配置状态计算机 .json

userdata_schema.json

定义userdata.jsonfile测试运行者可以包含在其设置配置中。这些区域有:userdata.json文件用于运行测试所需的任何其他配置信息,但不存在于device.json文件。请参阅 配置用户数据方案 .json

JSON 配置文件放置在<custom-test-suite-folder>如下所示。

<custom-test-suite-folder> └── suite ├── suite.json ├── state_machine.json ├── userdata_schema.json ├── <test-group-folder> ├── group.json ├── <test-case-folder> └── test.json

配置套件 .json

这些区域有:suite.json文件设置环境变量,并确定运行测试套件时是否需要用户数据。使用以下模板配置<custom-test-suite-folder>/suite/suite.jsonfile:

{ "id": "<suite-name>_<suite-version>", "title": "<suite-title>", "details": "<suite-details>", "userDataRequired": true | false, "environmentVariables": [ { "key": "<name>", "value": "<value>", }, ... { "key": "<name>", "value": "<value>", } ] }

包含值的所有字段都为必填字段,如下所述:

id

测试套件的唯一用户定义 ID。的值id必须与测试套件文件夹的名称匹配,其中suite.json文件位于中。套件名称和套件版本还必须满足以下要求:

  • <suite-name>不能包含下划线。

  • <suite-version>表示为x.x.x, 其中x是数字。

ID 显示在 IDT 生成的测试报告中。

title

此测试套件正在测试的产品或功能的用户定义名称。测试运行者的 IDT CLI 中显示该名称。

details

测试套件用途的简短描述。

userDataRequired

定义测试运行者是否需要将自定义信息包含在userdata.json文件。如果您将此值设置为true,您还必须包含userdata_schema.jsonfile在测试套件文件夹中。

environmentVariables

可选。要为此测试套件设置的环境变量数组。

environmentVariables.key

环境变量的名称。

environmentVariables.value

环境变量的值。

配置组 .json

这些区域有:group.json文件定义测试组是必需的还是可选的。使用以下模板配置<custom-test-suite-folder>/suite/<test-group>/group.jsonfile:

{ "id": "<group-id>", "title": "<group-title>", "details": "<group-details>", "optional": true | false, }

包含值的所有字段都为必填字段,如下所述:

id

测试组的唯一用户定义 ID。的值id必须与测试组文件夹的名称匹配,在中group.json文件位于中。ID 用于 IDT 生成的测试报告。

title

测试组的描述性名称。测试运行者的 IDT CLI 中显示该名称。

details

测试组用途的简短描述。

optional

可选。设置true在 IDT 完成运行所需测试后,将此测试组显示为可选组。默认值是 false.

配置测试 .json

这些区域有:test.json文件确定测试用例可执行文件和测试用例使用的环境变量。有关创建测试用例可执行文件的更多信息,请参阅创建 IDT 测试用例可执行文件.

使用以下模板配置<custom-test-suite-folder>/suite/<test-group>/<test-case>/test.jsonfile:

{ "id": "<test-id>", "title": "<test-title>", "details": "<test-details>", "requireDUT": true | false, "requiredResources": [ { "name": "<resource-name>", "features": [ { "name": "<feature-name>", "version": "<feature-version>", "jobSlots": <job-slots> } ] } ], "execution": { "timeout": <timeout>, "mac": { "cmd": "/path/to/executable", "args": [ "<argument>" ], }, "linux": { "cmd": "/path/to/executable", "args": [ "<argument>" ], }, "win": { "cmd": "/path/to/executable", "args": [ "<argument>" ] } }, "environmentVariables": [ { "key": "<name>", "value": "<value>", } ] }

包含值的所有字段都为必填字段,如下所述:

id

测试用例的唯一用户定义 ID。的值id必须与测试用例文件夹的名称匹配,test.json文件位于中。ID 用于 IDT 生成的测试报告。

title

测试用例的描述性名称。测试运行者的 IDT CLI 中显示该名称。

details

测试用例用途的简短描述。

requireDUT

可选。设置true如果需要设备才能运行此测试,否则将设置为false. 默认值是 true. 测试运行者将配置他们将用于运行测试的设备device.json文件。

requiredResources

可选。提供有关运行此测试所需资源设备的信息的阵列。

requiredResources.name

在运行此测试时为资源设备指定的唯一名称。

requiredResources.features

用户定义的资源设备功能的数组。

requiredResources.features.name

功能名称。要使用此设备的设备功能。此名称与测试运行程序在resource.json文件。

requiredResources.features.version

可选。功能的版本。此值与测试运行程序在resource.json文件。如果未提供版本,则不会选中该功能。如果功能不需要版本号,请将此字段留为空白。

requiredResources.features.jobSlots

可选。此功能可以支持的同步测试数。默认值为 1。如果您希望 IDT 为单个功能使用不同的设备,我们建议您将此值设置为1.

execution.timeout

IDT 等待测试完成运行的时间量(毫秒)。有关设置此值的更多信息,请参阅创建 IDT 测试用例可执行文件.

execution.os

基于运行 IDT 的主机的操作系统运行的测试用例可执行文件。支持的值有 linuxmacwin

execution.os.cmd

要为指定操作系统运行的测试用例可执行文件的路径。此位置必须位于系统路径中。

execution.os.args

可选。运行测试用例可执行文件时提供的参数。

environmentVariables

可选。为测试用例设置的环境变量数组。

environmentVariables.key

环境变量的名称。

environmentVariables.value

环境变量的值。

注意

如果您在test.json文件,并在suite.json文件中的值,则test.json文件优先。

配置状态计算机 .json

状态机是控制测试套件执行流程的结构。它确定测试套件的起始状态,根据用户定义的规则管理状态转换,并继续通过这些状态转换,直到达到结束状态。

如果您的测试套件不包括用户定义的状态机,IDT 将为您生成状态机。默认状态机执行以下功能:

  • 为测试运行者提供选择和运行特定测试组的能力,而不是整个测试套件。

  • 如果未选择特定的测试组,则按随机顺序运行测试套件中的每个测试组。

  • 生成报告并打印显示每个测试组和测试用例的测试结果的控制台摘要。

有关 IDT 状态机如何工作的更多信息,请参阅配置 IDT 状态机.

配置用户数据方案 .json

这些区域有:userdata_schema.json文件确定测试运行者提供用户数据的架构。如果您的测试套件需要的信息不在device.json文件。例如,您的测试可能需要 Wi-Fi 网络凭据、特定的开放端口或用户必须提供的证书。此信息可以作为输入参数提供给 IDT,名为userdata,其值为userdata.json文件中创建的文件,用户在<device-tester-extract-location>/configfolder。的格式userdata.json文件基于userdata_schema.json文件中包含在测试套件中。

要指示测试运行者必须提供userdata.jsonfile:

  1. suite.json文件,将userDataRequiredtrue.

  2. 在您的<custom-test-suite-folder>,创建一个userdata_schema.json文件。

  3. 编辑userdata_schema.json文件创建一个有效的IETF 草案 v4 JSON 架构.

IDT 运行测试套件时,它会自动读取模式并使用它来验证userdata.json文件中提供的文件。如果有效,userdata.json文件中的IDT 上下文,并在状态机上下文.