Merge 7ff657c7a5 into 30fa6f08a4

Improvements include:

1. Skip writing a temporary file if the file contents are unchanged
2. Better error reporting if templating program fails
3. Better error reporting/handling if file creation, mv, or chmod fail
4. Quiet logs by not outputing "Creating output..." line twice (debug & loud)

yadm

@@ -363,8 +363,8 @@ function choose_template_cmd() {
 function template_default() {
   input="$1"
   output="$2"
-  temp_file="${output}.$$.$RANDOM"
 
+  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:]]
   read -r -d '' awk_pgm << "EOF"
@@ -479,7 +479,9 @@ function replace_vars(input) {
 }
 EOF
 
-  "${AWK_PROGRAM[0]}" \
+  local source_dir content
+  source_dir=$(dirname "$input")
+  content=$("${AWK_PROGRAM[0]}" \
     -v class="$local_class" \
     -v arch="$local_arch" \
     -v os="$local_system" \
@@ -488,19 +490,20 @@ EOF
     -v distro="$local_distro" \
     -v distro_family="$local_distro_family" \
     -v source="$input" \
-    -v source_dir="$(dirname "$input")" \
+    -v source_dir="$source_dir" \
     "$awk_pgm" \
-    "$input" "${local_classes[@]}" > "$temp_file" || rm -f "$temp_file"
+    "$input" "${local_classes[@]}")
 
-  move_file "$input" "$output" "$temp_file"
+  move_file "$input" "$output" "$content"
 }
 
 function template_j2cli() {
-  input="$1"
-  output="$2"
-  temp_file="${output}.$$.$RANDOM"
+  local input="$1"
+  local output="$2"
+  local yadm_classes content
 
-  YADM_CLASS="$local_class"   \
+  yadm_classes=$(join_string $'\n' "${local_classes[@]}")
+  content=$(YADM_CLASS="$local_class"   \
   YADM_ARCH="$local_arch"     \
   YADM_OS="$local_system"     \
   YADM_HOSTNAME="$local_host" \
@@ -508,18 +511,20 @@ function template_j2cli() {
   YADM_DISTRO="$local_distro" \
   YADM_DISTRO_FAMILY="$local_distro_family" \
   YADM_SOURCE="$input"        \
-  YADM_CLASSES="$(join_string $'\n' "${local_classes[@]}")" \
-  "$J2CLI_PROGRAM" "$input" -o "$temp_file"
+  YADM_CLASSES="$yadm_classes" \
+  "$J2CLI_PROGRAM" "$input")
 
-  move_file "$input" "$output" "$temp_file"
+  move_file "$input" "$output" "$content" "$?"
 }
 
 function template_envtpl() {
-  input="$1"
-  output="$2"
-  temp_file="${output}.$$.$RANDOM"
+  local input="$1"
+  local output="$2"
+  local yadm_classes content
 
-  YADM_CLASS="$local_class"   \
+  yadm_classes=$(join_string $'\n' "${local_classes[@]}")
+  # shellcheck disable=SC2094
+  content=$(YADM_CLASS="$local_class"   \
   YADM_ARCH="$local_arch"     \
   YADM_OS="$local_system"     \
   YADM_HOSTNAME="$local_host" \
@@ -527,19 +532,20 @@ function template_envtpl() {
   YADM_DISTRO="$local_distro" \
   YADM_DISTRO_FAMILY="$local_distro_family" \
   YADM_SOURCE="$input"        \
-  YADM_CLASSES="$(join_string $'\n' "${local_classes[@]}")" \
-  "$ENVTPL_PROGRAM" --keep-template "$input" -o "$temp_file"
+  YADM_CLASSES="$yadm_classes" \
+  "$ENVTPL_PROGRAM" <"$input")
 
-  move_file "$input" "$output" "$temp_file"
+  move_file "$input" "$output" "$content" "$?"
 }
 
 function template_esh() {
-  input="$1"
-  output="$2"
-  temp_file="${output}.$$.$RANDOM"
+  local input="$1"
+  local output="$2"
+  local yadm_classes content
 
-  YADM_CLASSES="$(join_string $'\n' "${local_classes[@]}")" \
-  "$ESH_PROGRAM" -o "$temp_file" "$input" \
+  yadm_classes="$(join_string $'\n' "${local_classes[@]}")"
+  content=$(YADM_CLASSES="$yadm_classes" \
+  "$ESH_PROGRAM" "$input" \
   YADM_CLASS="$local_class"   \
   YADM_ARCH="$local_arch"     \
   YADM_OS="$local_system"     \
@@ -547,25 +553,60 @@ function template_esh() {
   YADM_USER="$local_user"     \
   YADM_DISTRO="$local_distro" \
   YADM_DISTRO_FAMILY="$local_distro_family" \
-  YADM_SOURCE="$input"
+  YADM_SOURCE="$input")
 
-  move_file "$input" "$output" "$temp_file"
+  move_file "$input" "$output" "$content" "$?"
 }
 
 function move_file() {
-  local input=$1
-  local output=$2
-  local temp_file=$3
+  local input="$1"
+  local output="$2"
+  local content="$3"
+  local err="${4:-}"
 
-  [ ! -f "$temp_file" ] && return
+  if [[ -s "$input" && -z "$content" ]]; then
+    debug "Failed to create $output from template $input: error $err"
+    return 1
+  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.
-  [[ -e "$output" && ! -w "$output" ]] && chmod u+w "$output"
+  if [[ -r "$output" ]]; then
+    local old_content
+    old_content=$(< "$output")
 
-  mv -f "$temp_file" "$output"
-  copy_perms "$input" "$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 Commands ******
@@ -733,8 +774,6 @@ function alt_linking() {
     template_cmd="${alt_template_cmds[$index]}"
     if [ -n "$template_cmd" ]; then
       # a template is defined, process the template
-      debug "Creating $tgt from template $src"
-      [ -n "$loud" ] && echo "Creating $tgt from template $src"
       # ensure the destination path exists
       assert_parent "$tgt"
       # remove any existing symlink before processing template
@@ -2137,7 +2176,7 @@ function get_mode {
 
   # only accept results if they are octal
   if [[ ! $mode =~ ^[0-7]+$ ]] ; then
-    mode=""
+    return
   fi
 
   echo "$mode"
@@ -2147,7 +2186,14 @@ function copy_perms {
   local source="$1"
   local dest="$2"
   mode=$(get_mode "$source")
-  [ -n "$mode" ] && chmod "$mode" "$dest"
+  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
+  fi
   return 0
 }