Flashing ready-to-use disk images onto devices

lib/terminal.robot

@@ -248,7 +248,8 @@ Write Bare Into Terminal
     ...    None
     ...
     ...    === Arguments ===
-    ...    ``${text}``: ``string`` - The text to write
+    ...    - ``${text}``: ``string`` - The text to write
+    ...    - ``${interval}``: ``float`` - Delay in seconds between every character
     ...
     ...    === Return Value ===
     ...    None

scripts/ci/qemu-run.sh

@@ -61,6 +61,8 @@ This is the QEMU wrapper script for the Dasharo Open Source Firmware Validation.
     DIR         working directory, defaults to current working directory
     HDD2_PATH   optional path of the second hard drive to connect to the machine if
                 ACTION "os" is used. Relative to DIR
+    BRIDGE      if set, connects the machine to the local network via `br0` bridge
+                instead of doing address translation.
 
 Example usage:
     ./$(basename $0) vnc firmware
@@ -133,8 +135,8 @@ if [ $# -ne 2 ]; then
   usage
 fi
 
-QEMU_PARAMS_BASE="-machine q35,smm=on \
-  -global driver=cfi.pflash01,property=secure,value=on \
+QEMU_PARAMS_BASE="-machine q35,smm=on -cpu Skylake-Client \
+  -global driver=cfi.pflash01,property=secure,value=off \
   -drive if=pflash,format=raw,unit=0,file=${QEMU_FW_FILE} \
   -global ICH9-LPC.disable_s3=1 \
   -qmp unix:/tmp/qmp-socket,server,nowait \
@@ -155,9 +157,23 @@ QEMU_PARAMS_OS="-device ich9-intel-hda \
   -object rng-random,id=rng0,filename=/dev/urandom \
   -device virtio-rng-pci,max-bytes=1024,period=1000 \
   -device virtio-net,netdev=vmnic \
-  -netdev user,id=vmnic,hostfwd=tcp::5222-:22 \
   -drive file=${HDD_PATH},if=ide"
 
+# Setting up a bridge interface for QEMU
+# ip link add name br0 type bridge
+# ip link set <interface> master br0
+# ip addr flush dev <interface>
+# ip link set br0 up
+# ip addr add <interface_local_ip>/<mask> dev br0
+# ip route add default via <gateway_ip>
+
+if [[ -z ${BRIDGE} ]]; then
+  QEMU_PARAMS_OS+=" -netdev user,id=vmnic,hostfwd=tcp::5222-:22"
+else
+  echo "Using bridged network $BRIDGE"
+  QEMU_PARAMS_OS+=" -netdev bridge,id=vmnic,br=$BRIDGE"
+fi
+
 if [[ -f ${HDD2_PATH} ]]; then
   QEMU_PARAMS_OS+=" \
   -drive file=${HDD2_PATH},if=ide"

scripts/ci/setup_bridge.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+
+# SPDX-FileCopyrightText: 2025 3mdeb <[email protected]>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+INTERFACE=$1
+DEL=$2
+BR_NAME=br0
+
+function print_help {
+    echo ""
+    echo "Usage: $0 <interface> [del]"
+    echo ""
+    echo "The script creates a bridged interface that will be connected"
+    echo "to a network of given <interface>. The given interface is"
+    echo "toggled down."
+    echo ""
+    echo "Use optional [del] option to delete the bridge and restore"
+    echo "the original interface"
+    echo ""
+    echo "Examples:"
+    echo "  Set up bridge interface:"
+    echo "    $0 enp0s1"
+    echo "  Remove bridge and restore original interface:"
+    echo "    $0 enp0s1 del"
+}
+
+if [[ -z $INTERFACE ]]; then
+    print_help
+    exit 1
+fi
+
+ip link show $INTERFACE &> /dev/null
+if [[ $? -ne 0 ]]; then
+    print_help
+    exit 1
+fi
+
+if [[ $DEL == "del" ]]; then
+    ip link show $BR_NAME &> /dev/null
+    if [[ $? -ne 0 ]]; then
+        echo "Bridge interface $BR_NAME does not exist"
+        exit 0
+    fi
+
+    BR_IP=$(ip addr show $BR_NAME | awk '/inet / {print $2}')
+
+    echo "Deleting $BR_NAME IP: $BR_IP on $INTERFACE"
+
+    ip link del $BR_NAME
+    ip link set $INTERFACE up
+else
+    ip link show $BR_NAME &> /dev/null
+    if [[ $? -eq 0 ]]; then
+        echo "Bridge interface $BR_NAME already exists"
+        exit 0
+    fi
+    BR_IP=$(ip addr show $INTERFACE | awk '/inet / {print $2}')
+
+    echo "Setting up interface $BR_NAME IP: $BR_IP on $INTERFACE"
+
+    ip link add name $BR_NAME type bridge
+    ip link set $INTERFACE master $BR_NAME
+    ip addr flush dev $INTERFACE
+    ip link set $BR_NAME up
+    ip addr add $BR_IP dev $BR_NAME
+fi

util/preseeds.robot

@@ -0,0 +1,127 @@
+*** Settings ***
+Library         Collections
+Library         Dialogs
+Library         OperatingSystem
+Library         Process
+Library         String
+Library         Telnet    timeout=30 seconds    connection_timeout=120 seconds
+Library         SSHLibrary    timeout=90 seconds
+Library         RequestsLibrary
+# Library    ../osfv-scripts/osfv_cli/src/osfv/rf/rte_robot.py
+# TODO: maybe have a single file to include if we need to include the same
+# stuff in all test cases
+Resource        ../variables.robot
+Resource        ../keywords.robot
+Resource        ../keys.robot
+Resource        ../keys-and-keywords/ubuntu-keywords.robot
+
+Suite Setup     Run Keywords
+...                 Prepare Test Suite
+# Test suite used to quickly flash disk images with preinstalled OSes.
+# Two environment variables must be set prior to running it:
+# - SOURCE_IMAGE
+# - TARGET_DISK
+# Optional:
+# - CLONEZILLA_TTY
+#
+# Example usage:
+# - Flash the `1_windows_ubuntu` image onto the `nvme0n1` disk on the device using ${RTE_IP}:
+#    SOURCE_IMAGE=1_windows_ubuntu TARGET_DISK=nvme0n1 ./scripts/run.sh util/preseeds.robot -- -t "Restore Disk*"
+# - The same, but redirect the Clonezilla's output onto ttyS0 if video output is not available:
+#    SOURCE_IMAGE=1_windows_ubuntu TARGET_DISK=nvme0n1 CLONEZILLA_TTY=ttyS0 ./scripts/run.sh util/preseeds.robot -- -t "Restore Disk*"
+# - Launch clonezilla in manual mode over chosen serial console (for restore or upload):
+#    CLONEZILLA_TTY=ttyUSB0 ./scripts/run.sh util/preseeds.robot -- -t "Manual*"
+#
+#    Important: Don't run the whole test suite. Every test case is a
+#    separate functionality and running them all after each other does not
+#    make much sense, unless you know what you are doing.
+
+
+*** Variables ***
+${CLONEZILLA_IPXE_SERVER}=      http://192.168.10.217:8080
+${DISKS_NFS_IP}=                192.168.10.217
+${DISKS_NFS_PATH}=              /srv/nfs/disk-images
+
+
+*** Test Cases ***
+Restore Disk Clonezilla
+    ${clonezilla_tty}=    Get Envvar    CLONEZILLA_TTY    ${TRUE}
+    Set Suite Variable    ${CLONEZILLA_TTY}    ${clonezilla_tty}
+
+    ${source_image}=    Get Envvar    SOURCE_IMAGE
+    Set Suite Variable    ${SOURCE_IMAGE}    ${source_image}
+
+    ${target_disk}=    Get Envvar    TARGET_DISK
+    Set Suite Variable    ${TARGET_DISK}    ${target_disk}
+
+    Power On
+    ${ipxe_entered}=    Run Keyword And Return Status    Enter IPXE
+    IF    not ${ipxe_entered}    # It might just be disabled
+        Set UEFI Option    NetworkBoot    ${TRUE}
+        Power On
+        Enter IPXE
+    END
+    Execute Command In Terminal
+    ...    dhcp
+    ...    timeout=5m
+    IF    "${CLONEZILLA_TTY}" == "${EMPTY}"
+        Write Bare Into Terminal
+        ...    chain ${CLONEZILLA_IPXE_SERVER}/boot.ipxe?image=${SOURCE_IMAGE}&disk=${TARGET_DISK}
+        ...    interval=0.5
+    ELSE
+        Write Bare Into Terminal
+        ...    chain ${CLONEZILLA_IPXE_SERVER}/boot.ipxe?image=${SOURCE_IMAGE}&disk=${TARGET_DISK}&tty=${CLONEZILLA_TTY}
+        ...    interval=0.5
+    END
+    Press Enter
+
+    ${msg}=    Catenate    \nThe test case ends now, but the disks are not restored yet.\n
+    ...    The restoration will now begin.\n
+    ...    After a successful restoration, the device will reboot.\n
+    ...    You can monitor the progress on the video output,\n
+    ...    or on the selected TTY, if it was provided (\${CLONEZILLA_TTY}=\"${CLONEZILLA_TTY}\")
+    Log To Console    ${msg}
+
+Manual Clonezilla
+    ${clonezilla_tty}=    Get Envvar    CLONEZILLA_TTY    ${TRUE}
+    Set Suite Variable    ${CLONEZILLA_TTY}    ${clonezilla_tty}
+
+    Power On
+    ${ipxe_entered}=    Run Keyword And Return Status    Enter IPXE
+    IF    not ${ipxe_entered}    # It might just be disabled
+        Set UEFI Option    NetworkBoot    ${TRUE}
+        Power On
+        Enter IPXE
+    END
+    Execute Command In Terminal
+    ...    dhcp
+    ...    timeout=5m
+
+    IF    "${CLONEZILLA_TTY}" == "${EMPTY}"
+        Write Bare Into Terminal
+        ...    chain ${CLONEZILLA_IPXE_SERVER}/boot-manual.ipxe
+        ...    interval=0.5
+    ELSE
+        Write Bare Into Terminal
+        ...    chain ${CLONEZILLA_IPXE_SERVER}/boot-manual.ipxe?tty=${CLONEZILLA_TTY}
+        ...    interval=0.5
+    END
+    Press Enter
+
+    Log    Clonezilla booted in manual mode. Continue manually.    level=WARN
+    Execute Manual Step    Clonezilla booted in manual mode. Continue manually.
+
+
+*** Keywords ***
+Get Envvar
+    [Tags]    robot:private
+    [Arguments]    ${name}    ${optional}=${FALSE}
+    ${status}=    Run Keyword And Return Status    Get Environment Variable    ${name}
+    IF    not (${optional} or ${status})
+        Log To Console    Environment variable ${name} must be set.
+        Fail    Environment variable ${name} is not set
+    ELSE IF    ${status}
+        ${var}=    Get Environment Variable    ${name}
+        RETURN    ${var}
+    END
+    RETURN    ${EMPTY}