threads / patch / 56682

patcharchive: add test testing MIME for created archive through compression filter

Subject: [PATCH] archive: add test testing MIME for created archive through compression filter

## tl;dr

6 messages between Oct 11, 2021 and Oct 12, 2021. Diffs are folded; open one to read it.

replies: 5people: 3as markdown or json

Bagas Sanjaya· Oct 11, 2021, 11:27 UTC · lore

The common use of `tar.<format>.command` config is to specify compression program filter for creating compressed tar archive.

Add a test that tests MIME type of archives created through the filter. The generated archives must not be `application/x-tar` (POSIX tar archive) type, so that these can be decompressed with the corresponding decompression program (such as gunzip, bunzip2, and unxz).

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 t/t5000-tar-tree.sh | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
Show changes to t/t5000-tar-tree.sh +17 −0
diff --git a/t/t5000-tar-tree.sh b/t/t5000-tar-tree.sh
index 2c88d1c159..04cdad5bff 100755
--- a/t/t5000-tar-tree.sh
+++ b/t/t5000-tar-tree.sh
@@ -38,6 +38,8 @@ test_lazy_prereq TAR_NEEDS_PAX_FALLBACK '
 '
 
 test_lazy_prereq GZIP 'gzip --version'
+test_lazy_prereq BZIP2 'bzip2 --version'
+test_lazy_prereq XZ 'xz --version'
 
 get_pax_header() {
 	file=$1
@@ -374,6 +376,21 @@ test_expect_success GZIP 'remote tar.gz can be disabled' '
 		>remote.tar.gz
 '
 
+test_expect_success GZIP,BZIP2,XZ 'git archive with gzip, bzip2, and xz filters creates compressed tar archive with proper MIME type' '
+	git config tar.tar.bz2.command "bzip2 -c" &&
+	git config tar.tar.xz.command "xz -c" &&
+	git archive --output HEAD.tar.gz --prefix=src/ HEAD &&
+	git archive --output HEAD.tar.bz2 --prefix=src/ HEAD &&
+	git archive --output HEAD.tar.xz --prefix=src/ HEAD &&
+	cat >expect <<EOF &&
+HEAD.tar.bz2: application/x-bzip2; charset=binary
+HEAD.tar.gz:  application/gzip; charset=binary
+HEAD.tar.xz:  application/x-xz; charset=binary
+EOF
+	file -i HEAD.tar.bz2 HEAD.tar.gz HEAD.tar.xz 2>/dev/null >actual &&
+	test_cmp expect actual
+'
+
 test_expect_success 'archive and :(glob)' '
 	git archive -v HEAD -- ":(glob)**/sh" >/dev/null 2>actual &&
 	cat >expect <<EOF &&

base-commit: 106298f7f9cca4158a980de149ef217751e1f943

-- 
An old man doll... just what I always wanted! - Clara
Junio C Hamano· Oct 11, 2021, 15:48 UTC · re: Bagas Sanjaya · lore

Re: [PATCH] archive: add test testing MIME for created archive through compression filter

Bagas Sanjaya <bagasdotme@gmail.com> writes:
Show 5 quoted lines
> +	cat >expect <<EOF &&
> +HEAD.tar.bz2: application/x-bzip2; charset=binary
> +HEAD.tar.gz:  application/gzip; charset=binary
> +HEAD.tar.xz:  application/x-xz; charset=binary
> +EOF
Use <<-EOF and you can align here-document to the script.
> +	file -i HEAD.tar.bz2 HEAD.tar.gz HEAD.tar.xz 2>/dev/null >actual &&
This looks super un-portable.
  https://pubs.opengroup.org/onlinepubs/9699919799/utilities/file.html
Junio C Hamano· Oct 11, 2021, 15:53 UTC · re: Bagas Sanjaya · lore

Re: [PATCH] archive: add test testing MIME for created archive through compression filter

Bagas Sanjaya <bagasdotme@gmail.com> writes:
> +test_expect_success GZIP,BZIP2,XZ 'git archive with gzip, bzip2, and xz filters creates compressed tar archive with proper MIME type' '
> +	git config tar.tar.bz2.command "bzip2 -c" &&
> +	git config tar.tar.xz.command "xz -c" &&
> +	git archive --output HEAD.tar.gz --prefix=src/ HEAD &&

I think a lot more portable and robust way to test the feature is to configure git config tar.tar.test.command (or come up with a name for a suffix to be used in the test), point it at a script created in this test script and run git archive with output filename that would trigger the command. Then, arrange the test to notice if the "test" script was called with expected command line arguments and standard input.

That way, you do not need to rely on prereqs and you do not have to resort to un-portable use of the "file" command. After all, you are *not* testing if "bzip2 -c" the user happens to have on their $PATH produces output their "find" recognises as bzip2 compressed.

Jeff King· Oct 11, 2021, 16:07 UTC · re: Junio C Hamano · lore

Re: [PATCH] archive: add test testing MIME for created archive through compression filter

On Mon, Oct 11, 2021 at 08:53:11AM -0700, Junio C Hamano wrote:
Show 18 quoted lines
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
> 
> > +test_expect_success GZIP,BZIP2,XZ 'git archive with gzip, bzip2, and xz filters creates compressed tar archive with proper MIME type' '
> > +	git config tar.tar.bz2.command "bzip2 -c" &&
> > +	git config tar.tar.xz.command "xz -c" &&
> > +	git archive --output HEAD.tar.gz --prefix=src/ HEAD &&
> 
> I think a lot more portable and robust way to test the feature is to
> configure git config tar.tar.test.command (or come up with a name for
> a suffix to be used in the test), point it at a script created in this
> test script and run git archive with output filename that would trigger
> the command.  Then, arrange the test to notice if the "test" script was
> called with expected command line arguments and standard input.
> 
> That way, you do not need to rely on prereqs and you do not have to
> resort to un-portable use of the "file" command.  After all, you are
> *not* testing if "bzip2 -c" the user happens to have on their $PATH
> produces output their "find" recognises as bzip2 compressed.

That would work. Or perhaps using something portable like "tr" to do a nonsense conversion, and verifying that we can get convert back to the original. Like say, the tests added to t5000 by 767cf4579f (archive: implement configurable tar filters, 2011-06-21).

I don't think the newly proposed test is adding anything beyond that (except checking the system "bzip2" command, but as you say, that is not useful to us, nor portable).

-Peff
Bagas Sanjaya· Oct 12, 2021, 03:14 UTC · re: Junio C Hamano · lore

Re: [PATCH] archive: add test testing MIME for created archive through compression filter

On 11/10/21 22.53, Junio C Hamano wrote:
Show 12 quoted lines
> I think a lot more portable and robust way to test the feature is to
> configure git config tar.tar.test.command (or come up with a name for
> a suffix to be used in the test), point it at a script created in this
> test script and run git archive with output filename that would trigger
> the command.  Then, arrange the test to notice if the "test" script was
> called with expected command line arguments and standard input.
> 
> That way, you do not need to rely on prereqs and you do not have to
> resort to un-portable use of the "file" command.  After all, you are
> *not* testing if "bzip2 -c" the user happens to have on their $PATH
> produces output their "find" recognises as bzip2 compressed.
>

The intent of this test is to ensure `git archive -o something.tar.<format>` produces proper compressed tar archive that can be decompressed with the corresponding decompression tool (such as gunzip for gz files), and not just with `tar xvf`.

-- 
An old man doll... just what I always wanted! - Clara
Junio C Hamano· Oct 12, 2021, 19:15 UTC · re: Bagas Sanjaya · lore

Re: [PATCH] archive: add test testing MIME for created archive through compression filter

Bagas Sanjaya <bagasdotme@gmail.com> writes:
Show 17 quoted lines
> On 11/10/21 22.53, Junio C Hamano wrote:
>> I think a lot more portable and robust way to test the feature is to
>> configure git config tar.tar.test.command (or come up with a name for
>> a suffix to be used in the test), point it at a script created in this
>> test script and run git archive with output filename that would trigger
>> the command.  Then, arrange the test to notice if the "test" script was
>> called with expected command line arguments and standard input.
>> That way, you do not need to rely on prereqs and you do not have to
>> resort to un-portable use of the "file" command.  After all, you are
>> *not* testing if "bzip2 -c" the user happens to have on their $PATH
>> produces output their "find" recognises as bzip2 compressed.
>> 
>
> The intent of this test is to ensure `git archive -o
> something.tar.<format>` produces proper compressed tar archive that
> can be decompressed with the corresponding decompression tool (such as 
> gunzip for gz files), and not just with `tar xvf`.
Yes, that is why relying on "file -i" is not the right thing to do.

We'd want to use the matching decompressor, or better yet, trust that the compressor-decompressor pair the system offers do work correctly (after all, it's not our test suite's job to debug the system software the tester uses) and validate that

 (1) the specified compressor is spawned with the right parameters
     taken from the configuration file, and that
 (2) the compressor is fed the correct input stream.

Using a script prepared by the test itself as the "compressor" would be one good way to validate (1); it can record how it was invoked, so that the test can check its correctness. Using a reversible transformation in the script as a fake compressor and comparing the reversed output with the output without any compression filter, may be one way to validate (2), like Peff mentioned.

But asking "file -i" validates neither.

The code that reads the configuration and spawns the compressor with specified parameters may be broken and may not pass the right parameters, or the archive stream may not be passed to the compressor intact. But the compressor may still produce a header block that is looking correct enough for the "file" command to say "ah, that uses X compressor", and the tests in the patch under discussion does not even see if the payload was passed correctly without corruption to the compressor at all.

← back to recent threads