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

Updating readme to use hyphens for unittest paths

pull/8066/head
Brian Daniels 2018-09-10 12:12:38 -05:00
parent 920db63453
commit ebd1c16c9e
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
UNITTESTS/README.md
View File

@ -79,7 +79,7 @@ mbed test --unittests
A subset of tests can be run by providing `-r` flag for the tool which runs tests matching a regular expression.
e.g. `mbed test --unittests --run -r features_netsocket`
e.g. `mbed test --unittests --run -r features-netsocket`
### Build manually without Python tools
@ -105,7 +105,7 @@ mingw32-make
#### Custom CMake variables
Usage:
Usage:
`cmake [RELATIVE PATH TO UNITTESTS DIR] [OPTIONS]`
Keyword variables (usage `cmake -D<VARIABLE>(:<TYPE>)=<value>`:
@ -157,8 +157,8 @@ mkdir UNITTESTS/build
cd UNITTESTS/build
cmake -DCMAKE_BUILD_TYPE=Debug -DCOVERAGE:STRING=html ..
make
./features_netsocket_InternetSocket
gcovr -r ../.. --html --html-detail -o ./index.html ./CMakeFiles/features_netsocket_InternetSocket.MbedOS.dir/
./features-netsocket-InternetSocket
gcovr -r ../.. --html --html-detail -o ./index.html ./CMakeFiles/features-netsocket-InternetSocket.MbedOS.dir/
```
Windows:
```
@ -166,8 +166,8 @@ mkdir UNITTESTS/build
cd UNITTESTS/build
cmake -DCMAKE_BUILD_TYPE=Debug -DCOVERAGE:STRING=html -g "MinGW Makefiles" ..
mingw32-make
features_netsocket_InternetSocket.exe
gcovr -r ..\.. --html --html-detail -o .\index.html .\CMakeFiles\features_netsocket_InternetSocket.MbedOS.dir\
features-netsocket-InternetSocket.exe
gcovr -r ..\.. --html --html-detail -o .\index.html .\CMakeFiles\features-netsocket-InternetSocket.MbedOS.dir\
```
## The structure of unit tests
@ -203,7 +203,7 @@ Each class to be tested requires two files for unit testing:
A unit test definition file `unittest.cmake` requires variables to be set for a test to be configured. File source paths in `unittest.cmake` files need to be relative to the unit test folder and `CMakeLists.txt`.
* **TEST_SUITE_NAME** - Identifier for the test suite. Use naming convention *PATH_TO_THE_TESTABLE_FILE* e.g. *features_netsocket_InternetSocket*
* **TEST_SUITE_NAME** - Identifier for the test suite. Use naming convention *PATH_TO_THE_TESTABLE_FILE* e.g. *features-netsocket-InternetSocket*
* **unittest-includes** - Include paths for headers needed to build the tests in addition to the base include paths listed in [CMakeLists.txt](CMakeLists.txt). Optional.
* **unittest-sources** - Mbed OS source files and stubs included for the build.
* **unittest-test-sources** - Unit test source files.
@ -291,4 +291,4 @@ TEST_F(TestSemaphore, constructor)
**Problem:** virus protection identifies files generated by CMake as malicious and quarantines the files on Windows.
* **Solution**: restore the false positive files from the quarantine.
* **Solution**: restore the false positive files from the quarantine.