pedro/cdist
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[type/__hostname] Lint

Browse source 
- Error if expected environment variables are unset
- Always wrap variable expansions in {}
This commit is contained in:
Dennis Camera 2020-11-11 14:09:26 +01:00
parent ba90651052
commit 3e48ef9e11
2 changed files with 114 additions and 115 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
cdist/conf/type/__hostname/gencode-remote
View file

@ -20,25 +20,26 @@
# along with cdist. If not, see <http://www.gnu.org/licenses/>. # along with cdist. If not, see <http://www.gnu.org/licenses/>.
# #
os=$(cat "$__global/explorer/os") os=$(cat "${__global:?}/explorer/os")
name_running=$(cat "$__global/explorer/hostname") name_running=$(cat "${__global:?}/explorer/hostname")
has_hostnamectl=$(cat "$__object/explorer/has_hostnamectl") has_hostnamectl=$(cat "${__object:?}/explorer/has_hostnamectl")
if test -s "$__object/parameter/name" if test -s "${__object:?}/parameter/name"
then then
name_should=$(cat "$__object/parameter/name") name_should=$(cat "${__object:?}/parameter/name")
else else
case $os case ${os}
in in
# RedHat-derivatives and BSDs # RedHat-derivatives and BSDs
centos|fedora|redhat|scientific|freebsd|macosx|netbsd|openbsd) (centos|fedora|redhat|scientific|freebsd|macosx|netbsd|openbsd)
# Hostname is FQDN # Hostname is FQDN
name_should="${__target_host}" name_should=${__target_host:?}
;; ;;
*) (*)
# Hostname is only first component of FQDN # Hostname is only first component of FQDN
name_should="${__target_host%%.*}" name_should=${__target_host:?}
name_should=${name_should%%.*}
;; ;;
esac esac
fi fi
@ -47,46 +48,46 @@ fi
################################################################################ ################################################################################
# Check if the (running) hostname is already correct # Check if the (running) hostname is already correct
# #
test "$name_running" != "$name_should" || exit 0 test "${name_running}" != "${name_should}" || exit 0
################################################################################ ################################################################################
# Setup hostname # Setup hostname
# #
echo 'changed' >>"$__messages_out" echo 'changed' >>"${__messages_out:?}"
# Use the good old way to set the hostname. # Use the good old way to set the hostname.
case $os case ${os}
in in
alpine|debian|devuan|ubuntu) (alpine|debian|devuan|ubuntu)
echo 'hostname -F /etc/hostname' echo 'hostname -F /etc/hostname'
;; ;;
archlinux) (archlinux)
echo 'command -v hostnamectl >/dev/null 2>&1' \ echo 'command -v hostnamectl >/dev/null 2>&1' \
"&& hostnamectl set-hostname '$name_should'" \ "&& hostnamectl set-hostname '${name_should}'" \
"|| hostname '$name_should'" "|| hostname '${name_should}'"
;; ;;
centos|fedora|redhat|scientific|freebsd|netbsd|openbsd|gentoo|void) (centos|fedora|redhat|scientific|freebsd|netbsd|openbsd|gentoo|void)
echo "hostname '$name_should'" echo "hostname '${name_should}'"
;; ;;
openwrt) (openwrt)
echo "echo '$name_should' >/proc/sys/kernel/hostname" echo "echo '${name_should}' >/proc/sys/kernel/hostname"
;; ;;
macosx) (macosx)
echo "scutil --set HostName '$name_should'" echo "scutil --set HostName '${name_should}'"
;; ;;
solaris) (solaris)
echo "uname -S '$name_should'" echo "uname -S '${name_should}'"
;; ;;
slackware|suse|opensuse-leap) (slackware|suse|opensuse-leap)
# We do not read from /etc/HOSTNAME, because the running # We do not read from /etc/HOSTNAME, because the running
# hostname is the first component only while the file contains # hostname is the first component only while the file contains
# the FQDN. # the FQDN.
echo "hostname '$name_should'" echo "hostname '${name_should}'"
;; ;;
*) (*)
# Fall back to set the hostname using hostnamectl, if available. # Fall back to set the hostname using hostnamectl, if available.
if test -n "$has_hostnamectl" if test -n "${has_hostnamectl}"
then then
# Don't use hostnamectl as the primary means to set the hostname for # Don't use hostnamectl as the primary means to set the hostname for
# systemd systems, because it cannot be trusted to work reliably and # systemd systems, because it cannot be trusted to work reliably and
@ -97,7 +98,8 @@ in
echo "test \"\$(hostname)\" = \"\$(cat /etc/hostname)\"" \ echo "test \"\$(hostname)\" = \"\$(cat /etc/hostname)\"" \
" || hostname -F /etc/hostname" " || hostname -F /etc/hostname"
else else
printf "echo 'Unsupported OS: %s' >&2\nexit 1\n" "$os" printf "echo 'Unsupported OS: %s' >&2\n" "${os}"
printf 'exit 1\n'
fi fi
;; ;;
esac esac

117
cdist/conf/type/__hostname/manifest
View file

@ -20,69 +20,65 @@
# along with cdist. If not, see <http://www.gnu.org/licenses/>. # along with cdist. If not, see <http://www.gnu.org/licenses/>.
# #
not_supported() {
echo "Your operating system ($os) is currently not supported by this type (${__type##*/})." >&2
echo "Please contribute an implementation for it if you can." >&2
exit 1
}
set_hostname_systemd() { set_hostname_systemd() {
echo "$1" | __file /etc/hostname --source - echo "$1" | __file /etc/hostname --source -
} }
os=$(cat "$__global/explorer/os") os=$(cat "${__global:?}/explorer/os")
os_version=$(cat "$__global/explorer/os_version") os_version=$(cat "${__global:?}/explorer/os_version")
os_major=$(echo "$os_version" | grep -o '^[0-9][0-9]*' || true) os_major=$(echo "${os_version}" | grep -o '^[0-9][0-9]*' || true)
max_len=$(cat "$__object/explorer/max_len") max_len=$(cat "${__object:?}/explorer/max_len")
has_hostnamectl=$(cat "$__object/explorer/has_hostnamectl") has_hostnamectl=$(cat "${__object:?}/explorer/has_hostnamectl")
if test -s "$__object/parameter/name" if test -s "${__object:?}/parameter/name"
then then
name_should=$(cat "$__object/parameter/name") name_should=$(cat "${__object:?}/parameter/name")
else else
case $os case ${os}
in in
# RedHat-derivatives and BSDs # RedHat-derivatives and BSDs
centos|fedora|redhat|scientific|freebsd|netbsd|openbsd|slackware) (centos|fedora|redhat|scientific|freebsd|netbsd|openbsd|slackware)
# Hostname is FQDN # Hostname is FQDN
name_should="${__target_host}" name_should=${__target_host:?}
;; ;;
suse|opensuse-leap) (suse|opensuse-leap)
name_should=${__target_host:?}
# Classic SuSE stores the FQDN in /etc/HOSTNAME, while # Classic SuSE stores the FQDN in /etc/HOSTNAME, while
# systemd does not. The running hostname is the first # systemd does not. The running hostname is the first
# component in both cases. # component in both cases.
# In versions before 15.x, the FQDN is stored in /etc/hostname. # In versions before 15.x, the FQDN is stored in /etc/hostname.
if test -n "$has_hostnamectl" && test "$os_major" -ge 15 \ if test -n "${has_hostnamectl}" \
&& test "$os_major" -ne 42 && test "${os_major}" -ge 15 \
&& test "${os_major}" -ne 42
then then
name_should="${__target_host%%.*}" name_should=${name_should%%.*}
else
name_should="${__target_host}"
fi fi
;; ;;
*) *)
# Hostname is only first component of FQDN on all other systems. # Hostname is only first component of FQDN on all other systems.
name_should="${__target_host%%.*}" name_should=${__target_host:?}
name_should=${name_should%%.*}
;; ;;
esac esac
fi fi
if test -n "$max_len" && test "$(printf '%s' "$name_should" | wc -c)" -gt "$max_len" if test -n "${max_len}" && test "$(printf '%s' "${name_should}" | wc -c)" -gt "${max_len}"
then then
printf "Host name too long. Up to %u characters allowed.\n" "${max_len}" >&2 printf "Host name too long. Up to %u characters allowed.\n" "${max_len}" >&2
exit 1 exit 1
fi fi
case $os case ${os}
in in
alpine|debian|devuan|ubuntu|void) (alpine|debian|devuan|ubuntu|void)
echo "$name_should" | __file /etc/hostname --source - echo "${name_should}" | __file /etc/hostname --source -
;; ;;
archlinux) (archlinux)
if test -n "$has_hostnamectl" if test -n "${has_hostnamectl}"
then then
set_hostname_systemd "$name_should" set_hostname_systemd "${name_should}"
else else
echo 'Ancient ArchLinux variants without hostnamectl are not supported.' >&2 echo 'Ancient ArchLinux variants without hostnamectl are not supported.' >&2
exit 1 exit 1
@ -97,8 +93,8 @@ in
# --value "\"$name_should\"" # --value "\"$name_should\""
fi fi
;; ;;
centos|fedora|redhat|scientific) (centos|fedora|redhat|scientific)
if test -z "$has_hostnamectl" if test -z "${has_hostnamectl}"
then then
# Only write to /etc/sysconfig/network on non-systemd versions. # Only write to /etc/sysconfig/network on non-systemd versions.
# On systemd-based versions this entry is ignored. # On systemd-based versions this entry is ignored.
@ -106,63 +102,62 @@ in
--file /etc/sysconfig/network \ --file /etc/sysconfig/network \
--delimiter '=' --exact_delimiter \ --delimiter '=' --exact_delimiter \
--key HOSTNAME \ --key HOSTNAME \
--value "\"$name_should\"" --value "\"${name_should}\""
else else
set_hostname_systemd "$name_should" set_hostname_systemd "${name_should}"
fi fi
;; ;;
gentoo) (gentoo)
# Only write to /etc/conf.d/hostname on OpenRC-based installations. # Only write to /etc/conf.d/hostname on OpenRC-based installations.
# On systemd use hostnamectl(1) in gencode-remote. # On systemd use hostnamectl(1) in gencode-remote.
if test -z "$has_hostnamectl" if test -z "${has_hostnamectl}"
then then
__key_value '/etc/conf.d/hostname:hostname' \ __key_value '/etc/conf.d/hostname:hostname' \
--file /etc/conf.d/hostname \ --file /etc/conf.d/hostname \
--delimiter '=' --exact_delimiter \ --delimiter '=' --exact_delimiter \
--key 'hostname' \ --key 'hostname' \
--value "\"$name_should\"" --value "\"${name_should}\""
else else
set_hostname_systemd "$name_should" set_hostname_systemd "$name_should"
fi fi
;; ;;
freebsd) (freebsd)
__key_value '/etc/rc.conf:hostname' \ __key_value '/etc/rc.conf:hostname' \
--file /etc/rc.conf \ --file /etc/rc.conf \
--delimiter '=' --exact_delimiter \ --delimiter '=' --exact_delimiter \
--key 'hostname' \ --key 'hostname' \
--value "\"$name_should\"" --value "\"${name_should}\""
;; ;;
macosx) (macosx)
# handled in gencode-remote # handled in gencode-remote
:
;; ;;
netbsd) (netbsd)
__key_value '/etc/rc.conf:hostname' \ __key_value '/etc/rc.conf:hostname' \
--file /etc/rc.conf \ --file /etc/rc.conf \
--delimiter '=' --exact_delimiter \ --delimiter '=' --exact_delimiter \
--key 'hostname' \ --key 'hostname' \
--value "\"$name_should\"" --value "\"${name_should}\""
# To avoid confusion, ensure that the hostname is only stored once. # To avoid confusion, ensure that the hostname is only stored once.
__file /etc/myname --state absent __file /etc/myname --state absent
;; ;;
openbsd) (openbsd)
echo "$name_should" | __file /etc/myname --source - echo "${name_should}" | __file /etc/myname --source -
;; ;;
openwrt) (openwrt)
__uci system.@system[0].hostname --value "$name_should" __uci system.@system[0].hostname --value "${name_should}"
# --transaction hostname # --transaction hostname
;; ;;
slackware) (slackware)
# We write the FQDN into /etc/HOSTNAME. But /etc/rc.d/rc.M will only # We write the FQDN into /etc/HOSTNAME. But /etc/rc.d/rc.M will only
# read the first component from this file and set it as the running # read the first component from this file and set it as the running
# hostname on boot. # hostname on boot.
echo "$name_should" | __file /etc/HOSTNAME --source - echo "${name_should}" | __file /etc/HOSTNAME --source -
;; ;;
solaris) (solaris)
echo "$name_should" | __file /etc/nodename --source - echo "${name_should}" | __file /etc/nodename --source -
;; ;;
suse|opensuse-leap) (suse|opensuse-leap)
# Modern SuSE provides /etc/HOSTNAME as a symlink for # Modern SuSE provides /etc/HOSTNAME as a symlink for
# backwards-compatibility. Unfortunately it cannot be used # backwards-compatibility. Unfortunately it cannot be used
# here as __file does not follow the symlink. # here as __file does not follow the symlink.
@ -171,23 +166,25 @@ in
# not work correctly on openSUSE 12.x which provides # not work correctly on openSUSE 12.x which provides
# hostnamectl but not /etc/hostname. # hostnamectl but not /etc/hostname.
if test -n "$has_hostnamectl" -a "$os_major" -gt 12 if test -n "${has_hostnamectl}" -a "${os_major}" -gt 12
then then
hostname_file='/etc/hostname' hostname_file=/etc/hostname
else else
hostname_file='/etc/HOSTNAME' hostname_file=/etc/HOSTNAME
fi fi
echo "$name_should" | __file "$hostname_file" --source - echo "${name_should}" | __file "${hostname_file}" --source -
;; ;;
*) (*)
# On other operating systems we fall back to systemd's # On other operating systems we fall back to systemd's
# hostnamectl if available… # hostnamectl if available…
if test -n "$has_hostnamectl" if test -n "${has_hostnamectl}"
then then
set_hostname_systemd "$name_should" set_hostname_systemd "${name_should}"
else else
not_supported echo "Your operating system (${os}) is currently not supported by this type (${__type##*/})." >&2
echo "Please contribute an implementation for it if you can." >&2
exit 1
fi fi
;; ;;
esac esac