Use IDT to develop and run your own test suites - AWS IoT Greengrass

You are viewing the documentation for AWS IoT Greengrass Version 1. AWS IoT Greengrass Version 2 is the latest major version of AWS IoT Greengrass. For more information about using AWS IoT Greengrass V2, see the AWS IoT Greengrass Version 2 Developer Guide.

Use IDT to develop and run your own test suites

Starting in IDT v4.0.0, IDT for AWS IoT Greengrass combines a standardized configuration setup and result format with a test suite environment that enables you to develop custom test suites for your devices and device software. You can add custom tests for your own internal validation or provide them to your customers for device verification.

Use IDT to develop and run custom test suites, as follows:

To develop custom test suites
  • Create test suites with custom test logic for the Greengrass device that you want to test.

  • Provide IDT with your custom test suites to test runners. Include information about specific settings configurations for your test suites.

To run custom test suites
  • Set up the device that you want to test.

  • Implement the settings configurations as required by the test suites that you want to use.

  • Use IDT to run your custom test suites.

  • View the test results and execution logs for the tests run by IDT.

Download the latest version of AWS IoT Device Tester for AWS IoT Greengrass

Download the latest version of IDT and extract the software into a location on your file system where you have read and write permissions.

Note

IDT does not support being run by multiple users from a shared location, such as an NFS directory or a Windows network shared folder. We recommend that you extract the IDT package to a local drive and run the IDT binary on your local workstation.

Windows has a path length limitation of 260 characters. If you are using Windows, extract IDT to a root directory like C:\ or D:\ to keep your paths under the 260 character limit.

Test suite creation workflow

Test suites are composed of three types of files:

  • JSON configuration files that provide IDT with information on how to execute the test suite.

  • Test executable files that IDT uses to run test cases.

  • Additional files required to run tests.

Complete the following basic steps to create custom IDT tests:

  1. Create JSON configuration files for your test suite.

  2. Create test case executables that contain the test logic for your test suite.

  3. Verify and document the configuration information required for test runners to run the test suite.

  4. Verify that IDT can run your test suite and produce test results as expected.

To quickly build a sample custom suite and run it, follow the instructions in Tutorial: Build and run the sample IDT test suite.

To get started creating a custom test suite in Python, see Tutorial: Develop a simple IDT test suite.