(maint) Handle correct naming of narch build artifacts

Packages like openvox-server, openvoxdb and openvoxdb-termini are noarch
and need a different naming schem when constructing urls to fetch them
from the artifacts server.

* adds a noarch_package() test to common.sh
* adds a set_package_architecture() function to common.sh
* extracts set_architecture() from install_build_artifact_linux.sh into
  common.sh and renames as set_cpu_architecture()
* extracts set_package_url() from install_build_artifact_linux.sh into
  common.sh and renames as set_artifacts_package_url()
* modifies set_artifacts_package_url() to set_package_architecture() so
  we get correct urls for noarch and arch packages
* adds tests to the bash specs for all the above

Author: jpartlow

files/common.sh

@@ -377,3 +377,126 @@ refresh_package_cache() {
     exit 1
   fi
 }
+
+# Test whether the given package name matches a list of
+# openvox packages that are noarch.
+noarch_package() {
+  local _package="$1"
+
+  # List of noarch packages.
+  local noarch_packages=(
+    'openvox-server'
+    'openvoxdb'
+    'openvoxdb-termini'
+  )
+
+  for pkg in "${noarch_packages[@]}"; do
+    if [[ "${_package}" == "${pkg}" ]]; then
+      return 0
+    fi
+  done
+
+  return 1
+}
+
+# Lookup the cpu architecture and set it as cpu_arch.
+# Translates x86_64 to amd64 and aarch64 to arm64 for debian/ubuntu.
+set_cpu_architecture() {
+  local _family="$1"
+
+  local _arch
+  _arch=$(uname -m)
+  case "${_family}" in
+    debian|ubuntu)
+      case "${_arch}" in
+        x86_64)
+          cpu_arch="amd64"
+          ;;
+        aarch64)
+          cpu_arch="arm64"
+          ;;
+        *)
+          cpu_arch="${_arch}"
+          ;;
+      esac
+      ;;
+    *)
+      cpu_arch="${_arch}"
+      ;;
+  esac
+  export cpu_arch # quiets shellcheck SC2034
+  assigned 'cpu_arch'
+}
+
+# Lookup the architecture for the given package and set it as
+# package_arch.
+#
+# This will either be noarch/all depending on the platform and
+# whether the package name matches an openvox noarch_package(),
+# or it will be the cpu_arch.
+set_package_architecture() {
+  local _package="$1"
+  local _os_family="${2:-${os_family}}"
+
+  if noarch_package "${_package}"; then
+    case "${_os_family}" in
+      debian|ubuntu)
+        package_arch='all'
+      ;;
+      *)
+        package_arch='noarch'
+      ;;
+    esac
+  else
+    set_cpu_architecture "${_os_family}"
+    package_arch="${cpu_arch}"
+  fi
+  export package_arch # quiets shellcheck SC2034
+  assigned 'package_arch'
+}
+
+# Based on platform, package and version set:
+#   package_name - the name of the build artifact package
+#   package_url - the url to download the build artifact package
+#
+# Currently this is based on the structure of the package repository
+# at https://artifacts.voxpupuli.org, which is a page
+# that provides a summary of links to artifacts contained in an S3
+# bucket hosted by Oregon State University Open Source Lab.
+#
+# Example rpm:
+# https://artifacts.voxpupuli.org/openvox-agent/8.15.0/openvox-agent-8.15.0-1.el8.x86_64.rpm
+# Example deb:
+# https://artifacts.voxpupuli.org/openvox-agent/8.15.0/openvox-agent_8.15.0-1%2Bdebian12_amd64.deb
+set_artifacts_package_url() {
+  local _artifacts_source="$1"
+  local _package="$2"
+  local _version="$3"
+
+  set_package_type "${os_family}"
+  set_package_architecture "${_package}" "${os_family}"
+
+  case "${package_type}" in
+    rpm)
+      # Account for a fedora naming quirk in the build artifacts.
+      if [[ "${os_family}" == "fedora" ]]; then
+        _os_family="fc"
+      else
+        _os_family="${os_family}"
+      fi
+      package_name="${_package}-${_version}-1.${_os_family}${os_major_version}.${package_arch}.${package_type}"
+      ;;
+    deb)
+      package_name="${_package}_${_version}-1%2B${os_family}${os_full_version}_${package_arch}.${package_type}"
+      ;;
+    *)
+      fail "Unhandled package type: '${package_type}'"
+      ;;
+  esac
+  package_url="${_artifacts_source}/${_package}/${_version}/${package_name}"
+
+  export package_name # quiets shellcheck SC2034
+  assigned 'package_name'
+  export package_url # quiets shellcheck SC2034
+  assigned 'package_url'
+}

spec/unit/bash/common_sh_spec.rb

@@ -261,38 +261,26 @@
       end
 
       it 'sets platform globals' do
-        output, status = test(<<~EOT)
-          set_platform_globals
-          echo "set platform=$platform"
-          echo "set os_full_version=$os_full_version"
-          echo "set os_major_version=$os_major_version"
-          echo "set os_family=$os_family"
-        EOT
+        output, status = test('set_platform_globals')
 
         expect(status.success?).to be(true)
-        expect(output).to include('set platform=Ubuntu')
-        expect(output).to include('set os_full_version=24.04')
-        expect(output).to include('set os_major_version=24')
-        expect(output).to include('set os_family=ubuntu')
+        expect(output).to include('Assigned platform=Ubuntu')
+        expect(output).to include('Assigned os_full_version=24.04')
+        expect(output).to include('Assigned os_major_version=24')
+        expect(output).to include('Assigned os_family=ubuntu')
       end
 
       context 'with a pre-release' do
         let(:os) { :debian13 }
 
         it 'uses codename when release is n/a' do
-          output, status = test(<<~EOT)
-            set_platform_globals
-            echo "set platform=$platform"
-            echo "set os_full_version=$os_full_version"
-            echo "set os_major_version=$os_major_version"
-            echo "set os_family=$os_family"
-          EOT
+          output, status = test('set_platform_globals')
 
           expect(status.success?).to be(true)
-          expect(output).to include('set platform=Debian')
-          expect(output).to include('set os_full_version=13')
-          expect(output).to include('set os_major_version=13')
-          expect(output).to include('set os_family=debian')
+          expect(output).to include('Assigned platform=Debian')
+          expect(output).to include('Assigned os_full_version=13')
+          expect(output).to include('Assigned os_major_version=13')
+          expect(output).to include('Assigned os_family=debian')
         end
       end
     end
@@ -308,13 +296,7 @@
       it 'fails for an unknown platform' do
         mock_facts_task_bash_sh(:unknown)
 
-        output, status = test(<<~EOT)
-          set_platform_globals
-          echo "set platform=$platform"
-          echo "set os_full_version=$os_full_version"
-          echo "set os_major_version=$os_major_version"
-          echo "set os_family=$os_family"
-        EOT
+        output, status = test('set_platform_globals')
 
         expect(status.success?).to be(false)
         expect(output).to include("Unhandled platform: 'Unknown'")
@@ -439,4 +421,142 @@
       end
     end
   end
+
+  context 'noarch_package' do
+    it 'returns 0 for a noarch package' do
+      output, status = test('noarch_package openvox-server')
+
+      expect(status.success?).to be(true)
+      expect(output.strip).to be_empty
+    end
+
+    it 'returns 1 for a non-noarch package' do
+      output, status = test('noarch_package foo')
+
+      expect(status.success?).to be(false)
+      expect(output.strip).to be_empty
+    end
+  end
+
+  context 'set_cpu_architecture' do
+    context 'debian or ubuntu' do
+      it 'sets x86_64 for amd64' do
+        allow_script.to receive_command(:uname).and_exec('echo x86_64')
+        output, status = test('set_cpu_architecture debian')
+
+        expect(status.success?).to be(true)
+        expect(output).to include('Assigned cpu_arch=amd64')
+      end
+
+      it 'sets arm64 for aarch64' do
+        allow_script.to receive_command(:uname).and_exec('echo aarch64')
+        output, status = test('set_cpu_architecture ubuntu')
+
+        expect(status.success?).to be(true)
+        expect(output).to include('Assigned cpu_arch=arm64')
+      end
+
+      it 'sets amd64 for amd64' do
+        allow_script.to receive_command(:uname).and_exec('echo amd64')
+        output, status = test('set_cpu_architecture debian')
+
+        expect(status.success?).to be(true)
+        expect(output).to include('Assigned cpu_arch=amd64')
+      end
+    end
+
+    context 'other' do
+      it 'sets what uname gives it' do
+        allow_script.to receive_command(:uname).and_exec('echo x86_64')
+        output, status = test('set_cpu_architecture el')
+
+        expect(status.success?).to be(true)
+        expect(output).to include('Assigned cpu_arch=x86_64')
+      end
+    end
+  end
+
+  context 'set_package_architecture' do
+    it 'sets all for debian noarch' do
+      output, status = test('set_package_architecture openvox-server debian')
+
+      expect(status.success?).to be(true)
+      expect(output).to include('Assigned package_arch=all')
+    end
+
+    it 'sets noarch for el noarch' do
+      output, status = test('set_package_architecture openvoxdb el')
+
+      expect(status.success?).to be(true)
+      expect(output).to include('Assigned package_arch=noarch')
+    end
+
+    it 'sets system arch otherwise' do
+      allow_script.to receive_command(:uname).and_exec('echo x86_64')
+      output, status = test('set_package_architecture openvox-agent el')
+
+      expect(status.success?).to be(true)
+      expect(output).to include('Assigned cpu_arch=x86_64')
+      expect(output).to include('Assigned package_arch=x86_64')
+    end
+  end
+
+  context 'set_artifacts_package_url' do
+    context 'deb' do
+      it 'builds a debian url' do
+        allow_script.to set_env('os_family', 'debian')
+        allow_script.to receive_command(:uname).and_exec('echo x86_64')
+        output, status = test('set_artifacts_package_url https://foo openvox-agent 8.18.0')
+
+        expect(status.success?).to be(true)
+        package_name = 'openvox-agent_8.18.0-1%2Bdebian_amd64.deb'
+        expect(output).to include("Assigned package_name=#{package_name}")
+        expect(output).to include("Assigned package_url=https://foo/openvox-agent/8.18.0/#{package_name}")
+      end
+
+      it 'builds a noarch package url for ubuntu' do
+        allow_script.to set_env('os_family', 'ubuntu')
+        output, status = test('set_artifacts_package_url https://foo openvox-server 8.9.0')
+
+        expect(status.success?).to be(true)
+        package_name = 'openvox-server_8.9.0-1%2Bubuntu_all.deb'
+        expect(output).to include("Assigned package_name=#{package_name}")
+        expect(output).to include("Assigned package_url=https://foo/openvox-server/8.9.0/#{package_name}")
+      end
+    end
+
+    context 'rpm' do
+      it 'builds a redhat url' do
+        allow_script.to set_env('os_family', 'el')
+        allow_script.to receive_command(:uname).and_exec('echo x86_64')
+        output, status = test('set_artifacts_package_url https://foo openvox-agent 8.18.0')
+
+        expect(status.success?).to be(true)
+        package_name = 'openvox-agent-8.18.0-1.el.x86_64.rpm'
+        expect(output).to include("Assigned package_name=#{package_name}")
+        expect(output).to include("Assigned package_url=https://foo/openvox-agent/8.18.0/#{package_name}")
+      end
+
+      it 'builds a noarch package url for redhat' do
+        allow_script.to set_env('os_family', 'el')
+        output, status = test('set_artifacts_package_url https://foo openvoxdb-termini 8.9.1')
+
+        expect(status.success?).to be(true)
+        package_name = 'openvoxdb-termini-8.9.1-1.el.noarch.rpm'
+        expect(output).to include("Assigned package_name=#{package_name}")
+        expect(output).to include("Assigned package_url=https://foo/openvoxdb-termini/8.9.1/#{package_name}")
+      end
+
+      it 'builds a fedora url' do
+        allow_script.to set_env('os_family', 'fedora')
+        allow_script.to receive_command(:uname).and_exec('echo x86_64')
+        output, status = test('set_artifacts_package_url https://foo openvox-agent 8.18.0')
+
+        expect(status.success?).to be(true)
+        package_name = 'openvox-agent-8.18.0-1.fc.x86_64.rpm'
+        expect(output).to include("Assigned package_name=#{package_name}")
+        expect(output).to include("Assigned package_url=https://foo/openvox-agent/8.18.0/#{package_name}")
+      end
+    end
+  end
 end