Skip to main content

Icetea - test framework

Project description

Icetea test framework

Icetea is an automated testing framework for Mbed development. It automates the process of flashing Mbed boards, running tests and accumulating test results into reports. Developers use it for local development as well as for automation in a Continuous Integration Environment.

When testing Mbed OS Icetea allows you to execute commands remotely via the command line interface (CLI) in a device under test (DUT). The interface between the test framework and DUT can be for example UART or stdio.

More detailed documentation on the tool is available here in rst format and here in markdown format.


Icetea supports Linux (Ubuntu preferred), Windows and OS X. Our main target is Linux. We support both Python 2.7 and 3.5 or later. Some OS specific prerequisites below:

  • Linux

    • python-dev and python-lxml sudo apt-get install python-dev python-lxml
    • In order to run test cases with hardware in Linux without sudo rights:
      sudo usermod -a -G dialout username
      Log out & log in back to Linux
      This command will add the user 'username' to the 'dialout' group and grant the required permissions to the USB ports.
  • OS X

  • Windows

    • python-lxml installation is problematic on Windows since it usually requires build tools. It can however be installed from pre-built binaries.
      • Search for a binary for you system from the internet.
      • Navigate to the directory where you downloaded the binary and install it with pip install <insert_file_name>
    • You can follow instructions here instead.


There are some optional dependencies that brings some optional features, like coloredlogs which decorate your console outputs with all kind of colors.

All optional dependencies are declared extra_requirements.txt and they can be installed using pip. Note that you need extra_requirements.txt file locally.

> pip install -r extra_requirements.txt


Sniffer integration component requires pyshark, which is not covered in requirements.txt due to installation issues with trollius (requirement for python 2 version of pyshark called pyshark-legacy). To use this integration, you need to manually install pyshark for your setup. For python 3:

> pip install pyshark

For python 2:

> pip install pyshark-legacy


> pip install icetea


To print the help page:

icetea --help

To list all local testcases from the examples subfolder:

icetea --list --tcdir examples

To print Icetea version:

icetea --version

Typical use

All of the commands described below might also need other options, depending on the test case.

Running test cases using the tc argument

> icetea --tc <test case name> --tcdir <test case search path>

To run all existing test cases from the examples folder:

> icetea --tc all --tcdir examples

Running an example test case with hardware

In this example, we assume that a compatible board has been connected to the computer and an application binary for the board is available. The referred test case is available in the icetea github repository.

> icetea --tc test_cmdline --tcdir examples --type hardware --bin <path to a binary>

Using metadata filters

To run all test cases with testtype regression in the metadata:

> icetea --testtype regression --tcdir <test case search path>

The following metadata filters are available:

  • test type (--testtype)
  • test subtype (--subtype)
  • feature (--feature)
  • test case name (--tc)
  • tested component (--component)
  • test case folder (--group)

Running a premade suite

Icetea supports a suite file that describes a suite of test cases in json format.

> icetea --suite <suite file name> --tcdir <test case search path> --suitedir <path to suite directory>

Enabling debug level logging

Use -v or -vv arguments to control logging levels. -v increases the frameworks logging level to debug (default is info) and the level of logging in certain plugins and external components to info (default is warning). --vv increases the level of logging on all Icetea loggers to debug.

Further details

For further details on any of the features see our documentation.

Creating a test case

Icetea test cases are implemented as Python classes that inherit the Bench object available in icetea_lib.bench module. The test case needs to have an initialization function that defines the metadata and a case function that implements the test sequence. There are two optional functions, setup and teardown. More information is available in our documentation.

An example test case is shown below:

Copyright 2017 ARM Limited
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

from icetea_lib.bench import Bench

class Testcase(Bench):
    def __init__(self):
                       title="Example test",
                       purpose="Show example of a test",
                           "duts": {
                               '*': {
                                    "count": 1,
                                    "type": "hardware"

    def setup(self):
        # nothing for now

    def case(self):
        self.command(1, "echo hello world", timeout=5)

    def teardown(self):
        # nothing for now


See the license agreement.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

icetea-2.0.1.tar.gz (184.4 kB view hashes)

Uploaded source

Built Distribution

icetea-2.0.1-py3-none-any.whl (207.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page