Simplify Pinned Build Scripts

README.md

@@ -72,7 +72,7 @@ git clone --recursive https://github.com/AntelopeIO/leap.git
 git clone --recursive [email protected]:AntelopeIO/leap.git
 ```
 
-> ℹ️ **HTTPS vs. SSH Clone** ℹ️
+> ℹ️ **HTTPS vs. SSH Clone** ℹ️  
 Both an HTTPS or SSH git clone will yield the same result - a folder named `leap` containing our source code. It doesn't matter which type you use.
 
 Navigate into that folder:
@@ -96,30 +96,33 @@ git submodule update --init --recursive
 ### Step 3 - Build
 Select build instructions below for a [pinned build](#pinned-build) (preferred) or an [unpinned build](#unpinned-build).
 
-> ℹ️ **Pinned vs. Unpinned Build** ℹ️
+> ℹ️ **Pinned vs. Unpinned Build** ℹ️  
 We have two types of builds for Leap: "pinned" and "unpinned." The only difference is that pinned builds use specific versions for some dependencies hand-picked by the Leap engineers - they are "pinned" to those versions. In contrast, unpinned builds use the default dependency versions available on the build system at the time. We recommend performing a "pinned" build to ensure the compiler and boost versions remain the same between builds of different Leap versions. Leap requires these versions to remain the same, otherwise its state might need to be recovered from a portable snapshot or the chain needs to be replayed.
 
-> ⚠️ **A Warning On Parallel Compilation Jobs (`-j` flag)** ⚠️
+> ⚠️ **A Warning On Parallel Compilation Jobs (`-j` flag)** ⚠️  
 When building C/C++ software, often the build is performed in parallel via a command such as `make -j "$(nproc)"` which uses all available CPU threads. However, be aware that some compilation units (`*.cpp` files) in Leap will consume nearly 4GB of memory. Failures due to memory exhaustion will typically, but not always, manifest as compiler crashes. Using all available CPU threads may also prevent you from doing other things on your computer during compilation. For these reasons, consider reducing this value.
 
-> 🐋 **Docker and `sudo`** 🐋
+> 🐋 **Docker and `sudo`** 🐋  
 If you are in an Ubuntu docker container, omit `sudo` from all commands because you run as `root` by default. Most other docker containers also exclude `sudo`, especially Debian-family containers. If your shell prompt is a hash tag (`#`), omit `sudo`.
 
 #### Pinned Build
-Make sure you are in the root of the `leap` repo, then run the `install_depts.sh` script to install dependencies:
-```bash
-sudo scripts/install_deps.sh
-```
+Make sure you are in the root of the `leap` repo, then run the pinned build script. You have to give it three arguments in the following order:
+1. A temporary folder, for all dependencies that need to be built from source.
+1. A build folder, where the binaries you need to install will be built to.
+1. The number of jobs or CPU cores/threads to use (note the [jobs flag](#step-3---build) warning above).
 
-Next, run the pinned build script. You have to give it three arguments, in the following order:
-  - A temporary folder, for all dependencies that need to be built from source.
-  - A build folder, where the binaries you need to install will be built to.
-  - The number of jobs or CPU cores/threads to use (note the [jobs flag](#step-3---build) warning above).
+> 🔒 You do not need to run this script with `sudo` or as root. On Debian-family operating systems such as Ubuntu, the script will determine if all package dependencies are installed and only invoke `apt-get` if you are missing packages. In that case, you may be prompted for your password if `apt-get` needs additional permissions from `sudo`. You should not run this script with `sudo` or as root because you do not need to.
 
-The following command runs the `pinned_build.sh` script, specifies a `deps` and `build` folder in the root of the Leap repo for the first two arguments, then builds the packages using all of your computer's CPU threads (Note: you don't need `sudo` for this command):
+For example, the following command runs the `pinned_build.sh` script, specifies a `deps` and `build` folder in the root of the Leap repo for the first two arguments, then builds the packages using all of your computer's CPU threads:
 ```bash
 scripts/pinned_build.sh deps build "$(nproc)"
 ```
+If you want to by-pass the `[Y/n]` prompt from `apt-get install`, you can pass `y` to the script like this.
+```bash
+echo 'y' | scripts/pinned_build.sh deps build "$(nproc)"
+```
+All other script behavior remains unchanged.
+
 Now you can optionally [test](#step-4---test) your build, or [install](#step-5---install) the `*.deb` binary packages, which will be in the root of your build directory.
 
 #### Unpinned Build

scripts/pinned_build.sh

@@ -57,13 +57,47 @@ popdir() {
 }
 
 try(){
+    echo "$ $*"
     "$@"
     res=$?
     if [[ ${res} -ne 0 ]]; then
-        exit 255
+        exit $res
     fi
 }
 
+install_dependencies() {
+    echo 'Installing package dependencies.'
+    if [[ "$(uname)" == 'Linux' && -f /etc/debian_version ]]; then
+        if [[ "$(id -u)" != '0' ]]; then # if not root, use sudo for the package manager
+            if dpkg -s sudo &>/dev/null; then # guard against sudo not being installed
+                SUDO_CMD='sudo'
+            else
+                printf '\033[1;31mERROR: This script must be run as root or sudo must be installed!\n\033[0m'
+                exit 2
+            fi
+        else
+            unset SUDO_CMD
+        fi
+        DEPENDENCIES=()
+        while IFS='' read -r LINE; do
+            DEPENDENCIES+=("$LINE");
+        done < <(cat "$SCRIPT_DIR/pinned_deps.txt")
+        echo 'Checking for missing package dependencies.'
+        if dpkg -s "${DEPENDENCIES[@]}" &> /dev/null; then
+            echo 'All package dependencies are already installed.'
+        else
+            echo 'Some package dependencies are missing, installing...'
+            try $SUDO_CMD apt-get update
+            try $SUDO_CMD apt-get update --fix-missing
+            export DEBIAN_FRONTEND='noninteractive'
+            try $SUDO_CMD apt-get install "${DEPENDENCIES[@]}"
+        fi
+    else
+        printf '\033[1;33mWARNING: Skipping package manager dependency installations because this is not a Debian-family operating system!\nWe currently only support Ubuntu.\033[0m\n'
+    fi
+    echo 'Done installing package dependencies.'
+}
+
 install_clang() {
     CLANG_DIR="$1"
     if [ ! -d "${CLANG_DIR}" ]; then
@@ -118,6 +152,8 @@ install_boost() {
     export BOOST_DIR="${BOOST_DIR}"
 }
 
+install_dependencies
+
 pushdir "${DEP_DIR}"
 
 install_clang "${DEP_DIR}/clang-${CLANG_VER}"

scripts/pinned_deps.txt

@@ -0,0 +1,21 @@
+build-essential
+bzip2
+cmake
+curl
+file
+git
+libbz2-dev
+libcurl4-openssl-dev
+libgmp-dev
+libncurses5
+libssl-dev
+libtinfo-dev
+libzstd-dev
+python3
+python3-numpy
+time
+tzdata
+unzip
+wget
+zip
+zlib1g-dev