|
2 | 2 |
|
3 | 3 | ### Structure
|
4 | 4 |
|
5 |
| -mbed-os has a folder called TEST_APPS that contains everything related to Icetea testing. |
| 5 | +Mbed OS has a folder called `TEST_APPS` that contains everything related to Icetea testing. |
6 | 6 | There are currently 3 folders:
|
7 | 7 |
|
8 |
| -- device - contains all the different test applications you can flash to your board |
9 |
| -- icetea-plugins - contains plugins that are being used by some of the testcases, needed for the test execution |
10 |
| -- testcases - contains Icetea testcases written in Python |
| 8 | +- `device` - contains all the different test applications you can flash to your board |
| 9 | +- `icetea_plugins` - contains plugins that are being used by some of the testcases, needed for the test execution |
| 10 | +- `testcases` - contains Icetea testcases written in Python |
11 | 11 |
|
12 |
| -The testcases depends on test applications |
| 12 | +The testcases depend on test applications. |
13 | 13 |
|
14 | 14 | ### Preparing your work environment
|
15 | 15 |
|
16 |
| -#### Prerequisities |
| 16 | +#### Prerequisites |
17 | 17 |
|
18 |
| -You need Icetea and mbed-cli that supports Icetea, installed. |
| 18 | +You need Icetea and version 1.8.0 or higher of Mbed CLI installed. |
19 | 19 |
|
20 | 20 | #### Selecting the network interface to use
|
21 | 21 |
|
22 |
| -Depending on a device, there might be a default network interface type defined in the mbed-os/targets/targets.json, which is used to locate a test-config file by default. |
23 |
| -If there is not, or you want to use a different interface than the default, you need to provide a relevant test-config -file to the mbed test with --test-config option. |
24 |
| -The test-config file contains the necessary information for the test application, there are some test-config files located under mbed-os/tools/test_configs. |
25 |
| -Devices which have their network drivers residing inside mbed-os can use generic test_configs like HeapBlockDeviceAndEthernetInterface.json and HeapBlockDeviceAndWifiInterface.json. Otherwise you need to use a device specific test-config. |
| 22 | +Depending on the device, there might be a default network interface type defined in `mbed-os/targets/targets.json`, which is used to locate a default test-config file. |
| 23 | +If default network interface type is not defined, or you want to use a different interface than the default, you need to provide a test-config file to the mbed test with `--test-config` option. |
| 24 | + |
| 25 | +The test-config file contains the necessary information for the test application. There are some test-config files located under `mbed-os/tools/test_configs`. |
| 26 | +Devices which have their network drivers residing inside mbed-os can use generic test_configs like `HeapBlockDeviceAndEthernetInterface.json` and `HeapBlockDeviceAndWifiInterface.json`. Otherwise you need to use a device specific test-config. |
26 | 27 |
|
27 | 28 | ### Running the tests
|
28 | 29 |
|
29 |
| -Now that the interface has been selected you can run the icetea tests from the mbed-os root on your command line by |
| 30 | +Now that the interface has been selected you can run the icetea tests from the mbed-os root on your command line by running the following command: |
30 | 31 |
|
31 |
| -`>mbed test -m <target> -t <toolchain> --icetea` |
| 32 | +`mbed test -m <target> -t <toolchain> --icetea` |
32 | 33 |
|
33 |
| -This command will compile the mbed-os, then compiles the test applications, creates a test suite and then starts running the tests. |
| 34 | +This command compiles the OS, compiles the test applications, creates a test suite and then starts running the tests. |
34 | 35 |
|
35 |
| -If you want only to run some specific tests, you can use the -n -option. You can list multiple tests by separating them by comma (,). |
| 36 | +If you only want to run some specific tests, you can use the `-n` option. You can choose multiple tests by separating them with a comma (`,`): |
36 | 37 |
|
37 |
| -`>mbed test -m <target> -t <toolchain> --icetea -n test1,test2` |
| 38 | +`mbed test -m <target> -t <toolchain> --icetea -n test1,test2` |
38 | 39 |
|
39 |
| -#### Running the tests with specifig test-config |
| 40 | +#### Running the tests with a specific test-config |
40 | 41 |
|
41 |
| -Some devices may offer multiple network interfaces to operate with. For example, UBLOX_EVK_ODIN_W2 offers ethernet and Wi-Fi capabilities. |
| 42 | +Some devices may offer multiple network interfaces to operate with. For example, `UBLOX_EVK_ODIN_W2` offers ethernet and Wi-Fi capabilities. |
42 | 43 | The tests can be run for either one of those using already existing test-config -files.
|
43 | 44 |
|
44 |
| -To run the tests with Wi-Fi interface: |
45 |
| -`>mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndWifiInterface.json` |
| 45 | +To run the tests with the Wi-Fi interface: |
| 46 | +`mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndWifiInterface.json` |
46 | 47 |
|
47 |
| -To run the tests with ethernet interface: |
48 |
| -`>mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndEthernetInterface.json` |
| 48 | +To run the tests with the ethernet interface: |
| 49 | +`mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndEthernetInterface.json` |
49 | 50 |
|
50 | 51 | #### Providing Wi-Fi access point information
|
51 | 52 |
|
52 |
| -If you are using Wi-Fi interface for running the tests, you need to provide also information about the used access point. |
| 53 | +If you are using the Wi-Fi interface for running the tests, you need to also provide information about the used access point. |
53 | 54 | The information can be provided in the used test-config file.
|
54 | 55 |
|
55 | 56 | Example of access point information:
|
|
0 commit comments