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

Change how docker run args are built #267

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

Conversation

cg2v
Copy link
Member

@cg2v cg2v commented Dec 13, 2024

There are 2 changes here

  • Redoes distDocker:runJob to look more like localDocker:runJob. I did this so I could stop maintaining a patch that manually inserts a --memory switch in distDocker
  • makes localDocker's runJob use list.append instead of + to build up the list. When I copied the code, I wanted to make it more pythonic

This isn't tested yet. I'll try to do that by next tuesday or so.

instead of constructing new list objects every time the list has items
appended to it, use python's list mutator functions (append and extend)
Make distDocker's runJob similar to localDocker's. Build a list
of args instead of assembling nested strings. Make sure to preserve
quoting of interior arguments. This has the effect of making the vm core
and memory limits effective for distDocker
@cg2v cg2v marked this pull request as ready for review December 16, 2024 19:40
@cg2v
Copy link
Member Author

cg2v commented Dec 16, 2024

tested with distDocker

Copy link

coderabbitai bot commented Dec 16, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces modifications to Docker-related classes in vmms/distDocker.py and vmms/localDocker.py, focusing on refactoring the command argument construction for Docker container execution. The changes primarily involve transitioning from string concatenation to using list-based methods like append() and extend() for building command arguments. This approach enhances code readability and provides more flexibility in constructing Docker run commands across both distributed and local Docker implementations.

Changes

File Change Summary
vmms/distDocker.py - Refactored runJob method to use list-based command argument construction
- Replaced string concatenation with list manipulation methods
- Improved handling of network and resource limit arguments
vmms/localDocker.py - Updated runJob method to use append() and extend() for argument list construction
- Replaced args = args + [...] with more explicit list manipulation methods

Sequence Diagram

sequenceDiagram
    participant Client
    participant DockerClass
    participant SSHConnection
    participant DockerContainer

    Client->>DockerClass: runJob()
    DockerClass->>DockerClass: Construct Docker run arguments
    DockerClass->>SSHConnection: Execute Docker run command
    SSHConnection->>DockerContainer: Start container
    DockerContainer-->>SSHConnection: Container execution result
    SSHConnection-->>DockerClass: Return execution result
    DockerClass-->>Client: Job result
Loading

📜 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 bff657d and e7d7ee0.

📒 Files selected for processing (2)
  • vmms/distDocker.py (2 hunks)
  • vmms/localDocker.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • vmms/distDocker.py
  • vmms/localDocker.py

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
  • @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 (2)
vmms/localDocker.py (1)

179-183: Consider using an f-string for better readability.

While the implementation is correct, the command string could be more readable using an f-string.

-        args.append(
-            'cp -r mount/* autolab/; su autolab -c "%s"; \
-                        cp output/feedback mount/feedback'
-            % autodriverCmd
-        )
+        args.append(
+            f'cp -r mount/* autolab/; su autolab -c "{autodriverCmd}"; \
+                        cp output/feedback mount/feedback'
+        )
vmms/distDocker.py (1)

292-296: Consider adding a comment about SSH command quoting.

While the implementation is correct, it would be helpful to document why the extra quotes are necessary for SSH command execution.

+        # Double quotes are required for proper SSH command execution
         args.append(
             f"\"cp -r mount/* autolab/; su autolab -c '{autodriverCmd}'; \
                         cp output/feedback mount/feedback\""
         )
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 92ae12f and bff657d.

📒 Files selected for processing (2)
  • vmms/distDocker.py (2 hunks)
  • vmms/localDocker.py (2 hunks)
🔇 Additional comments (4)
vmms/localDocker.py (2)

159-165: LGTM! Clean implementation of Docker run arguments.

The implementation properly handles resource limits and network configuration using list operations, making the code more maintainable and less error-prone.


166-167: LGTM! Consistent use of list operations.

The image and shell command arguments are added consistently using list operations.

vmms/distDocker.py (2)

283-291: LGTM! Successfully aligned with localDocker implementation.

The implementation correctly mirrors the approach in localDocker.py, maintaining consistency across both Docker implementations.


305-306: LGTM! Clean SSH command construction.

The SSH command construction is properly implemented using list operations.

@cg2v cg2v marked this pull request as draft December 17, 2024 20:25
cg2v added 2 commits December 18, 2024 11:36
append only takes a single value, make sure the arg is a single string.
use f-strings to build string values from multiple components.
@cg2v cg2v marked this pull request as ready for review December 18, 2024 16:47
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