feat(usability): add -j/--jobs optional argument (#1854)

Author: bitcoin-tools

README.md

@@ -58,10 +58,11 @@ chmod u+x nodebuilder
 
 | Short | Long Version | Description | Arguments |
 |:-----:|:-------------|:------------|:----------|
-| `-b` | `--bitcoin-version` | Specify the Bitcoin version. | One argument<br>For example: `-b 28.0` |
+| `-b` | `--bitcoin-version` | Specify the Bitcoin version. | One argument<br>E.g.: `-b 28.0` |
 | `-c` | `--compile` | Build Bitcoin from source. | No arguments |
 | `-h` | `--help` | Display the help message. | No arguments<br>_Supersedes other arguments._ |
-| `-p` | `--prune` | Set a prune value in MiB. | One argument<br>For example: `-p 50000` |
+| `-j` | `--jobs` | Set the number of compile jobs. | One argument<br>E.g.: `-j 1` |
+| `-p` | `--prune` | Set a prune value in MiB. | One argument<br>E.g.: `-p 50000` |
 | `-q` | `--quiet` | Suppress output unless unexpected behavior is detected. | No arguments |
 | `-r` | `--skip-reboot` | Skip reboot after installing system update. | No arguments |
 | `-s` | `--skip-update` | Skip installation of system updates. | No arguments |

nodebuilder

@@ -486,7 +486,7 @@ ensure_curl_dependency()
         sudo dnf install --allowerasing --assumeyes curl > /dev/null
         ;;
       gentoo)
-        emerge --jobs "${SYS_CORES_COUNT}" --load-average "${SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail net-misc/curl
+        emerge --jobs "${compile_num_jobs:-SYS_CORES_COUNT}" --load-average "${compile_num_jobs:-SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail net-misc/curl
         ;;
       arch | endeavouros | garuda | manjaro)
         sudo pacman -Syu --needed --noconfirm curl > /dev/null
@@ -553,7 +553,7 @@ ensure_sudo_dependency()
         ;;
       gentoo)
         emerge --sync --quiet
-        emerge --jobs "${SYS_CORES_COUNT}" --load-average "${SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail app-admin/sudo
+        emerge --jobs "${compile_num_jobs:-SYS_CORES_COUNT}" --load-average "${compile_num_jobs:-SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail app-admin/sudo
         ;;
       arch | endeavouros | garuda | manjaro)
         pacman -Syu --needed --noconfirm sudo > /dev/null
@@ -615,7 +615,7 @@ ensure_xargs_dependency()
         ;;
       gentoo)
         emerge --sync --quiet
-        emerge --jobs "${SYS_CORES_COUNT}" --load-average "${SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail sys-apps/findutils
+        emerge --jobs "${compile_num_jobs:-SYS_CORES_COUNT}" --load-average "${compile_num_jobs:-SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail sys-apps/findutils
         ;;
       arch | endeavouros | garuda | manjaro)
         pacman -Syu --needed --noconfirm findutils > /dev/null
@@ -862,12 +862,12 @@ install_build_dependencies_emerge()
     dependencies=$(curl --fail --silent --show-error --location --retry 5 "${BUILD_DEPENDENCIES_URL}")
   [ -z "${dependencies:-}" ] && throw_error 'The list of dependencies is empty.'
   if ! printf '%s\n' "${dependencies}" | xargs emerge --autounmask-write \
-    --jobs "${SYS_CORES_COUNT}" --load-average "${SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail; then
+    --jobs "${compile_num_jobs:-SYS_CORES_COUNT}" --load-average "${SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail; then
     etc-update --automode -5
-    emerge --update --jobs "${SYS_CORES_COUNT}" --load-average "${SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail --deep --newuse @world
+    emerge --update --jobs "${compile_num_jobs:-SYS_CORES_COUNT}" --load-average "${SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail --deep --newuse @world
     # Run the install command again
     printf '%s\n' "${dependencies}" | xargs emerge --autounmask-write \
-      --jobs "${SYS_CORES_COUNT}" --load-average "${SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail
+      --jobs "${compile_num_jobs:-SYS_CORES_COUNT}" --load-average "${SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail
   fi
 }
 
@@ -1098,7 +1098,7 @@ install_runtime_dependencies_emerge()
     dependencies=$(torsocks curl --fail --silent --show-error --location --retry 2 "${RUNTIME_DEPENDENCIES_URL}") ||
     dependencies=$(curl --fail --silent --show-error --location --retry 5 "${RUNTIME_DEPENDENCIES_URL}")
   [ -z "${dependencies}" ] && throw_error 'The list of dependencies is empty.'
-  printf '%s\n' "${dependencies}" | xargs emerge --autounmask-write --jobs "${SYS_CORES_COUNT}" --load-average "${SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail
+  printf '%s\n' "${dependencies}" | xargs emerge --autounmask-write --jobs "${compile_num_jobs:-SYS_CORES_COUNT}" --load-average "${compile_num_jobs:-SYS_CORES_PLUS_ONE}" --quiet --quiet-build --quiet-fail
 }
 
 install_runtime_dependencies_freebsd()
@@ -1262,7 +1262,7 @@ install_system_updates_dnf()
 install_system_updates_emerge()
 {
   readonly GENTOO_EBUILD_REPOSITORY='/var/db/repos/gentoo'
-  readonly EMERGE_UPDATE_COMMAND="emerge --update --jobs ${SYS_CORES_COUNT} --load-average ${SYS_CORES_PLUS_ONE} --quiet --quiet-build --quiet-fail --deep --newuse @world"
+  readonly EMERGE_UPDATE_COMMAND="emerge --update --jobs ${compile_num_jobs:-SYS_CORES_COUNT} --load-average ${compile_num_jobs:-SYS_CORES_PLUS_ONE} --quiet --quiet-build --quiet-fail --deep --newuse @world"
   readonly EMERGE_MAX_RETRIES='3'
   printf '\n'
 
@@ -1402,6 +1402,7 @@ print_usage()
   printf '%s\n' '-b, --bitcoin-version   Specify the Bitcoin version'
   printf '%s\n' '-c, --compile           Build Bitcoin from source'
   printf '%s\n' '-h, --help              Display this help message'
+  printf '%s\n' '-j, --jobs              Set the number of compile jobs'
   printf '%s\n' '-p, --prune             Set a prune value in MiB'
   printf '%s\n' '-q, --quiet             Suppress standard output'
   printf '%s\n' '-r, --skip-reboot       Skip reboot on system updates'
@@ -1506,9 +1507,12 @@ readonly VALID_BITCOIN_VERSION_LIST='0.9.5 0.10.0 0.10.1 0.10.2 0.10.3 0.10.4 \
     0.20.0 0.20.1 0.20.2 0.21.0 0.21.1 0.21.2 22.0 22.1 23.0 23.1 23.2 24.0 \
     24.0.1 24.1 24.2 25.0 25.1 25.2 26.0 26.1 26.2 27.0 27.1 27.2 28.0 28.1'
 
+# Bump this variable for new Bitcoin Core releases
 target_bitcoin_version='28.1'
 
+# Instantiate the parameter variables
 compile_bitcoin_flag='false'
+compile_num_jobs=''
 prune_value='-1'
 quiet_output='false'
 skip_system_update='false'
@@ -1536,11 +1540,31 @@ while [ $# -gt 0 ]; do
       print_usage
       exit 0
       ;;
+    -j | --jobs)
+      # ensure at leaset one additional argument is passed
+      if [ $# -eq 1 ]; then
+        throw_error '-j/--jobs requires one argumenet'
+      fi
+
+      # ensure the argument is a positive integer
+      case "$2" in
+        0)
+          throw_error 'Cannot compile with 0 jobs'
+          ;;
+        '' | *[!0-9]*)
+          throw_error "$2 is not a number"
+          ;;
+        *)
+          compile_num_jobs="$2"
+          ;;
+      esac
+      shift
+      ;;
     -p | --prune)
       if [ $# -eq 1 ]; then
         throw_error '-p/--prune requires an argument'
       fi
-      case $2 in
+      case "$2" in
         *[!0-9]*) # if $2 contains any non-numeric characters
           throw_error "The prune value '$2' must be a positive integer or zero to disable pruning"
           ;;
@@ -1609,25 +1633,27 @@ else
 fi
 readonly TEMP_DIRECTORY
 
-case "${TARGET_KERNEL}" in
-  Linux | FreeBSD)
-    SYS_CORES_COUNT="$(nproc)"
-    ;;
-  Darwin)
-    SYS_CORES_COUNT="$(sysctl -n hw.physicalcpu)"
-    ;;
-  NetBSD | OpenBSD)
-    SYS_CORES_COUNT="$(sysctl -n hw.ncpu)"
-    ;;
-  MINGW* | Cygwin)
-    throw_error 'Windows is not supported. Use Linux, macOS, or Windows Subsystem for Linux instead.'
-    ;;
-  *)
-    throw_error "${TARGET_KERNEL} is not supported. Please run on Linux or macOS."
-    ;;
-esac
-readonly SYS_CORES_COUNT
-readonly SYS_CORES_PLUS_ONE="$((SYS_CORES_COUNT + 1))"
+if [ -z "${compile_num_jobs}" ]; then
+  case "${TARGET_KERNEL}" in
+    Linux | FreeBSD)
+      SYS_CORES_COUNT="$(nproc)"
+      ;;
+    Darwin)
+      SYS_CORES_COUNT="$(sysctl -n hw.physicalcpu)"
+      ;;
+    NetBSD | OpenBSD)
+      SYS_CORES_COUNT="$(sysctl -n hw.ncpu)"
+      ;;
+    MINGW* | Cygwin)
+      throw_error 'Windows is not supported. Use Linux, macOS, or Windows Subsystem for Linux instead.'
+      ;;
+    *)
+      throw_error "${TARGET_KERNEL} is not supported. Please run on Linux or macOS."
+      ;;
+  esac
+  readonly SYS_CORES_COUNT
+  readonly SYS_CORES_PLUS_ONE="$((SYS_CORES_COUNT + 1))"
+fi
 
 ensure_sudo_dependency
 ensure_xargs_dependency

test/test_nodebuilder

@@ -66,6 +66,7 @@ print_usage()
   printf '%s\n' 'Options:'
   printf '%s\n' '-b, --bitcoin-version   Specify the Bitcoin version'
   printf '%s\n' '-c, --compile           Build Bitcoin from source'
+  printf '%s\n' '-j, --jobs              Specify number of compile jobs'
   printf '%s\n' '-h, --help              Display this help message'
   printf '%s\n' '-r, --ref               Choose a git tef to test'
 }
@@ -120,6 +121,26 @@ while [ $# -gt 0 ]; do
       print_usage
       exit 0
       ;;
+    -j | --jobs)
+      # ensure at leaset one additional argument is passed
+      if [ $# -eq 1 ]; then
+        throw_error '-j/--jobs requires one argumenet'
+      fi
+
+      # ensure the argument is a positive integer
+      case "$2" in
+        0)
+          throw_error 'Cannot compile with 0 jobs'
+          ;;
+        '' | *[!0-9]*)
+          throw_error "--jobs requires a positive integer, but $2 is not one."
+          ;;
+        *)
+          readonly NUMBER_OF_COMPILE_JOBS="$2"
+          ;;
+      esac
+      shift
+      ;;
     -r | --ref)
       [ -z "$2" ] && throw_error 'No argument supplied for -r|--ref.' "${LINENO}"
       readonly GIT_REF_SHORT_NAME="$2"
@@ -168,15 +189,23 @@ bitcoind_pid_path="${bitcoin_data_directory}/bitcoind.pid"
 [ -f nodebuilder ] || wget --no-verbose "${NODEBUILDER_BINARY_URL}"
 [ -x nodebuilder ] || chmod u+x nodebuilder
 
-nodebuilder_args=""
+nodebuilder_args=''
 [ -n "${TARGET_BITCOIN_VERSION}" ] && nodebuilder_args="${nodebuilder_args} --bitcoin-version ${TARGET_BITCOIN_VERSION}"
-[ "${COMPILE_BITCOIN}" = 'true' ] && nodebuilder_args="${nodebuilder_args} --compile"
+if [ "${COMPILE_BITCOIN}" = 'true' ]; then
+  if [ -z "${NUMBER_OF_COMPILE_JOBS:-}" ]; then
+    nodebuilder_args="${nodebuilder_args} --compile"
+  else
+    nodebuilder_args="${nodebuilder_args} --compile --jobs ${NUMBER_OF_COMPILE_JOBS}"
+  fi
+fi
 
 if [ -n "${nodebuilder_args}" ]; then
+  # remove extra whitespace from arguments
   readonly NODEBUILDER_ARGS_TRIMMED="$(printf '%s' "${nodebuilder_args}" | sed -e 's/^[[:space:]]*//')"
   printf "Running nodebuilder with '%s' args\n" "${NODEBUILDER_ARGS_TRIMMED}"
   readonly RUN_NODEBUILDER_COMMAND="./nodebuilder ${NODEBUILDER_ARGS_TRIMMED:-}"
 else
+  printf 'Running nodebuilder with no args\n'
   readonly RUN_NODEBUILDER_COMMAND="./nodebuilder"
 fi