From f79a066f9eba01777860a5df1b48b0a3604cc363 Mon Sep 17 00:00:00 2001 From: Amanda Butler Date: Tue, 11 Sep 2018 12:49:28 -0500 Subject: [PATCH] Copy edit readme.md Extend copy edits. --- TEST_APPS/readme.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/TEST_APPS/readme.md b/TEST_APPS/readme.md index a1bdbf670d..2d5f50bfac 100644 --- a/TEST_APPS/readme.md +++ b/TEST_APPS/readme.md @@ -3,11 +3,12 @@ ### Structure Mbed OS has a folder called `TEST_APPS` that contains everything related to Icetea testing. -There are currently 3 folders: -- `device` - contains all the different test applications you can flash to your board -- `icetea_plugins` - contains plugins that are being used by some of the testcases, needed for the test execution -- `testcases` - contains Icetea testcases written in Python +There are currently three folders: + +- `device` - contains all the different test applications you can flash to your board. +- `icetea_plugins` - contains plugins that are being used by some of the testcases, needed for the test execution. +- `testcases` - contains Icetea testcases written in Python. The testcases depend on test applications. @@ -19,15 +20,17 @@ You need Icetea and version 1.8.0 or higher of Mbed CLI installed. #### Selecting the network interface to use -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. -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. +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. + +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. 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`. -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. + +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. ### Running the tests -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: +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: `mbed test -m -t --icetea` @@ -40,20 +43,25 @@ If you only want to run some specific tests, you can use the `-n` option. You ca #### Running the tests with a specific test-config Some devices may offer multiple network interfaces to operate with. For example, `UBLOX_EVK_ODIN_W2` offers ethernet and Wi-Fi capabilities. + The tests can be run for either one of those using already existing test-config -files. To run the tests with the Wi-Fi interface: + `mbed test -m UBLOX_EVK_ODIN_W2 -t --icetea --test-config tools/test_configs/HeapBlockDeviceAndWifiInterface.json` To run the tests with the ethernet interface: + `mbed test -m UBLOX_EVK_ODIN_W2 -t --icetea --test-config tools/test_configs/HeapBlockDeviceAndEthernetInterface.json` #### Providing Wi-Fi access point information If you are using the Wi-Fi interface for running the tests, you need to also provide information about the used access point. + The information can be provided in the used test-config file. Example of access point information: + ``` "target_overrides": { "*": { @@ -67,7 +75,7 @@ Example of access point information: ### Test results -Icetea prints the results from the test run to the command line, and the final result looks similar to this. +Icetea prints the results from the test run to the command-line, and the final result looks similar to this: ``` +--------------------------------+---------+-------------+-------------+-----------+----------+ @@ -90,5 +98,6 @@ Icetea prints the results from the test run to the command line, and the final r +---------------+----------------+ ``` -The results from the tests can also be found in the mbed-os/log folder. -You probably want to add the log folder to your .mbedignore file to prevent issues with build commands becoming too long over the time. +You can also find the results from the tests in the `mbed-os/log` folder. + +You probably want to add the log folder to your `.mbedignore` file to prevent issues with build commands becoming too long over the time.