mirror of
https://github.com/troglobit/finit.git
synced 2026-10-02 05:52:48 +07:00
Joachim Wiberg
3b866c95e0
The one-liner format has grown crowded and very wide, and every new
service option makes it worse.
Add a second, block-based format, parsed with libconfuse:
service sshd {
description = "OpenSSH daemon"
runlevel = "2345"
command = "/usr/sbin/sshd -D $SSHD_OPTS"
}
Both formats keep the .conf extension and are detected per file by
content. Try-parse strictly with libconfuse; on a parse error,
re-parse leniently to tell a block file with a typo from a one-liner
file. Only a one-liner file reaches the legacy parser, a typo is
reported with its file and line.
Each block is translated to the canonical one-liner and registered
through the existing entry points, so the two formats cannot drift.
The one-liner parser is frozen at the 4.x feature set, new options
land only in the block schema. libconfuse 3.3 or later is required,
CFGF_KEYSTRVAL does not exist before it.
Covers service, task, run, sysv and tty blocks, the static directives,
and the cgroup, rlimit, set and log blocks. Templating and the
documentation rewrite are still to come.
The regression test covers translation of a service block to the
one-liner, a block-format /etc/finit.conf booting with set {} applied
at bootstrap, both formats side by side, and rejection of a typo at
block and at root level.
A rejected file must not fall through to the legacy parser, which
registers a bogus unstartable service per line. assert_num_children
cannot see that, the bogus service has no children either, so the
check is assert_num_services.
Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
395 lines
8.4 KiB
Bash
Executable File
395 lines
8.4 KiB
Bash
Executable File
#!/bin/sh
|
||
# Small framework for executing tests in a test environment.
|
||
#
|
||
# Copyright (c) 2021 Jacques de Laval <jacques@de-laval.se>
|
||
#
|
||
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||
# of this software and associated documentation files (the "Software"), to deal
|
||
# in the Software without restriction, including without limitation the rights
|
||
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||
# copies of the Software, and to permit persons to whom the Software is
|
||
# furnished to do so, subject to the following conditions:
|
||
#
|
||
# The above copyright notice and this permission notice shall be included in
|
||
# all copies or substantial portions of the Software.
|
||
#
|
||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||
# THE SOFTWARE.
|
||
|
||
assert_file_contains()
|
||
{
|
||
assert "File $1 contains the string $2" "$(texec grep "$2" "$1")"
|
||
}
|
||
|
||
assert_file_exists()
|
||
{
|
||
assert "File $1 exists" "$(texec ls "$1")"
|
||
}
|
||
|
||
assert_num_children()
|
||
{
|
||
assert "$1 services are running" "$(texec pgrep -P 1 "$2" | wc -l)" -eq "$1"
|
||
}
|
||
|
||
assert_num_services()
|
||
{
|
||
assert "$1 services are loaded" "$(texec initctl -t status "$2" | wc -l)" -eq "$1"
|
||
}
|
||
|
||
assert_forking()
|
||
{
|
||
assert "service $1 forking:$2" "$(texec initctl -j status "$1" | jq -M .forking)" = "$2"
|
||
}
|
||
|
||
assert_nopid()
|
||
{
|
||
assert "service $1 pid:0" "$(texec initctl -j status "$1" | jq -M .pid)" -eq 0
|
||
}
|
||
|
||
# shellcheck disable=SC2086
|
||
assert_new_pid()
|
||
{
|
||
assert "Finit has registered new PID" "$(texec initctl |grep $1 | awk '{print $1;}')" -eq "$(texec cat $2)"
|
||
}
|
||
|
||
assert_pidiff()
|
||
{
|
||
assert "PID has changed (old PID $2)" "$(texec initctl |awk -v svc="$1" '$0 ~ svc {print $1}')" -ne "$2"
|
||
}
|
||
|
||
assert_restarts()
|
||
{
|
||
assert "Finit has registered restarts" "$(texec initctl status "$2" | awk '/Restarts/{print $3;}')" -ge "$1"
|
||
}
|
||
|
||
assert_restart_cnt()
|
||
{
|
||
assert "Finit restart total $1 cnt $2" "$(texec initctl status "$3" | awk '/Restarts/{print $3 $4;}')" = "$1($2)"
|
||
}
|
||
|
||
assert_norestart()
|
||
{
|
||
assert "Service $1 is stable, no restarts" "$(texec initctl status "$1" | awk '/Restarts/{print $3;}')" -eq "0"
|
||
}
|
||
|
||
assert_desc()
|
||
{
|
||
assert "Service description == $1" "$(texec initctl status "$2" | grep 'Description' | sed 's/Description : //')" = "$1"
|
||
}
|
||
|
||
assert_status()
|
||
{
|
||
service=$1
|
||
status=$2
|
||
assert "Service $service $status" "$(texec initctl -p status "$service" | awk '/Status/{print $3}')" = "$status"
|
||
}
|
||
|
||
# Used by, e.g., pre-fail.sh
|
||
assert_status_full()
|
||
{
|
||
service=$1; shift
|
||
status="$*"
|
||
assert "Service $service status is: $status" "$(texec initctl -p status "$service" | awk '/Status/{sub("^ *Status : ", ""); print}')" = "$status"
|
||
}
|
||
|
||
assert_cond()
|
||
{
|
||
cond=$1
|
||
assert "Condition $cond asserted" "$(texec initctl -v cond get "$cond")" = "on"
|
||
}
|
||
|
||
assert_nocond()
|
||
{
|
||
cond=$1
|
||
assert "Condition $cond cleared" "$(texec initctl -v cond get "$cond")" = "off"
|
||
}
|
||
|
||
assert_ready()
|
||
{
|
||
srv=$1
|
||
cond="service/$srv/ready"
|
||
|
||
assert "$cond asserted" "$(texec initctl cond dump |grep "<$cond>" |awk '{print $3}')" = "on"
|
||
}
|
||
|
||
assert_is_pidfile()
|
||
{
|
||
assert "Process has PID file: $2" "$(texec initctl -p status "$1" | awk '/PID file/{print $4}')" = "$2"
|
||
}
|
||
|
||
# shellcheck disable=SC2086
|
||
assert_has_pidfile()
|
||
{
|
||
assert "Process has PID file" "$(texec find $1 2>/dev/null)"
|
||
}
|
||
|
||
# shellcheck disable=SC2154
|
||
texec()
|
||
{
|
||
"$TEST_DIR/lib/exec.sh" "$finit_pid" "$@"
|
||
}
|
||
|
||
run()
|
||
{
|
||
texec sh -c "$@"
|
||
}
|
||
|
||
pause()
|
||
{
|
||
echo "Press any key to continue... "
|
||
read -r REPLY
|
||
}
|
||
|
||
toggle_finit_debug()
|
||
{
|
||
say 'Toggle finit debug'
|
||
texec initctl debug
|
||
sleep 0.5
|
||
}
|
||
|
||
color_reset='\e[0m'
|
||
fg_red='\e[1;31m'
|
||
fg_green='\e[1;32m'
|
||
fg_yellow='\e[1;33m'
|
||
log()
|
||
{
|
||
test=$(basename "$0" ".sh")
|
||
printf "\e[2m[%s]\e[0m %b%b%b %s\n" "$test" "$1" "$2" "$color_reset" "$3"
|
||
}
|
||
|
||
sep()
|
||
{
|
||
heading=${1:-}
|
||
if [ -n "$heading" ]; then
|
||
num=$((72 - ${#heading} - 1))
|
||
printf "\e[1m%s " "$heading"
|
||
printf -- "―%.0s" $(seq 1 $num)
|
||
printf "\e[0m\n"
|
||
else
|
||
printf "\e[1m――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――\e[0m\n"
|
||
fi
|
||
}
|
||
|
||
say()
|
||
{
|
||
log "$fg_yellow" • "$@"
|
||
}
|
||
|
||
skip()
|
||
{
|
||
log "$fg_yellow" − "$*"
|
||
exit 77
|
||
}
|
||
|
||
fail()
|
||
{
|
||
log "$fg_red" ✘ "$*"
|
||
exit 99
|
||
}
|
||
|
||
# shellcheck disable=SC2068
|
||
check_dep()
|
||
{
|
||
if ! command -v "$1"; then
|
||
skip "Cannot find $1, skipping test."
|
||
fi
|
||
}
|
||
|
||
assert()
|
||
{
|
||
__assert_msg=$1
|
||
shift
|
||
|
||
if [ ! "$@" ]; then
|
||
log "$fg_red" ✘ "$__assert_msg ($*)"
|
||
return 1
|
||
fi
|
||
|
||
log "$fg_green" ✔ "$__assert_msg"
|
||
return 0
|
||
}
|
||
|
||
retry()
|
||
{
|
||
__retry_cmd=$1
|
||
shift
|
||
|
||
case "$#" in
|
||
2)
|
||
__retry_n=$1
|
||
__retry_sleep=$2
|
||
;;
|
||
1)
|
||
__retry_n=$1
|
||
__retry_sleep=0.1
|
||
;;
|
||
*)
|
||
__retry_n=50
|
||
__retry_sleep=0.1
|
||
;;
|
||
esac
|
||
|
||
for _ in $(seq 1 "$__retry_n"); do
|
||
sleep "$__retry_sleep"
|
||
__retry_cmd_out=$(eval "$__retry_cmd") && \
|
||
echo "$__retry_cmd_out" && \
|
||
return 0
|
||
done
|
||
|
||
__retry_cmd_exit="$?"
|
||
echo "$__retry_cmd_out"
|
||
|
||
return "$__retry_cmd_exit"
|
||
}
|
||
|
||
wdstart()
|
||
{
|
||
(
|
||
sleep "$1"
|
||
if ps -p "$finit_pid" > /dev/null; then
|
||
kill -9 "$finit_pid" 2>/dev/null
|
||
fi
|
||
) &
|
||
wdpid=$!
|
||
}
|
||
|
||
wdkill()
|
||
{
|
||
[ -n "${wdpid:-}" ] || return 0
|
||
|
||
say "Stopping test watchdog, pid $wdpid"
|
||
# Reap the sleep first, killing its subshell orphans it to PID 1.
|
||
pkill -KILL -P "$wdpid" 2>/dev/null || true
|
||
kill -KILL "$wdpid" 2>/dev/null || true
|
||
}
|
||
|
||
teardown()
|
||
{
|
||
test_status="$?"
|
||
|
||
echo "Test done $(date)"
|
||
wdkill
|
||
if type test_teardown > /dev/null 2>&1 ; then
|
||
test_teardown
|
||
fi
|
||
|
||
log "$color_reset" '--' ''
|
||
if [ "$test_status" -eq 0 ]; then
|
||
log "$fg_green" 'TEST PASS' ''
|
||
elif [ "$test_status" -eq 77 ]; then
|
||
log "$fg_yellow" 'TEST SKIP' ''
|
||
else
|
||
log "$fg_red" 'TEST FAIL' ''
|
||
fi
|
||
|
||
set +e
|
||
say "Telling Finit to shut down (set -$-) ..."
|
||
while [ -n "${finit_pid+x}" ]; do
|
||
if ! kill -USR2 "${finit_pid}" 2>/dev/null; then
|
||
break
|
||
fi
|
||
say "Retrying shutdown ..."
|
||
sleep 1
|
||
done
|
||
|
||
say "Waiting for Finit to shut down ..."
|
||
wait
|
||
|
||
say "Final cleanup ..."
|
||
rm -f "$SYSROOT"/running_test.pid
|
||
rm -f "$SYSROOT$FINIT_CONF"
|
||
rm -f "$SYSROOT/etc/rc.local"
|
||
|
||
say "EXIT: $test_status"
|
||
exit $test_status
|
||
}
|
||
|
||
trap teardown EXIT
|
||
|
||
SYSROOT="${SYSROOT:-$(pwd)/${TEST_DIR}/sysroot}"
|
||
export SYSROOT
|
||
|
||
TEST_TIMEOUT=300
|
||
|
||
# shellcheck source=/dev/null
|
||
. "$SYSROOT/../test.env"
|
||
|
||
# Setup test environment
|
||
if [ -n "${DEBUG:-}" ]; then
|
||
FINIT_ARGS="${FINIT_ARGS:-} finit.debug=on"
|
||
fi
|
||
|
||
# Tests may want to override runlevel
|
||
if [ -n "${FINIT_RUNLEVEL:-}" ]; then
|
||
FINIT_ARGS="${FINIT_ARGS:-} $FINIT_RUNLEVEL"
|
||
else
|
||
FINIT_RUNLEVEL=2
|
||
fi
|
||
|
||
set +u
|
||
rm -f "$SYSROOT$FINIT_CONF"
|
||
touch "$SYSROOT$FINIT_CONF"
|
||
|
||
if [ -n "$BOOTSTRAP" ]; then
|
||
say "Setting up bootstrap tasks ..."
|
||
echo "$BOOTSTRAP" >> "$SYSROOT$FINIT_CONF"
|
||
fi
|
||
|
||
if [ -n "$RUNPARTS" ]; then
|
||
say "Setting up runparts task ..."
|
||
echo "runparts /etc/rc.d" >> "$SYSROOT$FINIT_CONF"
|
||
mkdir "$SYSROOT/etc/rc.d"
|
||
echo "$RUNPARTS" > "$SYSROOT/etc/rc.d/start.sh"
|
||
chmod +x "$SYSROOT/etc/rc.d/start.sh"
|
||
fi
|
||
|
||
if [ -n "$RCLOCAL" ]; then
|
||
while [ -f "$SYSROOT/etc/rc.local" ]; do
|
||
echo "$SYSROOT/etc/rc.local busy ... waiting ..."
|
||
sleep 1
|
||
done
|
||
say "Setting up /etc/rc.local ..."
|
||
echo "$RCLOCAL" > "$SYSROOT/etc/rc.local"
|
||
chmod +x "$SYSROOT/etc/rc.local"
|
||
fi
|
||
set -u
|
||
|
||
# shellcheck disable=2086
|
||
"$TEST_DIR/lib/start.sh" finit ${FINIT_ARGS:-} &
|
||
finit_ppid=$!
|
||
echo "$finit_ppid" > "$SYSROOT"/running_test.pid
|
||
|
||
#>&2 echo "Hint: Execute 'SYSROOT=$SYSROOT $TEST_DIR/lib/enter.sh' to enter the test namespace"
|
||
log "$color_reset" 'Setup of test environment done, waiting for Finit ...' ''
|
||
|
||
finit_pid=$(retry "pgrep -P $finit_ppid")
|
||
echo "Finit running as PID $finit_pid"
|
||
#tty=/dev/$(texec cat /sys/class/tty/console/active)
|
||
#texec cat "$tty" &
|
||
|
||
sep "Test start $(date)"
|
||
|
||
# Allow Finit to start up properly before launching the test
|
||
i=0
|
||
set +u
|
||
while [ -z "$BOOTSTRAP" ] && [ $i -lt 10 ]; do
|
||
lvl=$(texec sh -c "initctl runlevel | awk '{print \$2;}'")
|
||
if [ "$lvl" = "$FINIT_RUNLEVEL" ]; then
|
||
say "Reached runlevel $FINIT_RUNLEVEL, releasing test."
|
||
break;
|
||
fi
|
||
i=$((i + 1))
|
||
sleep 1
|
||
done
|
||
set -u
|
||
|
||
if type test_setup > /dev/null 2>&1 ; then
|
||
test_setup
|
||
fi
|
||
wdstart $TEST_TIMEOUT
|