Add SKIP_RETURN_CODE argument to ament_add_test #264
Merged
Conversation
This file contains 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
This makes the `run_test.py` wrapper aware of the `SKIP_RETURN_CODE` property on CTest tests. In the existing implementation, the wrapper detects that no result file was generated and overrides the special return code coming from the test, making the the CTest feature fail completely. This change makes the wrapper script aware of the special return code, and when detected, will write a 'skipped' result file instead of a 'failed' result file, and pass along the special return code as-is. Now the gtest result and the ctest results both show the test as 'skipped' when the special return flag is used. Note that none of this behavior is enabled by default, which is important because we wouldn't want a test to fail and return a code which we've decided is the special 'skip' return code. Only tests which are aware of this feature should use it. Signed-off-by: Scott K Logan <logans@cottsay.net>
cottsay
added
enhancement
cottsay
commented
Jul 15, 2020
Comment on lines
90
to
95
| if(ARG_SKIP_TEST) | ||
| list(APPEND cmd_wrapper "--skip-test") | ||
| set(ARG_SKIP_RETURN_CODE 0) | ||
| elseif(ARG_SKIP_RETURN_CODE) | ||
| list(APPEND cmd_wrapper "--skip-return-code" "${ARG_SKIP_RETURN_CODE}") | ||
| endif() |
There was a problem hiding this comment.
Just to clarify this elseif(), unconditionally skipping a test using SKIP_TEST overrides the return code behavior because we'll never invoke the test and therefore will never get the magic return code to skip it because we'll ALWAYS skip it. However, since we know that we'll always skip it, setting the SKIP_RETURN_CODE to 0 makes CTest invoke the test so that the wrapper can write the gtest result, while still reporting the test as skipped in it's own console output and result file.
dirk-thomas
reviewed
Jul 15, 2020
Signed-off-by: Scott K Logan <logans@cottsay.net>
dirk-thomas
approved these changes
Jul 15, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This makes the
run_test.pywrapper aware of theSKIP_RETURN_CODEproperty on CTest tests. In the existing implementation, the wrapper detects that no result file was generated and overrides the special return code coming from the test, making the the CTest feature fail completely.This change makes the wrapper script aware of the special return code, and when detected, will write a 'skipped' result file instead of a 'failed' result file, and pass along the special return code as-is. Now the gtest result and the ctest results both show the test as 'skipped' when the special return flag is used.
Note that none of this behavior is enabled by default, which is important because we wouldn't want a test to fail and return a code which we've decided is the special 'skip' return code. Only tests which are aware of this feature should use it.