IEP-1471 ESP-IDF Path with whitespaces leads to python error during FLASH by sigmaaa · Pull Request #1205 · espressif/idf-eclipse-plugin

sigmaaa · 2025-04-22T13:01:18Z

Description

Fixed an issue with flash when esp-idf path contains spaces.

Fixes # (IEP-1471)

Type of change

Please delete options that are not relevant.

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

How has this been tested?

Install ESP-IDF to the directory that contains spaces
Create a new project
build flash using uart
build flash using jtag
build flash using dfu

Test Configuration:

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

Dependent components impacted by this PR:

Launch configuration
Flash
Dynamic variables

Checklist

Summary by CodeRabbit

Bug Fixes
- Improved handling of command-line arguments to better support quoted strings and special characters during flashing operations.
- Enhanced variable resolution to automatically quote values containing spaces, reducing potential errors in command execution.

coderabbitai · 2025-04-22T13:01:26Z

Walkthrough

The changes improve the way command-line arguments are parsed and handled across several modules. Instead of splitting command strings by spaces, the code now uses a specialized parsing utility (CommandLineUtil.argumentsToArray) to correctly handle quoted strings and escaped characters. Additionally, variable resolution logic was updated to wrap resolved values containing spaces in quotes, ensuring proper command-line behavior. No public APIs or exported entity signatures were altered.

Changes

File(s)	Change Summary
.../idf/core/util/DfuCommandsUtil.java	Replaced manual string splitting of command arguments with `CommandLineUtil.argumentsToArray` for robust parsing.
.../idf/launch/serial/internal/SerialFlashLaunchConfigDelegate.java	Switched from splitting arguments by spaces to parsing with `CommandLineUtil.argumentsToArray` after substitution.
.../idf/launch/serial/ui/IDFDynamicVariableResolver.java	Refactored variable resolution to quote values containing spaces; used a local variable for resolved value.
.../idf/launch/serial/ui/BuildFolderVariableResolver.java	Added quoting of build folder paths containing spaces before returning the resolved value.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VariableResolver
    participant CommandBuilder

    User->>VariableResolver: Request variable resolution
    VariableResolver->>VariableResolver: Resolve value
    alt Value contains spaces
        VariableResolver->>VariableResolver: Wrap value in quotes
    end
    VariableResolver-->>User: Return resolved value

    User->>CommandBuilder: Provide command string with variables
    CommandBuilder->>CommandBuilder: Substitute variables
    CommandBuilder->>CommandLineUtil: Parse command string with argumentsToArray
    CommandLineUtil-->>CommandBuilder: Return parsed arguments array
    CommandBuilder-->>User: Use parsed arguments for command execution

Suggested reviewers

alirana01
kolipakakondal
AndriiFilippov

Poem

In the warren of code where commands used to split,
Now arguments parse with a more careful wit.
Quoted and spaced, no tokens misplaced,
Variables wrapped so nothing’s erased.
With every new hop, our commands run anew—
A rabbit’s delight in a shell that’s true!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8deb3c2 and fdbb1d7.

📒 Files selected for processing (1)

bundles/com.espressif.idf.launch.serial.ui/src/com/espressif/idf/launch/serial/ui/BuildFolderVariableResolver.java (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: build
GitHub Check: build_macos

🔇 Additional comments (1)

bundles/com.espressif.idf.launch.serial.ui/src/com/espressif/idf/launch/serial/ui/BuildFolderVariableResolver.java (1)

46-49: Proper handling of paths with spaces by adding quotes

The added code correctly identifies and handles build folder paths containing spaces by wrapping them in double quotes. This addresses the issue where ESP-IDF paths with whitespaces were causing Python errors during the flash process by ensuring command-line arguments are properly parsed.

This change aligns with the PR's objective of fixing issues related to paths with spaces in ESP-IDF projects and supports the related improvements in command-line argument handling across the codebase.

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

alirana01

LGTM! Just a few comments to look at and please see if they need to be addressed @sigmaaa

alirana01 · 2025-04-22T13:33:54Z

+
+		// Wrap the resolved value in quotes if it contains spaces or special characters
+		if (resolvedValue != null && resolvedValue.contains(" ")) //$NON-NLS-1$
+		{
+			resolvedValue = "\"" + resolvedValue + "\""; //$NON-NLS-1$ //$NON-NLS-2$
+		}


This generally seems okay we just need to be sure that double quotes work on all platforms. It might be okay because we are running most of these commands through Java not via shell but it should be verified on all platforms note for @AndriiFilippov

AndriiFilippov · 2025-04-22T16:04:59Z

@sigmaaa hi !

Tested under:
OS - Windows 11 / MacOS / Linux
ESP-IDF: v5.4

able to flash if ${BUILD_DIR} wrap in " "

without " " -> error:

Usage: idf.py folder [OPTIONS]
Try 'idf.py folder --help' for help.

Error: No such option: -p

sigmaaa · 2025-04-23T06:50:24Z

@sigmaaa hi !

Tested under: OS - Windows 11 / MacOS / Linux ESP-IDF: v5.4

able to flash if ${BUILD_DIR} wrap in " "

without " " -> error:
Usage: idf.py folder [OPTIONS]
Try 'idf.py folder --help' for help.

Error: No such option: -p

Hi @AndriiFilippov,

Fixed in the last commit, no need for putting quotes manually for the BUILD_DIR variable now

AndriiFilippov · 2025-04-23T13:39:20Z

@sigmaaa

LGTM 👍

sigmaaa requested review from AndriiFilippov, alirana01 and kolipakakondal April 22, 2025 13:01

sigmaaa self-assigned this Apr 22, 2025

alirana01 approved these changes Apr 22, 2025

View reviewed changes

fix: fix an issue with flash when esp-idf contains spaces

8deb3c2

sigmaaa force-pushed the IEP-1471 branch from cb6562f to 8deb3c2 Compare April 22, 2025 14:25

fix: wrapping the build folder with quotes

fdbb1d7

alirana01 approved these changes Apr 23, 2025

View reviewed changes

AndriiFilippov approved these changes Apr 23, 2025

View reviewed changes

AndriiFilippov merged commit 1cca996 into master Apr 23, 2025

kolipakakondal deleted the IEP-1471 branch May 7, 2025 14:57

coderabbitai Bot mentioned this pull request Aug 19, 2025

IEP-1619 DFU flash output truncated in IDE console #1294

Merged

5 tasks

coderabbitai Bot mentioned this pull request Sep 2, 2025

IEP-1613 Encrypted Flash: regular flash command is not separated from encrypted-flash command #1301

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

IEP-1471 ESP-IDF Path with whitespaces leads to python error during FLASH#1205

IEP-1471 ESP-IDF Path with whitespaces leads to python error during FLASH#1205
AndriiFilippov merged 2 commits into
masterfrom
IEP-1471

sigmaaa commented Apr 22, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 22, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

alirana01 left a comment

Uh oh!

Uh oh!

alirana01 Apr 22, 2025

Uh oh!

AndriiFilippov commented Apr 22, 2025 •

edited

Loading

Uh oh!

sigmaaa commented Apr 23, 2025

Uh oh!

AndriiFilippov commented Apr 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

sigmaaa commented Apr 22, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How has this been tested?

Dependent components impacted by this PR:

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

alirana01 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

alirana01 Apr 22, 2025

Choose a reason for hiding this comment

Uh oh!

AndriiFilippov commented Apr 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sigmaaa commented Apr 23, 2025

Uh oh!

AndriiFilippov commented Apr 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

sigmaaa commented Apr 22, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 22, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

AndriiFilippov commented Apr 22, 2025 •

edited

Loading