(maint) Clarify difference between package version and os versions

...by prefixing the os related globals with 'os_'. Also changes
set_platform() to set_platform_globals() and has it set os_family as
well. Makes setting of the platform global variables little more linear,
and simplifies a bit of the defensive set global calls in the common.sh.

Author: jpartlow

files/common.sh

@@ -171,80 +171,81 @@ translate_codename_to_version() {
   esac
 }
 
-# Set platform, full_version and major_version variables by reaching
-# out to the puppetlabs-facts bash task as an executable.
-set_platform() {
-  local facts="${installdir}/facts/tasks/bash.sh"
-  if [ -e "${facts}" ]; then
-    platform=$(bash "${facts}" platform)
-    full_version=$(bash "${facts}" release)
-    if [[ "${full_version}" == "n/a" ]]; then
-      # Hit the facts json with blunt objects until the codename value
-      # pops out...
-      codename=$(bash "${facts}" | grep '"codename"' | cut -d':' -f2 | grep -oE '[^ "]+')
-      full_version=$(translate_codename_to_version "${codename}")
-    fi
-    major_version=${full_version%%.*}
-  else
-    fail "Unable to find the puppetlabs-facts bash task to determine platform at '${facts}'."
-  fi
-  export platform # quiets shellcheck SC2034
-  assigned 'platform'
-  export full_version # quiets shellcheck SC2034
-  assigned 'full_version'
-  export major_version # quiets shellcheck SC2034
-  assigned 'major_version'
-}
-
-# Set the OS family variable based on the platform.
-set_family() {
+# Set the $os_family variable based on the platform.
+set_os_family() {
   local _platform="${1:-${platform}}"
 
-  if [[ -z "${_platform}" ]]; then
-    set_platform
-    _platform="${platform}"
-  fi
-
   # Downcase the platform so as to avoid case issues.
   case ${_platform,,} in
     amazon)
-      family='amazon'
+      os_family='amazon'
       ;;
     rhel|redhat|centos|scientific|oraclelinux|rocky|almalinux)
-      family='el'
+      os_family='el'
       ;;
     fedora)
-      family='fedora'
+      os_family='fedora'
       ;;
     sles|suse)
-      family='sles'
+      os_family='sles'
       ;;
     debian)
-      family='debian'
+      os_family='debian'
       ;;
     ubuntu)
-      family='ubuntu'
+      os_family='ubuntu'
       ;;
     *)
       fail "Unhandled platform: '${_platform}'"
       ;;
   esac
-  export family # quiets shellcheck SC2034
-  assigned 'family'
+  export os_family # quiets shellcheck SC2034
+  assigned 'os_family'
+}
+
+# Read local OS facts by reaching out to the puppetlabs-facts bash
+# task as an executable, then set these globals:
+#   $platform
+#   $os_full_version
+#   $os_major_version
+#   $os_family
+set_platform_globals() {
+  local facts="${installdir}/facts/tasks/bash.sh"
+  if [ -e "${facts}" ]; then
+    platform=$(bash "${facts}" platform)
+    os_full_version=$(bash "${facts}" release)
+    if [[ "${os_full_version}" == "n/a" ]]; then
+      # Hit the facts json with blunt objects until the codename value
+      # pops out...
+      codename=$(bash "${facts}" | grep '"codename"' | cut -d':' -f2 | grep -oE '[^ "]+')
+      os_full_version=$(translate_codename_to_version "${codename}")
+    fi
+    os_major_version=${os_full_version%%.*}
+  else
+    fail "Unable to find the puppetlabs-facts bash task to determine platform at '${facts}'."
+  fi
+  export platform # quiets shellcheck SC2034
+  assigned 'platform'
+  export os_full_version # quiets shellcheck SC2034
+  assigned 'os_full_version'
+  export os_major_version # quiets shellcheck SC2034
+  assigned 'os_major_version'
+
+  set_os_family "${platform}"
 }
 
-# Based on platform family set:
+# Based on platform os_family set:
 #  package_type - rpm or deb or...
 #  package_file_suffix - the file extension for the release package name
 set_package_type() {
-  local _family="${1:-${family}}"
+  local _os_family="${1:-${os_family}}"
 
-  if [[ -z "${_family}" ]]; then
-    set_family "${platform}"
-    _family="${family}"
+  if [[ -z "${_os_family}" ]]; then
+    set_platform_globals
+    _os_family="${os_family}"
   fi
 
-  case $_family in
+  case $_os_family in
     amazon|fedora|el|sles)
       package_type='rpm'
       package_file_suffix='noarch.rpm'
@@ -265,8 +266,8 @@ set_package_type() {
 # since this could be called multiple times for different packages.
 get_deb_package_version() {
   local _version="$1"
-  local _family="${2:-${family}}"
-  local _full_version="${3-${full_version}}"
+  local _os_family="${2:-${os_family}}"
+  local _os_full_version="${3-${os_full_version}}"
 
   # Need the full packaging version for deb.
   # As an example, for openvox-agent 8.14.0 on ubuntu 24.04:
@@ -277,7 +278,7 @@ get_deb_package_version() {
     # full package version string.
     _package_version="${_version}"
   else
-    _package_version="${_version}-1+${_family}${_full_version}"
+    _package_version="${_version}-1+${_os_family}${_os_full_version}"
   fi
 
   echo -n "${_package_version}"
@@ -309,25 +310,22 @@ install_package_file() {
 install_package() {
   local _package="$1"
   local _version="$2"
-  local _family="${3:-${family}}"
-  local _full_version="${4:-${full_version}}"
+  local _os_family="${3:-${os_family}}"
+  local _os_full_version="${4:-${os_full_version}}"
 
   info "Installing ${_package} ${_version}"
 
   local _package_and_version
   if [[ -n "${_version}" ]] && [[ "${_version}" != 'latest' ]]; then
-    if [[ -z "${_family}" ]]; then
-      set_family "${platform}"
-      _family="${family}"
+    if [[ -z "${_os_family}" ]] || [[ -z "${_os_full_version}" ]]; then
+      set_platform_globals
+      _os_family="${os_family}"
+      _os_full_version="${os_full_version}"
     fi
-    case $_family in
+    case $_os_family in
       debian|ubuntu)
-        if [[ -z "${_full_version}" ]]; then
-          set_platform
-          _full_version="${full_version}"
-        fi
         local _deb_package_version
-        _deb_package_version=$(get_deb_package_version "${_version}" "${_family}" "${_full_version}")
+        _deb_package_version=$(get_deb_package_version "${_version}" "${_os_family}" "${_os_full_version}")
         _package_and_version="${_package}=${deb_package_version}"
         ;;
       *)

tasks/install_build_artifact_linux.sh

@@ -62,22 +62,21 @@ set_package_url() {
   local _package="$2"
   local _version="$3"
 
-  set_family "${_platform}"
-  set_package_type "${family}"
-  set_architecture "${family}"
+  set_package_type "${os_family}"
+  set_architecture "${os_family}"
 
   case "${package_type}" in
     rpm)
       # Account for a fedora naming quirk in the build artifacts.
-      if [[ "${family}" == "fedora" ]]; then
-        _family="fc"
+      if [[ "${os_family}" == "fedora" ]]; then
+        _os_family="fc"
       else
-        _family="${family}"
+        _os_family="${os_family}"
       fi
-      package_name="${_package}-${_version}-1.${_family}${major_version}.${cpu_arch}.${package_type}"
+      package_name="${_package}-${_version}-1.${_os_family}${os_major_version}.${cpu_arch}.${package_type}"
       ;;
     deb)
-      package_name="${_package}_${_version}-1%2B${family}${full_version}_${cpu_arch}.${package_type}"
+      package_name="${_package}_${_version}-1%2B${os_family}${os_full_version}_${cpu_arch}.${package_type}"
       ;;
     *)
       fail "Unhandled package type: '${package_type}'"
@@ -90,7 +89,7 @@ set_package_url() {
 }
 
 # Get platform information
-set_platform
+set_platform_globals
 # Set url to build artifacts package based on platform
 set_package_url "${platform}" "${package}" "${version}"
 # Download the build artifacts package to the tempdir.

tasks/install_linux.sh

@@ -41,16 +41,15 @@ set_repository() {
 set_collection_url() {
   local _platform="$1"
 
-  set_family "${_platform}"
-  set_repository "${family}"
-  set_package_type "${family}"
+  set_repository "${os_family}"
+  set_package_type "${os_family}"
 
   case "${package_type}" in
     rpm)
-      package_name="${collection}-release-${family}-${major_version}.${package_file_suffix}"
+      package_name="${collection}-release-${os_family}-${os_major_version}.${package_file_suffix}"
       ;;
     deb)
-      package_name="${collection}-release-${family}${full_version}.${package_file_suffix}"
+      package_name="${collection}-release-${os_family}${os_full_version}.${package_file_suffix}"
       ;;
     *)
       fail "Unhandled package type: '${package_type}'"
@@ -75,7 +74,7 @@ install_release_package() {
 }
 
 # Get platform information
-set_platform
+set_platform_globals
 # Set collection release package url based on platform
 set_collection_url "${platform}"
 # Download the release package to tempdir
@@ -86,4 +85,4 @@ download "${package_url}" "${local_release_package}"
 # packages from the collection using the platform package manager.
 install_release_package "${local_release_package}" "${package_type}"
 # Use the platform package manager to install openvox-agent
-install_package "${package}" "${version}" "${family}" "${full_version}"
+install_package "${package}" "${version}" "${os_family}" "${os_full_version}"