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
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!
libribzip2doing compression/decompression/compression. You can for example use the contents ofcli/samples/pepper.txtwhich 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