[LTP] [RFC] Bourne shell command library

[LTP] [RFC] Bourne shell command library

[Garrett Cooper]

The following is a proposed start for a command library that can be
used by all bourne shell scripts for executing bourne shell based
scripts / testcases, as there is a large degree of duplication in
testcases/network/{ipv6,tcp_cmds}/*, and there's no doubt a large
degree elsewhere.

The other driving motivator for this is that it would force folks to
adhere to a set standard for shell scripts, and would provide a common
set of simple routines for tracking whether or not prerequisites
exist, as well as whether or not to cleanup, report failure, find
commands, etc.

I will employ this logic in the testcases/network/{ipv6,tcp_cmds}/*
scripts, but I would really like some feedback as to whether or not
what I have is a good idea, or if I could stand more, or less
information, or whether or not this could be done in a better way...

Thanks.

(No sign-off included here because it's not in final form, yet -- will
sign off in my CVS branch space though)

#!/bin/sh
#
#    Command library that provides a boilerplate set of functions and variables
#    required for all bourne shell based scripts.
#
#    Copyright (C) 2009, Cisco Systems 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 2 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, write to the Free Software Foundation, Inc.,
#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Garrett Cooper, August 2009
#

set -u

export SHELL_DEBUG=${SHELL_DEBUG:=0}
if [ "$SHELL_DEBUG" = 1 ] ; then
    set -x
fi

#=============================================================================
# FUNCTION NAME:        cleanup
#
# FUNCTION DESCRIPTION: Clean up after a testcase.
#
# PARAMETERS:           None.
#
# RETURNS:              None.
#=============================================================================

cleanup()
{
    # To ensure set -u passes...
    TCtmp=${TCtmp:=}
    tst_resm TINFO "Cleaning up."
    # Nuke the testcase temporary directory if it exists.
    [ -d "$TCtmp" ] && rm -rf "$TCtmp"
}

#=============================================================================
# FUNCTION NAME:        end_testcase
#
# FUNCTION DESCRIPTION: Print out whether or not a test failed. Do not use
#			this when TBROK messages should be applied.
#
# PARAMETERS:           Failure message, or "" / unset if passed.
#
# RETURNS:              None.
#=============================================================================

end_testcase()
{
    cleanup
    if [ $# -eq 0 ]; then
        tst_resm TPASS "Test successful"
    else
        tst_resm TBROK "Test broken: $*"
        exit 1
    fi
}

#-----------------------------------------------------------------------
#
# FUNCTION:  exists
# PURPOSE:   Check if command(s) used by this test script exist.
#
#-----------------------------------------------------------------------

exists()
{
    for cmd in $@; do
        if ! which $cmd 2>&1 1>/dev/null; then
            end_testcase "$cmd: command not found"
            exit 1
        fi
    done
}

#-----------------------------------------------------------------------
#
# FUNCTION:  setup
# PURPOSE:   Setup the test environment.
#
#-----------------------------------------------------------------------

setup() {

    #
    # $0 is maintained by the caller script; tested on FreeBSD (ash) and
    # Gentoo GNU/Linux (bash) --
    #
    # foo.sh:
    # echo ${0##*/}
    # . ${$0%%*}/bar.sh
    # bar.sh:
    # echo ${0##*/}
    # echo $SHELL
    #
    # Gentoo:
    # gcooper@orangebox ~/Desktop $ ./foo.sh
    # foo.sh
    # foo.sh
    # /bin/bash
    # gcooper@orangebox ~/Desktop $ uname -sr
    # Linux 2.6.29-gentoo-r5
    #
    # $ ./foo.sh
    # foo.sh
    # foo.sh
    # /bin/sh
    # $ uname -sr
    # FreeBSD 8.0-BETA2
    #
    TCID=${TCID:=}
    [ -z "$TCID" ] && TCID=${0##*/}
    export TCID

    for varname in TST_COUNT TST_TOTAL; do
        if ! eval "test -z \"\$${varname}\""; then
            end_testcase "You must set ${varname} before calling setup()."
        fi
    done

    LTPROOT=${LTPROOT:="../../../../"}
    TEMPDIR=${TEMPDIR:=/tmp}
    TCtmp=${TCtmp:=$TEMPDIR/$TC$$}
    # User wants a temporary sandbox to play with.
    if [ -n "$TCtmp" ] ; then
        test -d "$TCtmp" || mkdir -p "$TCtmp"
        # Clean up on exit.
        trap cleanup EXIT
    fi

fi

------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
trial. Simplify your report design, integration and deployment - and focus on 
what you do best, core application coding. Discover what's new with 
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list

Re: [LTP] [RFC] Bourne shell command library

[Garrett Cooper]

On Sun, Aug 2, 2009 at 11:32 PM, Garrett Cooper<yanegomi@gmail.com> wrote:
> The following is a proposed start for a command library that can be
> used by all bourne shell scripts for executing bourne shell based
> scripts / testcases, as there is a large degree of duplication in
> testcases/network/{ipv6,tcp_cmds}/*, and there's no doubt a large
> degree elsewhere.
>
> The other driving motivator for this is that it would force folks to
> adhere to a set standard for shell scripts, and would provide a common
> set of simple routines for tracking whether or not prerequisites
> exist, as well as whether or not to cleanup, report failure, find
> commands, etc.
>
> I will employ this logic in the testcases/network/{ipv6,tcp_cmds}/*
> scripts, but I would really like some feedback as to whether or not
> what I have is a good idea, or if I could stand more, or less
> information, or whether or not this could be done in a better way...
>
> Thanks.
>
> (No sign-off included here because it's not in final form, yet -- will
> sign off in my CVS branch space though)

[..]

The following is a hint of what I have in store for the cmdlibs.sh
library. Phew... took a few hours to complete everything :)...

Again, I'm not signing off for anything here, because it's still
half-baked, and hasn't been fully integration tested yet, but it's
been unit tested for basic sanity and appears correct.

Integration test starting now before I go to sleep :)...

Index: testcases/lib/Makefile
===================================================================
RCS file: testcases/lib/Makefile
diff -N testcases/lib/Makefile
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ testcases/lib/Makefile	3 Aug 2009 11:35:31 -0000
@@ -0,0 +1,31 @@
+#
+#    testcases library Makefile (differs from lib/).
+#
+#    Copyright (C) 2009, Cisco Systems 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 2 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, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Garrett Cooper, August 2009
+#
+
+top_srcdir		?= ../..
+
+include $(top_srcdir)/include/mk/master_include.mk
+
+INSTALL_TARGETS		:= cmdlib.sh
+
+MAKE_TARGETS		:=
+
+$(eval $(generic_leaf_target))
Index: testcases/lib/cmdlib.sh
===================================================================
RCS file: testcases/lib/cmdlib.sh
diff -N testcases/lib/cmdlib.sh
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ testcases/lib/cmdlib.sh	3 Aug 2009 11:35:31 -0000
@@ -0,0 +1,145 @@
+#!/bin/sh
+#
+#    Command library that provides a boilerplate set of functions and variables
+#    required for all bourne shell based scripts.
+#
+#    Copyright (C) 2009, Cisco Systems 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 2 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, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Garrett Cooper, August 2009
+#
+
+set -u
+
+export SHELL_DEBUG=${SHELL_DEBUG:=0}
+if [ "$SHELL_DEBUG" = 1 ] ; then
+    set -x
+fi
+
+#=============================================================================
+# FUNCTION:   tst_cleanup
+# PURPOSE:    Clean up after a testcase.
+#=============================================================================
+tst_cleanup()
+{
+    # To ensure set -u passes...
+    TCtmp=${TCtmp:=}
+    tst_resm TINFO "Cleaning up."
+    # Nuke the testcase temporary directory if it exists.
+    [ -d "$TCtmp" ] && rm -rf "$TCtmp"
+}
+
+#=============================================================================
+# FUNCTION:  setup
+# PURPOSE:   Setup the test environment.
+#=============================================================================
+tst_setup() {
+
+    TST_COUNT=1
+    TST_TOTAL=${TST_TOTAL:=1}
+    export TCID TST_COUNT TST_TOTAL
+
+    for varname in TST_TOTAL; do
+        if eval "test -z \"\$${varname}\""; then
+            end_testcase "You must set ${varname} before calling setup()."
+        fi
+    done
+
+    LTPROOT=${LTPROOT:="../../../../"}
+    TEMPDIR=${TEMPDIR:=/tmp}
+
+    TC=${TC:=}
+    TCtmp=${TCtmp:=$TEMPDIR/$TC$$}
+    # User wants a temporary sandbox to play with.
+    if [ -n "$TCtmp" -a "$TCtmp" != "$TEMPDIR/$$" ] ; then
+        test -d "$TCtmp" || mkdir -p "$TCtmp"
+        # Clean up on exit.
+        trap tst_cleanup EXIT
+    fi
+
+}
+
+
+#=============================================================================
+# FUNCTION NAME:        end_testcase
+#
+# FUNCTION DESCRIPTION: Print out whether or not a test failed. Do not use
+#			this when TBROK messages should be applied.
+#
+# PARAMETERS:           Failure message, or "" / unset if passed.
+#
+# RETURNS:              None.
+#=============================================================================
+end_testcase()
+{
+    tst_cleanup
+    if [ $# -eq 0 ]; then
+        tst_resm TPASS "Test successful"
+    else
+        tst_resm TFAIL "Test broken: $*"
+        exit 1
+    fi
+}
+
+#=============================================================================
+# FUNCTION:  exists
+# PURPOSE:   Check if command(s) used by this test script exist.
+#=============================================================================
+exists()
+{
+    for cmd in $@; do
+        if ! which $cmd 2>&1 1>/dev/null; then
+            end_testcase "$cmd: command not found"
+            exit 1
+        fi
+    done
+}
+
+incr_tst_count()
+{
+    export TST_TOTAL=$(( $TST_TOTAL + 1 ))
+}
+
+#
+# $0 is maintained by the caller script; tested on FreeBSD (ash) and Gentoo
+# GNU/Linux (bash) -- assuming you aren't calling this from another function
+# or command:
+#
+# foo.sh:
+# echo ${0##*/}
+# . ${$0%%*}/bar.sh
+# bar.sh:
+# echo ${0##*/}
+# echo $SHELL
+#
+# Gentoo:
+# gcooper@orangebox ~/Desktop $ ./foo.sh
+# foo.sh
+# foo.sh
+# /bin/bash
+# gcooper@orangebox ~/Desktop $ uname -sr
+# Linux 2.6.29-gentoo-r5
+#
+# FreeBSD:
+# $ ./foo.sh
+# foo.sh
+# foo.sh
+# /bin/sh
+# $ uname -sr
+# FreeBSD 8.0-BETA2
+#
+TCID=${TCID:=}
+[ -z "$TCID" ] && TCID=${0##*/}

------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
trial. Simplify your report design, integration and deployment - and focus on 
what you do best, core application coding. Discover what's new with 
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list

Re: [LTP] [RFC] Bourne shell command library

[Mike Frysinger]

[-- Attachment #1.1: Type: text/plain, Size: 678 bytes --]

On Monday 03 August 2009 02:32:59 Garrett Cooper wrote:
> export SHELL_DEBUG=${SHELL_DEBUG:=0}

does this really need to be exported ?  otherwise, the simpler way to write a 
default value is:
: ${SHELL_DEBUG:=0}

there are a bunch of places this can be fixed in this file

> exists()
> {
>     for cmd in $@; do

you should always use "$@", not $@.  if you actually want $@, then you should 
use $* to keep things clear.

>         if ! which $cmd 2>&1 1>/dev/null; then

which is not portable.  use `type` or `command`.  $cmd should be quoted.

>     TCID=${TCID:=}
>     [ -z "$TCID" ] && TCID=${0##*/}

does this really need to be two lines ?
-mike

[-- Attachment #1.2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 836 bytes --]

[-- Attachment #2: Type: text/plain, Size: 355 bytes --]

------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
trial. Simplify your report design, integration and deployment - and focus on 
what you do best, core application coding. Discover what's new with 
Crystal Reports now.  http://p.sf.net/sfu/bobj-july

[-- Attachment #3: Type: text/plain, Size: 155 bytes --]

_______________________________________________
Ltp-list mailing list
Ltp-list@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/ltp-list