Fix `docker.run_command()` needing `detach` but not enforcing it #5979

felipecrs · 2025-06-27T01:58:39Z

Proposed change

docker.run_command only works with Detach=True, but was not including it in the default container.run args (i.e. was broken by default).

This fixes it, and also remove the redundant arguments from docker.run_command callers.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New feature (which adds functionality to the supervisor)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

Extracted from #5974.

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Ruff (ruff format supervisor tests)
Tests have been added to verify that the new code works.

If API endpoints or add-on configuration are added/changed:

Documentation added/updated for developers.home-assistant.io
CLI updated (if necessary)
Client library updated (if necessary)

Summary by CodeRabbit

Bug Fixes
- Improved handling of container command execution to ensure consistent detachment and output stream behavior.
- Adjusted retrieval of command exit codes for more reliable status reporting.

coderabbitai · 2025-06-27T02:01:16Z

📝 Walkthrough

Walkthrough

The changes adjust how Docker containers are run and how their output and status codes are managed for command execution. Parameters related to detachment and output streaming are removed from one method and set explicitly in another, with minor adjustments to how command status results are accessed.

Changes

File(s)	Change Summary
supervisor/docker/homeassistant.py	Removed `detach=True`, `stdout=True`, and `stderr=True` parameters from `run_command` call.
supervisor/docker/manager.py, tests/docker/test_manager.py	Added `detach=True` to `run_command` method and related tests; changed exit code retrieval to direct indexing.

Sequence Diagram(s)

sequenceDiagram
    participant DockerHomeAssistant
    participant DockerManager
    participant DockerEngine

    DockerHomeAssistant->>DockerManager: run_command(command, ...)
    DockerManager->>DockerEngine: Run container (detach=True)
    DockerEngine-->>DockerManager: Container result (with StatusCode)
    DockerManager-->>DockerHomeAssistant: Return StatusCode

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Pylint (3.3.7)

tests/docker/test_manager.py

supervisor/docker/manager.py

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 417ce08 and 1688b3e.

📒 Files selected for processing (3)

supervisor/docker/homeassistant.py (0 hunks)
supervisor/docker/manager.py (2 hunks)
tests/docker/test_manager.py (2 hunks)

💤 Files with no reviewable changes (1)

supervisor/docker/homeassistant.py

🚧 Files skipped from review as they are similar to previous changes (1)

supervisor/docker/manager.py

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

GitHub Check: Build armv7 supervisor
GitHub Check: Build armhf supervisor
GitHub Check: Build aarch64 supervisor
GitHub Check: Run tests Python 3.13.5

🔇 Additional comments (2)

tests/docker/test_manager.py (2)

34-42: LGTM! Test correctly updated to match implementation changes.

The test assertion has been properly updated to expect detach=True in the docker.containers.run call, which aligns with the bug fix that ensures detached mode is enabled by default.

67-73: LGTM! Test assertion correctly reflects the default behavior.

The test properly verifies that detach=True is included in the default arguments passed to docker.containers.run, ensuring the bug fix is working as intended.

✨ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 or @coderabbitai title 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.

felipecrs · 2025-06-27T02:11:29Z

I don't understand why codecov is failing. It is pointing itself that was a 0.00% coverage change with this PR.

felipecrs · 2025-06-27T02:28:03Z

Waiting for #5977 to be merged first, as it adds the test that will fix codecov for this PR.

supervisor/docker/manager.py

agners · 2025-06-30T12:13:01Z

Since execute_command() in supervisor/docker/homeassistant.py is the only call site of this function, and it is passing the detach, this PR effectively fixes a "local" bug, which is hidden by correct call args. So for the end user it doesn't fix a Supervisor bug, which is why I labeled it refactor. @felipecrs I hope you agree with that assessment.

felipecrs · 2025-06-30T13:04:55Z

Sure, I completely agree.

agners

LGTM, thanks!

home-assistant bot added the cla-signed label Jun 27, 2025

felipecrs marked this pull request as draft June 27, 2025 02:27

agners force-pushed the fix-not-enforcing-detach branch from 417ce08 to 085b653 Compare June 30, 2025 11:32

agners reviewed Jun 30, 2025

View reviewed changes

supervisor/docker/manager.py Show resolved Hide resolved

agners added the refactor A code change that neither fixes a bug nor adds a feature label Jun 30, 2025

felipecrs force-pushed the fix-not-enforcing-detach branch from 085b653 to 2948c3b Compare June 30, 2025 13:43

Fix docker.run_command() needing detach but not enforcing it

d957238

felipecrs force-pushed the fix-not-enforcing-detach branch from 2948c3b to d957238 Compare June 30, 2025 13:43

Fix test

1688b3e

felipecrs marked this pull request as ready for review June 30, 2025 13:45

felipecrs requested a review from agners June 30, 2025 13:45

agners approved these changes Jun 30, 2025

View reviewed changes

agners merged commit d1c1a2d into home-assistant:main Jun 30, 2025
23 checks passed

github-actions bot locked and limited conversation to collaborators Jul 2, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix `docker.run_command()` needing `detach` but not enforcing it #5979

Fix `docker.run_command()` needing `detach` but not enforcing it #5979

Uh oh!

felipecrs commented Jun 27, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 27, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

felipecrs commented Jun 27, 2025

Uh oh!

felipecrs commented Jun 27, 2025

Uh oh!

Uh oh!

agners commented Jun 30, 2025

Uh oh!

felipecrs commented Jun 30, 2025 •

edited

Loading

Uh oh!

agners left a comment

Uh oh!

Uh oh!

Uh oh!

Fix docker.run_command() needing detach but not enforcing it #5979

Fix docker.run_command() needing detach but not enforcing it #5979

Uh oh!

Conversation

felipecrs commented Jun 27, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

felipecrs commented Jun 27, 2025

Uh oh!

felipecrs commented Jun 27, 2025

Uh oh!

Uh oh!

agners commented Jun 30, 2025

Uh oh!

felipecrs commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

agners left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Fix `docker.run_command()` needing `detach` but not enforcing it #5979

Fix `docker.run_command()` needing `detach` but not enforcing it #5979

felipecrs commented Jun 27, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 27, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

felipecrs commented Jun 30, 2025 •

edited

Loading