Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better docs and unit tests for Storage #130

Open
haraldng opened this issue Dec 20, 2023 · 1 comment
Open

Better docs and unit tests for Storage #130

haraldng opened this issue Dec 20, 2023 · 1 comment

Comments

@haraldng
Copy link
Owner

The storage trait should have better descriptions, especially related to the indexes e.g., whether get_log_len should return only the number of real entries or be calculated based on the compacted index.

Furthermore, we currently only have tests for the storage in OmniPaxos. However, we should also have unit tests directly in omnipaxos_storage. This will make it easier for users to understand how to implement and test their own storage implementations.

@soruh
Copy link

soruh commented Dec 20, 2023

Thank you! I think it would help to have tests available for users to test their own Storage implementations against. (Similar to what I attempted here: https://gitea.h.glsys.de/soruh/validate_omnipaxos_storage). This could be reused to test the implementations in omnipaxos_storage. If you think that's reasonable feel free the reuse what you want of that code. I would do this myself, but I obviously don't know what to test...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants