Skip to content

Commit f79a066

Browse files
author
Amanda Butler
authored
Copy edit readme.md
Extend copy edits.
1 parent db463f2 commit f79a066

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

TEST_APPS/readme.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
### Structure
44

55
Mbed OS has a folder called `TEST_APPS` that contains everything related to Icetea testing.
6-
There are currently 3 folders:
76

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
7+
There are currently three folders:
8+
9+
- `device` - contains all the different test applications you can flash to your board.
10+
- `icetea_plugins` - contains plugins that are being used by some of the testcases, needed for the test execution.
11+
- `testcases` - contains Icetea testcases written in Python.
1112

1213
The testcases depend on test applications.
1314

@@ -19,15 +20,17 @@ You need Icetea and version 1.8.0 or higher of Mbed CLI installed.
1920

2021
#### Selecting the network interface to use
2122

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.
23+
Depending on the device, there might be a default network interface type defined in `mbed-os/targets/targets.json`, which you can use to locate a default test-config file.
24+
25+
If the 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.
2426

2527
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.
28+
29+
Devices that have their network drivers residing inside `mbed-os` can use generic `test_configs`, such as `HeapBlockDeviceAndEthernetInterface.json` and `HeapBlockDeviceAndWifiInterface.json`. Otherwise, you need to use a device-specific test-config.
2730

2831
### Running the tests
2932

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:
33+
Now that you have selected the interface, you can run the Icetea tests from the `mbed-os` root on your command-line by running the following command:
3134

3235
`mbed test -m <target> -t <toolchain> --icetea`
3336

@@ -40,20 +43,25 @@ If you only want to run some specific tests, you can use the `-n` option. You ca
4043
#### Running the tests with a specific test-config
4144

4245
Some devices may offer multiple network interfaces to operate with. For example, `UBLOX_EVK_ODIN_W2` offers ethernet and Wi-Fi capabilities.
46+
4347
The tests can be run for either one of those using already existing test-config -files.
4448

4549
To run the tests with the Wi-Fi interface:
50+
4651
`mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndWifiInterface.json`
4752

4853
To run the tests with the ethernet interface:
54+
4955
`mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndEthernetInterface.json`
5056

5157
#### Providing Wi-Fi access point information
5258

5359
If you are using the Wi-Fi interface for running the tests, you need to also provide information about the used access point.
60+
5461
The information can be provided in the used test-config file.
5562

5663
Example of access point information:
64+
5765
```
5866
"target_overrides": {
5967
"*": {
@@ -67,7 +75,7 @@ Example of access point information:
6775

6876
### Test results
6977

70-
Icetea prints the results from the test run to the command line, and the final result looks similar to this.
78+
Icetea prints the results from the test run to the command-line, and the final result looks similar to this:
7179

7280
```
7381
+--------------------------------+---------+-------------+-------------+-----------+----------+
@@ -90,5 +98,6 @@ Icetea prints the results from the test run to the command line, and the final r
9098
+---------------+----------------+
9199
```
92100

93-
The results from the tests can also be found in the mbed-os/log folder.
94-
You probably want to add the log folder to your .mbedignore file to prevent issues with build commands becoming too long over the time.
101+
You can also find the results from the tests in the `mbed-os/log` folder.
102+
103+
You probably want to add the log folder to your `.mbedignore` file to prevent issues with build commands becoming too long over the time.

0 commit comments

Comments
 (0)