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

Write tests documenting the usage of the library #14

Open
torfmaster opened this issue Jan 31, 2022 · 2 comments
Open

Write tests documenting the usage of the library #14

torfmaster opened this issue Jan 31, 2022 · 2 comments
Labels
Milestone

Comments

@torfmaster
Copy link
Owner

The library usage is currently poorly documented. Moreover, the only existing tests testing compression / decompression end-to-end. Let's solve these problems at once!

  • write round-trip unit tests for libribzip2 doing compression/decompression/compression. You can for example use the contents of cli/samples/pepper.txt which tests some of the features. You can also produce some static data larger than the block size of 900k to also test that use case
  • write tests for decompression using original bzip2 compressed data. You can store a bz2 file in the source code using https://doc.rust-lang.org/std/macro.include_bytes.html
  • write doc simple tests for the public library functions to explain the usage. Also run the doc tests in CI
@torfmaster torfmaster added this to the libribzip2 milestone Jan 31, 2022
@spennydl
Copy link

spennydl commented Mar 8, 2022

Hello! I would like to take this on if it still needs doing.

@torfmaster
Copy link
Owner Author

Go ahead. If you have questions, feel free to ask!

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

No branches or pull requests

2 participants