From 98149fd7d5ed21e47b375d7dc109881a6ac3b4d1 Mon Sep 17 00:00:00 2001 From: Jim Meyering Date: Fri, 9 Oct 2009 12:37:05 +0200 Subject: [PATCH] zdiff would exit 2 (error) rather than 1 for differences * zdiff.in: Save and restore cmp's exit status around a case statement that would otherwise clobber its value. * NEWS (Bug fixes): Mention it. * tests/zdiff: New test; exercise both bugs. * tests/test-lib.sh: New file. From coreutils. * Makefile.am (EXTRA_DIST): Add tests/test-lib.sh. (TESTS): Add tests/zdiff. (TESTS_ENVIRONMENT): Define. From coreutils. (EXTRA_DIST): Append all $(TESTS). --- .gitignore | 38 +++--- Makefile.am | 48 ++++++- NEWS | 3 + tests/test-lib.sh | 397 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ tests/zdiff | 53 ++++++++ zdiff.in | 2 + 6 files changed, 521 insertions(+), 20 deletions(-) create mode 100644 tests/test-lib.sh create mode 100755 tests/zdiff diff --git a/.gitignore b/.gitignore index c126c1d..d303400 100644 --- a/.gitignore +++ b/.gitignore @@ -8,27 +8,27 @@ .deps /GNUmakefile /maint.mk -INSTALL +/INSTALL Makefile Makefile.in -aclocal.m4 -build-aux -config.status -configure -gunzip -gzexe -gzip -gzip-* -zcat -zcmp -zdiff -zegrep -zfgrep -zforce -zgrep -zless -zmore -znew +/aclocal.m4 +/build-aux +/config.status +/configure +/gunzip +/gzexe +/gzip +/gzip-* +/zcat +/zcmp +/zdiff +/zegrep +/zfgrep +/zforce +/zgrep +/zless +/zmore +/znew /GNUmakefile /maint.mk ChangeLog diff --git a/Makefile.am b/Makefile.am index 8023f5b..af75eba 100644 --- a/Makefile.am +++ b/Makefile.am @@ -38,7 +38,8 @@ EXTRA_DIST = $(ACINCLUDE_INPUTS) $(man_MANS) \ sample/ztouch sample/add.c sample/sub.c sample/zread.c sample/zfile \ tailor.h vms/Makefile.mms vms/gzip.hlp vms/vms.c vms/Readme.vms \ vms/Makefile.vms vms/Makefile.gcc vms/makegzip.com zcat.in zcmp.in zdiff.in \ - zegrep.in zfgrep.in zforce.in zgrep.in zless.in zmore.in znew.in + zegrep.in zfgrep.in zforce.in zgrep.in zless.in zmore.in znew.in \ + tests/test-lib.sh bin_PROGRAMS = gzip bin_SCRIPTS = gunzip gzexe zcat zcmp zdiff \ @@ -99,6 +100,10 @@ check-local: $(FILES_TO_CHECK) $(bin_PROGRAMS) gzip.doc.gz test "`cat $$k | ./gzip -dc $$k - $$k`" = aaa && rm $$k @echo 'Test succeeded.' +TESTS = \ + tests/zdiff +EXTRA_DIST += $(TESTS) + install-exec-hook: remove-installed-links install-exec-hook remove-installed-links: @for prog_ext in $(bin_PROGRAMS) $(bin_SCRIPTS); do \ @@ -131,3 +136,44 @@ MAINTAINERCLEANFILES = gzip.doc MOSTLYCLEANFILES = _match.i match_.s _match.S gzip.doc.gz \ gunzip gzexe zcat zcmp zdiff zegrep zfgrep zforce zgrep zless zmore znew + +# Note that the first lines are statements. They ensure that environment +# variables that can perturb tests are unset or set to expected values. +# The rest are envvar settings that propagate build-related Makefile +# variables to test scripts. +TESTS_ENVIRONMENT = \ + tmp__=$$TMPDIR; test -d "$$tmp__" || tmp__=.; \ + TMPDIR=$$tmp__; export TMPDIR; \ + exec 9>&2; \ + shell_or_perl_() { \ + if grep '^\#!/usr/bin/perl' "$$1" > /dev/null; then \ + if $(PERL) -e 'use warnings' > /dev/null 2>&1; then \ + grep '^\#!/usr/bin/perl -T' "$$1" > /dev/null && T_=T || T_=; \ + $(PERL) -w$$T_ -I$(srcdir) -MCoreutils \ + -M"CuTmpdir qw($$f)" -- "$$1"; \ + else \ + echo 1>&2 "$$tst: configure did not find a usable version of Perl," \ + "so skipping this test"; \ + (exit 77); \ + fi; \ + else \ + $(SHELL) "$$1"; \ + fi; \ + }; \ + export \ + abs_top_builddir='$(abs_top_builddir)' \ + abs_top_srcdir='$(abs_top_srcdir)' \ + abs_srcdir='$(abs_srcdir)' \ + srcdir='$(srcdir)' \ + top_srcdir='$(top_srcdir)' \ + CC='$(CC)' \ + MAKE=$(MAKE) \ + PACKAGE_BUGREPORT='$(PACKAGE_BUGREPORT)' \ + PACKAGE_VERSION=$(PACKAGE_VERSION) \ + PERL='$(PERL)' \ + PREFERABLY_POSIX_SHELL='$(PREFERABLY_POSIX_SHELL)' \ + REPLACE_GETCWD=$(REPLACE_GETCWD) \ + PATH='$(abs_top_builddir)$(PATH_SEPARATOR)'"$$PATH" \ + ; shell_or_perl_ + +VERBOSE = yes diff --git a/NEWS b/NEWS index ec39a4c..20e09d8 100644 --- a/NEWS +++ b/NEWS @@ -4,6 +4,9 @@ GNU gzip NEWS -*- outline -*- ** Bug fixes + zdiff would exit with status 2 (indicating an error) rather than 1 to + indicate differences when both inputs were compressed and different. + zdiff would fail to print differences in two compressed inputs diff --git a/tests/test-lib.sh b/tests/test-lib.sh new file mode 100644 index 0000000..2caa604 --- /dev/null +++ b/tests/test-lib.sh @@ -0,0 +1,397 @@ +# source this file; set up for tests + +# Copyright (C) 2009 Free Software Foundation, Inc. + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# Skip this test if the shell lacks support for functions. +unset function_test +eval 'function_test() { return 11; }; function_test' +if test $? != 11; then + echo "$0: /bin/sh lacks support for functions; skipping this test." 1>&2 + Exit 77 +fi + +skip_test_() +{ + echo "$0: skipping test: $@" | head -1 1>&9 + echo "$0: skipping test: $@" 1>&2 + Exit 77 +} + +getlimits_() +{ + eval $(getlimits) + test "$INT_MAX" || + error_ "Error running getlimits" +} + +require_acl_() +{ + getfacl --version < /dev/null > /dev/null 2>&1 \ + && setfacl --version < /dev/null > /dev/null 2>&1 \ + || skip_test_ "This test requires getfacl and setfacl." + + id -u bin > /dev/null 2>&1 \ + || skip_test_ "This test requires a local user named bin." +} + +# Skip this test if we're not in SELinux "enforcing" mode. +require_selinux_enforcing_() +{ + test "$(getenforce)" = Enforcing \ + || skip_test_ "This test is useful only with SELinux in Enforcing mode." +} + + +require_openat_support_() +{ + # Skip this test if your system has neither the openat-style functions + # nor /proc/self/fd support with which to emulate them. + test -z "$CONFIG_HEADER" \ + && skip_test_ 'internal error: CONFIG_HEADER not defined' + + _skip=yes + grep '^#define HAVE_OPENAT' "$CONFIG_HEADER" > /dev/null && _skip=no + test -d /proc/self/fd && _skip=no + if test $_skip = yes; then + skip_test_ 'this system lacks openat support' + fi +} + +require_ulimit_() +{ + ulimit_works=yes + # Expect to be able to exec a program in 10MB of virtual memory, + # but not in 20KB. I chose "date". It must not be a shell built-in + # function, so you can't use echo, printf, true, etc. + # Of course, in coreutils, I could use $top_builddir/src/true, + # but this should be able to work for other projects, too. + ( ulimit -v 10000; date ) > /dev/null 2>&1 || ulimit_works=no + ( ulimit -v 20; date ) > /dev/null 2>&1 && ulimit_works=no + + test $ulimit_works = no \ + && skip_test_ "this shell lacks ulimit support" +} + +require_readable_root_() +{ + test -r / || skip_test_ "/ is not readable" +} + +# Skip the current test if strace is not available or doesn't work +# with the named syscall. Usage: require_strace_ unlink +require_strace_() +{ + test $# = 1 || framework_failure + + strace -V < /dev/null > /dev/null 2>&1 || + skip_test_ 'no strace program' + + strace -qe "$1" echo > /dev/null 2>&1 || + skip_test_ 'strace -qe "'"$1"'" does not work' +} + +# Require a controlling input `terminal'. +require_controlling_input_terminal_() +{ + tty -s || have_input_tty=no + test -t 0 || have_input_tty=no + if test "$have_input_tty" = no; then + skip_test_ 'requires controlling input terminal +This test must have a controlling input "terminal", so it may not be +run via "batch", "at", or "ssh". On some systems, it may not even be +run in the background.' + fi +} + +require_built_() +{ + skip_=no + for i in "$@"; do + case " $built_programs " in + *" $i "*) ;; + *) echo "$i: not built" 1>&2; skip_=yes ;; + esac + done + + test $skip_ = yes && skip_test_ "required program(s) not built" +} + +uid_is_privileged_() +{ + # Make sure id -u succeeds. + my_uid=$(id -u) \ + || { echo "$0: cannot run \`id -u'" 1>&2; return 1; } + + # Make sure it gives valid output. + case $my_uid in + 0) ;; + *[!0-9]*) + echo "$0: invalid output (\`$my_uid') from \`id -u'" 1>&2 + return 1 ;; + *) return 1 ;; + esac +} + +get_process_status_() +{ + sed -n '/^State:[ ]*\([[:alpha:]]\).*/s//\1/p' /proc/$1/status +} + +# Convert an ls-style permission string, like drwxr----x and -rw-r-x-wx +# to the equivalent chmod --mode (-m) argument, (=,u=rwx,g=r,o=x and +# =,u=rw,g=rx,o=wx). Ignore ACLs. +rwx_to_mode_() +{ + case $# in + 1) rwx=$1;; + *) echo "$0: wrong number of arguments" 1>&2 + echo "Usage: $0 ls-style-mode-string" 1>&2 + return;; + esac + + case $rwx in + [ld-][rwx-][rwx-][rwxsS-][rwx-][rwx-][rwxsS-][rwx-][rwx-][rwxtT-]) ;; + [ld-][rwx-][rwx-][rwxsS-][rwx-][rwx-][rwxsS-][rwx-][rwx-][rwxtT-][+.]) ;; + *) echo "$0: invalid mode string: $rwx" 1>&2; return;; + esac + + # Perform these conversions: + # S s + # s xs + # T t + # t xt + # The `T' and `t' ones are only valid for `other'. + s='s/S/@/;s/s/x@/;s/@/s/' + t='s/T/@/;s/t/x@/;s/@/t/' + + u=`echo $rwx|sed 's/^.\(...\).*/,u=\1/;s/-//g;s/^,u=$//;'$s` + g=`echo $rwx|sed 's/^....\(...\).*/,g=\1/;s/-//g;s/^,g=$//;'$s` + o=`echo $rwx|sed 's/^.......\(...\).*/,o=\1/;s/-//g;s/^,o=$//;'$s';'$t` + echo "=$u$g$o" +} + +skip_if_() +{ + case $1 in + root) skip_test_ must be run as root ;; + non-root) skip_test_ must be run as non-root ;; + *) ;; # FIXME? + esac +} + +require_selinux_() +{ + case `ls -Zd .` in + '? .'|'unlabeled .') + skip_test_ "this system (or maybe just" \ + "the current file system) lacks SELinux support" + ;; + esac +} + +very_expensive_() +{ + if test "$RUN_VERY_EXPENSIVE_TESTS" != yes; then + skip_test_ 'very expensive: disabled by default +This test is very expensive, so it is disabled by default. +To run it anyway, rerun make check with the RUN_VERY_EXPENSIVE_TESTS +environment variable set to yes. E.g., + + env RUN_VERY_EXPENSIVE_TESTS=yes make check +' + fi +} + +expensive_() +{ + if test "$RUN_EXPENSIVE_TESTS" != yes; then + skip_test_ 'expensive: disabled by default +This test is relatively expensive, so it is disabled by default. +To run it anyway, rerun make check with the RUN_EXPENSIVE_TESTS +environment variable set to yes. E.g., + + env RUN_EXPENSIVE_TESTS=yes make check +' + fi +} + +require_root_() +{ + uid_is_privileged_ || skip_test_ "must be run as root" + NON_ROOT_USERNAME=${NON_ROOT_USERNAME=nobody} + NON_ROOT_GROUP=${NON_ROOT_GROUP=$(id -g $NON_ROOT_USERNAME)} +} + +skip_if_root_() { uid_is_privileged_ && skip_test_ "must be run as non-root"; } +error_() { echo "$0: $@" 1>&2; Exit 1; } +framework_failure() { error_ 'failure in testing framework'; } + +# Set `groups' to a space-separated list of at least two groups +# of which the user is a member. +require_membership_in_two_groups_() +{ + test $# = 0 || framework_failure + + groups=${COREUTILS_GROUPS-`(id -G || /usr/xpg4/bin/id -G) 2>/dev/null`} + case "$groups" in + *' '*) ;; + *) skip_test_ 'requires membership in two groups +this test requires that you be a member of more than one group, +but running `id -G'\'' either failed or found just one. If you really +are a member of at least two groups, then rerun this test with +COREUTILS_GROUPS set in your environment to the space-separated list +of group names or numbers. E.g., + + env COREUTILS_GROUPS='users cdrom' make check + +' + ;; + esac +} + +# Is /proc/$PID/status supported? +require_proc_pid_status_() +{ + sleep 2 & + local pid=$! + sleep .5 + grep '^State:[ ]*[S]' /proc/$pid/status > /dev/null 2>&1 || + skip_test_ "/proc/$pid/status: missing or 'different'" + kill $pid +} + +# Does the current (working-dir) file system support sparse files? +require_sparse_support_() +{ + test $# = 0 || framework_failure + # Test whether we can create a sparse file. + # For example, on Darwin6.5 with a file system of type hfs, it's not possible. + # NTFS requires 128K before a hole appears in a sparse file. + t=sparse.$$ + dd bs=1 seek=128K of=$t < /dev/null 2> /dev/null + set x `du -sk $t` + kb_size=$2 + rm -f $t + if test $kb_size -ge 128; then + skip_test_ 'this file system does not support sparse files' + fi +} + +mkfifo_or_skip_() +{ + test $# = 1 || framework_failure + if ! mkfifo "$1"; then + # Make an exception of this case -- usually we interpret framework-creation + # failure as a test failure. However, in this case, when running on a SunOS + # system using a disk NFS mounted from OpenBSD, the above fails like this: + # mkfifo: cannot make fifo `fifo-10558': Not owner + skip_test_ 'NOTICE: unable to create test prerequisites' + fi +} + +# Disable the current test if the working directory seems to have +# the setgid bit set. +skip_if_setgid_() +{ + setgid_tmpdir=setgid-$$ + (umask 77; mkdir $setgid_tmpdir) + perms=$(stat --printf %A $setgid_tmpdir) + rmdir $setgid_tmpdir + case $perms in + drwx------);; + drwxr-xr-x);; # Windows98 + DJGPP 2.03 + *) skip_test_ 'this directory has the setgid bit set';; + esac +} + +skip_if_mcstransd_is_running_() +{ + test $# = 0 || framework_failure + + # When mcstransd is running, you'll see only the 3-component + # version of file-system context strings. Detect that, + # and if it's running, skip this test. + __ctx=$(stat --printf='%C\n' .) || framework_failure + case $__ctx in + *:*:*:*) ;; # four components is ok + *) # anything else probably means mcstransd is running + skip_test_ "unexpected context '$__ctx'; turn off mcstransd" ;; + esac +} + +# Skip the current test if umask doesn't work as usual. +# This test should be run in the temporary directory that ends +# up being removed via the trap commands. +working_umask_or_skip_() +{ + umask 022 + touch file1 file2 + chmod 644 file2 + perms=`ls -l file1 file2 | sed 's/ .*//' | uniq` + rm -f file1 file2 + + case $perms in + *' + '*) skip_test_ 'your build directory has unusual umask semantics' + esac +} + +# We use a trap below for cleanup. This requires us to go through +# hoops to get the right exit status transported through the signal. +# So use `Exit STATUS' instead of `exit STATUS' inside of the tests. +# Turn off errexit here so that we don't trip the bug with OSF1/Tru64 +# sh inside this function. +Exit () +{ + set +e + (exit $1) + exit $1 +} + +test_dir_=$(pwd) + +this_test_() { echo "./$0" | sed 's,.*/,,'; } +this_test=$(this_test_) + +# This is a stub function that is run upon trap (upon regular exit and +# interrupt). Override it with a per-test function, e.g., to unmount +# a partition, or to undo any other global state changes. +cleanup_() { :; } + +t_=$(mktemp -d --tmp="$test_dir_" gz-$this_test.XXXXXXXXXX)\ + || error_ "failed to create temporary directory in $test_dir_" + +remove_tmp_() +{ + __st=$? + cleanup_ + cd "$test_dir_" && chmod -R u+rwx "$t_" && rm -rf "$t_" && exit $__st +} + +# Run each test from within a temporary sub-directory named after the +# test itself, and arrange to remove it upon exception or normal exit. +trap remove_tmp_ 0 +trap 'Exit $?' 1 2 13 15 + +cd "$t_" || error_ "failed to cd to $t_" + +if ( diff --version < /dev/null 2>&1 | grep GNU ) 2>&1 > /dev/null; then + compare() { diff -u "$@"; } +elif ( cmp --version < /dev/null 2>&1 | grep GNU ) 2>&1 > /dev/null; then + compare() { cmp -s "$@"; } +else + compare() { cmp "$@"; } +fi diff --git a/tests/zdiff b/tests/zdiff new file mode 100755 index 0000000..cafe600 --- /dev/null +++ b/tests/zdiff @@ -0,0 +1,53 @@ +#!/bin/sh +# Exercise zdiff with two compressed inputs. +# Before gzip-1.4, this would fail. + +# Copyright (C) 2009 Free Software Foundation, Inc. + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# limit so don't run it by default. + +if test "$VERBOSE" = yes; then + set -x + zdiff --version +fi + +. $srcdir/tests/test-lib.sh + +echo a > a || framework_failure +echo b > b || framework_failure +gzip a b || framework_failure + +cat < exp +1c1 +< a +--- +> b +EOF + +fail=0 +zdiff a.gz b.gz > out 2>&1 +test $? = 1 || fail=1 + +compare out exp || fail=1 + +rm -f out +# expect success, for equal files +zdiff a.gz a.gz > out 2> err || fail=1 +# expect no output +test -s out && fail=1 +# expect no stderr +test -s err && fail=1 + +Exit $fail diff --git a/zdiff.in b/zdiff.in index 2a15860..7027221 100644 --- a/zdiff.in +++ b/zdiff.in @@ -110,10 +110,12 @@ elif test $# -eq 2; then ( (gzip -cdfq -- "$2" 4>&-; echo $? >&4) 3>&- 5<&- &3) 5<&0 ) + cmp_status=$? case $gzip_status in *[1-9]*) gzip_status=1;; *) gzip_status=0;; esac + (exit $cmp_status) else F=`expr "/$2" : '.*/\(.*\)[-.][zZtga]*$'` || F=$prog tmp= -- 2.11.4.GIT