install_base.sh

#! /usr/bin/env bash

# Script to install the depenencies for LISA on an Ubuntu-like system.

# This is intended to be used for setting up containers and virtual machines to
# run LISA (e.g. for CI infrastructure or for Vagrant installation).
# This can also work for a fresh LISA install on a workstation.

# Read standard /etc/os-release file and extract the needed field lsb_release
# binary is not installed on all distro, but that file is found pretty much
# anywhere.
read_os_release() {
    local field_name=$1
    (source /etc/os-release &> /dev/null && printf "%s" "${!field_name}")
}

# Test the value of a field in /etc/os-release
test_os_release(){
    local field_name=$1
    local value=$2

    if [[ "$(read_os_release "$field_name")" == "$value" ]]; then
        # same as "true" command
        return 0
    else
        # same as "false" commnad
        return 1
    fi
}

lower_or_equal() {
    local x=$(printf "$1" | sed 's/\.//2g')
    local y=$(printf "$2" | sed 's/\.//2g')
    [[ "$(printf "$x\n$y\n" | sort -g | head -1)" == "$x" ]]
}

LISA_HOME=${LISA_HOME:-$(dirname "${BASH_SOURCE[0]}")}
cd "$LISA_HOME" || (echo "LISA_HOME ($LISA_HOME) does not exists" && exit 1)

# Must be kept in sync with shell/lisa_shell
ANDROID_HOME="$LISA_HOME/tools/android-sdk-linux/"
ANDROID_SDK_ROOT="$ANDROID_HOME"
mkdir -p "$ANDROID_HOME"

# No need for the whole SDK for this one
install_android_platform_tools() {
    echo "Installing Android platform tools ..."

    local url="https://dl.google.com/android/repository/platform-tools-latest-linux.zip"
    local archive="$ANDROID_HOME/android-platform-tools.zip"

    wget --no-verbose "$url" -O "$archive" &&
    echo "Extracting $archive ..." &&
    unzip -q -o "$archive" -d "$ANDROID_HOME"
}

cleanup_android_home() {
    echo "Cleaning up Android SDK: $ANDROID_HOME"
    rm -r "$ANDROID_HOME"
    mkdir -p "$ANDROID_HOME"
}

install_android_sdk_manager() {
    echo "Installing Android SDK manager ..."

    # URL taken from "Command line tools only": https://developer.android.com/studio
    # Used to be "https://dl.google.com/android/repository/commandlinetools-linux-7302050_latest.zip"
    # Used to be "https://dl.google.com/android/repository/commandlinetools-linux-8092744_latest.zip"
    # Used to be "https://dl.google.com/android/repository/commandlinetools-linux-9477386_latest.zip"
    local url="https://dl.google.com/android/repository/commandlinetools-linux-10406996_latest.zip"
    local archive="$ANDROID_HOME/android-sdk-manager.zip"
    rm "$archive" &>/dev/null

    echo "Downloading Android SDK manager from: $url"
    wget --no-verbose "$url" -O "$archive" &&
    echo "Extracting $archive ..." &&
    unzip -q -o "$archive" -d "$ANDROID_HOME"

    yes | (call_android_sdkmanager --licenses || true)
    call_android_sdkmanager --list
}

# Android SDK is picky on Java version, so we need to set JAVA_HOME manually.
# In most distributions, Java is installed under /usr/lib/jvm so use that.
# according to the distribution
ANDROID_SDK_JAVA_VERSION=17
find_java_home() {
    _JAVA_BIN=$(find -L /usr/lib/jvm -path "*$ANDROID_SDK_JAVA_VERSION*/bin/java" -not -path '*/jre/bin/*' -print -quit)
    _JAVA_HOME=$(dirname "$_JAVA_BIN")/../

    echo "Found JAVA_HOME=$_JAVA_HOME"
}

call_android_sdk() {
    # Used to be:
    # local tool="$ANDROID_HOME/tools/bin/$1"
    local tool="$ANDROID_HOME/cmdline-tools/bin/$1"
    shift
    echo "Using JAVA_HOME=$_JAVA_HOME for Android SDK" >&2
    # Use grep to remove the progress bar, as there is no CLI option for the SDK
    # manager to do that
    JAVA_HOME=$_JAVA_HOME "$tool" "$@" | grep -v '\[='
}

call_android_sdkmanager() {
    call_android_sdk sdkmanager --sdk_root="$ANDROID_SDK_ROOT" "$@"
}

# Needs install_android_sdk_manager first
install_android_tools() {
    # We could use install_android_platform_tools here for platform-tools if the
    # SDK starts being annoying
    yes | call_android_sdkmanager --verbose --channel=0 --install "build-tools;34.0.0"
    yes | call_android_sdkmanager --verbose --channel=0 --install "platform-tools"
}

# Clone alpine-chroot-install repo
clone_alpine_chroot_install() {
    rm -rf "$LISA_HOME/tools/alpine-chroot-install"
    git -C $LISA_HOME/tools clone https://github.com/alpinelinux/alpine-chroot-install.git --depth=1
}

install_apt() {
    echo "Installing apt packages ..."
    local apt_cmd=(DEBIAN_FRONTEND=noninteractive apt-get)
    sudo "${apt_cmd[@]}" update
    if [[ $unsupported_distro == 1 ]]; then
        for package in "${apt_packages[@]}"; do
            if ! sudo "${apt_cmd[@]}" install -y "$package"; then
                echo "Failed to install $package on that distribution" >&2
            fi
        done
    else
        sudo "${apt_cmd[@]}" install -y "${apt_packages[@]}" || exit $?
    fi
}

install_pacman() {
    echo "Installing pacman packages ..."
    sudo pacman -Sy --needed --noconfirm "${pacman_packages[@]}" || exit $?
}

register_pip_extra_requirements() {
    local requirements="$LISA_HOME/extra_requirements.txt"
    local devmode_requirements="$LISA_HOME/devmode_extra_requirements.txt"

    echo "Registering extra Python pip requirements in $requirements:"
    local content=$(printf "%s\n" "${pip_extra_requirements[@]}")
    printf "%s\n\n" "$content" | tee "$requirements"

    # All the requirements containing "./" are prefixed with "-e " to install
    # them in editable mode
    printf "%s\n\n" "$(printf "%s" "$content" | sed '/.\//s/^/-e /')" > "$devmode_requirements"
}

# Extra Python pip requirements, to be installed by lisa-install
pip_extra_requirements=()

# APT-based distributions like Ubuntu or Debian
apt_packages=(
    coreutils
    build-essential
    git
    openssh-client
    sshpass
    wget
    rsync
    unzip
    qemu-user-static
    kernelshark
    python3
    # venv is not installed by default on Ubuntu, even though it is part of the
    # Python standard library
    python3-pip
    python3-venv
    python3-tk
    python3-setuptools
)

# pacman-based distributions like Archlinux or its derivatives
pacman_packages=(
    coreutils
    git
    rsync
    openssh
    sshpass
    base-devel
    wget
    unzip
    qemu-user-static
    python
    python-pip
    python-setuptools
    kernelshark
)

HOST_ARCH="$(uname -m)"

# ABI-specific packages
case $HOST_ARCH in
    aarch64)
        # Allows building C extensions from sources, when they do not ship a
        # prebuilt wheel for that arch
        apt_packages+=(python3-dev)
        # pacman_packages+=()
        ;;
esac


# More recent versions of Ubuntu ship firefox as a snap package already
# containing the geckodriver
if test_os_release NAME "Ubuntu" && lower_or_equal "$(read_os_release VERSION_ID)" "22"; then
    # In order to save plots using bokeh, we need a browser usable with
    # selenium, along with its selenium driver.
    #
    # Note: firefox seems to cope well without X11, unlike chromium.
    apt_packages+=(firefox-geckodriver)
fi

# Array of functions to call in order
install_functions=(
    register_pip_extra_requirements
)

# Detection based on the package-manager, so that it works on derivatives of
# distributions we expect. Matching on distro name would prevent that.
if which apt-get &>/dev/null; then
    install_functions+=(install_apt)
    package_manager='apt-get'
    expected_distro="Ubuntu"

elif which pacman &>/dev/null; then
    install_functions+=(install_pacman)
    package_manager="pacman"
    expected_distro="Arch Linux"
else
    echo "The package manager of distribution $(read_os_release NAME) is not supported, will only install distro-agnostic code"
fi

if [[ ! -z "$package_manager" ]] && ! test_os_release NAME "$expected_distro"; then
    unsupported_distro=1
    echo
    echo "INFO: the distribution seems based on $package_manager but is not $expected_distro, some package names might not be right"
    echo
else
    unsupported_distro=0
fi

usage() {
    echo "Usage: $0 [--help] [--cleanup-android-sdk] [--install-android-tools]
    [--install-android-platform-tools] [--install-doc-extras]
    [--install-tests-extra] [--install-bisector-dbus] [--install-toolchains]
    [--install-vagrant] [--install-all]"
    cat << EOF

Install distribution packages and other bits that don't fit in the Python
venv managed by lisa-install. Archlinux and Ubuntu are supported, although
derivative distributions will probably work as well.

--install-android-platform-tools is not needed when using --install-android-tools,
but has the advantage of not needing a Java installation and is quicker to install.
EOF
}

# Defaults to --install-all if no option is given
if [[ -z "$@" ]]; then
    args=("--install-all")
else
    args=($@)
fi

# Use conditional fall-through ;;& to all matching all branches with
# --install-all
for arg in "${args[@]}"; do
    # We need this flag since *) does not play well with fall-through ;;&
    handled=0
    case "$arg" in

    "--cleanup-android-sdk")
        install_functions+=(cleanup_android_home)
        handled=1
        ;;&

    # TODO: remove --install-android-sdk, since it is only temporarily there to
    # give some time to migrate CI scripts
    "--install-android-sdk" | "--install-android-tools" | "--install-all")
        install_functions+=(
            find_java_home
            install_android_sdk_manager # Needed by install_android_build_tools
            install_android_tools
        )
        apt_packages+=(openjdk-$ANDROID_SDK_JAVA_VERSION-jre openjdk-$ANDROID_SDK_JAVA_VERSION-jdk)
        pacman_packages+=(jre$ANDROID_SDK_JAVA_VERSION-openjdk jdk$ANDROID_SDK_JAVA_VERSION-openjdk)
        handled=1;
        ;;&

    # Not part of --install-all since that is already satisfied by
    # --install-android-tools The advantage of that method is that it does not
    # require the Java JDK/JRE to be installed, and is a bit quicker. However,
    # it will not provide the build-tools which are needed by devlib.
    "--install-android-platform-tools")
        install_functions+=(install_android_platform_tools)
        handled=1;
        ;;&

    "--install-doc-extras" | "--install-all")
        apt_packages+=(plantuml graphviz pandoc)
        # plantuml can be installed from the AUR
        pacman_packages+=(graphviz pandoc)
        handled=1;
        ;;&

    # Requirement for LISA's self tests (in tests/ folder), not the synthetic
    # kernel tests.
    "--install-tests-extras" | "--install-all")
        apt_packages+=(clang)
        pacman_packages+=(clang)
        handled=1;
        ;;&

    "--install-toolchains" | "--install-all")
        apt_packages+=(build-essential gcc-arm-linux-gnueabi gcc-aarch64-linux-gnu)
        # arm-linux-gnueabihf-gcc can be installed from the AUR
        pacman_packages+=(base-devel aarch64-linux-gnu-gcc flex)

        # Build dependencies of some assets
        apt_packages+=(autopoint autoconf libtool bison flex cmake)
        # gettext for autopoint
        pacman_packages+=(gettext autoconf libtool bison cmake)

        install_functions+=(clone_alpine_chroot_install)

        handled=1;
        ;;&

    "--install-vagrant" | "--install-all")
        # Only install the package if we are not already inside the VM to save
        # some install time
        vm=$(systemd-detect-virt 2>/dev/null)
        if [[ $vm == 'oracle' ]] ; then
            echo "VirtualBox detected, not installing virtualbox apt packages" >&2
        elif [[ $HOST_ARCH == 'aarch64' ]]; then
            echo "VirtualBox not supported on $HOST_ARCH" >&2
        else
            apt_packages+=(vagrant virtualbox)
            pacman_packages+=(vagrant virtualbox virtualbox-host-dkms)
        fi

        handled=1;
        ;;&

    "--install-kernel-build-dependencies" | "--install-all")
        apt_packages+=(build-essential gcc bc bison flex libssl-dev libncurses5-dev libelf-dev)
        handled=1;
        ;;&

    "--install-bisector-dbus")
        apt_packages+=(
            gobject-introspection
            # Some of that seems to only be needed on some version of Ubuntu.
            # GTK/Glib does not shine on packaging side, so ere on the side of
            # caution and install all the things that seem to avoid issues ...
            libcairo2-dev
            libgirepository1.0-dev
            gir1.2-gtk-3.0
        )
        # plantuml can be installed from the AUR
        pacman_packages+=(gobject-introspection)
        pip_extra_requirements+=(./tools/bisector[dbus])
        handled=1;
        ;;&

    "--help")
        usage
        exit 0
        ;;&

    *)
        if [[ $handled != 1 ]]; then
            echo "Unrecognised argument: $arg"
            usage
            exit 2
        fi
        ;;
    esac
done

# In order in which they will be executed if specified in command line
ordered_functions=(
    # Distro package managers before anything else, so all the basic
    # pre-requisites are there
    install_apt
    install_pacman

    find_java_home
    # cleanup must be done BEFORE installing
    cleanup_android_home
    install_android_sdk_manager # Needed by install_android_build_tools
    install_android_tools
    install_android_platform_tools

    register_pip_extra_requirements
    clone_alpine_chroot_install
)

# Remove duplicates in the list
install_functions=($(echo "${install_functions[@]}" | tr ' ' '\n' | sort -u | tr '\n' ' '))

# Call all the hooks in the order of available_functions
ret=0
for _func in "${ordered_functions[@]}"; do
    for func in "${install_functions[@]}"; do
        if [[ $func == $_func ]]; then
            # If one hook returns non-zero, we keep going but return an overall failure
            # code
            $func; _ret=$?
            if [[ $_ret != 0 ]]; then
                ret=$_ret
                echo "Stage $func failed with exit code $ret" >&2
            else
                echo "Stage $func succeeded" >&2
            fi
        fi
    done
done

exit $ret

# vim: set tabstop=4 shiftwidth=4 textwidth=80 expandtab: