Archives/TheLocehiliosan_yadm
1
0
Fork 0
mirror of https://github.com/TheLocehiliosan/yadm synced 2026-03-02 03:49:29 +00:00
Code Issues Releases Wiki Activity

Refactor template handling

Browse Source 
Move common template logic out to a new template() function that calls one of
the existing template processors and then handles writing the result and
copying permissions.
This commit is contained in:
Erik Flodin
2024-12-15 15:10:02 +01:00
parent eb819782ee
commit 119d1ddbaa
8 changed files with 120 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files

193
yadm
View File

@@ -170,7 +170,7 @@ function score_file() {
local conditions="${source#*##}"
score=0
local template_cmd=""
local template_processor=""
IFS=',' read -ra fields <<<"$conditions"
for field in "${fields[@]}"; do
@@ -213,12 +213,13 @@ function score_file() {
if [ -d "$source" ]; then
INVALID_ALT+=("$source")
else
template_cmd=$(choose_template_cmd "$value")
if [ -n "$template_cmd" ]; then
template_processor=$(choose_template_processor "$value")
if [ -n "$template_processor" ]; then
delta=0
elif [ -n "$loud" ]; then
echo "No supported template processor for template $source"
else
debug "No supported template processor for template $source"
[ -n "$loud" ] && echo "No supported template processor for template $source"
fi
fi
;;
@@ -235,17 +236,17 @@ function score_file() {
score=$((score + 1000 + delta))
done
record_score "$score" "$target" "$source" "$template_cmd"
record_score "$score" "$target" "$source" "$template_processor"
}
function record_score() {
local score="$1"
local target="$2"
local source="$3"
local template_cmd="$4"
local template_processor="$4"
# record nothing if the score is zero
[ "$score" -eq 0 ] && [ -z "$template_cmd" ] && return
[ "$score" -eq 0 ] && [ -z "$template_processor" ] && return
# search for the index of this target, to see if we already are tracking it
local -i index=$((${#alt_targets[@]} - 1))
@@ -262,57 +263,94 @@ function record_score() {
alt_sources=("$source" "${alt_sources[@]}")
alt_scores=("$score" "${alt_scores[@]}")
alt_template_cmds=("$template_cmd" "${alt_template_cmds[@]}")
alt_template_processors=("$template_processor" "${alt_template_processors[@]}")
else
alt_targets+=("$target")
alt_sources+=("$source")
alt_scores+=("$score")
alt_template_cmds+=("$template_cmd")
alt_template_processors+=("$template_processor")
fi
return
fi
if [[ -n "${alt_template_cmds[$index]}" ]]; then
if [[ -z "$template_cmd" || "$score" -lt "${alt_scores[$index]}" ]]; then
# No template command, or template command but lower score
if [[ -n "${alt_template_processors[$index]}" ]]; then
if [[ -z "$template_processor" || "$score" -lt "${alt_scores[$index]}" ]]; then
# Not template, or template but lower score
return
fi
elif [[ -z "$template_cmd" && "$score" -le "${alt_scores[$index]}" ]]; then
# No template command and too low score
elif [[ -z "$template_processor" && "$score" -le "${alt_scores[$index]}" ]]; then
# Not template and too low score
return
fi
# Record new alt
alt_sources[index]="$source"
alt_scores[index]="$score"
alt_template_cmds[index]="$template_cmd"
alt_template_processors[index]="$template_processor"
}
function choose_template_cmd() {
function choose_template_processor() {
local kind="$1"
if [[ "${kind:-default}" = "default" ]]; then
awk_available && echo "template_default"
awk_available && echo "default"
elif [[ "$kind" = "esh" ]]; then
esh_available && echo "template_esh"
esh_available && echo "esh"
elif [[ "$kind" = "j2cli" || "$kind" = "j2" ]] && j2cli_available; then
echo "template_j2cli"
echo "j2cli"
elif [[ "$kind" = "envtpl" || "$kind" = "j2" ]] && envtpl_available; then
echo "template_envtpl"
echo "envtpl"
fi
}
# ****** Template Processors ******
function template_default() {
input="$1"
output="$2"
function template() {
local processor="$1"
local input="$2"
local output="$3"
local content
if ! content=$("template_$processor" "$input"); then
echo "Error: failed to process template '$input'" >&2
return
fi
if [ -r "$output" ] && [ "$content" = "$(<"$output")" ]; then
debug "Template output '$output' is unchanged"
return
fi
# If the output file already exists as read-only, change it to be writable.
# There are some environments in which a read-only file will prevent the move
# from being successful.
if [ ! -w "$output" ] && [ -e "$output" ]; then
chmod u+w "$output"
fi
if [ -n "$loud" ]; then
echo "Creating $output from template $input"
else
debug "Creating $output from template $input"
fi
local temp_file="${output}.$$.$RANDOM"
if cat >"$temp_file" <<<"$content" && mv -f "$temp_file" "$output"; then
copy_perms "$input" "$output"
else
echo "Error: failed to create template output '$output'"
rm -f "$temp_file"
fi
}
function template_default() {
local input="$1"
local awk_pgm
# the explicit "space + tab" character class used below is used because not
# all versions of awk seem to support the POSIX character classes [[:blank:]]
local awk_pgm
read -r -d '' awk_pgm <<"EOF"
BEGIN {
classes = ARGV[2]
@@ -425,8 +463,7 @@ function replace_vars(input) {
}
EOF
local content
content=$("${AWK_PROGRAM[0]}" \
"${AWK_PROGRAM[0]}" \
-v class="$local_class" \
-v arch="$local_arch" \
-v os="$local_system" \
@@ -437,17 +474,13 @@ EOF
-v source="$input" \
-v source_dir="$(builtin_dirname "$input")" \
"$awk_pgm" \
"$input" "${local_classes[@]}")
move_file "$input" "$output" "$content"
"$input" "${local_classes[@]}"
}
function template_j2cli() {
local input="$1"
local output="$2"
local content
content=$(YADM_CLASS="$local_class" \
YADM_CLASS="$local_class" \
YADM_ARCH="$local_arch" \
YADM_OS="$local_system" \
YADM_HOSTNAME="$local_host" \
@@ -456,17 +489,13 @@ function template_j2cli() {
YADM_DISTRO_FAMILY="$local_distro_family" \
YADM_SOURCE="$input" \
YADM_CLASSES="$(join_string $'\n' "${local_classes[@]}")" \
"$J2CLI_PROGRAM" "$input")
move_file "$input" "$output" "$content" "$?"
"$J2CLI_PROGRAM" "$input"
}
function template_envtpl() {
local input="$1"
local output="$2"
local content
content=$(YADM_CLASS="$local_class" \
YADM_CLASS="$local_class" \
YADM_ARCH="$local_arch" \
YADM_OS="$local_system" \
YADM_HOSTNAME="$local_host" \
@@ -475,17 +504,13 @@ function template_envtpl() {
YADM_DISTRO_FAMILY="$local_distro_family" \
YADM_SOURCE="$input" \
YADM_CLASSES="$(join_string $'\n' "${local_classes[@]}")" \
"$ENVTPL_PROGRAM" --keep-template "$input" -o -)
move_file "$input" "$output" "$content" "$?"
"$ENVTPL_PROGRAM" -o - --keep-template "$input"
}
function template_esh() {
local input="$1"
local output="$2"
local content
content=$(YADM_CLASSES="$(join_string $'\n' "${local_classes[@]}")" \
YADM_CLASSES="$(join_string $'\n' "${local_classes[@]}")" \
"$ESH_PROGRAM" "$input" \
YADM_CLASS="$local_class" \
YADM_ARCH="$local_arch" \
@@ -494,60 +519,7 @@ function template_esh() {
YADM_USER="$local_user" \
YADM_DISTRO="$local_distro" \
YADM_DISTRO_FAMILY="$local_distro_family" \
YADM_SOURCE="$input")
move_file "$input" "$output" "$content" "$?"
}
function move_file() {
local input="$1"
local output="$2"
local content="$3"
local err="${4:-}"
if [[ -s "$input" && -z "$content" ]]; then
debug "Failed to create $output from template $input: error $err"
return 1
fi
if [[ -r "$output" ]]; then
local old_content
old_content=$(< "$output")
if [[ "$old_content" == "$content" ]]; then
debug "Not rewriting file as contents have not changed: $output"
return 0
fi
# if the output files already exists as read-only, change it to be writable.
# there are some environments in which a read-only file will prevent the move
# from being successful.
if [[ ! -w "$output" ]]; then
if ! chmod u+w "$output"; then
debug "Unable to make '$output' writeable"
fi
fi
fi
if [ -n "$loud" ]; then
echo "Creating $output from template $input"
else
debug "Creating $output from template $input"
fi
local temp_file="${output}.$$.$RANDOM"
if printf '%s\n' "$content" >"$temp_file"; then
if mv -f "$temp_file" "$output"; then
copy_perms "$input" "$output"
return
fi
debug "Failed to rename '$temp_file' to '$output'"
else
debug "Failed to create '$temp_file' to generate '$output'"
fi
rm -f "$temp_file" &>/dev/null
return 1
YADM_SOURCE="$input"
}
# ****** yadm Commands ******
@@ -588,7 +560,7 @@ function alt() {
local alt_targets=()
local alt_sources=()
local alt_scores=()
local alt_template_cmds=()
local alt_template_processors=()
# For removing stale links
local possible_alt_targets=()
@@ -721,7 +693,7 @@ function alt_linking() {
for ((index = 0; index < ${#alt_targets[@]}; ++index)); do
local target="${alt_targets[$index]}"
local source="${alt_sources[$index]}"
local template_cmd="${alt_template_cmds[$index]}"
local template_processor="${alt_template_processors[$index]}"
if [[ -L "$target" ]]; then
rm -f "$target"
@@ -732,8 +704,8 @@ function alt_linking() {
assert_parent "$target"
fi
if [[ -n "$template_cmd" ]]; then
"$template_cmd" "$source" "$target"
if [[ -n "$template_processor" ]]; then
template "$template_processor" "$source" "$target"
elif [[ "$do_copy" -eq 1 ]]; then
debug "Copying $source to $target"
[[ -n "$loud" ]] && echo "Copying $source to $target"
@@ -2099,7 +2071,7 @@ function get_mode {
# only accept results if they are octal
if [[ ! $mode =~ ^[0-7]+$ ]]; then
return
return 1
fi
echo "$mode"
@@ -2107,16 +2079,13 @@ function get_mode {
function copy_perms {
local source="$1"
local dest="$2"
mode=$(get_mode "$source")
if [[ -z "$mode" ]]; then
debug "Unable to get mode for '$source'"
return 0 # to allow tests to pass
fi
if ! chmod "$mode" "$dest"; then
debug "Unable to set mode to '$mode' on '$dest'"
return 0 # to allow tests to pass
local target="$2"
local mode
if ! mode=$(get_mode "$source") || ! chmod "$mode" "$target"; then
debug "Unable to copy perms '$mode' from '$source' to '$target'"
fi
return 0
}