Provide an env.sh file that can be sourced, automatically update shell profile config file to source it (#53)

Author: patrickfreed

install/swiftly-install.sh

@@ -12,12 +12,20 @@
 # to store platform information, downloaded toolchains, and other state required to manage
 # the toolchains.
 #
+# After installation, the script will create $SWIFTLY_HOME_DIR/env.sh, which can be sourced
+# to properly set up the environment variables required to run swiftly. Unless --no-modify-profile
+# was specified, the script will also update ~/.profile, ~/.bash_profile, ~/.bash_login, or ~/.zprofile,
+# depending on the value of $SHELL and the existence of the files, to source the env.sh file on login.
+# This will ensure that future logins will automatically configure SWIFTLY_HOME_DIR, SWIFTLY_BIN_DIR,
+# and PATH.
+#
 # Unless the --disable-confirmation flag is set, this script will allow the runner to
 # configure either of those two directory paths.
 #
 # curl is required to run this script.
 
 set -o errexit
+shopt -s extglob
 
 has_command () {
     command -v "$1" > /dev/null
@@ -40,8 +48,33 @@ read_input_with_default () {
     fi
 }
 
+# Replaces the actual path to $HOME at the beginning of the provided string argument with
+# the string "$HOME". This is used when printing to stdout.
+# e.g. "home/user/.local/bin" => "$HOME/.local/bin"
+replace_home_path () {
+    if [[ "$1" =~ ^"$HOME"(/|$) ]]; then
+        echo "\$HOME${1#$HOME}"
+    else
+        echo "$1"
+    fi
+}
+
+# Replaces the string "$HOME" or "~" in the argument with the actual value of $HOME.
+# e.g. "$HOME/.local/bin" => "/home/user/.local/bin"
+# e.g. "~/.local/bin" => "/home/user/.local/bin"
+expand_home_path () {
+    echo "${1/#@(~|\$HOME)/$HOME}"
+}
+
+# Prints the provided argument using the terminal's bold text effect.
+bold () {
+    echo "$(tput bold)$1$(tput sgr0)"
+}
+
 SWIFTLY_INSTALL_VERSION="0.1.0"
 
+MODIFY_PROFILE="true"
+
 for arg in "$@"; do
     case "$arg" in
         "--help" | "-h")
@@ -54,6 +87,8 @@ USAGE:
 
 FLAGS:
     -y, --disable-confirmation  Disable confirmation prompt.
+    --no-modify-profile         Do not attempt to modify the profile file to set environment 
+                                variables (e.g. PATH) on login.
     -h, --help                  Prints help information.
     --version                   Prints version information.
 EOF
@@ -64,6 +99,10 @@ EOF
             DISABLE_CONFIRMATION="true"
             ;;
 
+        "--no-modify-profile")
+            MODIFY_PROFILE="false"
+            ;;
+
         "--version")
             echo "$SWIFTLY_INSTALL_VERSION"
             exit 0
@@ -172,6 +211,23 @@ JSON_OUT=$(cat <<EOF
 EOF
 )
 
+PROFILE_FILE="$HOME/.profile"
+case "$SHELL" in
+    *"zsh")
+        PROFILE_FILE="$HOME/.zprofile"
+        ;;
+    *"bash")
+        # Order derived from:
+        # https://www.gnu.org/savannah-checkouts/gnu/bash/manual/bash.html#Bash-Startup-Files
+        if [[ -f "$HOME/.bash_profile" ]]; then
+            PROFILE_FILE="$HOME/.bash_profile"
+        elif [[ -f "$HOME/.bash_login" ]]; then
+            PROFILE_FILE="$HOME/.bash_login"
+        fi
+        ;;
+    *)
+esac
+
 echo "This script will install swiftly, a Swift toolchain installer and manager."
 echo ""
 
@@ -182,30 +238,53 @@ DEFAULT_BIN_DIR="$HOME/.local/bin"
 BIN_DIR="${SWIFTLY_BIN_DIR:-$DEFAULT_BIN_DIR}"
 
 while [ -z "$DISABLE_CONFIRMATION" ]; do
-    echo "swiftly data and configuration files directory: $HOME_DIR"
-    echo "swiftly executables installation directory: $BIN_DIR"
+    echo "Current installation options:"
+    echo ""
+    printf "  %40s: $(bold $(replace_home_path $HOME_DIR))\n" "Data and configuration files directory"
+    printf "  %40s: $(bold $(replace_home_path $BIN_DIR))\n" "Executables installation directory"
+    printf "  %40s: $(bold $MODIFY_PROFILE)\n" "Modify login config ($(replace_home_path $PROFILE_FILE))"
     echo ""
     echo "Select one of the following:"
     echo "1) Proceed with the installation (default)"
-    echo "2) Customize the installation paths"
+    echo "2) Customize the installation"
     echo "3) Cancel"
 
     read_input_with_default "1"
     case "$READ_INPUT_RETURN" in
         # Just hitting enter will proceed with the default installation.
         "1" | "1)")
-            echo ""
             break
             ;;
 
         "2" | "2)")
-            echo "Enter the swiftly data and configuration files directory (default $HOME_DIR): "
+            echo "Enter the swiftly data and configuration files directory (default $(replace_home_path $HOME_DIR)): "
             read_input_with_default "$HOME_DIR"
-            HOME_DIR="${READ_INPUT_RETURN/#~/$HOME}"
+            HOME_DIR="$(expand_home_path $READ_INPUT_RETURN)"
 
-            echo "Enter the swiftly binary installation directory (default $BIN_DIR): "
+            echo "Enter the swiftly executables installation directory (default $(replace_home_path $BIN_DIR)): "
             read_input_with_default "$BIN_DIR"
-            BIN_DIR="${READ_INPUT_RETURN/#~/$HOME}"
+            BIN_DIR="$(expand_home_path $READ_INPUT_RETURN)"
+
+            if [[ "$MODIFY_PROFILE" == "true" ]]; then
+                MODIFY_PROFILE_PROMPT="(Y/n)"
+            else
+                MODIFY_PROFILE_PROMPT="(y/N)"
+            fi
+            echo "Modify login config ($(replace_home_path $PROFILE_FILE))? $MODIFY_PROFILE_PROMPT"
+            read_input_with_default "$MODIFY_PROFILE"
+
+            case "$READ_INPUT_RETURN" in
+                "y" | "Y")
+                    MODIFY_PROFILE="true"
+                ;;
+
+                "n" | "N")
+                    MODIFY_PROFILE="false"
+                ;;
+
+                *)
+                ;;
+            esac
             ;;
 
         *)
@@ -217,9 +296,9 @@ done
 
 if [[ -d "$HOME_DIR" ]]; then
     if [[ "$DISABLE_CONFIRMATION" == "true" ]]; then
-        echo "Overwriting existing swiftly installation at $HOME_DIR"
+        echo "Overwriting existing swiftly installation at $(replace_home_path $HOME_DIR)"
     else
-        echo "Existing swiftly installation detected at $HOME_DIR, overwrite? (Y/n)"
+        echo "Existing swiftly installation detected at $(replace_home_path $HOME_DIR), overwrite? (Y/n)"
 
         while [[ true ]]; do
             read_input_with_default "y"
@@ -259,35 +338,42 @@ curl \
 
 chmod +x "$BIN_DIR/swiftly"
 
-echo ""
-
-echo "swiftly executable written to $BIN_DIR/swiftly"
-
 echo "$JSON_OUT" > "$HOME_DIR/config.json"
 
-echo "swiftly data files written to $HOME_DIR"
-
 # Verify the downloaded executable works. The script will exit if this fails due to errexit.
 SWIFTLY_HOME_DIR="$HOME_DIR" SWIFTLY_BIN_DIR="$BIN_DIR" "$BIN_DIR/swiftly" --version > /dev/null
 
 echo ""
 echo "swiftly has been succesfully installed!"
-if ! has_command "swiftly" ; then
-    echo "You may have to restart your shell or add $BIN_DIR \
-to your PATH in order to access swiftly from the shell."
+echo ""
+
+ENV_OUT=$(cat <<EOF
+export SWIFTLY_HOME_DIR="$(replace_home_path $HOME_DIR)"
+export SWIFTLY_BIN_DIR="$(replace_home_path $BIN_DIR)"
+if [[ ":\$PATH:" != *":\$SWIFTLY_BIN_DIR:"* ]]; then
+   export PATH="\$SWIFTLY_BIN_DIR:\$PATH"
 fi
+EOF
+)
 
-if [[ "$HOME_DIR" != "$DEFAULT_HOME_DIR" ]]; then
-    echo ""
-    echo "To ensure swiftly can properly find its data and configuration files, set the \$SWIFTLY_HOME_DIR \
-environment variable to $HOME_DIR before using swiftly."
+echo "$ENV_OUT" > "$HOME_DIR/env.sh"
+
+if [[ "$MODIFY_PROFILE" == "true" ]]; then
+    SOURCE_LINE=". $(replace_home_path $HOME_DIR)/env.sh"
+
+    # Only append the line if it isn't in .profile already.
+    if [[ ! -f "$PROFILE_FILE" ]] || [[ ! "$(cat $PROFILE_FILE)" =~ "$SOURCE_LINE" ]]; then
+        echo "$SOURCE_LINE" >> "$PROFILE_FILE"
+    fi
 fi
 
-if [[ "$BIN_DIR" != "$DEFAULT_BIN_DIR" ]]; then
+if ! has_command "swiftly" || [[ "$HOME_DIR" != "$DEFAULT_HOME_DIR" || "$BIN_DIR" != "$DEFAULT_BIN_DIR" ]] ; then
+    echo "Once you log in again, swiftly should be accessible from your PATH."
+    echo "To begin using swiftly from your current shell, first run the following command:"
+    echo ""
+    echo "    . $(replace_home_path $HOME_DIR)/env.sh"
     echo ""
-    echo "To ensure swiftly installs Swift tooclhain executables to the configured location, set the \$SWIFTLY_BIN_DIR \
-environment variable to $BIN_DIR before using swiftly."
+    echo "Then to install the latest version of Swift, run 'swiftly install latest'"
+else
+    echo "To install the latest version of Swift, run 'swiftly install latest'"
 fi
-
-echo ""
-echo "To install the latest version of Swift, run 'swiftly install latest'"

install/tests/custom-home-install.sh

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+
+# Tests that custom install paths that include the string "$HOME" are expanded properly.
+# WARNING: this test makes changes to the local filesystem and is intended to be run in a containerized environment.
+
+set -o errexit
+source ./test-util.sh
+
+export CUSTOM_HOME_DIR_NAME="home-substitution-test-home"
+export CUSTOM_HOME_DIR="$HOME/$CUSTOM_HOME_DIR_NAME"
+export CUSTOM_BIN_DIR="$CUSTOM_HOME_DIR/bin"
+
+cp "$HOME/.profile" "$HOME/.profile.bak"
+
+cleanup () {
+    rm -r "$CUSTOM_HOME_DIR"
+    mv "$HOME/.profile.bak" "$HOME/.profile"
+}
+trap cleanup EXIT
+
+# Make sure that the "~" character is handled properly.
+printf "2\n\$HOME/${CUSTOM_HOME_DIR_NAME}\n\$HOME/${CUSTOM_HOME_DIR_NAME}/bin\ny\n1\n" | ./swiftly-install.sh
+
+# .profile should be updated to update PATH and SWIFTLY_HOME_DIR/SWIFTLY_BIN_DIR.
+bash --login -c "swiftly --version"
+
+. "$CUSTOM_HOME_DIR/env.sh"
+
+if ! has_command "swiftly" ; then
+    test_fail "Can't find swiftly on the PATH"
+fi
+
+if [[ "$SWIFTLY_HOME_DIR" != "$CUSTOM_HOME_DIR" ]]; then
+    test_fail "SWIFTLY_HOME_DIR ($SWIFTLY_HOME_DIR) did not equal $CUSTOM_HOME_DIR"
+fi
+
+if [[ "$SWIFTLY_BIN_DIR" != "$CUSTOM_BIN_DIR" ]]; then
+    test_fail "SWIFTLY_BIN_DIR ($SWIFTLY_BIN_DIR) did not equal $CUSTOM_BIN_DIR"
+fi
+
+if [[ ! -d "$CUSTOM_HOME_DIR/toolchains" ]]; then
+    test_fail "the toolchains directory was not created in SWIFTLY_HOME_DIR"
+fi
+
+test_pass

install/tests/custom-install.sh

@@ -10,9 +10,12 @@ export CUSTOM_HOME_DIR="$(pwd)custom-test-home"
 export CUSTOM_BIN_DIR="$CUSTOM_HOME_DIR/bin"
 export PATH="$CUSTOM_BIN_DIR:$PATH"
 
+cp "$HOME/.profile" "$HOME/.profile.bak"
 cleanup () {
     set +o errexit
 
+    mv "$HOME/.profile.bak" "$HOME/.profile"
+
     if has_command "swiftly" ; then
        swiftly uninstall -y latest > /dev/null
     fi
@@ -21,15 +24,25 @@ cleanup () {
 }
 trap cleanup EXIT
 
-printf "2\n$CUSTOM_HOME_DIR\n$CUSTOM_BIN_DIR\n1\n" | ./swiftly-install.sh
+printf "2\n$CUSTOM_HOME_DIR\n$CUSTOM_BIN_DIR\ny\n1\n" | ./swiftly-install.sh
+
+# .profile should be updated to update PATH and SWIFTLY_HOME_DIR/SWIFTLY_BIN_DIR.
+bash --login -c "swiftly --version"
 
-export SWIFTLY_HOME_DIR="$CUSTOM_HOME_DIR"
-export SWIFTLY_BIN_DIR="$CUSTOM_BIN_DIR"
+. "$CUSTOM_HOME_DIR/env.sh"
 
 if ! has_command "swiftly" ; then
     test_fail "Can't find swiftly on the PATH"
 fi
 
+if [[ "$SWIFTLY_HOME_DIR" != "$CUSTOM_HOME_DIR" ]]; then
+    test_fail "SWIFTLY_HOME_DIR ($SWIFTLY_HOME_DIR) did not equal $CUSTOM_HOME_DIR"
+fi
+
+if [[ "$SWIFTLY_BIN_DIR" != "$CUSTOM_BIN_DIR" ]]; then
+    test_fail "SWIFTLY_BIN_DIR ($SWIFTLY_BIN_DIR) did not equal $CUSTOM_BIN_DIR"
+fi
+
 if [[ ! -d "$CUSTOM_HOME_DIR/toolchains" ]]; then
     test_fail "the toolchains directory was not created in SWIFTLY_HOME_DIR"
 fi

install/tests/custom-tilde-install.sh

@@ -9,20 +9,35 @@ source ./test-util.sh
 export CUSTOM_HOME_DIR_NAME="tilde-substitution-test-home"
 export CUSTOM_HOME_DIR="$HOME/$CUSTOM_HOME_DIR_NAME"
 export CUSTOM_BIN_DIR="$CUSTOM_HOME_DIR/bin"
-export PATH="$CUSTOM_BIN_DIR:$PATH"
+
+cp "$HOME/.profile" "$HOME/.profile.bak"
 
 cleanup () {
     rm -r "$CUSTOM_HOME_DIR"
+    mv "$HOME/.profile.bak" "$HOME/.profile"
 }
 trap cleanup EXIT
 
 # Make sure that the "~" character is handled properly.
-printf "2\n~/${CUSTOM_HOME_DIR_NAME}\n~/${CUSTOM_HOME_DIR_NAME}/bin\n1\n" | ./swiftly-install.sh
+printf "2\n~/${CUSTOM_HOME_DIR_NAME}\n~/${CUSTOM_HOME_DIR_NAME}/bin\ny\n1\n" | ./swiftly-install.sh
+
+# .profile should be updated to update PATH and SWIFTLY_HOME_DIR/SWIFTLY_BIN_DIR.
+bash --login -c "swiftly --version"
+
+. "$CUSTOM_HOME_DIR/env.sh"
 
 if ! has_command "swiftly" ; then
     test_fail "Can't find swiftly on the PATH"
 fi
 
+if [[ "$SWIFTLY_HOME_DIR" != "$CUSTOM_HOME_DIR" ]]; then
+    test_fail "SWIFTLY_HOME_DIR ($SWIFTLY_HOME_DIR) did not equal $CUSTOM_HOME_DIR"
+fi
+
+if [[ "$SWIFTLY_BIN_DIR" != "$CUSTOM_BIN_DIR" ]]; then
+    test_fail "SWIFTLY_BIN_DIR ($SWIFTLY_BIN_DIR) did not equal $CUSTOM_BIN_DIR"
+fi
+
 if [[ ! -d "$CUSTOM_HOME_DIR/toolchains" ]]; then
     test_fail "the toolchains directory was not created in SWIFTLY_HOME_DIR"
 fi

install/tests/default-install.sh

@@ -6,20 +6,29 @@
 set -o errexit
 source ./test-util.sh
 
+cp "$HOME/.profile" "$HOME/.profile.bak"
+
 cleanup () {
+    set +o errexit
+
+    mv "$HOME/.profile.bak" "$HOME/.profile"
+
     if has_command "swiftly" ; then
        swiftly uninstall -y latest > /dev/null
     fi
 
     rm -r "$HOME/.local/share/swiftly"
-    rm -r "$HOME/.local/bin/swiftly"
+    rm "$HOME/.local/bin/swiftly"
 }
 trap cleanup EXIT
 
-export PATH="$HOME/.local/bin:$PATH"
-
 echo "1" | ./swiftly-install.sh
 
+# .profile should be updated to update PATH.
+bash --login -c "swiftly --version"
+
+. "$HOME/.local/share/swiftly/env.sh"
+
 if ! has_command "swiftly" ; then
     test_fail "Can't find swiftly on the PATH"
 fi