[COMPRESS-434] Add test case/documentation for specific GzipCompressorInputStream use case

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 1.16
• Component/s: Compressors

Environment

Only observed this for Compress 1.15; have not checked earlier versions.

• Assignee: Unassigned
• Reporter: Anders Thulin
• Created: 26/Dec/17 09:55
• Updated: 29/Apr/18 10:40
• Resolved: 29/Apr/18 10:40

Description

The constructor for GzipCompressedInputStream() allows two forms of creation: one with the decompressConcatenated parameter true, and one with it false.

The second case (false) does not have any accompanying test case. The only testcase present is testConcatenatedStreamsReadFully, which uses decompressConcatenated = true.

*Suggestion 1: Provide a test case for the decompressConcatenated = false use case to test that separate gzip members are extracted from the same InputStream. Existing test data ('multiple.gz') might be used for this. (I'm assuming RFC1952 compliance here ... see below)

The lack of code indirectly strikes against practical use of this form of constructor: it is not at all obvious from the JavaDoc how concatenated archives are extracted while retaining their independent identity.

• Suggestion 2: Add sample code for this usecase to JavaDoc.

• Suggestion 3: If GzipCompressedInputStream is intended to provide support for RFC1952-compatible streams, please document it. Alternatively, document that it isn't.

Added: I see now that the lack of testcase and doc has been identified earlier (COMPRESS-154) referring to (COMPRESS-146)