ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Spelling fixes and general readability improvements

pull/8067/head
Brian Daniels 2018-09-10 15:37:39 -05:00
parent 920db63453
commit db463f2d2c
1 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
TEST_APPS/readme.md
View File

@ -2,54 +2,55 @@
### Structure
mbed-os has a folder called TEST_APPS that contains everything related to Icetea testing.
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
- `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 depends on test applications
The testcases depend on test applications.
### Preparing your work environment
#### Prerequisities
#### Prerequisites
You need Icetea and mbed-cli that supports Icetea, installed.
You need Icetea and version 1.8.0 or higher of Mbed CLI installed.
#### Selecting the network interface to use
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.
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.
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.
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.
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.
### 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
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:
`>mbed test -m <target> -t <toolchain> --icetea`
`mbed test -m <target> -t <toolchain> --icetea`
This command will compile the mbed-os, then compiles the test applications, creates a test suite and then starts running the tests.
This command compiles the OS, compiles the test applications, creates a test suite and then starts running the tests.
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 (,).
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 (`,`):
`>mbed test -m <target> -t <toolchain> --icetea -n test1,test2`
`mbed test -m <target> -t <toolchain> --icetea -n test1,test2`
#### Running the tests with specifig test-config
#### 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.
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 Wi-Fi interface:
`>mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndWifiInterface.json`
To run the tests with the Wi-Fi interface:
`mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndWifiInterface.json`
To run the tests with ethernet interface:
`>mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndEthernetInterface.json`
To run the tests with the ethernet interface:
`mbed test -m UBLOX_EVK_ODIN_W2 -t <toolchain> --icetea --test-config tools/test_configs/HeapBlockDeviceAndEthernetInterface.json`
#### Providing Wi-Fi access point information
If you are using Wi-Fi interface for running the tests, you need to provide also information about the used access point.
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: