[RSDK-7426] Make it more obvious how to run the tests for the C++ SDK #446
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gabegottlob
requested review from
lia-viam and
stuqdog
and removed request for
a team
stuqdog
approved these changes
May 30, 2025
Comment on lines
+100
to
+104
| ## Running Tests | ||
| Tests for the SDK are located in `src/viam/sdk/tests`. The CMakeLists.txt file in that directory defines how to build them. When the SDK is built, the test executables are placed in the test folder within your specified build directory (e.g., `build`, if you followed the instructions in [`BUILDING.md`](https://github.com/viamrobotics/viam-cpp-sdk/blob/main/BUILDING.md)). The test executable files can be run individually. To run the entire test suite at once, navigate to the `tests` folder in your build directory and run: | ||
| ``` | ||
| ctest | ||
| ``` |
Member
There was a problem hiding this comment.
(optional) might be worth noting that you can also run the entire test suite without having to navigate to the folder with ctest --test-dir src/viam/sdk/tests/
Member
There was a problem hiding this comment.
Also probably worth noting that there are many other interesting ctest options you can use too, to filter tests, or rerun only failures, etc. I don't think we should try to document those, but encouraging developers to expore ctest --help would only be a good thing.
lia-viam
approved these changes
May 30, 2025
Collaborator
lia-viam
left a comment
lia-viam
left a comment
There was a problem hiding this comment.
seconding ethan's comment, but otherwise lgtm!
acmorrow
approved these changes
Jun 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a section to the README to make the location of the tests and how to run the tests more clear.