scripts/install.sh: Add install script

scripts/install.sh

@@ -0,0 +1,328 @@
+#!/bin/bash
+set -euo pipefail
+
+Res='\e[0;0m'
+# shellcheck disable=SC2034
+Red='\e[0;31m'
+Gre='\e[0;32m'
+Yel='\e[0;33m'
+Pur='\e[0;35m'
+
+color() {
+	printf "%b" "$1"
+}
+
+# header display functions
+hash_header() { echo "########################################"; }
+
+# We only want to clear if the user is actually using a GUI terminal
+if [[ -z ${TERM} ]]; then
+	clear
+fi
+
+# Display header
+cat <<EOF
+$(color "$Pur")
+         &@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@#
+       @@@@@@*,...................................................,/@@@@@@
+     ,@@@@                                                            ,@@@@
+     (@@@(                      /////&@* (@%////*                      &@@@*
+     (@@@(                 #         %@* (@(         &                 &@@@*
+     (@@@(                @@@@       %@* (@(      ,@@@@                &@@@*
+     (@@@(               &@@@@@@%    %@* (@(    @@@@@@@#               &@@@*
+     (@@@(              %/  @@@@@@@. %@* (@( ,@@@@@@&  #,              &@@@*
+     (@@@(             *&     ,@@@@@@@@* (@@@@@@@@      @.             &@@@*
+     (@@@(             @         (@@@@@* (@@@@@,         @             &@@@*
+     (@@@(            @             @@@* (@@#            ,@            &@@@*
+     (@@@(           &               %@* (@(              /#           &@@@*
+     (@@@(          %/               %@* (@(               %,          &@@@*
+     (@@@(         *@                %@* (@(                @.         &@@@*
+     (@@@(         @                 %@* (@(                 @         &@@@*
+     (@@@(        @                  %@* (@(                 ,@        &@@@*
+     (@@@(  .@@@@@@@@            &@@@@@* (@@@@@#            @@@@@@@@   &@@@*
+     (@@@#  .%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%   &@@@*
+     .@@@@.                                                           (@@@@
+       @@@@@@%////////////////////////////////////////////////////(&@@@@@@
+         #@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@/
+$(color "$Gre")
+$(hash_header)$(hash_header)
+                                  Welcome to the
+                             Machine Intelligence Lab
+                                      at the
+                               University of Florida
+
+                                  (now in ROS2!!)
+$(hash_header)$(hash_header)
+$(color "$Yel")
+This script will help to get your system installed with the needed dependencies.
+You shouldn't need to do much - sit back and watch the magic happen before your
+eyes!$(color "$Res")
+EOF
+
+sleep 1
+
+mil_system_install() {
+	sudo apt install -y "$@"
+}
+
+cat <<EOF
+$(color "$Pur")
+$(hash_header)
+Fetching latest apt packages...
+$(hash_header)
+EOF
+
+# Install neovim (to prevent cameron from going mad)
+sudo apt-add-repository ppa:neovim-ppa/stable -y
+
+# Update apt
+sudo apt update
+
+# Installation for virtual machines
+# Installs the apt-add-repository command
+sudo apt-get install software-properties-common -y
+
+# Installs keyboard config without prompting for input
+sudo DEBIAN_FRONTEND=noninteractive apt-get install keyboard-configuration -y # Weird bug
+
+cat <<EOF
+$(color "$Pur")
+$(hash_header)
+$(color "$Gre")Fetched latest apt packages.
+$(color "$Pur")Installing needed Linux dependencies...
+$(hash_header)$(color "$Res")
+
+EOF
+
+# System dependencies
+mil_system_install apt-utils
+mil_system_install --no-install-recommends \
+	ca-certificates \
+	curl \
+	dirmngr \
+	doxygen \
+	doxygen-doc \
+	doxygen-gui \
+	expect \
+	gnupg \
+	gnupg2 \
+	graphviz \
+	lsb-release \
+	neovim \
+	python3 \
+	ruby \
+	tzdata \
+	wget \
+	vim
+
+# Turn on breaking system packages in pip (set to 0 by default in noble)
+# Generally, our packages shouldn't break the system, but we will continue to monitor
+# this for the future. ROS2 and rosdep have a hard time with virtual environments,
+# and using system pip packages in the past has been fine.
+python3 -m pip config set global.break-system-packages true
+
+# Attempt to install vcstool using apt-get or pip if apt-get does not work
+sudo apt install -y python3-vcstool || sudo pip3 install -U vcstool
+
+cat <<EOF
+$(color "$Pur")
+$(hash_header)
+$(color "$Gre")Installed needed Linux dependencies.
+$(color "$Pur")Setting up ROS distributions...
+$(hash_header)$(color "$Res")
+
+EOF
+
+# Ensure that locales are set up correctly
+sudo apt update && sudo apt install locales
+sudo locale-gen en_US en_US.UTF-8
+sudo update-locale LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8
+export LANG=en_US.UTF-8
+
+# Add universe
+sudo add-apt-repository universe -y
+
+# ROS2 GPG key
+sudo curl -sSL https://raw.githubusercontent.com/ros/rosdistro/master/ros.key -o /usr/share/keyrings/ros-archive-keyring.gpg
+
+# ROS2 apt source
+echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/ros-archive-keyring.gpg] http://packages.ros.org/ros2/ubuntu $(. /etc/os-release && echo $UBUNTU_CODENAME) main" | sudo tee /etc/apt/sources.list.d/ros2.list >/dev/null
+
+# Install Gazebo apt source
+echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/pkgs-osrf-archive-keyring.gpg] http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/gazebo-stable.list >/dev/null
+
+# Pull ROS apt key
+sudo apt-key adv --keyserver 'hkp://keyserver.ubuntu.com:80' --recv-key C1CF6E31E6BADE8868B172B4F42ED6FBAB17C654
+# Pull gazebo apt key
+sudo apt-key adv --keyserver 'hkp://keyserver.ubuntu.com:80' --recv-key D2486D2DD83DB69272AFE98867170598AF249743
+
+# Setup Gazebo GPG key
+sudo curl https://packages.osrfoundation.org/gazebo.gpg --output /usr/share/keyrings/pkgs-osrf-archive-keyring.gpg
+echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/pkgs-osrf-archive-keyring.gpg] http://packages.osrfoundation.org/gazebo/ubuntu-stable $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/gazebo-stable.list >/dev/null
+# Update apt again and install ros
+sudo apt update
+
+cat <<EOF
+$(color "$Pur")
+$(hash_header)
+$(color "$Gre")Set up sources for ROS distributions.
+$(color "$Pur")Downloading ROS2 Jazzy Jalisco...
+$(hash_header)$(color "$Res")
+EOF
+
+mil_system_install ros-jazzy-desktop-full gz-harmonic
+# Install additional dependencies not bundled by default with ros
+# Please put each on a new line for readability
+mil_system_install \
+	ros-jazzy-tf2-sensor-msgs \
+	ros-jazzy-geographic-msgs \
+	ros-jazzy-vision-msgs \
+	ros-jazzy-velodyne
+
+cat <<EOF
+$(color "$Pur")
+$(hash_header)
+$(color "$Gre")Downloaded and installed ROS2 Jazzy Jalisco.
+$(color "$Pur")Installing Python dependencies...
+$(hash_header)$(color "$Res")
+EOF
+
+# Disable "automatic updates" Ubuntu prompt (thanks to https://askubuntu.com/a/610623!)
+if which update-manager >/dev/null 2>&1; then
+	sudo sed -i 's/Prompt=.*/Prompt=never/' /etc/update-manager/release-upgrades
+fi
+
+# Install Python 3 dependencies
+sudo pip3 install -r requirements.txt --break-system-packages
+
+cat <<EOF
+$(color "$Pur")
+$(hash_header)
+$(color "$Gre")Downloaded and setup Python dependencies.
+$(color "$Pur")Initializing rosdep...
+$(hash_header)$(color "$Res")
+EOF
+
+# Initialize rosdep
+sudo apt-get install python3-rosdep
+
+# Update rosdep
+sudo rm -rf /etc/ros/rosdep/sources.list.d/* # Delete this file first - if not deleted, error could be thrown
+sudo rosdep init
+sudo rosdep update
+
+# If this script is not ~/mil2/scripts/install.sh, throw an error to prevent members
+# from installing the repo in the wrong location. Setting ALLOW_NONSTANDARD_DIR=1
+# will bypass this check.
+SCRIPT_DIR=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)
+if [[ $SCRIPT_DIR != "$HOME/mil2/scripts" && -z ${ALLOW_NONSTANDARD_DIR:-} ]]; then
+	echo "${Red}Error: This script must be located in ~/mil2/scripts/install.sh. Please review the installation guide and try again.${Res}"
+	exit 1
+fi
+# COLCON_SOURCE_DIR="$HOME/src"
+
+# Clone repository
+mil_user_install_dependencies() {
+	sudo apt update
+	sudo apt install -y \
+		git \
+		tmux \
+		vim \
+		htop \
+		tmuxinator \
+		net-tools \
+		cifs-utils \
+		nmap \
+		fd-find \
+		ripgrep \
+		fzf \
+		aptitude \
+		lm-sensors
+}
+
+# Add line to user's bashrc which source the repo's setup files
+# This allows us to update aliases, environment variables, etc
+mil_user_setup_rc() {
+	# Line(s) added to ~/.bashrc or ~/.zshrc
+	# Note that for backwards compatibility this should not be changed
+	# unless you have a very good reason.
+	BASH_RC_LINES=". $SCRIPT_DIR/setup.bash"
+	if [[ $SHELL == "/usr/bin/zsh" ]]; then
+		# User is using zsh
+		if grep -Fq "$BASH_RC_LINES" ~/.zshrc; then
+			echo "milrc is already sourced in ~/.zshrc, skipping"
+		else
+			echo "Adding source of milrc to ~/.zshrc"
+			{
+				echo ""
+				echo "# Setup environment for MIL development"
+				echo "$BASH_RC_LINES"
+			} >>~/.zshrc
+		fi
+	else
+		# User is using zsh
+		if grep -Fq "$BASH_RC_LINES" ~/.bashrc; then
+			echo "milrc is already sourced in ~/.bashrc, skipping"
+		else
+			echo "Adding source of milrc to ~/.bashrc"
+			{
+				echo ""
+				echo "# Setup environment for MIL development"
+				echo "$BASH_RC_LINES"
+			} >>~/.bashrc
+		fi
+	fi
+}
+
+add_hosts_entry() {
+	sudo grep -qxF "$1" /etc/hosts || echo "$1" | sudo tee -a /etc/hosts >/dev/null
+}
+
+# Add /etc/hosts entry for vehicles
+add_hosts_entry "192.168.37.60 sub8"
+add_hosts_entry "192.168.37.82 navigator-two"
+
+# Builds the MIL repo
+mil_user_setup_init_colcon() {
+	cd $SCRIPT_DIR/..
+	colcon build
+}
+
+cat <<EOF
+$(color "$Pur")
+$(hash_header)
+$(color "$Gre")Initialized rosdep.
+$(color "$Pur")Installing user tools and shell...
+$(hash_header)$(color "$Res")
+EOF
+
+mil_user_install_dependencies
+mil_user_setup_rc
+set +u
+. /opt/ros/jazzy/setup.bash
+set -u
+
+cat <<EOF
+$(color "$Pur")
+$(hash_header)
+$(color "$Gre")Setup user tools and shell.
+$(color "$Pur")Compiling repository...
+$(hash_header)$(color "$Res")
+EOF
+
+touch ~/tmux.conf
+if grep 'set -g default-terminal "screen-256color"' ~/tmux.conf; then
+	echo "Tmux already has 256 color support, skip this step"
+else
+	echo 'set -g default-terminal "screen-256color"' >>~/.tmux.conf
+fi
+
+mil_user_setup_init_colcon
+
+cat <<EOF
+$(color "$Gre")
+$(hash_header)
+Congratulations! Installation complete.
+$(hash_header)
+$(color "$Res")
+EOF