Skip to content

Commit e93c6b8

Browse files
lucasssvazlucasssvaz
committed
ci(qemu): Add QEMU emulator to CI
1 parent cf44890 commit e93c6b8

File tree

5 files changed

+111
-17
lines changed

5 files changed

+111
-17
lines changed

‎.github/scripts/tests_run.sh

+30-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ function run_test() {
88
local sketchdir=$(dirname $sketch)
99
local sketchname=$(basename $sketchdir)
1010

11+
if [[ -f "$sketchdir/.skip.$platform" ]] || [[ -f "$sketchdir/.skip.$target" ]] || [[ -f "$sketchdir/.skip.$platform.$target" ]]; then
12+
echo "Skipping $sketchname test in $target for $platform"
13+
exit 0
14+
fi
15+
1116
if [ $options -eq 0 ] && [ -f $sketchdir/cfg.json ]; then
1217
len=`jq -r --arg chip $target '.targets[] | select(.name==$chip) | .fqbn | length' $sketchdir/cfg.json`
1318
else
@@ -33,7 +38,20 @@ function run_test() {
3338
report_file="tests/$sketchname/$sketchname$i.xml"
3439
fi
3540

36-
pytest tests --build-dir $build_dir -k test_$sketchname --junit-xml=$report_file
41+
if [ $platform == "qemu" ]; then
42+
extra_args="--embedded-services qemu --qemu-image-path $build_dir/$sketchname.ino.bin"
43+
44+
if [ $target == "esp32" ] || [ $target == "esp32s3" ]; then
45+
extra_args+=" --qemu-prog-path $QEMU_PATH/qemu-system-xtensa --qemu-cli-args '-nographic -machine $target'"
46+
else
47+
extra_args+=" --qemu-prog-path $QEMU_PATH/qemu-system-riscv32 --qemu-cli-args '-nographic -machine $target'"
48+
fi
49+
else
50+
extra_args="--embedded-services esp,arduino"
51+
fi
52+
53+
echo "pytest tests --build-dir $build_dir -k test_$sketchname --junit-xml=$report_file $extra_args"
54+
pytest tests --build-dir $build_dir -k test_$sketchname --junit-xml=$report_file $extra_args
3755
result=$?
3856
if [ $result -ne 0 ]; then
3957
return $result
@@ -44,6 +62,7 @@ function run_test() {
4462
SCRIPTS_DIR="./.github/scripts"
4563
COUNT_SKETCHES="${SCRIPTS_DIR}/sketch_utils.sh count"
4664

65+
platform="hardware"
4766
chunk_run=0
4867
options=0
4968
erase=0
@@ -53,6 +72,13 @@ while [ ! -z "$1" ]; do
5372
-c )
5473
chunk_run=1
5574
;;
75+
-q )
76+
if [ ! -d $QEMU_PATH ]; then
77+
echo "QEMU path $QEMU_PATH does not exist"
78+
exit 1
79+
fi
80+
platform="qemu"
81+
;;
5682
-o )
5783
options=1
5884
;;
@@ -86,7 +112,9 @@ while [ ! -z "$1" ]; do
86112
shift
87113
done
88114

89-
source ${SCRIPTS_DIR}/install-arduino-ide.sh
115+
if [ ! $platform == "qemu" ]; then
116+
source ${SCRIPTS_DIR}/install-arduino-ide.sh
117+
fi
90118

91119
if [ $chunk_run -eq 0 ]; then
92120
run_test $target $PWD/tests/$sketch/$sketch.ino $options $erase

‎.github/workflows/hil.yml

+78-13
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Run tests in hardware
1+
name: Run tests
22

33
on:
44
pull_request:
@@ -16,9 +16,7 @@ concurrency:
1616

1717
jobs:
1818
gen_chunks:
19-
if: |
20-
contains(github.event.pull_request.labels.*.name, 'hil_test') ||
21-
(github.event_name == 'schedule' && github.repository == 'espressif/arduino-esp32')
19+
if: github.repository == 'espressif/arduino-esp32'
2220
name: Generate Chunks matrix
2321
runs-on: ubuntu-latest
2422
outputs:
@@ -41,7 +39,7 @@ jobs:
4139
CHUNKS=$(jq -c -n '$ARGS.positional' --args `seq 0 1 $((sketches - 1))`)
4240
echo "chunks=${CHUNKS}" >>$GITHUB_OUTPUT
4341
44-
Build:
42+
build:
4543
needs: gen_chunks
4644
name: ${{matrix.chip}}-Build#${{matrix.chunks}}
4745
runs-on: ubuntu-latest
@@ -63,9 +61,78 @@ jobs:
6361
~/.arduino/tests/*/build*.tmp/*.bin
6462
~/.arduino/tests/*/build*.tmp/*.json
6563
if-no-files-found: error
66-
Test:
67-
needs: [gen_chunks, Build]
68-
name: ${{matrix.chip}}-Test#${{matrix.chunks}}
64+
65+
qemu-test:
66+
needs: [gen_chunks, build]
67+
name: ${{matrix.chip}}-QEMU_Test#${{matrix.chunks}}
68+
strategy:
69+
fail-fast: false
70+
matrix:
71+
chip: ['esp32', 'esp32c3'] # Currently only ESP32 and ESP32-C3 are supported by QEMU
72+
chunks: ${{fromJson(needs.gen_chunks.outputs.chunks)}}
73+
runs-on: ubuntu-latest
74+
env:
75+
QEMU_INSTALL_PATH: "$HOME"
76+
steps:
77+
- name: Checkout repository
78+
uses: actions/checkout@v4
79+
80+
- name: Get QEMU version
81+
uses: pozetroninc/[email protected]
82+
id: get-qemu-version
83+
with:
84+
token: ${{secrets.GITHUB_TOKEN}}
85+
owner: espressif
86+
repo: qemu
87+
excludes: prerelease, draft
88+
89+
- name: Cache tools
90+
id: cache-linux
91+
uses: actions/cache@v4
92+
with:
93+
path: |
94+
~/qemu
95+
~/.cache/pip
96+
key: ${{ steps.get-qemu-version.outputs.release }}-${{ hashFiles('.github/workflows/hil.yml') }}
97+
98+
- name: Install python dependencies
99+
run: |
100+
pip install -U pip
101+
pip install -r tests/requirements.txt --extra-index-url https://dl.espressif.com/pypi
102+
103+
- name: Download QEMU
104+
if: steps.cache-linux.outputs.cache-hit != 'true'
105+
run: |
106+
cd ${{ env.QEMU_INSTALL_PATH }}
107+
underscore_release=$(echo ${{ steps.get-qemu-version.outputs.release }} | sed 's/\-/_/g')
108+
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
109+
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
110+
tar -xf qemu-riscv32.tar.xz
111+
tar -xf qemu-xtensa.tar.xz
112+
rm qemu-*
113+
echo "QEMU_PATH=${{ env.QEMU_INSTALL_PATH }}/qemu" >> $GITHUB_ENV
114+
115+
- name: Download ${{matrix.chip}}-${{matrix.chunks}} artifacts
116+
uses: actions/download-artifact@v4
117+
with:
118+
name: ${{matrix.chip}}-${{matrix.chunks}}.artifacts
119+
path: ~/.arduino/tests/
120+
121+
- name: Run Tests
122+
run: QEMU_PATH="${{env.QEMU_PATH}}" bash .github/scripts/tests_run.sh -c -t ${{matrix.chip}} -i ${{matrix.chunks}} -m ${{env.MAX_CHUNKS}} -q
123+
124+
- name: Upload test result artifacts
125+
uses: actions/upload-artifact@v4
126+
if: always()
127+
with:
128+
name: qemu_results-${{matrix.chip}}-${{matrix.chunks}}
129+
path: tests/*/*.xml
130+
131+
hardware-test:
132+
needs: [gen_chunks, build]
133+
name: ${{matrix.chip}}-Hardware_Test#${{matrix.chunks}}
134+
if: |
135+
contains(github.event.pull_request.labels.*.name, 'hil_test') || github.event_name == 'schedule'
69136
strategy:
70137
fail-fast: false
71138
matrix:
@@ -100,15 +167,13 @@ jobs:
100167
uses: actions/upload-artifact@v4
101168
if: always()
102169
with:
103-
name: test_results-${{matrix.chip}}-${{matrix.chunks}}
170+
name: hw_results-${{matrix.chip}}-${{matrix.chunks}}
104171
path: tests/*/*.xml
105172

106173
event_file:
107174
name: "Event File"
108-
if: |
109-
contains(github.event.pull_request.labels.*.name, 'hil_test') ||
110-
github.event_name == 'schedule'
111-
needs: Test
175+
if: ${{ always() && !failure() && !cancelled() }}
176+
needs: [hardware-test, qemu-test]
112177
runs-on: ubuntu-latest
113178
steps:
114179
- name: Upload

‎.github/workflows/publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Unit Test Results
22

33
on:
44
workflow_run:
5-
workflows: [Run tests in hardware]
5+
workflows: [Run tests]
66
branches-ignore: [master]
77

88
types:

‎tests/pytest.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[pytest]
2-
addopts = --embedded-services esp,arduino
2+
addopts = --embedded-services esp,arduino,qemu
33

44
# log related
55
log_cli = True

‎tests/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ cryptography>=2.1.4
33
pytest-cov
44
pytest-embedded-serial-esp>=1.3.4
55
pytest-embedded-arduino>=1.3.4
6+
pytest-embedded-qemu>=1.3.4

0 commit comments

Comments
 (0)