build.sh

#!/bin/bash

# Setting interactive mode to 'no' as standard
INTERACTIVE=no

# Generate a timestamp: YEAR-MONTH-DAY_HOURS-MINUTES
TIMESTAMP=$(date +%Y-%m-%d_%H-%M)

# -h/--help option for commandline instructions
##########################################################################################################################
usage() {
    echo "Usage: $0 [-h|--help] [-s|--suite SUITE] [-d|--desktop DESKTOP] [-a|--additional ADDITIONAL] [-u|--username USERNAME] [-p|--password PASSWORD] [-b]"
    echo "-------------------------------------------------------------------------------------------------"
    echo "Options:"
    echo "  -h, --help                      Show this help message and exit"
    echo "  -s, --suite SUITE               Choose the Debian suite (e.g., testing, experimental, trixie)"
    echo "  -k, --kernel latest/standard    Choose which kernel to install"
    echo "  -H, --headers yes/no            Install Kernel headers(only works with standard Kernel)"
    echo "  -d, --desktop DESKTOP           Choose the desktop environment."
    echo "                                  (none/xfce4/gnome/cinnamon/lxqt/lxde/unity/budgie/kde)"
    echo "                                  This only has an effect in kombination with -d or --desktop"
    echo "  -u, --username USERNAME         Enter the username for the sudo user"
    echo "  -p, --password PASSWORD         Enter the password for the sudo user"
    echo "  -i, --interactive yes/no        Start an interactive shell inside the container"
    echo "  -b                              Build the image with the specified configuration without asking"
    echo "-------------------------------------------------------------------------------------------------"
    echo "For example: $0 -s sid -d none -k latest -u USERNAME123 -p PASSWORD123 -b"
    exit 1
}

# Check if running with sudo
if [ "$UID" -ne 0 ]; then
    echo "This program needs sudo rights."
    echo "Run it with 'sudo $0'"
    exit 1
fi

# Parse arguments
while [[ "$#" -gt 0 ]]; do
    case $1 in
        -h|--help) usage;;
        -s|--suite) SUITE="$2"; shift ;;
        -k|--kernel) KERNEL="$2"; shift ;;
        -H|--headers) HEADERS="$2"; shift ;;
        -d|--desktop) DESKTOP="$2"; shift ;;
        -u|--username) USERNAME="$2"; shift ;;
        -p|--password) PASSWORD="$2"; shift ;;
        -i|--interactive) INTERACTIVE="$2"; shift ;;
        -b) BUILD="yes" ;;
        *) echo "Unknown parameter passed: $1"; usage ;;
    esac
    shift
done

# Cleaning Build area
echo "----------------------"
echo "cleaning build area..."
echo "----------------------"
sleep 2
rm .config
rm .rootfs.img
rm .rootfs.tar
rm -rf .rootfs/
rm config/rootfs_size.txt
echo ""
# Check if arguments are missing
##########################################################################################################################
if [ -z "$SUITE" ] || [ -z "$DESKTOP" ] || [ -z "$USERNAME" ] || [ -z "$PASSWORD" ] || [ -z "$KERNEL" ] || [ -z "$HEADERS" ]; then

##########################################################################################################################
# NOW THE MENU FOR CHOOSING REQUIRED OPTIONS START IF NOT ENOUGH COMMANDLINE ARGUMENTS ARE GIVEN
##########################################################################################################################

# Welcome message
##########################################################################################################################
info_text="                          Welcome to rock4se-image-builder\n"
whiptail --title "Information" --msgbox "$info_text" 20 65
# Here we choose the Debian Suite
##########################################################################################################################
whiptail --title "Menu" --menu "Choose a Debian Suite" 20 65 6 \
"1" "testing" \
"2" "experimental" \
"3" "trixie" \
"4" "sid" \
"5" "bookworm" \
"6" "bullseye" 2> choice.txt
choice=$(cat choice.txt)

case $choice in
  1)
    echo "SUITE=testing" > .config
    ;;
  2)
    echo "SUITE=experimental" > .config
    ;;
  3)
    echo "SUITE=trixie" > .config
    ;;
  4)
    echo "SUITE=sid" > .config
    ;;
  5)
    echo "SUITE=bookworm" > .config
    ;;
  6)
    echo "SUITE=bullseye" > .config
    ;;
  *)
    echo "Invalid option"
    ;;
esac

rm choice.txt

# Here we choose the Kernel to install
##########################################################################################################################
whiptail --title "Menu" --menu "Choose Kernel to install" 20 65 6 \
"1" "Standardkernel of the Debian Suite" \
"2" "Download and compile latest availible Kernel" 2> choice.txt
choice=$(cat choice.txt)

case $choice in
  1)
    echo "KERNEL=standard" >> .config
    ;;
  2)
    echo "KERNEL=latest" >> .config
    ;;
  *)
    echo "Invalid option"
    ;;
esac

rm choice.txt
# Here we choose installation of the kernel headers
##########################################################################################################################
whiptail --title "Menu" --menu "KERNEL HEADERS" 20 65 6 \
"1" "Install Kernel headers(only works with standard Kernel)" \
"2" "Do not install Kernel headers" 2> choice.txt
choice=$(cat choice.txt)

case $choice in
  1)
    echo "HEADERS=yes" >> .config
    ;;
  2)
    echo "HEADERS=no" >> .config
    ;;
  *)
    echo "Invalid option"
    ;;
esac

rm choice.txt
# Here we choose the desktop which will be installed
##########################################################################################################################
whiptail --title "Menu" --menu "Choose a Desktop option" 20 65 10 \
"1" "none" \
"2" "xfce" \
"3" "gnome" \
"4" "mate" \
"5" "cinnamon" \
"6" "lxqt" \
"7" "lxde" \
"8" "unity" \
"9" "budgie" \
"10" "kde" 2> choice.txt
choice=$(cat choice.txt)

case $choice in
  1)
    echo "DESKTOP=CLI" >> .config
    ;;
  2)
    echo "DESKTOP=xfce4" >> .config
    ;;
  3)
    echo "DESKTOP=gnome" >> .config
    ;;
  4)
    echo "DESKTOP=mate" >> .config
    ;;
  5)
    echo "DESKTOP=cinnamon" >> .config
    ;;
  6)
    echo "DESKTOP=lxqt" >> .config
    ;;
  7)
    echo "DESKTOP=lxde" >> .config
    ;;
  8)
    echo "DESKTOP=unity" >> .config
    ;;
  9)
    echo "DESKTOP=budgie" >> .config
    ;;
  10)
    echo "DESKTOP=kde" >> .config
    ;;
  *)
    echo "Invalid option"
    ;;
esac
rm choice.txt
# Here we choose Username and Password for the only created user
##########################################################################################################################    

USERNAME=$(whiptail --title "Create sudo user" --inputbox "Enter username:" 20 65 3>&1 1>&2 2>&3)

# Passwort abfragen
PASSWORD=$(whiptail --title "Create sudo user" --passwordbox "Enter password:" 20 65 3>&1 1>&2 2>&3)

echo "USERNAME=${USERNAME}" >> .config
echo "PASSWORD=${PASSWORD}" >> .config
# Here we can decide if we wish an interactive shell inside the docker container or not
##########################################################################################################################
whiptail --title "Menu" --menu "Choose an option" 20 65 4 \
"1" "Just build with the given configuration" \
"2" "Start interactive shell in the container" 2> choice.txt

choice=$(cat choice.txt)

case $choice in
  1)
    echo "INTERACTIVE=no" >> .config
    ;;
  2)
    echo "INTERACTIVE=yes" >> .config
    ;;
  *)
    echo "Invalid option"
    ;;
  esac
  rm choice.txt
# Read the configuration from the configfile
##########################################################################################################################
  while IFS='=' read -r key value; do
    case "$key" in
    	SUITE)
    		SUITE="$value"
    		;;
        KERNEL)
            KERNEL="$value"
            ;;
        DESKTOP)
            DESKTOP="$value"
            ;;
        HEADERS)
            HEADERS="$value"
            ;;
        USERNAME)
            USERNAME="$value"
            ;;
        PASSWORD)
            PASSWORD="$value"
            ;;
        INTERACTIVE)
            INTERACTIVE="$value"
            ;;
        *)
            ;;
    esac
  done < .config
# Displaying the configuration of the build and ask for start or cancel the build-process
##########################################################################################################################
  display_variables() {
    whiptail --title "Is this configuration correct?" --yesno \
    "SUITE=$SUITE\nKERNEL=$KERNEL\nHEADERS=$HEADERS\nDESKTOP=$DESKTOP\nUSERNAME=$USERNAME\nPASSWORD=$PASSWORD\nINTERACTIVE=$INTERACTIVE" \
    20 65
  }

# Anzeige der Variablen aufrufen
  display_variables

# Überprüfen der Benutzerantwort
  if [ $? -eq 0 ]; then
      BUILD=yes
  elif [ $? -eq 1 ]; then
      BUILD=no
  fi
fi


# Start the building process
##########################################################################################################################
if [[ "$BUILD" == "yes" ]]; then
    while IFS='=' read -r key value; do
        case "$key" in
            DESKTOP)
                DESKTOP="$value"
                ;;
            KERNEL)
                KERNEL="$value"
                ;;
            HEADERS)
                HEADERS="$value"
                ;;
            USERNAME)
                USERNAME="$value"
                ;;
            PASSWORD)
                PASSWORD="$value"
                ;;
            INTERACTIVE)
                INTERACTIVE="$value"
                ;;
            *)
                ;;
        esac
    done < .config

# If latest Kernel was chosen starting the download and building process of the latest availible Linux Kernel
##########################################################################################################################
    if [ "$KERNEL" == "latest" ]; then
      echo "0" > config/kernel_status
      xfce4-terminal --title="Building Kernel" --command="config/makekernel.sh $HEADERS" &
    fi
# Building a docker image for the root filesystem creation
##########################################################################################################################    
    echo "Building Docker image..."
    sleep 1
    docker kill debiancontainer
    docker rm debiancontainer
    docker rmi debian:finest
    docker build --build-arg "SUITE="$SUITE --build-arg "DESKTOP="$DESKTOP --build-arg "USERNAME="$USERNAME --build-arg "PASSWORD="$PASSWORD --build-arg "KERNEL="$KERNEL --build-arg "HEADERS="$HEADERS -t debian:finest -f config/Dockerfile .
# Create a docker container with the previous created docker image
##########################################################################################################################    
    docker run --platform=aarch64 -dit --name debiancontainer debian:finest /bin/bash  

# If latest Kernel was chosen waiting for finished cross-compilation and install it inside the container
##########################################################################################################################
    if [ "$KERNEL" == "latest" ]; then
      echo "Waiting for Kernel compilation..."
      while [[ "$(cat config/kernel_status)" != "1" ]]; do
        sleep 2
      done
      rm config/kernel_status
      docker cp kernel*.zip debiancontainer:/
      docker cp config/installkernel.sh debiancontainer:/
      docker exec debiancontainer bash -c '/installkernel.sh kernel-*.zip'
      docker exec debiancontainer bash -c 'rm -rf /kernel*.zip'
      docker exec debiancontainer bash -c 'rm /installkernel.sh'
      docker exec debiancontainer bash -c 'u-boot-update'
      rm kernel-*.zip
    else
      echo "standard" > config/release
    fi

# If interactive shell was selected start it
##########################################################################################################################    
    if [[ "$INTERACTIVE" == "yes" ]]; then
        docker attach debiancontainer
        docker start debiancontainer       
    fi
# Get size of the root filesystem(needed for image creation)  
##########################################################################################################################    
    docker exec debiancontainer bash -c "echo \$((\$(du -s -m --exclude=/proc --exclude=/sys --exclude=/dev / | awk '{print \$1}'))) > /rootfs_size.txt"
    docker cp debiancontainer:/rootfs_size.txt config/

# Image creation
##########################################################################################################################
    ROOTFS=.rootfs.img
    rootfs_size=$(cat config/rootfs_size.txt)
    
    echo "Creating an empty rootfs image..."
    dd if=/dev/zero of=$ROOTFS bs=1M count=$((${rootfs_size} + 750)) status=progress
    rm config/rootfs_size.txt
    mkfs.ext4 -L rootfs $ROOTFS -F
    mkfs.ext4 ${ROOTFS} -L rootfs -F
    mkdir -p .loop/root
    mount ${ROOTFS} .loop/root
    docker export -o .rootfs.tar debiancontainer
    tar -xvf .rootfs.tar -C .loop/root
    rm .loop/root/.dockerenv
    docker kill debiancontainer
    mkdir -p output/Debian-${SUITE}-${DESKTOP}-build-${TIMESTAMP}/.qemu
    
    # Copy the Kernel and intard image to emulate the build with QEMU
    cp .loop/root/boot/vmlinuz* output/Debian-${SUITE}-${DESKTOP}-build-${TIMESTAMP}/.qemu/vmlinuz
    cp .loop/root/boot/initrd* output/Debian-${SUITE}-${DESKTOP}-build-${TIMESTAMP}/.qemu/initrd.img
    umount .loop/root

    e2fsck -f ${ROOTFS}
    gzip ${ROOTFS}
    mkdir -p output/Debian-${SUITE}-${DESKTOP}-build-${TIMESTAMP}/.qemu
    RELEASE=$(cat config/release)
# Creating the final build
##########################################################################################################################
    zcat config/boot-rock_pi_4se.bin.gz ${ROOTFS}.gz > "output/Debian-${SUITE}-${DESKTOP}-build-${TIMESTAMP}/Debian-${SUITE}-${DESKTOP}-Kernel-${RELEASE}.img"
    chown -R ${SUDO_USER}:${SUDO_USER} output/
    rm -rf .loop/root .loop/ .rootfs.img .rootfs.tar "${ROOTFS}.gz"
    SDCARDIMAGE="output/Debian-${SUITE}-${DESKTOP}-build-${TIMESTAMP}/Debian-${SUITE}-${DESKTOP}-Kernel-${RELEASE}.img"
    filesize=$(stat -c %s "output/Debian-${SUITE}-${DESKTOP}-build-${TIMESTAMP}/Debian-${SUITE}-${DESKTOP}-Kernel-${RELEASE}.img")
    if [ $filesize -gt 1073741824 ]; then
      if [ -e "$(dirname $SDCARDIMAGE)/.qemu/vmlinuz" ] && [ -e "$(dirname $SDCARDIMAGE)/.qemu/initrd.img" ]; then
        echo "--------------------------------------"
        echo "CONGRATULATION, BUILD WAS SUCCESSFULL!"
        echo "--------------------------------------"
      fi
    else
        echo "--------------------------------"
        echo "SORRY, BUILD WAS NOT SUCCESSFULL"
        echo "--------------------------------"
    fi
    rm config/release
    rm -rf "$(dirname "$SDCARDIMAGE")/.qemu"
fi