run.sh

#!/usr/bin/env bash
clear
#####################################################
#              SCRIPT							                  #
#####################################################
# ###script_version=0.0.6
# DO NOT CHANGE THE ABOVE LINE!!!!
#####################################################
#              VARIABLES							              #
#####################################################
start=`date +%s`
print_prefix="* * Automaton 9k - run.sh ==>"
dts=`date +%Y-%m-%d_%H:%M:%S`
#####################################################
#              USER CONFIG VARIABLES				        #
#####################################################
source run.properties
#####################################################
#              ARGUMENTS                            #
#####################################################
while [[ $# -gt 0 ]]; do
  args="$1"
  case $args in
    -b|--boxes)
    vagrant_boxes="$2"
    shift # past argument
    ;;
    -u|--update)
    script_force_update=true
    shift # past argument
    ;;
    -h|--help)
    show_help=true
    shift # past argument
    ;;
    *)
    # unknown option
    print_line "Unknown argument: $1"
    print_line "Use -h or --help for more information."
    exit 1
    ;;
  esac
  shift # past argument or value
done
#####################################################
#              MAIN CODE                            #
#####################################################
main() {
  # Using a function like this allows having other
    # functions called before they are actually defined
  print_line "#####################################################"
  print_line "#	 	Vagrant Automaton 9000                    #"
  print_line "#####################################################\n"

  print_line "#####################################################"
  print_line "#	 	Arguments                                 #"
  print_line "#####################################################"
  process_args
  print_done

  print_line "#####################################################"
  print_line "#	 	Variables                                 #"
  print_line "#####################################################"
  print_variables
  print_done

  print_line "#####################################################"
  print_line "#	 	Script                                    #"
  print_line "#####################################################"
  script_update
  print_done

  print_line "#####################################################"
  print_line "#	 	Vagrant                                   #"
  print_line "#####################################################"
  vagrant_install
  vagrant_get_plugins
  # Handled by Vagrantfile
  # vagrant_download_boxes
  print_done

  print_line "#####################################################"
  print_line "#	 	Ansible                                   #"
  print_line "#####################################################"
  ansible_install
  ansible_playbook_repo_clone
  ansible_config
  ansible_plugins
  ansible_prompt_vault_password
  # Handled by Vagrantfile
  # ansible_get_requirements
  print_done

  print_line "#####################################################"
  print_line "#	 	Boxes                                     #"
  print_line "#####################################################"
  if [[ -z "$vagrant_boxes" ]]; then
    vagrant_get_box_names
  fi

  print_line "Boxes: Box(es) is/are: $vagrant_boxes"
  for box in $vagrant_boxes
  do
    if !(vm_check_status $box); then
      vm_destroy $box
    fi

    if (vm_start $box); then
      print_line "Boxes: Box Started Successfully: '$box'"
    else
      print_line "Boxes: !!! ERROR !!!"
      print_line "Boxes: !!! ERROR !!!   Unable to bring up box: '$box'"
      print_line "Boxes: !!! ERROR !!!"
    fi

    if [[ "$vagrant_force_provisioning" == "true" ]]; then
      vagrant provision $box
    fi

    if [[ "$vagrant_force_reload" == "true" ]]; then
      vagrant reload $box
    fi
  done
  print_line "#####################################################"
  end=`date +%s`
  print_line "Total execution time: $((end-start)) seconds"
  print_line "#####################################################"
  print_line "#	 	Vagrant Automaton 9000                    #"
  print_line "#####################################################"
}
#####################################################
#              FUNCTIONS: HELPERS                   #
#####################################################
print_line() {
  echo -e "$print_prefix $@"
}

print_done() {
  print_line "#####################################################\n"
}

in_list() {
	[[ $1 =~ $2 ]] && return 0 || return 1	
}

sed_replace() {
	sed -i "s|.*$2.*|$3|" $1
}

vm_check_status() {
  print_line "Boxes: Checking box: $1"
  is_running=$(vagrant status $1 --machine-readable | grep -m 1 'state' | awk -F',' '{print $4}')
  if [[ "$is_running" == 'running' ]]; then
    print_line "Boxes: Box is currently running: '$1'"
  else
    print_line "Boxes: Box is NOT running: '$1'"
  fi
  [[ "$is_running" == 'running' ]] && return 1 || return 0
}

vm_destroy() {
  print_line "Boxes: Destroying box: '$1'"
  vagrant destroy -f $1
  return $?
}

vm_start() {
  print_line "Boxes: Starting Box: '$1'"
  vagrant up --provider $vagrant_box_provider $1
  [[ $? == 0 ]] && return 0 || return 1
}
#####################################################
#              FUNCTIONS: ARGUMENTS                 #
#####################################################
process_args() {
  if [[ "$script_force_update" == "true" ]]; then
    script_check_updates=true
    script_update
  fi
  
  print_help
}

print_help() {
  if [ "$show_help" == "true" ]; then
    print_line 
    print_line "run.sh Version: $(script_get_current_version)"
    print_line 
    printf "%-20s %-40s\n" "  -b|--boxes"   "Specifies which boxes to target for this run"
    printf "%-20s %-40s\n" "  -u|--update"  "Forces the script to update regardless of properties"
    printf "%-20s %-40s\n" "  -h|--help"    "Shows the help information"
    exit 0
  fi
}
#####################################################
#              FUNCTIONS: UPDATES                   #
#####################################################
script_update() {
  if [[ "$script_check_updates" != 'true' ]]; then
    print_line "Update: Update checking disabled by run.properties variable 'script_check_udpates'"
  else    
    if script_version_check ; then
      print_line "Update: Update available!"
    
      if script_download_updates ; then
        script_prep_update && script_do_update
      else 
        print_line "Update: Download Failed. Skipping update..."
      fi # Script_download_updates
      
      print_line "Update: Version: $script_ver_current is latest"
    else
      print_line "Update: Update not needed"
    fi #script_version_check
  fi #script_check_updates
}

## each separate version number must be less than 3 digit wide !
function version_check {
  echo "$@" | gawk -F. '{ printf("%03d%03d%03d\n", $1,$2,$3); }';
}

script_version_check() {
  print_line "Update: Checking for updates..."
  script_get_current_version
  script_ver_target=$(curl -s ${script_src_repo}/run.sh | grep '###script_version' | head -1 | awk -F= '{print $2}')
  print_line "Update: Comparing current version ($script_ver_current) to repo version ($script_ver_target)"
  [[ "$(version_check $script_ver_current)" -lt "$(version_check $script_ver_target)" ]] && return 0 || return 1
}

script_get_current_version() {
  script_ver_current=$(grep '###script_version' run.sh | head -1 | awk -F= '{print $2}')
}

script_download_updates() {
  download_success=true
  print_line "Update: Downloading updates..."
  if ! curl -s "${script_src_repo}/run.properties" -o run.properties.tmp ; then
    download_success=false
  fi
  
  if ! curl -s "${script_src_repo}/run.sh" -o run.sh.tmp ; then
    download_success=false
  fi

  [[ "$download_success" ]] && return 0 || return 1
}

script_prep_update() {
  # Set File Properties
  OCTAL_MODE=$(stat -c '%a' $(basename $0))
  if ! $(chmod $OCTAL_MODE "$0.tmp") ; then
    print_line "Update: Failed: Error while trying to set mode on $0.tmp."
  fi
  # Create actual update script
  cat > run.updateScript.sh << EOF
#!/bin/bash
d=`date +%Y-%m-%d_%H-%M-%S`
# Backup current script
if mv run.sh "run.sh.${d}" && mv "run.sh.tmp" "run.sh" ; then
  # mv run.properties "run.properties.${d}" && mv run.properties.tmp run.properties 
  echo "Update: Update complete! Relaunching..."
  exec /bin/bash "run.sh" "$@" && rm -f run.updateScript.sh
else
  echo "Update: Failed to move script files!"
  exit 1
fi
EOF
}

script_do_update() {
  exec /bin/bash "run.updateScript.sh" "$@"
  exit 0
}

print_variables() {
  while read -r line; do
    if [[ ! -z "${line// }" && "${line:0:1}" != '#' && "${line:0:1}" != ' ' ]]; then
      line=$(echo "$line" | cut -d'=' -f 1)
      printf "%-65s %-40s\n" "$print_prefix $line" ${!line}
    fi
  done < run.properties
}
#####################################################
#              FUNCTIONS: VAGRANT                   #
#####################################################
vagrant_install() {
  installed=$(which vagrant && echo $?)
  if [ "$installed" == '1' ]; then
    # print_line "Install: Installing ..."
    print_line "Install: Vagrant NOT installed. Auto installation is not yet supported. Install Vagrant & try again. Exiting..."
    exit 1
  else
    print_line "Install: Already installed"
  fi
}

vagrant_get_plugins() {
  if [[ "$vagrant_plugins_install" == "true" ]]; then
    for plugin in $vagrant_plugins; do
      print_line "Plugins: Checking for: $plugin"
      if ! vagrant plugin list | grep -q -i $plugin ; then
        print_line "Plugins: Installing: $plugin"
        vagrant plugin install $plugin
      else
        print_line "Plugins: Already installed: $plugin"
      fi
    done
  fi
}

vagrant_download_boxes() {
  if [ ! -z $vagrant_boxstore_url ]; then
  for box in $vagrant_boxes; do
    if [[ "$box" -ne 'default' ]]; then
    print_line "Boxes: Download box: '$box'"
    vagrant box add "${vagrant_boxstore_url}/${box}.box"
    fi
  done
  fi
}

vagrant_get_box_names() {
  vagrant_boxes=$(vagrant status --machine-readable | grep metadata | awk -F',' '{print $2}' | awk '{printf("%s,",$0)}' | sed 's/,\s*$//')
  return $?
}
#####################################################
#              FUNCTIONS: ANSIBLE                   #
#####################################################
ansible_install() {
  installed=$(which ansible && echo $?)
  if [ "$installed" == '1' ]; then
    # print_line "Install: Installing ..."
    print_line "Install: Ansible NOT installed. Auto installation is not yet supported. Install Ansible & try again. Exiting..."
    exit 1
  else
    print_line "Install: Already installed"
  fi
}

ansible_config() {
  if [[ "$ansible_replace_config" == "true" ]]; then
    print_line "Config: Removing current ansible.cfg"
    rm -f ansible.cfg  
  fi
  
  if [ ! -e ansible.cfg ]; then
    print_line "Config: Downloading 'clean' ansible.cfg"
    curl -s -k https://raw.githubusercontent.com/ansible/ansible/devel/examples/ansible.cfg -o ansible.cfg
  fi

  print_line "Config: Setting 'roles_path' to: 'ansible/roles'"
  sed_replace 'ansible.cfg' '#roles_path' 'roles_path = ansible/roles'

  if [[ "$ansible_use_log_plugin" == "true" ]]; then
    print_line "Config: Setting 'callback_plugins' to: 'ansible/plugins'"
    sed_replace 'ansible.cfg' '#callback_plugins' 'callback_plugins = ansible/plugins'
  fi

  print_line "Config: Settings 'cows' to off"
  sed_replace 'ansible.cfg' '#nocows' 'nocows = 1'

  print_line "Config: Disable retry files"
  sed_replace 'ansible.cfg' '#retry_files_enabled' 'retry_files_enabled = false'
}

ansible_playbook_repo_clone() {
  ret=0
  if [ ! -z "$ansible_playbook_repo" ]; then
    print_line "Repo: Checking playbook repo..."
    # Check if dir exists already
    if [[ -d ansible ]]; then
      print_line "Repo: Already cloned, pulling latest changes"
      git -C ./ansible pull || true
    else
      print_line "Repo: Cloning repo to ./ansible"
      git clone $ansible_playbook_repo ./ansible
      ret=$?
    fi
  fi
  return $?
}

ansible_plugins() {
  if [[ "$ansible_replace_config" == "true" && "$ansible_use_log_plugin" == "true" ]]; then
    if [ ! -e ansible/plugins/human_log.py ]; then
    print_line "Plugins: Downloading 'Human' Readable Ouptut"
    mkdir -p ansible/plugins
    # Source: https://gist.github.com/cliffano/9868180    
    # plugin_link="https://gist.githubusercontent.com/dmsimard/cd706de198c85a8255f6/raw/a2332f282be6e47286f588a9af6c10ff1b92749d/human_log.py"
    # plugin_link="https://raw.githubusercontent.com/redhat-openstack/khaleesi/master/plugins/callbacks/human_log.py"
    plugin_link="https://raw.githubusercontent.com/n0ts/ansible-human_log/master/human_log.py"
    curl -s $plugin_link -o ansible/plugins/human_log.py
    fi
  fi
}

ansible_prompt_vault_password() {
  if [[ "$ansible_ask_for_vault_password" == "true" ]]; then
    # Check if file already exists
    if [ -f ./ansible/vault-password.txt ]; then
      print_line "Vault Password: File already exists, skipping..."
    else
      print_line
      print_line "\tVault Password: Enter the vault password: "
      print_line 
      read -s ansible_vault_password
      echo $ansible_vault_password > ansible/vault-password.txt
      print_line "Vault Password: Saved to file: ansible/vault-password.txt"
    fi
  fi
}

ansible_get_requirements() {
  if [ -f ./ansible/requirements ]; then
    if [ ! -d .ansible/roles ]; then
      mkdir -p ansible/roles
    fi
  ansible-galaxy install -p ./ansible/roles/ -r ./ansible/requirements.yml
  fi
}
#####################################################
#              MAIN CODE CALL                       #
#####################################################
main
exit 0
#####################################################
#              TODOs                                #
#####################################################
# - Install Vagrant if not found
# - Install Ansible if not found
# - Install VirtualBox if not found
# - Check exit codes and stop script on errors