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

Intefrations Tests: remove docs

pull/11276/head
Qinghao Shi 2019-08-23 22:15:27 +01:00
parent 8d7c100fa1
commit 701e1a7589
1 changed files with 0 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
TESTS/integration/README.md
View File

@ -1,72 +0,0 @@
# Integration tests for Mbed OS
Mbed OS provides a set of integration tests to help users identify integration issues around storage device and connectivity device.
## Test suites
| **Test suite** | **Description** |
| ------------- | ------------- |
| `fs-single` | File system single-threaded tests with write buffer sizes - 1 byte, 4b, 16b, 64b, 256b, 1kb, 4kb, 16kb, 64kb. |
| `fs-multi` | File system multithreaded test with write buffer sizes - 1 byte, 4b, 16b, 64b, 256b, 1kb, 4kb, 16kb, 64kb. |
| `net-single` | Network single-threaded test with receive buffer sizes - 128 bytes, 256b, 1kb, 2kb, 4kb. |
| `net-multi` | Network multithreaded test for 1, 2 and 3 download threads with 1kb receive buffer size. |
| `stress-net-fs` | Network and file system single and multithreaded tests:<ul><li>memory allocation - 10k, 20k, 40k, 60k</li><li>1 thread (sequential) - 1 download (1kb buffer), 1 file thread (1kb buffer)</li><li>2 parallel threads - 1 download, 1 file thread (1kb buffer)</li><li>3 parallel threads - 1 download, 2 file (256 bytes, 1 kb buffer)</li><li>4 parallel threads - 1 download, 3 file (1 byte, 256 bytes, 1kb buffer)</li></ul> |
## Execute tests
The integration test requires both the connectivity and storage device to configured.
If a platform has both of them enabled by default ( in `targets.json`), then the tests can be compiled and run from inside the mbed-os directory::
```
$ mbed test -t <toolchain> -m <platform> -n *integration-* -DINTEGRATION_TESTS -v
```
If a platform not have default storage or connectivity device and may require extra shield to run the integration test. In this case, a `target_extended.json` file can be passed in the command line, to configurate the target:
```
$ mbed test -t <toolchain> -m <platform> -n *integration-* -DINTEGRATION_TESTS --app-config TESTS\integration\COMMON\target_extended.json -v
```
Currently we have a pre-configuration file defined in the COMMON folder, and that file covers some of the platform connectivity/storage combinations. Yet this pre-configuration file might contains some compoments drivers that not included in the mbed-os. ( e.g. `WIFI_WIZFI310` and `NUSD` ), we'd expect user to add those drivers manually. If you have your own platform or you want to define your own configuration, please follow the [configuration guide](#Tests-configuration).
## Tests configuration
If required, edit the `target_extended.json` file, and create a new entry under `target_overrides` with the target name for your device:
- **Connectivity** - Specify the default connectivity type for your target. It's essential with targets that lack default connectivity set in `targets.json` or for targets that support multiple connectivity options. For example:
```
"target.network-default-interface-type" : "ETHERNET",
```
The possible options are `ETHERNET`, `WIFI` and `CELLULAR`.
Depending on connectivity type, you might have to specify more config options. For an example, please see the defined `CELLULAR` targets in `mbed_app.json`.
- **Storage** - Specify the storage block device type, which dynamically adds the block device driver you specified at compile time. For example:
```
"target.components_add" : ["SD"],
```
Valid options are `SD`, `SPIF`, `QSPIF` and `FLASHIAP` (not recommended). For more available options, please see the [block device components](https://github.com/ARMmbed/mbed-os/tree/master/components/storage/blockdevice).
You also have to specify block device pin configuration, which may vary from one block device type to another. Here's an example for `SD`:
```
"sd.SPI_MOSI" : "PE_6",
"sd.SPI_MISO" : "PE_5",
"sd.SPI_CLK" : "PE_2",
"sd.SPI_CS" : "PE_4",
```
If you are using SPI/QSPI flash, please make sure you have specified the correct SPI frequency by configuring `spif-driver.SPI_FREQ`. If it is not configured, 40Mhz will be applied by default.