Add examples, integration tests and docs for simulated device and rea… #87
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
…der interaction (#1) Integration tests and docs for simulated device and reader interaction **Integration tests:** - add simulated device and reader interaction - also for simulated device and reader interaction, add a more structured one using `state pattern`, `Mutex` and `Arc` - one test from the holder's POV with a simulated reader, and vice-versa for another test **Docs:** - add example from the holder's POV with a simulated reader, and vice-versa for another example - add diagram for simulated device and reader interaction - add diagrams for simulated device perspective and simulated reader perspective - add diagrams in readme and links to examples - add ASCII diagrams in `lib.rs` and include examples from device and reader's perspective - fix some docs **Code:** - add `allow invisible_characters` for clippy in a file **CI:** - upgrade `actions/checkout` - add `--all-targets` to build so that it builds tests too (to make sure they don't fall behind) - add `--all-targets` to `clippy` so that it runs on tests too (it will run o tests too but I assume it's fine) - don't explicitly run in in `macros` because `--all-targets` takes care of that - add `--all` to `fmt --check` so that it runs on examples too - don't explicitly run in in `macros` because `--all` takes care of that
cobward
requested changes
Aug 5, 2024
There was a problem hiding this comment.
I don't see the value of these four separate files in the tests directory. They are using the same code, sometimes imported from common.rs, sometimes duplicated in the file. Possibly it could be made clearer if you created Device and Reader structs, where each of these functions was a method of the corresponding struct, but I also think just having a single well-documented file would be clearer.
|
@cobward did the changes. |
…se common code. (#3) Removed some of the integration tests and refactor remaining ones to use common code.
# Conflicts: # src/lib.rs # tests/README.md # tests/common.rs # tests/simulated_device_and_reader.rs # tests/simulated_device_and_reader_state.rs
cobward
approved these changes
Aug 6, 2024
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.
Add tests and docs for simulated device and reader interaction.
Integration tests:
state pattern,MutexandArcDocs:
lib.rsand include examples from device and reader's perspectiveCode:
allow invisible_charactersfor clippy in a fileCI:
actions/checkout--all-targetsto build so that it builds tests too (to make sure they don't fall behind)--all-targetstoclippyso that it runs on tests too (it will run o tests too but I assume it's fine)macrosbecause--all-targetstakes care of that--alltofmt --checkso that it runs on examples toomacrosbecause--alltakes care of that