assert.sh

#
# asserts.
#
#  assert_fails    COMMAND        -- assert that command fails
#  assert_succeeds COMMAND        -- assert that command succeeds
#  assert_equals   VALUE VALUE    -- check that values are equal
#
#  assert_grep     REGEXP FILE    -- check that FILE matches REGEXP
#  assert_grepv    REGEXP FILE    -- check that FILE doesn't match REGEXP
#
#  assert_exists   NAMES...       -- check that all NAMES are existing file names
#

bashfoo_require run

source_log_error()
{
    SCRIPT_NAME="${BASH_SOURCE[2]}:${BASH_LINENO[1]}" log_error "$@"
}

source_log_info()
{
    SCRIPT_NAME="${BASH_SOURCE[2]}:${BASH_LINENO[1]}" log_info "$@"
}
assert_fails()
{
    "$@"
    local r=$?
    if [ "$r" = 0 ] ; then
        source_log_error "expected '$@' to fail, but it succeeded (exit_code=$r)"
        exit 1
    else
        source_log_info "success: $@ failed (exit_code=$r) as expected"
    fi
}

assert_succeeds()
{
    "$@"
    local r=$?
    if [ "$r" != 0 ] ; then
        source_log_error "expected '$@' to succeed, but it failed (exit_code=$r)"
        exit 1
    else
        source_log_info "success: $@ succeeded as expected"
    fi
}

assert_variable_present()
{
    local val=`eval echo \\${$1}`
    if [ -z "$val" ] ; then
        source_log_error "variable setting '$1' is missing $2"
        exit 1
    else
        source_log_info "variable $1 value: $val"
    fi
}

assert_equals()
{
    local expected="$1"
    local actual="$2"
    
    if [ "$expected" != "$actual" ] ; then
        source_log_error "expected '$expected', but actual value is '$actual'"
        exit 1
    fi
}

assert_files_equal()
{
    local expected="$1"
    local actual="$2"
    if ! quiet_if_success -q diff -u "$expected" "$actual" ; then
        source_log_error "file '$actual'(+) is different from '$expected'(-), diff above"
        exit 1
    fi
}

show_file()
{
    source_log_info "contents of '$1' after last command ($last_command)"
    egrep -H "^" $1 >&2
}

assert_grep() {
    egrep -q "$@" || {
        source_log_error "expected '$1' in '$2' not found"
        show_file $2
        exit 1
    }
}

assert_grepv() {
    
    egrep -qv "$@" || {
        source_log_error "not expected '$1' found in $2"
        show_file $2
        exit 1
    }
}

assert_exists() {
    local r=0
    for f in "$@" ; do 
        if ! test -f $f ; then
            source_log_error "expected file '$f' doesn't exist"
            r=1
        fi
    done
    if [ "$r" = 1 ] ; then
        exit 1
    fi
}