[debug] Add manticore::debug #108
Draft
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
The `debug` module is intended to hold debugging helpers, to make debugging Manticore tests easier. This will include: - Redactable logging. - Error creation capture (e.g., capturing where `Err` variants are created). The generated logs can be captured by tests, and eventually get returned through Cerberus's "debug log" functionality. Signed-off-by: Miguel Young de la Sota <[email protected]>
This type cannot be created except via special macros in the `debug` module that generate log statements. We may eventually also attach extra debugging information to errors, and this type is a good place to do so. Signed-off-by: Miguel Young de la Sota <[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.
The
debugmodule is intended to hold debugging helpers, to make debugging Manticore tests easier. This includes:Errvariants are created).The generated logs can be captured by tests, and eventually get returned through Cerberus's "debug log" functionality.
Right now,
manticore::Resultis unused. If we decide to go with this design, we'll need to manually update a ton of callsites to use it, and i'm not certain this can be done gradually. I think this will ultimately be worth it, since I won't have to break out GDB to do basic debugging of unit tests. Other than this immediate benefit, it means we can extract fine-grained errors out of Manticore for other purposes.