Normalizing file names and extensions & Updates

- Updating naming and formatting
- Normalizing testing naming
- Added reasoning for not testing parameters with feature checker

Author: xN4P4LM

bin/ghe-host-check

@@ -153,8 +153,8 @@ if [[ "$CALLING_SCRIPT" == "ghe-backup" ]]; then
   . "$(dirname "${BASH_SOURCE[0]}")/../share/github-backup-utils/requirements.txt"
 
   #source disk size file
-  # shellcheck source=share/github-backup-utils/ghe-rsync-size.sh
-  . "$(dirname "${BASH_SOURCE[0]}")/../share/github-backup-utils/ghe-rsync-size.sh"
+  # shellcheck source=share/github-backup-utils/ghe-rsync-size
+  . "$(dirname "${BASH_SOURCE[0]}")/../share/github-backup-utils/ghe-rsync-size"
 
   #Display dir requirements for repositories and mysql
   echo "Checking host for sufficient space for a backup..." 1>&2

share/github-backup-utils/ghe-rsync

@@ -11,6 +11,7 @@ set -o pipefail
 # shellcheck source=share/github-backup-utils/ghe-backup-config
 . "$( dirname "${BASH_SOURCE[0]}" )/ghe-backup-config"
 
+# Don't use the feature checker for expected parameters as it can cause issues with server paths
 # Check for --ignore-missing-args parameter support and remove if unavailable.
 if rsync -h | grep '\-\-ignore-missing-args' >/dev/null 2>&1; then
   parameters=("$@")
@@ -20,19 +21,21 @@ else
   done
 fi
 
-# This prepends `--trust-sender` to the parameters if supported by the current version of rsync to mitigate the degradation of performance due to the resolution of CVE-2022-29154
-# shellcheck source=share/github-backup-utils/ghe-rsync-feature-checker.sh
+# This prepends `--trust-sender` to the parameters if supported by the current version of rsync 
+# to mitigate the degradation of performance due to the resolution of CVE-2022-29154
+# shellcheck source=share/github-backup-utils/ghe-rsync-feature-checker
 # shellcheck disable=SC2046
-if [ "$($( dirname "${BASH_SOURCE[0]}" )/ghe-rsync-feature-checker.sh --trust-sender)" == "true" ]; then
+if [ "$($( dirname "${BASH_SOURCE[0]}" )/ghe-rsync-feature-checker --trust-sender)" == "true" ]; then
   parameters=("--trust-sender" "${parameters[@]}")
 fi
 
-# This loads the $GHE_EXTRA_RSYNC_OPTS from the config file if available then adds them to the parameters and skip adding if already present in the parameters
-# shellcheck source=share/github-backup-utils/ghe-rsync-feature-checker.sh
+# This loads the $GHE_EXTRA_RSYNC_OPTS from the config file if available then adds them
+# to the parameters and skip adding if already present in the parameters
+# shellcheck source=share/github-backup-utils/ghe-rsync-feature-checker
 # shellcheck disable=SC2046
 if [ -n "$GHE_EXTRA_RSYNC_OPTS" ]; then
   for extra_opt in $GHE_EXTRA_RSYNC_OPTS; do
-    if [ "$($( dirname "${BASH_SOURCE[0]}" )/ghe-rsync-feature-checker.sh "$extra_opt")" == "true" ]; then
+    if [ "$($( dirname "${BASH_SOURCE[0]}" )/ghe-rsync-feature-checker "$extra_opt")" == "true" ]; then
       parameters+=("$extra_opt")
     fi
   done

share/github-backup-utils/ghe-rsync-feature-checker.sh renamed to share/github-backup-utils/ghe-rsync-feature-checker

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# ghe-rsync-feature-checker.sh command tests
+# ghe-rsync-feature-checker command tests
 
 TESTS_DIR="$PWD/$(dirname "$0")"
 # Bring in testlib.
@@ -8,121 +8,121 @@ TESTS_DIR="$PWD/$(dirname "$0")"
 
 ## testing for known supported command help with and without leading dashes
 
-begin_test "ghe-rsync-feature-checker.sh for known supported command --help"
+begin_test "Testing ghe-rsync-feature-checker for known supported command --help"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh --help | grep -q "true"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker --help | grep -q "true"
 )
 end_test
 
-begin_test "ghe-rsync-feature-checker.sh for known supported command help"
+begin_test "Testing ghe-rsync-feature-checker with known supported command help"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh help | grep -q "true"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker help | grep -q "true"
 )
 end_test
 
-## testing for known unsupported command not-an-actual-feature with and without leading dashes
+## testing with known unsupported command not-an-actual-feature with and without leading dashes
 
-begin_test "ghe-rsync-feature-checker.sh for known unsupported command --not-an-actual-feature"
+begin_test "Testing ghe-rsync-feature-checker with known unsupported command --not-an-actual-feature"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command 
-    ghe-rsync-feature-checker.sh --not-an-actual-feature | grep -q "false"
+    # Test ghe-rsync-feature-checker command 
+    ghe-rsync-feature-checker --not-an-actual-feature | grep -q "false"
 
 )
 end_test
 
-begin_test "ghe-rsync-feature-checker.sh for known unsupported command not-an-actual-feature"
+begin_test "Testing ghe-rsync-feature-checker with known unsupported command not-an-actual-feature"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh not-an-actual-feature | grep -q "false"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker not-an-actual-feature | grep -q "false"
 )
 end_test
 
-## testing for known supported command partial with and without leading dashes
+## testing with known supported command partial with and without leading dashes
 
-begin_test "ghe-rsync-feature-checker.sh for known supported command --partial"
+begin_test "Testing ghe-rsync-feature-checker with known supported command --partial"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh --partial | grep -q "true"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker --partial | grep -q "true"
 )
 end_test
 
-begin_test "ghe-rsync-feature-checker.sh for known supported command partial"
+begin_test "Testing ghe-rsync-feature-checker with known supported command partial"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh partial | grep -q "true"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker partial | grep -q "true"
 )
 end_test
 
-## testing for known supported command -v with and without leading dashes
+## testing with known supported command -v with and without leading dashes
 
-begin_test "ghe-rsync-feature-checker.sh for known supported command -v"
+begin_test "Testing ghe-rsync-feature-checker with known supported command -v"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh -v | grep -q "true"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker -v | grep -q "true"
 )
 end_test
 
-begin_test "ghe-rsync-feature-checker.sh for known supported command v"
+begin_test "Testing ghe-rsync-feature-checker with known supported command v"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh v | grep -q "true"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker v | grep -q "true"
 )
 end_test
 
-## testing for known supported command --verbose with and without leading dashes
+## testing with known supported command --verbose with and without leading dashes
 
-begin_test "ghe-rsync-feature-checker.sh for known supported command --verbose"
+begin_test "Testing ghe-rsync-feature-checker with known supported command --verbose"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh --verbose | grep -q "true"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker --verbose | grep -q "true"
 )
 end_test
 
-begin_test "ghe-rsync-feature-checker.sh for known supported command verbose"
+begin_test "Testing ghe-rsync-feature-checker with known supported command verbose"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh verbose | grep -q "true"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker verbose | grep -q "true"
 )
 end_test
 
-## testing for known supported command ignore-missing-args with and without leading dashes
+## testing with known supported command ignore-missing-args with and without leading dashes
 
-begin_test "ghe-rsync-feature-checker.sh for known supported command --ignore-missing-args"
+begin_test "Testing ghe-rsync-feature-checker with known supported command --ignore-missing-args"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh "--ignore-missing-args" | grep -q "true"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker "--ignore-missing-args" | grep -q "true"
 )
 end_test
 
-begin_test "ghe-rsync-feature-checker.sh for known supported command ignore-missing-args"
+begin_test "Testing ghe-rsync-feature-checker with known supported command ignore-missing-args"
 (
     set -e
 
-    # Test ghe-rsync-feature-checker.sh command
-    ghe-rsync-feature-checker.sh "ignore-missing-args" | grep -q "true"
+    # Test ghe-rsync-feature-checker command
+    ghe-rsync-feature-checker "ignore-missing-args" | grep -q "true"
 )
 end_test