Housekeeping

- Update README
- Run shellcheck on .sh files
- Add helper scripts
- Remove eirene vm variant
- Add post-install checklist

Signed-off-by: Nikolaos Karaolidis <nick@karaolidis.com>

hosts/common/system/configs/impermanence/scripts/start.sh

@@ -1,19 +1,19 @@
-echo "Starting impermanence mount with source: $source, target: $target, path: $path."
+echo "Starting impermanence mount with source: ${source}, target: ${target}, path: ${path}."
 
-source_current="$source"
-target_current="$target"
+source_current="${source}"
+target_current="${target}"
 
-IFS='/' read -ra path_parts <<< "$path"
+IFS='/' read -ra path_parts <<< "${path}"
 unset "path_parts[-1]"
 
 for part in "${path_parts[@]}"; do
-  source_current="$source_current/$part"
-  target_current="$target_current/$part"
+  source_current="${source_current}/${part}"
+  target_current="${target_current}/${part}"
 
-  if [ ! -d "$source_current" ]; then
+  if [[ ! -d "${source_current}" ]]; then
     break
   fi
 
-  read -r mode owner group <<< "$(stat -c '%a %u %g' "$source_current")"
-  install -d -m "$mode" -o "$owner" -g "$group" "$target_current"
+  read -r mode owner group <<< "$(stat -c '%a %u %g' "${source_current}")"
+  install -d -m "${mode}" -o "${owner}" -g "${group}" "${target_current}"
 done

hosts/common/system/configs/impermanence/scripts/stop.sh

@@ -1,38 +1,38 @@
-echo "Stopping impermanence mount with source: $source, target: $target, path: $path."
+echo "Stopping impermanence mount with source: ${source}, target: ${target}, path: ${path}."
 
-source_current="$source"
-target_current="$target"
+source_current="${source}"
+target_current="${target}"
 
-IFS='/' read -ra path_parts <<< "$path"
+IFS='/' read -ra path_parts <<< "${path}"
 unset "path_parts[-1]"
 
 for part in "${path_parts[@]}"; do
-  source_current="$source_current/$part"
-  target_current="$target_current/$part"
+  source_current="${source_current}/${part}"
+  target_current="${target_current}/${part}"
 
-  if [ ! -d "$target_current" ]; then
+  if [[ ! -d "${target_current}" ]]; then
     break
   fi
 
-  if [ -d "$source_current" ]; then
+  if [[ -d "${source_current}" ]]; then
     continue
   fi
 
-  read -r mode owner group <<< "$(stat -c '%a %u %g' "$target_current")"
-  install -d -m "$mode" -o "$owner" -g "$group" "$source_current"
+  read -r mode owner group <<< "$(stat -c '%a %u %g' "${target_current}")"
+  install -d -m "${mode}" -o "${owner}" -g "${group}" "${source_current}"
 done
 
-source=$(realpath -m "$source/$path")
-target=$(realpath -m "$target/$path")
+source=$(realpath -m "${source}/${path}")
+target=$(realpath -m "${target}/${path}")
 
-if [ ! -e "$target" ] || { [ -d "$target" ] && [ -z "$(ls -A "$target")" ]; } || { [ -f "$target" ] && [ ! -s "$target" ]; }; then
+if [[ ! -e "${target}" ]] || { [[ -d "${target}" ]] && [[ -z "$(ls -A "${target}")" ]]; } || { [[ -f "${target}" ]] && [[ ! -s "${target}" ]]; }; then
   exit 0
 fi
 
-if [ -e "$source" ]; then
-  >&2 echo "Error: Source $source already exists. Cannot move $target to $source."
+if [[ -e "${source}" ]]; then
+  >&2 echo "Error: Source ${source} already exists. Cannot move ${target} to ${source}."
   exit 1
 fi
 
-echo "Moving target $target to source $source."
-mv "$target" "$source"
+echo "Moving target ${target} to source ${source}."
+mv "${target}" "${source}"

hosts/common/system/configs/impermanence/scripts/wipe.sh

@@ -1,7 +1,7 @@
 delete_subvolume_recursively() {
   IFS=$'\n'
   for i in $(btrfs subvolume list -o "$1" | cut -f 9- -d ' '); do
-    delete_subvolume_recursively "/mnt/btrfs/$i"
+    delete_subvolume_recursively "/mnt/btrfs/${i}"
   done
   btrfs subvolume delete "$1"
 }
@@ -12,11 +12,11 @@ mount /dev/mapper/luks /mnt/btrfs
 if [[ -e /mnt/btrfs/@ ]]; then
   mkdir -p /mnt/btrfs/@.bak
   timestamp=$(date --date="@$(stat -c %Y /mnt/btrfs/@)" "+%Y-%m-%d_%H:%M:%S")
-  mv /mnt/btrfs/@ "/mnt/btrfs/@.bak/$timestamp"
+  mv /mnt/btrfs/@ "/mnt/btrfs/@.bak/${timestamp}"
 fi
 
 find /mnt/btrfs/@.bak/ -maxdepth 1 -mtime +14 | while IFS= read -r i; do
-  delete_subvolume_recursively "$i"
+  delete_subvolume_recursively "${i}"
 done
 
 btrfs subvolume create /mnt/btrfs/@

hosts/common/system/configs/timezone/timezone.sh

@@ -1,7 +1,7 @@
 case "$2" in
   connectivity-change)
     if timezone=$(curl --fail https://ipapi.co/timezone); then
-      timedatectl set-timezone "$timezone"
+      timedatectl set-timezone "${timezone}"
     fi
     ;;
 esac

hosts/common/system/scripts/cleanup/cleanup.sh

@@ -1,4 +1,4 @@
-if [ "$(id -u)" -ne 0 ]; then
+if [[ "$(id -u)" -ne 0 ]]; then
   echo "This script must be run as root or with sudo privileges."
   exit 1
 fi
@@ -6,12 +6,12 @@ fi
 delete_subvolume_recursively() {
   IFS=$'\n'
   for i in $(btrfs subvolume list -o "$1" | cut -f 9- -d ' '); do
-    delete_subvolume_recursively "/mnt/btrfs/$i"
+    delete_subvolume_recursively "/mnt/btrfs/${i}"
   done
   btrfs subvolume delete "$1"
 }
 
-if [[ -e /mnt/btrfs && $(mountpoint -q /mnt/btrfs) ]]; then
+if [[ -e /mnt/btrfs && -n $(mountpoint -q /mnt/btrfs) ]]; then
   echo "/mnt/btrfs is already mounted. Exiting."
   exit 1
 fi
@@ -20,9 +20,9 @@ mkdir -p /mnt/btrfs
 mount /dev/mapper/luks /mnt/btrfs
 
 if [[ -e /mnt/btrfs/@.bak ]]; then
-  if [ "$(ls -A /mnt/btrfs/@.bak)" ]; then
+  if [[ -n "$(ls -A /mnt/btrfs/@.bak)" ]]; then
     for i in /mnt/btrfs/@.bak/*; do
-      delete_subvolume_recursively "$i"
+      delete_subvolume_recursively "${i}"
     done
   else
     echo "/mnt/btrfs/@.bak is empty. Nothing to delete."