ci(qemu): Add QEMU emulator to CI

.github/scripts/sketch_utils.sh

@@ -78,10 +78,10 @@ function build_sketch(){ # build_sketch <ide_path> <user_path> <path-to-ino> [ex
 
  # Default FQBN options if none were passed in the command line.
 
- esp32_opts="PSRAM=enabled,PartitionScheme=huge_app"
+ esp32_opts="FlashMode=dio,PSRAM=enabled,PartitionScheme=huge_app"
  esp32s2_opts="PSRAM=enabled,PartitionScheme=huge_app"
  esp32s3_opts="PSRAM=opi,USBMode=default,PartitionScheme=huge_app"
- esp32c3_opts="PartitionScheme=huge_app"
+ esp32c3_opts="FlashMode=dio,PartitionScheme=huge_app"
  esp32c6_opts="PartitionScheme=huge_app"
  esp32h2_opts="PartitionScheme=huge_app"
 
@@ -139,7 +139,7 @@ function build_sketch(){ # build_sketch <ide_path> <user_path> <path-to-ino> [ex
  echo "Skipping $sketchname for target $target"
  exit 0
  fi
- 
+
  ARDUINO_CACHE_DIR="$HOME/.arduino/cache.tmp"
  if [ -n "$ARDUINO_BUILD_DIR" ]; then
  build_dir="$ARDUINO_BUILD_DIR"
@@ -177,7 +177,7 @@ function build_sketch(){ # build_sketch <ide_path> <user_path> <path-to-ino> [ex
  --build-path "$build_dir" \
  $xtra_opts "${sketchdir}" \
  > $output_file
- 
+
  exit_status=$?
  if [ $exit_status -ne 0 ]; then
  echo ""ERROR: Compilation failed with error code $exit_status""
@@ -198,11 +198,11 @@ function build_sketch(){ # build_sketch <ide_path> <user_path> <path-to-ino> [ex
  # Extract the desired substring using sed
  lib_sketch_name=$(echo "$directory_path" | sed "s|$constant_part||")
  #append json file where key is fqbn, sketch name, sizes -> extracted values
- echo "{\"name\": \"$lib_sketch_name\", 
+ echo "{\"name\": \"$lib_sketch_name\",
  \"sizes\": [{
- \"flash_bytes\": $flash_bytes, 
- \"flash_percentage\": $flash_percentage, 
- \"ram_bytes\": $ram_bytes, 
+ \"flash_bytes\": $flash_bytes,
+ \"flash_percentage\": $flash_percentage,
+ \"ram_bytes\": $ram_bytes,
  \"ram_percentage\": $ram_percentage
  }]
  }," >> "$sizes_file"
@@ -386,7 +386,7 @@ function build_sketches(){ # build_sketches <ide_path> <user_path> <target> <pat
  if [ $log_compilation ]; then
  #echo board,target and start of sketches to sizes_file json
  echo "{ \"board\": \"$fqbn\",
- \"target\": \"$target\", 
+ \"target\": \"$target\",
  \"sketches\": [" >> "$sizes_file"
  fi
 

.github/scripts/tests_run.sh

@@ -8,6 +8,11 @@ function run_test() {
  local sketchdir=$(dirname $sketch)
  local sketchname=$(basename $sketchdir)
 
+ if [[ -f "$sketchdir/.skip.$platform" ]] || [[ -f "$sketchdir/.skip.$target" ]] || [[ -f "$sketchdir/.skip.$platform.$target" ]]; then
+ echo "Skipping $sketchname test in $target for $platform"
+ exit 0
+ fi
+
  if [ $options -eq 0 ] && [ -f $sketchdir/cfg.json ]; then
  len=`jq -r --arg chip $target '.targets[] | select(.name==$chip) | .fqbn | length' $sketchdir/cfg.json`
  else
@@ -33,7 +38,24 @@ function run_test() {
  report_file="tests/$sketchname/$sketchname$i.xml"
  fi
 
- pytest tests --build-dir $build_dir -k test_$sketchname --junit-xml=$report_file
+ if [ $platform == "qemu" ]; then
+ PATH=$HOME/qemu/bin:$PATH
+ extra_args="--embedded-services qemu --qemu-image-path $build_dir/$sketchname.ino.merged.bin"
+
+ if [ $target == "esp32" ] || [ $target == "esp32s3" ]; then
+ extra_args+=" --qemu-prog-path qemu-system-xtensa --qemu-cli-args=\"-machine $target -m 4M -nographic\""
+ elif [ $target == "esp32c3" ]; then
+ extra_args+=" --qemu-prog-path qemu-system-riscv32 --qemu-cli-args=\"-machine $target -icount 3 -nographic\""
+ else
+ echo "Unsupported QEMU target: $target"
+ exit 1
+ fi
+ else
+ extra_args="--embedded-services esp,arduino"
+ fi
+
+ echo "pytest tests --build-dir $build_dir -k test_$sketchname --junit-xml=$report_file $extra_args"
+ bash -c "pytest tests --build-dir $build_dir -k test_$sketchname --junit-xml=$report_file $extra_args"
  result=$?
  if [ $result -ne 0 ]; then
  return $result
@@ -44,6 +66,7 @@ function run_test() {
 SCRIPTS_DIR="./.github/scripts"
 COUNT_SKETCHES="${SCRIPTS_DIR}/sketch_utils.sh count"
 
+platform="hardware"
 chunk_run=0
 options=0
 erase=0
@@ -53,6 +76,13 @@ while [ ! -z "$1" ]; do
  -c )
  chunk_run=1
  ;;
+ -q )
+ if [ ! -d $QEMU_PATH ]; then
+ echo "QEMU path $QEMU_PATH does not exist"
+ exit 1
+ fi
+ platform="qemu"
+ ;;
  -o )
  options=1
  ;;
@@ -86,7 +116,9 @@ while [ ! -z "$1" ]; do
  shift
 done
 
-source ${SCRIPTS_DIR}/install-arduino-ide.sh
+if [ ! $platform == "qemu" ]; then
+ source ${SCRIPTS_DIR}/install-arduino-ide.sh
+fi
 
 if [ $chunk_run -eq 0 ]; then
  run_test $target $PWD/tests/$sketch/$sketch.ino $options $erase

.github/workflows/hil.yml

@@ -1,4 +1,4 @@
-name: Run tests in hardware
+name: Run tests
 
 on:
  pull_request:
@@ -16,9 +16,7 @@ concurrency:
 
 jobs:
  gen_chunks:
- if: |
- contains(github.event.pull_request.labels.*.name, 'hil_test') ||
- (github.event_name == 'schedule' && github.repository == 'espressif/arduino-esp32')
+ if: github.repository == 'espressif/arduino-esp32'
  name: Generate Chunks matrix
  runs-on: ubuntu-latest
  outputs:
@@ -41,7 +39,7 @@ jobs:
  CHUNKS=$(jq -c -n '$ARGS.positional' --args `seq 0 1 $((sketches - 1))`)
  echo "chunks=${CHUNKS}" >>$GITHUB_OUTPUT
 
- Build:
+ build:
  needs: gen_chunks
  name: ${{matrix.chip}}-Build#${{matrix.chunks}}
  runs-on: ubuntu-latest
@@ -63,9 +61,79 @@ jobs:
  ~/.arduino/tests/*/build*.tmp/*.bin
  ~/.arduino/tests/*/build*.tmp/*.json
  if-no-files-found: error
- Test:
- needs: [gen_chunks, Build]
- name: ${{matrix.chip}}-Test#${{matrix.chunks}}
+
+ qemu-test:
+ needs: [gen_chunks, build]
+ name: ${{matrix.chip}}-QEMU_Test#${{matrix.chunks}}
+ strategy:
+ fail-fast: false
+ matrix:
+ chip: ['esp32', 'esp32c3'] # Currently only ESP32 and ESP32-C3 are supported by QEMU
+ chunks: ${{fromJson(needs.gen_chunks.outputs.chunks)}}
+ runs-on: ubuntu-latest
+ env:
+ QEMU_INSTALL_PATH: "$HOME"
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+
+ - name: Get QEMU version
+ uses: pozetroninc/[email protected]
+ id: get-qemu-version
+ with:
+ token: ${{secrets.GITHUB_TOKEN}}
+ owner: espressif
+ repo: qemu
+ excludes: prerelease, draft
+
+ - name: Cache tools
+ id: cache-linux
+ uses: actions/cache@v4
+ with:
+ path: |
+ ~/qemu
+ ~/.cache/pip
+ key: ${{ steps.get-qemu-version.outputs.release }}-${{ hashFiles('.github/workflows/hil.yml') }}
+
+ - name: Install dependencies
+ run: |
+ pip install -U pip
+ pip install -r tests/requirements.txt --extra-index-url https://dl.espressif.com/pypi
+ sudo apt update && sudo apt install libpixman-1-0 libnuma1 libglib2.0-0 libslirp0 libsdl2-2.0-0
+
+ - name: Download QEMU
+ if: steps.cache-linux.outputs.cache-hit != 'true'
+ run: |
+ cd ${{ env.QEMU_INSTALL_PATH }}
+ underscore_release=$(echo ${{ steps.get-qemu-version.outputs.release }} | sed 's/\-/_/g')
+ curl -L https://github.com/espressif/qemu/releases/download/${{ steps.get-qemu-version.outputs.release }}/qemu-riscv32-softmmu-${underscore_release}-x86_64-linux-gnu.tar.xz > qemu-riscv32.tar.xz
+ curl -L https://github.com/espressif/qemu/releases/download/${{ steps.get-qemu-version.outputs.release }}/qemu-xtensa-softmmu-${underscore_release}-x86_64-linux-gnu.tar.xz > qemu-xtensa.tar.xz
+ tar -xf qemu-riscv32.tar.xz
+ tar -xf qemu-xtensa.tar.xz
+ rm qemu-*
+ echo "QEMU_PATH=${{ env.QEMU_INSTALL_PATH }}/qemu" >> $GITHUB_ENV
+
+ - name: Download ${{matrix.chip}}-${{matrix.chunks}} artifacts
+ uses: actions/download-artifact@v4
+ with:
+ name: ${{matrix.chip}}-${{matrix.chunks}}.artifacts
+ path: ~/.arduino/tests/
+
+ - name: Run Tests
+ run: QEMU_PATH="${{env.QEMU_PATH}}" bash .github/scripts/tests_run.sh -c -t ${{matrix.chip}} -i ${{matrix.chunks}} -m ${{env.MAX_CHUNKS}} -q
+
+ - name: Upload test result artifacts
+ uses: actions/upload-artifact@v4
+ if: always()
+ with:
+ name: qemu_results-${{matrix.chip}}-${{matrix.chunks}}
+ path: tests/*/*.xml
+
+ hardware-test:
+ needs: [gen_chunks, build]
+ name: ${{matrix.chip}}-Hardware_Test#${{matrix.chunks}}
+ if: |
+ contains(github.event.pull_request.labels.*.name, 'hil_test') || github.event_name == 'schedule'
  strategy:
  fail-fast: false
  matrix:
@@ -100,15 +168,13 @@ jobs:
  uses: actions/upload-artifact@v4
  if: always()
  with:
- name: test_results-${{matrix.chip}}-${{matrix.chunks}}
+ name: hw_results-${{matrix.chip}}-${{matrix.chunks}}
  path: tests/*/*.xml
 
  event_file:
  name: "Event File"
- if: |
- contains(github.event.pull_request.labels.*.name, 'hil_test') ||
- github.event_name == 'schedule'
- needs: Test
+ if: ${{ always() && !failure() && !cancelled() }}
+ needs: [hardware-test, qemu-test]
  runs-on: ubuntu-latest
  steps:
  - name: Upload

.github/workflows/publish.yml

@@ -2,7 +2,7 @@ name: Unit Test Results
 
 on:
  workflow_run:
- workflows: [Run tests in hardware]
+ workflows: [Run tests]
  branches-ignore: [master]
 
  types:

platform.txt

@@ -169,6 +169,17 @@ recipe.hooks.objcopy.postobjcopy.1.pattern.windows=cmd /c if exist "{build.path}
 recipe.hooks.objcopy.postobjcopy.2.pattern=/usr/bin/env bash -c "[ ! -d "{build.path}"/libraries/ESP_SR ] || [ ! -f "{compiler.sdk.path}"/esp_sr/srmodels.bin ] || cp -f "{compiler.sdk.path}"/esp_sr/srmodels.bin "{build.path}"/srmodels.bin"
 recipe.hooks.objcopy.postobjcopy.2.pattern.windows=cmd /c if exist "{build.path}\libraries\ESP_SR" if exist "{compiler.sdk.path}\esp_sr\srmodels.bin" COPY /y "{compiler.sdk.path}\esp_sr\srmodels.bin" "{build.path}\srmodels.bin"
 
+## Create flash_args file
+flash_args.path={build.path}/flash_args
+recipe.hooks.objcopy.postobjcopy.3.pattern_args=(echo --fill-flash-size {build.flash_size} --flash_mode keep --flash_freq keep --flash_size keep; echo {build.bootloader_addr} "{build.path}/{build.project_name}.bootloader.bin"; echo 0x8000 "{build.path}/{build.project_name}.partitions.bin"; echo 0xe000 "{runtime.platform.path}/tools/partitions/boot_app0.bin"; echo 0x10000 "{build.path}/{build.project_name}.bin") > "{flash_args.path}"
+recipe.hooks.objcopy.postobjcopy.3.pattern=/usr/bin/env bash -c "{recipe.hooks.objcopy.postobjcopy.3.pattern_args}"
+recipe.hooks.objcopy.postobjcopy.3.pattern.windows=cmd /c {recipe.hooks.objcopy.postobjcopy.3.pattern_args}
+
+# Create merged binary
+recipe.hooks.objcopy.postobjcopy.4.pattern_args=--chip {build.mcu} merge_bin -o "{build.path}/{build.project_name}.merged.bin" "@{flash_args.path}"
+recipe.hooks.objcopy.postobjcopy.4.pattern="{tools.esptool_py.path}/{tools.esptool_py.cmd}" {recipe.hooks.objcopy.postobjcopy.4.pattern_args}
+recipe.hooks.objcopy.postobjcopy.4.pattern.linux=python3 "{tools.esptool_py.path}/{tools.esptool_py.cmd}" {recipe.hooks.objcopy.postobjcopy.4.pattern_args}
+
 ## Save bin
 recipe.output.tmp_file={build.project_name}.bin
 recipe.output.save_file={build.project_name}.{build.variant}.bin

tests/pytest.ini

@@ -1,5 +1,5 @@
 [pytest]
-addopts = --embedded-services esp,arduino
+addopts = --embedded-services esp,arduino,qemu
 
 # log related
 log_cli = True

tests/requirements.txt

@@ -1,5 +1,6 @@
 cryptography>=2.1.4
 --only-binary cryptography
 pytest-cov
-pytest-embedded-serial-esp>=1.3.4
-pytest-embedded-arduino>=1.3.4
+pytest-embedded-serial-esp>=1.10.1
+pytest-embedded-arduino>=1.10.1
+pytest-embedded-qemu>=1.10.1