#!/usr/bin/bash
# Copyright (C) 2011-2017 Red Hat, Inc. All rights reserved.
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions
# of the GNU General Public License v.2.
#
# 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

initskip() {
	[[ $# -eq 0 ]] || echo "TEST SKIPPED:" "$@"
	exit 200
}

# Parse command line options
SKIP_ROOT_DM_CHECK=${SKIP_ROOT_DM_CHECK:-0}
SKIP_WITH_DEVICES_FILE=${SKIP_WITH_DEVICES_FILE:-0}
SKIP_WITH_LVMLOCKD=${SKIP_WITH_LVMLOCKD:-0}
SKIP_WITH_LVMPOLLD=${SKIP_WITH_LVMPOLLD:-0}
REQUIRE_EXTENDED=1
REQUIRE_MULTI_HOST=1
REQUIRE_IDM_FAILURE=1
REQUIRE_LOCK_TYPE_IDM=1
REQUIRE_LOCK_TYPE_DLM=1
REQUIRE_LOCK_TYPE_SANLOCK=1
while [[ "$#" -gt 0 ]]; do
	case "$1" in
		--skip-root-dm-check)
			SKIP_ROOT_DM_CHECK=1
			;;
		--skip-with-devices-file)
			SKIP_WITH_DEVICES_FILE=1
			;;
		--skip-with-lvmpolld)
			SKIP_WITH_LVMPOLLD=1
			;;
		--skip-with-lvmlockd)
			SKIP_WITH_LVMLOCKD=1
			;;
		--with-extended)
			REQUIRE_EXTENDED=${LVM_TEST_EXTENDED:-0}
			;;
		--with-multi-host)
			REQUIRE_MULTI_HOST=${LVM_TEST_MULTI_HOST:-0}
			;;
		--with-idm-failure)
			REQUIRE_IDM_FAILURE=${LVM_TEST_FAILURE:-0}
			;;
		--with-lock-type-idm)
			REQUIRE_LOCK_TYPE_IDM=${LVM_TEST_LOCK_TYPE_IDM:-0}
			;;
		--with-lock-type-dlm)
			REQUIRE_LOCK_TYPE_DLM=${LVM_TEST_LOCK_TYPE_DLM:-0}
			;;
		--with-lock-type-sanlock)
			REQUIRE_LOCK_TYPE_SANLOCK=${LVM_TEST_LOCK_TYPE_SANLOCK:-0}
			;;
		*)
			echo "Unknown option: $1"
			exit 1
			;;
	esac
	shift
done

# sanitize the environment
LANG=C
LC_ALL=C
TZ=UTC

# Put script name into variable, so it can used in external scripts
TESTNAME=${0##*/}
# Nice debug message
PS4='#${BASH_SOURCE[0]##*/}:${LINENO}+ '
export TESTNAME PS4

LVM_TEST_FLAVOUR=${LVM_TEST_FLAVOUR-ndev-vanilla}

LVM_TEST_BACKING_DEVICE=${LVM_TEST_BACKING_DEVICE-}
LVM_TEST_DEVDIR=${LVM_TEST_DEVDIR-}
LVM_TEST_NODEBUG=${LVM_TEST_NODEBUG:-0}
LVM_TEST_LVM1=${LVM_TEST_LVM1:-0}
LVM_TEST_FAILURE=${LVM_TEST_FAILURE:-0}
LVM_TEST_MULTI_HOST=${LVM_TEST_MULTI_HOST:-0}

LVM_TEST_LVMLOCKD=${LVM_TEST_LVMLOCKD:-0}
LVM_TEST_LVMLOCKD_TEST=${LVM_TEST_LVMLOCKD_TEST:-0}
LVM_TEST_LVMPOLLD=${LVM_TEST_LVMPOLLD:-0}
LVM_TEST_DEVICES_FILE=${LVM_TEST_DEVICES_FILE:-0}
LVM_TEST_EXTENDED=${LVM_TEST_EXTENDED:-0}
LVM_TEST_LOCK_TYPE_DLM=${LVM_TEST_LOCK_TYPE_DLM:-0}
LVM_TEST_LOCK_TYPE_SANLOCK=${LVM_TEST_LOCK_TYPE_SANLOCK:-0}
LVM_TEST_LOCK_TYPE_IDM=${LVM_TEST_LOCK_TYPE_IDM:-0}

SKIP_WITH_LOW_SPACE=${SKIP_WITH_LOW_SPACE-50}

[[ -n "$LVM_TEST_FLAVOUR" ]] || { echo "NOTE: Empty flavour">&2; initskip; }
[[ -f "lib/flavour-$LVM_TEST_FLAVOUR" ]] || { echo "NOTE: Flavour '$LVM_TEST_FLAVOUR' does not exist">&2; initskip; }
. "lib/flavour-$LVM_TEST_FLAVOUR"

# Re-evaluate REQUIRE_EXTENDED now that the flavour file has been sourced
[[ "$REQUIRE_EXTENDED" = 0 ]] && REQUIRE_EXTENDED=${LVM_TEST_EXTENDED:-0}

# When requested testing LVMLOCKD & LVMPOLLD - ignore skipping of marked test for lvmpolld
[[ "$LVM_TEST_LVMLOCKD" != 0 && "$LVM_TEST_LVMPOLLD" != 0 ]] && SKIP_WITH_LVMPOLLD=0

[[ "$SKIP_WITH_LVMPOLLD" != 0 && "$LVM_TEST_LVMPOLLD" != 0 ]] && initskip

[[ "$SKIP_WITH_LVMLOCKD" != 0 && "$LVM_TEST_LVMLOCKD" != 0 ]] && initskip

[[ "$SKIP_WITH_DEVICES_FILE" != 0 && "$LVM_TEST_DEVICES_FILE" != 0 ]] && initskip

[[ "$REQUIRE_EXTENDED" = 0 ]] && initskip

[[ "$REQUIRE_MULTI_HOST" = 0 ]] && initskip

[[ "$REQUIRE_IDM_FAILURE" = 0 ]] && initskip

[[ "$REQUIRE_LOCK_TYPE_IDM" = 0 ]] && initskip

[[ "$REQUIRE_LOCK_TYPE_DLM" = 0 ]] && initskip

[[ "$REQUIRE_LOCK_TYPE_SANLOCK" = 0 ]] && initskip

unset CDPATH

export LVM_TEST_BACKING_DEVICE LVM_TEST_DEVDIR LVM_TEST_NODEBUG LVM_TEST_FAILURE
export LVM_TEST_MULTI_HOST
export LVM_TEST_LVMLOCKD LVM_TEST_LVMLOCKD_TEST
export LVM_TEST_LVMPOLLD LVM_TEST_LOCK_TYPE_DLM LVM_TEST_LOCK_TYPE_SANLOCK LVM_TEST_LOCK_TYPE_IDM
export LVM_TEST_DEVICES_FILE
export LVM_TEST_EXTENDED
# grab some common utilities
. lib/utils

TESTOLDPWD=$(pwd)
COMMON_PREFIX="LVMTEST"
PREFIX="${COMMON_PREFIX}$$"

# Check we are not conflicting with some exiting setup
if [[ "$SKIP_ROOT_DM_CHECK" -eq 0 ]]; then
	# Use --mangle none: libdm unmangles every name in the reply before the
	# -S filter runs, so one stale device with an unmangleable name fails
	# the whole listing and this check would abort every test.
	d=$(dmsetup info -c -o name --noheadings --rows --mangle none -S "suspended=Suspended||name=~${PREFIX}[^0-9]")
	case "$d" in
	"No devices found") ;;
	"") ;;
	*) skip "DM table already has either suspended or $PREFIX prefixed devices: $d" ;;
	esac
fi

# TRUSTED_PATH (see scripts/fsadm.sh): same invariants as validate_path()
# there -- root-owned path components, no group/world writability unless
# the directory is sticky. This helper returns boolean; fsadm calls die.
# The scripts under test only execute root-owned binaries from a
# root-owned path, so keep the test directory below trusted parents.
safe_root_dir() {
	local dir
	local info owner mode

	dir=$(readlink -f "$1" 2>/dev/null) || return 1
	while :; do
		info=$(stat -c '%u %a' "$dir" 2>/dev/null) || return 1
		owner=${info%% *}
		mode=${info##* }
		[[ "$owner" = "0" ]] || return 1
		if (( 0$mode & 022 )) && ! (( 0$mode & 01000 )); then
			return 1
		fi
		[[ "$dir" = "/" ]] && break
		dir=${dir%/*}
		[[ -n "$dir" ]] || dir=/
	done
	return 0
}

[[ -n "$LVM_TEST_DIR" ]] || LVM_TEST_DIR=${TMPDIR:-/tmp}
[[ "$LVM_TEST_DIR" = "/dev" ]] && die "Setting LVM_TEST_DIR=/dev is not supported!"

if [[ "$(id -u)" -eq 0 ]] && ! safe_root_dir "$LVM_TEST_DIR"; then
	echo "WARNING: LVM_TEST_DIR=\"$LVM_TEST_DIR\" is not a safe root-owned directory, using /tmp." >&2
	LVM_TEST_DIR=/tmp
	safe_root_dir "$LVM_TEST_DIR" ||
		die "LVM_TEST_DIR must point into a root-owned directory."
fi

TESTDIR=$(mkdtemp "$LVM_TEST_DIR" "$PREFIX.XXXXXXXXXX") || \
	die "failed to create temporary directory in \"$LVM_TEST_DIR\""
RUNNING_DMEVENTD=$(pgrep dmeventd || true)

export TESTOLDPWD TESTDIR COMMON_PREFIX PREFIX RUNNING_DMEVENTD
LVM_LOG_FILE_EPOCH=DEBUG
LVM_LOG_FILE_MAX_LINES=${LVM_LOG_FILE_MAX_LINES-1000000}
LVM_EXPECTED_EXIT_STATUS=1
export LVM_LOG_FILE_EPOCH LVM_LOG_FILE_MAX_LINES LVM_EXPECTED_EXIT_STATUS

if [[ "$SKIP_ROOT_DM_CHECK" -eq 0 ]]; then
	# Teardown only with root
	[[ -n "$BASH" ]] && trap '{ set +vx; } 2>/dev/null; STACKTRACE; exit 1' ERR
	trap '{ set +vx; } 2>/dev/null; aux teardown' EXIT # don't forget to clean up
else
	trap 'cd "$TESTOLDPWD"; rm -rf "${TESTDIR:?}"' EXIT
fi

cd "$TESTDIR"
mkdir lib tmp

# Setting up symlink from $i to $TESTDIR/lib
# library libdevmapper-event-lvm2.so.2.03 is needed with name
[[ -n "${abs_top_builddir+varset}" ]] && \
    find "$abs_top_builddir/daemons/dmeventd/plugins/" -name '*.so*' \
    -exec ln -s -t lib "{}" +
find "$TESTOLDPWD/lib" ! \( -name '*.sh' -o -name '*.[cdo]' \
    -o -name '*~' \)  -exec ln -s -t lib "{}" +

# The scripts under test refuse to execute binaries that are not
# root-owned, while the build tree belongs to the developer.  Stage
# root-owned copies of the test wrappers and helper scripts for this
# test and point PATH and the binary overrides at them.
if [[ "$(id -u)" -eq 0 && -n "${abs_top_builddir-}" ]]; then
	LVM_TEST_BINDIR="$TESTDIR/bin"
	mkdir "$LVM_TEST_BINDIR"
	for f in "$TESTOLDPWD"/lib/lvm-wrapper "$TESTOLDPWD"/lib/dm-wrapper \
		 "$TESTOLDPWD"/lib/lvm_vdo_wrapper "$TESTOLDPWD"/lib/fsadm \
		 "$TESTOLDPWD"/lib/lvresize_fs_helper "$TESTOLDPWD"/lib/lvm_import_vdo; do
		[[ -f "$f" ]] || continue
		install -m 0755 -o root -g root "$f" "$LVM_TEST_BINDIR/${f##*/}"
	done
	# Recreate every command name (lvs, vgs, dmsetup, ...) as a copy of
	# its wrapper.  Copies keep the command name when a script resolves
	# the override path with readlink -f, while a symlink would hand the
	# wrapper its own name instead of the command name.
	for f in "$TESTOLDPWD"/lib/*; do
		[[ -L "$f" ]] || continue
		link=$(readlink -f "$f") || continue
		case "${link##*/}" in
		  lvm-wrapper|dm-wrapper|lvm_vdo_wrapper)
			install -m 0755 -o root -g root "$link" "$LVM_TEST_BINDIR/${f##*/}" ;;
		esac
	done
	PATH="$LVM_TEST_BINDIR:$PATH"
	LVM_BINARY="$LVM_TEST_BINDIR/lvm"
	DMSETUP_BINARY="$LVM_TEST_BINDIR/dmsetup"
	export LVM_TEST_BINDIR PATH LVM_BINARY DMSETUP_BINARY
fi

LD_LIBRARY_PATH="$TESTDIR/lib:$LD_LIBRARY_PATH"

DM_DEFAULT_NAME_MANGLING_MODE=none
DM_DEV_DIR="$TESTDIR/dev"
LVM_SYSTEM_DIR="$TESTDIR/etc"
TMPDIR="$TESTDIR/tmp"
# abort on the internal dm errors in the tests (allowing test user override)
DM_ABORT_ON_INTERNAL_ERRORS=${DM_ABORT_ON_INTERNAL_ERRORS:-1}
DM_DEBUG_WITH_LINE_NUMBERS=${DM_DEBUG_WITH_LINE_NUMBERS:-1}

export DM_DEFAULT_NAME_MANGLING_MODE DM_ABORT_ON_INTERNAL_ERRORS DM_DEBUG_WITH_LINE_NUMBERS
export DM_DEV_DIR LVM_SYSTEM_DIR TMPDIR
mkdir "$LVM_SYSTEM_DIR" "$DM_DEV_DIR"
MACHINEID=$(uuidgen 2>/dev/null || echo "abcdefabcdefabcdefabcdefabcdefab")
echo "${MACHINEID//-/}" > "$LVM_SYSTEM_DIR/machine-id"   # remove all '-'
if [[ -n "$LVM_TEST_DEVDIR" ]]; then
	[[ -d "$LVM_TEST_DEVDIR" ]] || die "Test device directory LVM_TEST_DEVDIR=\"$LVM_TEST_DEVDIR\" is not valid."
	DM_DEV_DIR=$LVM_TEST_DEVDIR
elif [[ "$SKIP_ROOT_DM_CHECK" -eq 0 ]]; then
	mknod "$DM_DEV_DIR/testnull" c 1 3 || die "mknod failed"
	echo >"$DM_DEV_DIR/testnull" || \
		die "Filesystem does not support devices in \"$DM_DEV_DIR\" (mounted with nodev?)"
	# dmsetup makes here needed control entry if still missing
	dmsetup version || \
		die "Dmsetup in \"$DM_DEV_DIR\" can't report version?"
fi

echo "$TESTNAME" >TESTNAME
# Require 50M of free space in testdir
[[ "$(df -k -P . | awk '/\// {print $4}')" -gt $(( SKIP_WITH_LOW_SPACE * 1024 )) ]] || \
	skip "Testing requires more than ${SKIP_WITH_LOW_SPACE}M of free space in directory $TESTDIR!\\n$(df -H | sed -e 's,^,## DF:   ,')"

echo "Kernel is $(uname -a)"
# Report SELinux mode
echo "Selinux mode is $(getenforce 2>/dev/null || echo not installed)."
free -m || true

df -h || true

# Set vars from utils now that we have TESTDIR/PREFIX/...
prepare_test_vars

# Set strict shell mode
# see: http://redsymbol.net/articles/unofficial-bash-strict-mode
[[ -n "$BASH" ]] && set -euE -o pipefail

# Vars for harness
echo "@TESTDIR=$TESTDIR"
echo "@PREFIX=$PREFIX"

# Date of executed test
echo "## DATE: $(date || true)"

# Hostname IP address
HOSTNAME=$(hostname -I 2>/dev/null || true)
HOSTNAME="$(hostname 2>/dev/null) ${HOSTNAME}" || true
echo "## HOST: $HOSTNAME"

[[ "$SKIP_ROOT_DM_CHECK" -eq 0 ]] && aux lvmconf

if [[ "$LVM_TEST_LVMPOLLD" != 0 ]]; then
	export LVM_LVMPOLLD_SOCKET="$TESTDIR/lvmpolld.socket"
	export LVM_LVMPOLLD_PIDFILE="$TESTDIR/lvmpolld.pid"
	aux prepare_lvmpolld
fi

export SHARED=""

if [[ "$LVM_TEST_LVMLOCKD" != 0 ]]; then
	[[ "$LVM_TEST_LOCK_TYPE_SANLOCK" != 0 ]] && aux lvmconf 'local/host_id = 1'
	export SHARED="--shared"
fi

# for check_lvmlockd_test, lvmlockd is restarted for each shell test.
# for check_lvmlockd_{sanlock,dlm}, lvmlockd is started once by
# aa-lvmlockd-{sanlock,dlm}-prepare.sh and left running for all shell tests.

[[ "$LVM_TEST_LVMLOCKD_TEST" != 0 ]] && aux prepare_lvmlockd

echo "<======== Processing test: \"$TESTNAME\" ========>"

set -vx
