run.in

#!/bin/bash -
# libguestfs 'run' programs locally script
# Copyright (C) 2011-2019 Red Hat Inc.
#
# @configure_input@
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

#----------------------------------------------------------------------

# With this script you can run all the virt tools without needing to
# install them first.  You just have to do for example:
#
#   ./run virt-inspector [args ...]
#
# This works for any C program, virt tools, and most non-C bindings
# and programs in the libguestfs distribution.
#
# For lots more ways to use this script, see the libguestfs
# p2v-building(1) man page.
#
# The script should also be used for tests like this:
#
#   TESTS_ENVIRONMENT = ... $(top_builddir)/run --test
#
# The --test parameter introduces a timeout, stopping tests from
# running forever.

#----------------------------------------------------------------------

if [ "$1" = "--test" ]; then
    timeout_mode=1
    shift
fi

# Function to intelligently prepend a path to an environment variable.
# See http://stackoverflow.com/a/9631350
prepend()
{
    eval $1="$2\${$1:+:\$$1}"
}

# Source and build directories (absolute paths so this works from any
# directory).
s="$(cd @abs_srcdir@ && pwd)"
b="$(cd @abs_builddir@ && pwd)"

prepend PATH "$b"
export PATH

# virt-p2v-make-* data directory.
if [ -z "$VIRT_P2V_DATA_DIR" ]; then
    VIRT_P2V_DATA_DIR="$s"
    export VIRT_P2V_DATA_DIR
fi

# This is a cheap way to find some use-after-free and uninitialized
# read problems when using glibc.  But if we are valgrinding then
# don't use this because it can stop valgrind from working.
if [ -z "$VG" ]; then
    random_val="$(@AWK@ 'BEGIN{srand(); print 1+int(255*rand())}' < /dev/null)"
    LD_PRELOAD="${LD_PRELOAD:+"$LD_PRELOAD:"}libc_malloc_debug.so.0"
    GLIBC_TUNABLES=glibc.malloc.check=1:glibc.malloc.perturb=$random_val
    export LD_PRELOAD GLIBC_TUNABLES
fi

# Avoid GNOME keyring stupidity
export GNOME_KEYRING_CONTROL=
export GNOME_KEYRING_PID=

# Run the program.
if [ -z "$timeout_mode" ]; then
    exec "$@"
fi

# For tests (./run --test):
#  - timeout if the test takes too long to run

# Originally 1h, but that is not long enough to run the C API
# tests on Koji.
timeout_period=4h
timeout_kill=30s

# Must use the --foreground option (RHBZ#1025269).
if timeout --foreground 2 sleep 0 >/dev/null 2>&1; then
    # Does this version of timeout have the -k option?  (Not on RHEL 6)
    if timeout -k 10s 10s true >/dev/null 2>&1; then
        timeout="timeout --foreground -k $timeout_kill $timeout_period"
    fi
fi

$timeout "$@"
fail=$?
if [ "$fail" -eq 0 ]; then
    # Test successful.
    :
elif [ "$fail" -eq 77 ]; then
    # Tests return 77 to mean skipped.
    :
elif [ "$fail" -eq 124 ]; then
    # Timed out.
    echo "$b/run: command timed out after $timeout_period"
else
    # Test failed.
    echo "$b/run: command failed with exit code $fail"
fi
exit $fail