使用SonarQube扫描ESP32项目，如何生成build-wrapper-dump.json

康de哥2024-09-21 15:33

众所周知，ESP32项目一般使用乐鑫官方的IDF环境进行编译调试。以Windows为例，编译流程为先运行export.ps1加载虚拟环境和环境变量，然后运行idf.py build。

而SonarQube扫描需要使用build-wrapper对编译过程进行一次"监视"或者说分析，以生成build-wrapper-dump.json，这个json在进行代码分析时需要使用。但是直接运行就会得到如下错误：

bash 复制代码

build-wrapper-win-x86-64.exe --out-dir . idf.py build
[SONARSOURCE BUILD-WRAPPER] failed to execute idf.py build: The system cannot find the file specified.

这是因为build-wrapper-win-x86-64.exe一般接受的是exe如gcc或编译脚本，而此处的idf.py实际为先前运行的export.ps1封装过的powershell function，查看其代码可知其封装为function idf.py { &python "$IDF_PATH\tools\idf.py" $args }也就是其封装前的实际调用为python /PATH_TO_IDF_PY/idf.py build，所以在运行export.ps1加载虚拟环境和环境变量后，运行如下命令即可：

bash 复制代码

build-wrapper-win-x86-64.exe --out-dir . python ../../esp-idf/tools/idf.py build
Executing action: all (aliases: build)
...
Project build complete. To flash, run this command:
...\.espressif\python_env\idf5.1_py3.11_env\Scripts\python.exe ..\..\esp-idf\components\esptool_py\esptool\esptool.py -p (PORT) -b 460800 --before default_reset --after hard_reset --chip esp32s3  write_flash --flash_mode dio --flash_size 16MB --flash_freq 80m 0x0 build\bootloader\bootloader.bin 0x8000 build\partition_table\partition-table.bin 0x10d000 build\ota_data_initial.bin 0x110000 build\esp_ot_br.bin 0x910000 build\web_ui.bin 0xc10000 build\rcp_fw.bin
or run 'idf.py -p (PORT) flash'

可以看到编译能够像往常一样开始，且期望的build-wrapper-dump.json已生成在.目录下。

另外，项目路径很容易出错，需要注意编译路径、工具路径、SonarQube路径等的区别。