CMake: Update README.md with CTest/greentea instructions #15001
Conversation
ciarmcom
added
the
release-type: patch
|
@rwalton-arm, thank you for your changes. |
| cd cmake_build/<MBED_TARGET>/<PROFILE>/<TOOLCHAIN>/ && cmake ../../../.. -G Ninja -DMBED_GREENTEA_TEST_BAREMETAL=ON && cmake --build . | ||
| cmake --build __build | ||
| cd __build | ||
| ctest -V |
There was a problem hiding this comment.
Is it worth adding a note on how to run an individual test?
There was a problem hiding this comment.
I'll add a link to the ctest documentation to avoid repeating it here.
There was a problem hiding this comment.
Even though how to filter an individual test(s) is in the CTest documentation, it only covers the "run" stage. It's still good to let users know how to build one test. Presumably using --target <test-name> instead of --target test? Since building & testing of one test is a very commonly done task, giving a special mention of both in one place could be useful in my opinion.
Especially that the build time for all tests has increased quite a lot by now (e.g. over 10K object files as of today). Even though it's partially because INTERFACE libraries does lots of duplicated compilation than STATIC (a bit off-topic now...)
| ``` | ||
| * Build the test binary with the full profile | ||
| ## How to build and run greentea tests | ||
|
|
There was a problem hiding this comment.
I wonder if we need a note that migration of all tests is still in progress?
There was a problem hiding this comment.
This is the last remaining question. Can we merge this to get into the upcoming release (code freeze today).
There was a problem hiding this comment.
Should we wait until the migration of all tests is complete before merging this? I can see it causing confusion for users. This PR also removes the previous instructions for running greentea tests, which users could've been relying on. Rather than adding caveats or calling out both methods of running the tests, maybe we wait until the work to migrate all tests is complete, then the documentation is correct (and doesn't need to be changed again later)?
The steps for building and running a greentea test have changed since 40154ee. This commit updates the README with the current instructions for building and running greentea tests using CMake/Ninja/CTest.
rwalton-arm
force-pushed
the
gtea_test_readme
branch
from
15b6127 to
80fe7c2
Compare
| The `MBED_HTRUN_ARGUMENTS` argument is a semicolon separated list of arguments | ||
| to forward to `mbedhtrun`. You can pass any of the optional flags you would | ||
| usually pass to `mbedhtrun` by adding them to this list. |
There was a problem hiding this comment.
Worth noting that each argument is already quoted by CTest so the user should not add quotation marks or escape any characters.
For example, a mount point has a space inside, in which case -DMBED_HTRUN_ARGUMENTS="-p;/dev/tty.usbmodem14402;-d;/Volumes/NuMicro MCU" just works, but -DMBED_HTRUN_ARGUMENTS="-p;/dev/tty.usbmodem14402;-d;/Volumes/NuMicro\ MCU" causes the backslash to be treated as a literal character, and -DMBED_HTRUN_ARGUMENTS="-p;/dev/tty.usbmodem14402;-d;'/Volumes/NuMicro\ MCU'" causes the single quotes to be treated as literal characters.
|
Closing due to inactivity. |
mergify
bot
removed
component: tools
needs: preceding PR
release-type: patch
Summary of changes
The steps for building and running a greentea test have changed since
40154ee. This commit updates the README
with the current instructions for building and running greentea tests
using CMake/Ninja/CTest.
Partially fixes #14854
Impact of changes
N/A
Migration actions required
N/A
Documentation
None
Pull request type
Test results
Reviewers