deploy.sh

#!/usr/bin/env bash
## Deploys a web app to given servers. Check out
## This script is designed for Debian-based systems. Support for other distros will be added later.
## Copyright (C) 2025 Buffer Punk. All rights reserved.
## MIT License

SOURCE="${BASH_SOURCE[0]}"
while [ -L "$SOURCE" ]; do
  DIR="$(cd -P "$(dirname "$SOURCE")" >/dev/null 2>&1 && pwd)"
  SOURCE="$(readlink "$SOURCE")"
  [[ "$SOURCE" != /* ]] && SOURCE="$DIR/$SOURCE"
done
SCRIPT_DIR="$(cd -P "$(dirname "$SOURCE")" >/dev/null 2>&1 && pwd)"
source "$SCRIPT_DIR/awesome.conf" # For colors and Usage message

set -e
trap 'echo -e "\n${BRed}Error: An error occurred during deployment. Please check your inputs and try again.${Color_Off}"' ERR

SCRIPT_PATH="$DIR/$(basename "$SOURCE")"
IN_PATH=false
IFS=':' read -ra PATH_DIRS <<<"$PATH"
for dir in "${PATH_DIRS[@]}"; do
  if [[ "$SCRIPT_PATH" == "$dir/"* ]]; then
    IN_PATH=true
    break
  fi
done

if ! $IN_PATH && [[ ! -f /usr/local/bin/deploy && ! -L /usr/local/bin/deploy ]]; then
  echo "Warning: Script is not in your \$PATH. Adding it will allow you to run it from anywhere."
  read -p "Do you want to add it to your \$PATH? (y/n) " answer
  if [[ "$answer" == "y" || "$answer" == "Y" ]]; then
    echo "Adding script to your \$PATH..."
    sudo ln -s "$SCRIPT_PATH" /usr/local/bin/deploy
    echo -e "Script added to your \$PATH. You can now run it from anywhere with the command:${BCyan} deploy [options] ${Color_Off}\n"
  else
    echo "Script not added to your \$PATH. You can run it using the full path: $SCRIPT_PATH"
  fi
fi

cd ..
for i in "$@"; do
  if [[ $i =~ ^--config= ]]; then
    config="${i#*=}"
    old="$OLDPWD"
    if [ -f "$old/$config" ]; then
      source "$old/$config"
      echo -e "${Cyan}Using configuration from $config file.${Color_Off}"
      IFS=',' read -r -a SERVERS <<<"$SERVERS"
      IFS=',' read -r -a SERVICES <<<"$SERVICES"
    else
      echo -e "${BRed}Error: Configuration file '$config' not found.${Color_Off} Falling back to command line arguments."
      exit 1
    fi
  elif [[ $i =~ ^--servers=\[(.*)\]$ ]]; then
    IFS=',' read -r -a SERVERS <<<"${BASH_REMATCH[1]}"
  elif [[ $i =~ ^--services=\[(.*)\]$ ]]; then
    IFS=',' read -r -a SERVICES <<<"${BASH_REMATCH[1]}"
  elif [[ $i =~ ^--type= ]]; then
    TYPE="${i#*=}"
    if [[ "$TYPE" != "domain" && "$TYPE" != "ip" ]]; then
      echo -e "${BRed}Error: Invalid TYPE '$TYPE'. Please use 'domain' or 'ip'. ${Color_Off}"
      exit 1
    fi
  elif [[ $i =~ ^--rollback= ]]; then
    ROLLBACK="${i#*=}"
    if ! [[ "$ROLLBACK" =~ ^[0-9]+$ ]]; then
      echo -e "${BRed}Error: Invalid ROLLBACK value '$ROLLBACK'. Please provide a number.${Color_Off}"
      exit 1
    fi
    echo -e "${BCyan}You included the rollback option '$ROLLBACK'.${Color_Off}"
  elif [[ $i =~ ^--deploy-dir= ]]; then
    DEPLOY_DIR="${i#*=}"
    export DEPLOY_DIR="$DEPLOY_DIR"
  elif [[ $i =~ ^--setup= ]]; then
    setup="${i#*=}"
    if [[ "$setup" != "full" && "$setup" != "only" ]]; then
      echo -e "${BRed}Error: Invalid setup option '$setup'. Please use 'full' or 'only'. ${Color_Off}"
      exit 1
    elif [ -z "$SETUP_COMMAND" ]; then
      echo -e "\nYou included the setup option '$setup'. (Please be careful with this option, as it can cause issues if not used correctly.)"
      printf "${BCyan}How many commands do you want to run on the remote server(s)?: ${Color_Off}"
      read -r NUMBER
      SETUP_COMMAND="echo -e '${Cyan}Executing commands... ${Color_Off}\n'"
      if ! [[ "$NUMBER" =~ ^[0-9]+$ ]]; then
        echo -e "${BRed}Error: Invalid number of commands '$NUMBER'. Please provide a number.${Color_Off}"
        exit 1
      fi
      for ((j = 1; j <= NUMBER; j++)); do
        printf "${BCyan}Enter command $j: ${Color_Off}"
        read -r command
        if [[ -z "$command" ]]; then
          echo -e "${BRed}Error: Command cannot be empty. Please provide a valid command.${Color_Off}"
          exit 1
        fi
        SETUP_COMMAND="$SETUP_COMMAND && $command"
        echo -e "${Green}Command $j added: $command${Color_Off}"
      done
    fi
  elif [[ $i =~ ^--project= ]]; then
    PROJECT_NAME="${i#*=}"
    if [ ! -d "$PROJECT_NAME" ]; then
      echo -e "${BRed} Could not find $PROJECT_NAME in $(pwd) ${Color_Off}"
      exit 1
    fi

  elif [[ $i =~ ^--keep= ]]; then
    KEEP="${i#*=}"
    if ! [[ "$KEEP" =~ ^[0-9]+$ ]]; then
      echo -e "${BRed}Error: Invalid KEEP value '$KEEP'. Please provide a number.${Color_Off}"
      exit 1
    fi
  elif [[ $i =~ ^--help$ || $i =~ ^-h$ ]]; then
    echo -e "$Usage"
    exit 0
  elif ! [[ $i =~ ^-- ]]; then
    echo -e "${BRed}Error: Invalid argument format: '$i'. ${Color_Off}"
    echo -e "$Usage"
    exit 1
  fi
done

KEEP=${KEEP:-5}

if [ -z "$PROJECT_NAME" ]; then
  echo -e "${BYellow}WARNING: PROJECT_NAME is not set in your config. Falling back to user input. ${Color_Off}\n"
  echo -e "${BCyan}What is your project's name?${Color_Off}"
  read -r PROJECT_NAME
  if [ -z "$PROJECT_NAME" ]; then
    echo -e "${BRed}Error: No project name provided. Exiting...${Color_Off}"
    exit 1
  fi
  export PROJECT_NAME="$PROJECT_NAME"
  if [ ! -d "$PROJECT_NAME" ]; then
    echo -e "${BRed}Could not find '$PROJECT_NAME' in $(pwd) ${Color_Off}"
    exit 1
  fi
  echo -e "${Cyan}You can set the PROJECT_NAME environment variable in your shell profile to avoid this prompt in the future or pass --project in flags.${Color_Off}"
  echo -e "${Cyan}Please note that the project name must match the name of the folder in which the project is located.${Color_Off}"
fi

echo -e "\n${BGreen}Welcome to the ${BBlue}${PROJECT_NAME} project ${BGreen}deployment!${Color_Off}\n"

# Check if host command is available
if ! command -v host &>/dev/null; then
  echo -e "${BRed}Error:${Color_Off} host command not found. Installing dnsutils..."
  sudo apt-get install -y dnsutils
fi

# check length
if [ ${#SERVERS[@]} -lt 1 ]; then
  echo -e "${BRed}Error:${Color_Off} ${Red}No servers provided. Please provide a list of servers in the format: servers=[server1,server2,...]${Color_Off}"
  exit 1
fi

if [ "$TYPE" == "domain" ]; then
  printf "${BYellow}Warning:${Color_Off} ${Yellow}You are using domain names. Make sure they are valid and reachable.${Color_Off}\n${Cyan}Checking domain names... ${Color_Off}"
  for s in "${SERVERS[@]}"; do
    if ! host "$s" &>/dev/null; then
      echo -e "${BRed}Error:${Color_Off} The domain name ${BRed}'$s'${Color_Off} you provided is invalid or unreachable.\nPlease check your domain names. Exiting..."
      exit 1
    fi
  done
  echo -e "${Green}Done! All domain names are valid.${Color_Off}"
else
  # Check for valid IP addresses
  for s in "${SERVERS[@]}"; do
    if ! [[ "$s" =~ ^(([1-9]?[0-9]|1[0-9][0-9]|2([0-4][0-9]|5[0-5]))\.){3}([1-9]?[0-9]|1[0-9][0-9]|2([0-4][0-9]|5[0-5]))$ ]]; then
      echo -e "${BRed}Error:${Color_Off} Invalid IP address ${BRed}'$s'${Color_Off}. Please provide valid IP addresses."
      exit 1
    fi
  done
fi

restart_services=""
for i in "${SERVICES[@]}"; do
  if [[ "$i" =~ ^[a-zA-Z0-9_]+$ ]]; then
    restart_services="${restart_services} $i"
  else
    echo -e "${BRed}Error:${Color_Off} ${Red}Invalid service name '$i'. Only alphanumeric characters and underscores are allowed.${Color_Off}"
    exit 1
  fi
done

ssh_key_given=false
if [[ -n "$SSH_KEY" ]]; then
  ssh_key_given=true
fi

# Install sshpass if needed
if [[ "$ssh_key_given" == "false" ]]; then
  if ! command -v sshpass &>/dev/null; then
    echo -e "${Cyan}sshpass not found. Installing sshpass...${Color_Off}"
    sudo apt-get update && sudo apt-get install -y sshpass
    echo -e "${Green}sshpass installed successfully.${Color_Off}"
  fi
fi

if [ -n "$ROLLBACK" ]; then
  if [[ -n "${SERVERS[*]}" && -n "${SERVICES[*]}" ]]; then
    for i in "${SERVERS[@]}"; do
      (
        read -s -p "[sudo] password for $SSH_USER@$i (Press ENTER if not required): " SUDO_PASS
        echo ""
        # Determine ssh authentication args
        if [[ "$ssh_key_given" == "true" ]]; then
          ssh_auth=(-i "$SSH_KEY")
          ssh_prefix=() # no sshpass
        else
          ssh_auth=(-o PreferredAuthentications=password -o PubkeyAuthentication=no)
          if [[ -z "$SUDO_PASS" ]]; then
            echo -e "${BYellow}Warning:${Color_Off} ${Yellow}No SSH key or password provided. Skipping $i...${Color_Off}"
            continue
          fi
          ssh_prefix=(sshpass -p "$SUDO_PASS")
        fi

        echo -e "${BBlue}Rolling back on server: ${BYellow}\t$i\t...\n${Color_Off}"
        ssh -i "$SSH_KEY" "$SSH_USER@$i" "bash -c '
                cd $DEPLOY_DIR/
                rm -rf ../current
                f=\$(ls -ut | grep $PROJECT_NAME | head -n +$((ROLLBACK)) | tail -n +$((ROLLBACK)))
                echo -e \"${Cyan}Rolling back to version: ${BCyan}\$f${Color_Off}\n\"
                ln -s \$(readlink -f \$f) ../current
                ls -l .. | grep current
                sudo systemctl restart ${restart_services[*]}
                echo -e \"${Cyan}Service statuses after restart:${Color_Off}\n\"
                sudo systemctl status ${restart_services[*]} --no-pager
                echo -e \"${Green}Rollback completed on server name: $i.${Color_Off}\n\"
            '"
      ) &
    done
    wait
    echo -e "${BCyan}Done. Bye!${Color_Off}"
    exit 0
  else
    echo -e "${BRed}Error: Please provide servers for rollback and services to restart ${Color_Off}"
    exit 1
  fi
fi

echo -e "\n${BYellow}Please note that this script does not provide full graceful error handling, so that you don't live with a broken app.${Color_Off}\n"
if [ "$setup" == "only" ]; then
  for i in "${SERVERS[@]}"; do
    (
      read -s -p "[sudo] password for $SSH_USER@$i (Press ENTER if not required): " SUDO_PASS
      echo ""
      define_api=$([ -n "$JSHOST" ] && echo "sed -i 's#undefined#\\\"$i\\\"#' $JSHOST" || echo "")

      # Determine ssh authentication args
      if [[ "$ssh_key_given" == "true" ]]; then
        ssh_auth=(-i "$SSH_KEY")
        ssh_prefix=() # no sshpass
      else
        ssh_auth=(-o PreferredAuthentications=password -o PubkeyAuthentication=no)
        if [[ -z "$SUDO_PASS" ]]; then
          echo -e "${BYellow}Warning:${Color_Off} ${Yellow}No SSH key or password provided. Skipping $i...${Color_Off}"
          continue
        fi
        ssh_prefix=(sshpass -p "$SUDO_PASS")
      fi

      echo -e "${Green}Skipping deployment and going for server setup. This will fail if there is no deployed version.${Color_Off}\n"
      echo -e "${Yellow}BEGIN Server MOTD: \n${Color_Off}"
      ssh -T -q -i "$SSH_KEY" "$SSH_USER@$i" <<EOF
            echo -e "${Yellow}END Server MOTD.${Color_Off}\n"
            $SETUP_COMMAND
            cd $DEPLOY_DIR/../current/$NODE_HOME
            if which npm >/dev/null 2>&1 && [[ "$*" =~ (^|[[:space:]])--npm($|[[:space:]]) ]]; then
                npm install && echo -e "${Cyan}Npm install was a success.${Color_Off}\n"
            elif ! which npm >/dev/null 2>&1; then
                echo -e "\n${BRed}Npm not found. Please install it.${Color_Off}\n"
            fi
            if [ -n "${restart_services[@]}" ]; then
                if sudo systemctl status ${restart_services} >/dev/null 2>&1; then
                    echo "✅ Services are running fine. Restarting: $restart_services"
                    sudo systemctl restart $restart_services
                    echo -e "${Green}Setup completed on server name: $i.${Color_Off}"
                else
                    echo "❌ Some services might be dead or unavailable. Please check your setup. Full setup failed."
                fi
            fi
            cd - > /dev/null && cd $DEPLOY_DIR/../current
            $define_api
EOF
    ) &
  done
  wait
  echo -e "\n${BCyan}Done. Bye!${Color_Off}"
  exit 0
fi

inputFile="$PROJECT_NAME"
dtime="$(date +'%Y%m%d%H%M%S')"
file="$inputFile$dtime"

if [ ! -d "$inputFile" ]; then
  echo -e "${BRed}Error: Input directory '$inputFile' does not exist.${Color_Off}"
  exit 1
fi

# Countdown
echo -e "${Cyan}After this operation, the deployed version will be stored in the folder 'versions/'"
echo -e "${Color_Off}Deployment will commence in 10 seconds. Check if you entered correct information. \nPress ctrl c, to cancel if you made a mistake.\n"

# Braille spinner frames (npm-like)
frames=(⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏)

# Countdown start (in seconds)
seconds=10

# Start countdown
for ((j = seconds; j > 0; j--)); do
  for frame in "${frames[@]}"; do
    printf "${Yellow} \r\tStarting deployment in %2d seconds... %s Press ENTER to deploy now." "$j" "$frame"

    # Sleep for spinner frame interval
    sleep 0.1

    # Check if ENTER is pressed (non-blocking)
    if read -t 0.001 -n 1 key; then
      # If ENTER pressed (empty string)
      if [[ $key == "" ]]; then
        echo -e "\n🚀 Deploying now!"
        break 2
      fi
    fi
  done
done

# Display archive name and deployment servers
echo -e "\n${Cyan}Your new archive will be named:${Color_Off}\t$file"

echo -e "${Cyan}Deploying to the following servers:${Color_Off}\n"
for i in "${SERVERS[@]}"; do
  printf "\t%s\n" "$i"
done

# Create versions directory if it doesn't exist
if [ ! -d "$inputFile/versions" ]; then
  mkdir "$inputFile/versions/"
fi

clear

# Create and transfer archive, then deploy to servers
tar --exclude="versions" --exclude=".git" --exclude="node_modules" -czf "$inputFile/versions/$file.tgz" -C "$inputFile" .
echo -e "\n${Cyan}Archive created successfully. Beginning deployment...${Color_Off}\n"
apt_flag_passed=$([[ "$*" =~ (^|[[:space:]])--apt-update($|[[:space:]]) ]] && echo "true" || echo "false")
npm_flag_passed=$([[ "$*" =~ (^|[[:space:]])--npm($|[[:space:]]) ]] && echo "true" || echo "false")

for i in "${SERVERS[@]}"; do
  # read sudo password once per server
  read -s -p "[sudo] password for $SSH_USER@$i (Press ENTER if not required): " SUDO_PASS
  echo ""
  (
    # Only convenient if your api endpoint is on the same dmain as your app.
    # Do not define JSHOST if you don't want this behavior.
    # This will be improved in future versions to let you define custom endpoints.
    define_api=$([ -n "$JSHOST" ] && echo "sed -i 's#undefined#\\\"https://$i/api\\\"#' $JSHOST" || printf "")

    # Determine ssh/scp authentication args
    if [[ "$ssh_key_given" == "true" ]]; then
      ssh_auth=(-i "$SSH_KEY")
      ssh_prefix=() # no sshpass
    else
      ssh_auth=(-o PreferredAuthentications=password -o PubkeyAuthentication=no)
      if [[ -z "$SUDO_PASS" ]]; then
        echo -e "${BYellow}Warning:${Color_Off} ${Yellow}No SSH key or password provided. Skipping $i...${Color_Off}"
        continue
      fi
      ssh_prefix=(sshpass -p "$SUDO_PASS")
    fi

    echo -e "\n${BBlue}Deploying on server:${Color_Off} ${BYellow}$i${Color_Off}\n"

    "${ssh_prefix[@]}" scp "${ssh_auth[@]}" "$inputFile/versions/$file.tgz" "$SSH_USER@$i:/tmp/" || {
      echo -e "${BRed}Failed to copy file to $i${Color_Off}"
      exit 1
    }

    echo -e "\n${Green}Copied archive file to server:${Color_Off} $i in directory: /tmp/"
    echo -e "${Blue}Extracting archive to:${Color_Off} $DEPLOY_DIR/ ..."
    echo -e "${Yellow}BEGIN Server MOTD:${Color_Off}\n"

    # --- Remote SSH Execution ---
    "${ssh_prefix[@]}" ssh -T "${ssh_auth[@]}" "$SSH_USER@$i" <<EOF
      echo -e "\n${Yellow}END Server MOTD.${Color_Off}\n"
      if [ -n "$SUDO_PASS" ]; then
          echo -e "${Cyan}Using provided sudo password for operations requiring elevated privileges.${Color_Off}\n"
          echo "$SUDO_PASS" | sudo -S -v >/dev/null 2>&1
      else
          echo -e "${Yellow}No sudo password provided. Assuming passwordless sudo access.${Color_Off}\n"
      fi

      if [[ "$apt_flag_passed" == "true" ]]; then
          echo -e "${Cyan}Running apt-get update...${Color_Off}\n"
          sudo apt-get update
          echo -e "${Cyan}Server updated successfully.${Color_Off}\n"
      fi

      mkdir -p $DEPLOY_DIR/new && tar -xzf /tmp/$file.tgz -C $DEPLOY_DIR/new && mv $DEPLOY_DIR/new $DEPLOY_DIR/$file
      sudo rm -rf $DEPLOY_DIR/new/
      sudo rm -rf $DEPLOY_DIR/../current
      ln -s $DEPLOY_DIR/$file $DEPLOY_DIR/../current
      echo -e "${Green}Finished making a symbolic link for the new release. Deleting old releases...${Color_Off}"
      cd $DEPLOY_DIR/ && ls -ut | grep $PROJECT_NAME | tail -n +$((KEEP + 1)) | xargs rm -rf && cd $DEPLOY_DIR/$file && $define_api

      echo -e "${Cyan}Deleted old releases, keeping the last $KEEP version(s).${Color_Off}"
      echo -e "${Cyan}Here are the new contents of the releases directory:${Color_Off}\n"
      ls $DEPLOY_DIR/ | sed 's/^/\t\t\t/'

      if [[ "$npm_flag_passed" == "true" ]]; then
          echo -e "\n${Cyan}Running npm install on the latest version...${Color_Off}\n"
          cd $DEPLOY_DIR/$file/$NODE_HOME
          if which npm >/dev/null 2>&1; then
            npm install
            echo -e '${Cyan}Npm install was a success.${Color_Off}';
          else
            echo -e '${Red}Npm not found. Please install it.${Color_Off}';
          fi
      fi

      if [ -n "$SETUP_COMMAND" ]; then
          echo -e "\n${Cyan}Executing setup commands...${Color_Off}"
          $SETUP_COMMAND
          echo -e "\n${Cyan}Setup command executed successfully.${Color_Off}\n"
      fi

      sudo rm -rf /tmp/$file.tgz
      if [ -n "${restart_services[@]}" ]; then
          if sudo systemctl status ${restart_services} >/dev/null 2>&1; then
              echo "\n${Green}✓ Services are running fine.${Color_off} Restarting: ${restart_services[@]}"
              sudo systemctl restart ${restart_services[@]}
              echo -e "${Green}✓ Setup completed successfully on server name: $i.${Color_Off}"
          else
              echo "❌ Some services might be dead or unavailable. Please check your setup. Full setup failed."
          fi
      fi
EOF

    cd "$PROJECT_NAME/versions" && ls -ut | grep "$PROJECT_NAME" | tail -n +$((KEEP + 1)) | xargs rm -rf && cd - >/dev/null

    echo -e "${Green}Your newest app release ($file) is now live on -> ($i)!${Color_Off}\nYou can use your app if the services are set up correctly.\n"
  ) &
done
wait

echo -e "${BGreen}Server loop complete${Color_Off}"