Merge pull request #9 from jpartlow/fix-retry-function

Fix retry function

Author: jpartlow

.github/workflows/pr_testing.yaml

@@ -41,6 +41,8 @@ jobs:
       - name: Verify openvox-agent is installed
         run: |-
           [[ "$(/opt/puppetlabs/bin/puppet --version)" =~ [0-9]+\.[0-9]+\.[0-9]+ ]]
+      - name: Verify idempotency
+        run: bolt task run openvox_bootstrap::install --targets localhost --run-as root
 
   test-install-task-on-other-os-via-containers:
     strategy:
@@ -75,6 +77,13 @@ jobs:
         run: ./openvox_bootstrap/tasks/install_linux.sh
       - name: Verify openvox-agent is installed
         run: /opt/puppetlabs/bin/puppet --version | grep -E '8\.[0-9]+'
+      - name: Verify idempotency
+        env:
+          PT__installdir: ${{ github.workspace }}
+          PT_collection: openvox8
+          PT_apt_source: "https://apt.overlookinfratech.com"
+          PT_yum_source: "https://yum.overlookinfratech.com"
+        run: ./openvox_bootstrap/tasks/install_linux.sh
 
   test-install-version:
     strategy:
@@ -104,3 +113,10 @@ jobs:
         run: ./openvox_bootstrap/tasks/install_linux.sh
       - name: Verify openvox-agent is installed
         run: /opt/puppetlabs/bin/puppet --version | grep '8.14.0'
+      - name: Verify idempotency
+        env:
+          PT__installdir: ${{ github.workspace }}
+          PT_version: "8.14.0"
+          PT_apt_source: "https://apt.overlookinfratech.com"
+          PT_yum_source: "https://yum.overlookinfratech.com"
+        run: ./openvox_bootstrap/tasks/install_linux.sh

.github/workflows/pr_testing_install_build_artifact.yaml

@@ -31,6 +31,8 @@ jobs:
       - name: Verify openvox-agent is installed
         run: |-
           [[ "$(/opt/puppetlabs/bin/puppet --version)" = "8.15.0" ]]
+      - name: Verify idempotency
+        run: bolt task run openvox_bootstrap::install_build_artifact version=8.15.0 --targets localhost --run-as root
 
   test-install-build-artifact-task-on-other-os-via-containers:
     strategy:
@@ -64,3 +66,8 @@ jobs:
         shell: bash
         run: |-
           [[ "$(/opt/puppetlabs/bin/puppet --version)" = "8.15.0" ]]
+      - name: Verify idempotency
+        env:
+          PT__installdir: ${{ github.workspace }}
+          PT_version: "8.15.0"
+        run: ./openvox_bootstrap/tasks/install_build_artifact_linux.sh

files/common.sh

@@ -45,21 +45,25 @@ exists() {
 # Log and execute a command in a subshell, capturing and echoing its
 # output before returning its exit status.
 #
-# Output is also captured in the variable EXEC_AND_CAPTURE_RESULT
-# for other functions to inspect.
+# Also captures output and status in the global variables:
+#
+# LAST_EXEC_AND_CAPTURE_OUTPUT
+# LAST_EXEC_AND_CAPTURE_STATUS
+#
+# so that the caller can inspect them as well.
 exec_and_capture() {
   local _cmd="$*"
 
   info "Executing: ${_cmd}"
 
   set +e
-  EXEC_AND_CAPTURE_RESULT=$(${_cmd} 2>&1)
-  local _status=$?
+  LAST_EXEC_AND_CAPTURE_OUTPUT=$(${_cmd} 2>&1)
+  LAST_EXEC_AND_CAPTURE_STATUS=$?
   set -e
 
-  echo "${EXEC_AND_CAPTURE_RESULT}"
-  info "Status: ${_status}"
-  return $_status
+  echo "${LAST_EXEC_AND_CAPTURE_OUTPUT}"
+  info "Status: ${LAST_EXEC_AND_CAPTURE_STATUS}"
+  return $LAST_EXEC_AND_CAPTURE_STATUS
 }
 
 # If the passed command fails with output matching the given regex,
@@ -82,19 +86,24 @@ with_retries_if() {
   shift 3
 
   local _cmd="$*"
+  local _result
   local _status
 
-  for ((i = 0; i < _retries; i++)); do
-    info "Attempt $((i + 1)) of $_retries: ${_cmd}"
-    exec_and_capture "${_cmd}"
-    _status=$?
-    if [[ "${_status}" == 0 ]]; then
+  for ((i = 1; i <= _retries; i++)); do
+    if [[ $i -gt 1 ]]; then
+      info "Retrying in ${_delay} seconds..."
+      sleep "${_delay}"
+    fi
+
+    info "Attempt ${i} of $_retries: ${_cmd}"
+
+    if exec_and_capture "${_cmd}"; then
+      _status=$LAST_EXEC_AND_CAPTURE_STATUS
       break # command succeeded
     else
-      if [[ "${EXEC_AND_CAPTURE_OUTPUT}" =~ ${_error_regex} ]]; then
-        info "Retrying in ${_delay} seconds..."
-        sleep "${_delay}"
-      else
+      _result="${LAST_EXEC_AND_CAPTURE_OUTPUT}"
+      _status=$LAST_EXEC_AND_CAPTURE_STATUS
+      if ! [[ "${_result}" =~ ${_error_regex} ]]; then
         info "Command failed but output did not match /${_error_regex}/. Aborting retries."
         break
       fi
@@ -260,7 +269,7 @@ install_package_file() {
   info "Installing release package '${_package_file}' of type '${_package_type}'"
   case $_package_type in
     rpm)
-      rpm_with_retries -Uvh "$_package_file"
+      rpm_with_retries -Uvh --replacepkgs "$_package_file"
       ;;
     deb)
       dpkg_with_retries -i "$_package_file"