GitHub Actions 中与 QEMU 交互：解决常见问题

2024-03-18 08:13:42

向 QEMU CLI 传递参数

在使用 GitHub Actions 调用 QEMU 时，正确地向 QEMU 命令行界面（CLI）传递参数至关重要。常见的问题是参数未被正确识别或执行。

解决方案

确保所有参数都按需转义并以正确的顺序排列。例如，在 YAML 文件中使用双引号将参数包裹起来可以避免 shell 对特殊字符的误解释。

示例代码：

- name: Run QEMU with parameters
  run: |
    qemu-system-x86_64 -enable-kvm -hda disk.img -m 1024 -nographic -serial mon:stdio

原理

YAML 文件中的 run 字段会直接传递给默认的 shell（通常是 /bin/bash），通过使用双引号，可以确保特殊字符和空格被正确解释。

分离步骤

在复杂的工作流中，分离步骤能提高代码的可读性和维护性。每个步骤都应明确其目的，并尽量保持简短，方便后续调试。

解决方案

将操作分成更小的任务单元，比如分别设置环境、启动 QEMU、运行测试等。这样不仅能减少错误的发生概率，还能简化问题排查过程。

示例代码：

- name: Set environment variables
  run: |
    export QEMU_ARGS="-enable-kvm -hda disk.img"

- name: Run QEMU with specified arguments
  run: |
    qemu-system-x86_64 $QEMU_ARGS -m 1024 -nographic -serial mon:stdio

原理

通过分离步骤，可以更容易地识别和处理每个操作的输出，有助于快速定位问题所在。

使用正确的 shell

在 GitHub Actions 中，默认使用 /bin/bash。如果需要使用其他 shell（如 sh），需明确指定以避免意外行为。

解决方案

显式指明所使用的 shell，并确保该 shell 在运行环境中可用。

示例代码：

- name: Run QEMU with sh shell
  shell: sh -l {0}
  run: |
    qemu-system-x86_64 -enable-kvm -hda disk.img -m 1024 -nographic -serial mon:stdio

原理

指定 shell 可以确保命令在预期的环境中执行，防止因 shell 特定行为导致的问题。

转义参数

传递给 QEMU 的某些参数可能含有特殊字符，这些字符需要被正确转义，否则可能导致命令执行失败或不按预期工作。

解决方案

使用反斜杠 (\) 或双引号来转义参数中的特殊字符。对于复杂的参数设置，可以考虑在脚本中预处理它们。

示例代码：

- name: Run QEMU with escaped parameters
  run: |
    qemu-system-x86_64 -enable-kvm -hda "disk.img" -m 1024 -nographic -serial "mon:stdio"

原理

正确转义参数可以确保特殊字符被准确解释，避免语法错误或命令执行失败。

使用 expect 自动化交互过程

在某些情况下，QEMU 需要用户交互才能完成任务。这时，可以使用 expect 工具来模拟用户输入，自动化这个过程。

解决方案

编写一个简单的 expect 脚本，用于处理与 QEMU 的交互。

示例代码：

- name: Run expect script for QEMU interaction
  run: |
    expect -c 'spawn qemu-system-x86_64 -enable-kvm -hda disk.img; expect "password:" {send "your_password\r"}'

原理

expect 能够识别特定的输出并自动发送相应的输入，从而实现自动化操作。

改进后的 GitHub Actions 工作流示例

name: QEMU Interaction Workflow

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - name: Set environment variables
      run: |
        export QEMU_ARGS="-enable-kvm -hda disk.img"

    - name: Run expect script for QEMU interaction
      run: |
        expect -c 'spawn qemu-system-x86_64 $QEMU_ARGS; expect "password:" {send "your_password\r"}'