Subject: [PATCH] tests: get rid of obsolete 'error_' shell function
From: Stefano Lattarini <[email-masked]>
To: [email-masked]
Date: Thu, 4 Aug 2011 10:52:26 +0200
List-Id: <debbugs-submit.debbugs.gnu.org>

$ cd ~/src/coreutils
 $ grep -I -r --exclude-dir=.git '\berror_\b' .
 ./tests/shell-or-perl:error_ ()
 ./tests/shell-or-perl:  test $# -gt 1 || error_ "option '\''$1'\'' requires an argument"
 ./tests/shell-or-perl:    -*) error_ "unknown option '$1'";;
 ./tests/shell-or-perl:  0) error_ "missing argument";;
 ./tests/shell-or-perl:  || error_ "test script '$test_script' does not exist, or isn't readable"
 ./tests/shell-or-perl:  || error_ "cannot read from the test script '$test_script'"
 ./tests/shell-or-perl:error_ "dead code reached"
 ./tests/init.cfg:# FIXME: eventually s/error_/fail_/ and remove the definition of error_ below.
 ./tests/init.cfg:    error_ "Error running getlimits"
 ./tests/init.cfg:error_() { echo "$0: $@" 1>&2; Exit 1; }
 ./tests/init.cfg:framework_failure() { error_ 'failure in testing framework'; }

So, time to remove dead code, right? :-)

What about the attached patch?

Regards,
  Stefano
From ddc9db5fb98069066f3fb2160be433fa7a2a5d44 Mon Sep 17 00:00:00 2001
Message-Id: <ddc9db5fb[email-masked]>
From: Stefano Lattarini <[email-masked]>
Date: Thu, 4 Aug 2011 10:48:38 +0200
Subject: [PATCH] tests: get rid of obsolete 'error_' shell function

* tests/init.cfg (framework_failure, getlimits_): Use 'fatal_'
instead of 'error_'.
(error_): Delete, it's not used anymore (and one is anyway
advised to use 'fatal_' instead).
Update heading comments.
* tests/shell-or-perl (error_): Renamed ...
(fatal_): ... to this, for consistency.  Also, add a useful
comment.
---
 tests/init.cfg      |   10 ++++------
 tests/shell-or-perl |   16 +++++++++-------
 2 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/tests/init.cfg b/tests/init.cfg
index 1b8f870..60c5108 100644
--- a/tests/init.cfg
+++ b/tests/init.cfg
@@ -4,8 +4,8 @@
 # TESTS_ENVIRONMENT definition.
 stderr_fileno_=9
 
-# FIXME: eventually s/error_/fail_/ and remove the definition of error_ below.
-# FIXME: s/(framework_failure)\>/${1}_/ and remove def. of framework_failure
+# FIXME: eventually, FIXME: s/(framework_failure)\>/${1}_/ and remove the
+# FIXME: definition of framework_failure below
 
 # Having an unsearchable directory in PATH causes execve to fail with EACCES
 # when applied to an unresolvable program name, contrary to the desired ENOENT.
@@ -37,8 +37,7 @@ sanitize_path_()
 getlimits_()
 {
   eval $(getlimits)
-  test "$INT_MAX" ||
-    error_ "Error running getlimits"
+  test "$INT_MAX" || fatal_ "running getlimits"
 }
 
 require_acl_()
@@ -266,8 +265,7 @@ require_root_()
 }
 
 skip_if_root_() { uid_is_privileged_ && skip_ "must be run as non-root"; }
-error_() { echo "$0: $@" 1>&2; Exit 1; }
-framework_failure() { error_ 'failure in testing framework'; }
+framework_failure() { fatal_ 'failure in testing framework'; }
 
 # Set `groups' to a space-separated list of at least two groups
 # of which the user is a member.
diff --git a/tests/shell-or-perl b/tests/shell-or-perl
index accb37a..489c112 100644
--- a/tests/shell-or-perl
+++ b/tests/shell-or-perl
@@ -28,9 +28,11 @@ set -u
 
 me=shell-or-perl
 
-error_ ()
+fatal_ ()
 {
   echo "$me: $*" >&2
+  # Exit with status `99' to inform the testsuite harness that an
+  # hard error occurred.
   exit 99
 }
 
@@ -47,7 +49,7 @@ EOH
 # ---------------- #
 
 assign_optarg_to_var='
-  test $# -gt 1 || error_ "option '\''$1'\'' requires an argument"
+  test $# -gt 1 || fatal_ "option '\''$1'\'' requires an argument"
   eval "$var=\$2"
   shift'
 
@@ -64,7 +66,7 @@ while test $# -gt 0; do
     --srcdir) var=srcdir;;
     --test-name) var=test_name;;
     --) shift; break;;
-    -*) error_ "unknown option '$1'";;
+    -*) fatal_ "unknown option '$1'";;
     *) break;;
   esac
   test -z "$var" || eval "$assign_optarg_to_var"
@@ -74,7 +76,7 @@ done
 unset assign_optarg_to_var var
 
 case $# in
-  0) error_ "missing argument";;
+  0) fatal_ "missing argument";;
   *) test_script=$1; shift;;
 esac
 
@@ -85,10 +87,10 @@ test -z "$test_name" && test_name=$test_script
 # --------------------- #
 
 test -f "$test_script" && test -r "$test_script" \
-  || error_ "test script '$test_script' does not exist, or isn't readable"
+  || fatal_ "test script '$test_script' does not exist, or isn't readable"
 
 read shebang_line < "$test_script" \
-  || error_ "cannot read from the test script '$test_script'"
+  || fatal_ "cannot read from the test script '$test_script'"
 
 case $shebang_line in
 '#!/usr/bin/perl'*)
@@ -116,4 +118,4 @@ esac
 #  Not reached  #
 # ------------- #
 
-error_ "dead code reached"
+fatal_ "dead code reached"
-- 
1.7.2.3