Refactor: harmonize tools/addon and move boilerplate into core.func (#16202)

Author: MickLesk

.github/workflows/auto-update-app-headers.yml

@@ -299,6 +299,72 @@ root_check() {
   fi
 }
 
+# ------------------------------------------------------------------------------
+# on_pve_host()
+#
+# - Returns 0 when executed on a Proxmox VE node, 1 otherwise
+# - Cheap probe used by the guards below; never exits on its own
+# ------------------------------------------------------------------------------
+on_pve_host() {
+  command -v pveversion &>/dev/null
+}
+
+# ------------------------------------------------------------------------------
+# require_pve_host()
+#
+# - Guard for tools that drive the node itself (pct/pveam/pvesm/pvesh/qm)
+# - Aborts when not on a PVE node, then validates the PVE version
+# ------------------------------------------------------------------------------
+require_pve_host() {
+  if ! on_pve_host; then
+    msg_error "${APP:-This script} must be run on the Proxmox VE host."
+    msg_error "Proxmox tooling (pct/pveam/pvesm/qm) is not available here."
+    exit 232
+  fi
+  pve_check
+}
+
+# ------------------------------------------------------------------------------
+# confirm_not_pve_host()
+#
+# - Guard for tools that belong inside an LXC/VM but would technically run
+#   on the node as well
+# - Warns and asks for confirmation instead of hard-failing
+# ------------------------------------------------------------------------------
+confirm_not_pve_host() {
+  on_pve_host || return 0
+
+  msg_error "Running on the Proxmox VE host is NOT recommended!"
+  msg_error "${APP:-This script} is meant to be executed inside an LXC container."
+  echo ""
+  echo -n "${TAB:-  }Continue anyway? (y/N): "
+  local confirm
+  read -r confirm
+  if [[ ! "${confirm,,}" =~ ^(y|yes)$ ]]; then
+    msg_warn "Aborted. Please run this inside an LXC container."
+    exit 0
+  fi
+  msg_warn "Proceeding on the Proxmox VE host at your own risk!"
+}
+
+# ------------------------------------------------------------------------------
+# require_debian_like()
+#
+# - Guard for addons that have no Alpine code path
+# - Aborts early instead of failing halfway through with apt/systemd errors
+# ------------------------------------------------------------------------------
+require_debian_like() {
+  if is_alpine; then
+    msg_error "${APP:-This script} does not support Alpine Linux."
+    msg_error "Please use a Debian or Ubuntu based LXC container."
+    exit 238
+  fi
+  if ! command -v apt-get &>/dev/null; then
+    msg_error "${APP:-This script} requires a Debian or Ubuntu based system."
+    exit 238
+  fi
+}
+
 # ------------------------------------------------------------------------------
 # pve_check()
 #
@@ -308,6 +374,10 @@ root_check() {
 # ------------------------------------------------------------------------------
 pve_check() {
   local PVE_VER
+  if ! on_pve_host; then
+    msg_error "${APP:-This script} must be run on the Proxmox VE host."
+    exit 232
+  fi
   PVE_VER="$(pveversion | awk -F'/' '{print $2}' | awk -F'-' '{print $1}')"
 
   # Check for Proxmox VE 8.x: allow 8.0–8.9

.github/workflows/scripts/generate-app-headers.sh

@@ -4628,6 +4628,53 @@ _docker_is_noninteractive() {
   [[ "${DOCKER_NONINTERACTIVE:-}" == "1" || "${DOCKER_NONINTERACTIVE:-}" == "true" || "${DOCKER_NONINTERACTIVE:-}" == "TRUE" ]] || [[ ! -t 0 ]]
 }
 
+# ------------------------------------------------------------------------------
+# ensure_docker()
+#
+# - Docker precondition for addon scripts that ship a compose stack
+# - Reuses an existing installation, otherwise offers to install Docker
+#   (Debian/Ubuntu via setup_docker, Alpine via apk)
+# - Aborts when the user declines or Compose is unavailable afterwards
+# ------------------------------------------------------------------------------
+ensure_docker() {
+  if command -v docker &>/dev/null; then
+    msg_ok "Docker $(docker --version | cut -d' ' -f3 | tr -d ',') is available"
+    if docker compose version &>/dev/null; then
+      msg_ok "Docker Compose is available"
+      return 0
+    fi
+    msg_error "Docker Compose plugin is not available. Please install it."
+    exit 237
+  fi
+
+  msg_warn "Docker is not installed."
+  echo -n "${TAB:-  }Install Docker now? (y/N): "
+  local install_docker_prompt
+  read -r install_docker_prompt
+  if [[ ! "${install_docker_prompt,,}" =~ ^(y|yes)$ ]]; then
+    msg_error "Docker is required for ${APP:-this script}. Exiting."
+    exit 254
+  fi
+
+  if is_alpine; then
+    msg_info "Installing Docker"
+    $STD apk add --no-cache docker docker-cli-compose
+    $STD rc-update add docker default
+    $STD rc-service docker start
+    msg_ok "Installed Docker"
+  else
+    setup_docker || {
+      msg_error "Docker installation failed."
+      exit 237
+    }
+  fi
+
+  if ! command -v docker &>/dev/null || ! docker compose version &>/dev/null; then
+    msg_error "Docker or the Compose plugin is still unavailable after installation."
+    exit 237
+  fi
+}
+
 setup_docker() {
   local docker_installed=false
   local USE_DOCKER_REPO="${USE_DOCKER_REPO:-true}"

misc/core.func

@@ -7,8 +7,13 @@
 
 if ! command -v curl &>/dev/null; then
   printf "\r\e[2K%b" '\033[93m Setup Source \033[m' >&2
-  apt-get update >/dev/null 2>&1
-  apt-get install -y curl >/dev/null 2>&1
+  if [[ -f /etc/alpine-release ]]; then
+    apk update >/dev/null 2>&1
+    apk add --no-cache curl >/dev/null 2>&1
+  else
+    apt-get update >/dev/null 2>&1
+    apt-get install -y curl >/dev/null 2>&1
+  fi
 fi
 source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/core.func)
 source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/tools.func)
@@ -20,6 +25,7 @@ declare -f init_tool_telemetry &>/dev/null && init_tool_telemetry "actual-budget
 set -Eeuo pipefail
 trap 'error_handler' ERR
 load_functions
+require_debian_like
 
 # ==============================================================================
 # CONFIGURATION
@@ -31,14 +37,6 @@ INSTALL_PATH="/opt/actual-budget-prometheus-exporter"
 CONFIG_PATH="/opt/actual-budget-prometheus-exporter.env"
 SERVICE_PATH="/etc/systemd/system/actual-budget-prometheus-exporter.service"
 
-# ==============================================================================
-# OS DETECTION
-# ==============================================================================
-if ! grep -qE 'ID=debian|ID=ubuntu' /etc/os-release 2>/dev/null; then
-  echo -e "${CROSS} Unsupported OS detected. This script only supports Debian and Ubuntu."
-  exit 238
-fi
-
 # ==============================================================================
 # UNINSTALL
 # ==============================================================================

misc/tools.func

@@ -6,39 +6,45 @@
 # License: MIT | https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
 # Source: https://netbird.io/ | Github: https://github.com/netbirdio/netbird
 
-function header_info {
-  clear
-  cat <<"EOF"
-    _   __     __  ____  _          __
-   / | / /__  / /_/ __ )(_)________/ /
-  /  |/ / _ \/ __/ __  / / ___/ __  / 
- / /|  /  __/ /_/ /_/ / / /  / /_/ / 
-/_/ |_/\___/\__/_____/_/_/   \__,_/  
+APP="add-netbird-lxc"
+APP_TYPE="addon"
 
-EOF
-}
-header_info
-set -e
-
-# Telemetry
+if ! command -v curl &>/dev/null; then
+  printf "\r\e[2K%b" '\033[93m Setup Source \033[m' >&2
+  if [[ -f /etc/alpine-release ]]; then
+    apk update >/dev/null 2>&1
+    apk add --no-cache curl >/dev/null 2>&1
+  else
+    apt-get update >/dev/null 2>&1
+    apt-get install -y curl >/dev/null 2>&1
+  fi
+fi
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/core.func)
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/tools.func)
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/error_handler.func)
 source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/api.func) 2>/dev/null || true
 declare -f init_tool_telemetry &>/dev/null && init_tool_telemetry "add-netbird-lxc" "addon"
 
+# Enable error handling
+set -Eeuo pipefail
+trap 'error_handler' ERR
+
+# Initialize all core functions (colors, formatting, icons, STD mode)
+load_functions
+
+header_info
+require_pve_host
+
 while true; do
-  read -p "This will add NetBird to an existing LXC Container ONLY. Proceed(y/n)?" yn
+  read -r -p "This will add NetBird to an existing LXC Container ONLY. Proceed(y/n)? " yn
   case $yn in
   [Yy]*) break ;;
-  [Nn]*) exit ;;
+  [Nn]*) exit 0 ;;
   *) echo "Please answer yes or no." ;;
   esac
 done
-header_info
-echo "Loading..."
 
-function msg() {
-  local TEXT="$1"
-  echo -e "$TEXT"
-}
+echo -e "Loading container list..."
 
 NODE=$(hostname)
 MSG_MAX_LENGTH=0
@@ -61,37 +67,51 @@ done
 
 LXC_STATUS=$(pct status "$CTID" | awk '{print $2}')
 if [[ "$LXC_STATUS" != "running" ]]; then
-  msg "\e[1;33m The container $CTID is not running. Starting it now...\e[0m"
+  msg_info "Container $CTID is not running. Starting it now..."
   pct start "$CTID"
   while [[ "$(pct status "$CTID" | awk '{print $2}')" != "running" ]]; do
-    msg "\e[1;33m Waiting for the container to start...\e[0m"
+    msg_info "Waiting for the container to start..."
     sleep 2
   done
-  msg "\e[1;32m Container $CTID is now running.\e[0m"
+  msg_ok "Container $CTID is now running."
 fi
 
 DISTRO=$(pct exec "$CTID" -- cat /etc/os-release | grep -w "ID" | cut -d'=' -f2 | tr -d '"')
 if [[ "$DISTRO" != "debian" && "$DISTRO" != "ubuntu" ]]; then
-  msg "\e[1;31m Error: This script only supports Debian or Ubuntu LXC containers. Detected: $DISTRO. Aborting...\e[0m"
+  msg_error "This script only supports Debian or Ubuntu LXC containers. Detected: $DISTRO. Aborting..."
   exit 238
 fi
 
-CTID_CONFIG_PATH=/etc/pve/lxc/${CTID}.conf
-cat <<EOF >>$CTID_CONFIG_PATH
+CTID_CONFIG_PATH="/etc/pve/lxc/${CTID}.conf"
+cat <<EOF >>"$CTID_CONFIG_PATH"
 lxc.cgroup2.devices.allow: c 10:200 rwm
 lxc.mount.entry: /dev/net/tun dev/net/tun none bind,create=file
 EOF
-header_info
-msg "Installing NetBird..."
+
+msg_info "Installing NetBird"
 pct exec "$CTID" -- bash -c '
+set -e
 if ! command -v curl &>/dev/null; then
   apt-get update -qq
   apt-get install -y curl >/dev/null
 fi
-apt install -y ca-certificates gpg &>/dev/null
-curl -fsSL "https://pkgs.netbird.io/debian/public.key" | gpg --dearmor >/usr/share/keyrings/netbird-archive-keyring.gpg
-echo "deb [signed-by=/usr/share/keyrings/netbird-archive-keyring.gpg] https://pkgs.netbird.io/debian stable main" >/etc/apt/sources.list.d/netbird.list
-apt-get update &>/dev/null
+apt-get install -y ca-certificates gpg &>/dev/null
+
+# Reuse the shared repository helper instead of hand-rolling the sources entry
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/core.func)
+source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/misc/tools.func)
+load_functions
+
+# Drop the legacy keyring from the pre-deb822 layout
+rm -f /usr/share/keyrings/netbird-archive-keyring.gpg
+
+setup_deb822_repo \
+  "netbird" \
+  "https://pkgs.netbird.io/debian/public.key" \
+  "https://pkgs.netbird.io/debian" \
+  "stable" \
+  "main"
+
 apt-get install -y netbird-ui &>/dev/null
 if systemctl list-unit-files docker.service &>/dev/null; then
   mkdir -p /etc/systemd/system/netbird.service.d
@@ -103,6 +123,5 @@ OVERRIDE
   systemctl daemon-reload
 fi
 '
-msg "\e[1;32m ✔ Installed NetBird.\e[0m"
-sleep 2
-msg "\e[1;31m Reboot ${CTID} LXC to apply the changes, then run netbird up in the LXC console\e[0m"
+msg_ok "Installed NetBird."
+echo -e "${YW}Reboot ${CTID} LXC${CL} to apply the changes, then run 'netbird up' in the LXC console"