sgi/pre-reqs: add script to install prerequisite packages for SGI platform

To build and execute the SGI platform software, certain host OS packages are
expected to be pre-installed. This script helps with installing the required
host packages.

Change-Id: Ib7a9639b7722426c57b68e1b19a25d406c342047
Signed-off-by: Lokesh Belathur Veerappa <lokesh.belathurveerappa@arm.com>

1 files changed, 221 insertions, 0 deletions

diff --git a/sgi/install_sgi_prerequisites.sh b/sgi/install_sgi_prerequisites.sh
new file mode 100755
index 0000000..81c0ab4
--- /dev/null
+++ b/sgi/install_sgi_prerequisites.sh
@@ -0,0 +1,221 @@
+#!/usr/bin/env bash
+
+# Copyright (c) 2019, ARM Limited and Contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+#
+# Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# Neither the name of ARM nor the names of its contributors may be used
+# to endorse or promote products derived from this software without specific
+# prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+############################################################################
+#                                                                          #
+#  Global Variables                                                        #
+#                                                                          #
+############################################################################
+
+RED='\033[0;31m'
+BLUE='\033[0;34m'
+GREEN='\033[0;32m'
+NORMAL='\033[0m'
+CYAN='\033[0;36m'
+LPURPLE='\033[1;35m'
+
+############################################################################
+# List of packages which would need to be installed via "apt-get install"  #
+# for all the platforms. This list should not include any package which is #
+# specific to any test or filesystem.                                      #
+############################################################################
+APT_PACKAGES_COMMON=(
+		"git"
+		"acpica-tools"
+		"bc"
+		"bison"
+		"build-essential"
+		"curl"
+		"flex"
+		"g++-multilib"
+		"gcc-multilib"
+		"genext2fs"
+		"gperf"
+		"libc6:i386"
+		"libssl-dev"
+		"libstdc++6:i386"
+		"libncurses5:i386"
+		"libxml2"
+		"libxml2-dev"
+		"libxml2-utils"
+		"libxml-libxml-perl"
+		"make"
+		"openssh-server"
+		"openssh-client"
+		"expect"
+		"bridge-utils"
+		"python"
+		"python-pip"
+		"device-tree-compiler"
+)
+
+###########################################################################
+# List of packages which would need to be installed via "apt-get install" #
+# for enterprise platform only. This list should not include any package  #
+# which is specific to any test or filesystem.                            #
+###########################################################################
+APT_PACKAGES_ENTERPRISE=(
+		"uuid-dev"
+		"wget"
+		"zlib1g:i386"
+		"zlib1g-dev:i386"
+		"zip"
+		"mtools"
+		"fuseext2"
+		"autoconf"
+		"locales"
+		"sbsigntool"
+)
+
+LOGFILE="./sgipkg_install.log"
+
+APT_PACKAGES_TO_INSTALL=( )
+APT_PACKAGES_FAILED=( )
+
+RC_ERROR=1
+RC_SUCCESS=0
+
+###########################################################################
+#                                                                         #
+#  Function: prepare_resources                                            #
+#  Description: set-up resources required for installing packages         #
+#                                                                         #
+###########################################################################
+function prepare_resources()
+{
+	# Get the list of packages to be installed
+	APT_PACKAGES_TO_INSTALL+=( "${APT_PACKAGES_COMMON[@]}" )
+	APT_PACKAGES_TO_INSTALL+=( "${APT_PACKAGES_ENTERPRISE[@]}" )
+
+	# Enable all the standard Ubuntu repositories
+	echo -ne "\nAdding required Ubuntu repositories to apt list..."
+	sudo add-apt-repository main > $LOGFILE 2>&1
+	sudo add-apt-repository universe >> $LOGFILE 2>&1
+	sudo add-apt-repository restricted >> $LOGFILE 2>&1
+	sudo add-apt-repository multiverse >> $LOGFILE 2>&1
+	echo >> $LOGFILE 2>&1
+	echo -e "${BOLD}${GREEN}done${NORMAL}"
+
+	# Add 'i386'  to dpkg architecture list
+	sudo dpkg --add-architecture i386 >> $LOGFILE 2>&1
+	echo >> $LOGFILE 2>&1
+
+	# Update package list
+	echo -ne "\nUpdating apt list..."
+	sudo apt-get update >> $LOGFILE 2>&1
+	echo >> $LOGFILE 2>&1
+	echo -e "${BOLD}${GREEN}done${NORMAL}"
+}
+
+###########################################################################
+#                                                                         #
+#  Function: install_package                                              #
+#  Description: Install required packages on the build machine            #
+#                                                                         #
+###########################################################################
+function install_package()
+{
+	i=1
+	n=${#APT_PACKAGES_TO_INSTALL[@]}
+	for pack in "${APT_PACKAGES_TO_INSTALL[@]}"
+	do
+		echo -ne "${BOLD}${CYAN}[$i/$n]${NORMAL} Installing '$pack' - "
+		echo >> $LOGFILE 2>&1
+		# Install the package
+		sudo apt-get install -y $pack >> $LOGFILE 2>&1
+		RC=$?
+		if [ $RC = $RC_SUCCESS ]
+		then
+			echo -e "${BOLD}${GREEN}done${NORMAL}\n"
+		else
+			echo -e "${BOLD}${RED}failed${NORMAL}\n"
+			APT_PACKAGES_FAILED+=( "$pack" )
+		fi
+		((i++))
+	done
+
+	if [ ${#APT_PACKAGES_FAILED[@]} -gt 0 ]
+	then
+		echo -e "\n${BOLD}${RED}Failed to install following packages!${NORMAL} \
+Check log file to find the specific reason for failure\n"
+		printf '%s\n' "${APT_PACKAGES_FAILED[@]}"
+	fi
+}
+
+############################################################################
+#                                                                          #
+#  Function: shutdown                                                      #
+#  Description: Handle untrapping trapped signals and output of the final  #
+#               return code from the script.                               #
+#                                                                          #
+############################################################################
+function shutdown()
+{
+	trap '' 1 2 3 15
+
+	exit $1
+}
+
+############################################################################
+#                                                                          #
+#  Function:     main                                                      #
+#  Description:  Entry point for the script.                               #
+#                                                                          #
+############################################################################
+
+	trap 'shutdown' 1 2 3 15
+
+	# Check for 'root' permission
+	if [[ $EUID -ne 0 ]]
+	then
+		echo -e "\n'sudo' privilege is required to install pre-requisite packages\n"
+		shutdown $RC_ERROR
+	fi
+
+	if [ ! -f $LOGFILE ]
+	then
+		/bin/touch $LOGFILE &>/dev/null
+	fi
+	echo "LOGFILE is $LOGFILE"
+
+	echo -e "\nInstalltion of prerequisites started on \
+${NORMAL} ${BOLD}${BLUE}`date`${NORMAL}\n"
+
+	prepare_resources
+
+	echo -e "\nInstalling Required Packages:\n\n"
+	install_package
+
+	echo -e "\nInstalltion of prerequisites ended at \
+${NORMAL} ${BOLD}${BLUE}`date`${NORMAL}\n"
+
+	shutdown $?
+
+#end of main