tests/help/help-version.sh

   1 #!/bin/sh
   2 # Make sure all of these programs work properly
   3 # when invoked with --help or --version.
   4
   5 # Copyright (C) 2000-2024 Free Software Foundation, Inc.
   6
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19
  20 . "${srcdir=.}/tests/init.sh"; path_prepend_ ./src
  21
  22 # Terminate any background processes
  23 cleanup_() { kill $pid 2>/dev/null && wait $pid; }
  24
  25 expected_failure_status_chroot=125
  26 expected_failure_status_env=125
  27 expected_failure_status_nice=125
  28 expected_failure_status_nohup=125
  29 expected_failure_status_runcon=125
  30 expected_failure_status_stdbuf=125
  31 expected_failure_status_timeout=125
  32 expected_failure_status_printenv=2
  33 expected_failure_status_tty=3
  34 expected_failure_status_sort=2
  35 expected_failure_status_expr=3
  36 expected_failure_status_lbracket=2
  37 expected_failure_status_dir=2
  38 expected_failure_status_ls=2
  39 expected_failure_status_vdir=2
  40
  41 expected_failure_status_cmp=2
  42 expected_failure_status_zcmp=2
  43 expected_failure_status_sdiff=2
  44 expected_failure_status_diff3=2
  45 expected_failure_status_diff=2
  46 expected_failure_status_zdiff=2
  47 expected_failure_status_zgrep=2
  48 expected_failure_status_zegrep=2
  49 expected_failure_status_zfgrep=2
  50
  51 expected_failure_status_grep=2
  52 expected_failure_status_egrep=2
  53 expected_failure_status_fgrep=2
  54
  55 test "$built_programs" \
  56   || fail_ "built_programs not specified!?!"
  57
  58 test "$VERSION" \
  59   || fail_ "set envvar VERSION; it is required for a PATH sanity-check"
  60
  61 # Extract version from --version output of the first program
  62 for i in $built_programs; do
  63   v=$(env $i --version | sed -n '1s/.* //p;q')
  64   break
  65 done
  66
  67 # Ensure that it matches $VERSION.
  68 test "x$v" = "x$VERSION" \
  69   || fail_ "--version-\$VERSION mismatch"
  70
  71 for i in $built_programs; do
  72
  73   # Skip 'test'; it doesn't accept --help or --version.
  74   test $i = test && continue
  75
  76   # false fails even when invoked with --help or --version.
  77   # true and false are tested with these options separately.
  78   test $i = false || test $i = true && continue
  79
  80   # The just-built install executable is always named 'ginstall'.
  81   test $i = install && i=ginstall
  82
  83   # Make sure they exit successfully, under normal conditions.
  84   env $i --help    >/dev/null || fail=1
  85   env $i --version >/dev/null || fail=1
  86
  87   # Make sure they fail upon 'file system full' error.
  88   if test -w /dev/full && test -c /dev/full &&
  89        ! printf x >/dev/full 2>/dev/null; then
  90     test $i = [ && prog=lbracket || prog=$(echo $i|sed "s/$EXEEXT$//")
  91     eval "expected=\$expected_failure_status_$prog"
  92     test x$expected = x && expected=1
  93
  94     returns_ $expected env $i --help    >/dev/full 2>/dev/null &&
  95     returns_ $expected env $i --version >/dev/full 2>/dev/null ||
  96     {
  97       fail=1
  98       env $i --help >/dev/full 2>/dev/null
  99       status=$?
 100       echo "*** $i: bad exit status '$status' (expected $expected)," 1>&2
 101       echo "  with --help or --version output redirected to /dev/full" 1>&2
 102     }
 103   fi
 104 done
 105
 106 bigZ_in=bigZ-in.Z
 107 zin=zin.gz
 108 zin2=zin2.gz
 109
 110 tmp=tmp-$$
 111 tmp_in=in-$$
 112 tmp_in2=in2-$$
 113 tmp_dir=dir-$$
 114 tmp_out=out-$$
 115 mkdir $tmp || fail=1
 116 cd $tmp || fail=1
 117
 118 comm_setup () { args="$tmp_in $tmp_in"; }
 119 csplit_setup () { args="$tmp_in //"; }
 120 cut_setup () { args='-f 1'; }
 121 join_setup () { args="$tmp_in $tmp_in"; }
 122 tr_setup () { args='a a'; }
 123
 124 chmod_setup () { args="a+x $tmp_in"; }
 125 # Punt on these.
 126 chgrp_setup () { args=--version; }
 127 chown_setup () { args=--version; }
 128 mkfifo_setup () { args=--version; }
 129 mknod_setup () { args=--version; }
 130 # Punt on uptime, since it fails (e.g., failing to get boot time)
 131 # on some systems, and we shouldn't let that stop 'make check'.
 132 uptime_setup () { args=--version; }
 133
 134 # Create a file in the current directory, not in $TMPDIR.
 135 mktemp_setup () { args=mktemp.XXXX; }
 136
 137 cmp_setup () { args="$tmp_in $tmp_in2"; }
 138
 139 # Tell dd not to print the line with transfer rate and total.
 140 # The transfer rate would vary between runs.
 141 dd_setup () { args=status=noxfer; }
 142
 143 zdiff_setup () { args="$zin $zin2"; }
 144 zcmp_setup () { zdiff_setup; }
 145 zcat_setup () { TERM=dumb; export TERM; args=$zin; }
 146 gunzip_setup () { zcat_setup; }
 147 zmore_setup () { zcat_setup; }
 148 zless_setup () { zcat_setup; }
 149 znew_setup () { args=$bigZ_in; }
 150 zforce_setup () { zcat_setup; }
 151 zgrep_setup () { args="z $zin"; }
 152 zegrep_setup () { zgrep_setup; }
 153 zfgrep_setup () { zgrep_setup; }
 154 gzexe_setup () { args=$tmp_in; }
 155
 156 # We know that $tmp_in contains a "0"
 157 grep_setup () { args="0 $tmp_in"; }
 158 egrep_setup () { args="0 $tmp_in"; }
 159 fgrep_setup () { args="0 $tmp_in"; }
 160
 161 diff_setup () { args="$tmp_in $tmp_in2"; }
 162 sdiff_setup () { args="$tmp_in $tmp_in2"; }
 163 diff3_setup () { args="$tmp_in $tmp_in2 $tmp_in2"; }
 164 cp_setup () { args="$tmp_in $tmp_in2"; }
 165 ln_setup () { args="$tmp_in ln-target"; }
 166 ginstall_setup () { args="$tmp_in $tmp_in2"; }
 167 mv_setup () { args="$tmp_in $tmp_in2"; }
 168 mkdir_setup () { args=$tmp_dir/subdir; }
 169 realpath_setup () { args=$tmp_in; }
 170 rmdir_setup () { args=$tmp_dir; }
 171 rm_setup () { args=$tmp_in; }
 172 shred_setup () { args=$tmp_in; }
 173 touch_setup () { args=$tmp_in2; }
 174 truncate_setup () { args="--reference=$tmp_in $tmp_in2"; }
 175
 176 mkid_setup () { printf 'f(){}\ntypedef int t;\n' > f.c; args=. ; }
 177 lid_setup () { args=; }
 178 fid_setup () { args=f.c; }
 179 fnid_setup () { args=; }
 180 xtokid_setup () { args=; }
 181 aid_setup () { args=f; }
 182 eid_setup () { args=--version; }
 183 gid_setup () { args=f; }
 184 defid_setup () { args=t; }
 185
 186 basename_setup () { args=$tmp_in; }
 187 dirname_setup () { args=$tmp_in; }
 188 expr_setup () { args=foo; }
 189 basenc_setup () { args=--version; }
 190
 191 # Punt, in case GNU 'id' hasn't been installed yet.
 192 groups_setup () { args=--version; }
 193
 194 pathchk_setup () { args=$tmp_in; }
 195 yes_setup () { args=--version; }
 196 logname_setup () { args=--version; }
 197 nohup_setup () { args=--version; }
 198 printf_setup () { args=foo; }
 199 seq_setup () { args=10; }
 200 sleep_setup () { args=0; }
 201 stdbuf_setup () { args="-oL true"; }
 202 timeout_setup () { args=--version; }
 203
 204 # I'd rather not run sync, since it spins up disks that I've
 205 # deliberately caused to spin down (but not unmounted).
 206 sync_setup () { args=--version; }
 207
 208 test_setup () { args=foo; }
 209
 210 # This is necessary in the unusual event that there is
 211 # no valid entry in /etc/mtab.
 212 df_setup () { args=/; }
 213
 214 # This is necessary in the unusual event that getpwuid (getuid ()) fails.
 215 id_setup () { args=-u; }
 216
 217 # Use env to avoid invoking built-in sleep of Solaris 11's /bin/sh.
 218 kill_setup () {
 219   external=env
 220   $external sleep 10m & pid=$!
 221   args=$pid
 222 }
 223
 224 link_setup () { args="$tmp_in link-target"; }
 225 unlink_setup () { args=$tmp_in; }
 226
 227 readlink_setup () {
 228   ln -s . slink
 229   args=slink;
 230 }
 231
 232 stat_setup () { args=$tmp_in; }
 233 unlink_setup () { args=$tmp_in; }
 234 lbracket_setup () { args=": ]"; }
 235
 236 parted_setup () { args="-s $tmp_in mklabel gpt"
 237   dd if=/dev/null of=$tmp_in seek=2000; }
 238
 239 # Ensure that each program "works" (exits successfully) when doing
 240 # something more than --help or --version.
 241 for i in $built_programs; do
 242   # Skip these.
 243   case $i in chroot|stty|tty|false|chcon|runcon|coreutils) continue;; esac
 244
 245   rm -rf $tmp_in $tmp_in2 $tmp_dir $tmp_out $bigZ_in $zin $zin2
 246   echo z |gzip > $zin
 247   cp $zin $zin2
 248   cp $zin $bigZ_in
 249
 250   # This is sort of kludgey: use numbers so this is valid input for factor,
 251   # and two tokens so it's valid input for tsort.
 252   echo 2147483647 0 > $tmp_in
 253   # Make $tmp_in2 identical. Then, using $tmp_in and $tmp_in2 as arguments
 254   # to the likes of cmp and diff makes them exit successfully.
 255   cp $tmp_in $tmp_in2
 256   mkdir $tmp_dir
 257   # echo ================== $i
 258   test $i = [ && prog=lbracket || prog=$(echo $i|sed "s/$EXEEXT$//")
 259   if type ${prog}_setup > /dev/null 2>&1; then
 260     ${prog}_setup
 261   else
 262     args=
 263   fi
 264   if env $i $args < $tmp_in > $tmp_out; then
 265     : # ok
 266   else
 267     echo FAIL: $i
 268     fail=1
 269   fi
 270   rm -rf $tmp_in $tmp_in2 $tmp_out $tmp_dir
 271 done
 272
 273 Exit $fail