Consolidate sanoid-portable tests into a single script

Author: decoyjoe

.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
 
           # Add a new binfmt entry that matches APE's (Actually Portable Executable)'s
           # magic number to avoid execution by Ubuntu's built-in "MZ" binfmt
-          # interpreter which "helpfully" tries to run the binary with WINE.
+          # interpreter which "helpfully" tries to run the binary with Wine.
           sudo update-binfmts --install APE /bin/sh --magic MZqFpD
 
           ./build.sh
@@ -37,41 +37,27 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
       - name: Download sanoid-portable artifact
         uses: actions/download-artifact@v4
         with:
           name: ${{ needs.build.outputs.artifact_name }}
-      - name: Test in Ubuntu
+      - name: Test on Ubuntu
         run: |
           # Test on Ubuntu
 
+          # Add a new binfmt entry that matches APE's (Actually Portable Executable)'s
+          # magic number to avoid execution by Ubuntu's built-in "MZ" binfmt
+          # interpreter which "helpfully" tries to run the binary with Wine.
           sudo update-binfmts --install APE /bin/sh --magic MZqFpD
 
-          chmod +x sanoid-portable
-          ln -s sanoid-portable sanoid
-          ln -s sanoid-portable syncoid
-          ln -s sanoid-portable findoid
-
-          ./sanoid-portable -h
-          ./sanoid -h
-          ./syncoid -h
-          ./findoid -h
-
-          ls -lah
-
-          echo 'SHA-256 checksum:'
-          sha256sum sanoid-portable
+          ./test.sh
       - name: Test in FreeBSD
         uses: vmactions/freebsd-vm@v1
         with:
           usesh: true
+          prepare: |
+            pkg install -y jq
           run: |
-            ./sanoid-portable -h
-            ./sanoid -h
-            ./syncoid -h
-            ./findoid -h
-
-            ls -lah
-
-            echo 'SHA-256 checksum:'
-            sha256sum sanoid-portable
+            ./test.sh

build.sh

@@ -77,32 +77,9 @@ echo ''
 echo 'Build complete.'
 echo ''
 
-stat sanoid-portable
+echo 'Testing...'
 echo ''
 
-./sanoid-portable
-
-# APPerl uses the invoking command name (argv[0]) to determine which internal script to run
-ln -s sanoid-portable sanoid
-ln -s sanoid-portable syncoid
-ln -s sanoid-portable findoid
-
-./sanoid --version
-echo ''
-
-echo 'Testing execution of sanoid...'
-./sanoid --help
-echo ''
-
-echo 'Testing execution of syncoid...'
-./syncoid --help
-echo ''
-
-echo 'Testing execution of findoid...'
-./findoid --help
-echo ''
-
-echo 'SHA-256 checksum:'
-sha256sum sanoid-portable
+"${repo_root}/test.sh"
 
 popd > /dev/null

sanoid-portable.pl

@@ -58,8 +58,5 @@
     exit 0;
 }
 
-if ($print_help) {
-    print "$all_versions\n";
-    print $usage;
-    exit 0;
-}
+print $usage;
+print "$all_versions\n";

test.sh

@@ -0,0 +1,61 @@
+#!/usr/bin/env sh
+
+set -eu
+
+# Use the current directory by default
+output_dir=$(pwd)
+
+# Optionally pass in the output directory
+# Usage: test.sh [output-directory]
+if [ $# -gt 0 ] && [ -n "${1}" ]; then
+  output_dir=$(realpath "${1}")
+fi
+
+sanoid_portable_path="${output_dir}/sanoid-portable"
+if [ ! -f "${sanoid_portable_path}" ]; then
+  echo "Error: sanoid-portable does not exist at \"$(dirname "${sanoid_portable_path}")\"."
+  exit 1
+fi
+
+chmod +x "${output_dir}/sanoid-portable"
+$sanoid_portable_path --help
+
+expected_sanoid_version=$(jq -r '.Sanoid' versions.json)
+expected_sanoid_portable_version="${expected_sanoid_version}-$(jq -r '.PackagingRevision' versions.json)"
+actual_sanoid_portable_version=$($sanoid_portable_path --version)
+
+if [ "${actual_sanoid_portable_version}" != "${expected_sanoid_portable_version}" ]; then
+  echo "Error: Expected sanoid-portable version \"${expected_sanoid_portable_version}\" but got \"${actual_sanoid_portable_version}\"."
+  exit 1
+fi
+
+for tool in sanoid syncoid findoid; do
+  tool_path="${output_dir}/${tool}"
+
+  # APPerl uses the invoking command name (argv[0]) to determine which internal script to run
+  ln -sf sanoid-portable "${tool_path}"
+
+  tool_version_output=$($tool_path --version | head -n 1)
+  expected_version_output="/zip/bin/${tool} version ${expected_sanoid_version}"
+
+  if [ "${tool_version_output}" != "${expected_version_output}" ]; then
+    echo $tool_version_output
+    echo "Error: Expected \"${tool} --version\" output to be \"${expected_version_output}\" but got \"${tool_version_output}\"."
+    exit 1
+  fi
+
+  $tool_path --version
+  $tool_path --help
+
+  if [ $? -ne 0 ]; then
+    echo "Error: Command \"${tool_path} --help\" failed with exit code $?"
+    exit $?
+  fi
+done
+
+ls -lah "${output_dir}"
+
+echo ''
+
+echo 'SHA-256 checksum:'
+sha256sum $sanoid_portable_path