Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: 'docker wait' requires at least 1 argument #36

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

dbankier
Copy link

@dbankier dbankier commented Mar 13, 2025

interactive mode was not returning the container id which lead to the above error - refactored to fix

Summary by CodeRabbit

  • Chores
    • Streamlined the secure transfer of connection details during container initialization.
    • Enhanced the process reliability by moving from interactive input to a more efficient, detached execution approach.

dbankier added 2 commits March 6, 2025 11:39
interactive mode was not returning the container id which lead to the above error - refactored to fix
Copy link

coderabbitai bot commented Mar 13, 2025

Walkthrough

The script has been updated to change how known hosts and SSH configurations are transferred to a Docker container. The previous method used interactive input redirection with the -i flag, while the new approach first assigns the hosts to a variable and then uses detached mode (-d) Docker run commands to append the known hosts and SSH configuration directly into the target files.

Changes

File(s) Change Summary
pre-build/... Updated Docker command execution: switched from piping echo into Docker with interactive input (-i) to using detached (-d) mode with direct echo commands that append known hosts and SSH configuration.

Sequence Diagram(s)

sequenceDiagram
    participant Script
    participant DockerEngine as Docker Engine
    participant Container

    Script->>Script: Set `hosts` variable with known hosts content
    Script->>DockerEngine: Execute `docker run -d` (append known hosts)
    DockerEngine->>Container: Start container in detached mode
    Container->>Container: Append known hosts to /etc/ssh/ssh_known_hosts and set permissions

    Script->>DockerEngine: Execute `docker run -d` (append SSH configuration)
    DockerEngine->>Container: Start container in detached mode
    Container->>Container: Append SSH config line
Loading

Poem

I hopped along the code lane so bright,
Ditching the old for detached command flight.
Known hosts and SSH now find their way,
In Docker’s realm, they securely stay.
A rabbit delights with each refined line,
Bounding through changes, feeling simply divine!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
pre-build (1)

39-48: Consider adding error handling for Docker commands.

While the changes effectively fix the specific issue with docker wait, the script could benefit from more robust error handling for Docker operations. Currently, if any Docker command fails for reasons other than exit code (e.g., Docker daemon not running), the script might not provide helpful error messages.

-  idWithKeys=$(docker run $DOKKU_GLOBAL_RUN_ARGS -d $IMAGE /bin/bash -c "echo \"$hosts\" >> /etc/ssh/ssh_known_hosts && chmod 644 /etc/ssh/ssh_known_hosts")
+  if ! idWithKeys=$(docker run $DOKKU_GLOBAL_RUN_ARGS -d $IMAGE /bin/bash -c "echo \"$hosts\" >> /etc/ssh/ssh_known_hosts && chmod 644 /etc/ssh/ssh_known_hosts"); then
+    dokku_log_fail "Failed to run Docker container for adding known hosts"
+  fi

-  idWithConfig=$(docker run $DOKKU_GLOBAL_RUN_ARGS -d $IMAGE /bin/bash -c "echo \"UserKnownHostsFile /etc/ssh/ssh_known_hosts\" >> /etc/ssh/ssh_config" )
+  if ! idWithConfig=$(docker run $DOKKU_GLOBAL_RUN_ARGS -d $IMAGE /bin/bash -c "echo \"UserKnownHostsFile /etc/ssh/ssh_known_hosts\" >> /etc/ssh/ssh_config" ); then
+    dokku_log_fail "Failed to run Docker container for adding SSH config"
+  fi
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7048d18 and 999345c.

📒 Files selected for processing (1)
  • pre-build (1 hunks)
🔇 Additional comments (2)
pre-build (2)

40-41: Improved Docker container handling method.

This change effectively addresses the PR objective by switching from an interactive mode with input redirection to a detached mode that captures container IDs properly. This ensures the docker wait command will always have an argument to work with.


45-45: Consistent approach for SSH config modification.

The modification here follows the same pattern as the known hosts change, switching from interactive mode to detached mode. This ensures reliable container ID capture for the subsequent docker wait command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant