Improve debug log enablement in unit tests #10273
Open
+301
−159
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
Rework how debug logs are handled in SSL unit tests. The big change is that test endpoints now automatically set up the new function `mbedtls_test_ssl_debug_handler()` a debug callback, and they set the debug level to high so that the handler is always called. Test functions no longer call `mbedtls_ssl_conf_dbg()` or `mbedtls_debug_set_threshold()`. As part of this change, the interface for setting a pattern that must be present in the logs has changed, and is now a bit simpler: just set `options.debug_threshold`, `options.cli_log_pattern` and `options.srv_log_pattern`. The endpoint structure now owns its own counter. This refactoring will make it a lot easier to enable debug logs temporarily when debugging tests. This commit changes how the test helpers work, but there is no intended change to what the test functions actually test for. Signed-off-by: Gilles Peskine <[email protected]>
Use a runtime variable rather than a compile-time edit to determine whether to print SSL debug logs to stdout. This makes it easier to selectively enable it, and allows controlling the level. Also fix bitrot in the code that was guarded by `#if 0`. Signed-off-by: Gilles Peskine <[email protected]>
Signed-off-by: Gilles Peskine <[email protected]>
Signed-off-by: Gilles Peskine <[email protected]>
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.
Simplify the use of SSL debug logs (provided by
debug.c) in unit tests.mbedtls_test_ssl_debug_stdout_threshold = 4;in the C code and runtests/test_suite_ssl -v.Status: works in the default config. Probably needs work for weird configs.
Follow-up: I'd prefer to write debug logs to a file if
MBEDTLS_SSL_DEBUG=filename.logis set in the environment. But I haven't coded this yet.Code extracted from #10217.
Builds on #10197. The same remarks apply regarding a 3.6 backport.
PR checklist