strongswan/testing/scripts/function.sh
Tobias Brunner 3615e907f5 testing: Improve replacing IP addresses in test files
There are a lot of files without patterns and running them all through
sed is quite slow.  Using grep first makes this quicker (about 0.5s per
test).  Ignoring PEM files is also helpful.
2024-12-03 08:43:45 +01:00

200 lines
4.1 KiB
Bash
Executable File

#!/bin/bash
# provides some general-purpose script functions
#
# Copyright (C) 2004 Eric Marchionni, Patrik Rayo
# Zuercher Hochschule Winterthur
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; either version 2 of the License, or (at your
# option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
#
# This program 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 General Public License
# for more details.
export TERM=xterm
RED=$(tput setaf 1)
GREEN=$(tput setaf 2)
YELLOW=$(tput setaf 3)
NORMAL=$(tput op)
# exit with given error message
# $1 - error message
die() {
echo -e "${RED}$1${NORMAL}"
exit 1
}
# execute command
# $1 - command to execute
# $2 - whether or not to log command exit status
# (0 -> disable exit status logging)
execute()
{
cmd=${1}
echo $cmd >>$LOGFILE 2>&1
$cmd >>$LOGFILE 2>&1
status=$?
[ "$2" != 0 ] && log_status $status
if [ $status != 0 ]; then
echo
echo "! Command $cmd failed, exiting (status $status)"
echo "! Check why here $LOGFILE"
exit 1
fi
}
# execute command in chroot
# $1 - command to execute
execute_chroot()
{
execute "chroot $LOOPDIR env PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin $@"
}
# write green status message to console
# $1 - msg
echo_ok()
{
echo -e "${GREEN}$1${NORMAL}"
}
# write red status message to console
# $1 - msg
echo_failed()
{
echo -e "${RED}$1${NORMAL}"
}
# write yellow status message to console
# $1 - msg
echo_warn()
{
echo -e "${YELLOW}$1${NORMAL}"
}
# log an action
# $1 - current action description
log_action()
{
/bin/echo -n "[....] $1 "
}
# log an action status
# $1 - exit status of action
log_status()
{
tput hpa 0
if [ $1 -eq 0 ]; then
/bin/echo -ne "[${GREEN} ok ${NORMAL}"
else
/bin/echo -ne "[${RED}FAIL${NORMAL}"
fi
echo
}
# the following two functions are stolen from [1]
# [1] - http://www.linuxjournal.com/content/use-bash-trap-statement-cleanup-temporary-files
declare -a on_exit_items
# perform registered actions on exit
on_exit()
{
for ((onex=${#on_exit_items[@]}-1; onex>=0; onex--))
do
echo "On_Exit: ${on_exit_items[$onex]}" >>$LOGFILE
${on_exit_items[$onex]} >>$LOGFILE 2>&1
done
on_exit_items=""
trap - EXIT
}
# register a command to execute when the calling script terminates. The
# registered commands are called in FILO order.
# $* - command to register
do_on_exit()
{
local n=${#on_exit_items[*]}
on_exit_items[$n]="$*"
if [ $n -eq 0 ]; then
trap on_exit EXIT
fi
}
# wait for a mount to disappear
# $1 - device/image to wait for
# $2 - maximum time to wait in seconds, default is 5 seconds
graceful_umount()
{
secs=$2
[ ! $secs ] && secs=5
let steps=$secs*100
for st in `seq 1 $steps`
do
umount $1 >>$LOGFILE 2>&1
mount | grep $1 >/dev/null 2>&1
[ $? -eq 0 ] || return 0
sleep 0.01
done
return 1
}
# load qemu NBD kernel module, if not already loaded
load_qemu_nbd()
{
lsmod | grep ^nbd[[:space:]]* >/dev/null 2>&1
if [ $? != 0 ]
then
log_action "Loading NBD kernel module"
execute "modprobe nbd max_part=16"
fi
}
# check if given commands exist in $PATH
# $* - commands to check
check_commands()
{
for i in $*
do
command -v $i >/dev/null || { die "Required command $i not found"; exit 1; }
done
}
# check if any of the given virtual guests are running
# $* - names of guests to check
running_any()
{
command -v virsh >/dev/null || return 1
for host in $*
do
virsh list --name 2>/dev/null | grep "^$host$" >/dev/null && return 0
done
return 1
}
#############################################
# search and replace strings throughout a
# whole directory
#
function searchandreplace {
SEARCHSTRING="$1"
REPLACESTRING="$2"
DESTDIR="$3"
[ -d "$DESTDIR" ] || die "$DESTDIR is not a directory!"
###########################################
# search and replace in each found file the
# given string
#
grep -rlZ --exclude='*.pem' "$SEARCHSTRING" $DESTDIR | \
xargs -0 -I@ sed -i -e "s/$SEARCHSTRING/$REPLACESTRING/g" @
}