test/lib/utils.sh - manifest_repos/lvm2 - Git at Google

 #!/usr/bin/env bash
 # Copyright (C) 2011-2012 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

 set -e
 MAX_TRIES=4
 IFS_NL='
 '

 die() {
 	rm -f debug.log
 	echo -e "$@" >&2
 	return 1
 }

 rand_bytes() {
 	n=$1

 	chars="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"

 	dev_rand="/dev/urandom"
 	if test -r "$dev_rand"; then
 		# Note: 256-length($chars) == 194; 3 copies of $chars is 186 + 8 = 194.
 		head -c"$n" "$dev_rand" | tr -c "$chars" "01234567$chars$chars$chars"
 		return
 	fi

 	cmds='date; date +%N; free; who -a; w; ps auxww; ps ef; netstat -n'
 	data=$( (eval "$cmds") 2>&1 | gzip )

 	n_plus_50=$(expr $n + 50)

 	# Ensure that $data has length at least 50+$n
 	while :; do
 		len=$(echo "$data" | wc -c)
 		test $n_plus_50 -le $len && break;
 		data=$( (echo "$data"; eval "$cmds") 2>&1 | gzip )
 	done

 	echo "$data" | dd bs=1 skip=50 count=$n 2>/dev/null \
 		| tr -c "$chars" "01234567$chars$chars$chars"
 }

 mkdtemp() {
 	case $# in
 		2) ;;
 		*) die "Usage: mkdtemp DIR TEMPLATE";;
 	esac

 	destdir=$1
 	template=$2

         test -d "$destdir" || die "DIR ('$destdir') does not exist."

 	case "$template" in
 		*XXXX) ;;
 		*) die "Invalid template: $template (must have a suffix of at least 4 X's)";;
 	esac

 	fail=0

 	# First, try to use mktemp.
 	d=$(env -u TMPDIR mktemp -d -t -p "$destdir" "$template" 2>/dev/null) || fail=1

 	# The resulting name must be in the specified directory.
 	case "$d" in "${destdir}"*);; *) fail=1;; esac

 	# It must have created the directory.
 	test -d "$d" || fail=1

 	# It must have 0700 permissions.
 	perms=$(ls -dgo "$d" 2>/dev/null) || fail=1
 	case "$perms" in drwx------*) ;; *) fail=1;; esac

 	test $fail = 0 && { echo "$d"; return; }

 	# If we reach this point, we'll have to create a directory manually.

 	# Get a copy of the template without its suffix of X's.
 	base_template=$(echo "$template" | sed 's/XX*$//')

 	# Calculate how many X's we've just removed.
 	nx=$(expr length "$template" - length "$base_template")

 	err=
 	i=1
 	while :; do
 		X=$(rand_bytes "$nx")
 		candidate_dir="$destdir/$base_template$X"
 		err=$(mkdir -m 0700 "$candidate_dir" 2>&1) && \
 			{ echo "$candidate_dir"; return; }
 		test $MAX_TRIES -le $i && break;
 		i=$(expr $i + 1)
 	done
 	die "$err"
 }

 # Like grep, just always print 1st. line
 grep1_() {
 	awk -v pattern="${1}" 'NR==1 || $0~pattern' "${@:2}"
 }

 stacktrace() {
 	trap - ERR
 	local i=0

 	echo "## - $0:${BASH_LINENO[0]}"
 	while FUNC=${FUNCNAME[$i]}; test "$FUNC" != "main"; do
 		echo "## $i ${FUNC}() called from ${BASH_SOURCE[$i]}:${BASH_LINENO[$i]}"
 		i=$(($i + 1))
 	done
 }

 STACKTRACE() {
 	trap - ERR
 	local i=0

 	stacktrace

 	test "${LVM_TEST_PARALLEL:-0}" -eq 1 -o -n "$RUNNING_DMEVENTD" -o -f LOCAL_DMEVENTD || {
 		pgrep dmeventd &>/dev/null && \
 			die "ERROR: The test started dmeventd unexpectedly."
 	}

 	# Get backtraces from coredumps
 	if which gdb &>/dev/null; then
 		echo bt full > gdb_commands.txt
 		echo l >> gdb_commands.txt
 		echo quit >> gdb_commands.txt
 		for core in $(ls core* 2>/dev/null); do
 			bin=$(gdb -batch -c "$core" 2>&1 | grep "generated by" | \
 			sed -e "s,.*generated by \`\([^ ']*\).*,\1,")
 			gdb -batch -c "$core" -x gdb_commands.txt $(which "$bin")
 		done
 	fi

 	test -f SKIP_THIS_TEST && exit 200

 	test -z "$LVM_TEST_NODEBUG" -a -f TESTNAME && {
 		local name
 		local idx
 		for i in debug.log* ; do
 			test -f "$i" || break  # nothing is found (expands to debug.log*)
 			name=${i##debug.log_}
 			name=${name%%_*}
 			test "$name" = "DEBUG" && { name="$name$idx" ; idx=$(($idx + 1)) ; }
 			echo "<======== Debug log $i ========>"
 			sed -e "s,^,## $name: ," "$i"
 		done
 		if test -e strace.log ; then
 			echo "<======== Strace debug log ========>"
 			sed -e "s,^,## STRACE: ," strace.log
 		fi
 		dmsetup info -c | grep1_ "$PREFIX" > out
 		if test $(wc -l < out) -gt 1 ; then
 			echo "<======== Info ========>"
 			sed -e "s,^,## DMINFO:   ," out
 			echo "<======== Active table ========>"
 			dmsetup table | grep "$PREFIX" | sed -e "s,^,## DMTABLE:  ,"
 			echo "<======== Inactive table ========>"
 			dmsetup table --inactive  | grep "$PREFIX" | sed -e "s,^,## DMITABLE: ,"
 			echo "<======== Status ========>"
 			dmsetup status | grep "$PREFIX" | sed -e "s,^,## DMSTATUS: ,"
 			echo "<======== Tree ========>"
 			dmsetup ls --tree | sed -e "s,^,## DMTREE:   ,"
 			echo "<======== Recursive list of $DM_DEV_DIR ========>"
 			ls -Rl --hide=shm --hide=bus --hide=snd --hide=input --hide=dri \
 			       --hide=net --hide=hugepages --hide=mqueue --hide=pts \
 			       "$DM_DEV_DIR" | sed -e "s,^,## LSLR:	,"
 			echo "<======== Udev DB content ========>"
 			for i in /sys/block/dm-* /sys/block/loop* ; do
 				udevadm info --query=all --path "$i" 2>/dev/null || true
 			done | sed -e "s,^,## UDEV:	,"
 		fi
 		echo "<======== Script file \"$(< TESTNAME)\" ========>"
 		local script=$0
 		test -f "$script" || script="$TESTOLDPWD/$0"
 		awk '{print "## Line:", NR, "\t", $0}' "$script"
 	}
 }

 init_udev_transaction() {
 	if test "$DM_UDEV_SYNCHRONISATION" = 1; then
 		local cookie=$(dmsetup udevcreatecookie)
 		# Cookie is not generated if udev is not running!
 		test -z "$cookie" || export DM_UDEV_COOKIE=$cookie
 	fi
 }

 finish_udev_transaction() {
 	if test "$DM_UDEV_SYNCHRONISATION" = 1 -a -n "$DM_UDEV_COOKIE"; then
 		dmsetup udevreleasecookie
 		unset DM_UDEV_COOKIE
 	fi
 }

 teardown_udev_cookies() {
 	if test "$DM_UDEV_SYNCHRONISATION" = 1; then
 		# Delete any cookies created more than 10 minutes ago
 		# and not used in the last 10 minutes.
 		# Log only non-zero semaphores count
 		(dmsetup udevcomplete_all -y 10 | grep -v "^0 ") || true
 	fi
 }

 dm_info() {
 	should dmsetup info --noheadings -c -o "$@"
 }

 dm_table() {
 	should dmsetup table "$@"
 }

 skip() {
 	if test "$#" -eq 0; then
 		stacktrace
 	else
 		echo "TEST SKIPPED: $@"
 	fi
 	touch SKIP_THIS_TEST
 	exit 200
 }

 get_devs() {
 	local IFS=$IFS_NL
 	DEVICES=( $(<DEVICES) )
 	export DEVICES
 #	local DEVS=( $(<DEVICES) )
 #	eval "$1"'=("${DEVS[@]}")'
 }

 prepare_test_vars() {
 	vg="${PREFIX}vg"
 	lv=LV

 	for i in $(seq 1 16); do
 		name="${PREFIX}pv$i"
 		dev="$DM_DEV_DIR/mapper/$name"
 		eval "dev$i=\"$dev\""
 		eval "lv$i=LV$i"
 		eval "vg$i=${PREFIX}vg$i"
 	done
 }

 if test -z "${abs_top_builddir+varset}" && test -z "${installed_testsuite+varset}"; then
     . lib/paths || die "something went wrong -- lib/paths is missing?"
 fi

 if test -z "${installed_testsuite+varset}"; then
     case "$PATH" in
     *"$abs_top_builddir/test/lib"*) ;;
     *)
 	    PATH="$abs_top_builddir/test/lib":"$abs_top_builddir/test/api":$PATH
 	    for i in `find $abs_top_builddir -name \*.so`; do
 		    p=`dirname $i`
 		    LD_LIBRARY_PATH="$p":$LD_LIBRARY_PATH
 	    done
             export PATH LD_LIBRARY_PATH ;;
     esac
 fi

 test -z "$PREFIX" || prepare_test_vars
	#!/usr/bin/env bash
	# Copyright (C) 2011-2012 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

	set -e
	MAX_TRIES=4
	IFS_NL='
	'

	die() {
	rm -f debug.log
	echo -e "$@" >&2
	return 1
	}

	rand_bytes() {
	n=$1

	chars="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"

	dev_rand="/dev/urandom"
	if test -r "$dev_rand"; then
	# Note: 256-length($chars) == 194; 3 copies of $chars is 186 + 8 = 194.
	head -c"$n" "$dev_rand" \| tr -c "$chars" "01234567$chars$chars$chars"
	return
	fi

	cmds='date; date +%N; free; who -a; w; ps auxww; ps ef; netstat -n'
	data=$( (eval "$cmds") 2>&1 \| gzip )

	n_plus_50=$(expr $n + 50)

	# Ensure that $data has length at least 50+$n
	while :; do
	len=$(echo "$data" \| wc -c)
	test $n_plus_50 -le $len && break;
	data=$( (echo "$data"; eval "$cmds") 2>&1 \| gzip )
	done

	echo "$data" \| dd bs=1 skip=50 count=$n 2>/dev/null \
	\| tr -c "$chars" "01234567$chars$chars$chars"
	}

	mkdtemp() {
	case $# in
	2) ;;
	*) die "Usage: mkdtemp DIR TEMPLATE";;
	esac

	destdir=$1
	template=$2

	test -d "$destdir" \|\| die "DIR ('$destdir') does not exist."

	case "$template" in
	*XXXX) ;;
	*) die "Invalid template: $template (must have a suffix of at least 4 X's)";;
	esac

	fail=0

	# First, try to use mktemp.
	d=$(env -u TMPDIR mktemp -d -t -p "$destdir" "$template" 2>/dev/null) \|\| fail=1

	# The resulting name must be in the specified directory.
	case "$d" in "${destdir}");; ) fail=1;; esac

	# It must have created the directory.
	test -d "$d" \|\| fail=1

	# It must have 0700 permissions.
	perms=$(ls -dgo "$d" 2>/dev/null) \|\| fail=1
	case "$perms" in drwx------) ;; ) fail=1;; esac

	test $fail = 0 && { echo "$d"; return; }

	# If we reach this point, we'll have to create a directory manually.

	# Get a copy of the template without its suffix of X's.
	base_template=$(echo "$template" \| sed 's/XX*$//')

	# Calculate how many X's we've just removed.
	nx=$(expr length "$template" - length "$base_template")

	err=
	i=1
	while :; do
	X=$(rand_bytes "$nx")
	candidate_dir="$destdir/$base_template$X"
	err=$(mkdir -m 0700 "$candidate_dir" 2>&1) && \
	{ echo "$candidate_dir"; return; }
	test $MAX_TRIES -le $i && break;
	i=$(expr $i + 1)
	done
	die "$err"
	}

	# Like grep, just always print 1st. line
	grep1_() {
	awk -v pattern="${1}" 'NR==1 \|\| $0~pattern' "${@:2}"
	}

	stacktrace() {
	trap - ERR
	local i=0

	echo "## - $0:${BASH_LINENO[0]}"
	while FUNC=${FUNCNAME[$i]}; test "$FUNC" != "main"; do
	echo "## $i ${FUNC}() called from ${BASH_SOURCE[$i]}:${BASH_LINENO[$i]}"
	i=$(($i + 1))
	done
	}

	STACKTRACE() {
	trap - ERR
	local i=0

	stacktrace

	test "${LVM_TEST_PARALLEL:-0}" -eq 1 -o -n "$RUNNING_DMEVENTD" -o -f LOCAL_DMEVENTD \|\| {
	pgrep dmeventd &>/dev/null && \
	die "ERROR: The test started dmeventd unexpectedly."
	}

	# Get backtraces from coredumps
	if which gdb &>/dev/null; then
	echo bt full > gdb_commands.txt
	echo l >> gdb_commands.txt
	echo quit >> gdb_commands.txt
	for core in $(ls core* 2>/dev/null); do
	bin=$(gdb -batch -c "$core" 2>&1 \| grep "generated by" \| \
	sed -e "s,.generated by \`\([^ ']\).*,\1,")
	gdb -batch -c "$core" -x gdb_commands.txt $(which "$bin")
	done
	fi

	test -f SKIP_THIS_TEST && exit 200

	test -z "$LVM_TEST_NODEBUG" -a -f TESTNAME && {
	local name
	local idx
	for i in debug.log* ; do
	test -f "$i" \|\| break # nothing is found (expands to debug.log*)
	name=${i##debug.log_}
	name=${name%%_*}
	test "$name" = "DEBUG" && { name="$name$idx" ; idx=$(($idx + 1)) ; }
	echo "<======== Debug log $i ========>"
	sed -e "s,^,## $name: ," "$i"
	done
	if test -e strace.log ; then
	echo "<======== Strace debug log ========>"
	sed -e "s,^,## STRACE: ," strace.log
	fi
	dmsetup info -c \| grep1_ "$PREFIX" > out
	if test $(wc -l < out) -gt 1 ; then
	echo "<======== Info ========>"
	sed -e "s,^,## DMINFO: ," out
	echo "<======== Active table ========>"
	dmsetup table \| grep "$PREFIX" \| sed -e "s,^,## DMTABLE: ,"
	echo "<======== Inactive table ========>"
	dmsetup table --inactive \| grep "$PREFIX" \| sed -e "s,^,## DMITABLE: ,"
	echo "<======== Status ========>"
	dmsetup status \| grep "$PREFIX" \| sed -e "s,^,## DMSTATUS: ,"
	echo "<======== Tree ========>"
	dmsetup ls --tree \| sed -e "s,^,## DMTREE: ,"
	echo "<======== Recursive list of $DM_DEV_DIR ========>"
	ls -Rl --hide=shm --hide=bus --hide=snd --hide=input --hide=dri \
	--hide=net --hide=hugepages --hide=mqueue --hide=pts \
	"$DM_DEV_DIR" \| sed -e "s,^,## LSLR: ,"
	echo "<======== Udev DB content ========>"
	for i in /sys/block/dm-* /sys/block/loop* ; do
	udevadm info --query=all --path "$i" 2>/dev/null \|\| true
	done \| sed -e "s,^,## UDEV: ,"
	fi
	echo "<======== Script file \"$(< TESTNAME)\" ========>"
	local script=$0
	test -f "$script" \|\| script="$TESTOLDPWD/$0"
	awk '{print "## Line:", NR, "\t", $0}' "$script"
	}
	}

	init_udev_transaction() {
	if test "$DM_UDEV_SYNCHRONISATION" = 1; then
	local cookie=$(dmsetup udevcreatecookie)
	# Cookie is not generated if udev is not running!
	test -z "$cookie" \|\| export DM_UDEV_COOKIE=$cookie
	fi
	}

	finish_udev_transaction() {
	if test "$DM_UDEV_SYNCHRONISATION" = 1 -a -n "$DM_UDEV_COOKIE"; then
	dmsetup udevreleasecookie
	unset DM_UDEV_COOKIE
	fi
	}

	teardown_udev_cookies() {
	if test "$DM_UDEV_SYNCHRONISATION" = 1; then
	# Delete any cookies created more than 10 minutes ago
	# and not used in the last 10 minutes.
	# Log only non-zero semaphores count
	(dmsetup udevcomplete_all -y 10 \| grep -v "^0 ") \|\| true
	fi
	}

	dm_info() {
	should dmsetup info --noheadings -c -o "$@"
	}

	dm_table() {
	should dmsetup table "$@"
	}

	skip() {
	if test "$#" -eq 0; then
	stacktrace
	else
	echo "TEST SKIPPED: $@"
	fi
	touch SKIP_THIS_TEST
	exit 200
	}

	get_devs() {
	local IFS=$IFS_NL
	DEVICES=( $(<DEVICES) )
	export DEVICES
	# local DEVS=( $(<DEVICES) )
	# eval "$1"'=("${DEVS[@]}")'
	}

	prepare_test_vars() {
	vg="${PREFIX}vg"
	lv=LV

	for i in $(seq 1 16); do
	name="${PREFIX}pv$i"
	dev="$DM_DEV_DIR/mapper/$name"
	eval "dev$i=\"$dev\""
	eval "lv$i=LV$i"
	eval "vg$i=${PREFIX}vg$i"
	done
	}

	if test -z "${abs_top_builddir+varset}" && test -z "${installed_testsuite+varset}"; then
	. lib/paths \|\| die "something went wrong -- lib/paths is missing?"
	fi

	if test -z "${installed_testsuite+varset}"; then
	case "$PATH" in
	"$abs_top_builddir/test/lib") ;;
	*)
	PATH="$abs_top_builddir/test/lib":"$abs_top_builddir/test/api":$PATH
	for i in `find $abs_top_builddir -name \*.so`; do
	p=`dirname $i`
	LD_LIBRARY_PATH="$p":$LD_LIBRARY_PATH
	done
	export PATH LD_LIBRARY_PATH ;;
	esac
	fi

	test -z "$PREFIX" \|\| prepare_test_vars