Files
finit/test/conf-format.sh
Joachim Wiberg ecac1e58e3 conf: make cgroup delegate and leaf name first-class keys
parse_cgroup() takes two arguments that are not cgroupfs files: the
leaf directory to place the service in, and whether to hand the subtree
over to it.  The block format could express neither.  'name' happened
to work, because a free-form key is emitted as name:VALUE and that is
what the parser looks for, but 'delegate' came out as delegate:true and
was filed as a cgroup setting, so it silently did nothing.

Declare both, and emit delegate as the bare flag the parser expects.
Neither means anything on a top-level group definition, so say so there
rather than emitting something that would be written to cgroupfs.

    service podman {
        cgroup containers { name = "podman"  delegate = true }
        ...
    }

Signed-off-by: Joachim Wiberg <troglobit@gmail.com>
2026-07-30 15:21:30 +02:00

277 lines
12 KiB
Bash
Executable File

#!/bin/sh
# Verify the new libconfuse config format: block -> legacy translation,
# per-file format detection (legacy files keep working alongside), and
# that a typo in a new-format file is rejected with an error instead of
# being fed to the legacy parser.
set -eu
TEST_DIR=$(dirname "$0")
# shellcheck disable=SC2034
# A /etc/finit.conf entirely in the new format, seeded before Finit
# boots. Mixing the two formats in one file is not supported, so the
# probe that reads the variable back is a block too.
BOOTSTRAP="environment {\n\
CONF_FORMAT_VAR = \"blockfmt\"\n\
}\n\
run envprobe {\n\
runlevel = \"S\"\n\
description = \"Probe\"\n\
command = \"/bin/touch /tmp/envprobe-\$CONF_FORMAT_VAR\"\n\
}"
test_teardown()
{
say "Running test teardown."
run "rm -f $FINIT_CONF /tmp/envprobe-* /tmp/pre /run/blockfmt.pid /run/notmine.pid"
run "rm -f $FINIT_RCSD/legacy-side.conf"
}
# Write a service block, $1 is the description key, to exercise both
# the canonical spelling and a typo. $2, if given, is prepended as a
# root-level line.
write_svc()
{
run "echo '${2:-}service service.sh {' > $FINIT_CONF"
run "echo ' $1 = \"Test service\"' >> $FINIT_CONF"
run "echo ' command = \"service.sh\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
}
# shellcheck source=/dev/null
. "$TEST_DIR/lib/setup.sh"
say 'A new-format /etc/finit.conf booted the system, environment {} applied'
retry 'assert_file_exists /tmp/envprobe-blockfmt'
# Reaching runlevel 2 reloads the .conf files, and conf_reset_env()
# clears every tracked variable first. Gating environment {} on
# bootstrap would therefore drop it here, which is what serv -e
# catches: it exits unless the variable still holds the value.
say 'Global env survives the runlevel change and a reload, via the env {} alias'
run "echo 'env {' > $FINIT_CONF"
run "echo ' CONF_FORMAT_VAR = \"blockfmt\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "echo 'service serv {' >> $FINIT_CONF"
run "echo ' description = \"Verify env\"' >> $FINIT_CONF"
run "echo ' command = \"serv -np -e CONF_FORMAT_VAR:blockfmt\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "initctl reload"
retry 'assert_num_children 1 serv'
assert_desc "Verify env" serv
say "Add new-format service block in $FINIT_CONF"
run "echo 'service service.sh {' > $FINIT_CONF"
run "echo ' description = \"Test service\"' >> $FINIT_CONF"
run "echo ' runlevel = \"2345\"' >> $FINIT_CONF"
run "echo ' stop-timeout = 20' >> $FINIT_CONF"
run "echo ' log { }' >> $FINIT_CONF"
# Exercises the cgroup translation path. Whether the group is really
# joined cannot be asserted here, cgroup_avail() is false inside the
# test namespace, so initctl reports no cgroup at all.
run "echo ' cgroup user {}' >> $FINIT_CONF"
run "echo ' command = \"service.sh\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
say 'Reload Finit'
run "initctl reload"
retry 'assert_num_children 1 service.sh'
assert_desc "Test service" service.sh
say 'Stop the service'
run "initctl stop service.sh"
retry 'assert_num_children 0 service.sh'
say 'Start the service again'
run "initctl start service.sh"
retry 'assert_num_children 1 service.sh'
say 'Both formats side by side: legacy file in finit.d/, block file in finit.conf'
run "echo 'task [2345] name:legacyside /bin/touch /tmp/legacyside -- Legacy side' > $FINIT_RCSD/legacy-side.conf"
run "initctl reload"
retry 'assert_file_exists /tmp/legacyside'
retry 'assert_num_children 1 service.sh'
assert_desc "Legacy side" legacyside
run "rm -f $FINIT_RCSD/legacy-side.conf /tmp/legacyside"
run "initctl reload"
say 'Round-trip: switch to the legacy one-liner equivalent'
run "echo 'service [2345] name:service.sh kill:20 log service.sh -- Test service' > $FINIT_CONF"
run "initctl reload"
retry 'assert_num_children 1 service.sh'
assert_desc "Test service" service.sh
# A rejected file must not reach the legacy parser, which registers a
# bogus unstartable service per line. assert_num_children cannot see
# that, the bogus service has no children either.
say 'Typo inside a block must be rejected, not fed to legacy parser'
write_svc descriptoin
run "initctl reload"
retry 'assert_num_children 0 service.sh'
assert_num_services 0 service.sh
say 'Typo at root level must be rejected too, same as inside a block'
write_svc description 'hostnam = \"typo\"\n'
run "initctl reload"
retry 'assert_num_children 0 service.sh'
assert_num_services 0 service.sh
say 'A clean new-format file still loads after the rejected ones'
write_svc description
run "initctl reload"
retry 'assert_num_children 1 service.sh'
assert_desc "Test service" service.sh
# The renamed and split settings each have translation logic behind
# them, so exercise the ones with a visible effect.
# Only the warning differs, service_register() bails before svc_new()
# either way, so this asserts the stanza is skipped, not that the
# warning was suppressed. The emitted one-liner is where nowarn is
# visible, with finit.debug=on.
say 'A leading - on command tolerates a missing binary'
run "echo 'service ghost {' > $FINIT_CONF"
run "echo ' description = \"Ghost\"' >> $FINIT_CONF"
run "echo ' command = \"-/no/such/binary\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "initctl reload"
assert_num_services 0 ghost
say 'exec-start-pre runs before the service, pidfile-create makes Finit own the file'
run "echo 'service service.sh {' > $FINIT_CONF"
run "echo ' description = \"Test service\"' >> $FINIT_CONF"
run "echo ' conditions = { \"hook/svc/up\" }' >> $FINIT_CONF"
run "echo ' exec-start-pre = \"/bin/pre.sh\"' >> $FINIT_CONF"
run "echo ' exec-start-pre-timeout = 5' >> $FINIT_CONF"
run "echo ' pidfile = \"/run/blockfmt.pid\"' >> $FINIT_CONF"
run "echo ' pidfile-create = true' >> $FINIT_CONF"
run "echo ' restart = true' >> $FINIT_CONF"
run "echo ' restart-max = 3' >> $FINIT_CONF"
run "echo ' command = \"service.sh\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "initctl reload"
retry 'assert_num_children 1 service.sh'
retry 'assert_file_exists /tmp/pre'
assert_restart_cnt 0 "0/3" service.sh
# service.sh writes /run/service.pid, never /run/blockfmt.pid, so only
# Finit can have created this one. assert_is_pidfile cannot tell, it
# prints the path with any leading ! stripped.
retry 'assert_file_exists /run/blockfmt.pid'
say 'Without pidfile-create the daemon owns the file, Finit does not make it'
run "echo 'service service.sh {' > $FINIT_CONF"
run "echo ' description = \"Test service\"' >> $FINIT_CONF"
run "echo ' pidfile = \"/run/notmine.pid\"' >> $FINIT_CONF"
run "echo ' command = \"service.sh\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "rm -f /run/notmine.pid"
run "initctl reload"
retry 'assert_num_children 1 service.sh'
assert "daemon-owned pidfile is not created by Finit" \
"$(texec ls /run/notmine.pid 2>/dev/null)" = ""
say 'reload-signal = none emits the legacy noreload flag'
run "echo 'service service.sh {' > $FINIT_CONF"
run "echo ' description = \"Test service\"' >> $FINIT_CONF"
run "echo ' reload-signal = \"none\"' >> $FINIT_CONF"
run "echo ' command = \"service.sh\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "initctl reload"
retry 'assert_num_children 1 service.sh'
assert_desc "Test service" service.sh
say 'Case and short forms of SIGHUP are all the default, no flag'
for s in SIGHUP sighup HUP hup; do
run "echo 'service service.sh {' > $FINIT_CONF"
run "echo ' description = \"Test service\"' >> $FINIT_CONF"
run "echo \" reload-signal = '$s'\" >> $FINIT_CONF"
run "echo ' command = \"service.sh\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "initctl reload"
retry 'assert_num_children 1 service.sh'
done
# 'required' and 'reload-signal' both translate to the legacy ! that
# leads the condition list, but each is valid only for the block types
# where that ! carries its meaning.
say 'required = false on a task does not hold up bootstrap'
run "echo 'task pwrfail {' > $FINIT_CONF"
run "echo ' description = \"Power failure\"' >> $FINIT_CONF"
run "echo ' conditions = { \"sys/pwr/fail\" }' >> $FINIT_CONF"
run "echo ' required = false' >> $FINIT_CONF"
run "echo ' command = \"/bin/true\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "initctl reload"
retry 'assert_desc "Power failure" pwrfail'
# remain-after-exit keeps a completed task in the service list, so it
# is still visible and can be stopped. The alias must reach the same
# legacy token.
for key in remain-after-exit remain; do
say "$key keeps a completed task visible"
run "echo 'task setup {' > $FINIT_CONF"
run "echo ' description = \"Setup task\"' >> $FINIT_CONF"
run "echo ' runlevel = \"2345\"' >> $FINIT_CONF"
run "echo \" $key = true\" >> $FINIT_CONF"
run "echo ' command = \"/bin/true\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "initctl reload"
retry 'assert_desc "Setup task" setup'
done
# manual-start registers the service but does not start it, so both
# spellings must reach the legacy manual:yes token.
for key in manual-start manual; do
say "$key leaves the service stopped until asked"
run "echo 'service service.sh {' > $FINIT_CONF"
run "echo ' description = \"Manual service\"' >> $FINIT_CONF"
run "echo \" $key = true\" >> $FINIT_CONF"
run "echo ' command = \"service.sh\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "initctl reload"
retry 'assert_desc "Manual service" service.sh'
assert_num_children 0 service.sh
run "initctl start service.sh"
retry 'assert_num_children 1 service.sh'
# a started service survives the next reload, so clear it before
# the alias pass repeats the "stopped until asked" check
run "initctl stop service.sh"
retry 'assert_num_children 0 service.sh'
done
# delegate is a flag to parse_cgroup(), not a cgroupfs file, and the
# cgroup leaf name is an argument too. Both must come out of the
# translator in the comma-separated form that parser expects.
say 'cgroup delegate and name translate as parse_cgroup arguments'
run "echo 'service service.sh {' > $FINIT_CONF"
run "echo ' description = \"Delegated\"' >> $FINIT_CONF"
run "echo ' cgroup system {' >> $FINIT_CONF"
run "echo ' name = \"mysvc\"' >> $FINIT_CONF"
run "echo ' delegate = true' >> $FINIT_CONF"
run "echo ' cpu.weight = 250' >> $FINIT_CONF"
run "echo ' }' >> $FINIT_CONF"
run "echo ' command = \"service.sh\"' >> $FINIT_CONF"
run "echo '}' >> $FINIT_CONF"
run "initctl reload"
retry 'assert_desc "Delegated" service.sh'