fuel-virtualbox/actions/prepare-environment.sh

#!/bin/bash
# set -x

#    Copyright 2013 Mirantis, Inc.
#
#    Licensed under the Apache License, Version 2.0 (the "License"); you may
#    not use this file except in compliance with the License. You may obtain
#    a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

#
# This script performs initial check and configuration of the host system. It:
#   - verifies that all available command-line tools are present on the host system
#   - accepts one parameter value ('launch' or 'clean') which indicates how it is should be used
#
# We are avoiding using 'which' because of http://stackoverflow.com/questions/592620/check-if-a-program-exists-from-a-bash-script
#

# Include the script with handy functions to operate VMs and VirtualBox networking
source ./config.sh
source ./functions/vm.sh
source ./functions/network.sh
source ./functions/shell.sh

# Check for the 'dumpkeys.cache' file
echo -n "Checking for 'dumpkeys.cache'... "
if ! [ -f dumpkeys.cache ]; then
  echo
  echo
  echo "The file 'dumpkeys.cache' shouldn't be removed from the main directory!"
  case "$(uname)" in
    CYGWIN*)
      echo "Please restore it from the sources, it can't be recreated on this operating system."
    ;;
    *)
      echo "Please restore it from the sources, or it can recreated using this command:"
      echo "  sudo dumpkeys --keys-only > dumpkeys.cache"
      echo "The 'dumpkeys' and 'sudo' should be installed first using your package manager."
    ;;
  esac
  echo "Aborting."
  exit 1
else
  echo "OK"
fi

# Check for procps package
if [ "$(execute uname -s | cut -c1-6)" = "CYGWIN" ]; then
  echo -n "Checking for 'free'... "
  execute type free >/dev/null 2>&1
  if [ $? -eq 1 ]; then
    echo
    echo
    echo "'free' is not available in the path, but it's required. Please install the 'procps' package. Aborting."
    exit 1
  else
    echo "OK"
  fi
fi

# Check for expect
echo -n "Checking for 'expect'... "
execute type expect >/dev/null 2>&1
if [ $? -eq 1 ]; then
  echo
  echo
  echo "'expect' is not available in the path, but it's required. Please install Tcl 'expect' package. Aborting."
  exit 1
else
  echo "OK"
fi

# Check for xxd
echo -n "Checking for 'xxd'... "
execute type xxd >/dev/null 2>&1
if [ $? -eq 1 ]; then
  echo
  echo
  echo "'xxd' is not available in the path, but it's required. Please install the 'xxd' package. Aborting."
  exit 1
else
  echo "OK"
fi

# Check for VirtualBox
echo -n "Checking for 'VBoxManage'... "
execute type VBoxManage >/dev/null 2>&1
if [ $? -eq 1 ]; then
  echo
  echo
  echo "'VBoxManage' is not available in the path, but it's required. Likely, VirtualBox is not installed. Aborting."
  exit 1
else
  echo "OK"
fi

# Check for VirtualBox Extension Pack
echo -n "Checking for VirtualBox Extension Pack... "
extpacks=`execute VBoxManage list extpacks | grep 'Usable' | grep 'true' | wc -l`
if [ "$extpacks" -le 0 ]; then
  echo
  echo
  echo "VirtualBox Extension Pack is not installed. Please, download and install it from the official VirtualBox web site at https://www.virtualbox.org/wiki/Downloads"
  exit 1;
else
  echo "OK"
fi

# execute some checks only in the 'launch' mode
if [ $1 == "launch" ]; then

# Check for VirtualBox iPXE firmware
echo -n "Checking for VirtualBox iPXE firmware..."
if [ -z $pxe_path ]; then
    echo "SKIP"
    if [ -z "$REMOTE_HOST" ]; then
        echo "VirtualBox iPXE firmware is not found. Used standard firmware from the VirtualBox Extension Pack."
        execute VBoxManage setextradata global VBoxInternal/Devices/pcbios/0/Config/LanBootRom
    fi
else
    echo "OK"
    if [ -z "$REMOTE_HOST" ]; then
        execute VBoxManage setextradata global VBoxInternal/Devices/pcbios/0/Config/LanBootRom "$(pwd)/$pxe_path" 2>/dev/null
        echo "Going to use iPXE boot firmware file $pxe_path"
    else
        echo "The iPXE boot on the remote system should be configured manually."
    fi
fi

# Check for ISO image to be available
echo -n "Checking for Mirantis OpenStack ISO image... "
if [ -z $iso_path ]; then
  echo
  echo
  echo "Mirantis OpenStack image is not found. Please download it from software.mirantis.com and put under the 'iso' directory."
  exit 1
else
  echo "OK"
  echo "Going to use Mirantis OpenStack ISO file: $iso_path"
fi

# Copy ISO to host
copy_if_required $iso_path

fi # end 'launch' mode check

# Check if SSH is installed. Cygwin does not install SSH by default.
echo -n "Checking if SSH client installed... "
execute type ssh >/dev/null 2>&1
if [ $? -eq 1 ]; then
  echo
  echo
  echo "SSH client is not installed. Please install the \"openssh\" package if you run this script under Cygwin. Aborting."
  exit 1
else
  echo "OK"
fi

echo -n "Checking if ipconfig or ifconfig installed... "
case "$(execute uname)" in
  Linux | Darwin)
    if ! execute test -x /sbin/ifconfig ; then
      echo
      echo
      echo "No ifconfig available at /sbin/ifconfig path! This path is hard-coded into VBoxNetAdpCtl utility."
      echo "Please install ifconfig or create symlink to proper interface configuration utility. Aborting."
      exit 1
    fi
  ;;
  CYGWIN*)
    # Cygwin does not use ifconfig at all and even has no link to it.
    # It uses built-in Windows ipconfig utility instead.
    execute type ipconfig >/dev/null 2>&1
    if [ $? -eq 1 ]; then
      echo
      echo
      echo "No ipconfig available in Cygwin environment. Please check you can run ipconfig from Cygwin command prompt. Aborting."
      exit 1
    fi
  ;;
  *)
    echo
    echo
    echo "$(execute uname) is not supported operating system."
    exit 1
  ;;
esac
echo "OK"

# Report success
echo "Done."