CI: Refine Linux boot script for new feature verification

ChinYikMing · ChinYikMing · commit e2e87ee26385 · 2025-03-20T22:46:55.000+08:00
The Linux boot script previously tested both booting and VirtIO block
access simultaneously. This commit refines the boot script to test each
guest Linux feature independently. In addition, a new color (yellow) is
introduced to clearly indicate which test is currently running in the
CI, improving debugging capabilities. For future VirtIO device tests or
other new features, TEST_OPTIONS and EXPECT_CMDS can be easily updated
to extend the tests, enhancing the overall flexibility of the script.

The VirtIO block device image or loop device is prepared by the
.ci/boot-linux-prepare.sh script which decouples data and control for
system emulation validation in .ci/boot-linux.sh. This script can be
extended in the future to support additional VirtIO devices by preparing
their associated data prior to Linux boot validation.

The system validation flow is abstracted into a variable called
BOOT_LINUX_TEST which uses sudo only for data preparation and does not
use sudo to run .ci/boot-linux.sh, enhancing security when launching
the system VM.
diff --git a/.ci/boot-linux-prepare.sh b/.ci/boot-linux-prepare.sh
@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+
+. .ci/common.sh
+
+check_platform
+
+VBLK_IMG=build/disk.img
+which dd >/dev/null 2>&1 || { echo "Error: dd not found"; exit 1; }
+which mkfs.ext4 >/dev/null 2>&1 || which $(brew --prefix e2fsprogs)/sbin/mkfs.ext4 >/dev/null 2>&1 || \
+	{ echo "Error: mkfs.ext4 not found"; exit 1; }
+which 7z >/dev/null 2>&1 || { echo "Error: 7z not found"; exit 1; }
+
+ACTION=$1
+
+case "$ACTION" in
+    setup)
+        # Setup a disk image
+        dd if=/dev/zero of=${VBLK_IMG} bs=4M count=32
+
+        # Setup a /dev/ block device with ${VBLK_IMG} to test guestOS access to hostOS /dev/ block device
+        case "${OS_TYPE}" in
+            Linux)
+                mkfs.ext4 ${VBLK_IMG}
+                BLK_DEV=$(losetup -f)
+                losetup ${BLK_DEV} ${VBLK_IMG}
+            ;;
+            Darwin)
+                $(brew --prefix e2fsprogs)/sbin/mkfs.ext4 ${VBLK_IMG}
+                BLK_DEV=$(hdiutil attach -nomount ${VBLK_IMG})
+            ;;
+        esac
+
+        # On Linux, ${VBLK_IMG} will be created by root and owned by root:root.
+        # Even if "others" have read and write (rw) permissions, accessing the file for certain operations may
+        # still require elevated privileges (e.g., setuid).
+        # To simplify this, we change the ownership to a non-root user.
+        # Use this with caution—changing ownership to runner:runner is specific to the GitHub CI environment.
+        chown runner: ${VBLK_IMG}
+        # Add other's rw permission to the disk image and device, so non-superuser can rw them
+        chmod o+r,o+w ${VBLK_IMG}
+        chmod o+r,o+w ${BLK_DEV}
+
+        # Export ${BLK_DEV} to a tmp file. Then, source to "$GITHUB_ENV" in job step.
+        echo "export BLK_DEV=${BLK_DEV}" > "${TMP_FILE}"
+        ;;
+    cleanup)
+        # Detach the /dev/loopx(Linux) or /dev/diskx(Darwin)
+        case "${OS_TYPE}" in
+            Linux)
+                losetup -d ${BLK_DEV}
+            ;;
+            Darwin)
+                hdiutil detach ${BLK_DEV}
+            ;;
+        esac
+
+        # delete disk image
+        rm -f ${VBLK_IMG}
+
+        # delete tmp file
+        rm "${TMP_FILE}"
+        ;;
+    *)
+        printf "Usage: %s {setup|cleanup}\n" "$0"
+        exit 1
+        ;;
+esac
diff --git a/.ci/boot-linux.sh b/.ci/boot-linux.sh
@@ -1,5 +1,9 @@
 #!/usr/bin/env bash
 
+. .ci/common.sh
+
+check_platform
+
 function cleanup {
     sleep 1
     pkill -9 rv32emu
@@ -8,71 +12,98 @@ function cleanup {
 function ASSERT {
     $*
     local RES=$?
-    if [ $RES -ne 0 ]; then
+    if [ ${RES} -ne 0 ]; then
         echo 'Assert failed: "' $* '"'
-        exit $RES
+        exit ${RES}
     fi
 }
 
 cleanup
 
 ENABLE_VBLK=1
 VBLK_IMG=build/disk.img
-which dd >/dev/null 2>&1 || ENABLE_VBLK=0
-which mkfs.ext4 >/dev/null 2>&1 || which $(brew --prefix e2fsprogs)/sbin/mkfs.ext4 >/dev/null 2>&1 || ENABLE_VBLK=0
-which 7z >/dev/null 2>&1 || ENABLE_VBLK=0
+[ -f "${VBLK_IMG}" ] || ENABLE_VBLK=0
 
 TIMEOUT=50
-OPTS=" -k build/linux-image/Image "
-OPTS+=" -i build/linux-image/rootfs.cpio "
-if [ "$ENABLE_VBLK" -eq "1" ]; then
-    dd if=/dev/zero of=$VBLK_IMG bs=4M count=32
-    mkfs.ext4 $VBLK_IMG || $(brew --prefix e2fsprogs)/sbin/mkfs.ext4 $VBLK_IMG
-    OPTS+=" -x vblk:$VBLK_IMG "
-else
-    printf "Virtio-blk Test...Passed\n"
-fi
-RUN_LINUX="build/rv32emu ${OPTS}"
+OPTS_BASE=" -k build/linux-image/Image"
+OPTS_BASE+=" -i build/linux-image/rootfs.cpio"
 
-if [ "$ENABLE_VBLK" -eq "1" ]; then
-ASSERT expect <<DONE
-set timeout ${TIMEOUT}
-spawn ${RUN_LINUX}
-expect "buildroot login:" { send "root\n" } timeout { exit 1 }
-expect "# " { send "uname -a\n" } timeout { exit 2 }
-expect "riscv32 GNU/Linux" { send "mkdir mnt && mount /dev/vda mnt\n" } timeout { exit 3 }
-expect "# " { send "echo rv32emu > mnt/emu.txt\n" } timeout { exit 3 }
-expect "# " { send "sync\n" } timeout { exit 3 }
-expect "# " { send "umount mnt\n" } timeout { exit 3 }
-expect "# " { send "\x01"; send "x" } timeout { exit 3 }
-DONE
-else
-ASSERT expect <<DONE
-set timeout ${TIMEOUT}
-spawn ${RUN_LINUX}
+TEST_OPTIONS=("base (${OPTS_BASE})")
+EXPECT_CMDS=('
 expect "buildroot login:" { send "root\n" } timeout { exit 1 }
 expect "# " { send "uname -a\n" } timeout { exit 2 }
 expect "riscv32 GNU/Linux" { send "\x01"; send "x" } timeout { exit 3 }
-DONE
-fi
-ret=$?
-cleanup
+')
 
 COLOR_G='\e[32;01m' # Green
 COLOR_R='\e[31;01m' # Red
+COLOR_Y='\e[33;01m' # Yellow
 COLOR_N='\e[0m' # No color
 
 MESSAGES=("${COLOR_G}OK!" \
      "${COLOR_R}Fail to boot" \
      "${COLOR_R}Fail to login" \
      "${COLOR_R}Fail to run commands" \
-     "${COLOR_R}Fail to find emu.txt in $VBLK_IMG"\
+     "${COLOR_R}Fail to find emu.txt in ${VBLK_IMG}"\
 )
 
-printf "\nBoot Linux Test: [ ${MESSAGES[$ret]}${COLOR_N} ]\n"
-if [ "$ENABLE_VBLK" -eq "1" ]; then 
-    7z l $VBLK_IMG | grep emu.txt >/dev/null 2>&1 || ret=4
-    printf "Virtio-blk Test: [ ${MESSAGES[$ret]}${COLOR_N} ]\n"
+if [ "${ENABLE_VBLK}" -eq "1" ]; then
+    # Read-only
+    TEST_OPTIONS+=("${OPTS_BASE} -x vblk:${VBLK_IMG},readonly")
+    EXPECT_CMDS+=('
+    expect "buildroot login:" { send "root\n" } timeout { exit 1 }
+    expect "# " { send "uname -a\n" } timeout { exit 2 }
+    expect "riscv32 GNU/Linux" { send "mkdir mnt && mount /dev/vda mnt\n" } timeout { exit 3 }
+    expect "# " { send "echo rv32emu > mnt/emu.txt\n" } timeout { exit 3 }
+    expect -ex "-sh: can'\''t create mnt/emu.txt: Read-only file system" {} timeout { exit 3 }
+    expect "# " { send "\x01"; send "x" } timeout { exit 3 }
+    ')
+
+    # Read-write using disk image
+    TEST_OPTIONS+=("${OPTS_BASE} -x vblk:${VBLK_IMG}")
+    VBLK_EXPECT_CMDS='
+     expect "buildroot login:" { send "root\n" } timeout { exit 1 }
+     expect "# " { send "uname -a\n" } timeout { exit 2 }
+     expect "riscv32 GNU/Linux" { send "mkdir mnt && mount /dev/vda mnt\n" } timeout { exit 3 }
+     expect "# " { send "echo rv32emu > mnt/emu.txt\n" } timeout { exit 3 }
+     expect "# " { send "sync\n" } timeout { exit 3 }
+     expect "# " { send "umount mnt\n" } timeout { exit 3 }
+     expect "# " { send "\x01"; send "x" } timeout { exit 3 }
+    '
+    EXPECT_CMDS+=("${VBLK_EXPECT_CMDS}")
+
+    # Read-write using /dev/loopx(Linux) or /dev/diskx(Darwin) block device
+    TEST_OPTIONS+=("${OPTS_BASE} -x vblk:${BLK_DEV}")
+    EXPECT_CMDS+=("${VBLK_EXPECT_CMDS}")
 fi
 
+for i in "${!TEST_OPTIONS[@]}"; do
+    printf "${COLOR_Y}===== Test option: ${TEST_OPTIONS[$i]} =====${COLOR_N}\n"
+
+    OPTS="${OPTS_BASE}"
+    # No need to add option when running base test
+    if [[ ! "${TEST_OPTIONS[$i]}" =~ "base" ]]; then
+        OPTS+="${TEST_OPTIONS[$i]}"
+    fi
+    RUN_LINUX="build/rv32emu ${OPTS}"
+
+    ASSERT expect <<-DONE
+	set timeout ${TIMEOUT}
+	spawn ${RUN_LINUX}
+	${EXPECT_CMDS[$i]}
+	DONE
+
+    ret=$?
+    cleanup
+
+    printf "\nBoot Linux Test: [ ${MESSAGES[$ret]}${COLOR_N} ]\n"
+    if [[ "${TEST_OPTIONS[$i]}" =~ vblk ]]; then
+        # read-only test first, so the emu.txt definitely does not exist, skipping the check
+        if [[ ! "${TEST_OPTIONS[$i]}" =~ readonly ]]; then
+            7z l ${VBLK_IMG} | grep emu.txt >/dev/null 2>&1 || ret=4
+        fi
+        printf "Virtio-blk Test: [ ${MESSAGES[$ret]}${COLOR_N} ]\n"
+    fi
+done
+
 exit ${ret}
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -65,7 +65,14 @@ jobs:
         actions-cache-folder: 'emsdk-cache'
     - name: Set parallel jobs variable
       run: |
-            echo "PARALLEL=-j$(nproc)" >> $GITHUB_ENV
+            echo "PARALLEL=-j$(nproc)" >> "$GITHUB_ENV"
+            echo "BOOT_LINUX_TEST=TMP_FILE=\$(mktemp "$RUNNER_TEMP/tmpfile.XXXXXX"); \
+                                  sudo env TMP_FILE=\${TMP_FILE} .ci/boot-linux-prepare.sh setup; \
+                                  . \${TMP_FILE}; \
+                                  .ci/boot-linux.sh; \
+                                  EXIT_CODE=\$?; \
+                                  sudo env TMP_FILE=\${TMP_FILE} BLK_DEV=\${BLK_DEV} .ci/boot-linux-prepare.sh cleanup; \
+                                  exit \${EXIT_CODE};" >> "$GITHUB_ENV"
     - name: fetch artifact first to reduce HTTP requests
       env:
         CC: ${{ steps.install_cc.outputs.cc }}
@@ -265,15 +272,15 @@ jobs:
         CC: ${{ steps.install_cc.outputs.cc }}
       run: |
             make distclean && make INITRD_SIZE=32 ENABLE_SYSTEM=1 $PARALLEL && make ENABLE_SYSTEM=1 artifact $PARALLEL
-            .ci/boot-linux.sh
+            bash -c "${BOOT_LINUX_TEST}"
             make ENABLE_SYSTEM=1 clean
       if: ${{ always() }}
     - name: boot Linux kernel test (JIT)
       env:
         CC: ${{ steps.install_cc.outputs.cc }}
       run: |
             make distclean && make INITRD_SIZE=32 ENABLE_SYSTEM=1 ENABLE_JIT=1 ENABLE_T2C=0 ENABLE_MOP_FUSION=0 $PARALLEL && make ENABLE_SYSTEM=1 artifact $PARALLEL
-            .ci/boot-linux.sh
+            bash -c "${BOOT_LINUX_TEST}"
             make ENABLE_SYSTEM=1 ENABLE_JIT=1 ENABLE_T2C=0 ENABLE_MOP_FUSION=0 clean
       if: ${{ always() }}
     - name: Architecture test
@@ -292,7 +299,7 @@ jobs:
       uses: actions/checkout@v4
     - name: Set parallel jobs variable
       run: |
-            echo "PARALLEL=-j$(nproc)" >> $GITHUB_ENV
+            echo "PARALLEL=-j$(nproc)" >> "$GITHUB_ENV"
     - name: build artifact
       # The GitHub Action for non-x86 CPU
       uses: allinurl/run-on-arch-action@master
@@ -351,7 +358,14 @@ jobs:
          actions-cache-folder: 'emsdk-cache'
      - name: Set parallel jobs variable
        run: |
-             echo "PARALLEL=-j$(sysctl -n hw.logicalcpu)" >> $GITHUB_ENV
+             echo "PARALLEL=-j$(sysctl -n hw.logicalcpu)" >> "$GITHUB_ENV"
+             echo "BOOT_LINUX_TEST=TMP_FILE=\$(mktemp "$RUNNER_TEMP/tmpfile.XXXXXX"); \
+                                   sudo env TMP_FILE=\${TMP_FILE} .ci/boot-linux-prepare.sh setup; \
+                                   . \${TMP_FILE}; \
+                                   .ci/boot-linux.sh; \
+                                   EXIT_CODE=\$?; \
+                                   sudo env TMP_FILE=\${TMP_FILE} BLK_DEV=\${BLK_DEV} .ci/boot-linux-prepare.sh cleanup; \
+                                   exit \${EXIT_CODE};" >> "$GITHUB_ENV"
      - name: Symlink gcc-14 due to the default /usr/local/bin/gcc links to system's clang
        run: |
              ln -s /opt/homebrew/opt/gcc/bin/gcc-14 /usr/local/bin/gcc-14
@@ -463,7 +477,7 @@ jobs:
        run: |
              make distclean && make INITRD_SIZE=32 ENABLE_SYSTEM=1 $PARALLEL && \
              make ENABLE_SYSTEM=1 artifact $PARALLEL
-             .ci/boot-linux.sh
+             bash -c "${BOOT_LINUX_TEST}"
              make ENABLE_SYSTEM=1 clean
        if: ${{ always() }}
      - name: Architecture test
