[VSC-1473/1495] update dockerfile and qemu options #1282

brianignacio5 · 2024-08-16T10:31:36Z

Description

Update Dockerfile and QEMU options.:

Remove adding QEMU in Dockerfile and using the one from ESP-IDF tools.
Adding QEMU options to support both esp32 and esp32c3 as target.
Add ${idf.buildPath}/merged-qemu.bin delete when ${idf.buildPath}/.bin_timestamp changes to trigger rebuilding the merged QEMU bin image.

Fixes #1281
Fixes #1320

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)

Steps to test this pull request

Provide a list of steps to test changes in this PR and required output

Click on "ESP-IDF: Launch QEMU Debug Session" or ESP-IDF: Monitor QEMU Device should work for esp32 or esp32c3 and show error for other IDF_TARGET.
Change the source code. The merged-qemu.bin should be deleted.
Click on "ESP-IDF: Launch QEMU Debug Session" or ESP-IDF: Monitor QEMU Device and the new image should be generated and used.

Expected behaviour:
Expected output:

How has this been tested?

Manual testing in a Dev Container in Visual Studio Code running previous code on ESP-IDF project like the blink example.

Test Configuration: Using VSCode Devcontainer Docker container in either Windows or MacOS

ESP-IDF Version: 5.4
OS (Windows,Linux and macOS): macOS

Checklist

github-actions · 2024-08-16T10:44:04Z

Download the artifacts for this pull request:
You can test these changes by installing this VSIX by click menu View -> Command Palette..., type Install from VSIX and then select downloaded esp-idf-extension.vsix file to install the extension.

esp-idf-extension.vsix.zip
Espressif documentation preview

github-actions · 2024-09-11T00:22:07Z

Pull request has been marked as stale since there are no activities, and this will be closed in 5 days if there are no further activities

github-actions · 2024-10-09T00:23:31Z

Pull request has been marked as stale since there are no activities, and this will be closed in 5 days if there are no further activities

fix lint

test msg fix lint rm test msg

brianignacio5 · 2024-10-14T10:47:03Z

PTAL @radurentea @Fabricio-ESP

radurentea

Left some comments related to some small text changes

radurentea · 2024-10-21T12:16:01Z

src/extension.ts

+          } catch (error) {
+            const msg = error.message
+              ? error.message
+              : "Error launching QEMU debugging";


We should use translation for notitfications and keep the name and capitalisation the same. Please check line 2471

radurentea · 2024-10-21T12:16:40Z

src/extension.ts

+        {
+          cancellable: true,
+          location: ProgressLocation,
+          title: "ESP-IDF: Starting ESP-IDF QEMU Debug",


Maybe we should change the title to "ESP-IDF: Starting ESP-IDF QEMU Debugging"

radurentea · 2024-10-21T15:41:07Z

Hi @brianignacio5,

I've left some small comments related to consistency of the text and translations.

Also, when testing I ran into the following issues:

Docker container does not come pre-configured as stated in our documentation at step 4, python path is missing, which causes issues with the commands that are using python (ex: setting device target etc)
When trying to configure the extension inside the docker container, python path still doesn't changes.

brianignacio5 · 2024-10-22T00:53:36Z

Hi @brianignacio5,

I've left some small comments related to consistency of the text and translations.

Also, when testing I ran into the following issues:

Docker container does not come pre-configured as stated in our documentation at step 4, python path is missing, which causes issues with the commands that are using python (ex: setting device target etc)

When trying to configure the extension inside the docker container, python path still doesn't changes.

2 things you need to consider:

Are you re opening a ESP-IDF project that already has .vscode/settings.json into a Docker Container ? Do you have python path defined there? The container will use settings from .devcontainer/devcontainer.json IF .vscode/settings.json are not defined.
When you re-open a project in a Docker container, the extension installed is from marketplace. Have you reinstalled the vsix from this PR in the container to see if it works. The python path issue is from marketplace extension which should be resolved with the removal of python path settings.
A doctor command output from the container will show you what settings are used in the container. If you see python path. Please share this doctor command output.

radurentea · 2024-10-22T10:06:44Z

Hi @brianignacio5,

I've checked and indeed the settings.json inside the project was configured with the settings from my Mac. I thought the Remote Settings will have higher priority, but it was not the case
I did not think of that, but it makes sense that I had to install a new version of the extension.

After properly configuring the container settings, the issue has been resolved.

The project is now working as expected. I'll create a separate ticket to investigate a more robust solution for managing configuration switches between local development and container environments as we've discussed.

L.E: new task can be found under VSC-1506 in JIRA

radurentea

LGTM!

Fabricio-ESP

Tested on container connection from a project on windows and on my default WSL instance. Container creation, QEMU execution and real target connection were successful.

brianignacio5 self-assigned this Aug 16, 2024

brianignacio5 force-pushed the bugfix/dockerfile-template-qemu branch from 549494f to db592a3 Compare August 22, 2024 08:32

Voidler-cell mentioned this pull request Aug 22, 2024

QEMU emulated programm not updated when, changing, rebuilding the project and then restarting the QEMU Server (VSC-1473) #1281

Closed

1 task

brianignacio5 added this to the 1.9.0 milestone Aug 26, 2024

brianignacio5 mentioned this pull request Aug 30, 2024

"Select Port To Use" throws error "spawn udevadm ENOENT" #1296

Closed

1 task

github-actions bot added the stale Stale PR or Issue label Sep 11, 2024

brianignacio5 removed the stale Stale PR or Issue label Sep 11, 2024

brianignacio5 force-pushed the bugfix/dockerfile-template-qemu branch from db592a3 to 5cad306 Compare September 23, 2024 08:50

github-actions bot added the stale Stale PR or Issue label Oct 9, 2024

brianignacio5 removed the stale Stale PR or Issue label Oct 10, 2024

brianignacio5 added 7 commits October 12, 2024 16:51

update dockerfile and qemu options

390ae27

update bin timestamp glob

a664e94

spaces in qemu manager

cb4f09b

qemu file quotes add udev dockerfile

e7730c0

add on create bin timestamp file watcher

9dccd10

fix lint

add delete timestamp event

0cbfe01

test msg fix lint rm test msg

rm user dockerfile template

2a1ba71

brianignacio5 force-pushed the bugfix/dockerfile-template-qemu branch from 66c814e to 2a1ba71 Compare October 12, 2024 08:51

brianignacio5 requested review from radurentea and Fabricio-ESP October 14, 2024 10:39

capture qemu debug monitor error

3eef294

radurentea requested changes Oct 21, 2024

View reviewed changes

Fabricio-ESP changed the title ~~update dockerfile and qemu options~~ [VSC-1473] update dockerfile and qemu options Oct 22, 2024

Fabricio-ESP changed the title ~~[VSC-1473] update dockerfile and qemu options~~ [VSC-1473/1495] update dockerfile and qemu options Oct 23, 2024

brianignacio5 added 2 commits October 25, 2024 15:15

update docs to include auto attach param

6f07f01

add qemu msg translation

72a72ee

brianignacio5 requested a review from radurentea October 25, 2024 07:43

radurentea approved these changes Oct 25, 2024

View reviewed changes

Fabricio-ESP approved these changes Oct 25, 2024

View reviewed changes

brianignacio5 merged commit 120dd40 into master Oct 28, 2024
7 checks passed

brianignacio5 deleted the bugfix/dockerfile-template-qemu branch October 28, 2024 00:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[VSC-1473/1495] update dockerfile and qemu options #1282

[VSC-1473/1495] update dockerfile and qemu options #1282

brianignacio5 commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Sep 11, 2024

github-actions bot commented Oct 9, 2024

brianignacio5 commented Oct 14, 2024

radurentea left a comment

radurentea Oct 21, 2024

radurentea Oct 21, 2024

radurentea commented Oct 21, 2024

brianignacio5 commented Oct 22, 2024

radurentea commented Oct 22, 2024 •

edited

Loading

radurentea left a comment

Fabricio-ESP left a comment

[VSC-1473/1495] update dockerfile and qemu options #1282

[VSC-1473/1495] update dockerfile and qemu options #1282

Conversation

brianignacio5 commented Aug 16, 2024 • edited Loading

Description

Type of change

Steps to test this pull request

How has this been tested?

Checklist

github-actions bot commented Aug 16, 2024 • edited Loading

github-actions bot commented Sep 11, 2024

github-actions bot commented Oct 9, 2024

brianignacio5 commented Oct 14, 2024

radurentea left a comment

Choose a reason for hiding this comment

radurentea Oct 21, 2024

Choose a reason for hiding this comment

radurentea Oct 21, 2024

Choose a reason for hiding this comment

radurentea commented Oct 21, 2024

brianignacio5 commented Oct 22, 2024

radurentea commented Oct 22, 2024 • edited Loading

radurentea left a comment

Choose a reason for hiding this comment

Fabricio-ESP left a comment

Choose a reason for hiding this comment

brianignacio5 commented Aug 16, 2024 •

edited

Loading

github-actions bot commented Aug 16, 2024 •

edited

Loading

radurentea commented Oct 22, 2024 •

edited

Loading