feat: add teardown fn for defmt-test #917
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
Urhengulas
requested changes
Jan 9, 2025
firmware/defmt-test/macros/tests/ui/teardown-has-invalid-function-signature.stderr
Outdated
Show resolved
Hide resolved
|
Hi Johann, for the error msg I wait on how you decide |
Urhengulas
approved these changes
Jan 10, 2025
Comment on lines
+18
to
+26
| macro_rules! fn_state_signature_msg { | ||
| ($name:literal) => { | ||
| concat!( | ||
| "`#[", | ||
| $name, | ||
| "]` function must have signature `fn()` or `fn(state: &mut T)`" | ||
| ) | ||
| }; | ||
| } |
There was a problem hiding this comment.
Could this also be a function? If not, it is okay as well. I just think functions are usually easier to understand.
Suggested change
| macro_rules! fn_state_signature_msg { | |
| ($name:literal) => { | |
| concat!( | |
| "`#[", | |
| $name, | |
| "]` function must have signature `fn()` or `fn(state: &mut T)`" | |
| ) | |
| }; | |
| } | |
| fn fn_state_signature_msg(name: &str) -> String { | |
| format!("`#[{name}]` function must have signature `fn()` or `fn(state: &mut T)`") | |
| } |
There was a problem hiding this comment.
not sure how Rust optimizes format!() in this case, because String is heap allocated while the macro is compile time (so constant).
Thats why I went with a macro.
For defmt-test to be usable in no_std, it is not possible to use String.
There was a problem hiding this comment.
For defmt-test to be usable in no_std, it is not possible to use String.
True, makes sense
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 PR adds the possibility to specify a teardown function in a defmt-test module.
Similar to the before_each and after_each attributes, the teardown function can only be specified once and may take the state from the init function as parameter.
In contrast to the *_each functions, the teardown function is called only once at the end of the test run directly before exiting.
This function is needed, for example to handle cleanup code that must only be run at the end of a test run.