Skip to content

Commit e569936

Browse files
bridadanbridadan
committed
Update readme with moved repository info
1 parent ac36ed1 commit e569936

File tree

1 file changed

+79
-76
lines changed

1 file changed

+79
-76
lines changed

‎legacy/mbed-host-tests/README.md

Lines changed: 79 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
1-
[![Circle CI](https://circleci.com/gh/ARMmbed/htrun.svg?style=svg)](https://circleci.com/gh/ARMmbed/htrun)
2-
[![Coverage Status](https://coveralls.io/repos/github/ARMmbed/htrun/badge.svg?branch=master)](https://coveralls.io/github/ARMmbed/htrun?branch=master)
1+
# Development moved
2+
3+
The development of htrun has been moved into the [mbed-os-tools](../../src/mbed_os_tools) package. You can continue to use this module for legacy reasons, however all further development should be continued in the new package.
4+
5+
-------------
6+
37
[![PyPI version](https://badge.fury.io/py/mbed-host-tests.svg)](https://badge.fury.io/py/mbed-host-tests)
48

59
# Table of contents
@@ -137,7 +141,7 @@ Command line switch `--grm` has format: `<module_name>:<IP_address>:<port_number
137141

138142
This option is designed for htrun to use Arm Fast Models.
139143

140-
The "--fm" option only available when [mbed-fastmodel-agent](https://github.com/ARMmbed/mbed-fastmodel-agent) module is installed :
144+
The "--fm" option only available when [mbed-fastmodel-agent](https://github.com/ARMmbed/mbed-fastmodel-agent) module is installed :
141145

142146
Load local file `/path/to/file/binary.elf` to onto fastmodel FVP_MPS2_m3 simulators:
143147
```
@@ -183,14 +187,14 @@ $ pip install mbed-host-tests --upgrade
183187
```
184188

185189
## Installation from Python sources
186-
To install the mbed test suite, first clone the `htrun` repository:
190+
To install the mbed test suite, first clone the `mbed-os-tools` repository:
187191
```
188-
$ git clone https://github.com/ARMmbed/htrun.git
192+
$ git clone https://github.com/ARMmbed/mbed-os-tools.git
189193
```
190194

191-
Change the directory to the `htrun` directory:
195+
Change the directory to the `mbed-os-tools/legacy/mbed-host-tests` directory:
192196
```
193-
$ cd htrun
197+
$ cd mbed-os-tools/legacy/mbed-host-tests
194198
```
195199

196200
Now you are ready to install `htrun`:
@@ -220,7 +224,7 @@ Options:
220224
mbed's test suite (codenamed ```Greentea```) supports the *test supervisor* concept. This concept is realized by this module. ```mbed-host-tests``` is a collection of host tests. Host test is script written in Python, which is executed in parallel with the test suite runner (a binary running on the target hardware / device under test) to monitor the test execution's progress or to control the test flow (interaction with the mbed device under test - DUT). The host test is also responsible for grabbing the test result, or deducing it from the test runner's behavior.
221225

222226
Key-value protocol was developed and is used to provide communication layer between DUT (device under test) and host computer. Key-value protocol defined host computer as master and DUT as slave.
223-
* Slave side APIs and key-value protocol implementation is encapsulated in [greentea-client](https://github.com/ARMmbed/greentea-client) module.
227+
* Slave side APIs and key-value protocol implementation is encapsulated in [greentea-client](https://github.com/ARMmbed/mbed-os/tree/master/features/frameworks/greentea-client) module.
224228
* Master side APIs and key-value protocol is encapsulated in ```mbed-host-tests```.
225229

226230
```mbed-host-tests``` responsibilities are:
@@ -1041,7 +1045,7 @@ The SARA NBIOT EVK board must be connected to a Windows PC using a Segger JLink
10411045

10421046
# Testing mbed-os examples
10431047

1044-
mbed-os examples are essentially sample apps written as inspirational code for developers to understand the mbed-os APIs and coding paradigms. Before every mbed-os release all examples are tested across all supported configs and platforms. There is already a large set examples available and as they grow it is important to automate them. Hence automating examples make sense. Although it is important not to pollute them with test like instrumentation. As that will defeat the purpose of examples being simple and specific.
1048+
mbed-os examples are essentially sample apps written as inspirational code for developers to understand the mbed-os APIs and coding paradigms. Before every mbed-os release all examples are tested across all supported configs and platforms. There is already a large set examples available and as they grow it is important to automate them. Hence automating examples make sense. Although it is important not to pollute them with test like instrumentation. As that will defeat the purpose of examples being simple and specific.
10451049

10461050
Hence the strategy for testing examples is based on observation instead of interaction. An example's serial logging is captured and converted into a templated log. All successive executions of this example should match this log.
10471051

@@ -1050,87 +1054,87 @@ Templated log simply means a log with text that does not change or regular expre
10501054
```
10511055
10521056
> Using Ethernet LWIP
1053-
1057+
10541058
> Client IP Address is 10.2.203.139
1055-
1059+
10561060
> Connecting with developer.mbed.org
1057-
1061+
10581062
Starting the TLS handshake... Starting the TLS handshake...
1059-
1063+
10601064
> TLS connection to developer.mbed.org established
1061-
1065+
10621066
Server certificate: Server certificate:
1063-
1064-
>
1067+
1068+
>
10651069
cert. version : 3
1066-
>
1070+
>
10671071
serial number : 11:21:B8:47:9B:21:6C:B1:C6:AF:BC:5D:0
1068-
>
1072+
>
10691073
issuer name : C=BE, O=GlobalSign nv-sa, CN=GlobalSi
1070-
>
1074+
>
10711075
subject name : C=GB, ST=Cambridgeshire, L=Cambridge,
1072-
>
1076+
>
10731077
issued on : 2016-03-03 12:26:08
1074-
>
1078+
>
10751079
expires on : 2017-04-05 10:31:02
1076-
>
1080+
>
10771081
signed using : RSA with SHA-256
1078-
>
1082+
>
10791083
RSA key size : 2048 bits
1080-
>
1084+
>
10811085
basic constraints : CA=false
1082-
>
1086+
>
10831087
subject alt name : *.mbed.com, mbed.org, *.mbed.org, mbe
1084-
>
1088+
>
10851089
key usage : Digital Signature, Key Encipherment
1086-
>
1090+
>
10871091
ext key usage : TLS Web Server Authentication, TLS We
10881092
10891093
Certificate verification passed Certificate verification passed
1090-
10911094
1092-
1093-
1095+
1096+
1097+
10941098
> HTTPS: Received 439 chars from server
1095-
1099+
10961100
> HTTPS: Received 200 OK status ... [OK]
1097-
1101+
10981102
HTTPS: Received 'Hello world!' status ... [OK] HTTPS: Received 'Hello world!' status ... [OK]
1099-
1103+
11001104
HTTPS: Received message: HTTPS: Received message:
1101-
11021105
1103-
1104-
1106+
1107+
1108+
11051109
> HTTP/1.1 200 OK
1106-
1110+
11071111
> Server: nginx/1.7.10
1108-
1112+
11091113
> Date: Thu, 01 Dec 2016 13:56:32 GMT
1110-
1114+
11111115
> Content-Type: text/plain
1112-
1116+
11131117
> Content-Length: 14
1114-
1118+
11151119
> Connection: keep-alive
1116-
1120+
11171121
> Last-Modified: Fri, 27 Jul 2012 13:30:34 GMT
1118-
1122+
11191123
> Accept-Ranges: bytes
1120-
1124+
11211125
> Cache-Control: max-age=36000
1122-
1126+
11231127
> Expires: Thu, 01 Dec 2016 23:56:32 GMT
1124-
1128+
11251129
> X-Upstream-L3: 172.17.0.3:80
1126-
1130+
11271131
> X-Upstream-L2: developer-sjc-indigo-2-nginx
1128-
1132+
11291133
> Strict-Transport-Security: max-age=31536000; includeSubdomain
1130-
11311134
1132-
1133-
1135+
1136+
1137+
11341138
Hello world! Hello world!
11351139
11361140
```
@@ -1142,53 +1146,53 @@ Another example with regular examples is shown below:
11421146
```
11431147
11441148
SHA-256 :\s*\d+ Kb/s,\s*\d+ cycles/byte | SHA-256 : 1922 Kb/s, 61 cycl
1145-
1149+
11461150
SHA-512 :\s*\d+ Kb/s,\s*\d+ cycles/byte | SHA-512 : 614 Kb/s, 191 cycl
1147-
1151+
11481152
AES-CBC-128 :\s*\d+ Kb/s,\s*\d+ cycles/byte | AES-CBC-128 : 1401 Kb/s, 83 cycl
1149-
1153+
11501154
AES-CBC-192 :\s*\d+ Kb/s,\s*\d+ cycles/byte | AES-CBC-192 : 1231 Kb/s, 95 cycl
1151-
1155+
11521156
AES-CBC-256 :\s*\d+ Kb/s,\s*\d+ cycles/byte | AES-CBC-256 : 1097 Kb/s, 106 cycl
1153-
1157+
11541158
AES-GCM-128 :\s*\d+ Kb/s,\s*\d+ cycles/byte | AES-GCM-128 : 429 Kb/s, 273 cycl
1155-
1159+
11561160
AES-GCM-192 :\s*\d+ Kb/s,\s*\d+ cycles/byte | AES-GCM-192 : 412 Kb/s, 285 cycl
1157-
1161+
11581162
AES-GCM-256 :\s*\d+ Kb/s,\s*\d+ cycles/byte | AES-GCM-256 : 395 Kb/s, 297 cycl
1159-
1163+
11601164
AES-CCM-128 :\s*\d+ Kb/s,\s*\d+ cycles/byte | AES-CCM-128 : 604 Kb/s, 194 cycl
1161-
1165+
11621166
AES-CCM-192 :\s*\d+ Kb/s,\s*\d+ cycles/byte | AES-CCM-192 : 539 Kb/s, 217 cycl
1163-
1167+
11641168
AES-CCM-256 :\s*\d+ Kb/s,\s*\d+ cycles/byte | AES-CCM-256 : 487 Kb/s, 241 cycl
1165-
1169+
11661170
CTR_DRBG \(NOPR\) :\s*\d+ Kb/s,\s*\d+ cycles/byte | CTR_DRBG (NOPR) : 1145 Kb/s, 102 cycl
1167-
1171+
11681172
CTR_DRBG \(PR\) :\s*\d+ Kb/s,\s*\d+ cycles/byte | CTR_DRBG (PR) : 821 Kb/s, 142 cycl
1169-
1173+
11701174
HMAC_DRBG SHA-256 \(NOPR\) :\s*\d+ Kb/s,\s*\d+ cycles/byte | HMAC_DRBG SHA-256 (NOPR) : 219 Kb/s, 537 cycl
1171-
1175+
11721176
HMAC_DRBG SHA-256 \(PR\) :\s*\d+ Kb/s,\s*\d+ cycles/byte | HMAC_DRBG SHA-256 (PR) : 193 Kb/s, 612 cycl
1173-
1177+
11741178
RSA-2048 :\s*\d+ ms/ public | RSA-2048 : 30 ms/ public
1175-
1179+
11761180
RSA-2048 :\s*\d+ ms/private | RSA-2048 : 1054 ms/private
1177-
1181+
11781182
RSA-4096 :\s*\d+ ms/ public | RSA-4096 : 101 ms/ public
1179-
1183+
11801184
RSA-4096 :\s*\d+ ms/private | RSA-4096 : 5790 ms/private
1181-
1185+
11821186
ECDHE-secp384r1 :\s*\d+ ms/handshake | ECDHE-secp384r1 : 1023 ms/handshake
1183-
1187+
11841188
ECDHE-secp256r1 :\s*\d+ ms/handshake | ECDHE-secp256r1 : 678 ms/handshake
1185-
1189+
11861190
ECDHE-Curve25519 :\s*\d+ ms/handshake | ECDHE-Curve25519 : 580 ms/handshake
1187-
1191+
11881192
ECDH-secp384r1 :\s*\d+ ms/handshake | ECDH-secp384r1 : 503 ms/handshake
1189-
1193+
11901194
ECDH-secp256r1 :\s*\d+ ms/handshake | ECDH-secp256r1 : 336 ms/handshake
1191-
1195+
11921196
ECDH-Curve25519 :\s*\d+ ms/handshake | ECDH-Curve25519 : 300 ms/handshake
11931197
11941198
```
@@ -1208,4 +1212,3 @@ mbedhtrun -d D: -p COM46 -m K64F -f .\BUILD\K64F\GCC_ARM\benchmark.bin --compare
12081212
In case an application requires more time to process data and generate results, you can use the option ```--polling-timeout``` to override the default timeout setting.
12091213

12101214
A tested comparison log can be checked into GitHub with the examples and can be used in the CI for example verification.
1211-

0 commit comments

Comments
 (0)