Home

Simplified unit test framework for shell script which produces junit-style xml results file (for Jenkins/Hudson).

Include this file into your test shellscript using . /usr/local/include/jshutest.inc (or whatever path is appropriate to find this file).

Create shell functions whose name ends with "Test" which will return

• ${jshuPASS} - (0) if the test passes
• ${jshuFAIL} - (1) if the test fails
• ${jshuERROR} - (2) if an error occured other than a test failure

The meat of the test shell function performs the test. It can do so locally (inside this shell script) or it can call external shell scripts and programs.

Standard out and standard err are captured and included in the xml result report. Also, you may define two variables inside your test function to do a regular expression search of the combined stdout/stderr. If the regular expression is found inside the captured stdout/stderr, then the test fails.

• ereg - regular expression pattern for Linux egrep(1)
• icase - either "" (don't ignore case) or "-i" (ignore case)

Inside a test shell function, you may set the shell variable jshu_errmsg to some value (typically used for error conditions to describe what happened) if you do not want the default jshu_errmsg "Error found". For example: jshu_errmsg="Script ./idontexist.sh was existed!!"

Inside a test shell function, you may say: ${jshuTEST_SKIP} if you want the test to be skipped (not passing or failing) for whatever reason. This would typically be used at the top of the function.

At the bottom of the test shell script:

##############################################################
# main
##############################################################
# initialize testsuite
jshuInit

# run unit tests in this script
jshuRunTests

# result summary
jshuFinalize

echo Done.
echo
let tot=failed+errors
exit $tot

NOTES:

• You may wish to set the jshu_pkgname variable to the name you want it to display for the "package" name at the top of the test script, otherwise it will default to the name of the directory that the test script is in (or one above it, if the current directory is named "test" or "tests").

• Junit-style XML Jenkins result files will be written to ./results. You can change the directory that the results dir is in by defining the BUILDDIR variable at the top of the script (or in the environment).

• You can use a test shell script to test functions in other shell scripts by sourcing the script to be tested as long as that script has the following if-then around the "main" (non-function) code:

    if [ ${0##*/} == "${SCRIPT_NAME}" ] ; then
        # "main" code goes here
    fi
  

  where ${SCRIPT_NAME} evaluates to the name that you use to invoke the script.

• This script relies on the proper recognition of the %N format character for the date(1) command. The version provided by CentOS 5.x is broken in that respect.