Skip to content

Create working directory #767

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jul 31, 2025
Merged

Create working directory #767

merged 3 commits into from
Jul 31, 2025

Conversation

@jan-janssen
Copy link
Member

@jan-janssen jan-janssen commented Jul 31, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Bug Fixes
    • Ensured that specified working directories are automatically created if they do not exist before launching subprocesses or job specifications. This prevents errors related to missing directories during process startup.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 31, 2025 •
edited
Loading

Walkthrough

The changes ensure that the working directory specified for subprocess or job execution exists before launching processes. This is implemented by creating the directory (and parents) if it does not exist in the SubprocessSpawner, FluxPythonSpawner, and queue_spawner and subprocess_spawner modules using os.makedirs(..., exist_ok=True).

Changes

Cohort / File(s) Change Summary
SubprocessSpawner Working Directory Creation
executorlib/standalone/interactive/spawner.py		 Imports os and updates SubprocessSpawner.bootup to create the working directory if it doesn't exist before launching subprocess.
FluxPythonSpawner Working Directory Creation
executorlib/task_scheduler/interactive/fluxspawner.py		 Adds os.makedirs in FluxPythonSpawner.bootup to ensure the working directory exists before job submission.
QueueSpawner Directory Creation Adjustment
executorlib/task_scheduler/file/queue_spawner.py		 Moves os.makedirs call outside the else block so the working directory is created regardless of how it is set.
SubprocessSpawner Directory Creation in File Scheduler
executorlib/task_scheduler/file/subprocess_spawner.py		 Adds os.makedirs to create the working directory before launching subprocess to avoid errors when directory is missing.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

In the warren where processes hop,
Directories now sprout before jobs drop.
With makedirs called and errors at bay,
Each rabbit ensures a smooth workday.
No more tripping on missing paths—
Just code that runs and gently laughs! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 40f0614 and 623c1ea.

📒 Files selected for processing (2)
  • executorlib/task_scheduler/file/queue_spawner.py (1 hunks)
  • executorlib/task_scheduler/file/subprocess_spawner.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (17)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-openmpi.yml)
  • GitHub Check: unittest_mpich (ubuntu-latest, 3.12)
  • GitHub Check: unittest_mpich (ubuntu-latest, 3.11)
  • GitHub Check: unittest_mpich (macos-latest, 3.13)
  • GitHub Check: unittest_mpich (ubuntu-latest, 3.13)
  • GitHub Check: benchmark (ubuntu-latest, 3.13, .ci_support/environment-mpich.yml)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.12)
  • GitHub Check: unittest_slurm_mpich
  • GitHub Check: unittest_old
  • GitHub Check: notebooks
  • GitHub Check: unittest_openmpi (macos-latest, 3.13)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.11)
  • GitHub Check: unittest_openmpi (ubuntu-latest, 3.13)
  • GitHub Check: unittest_flux_mpich
  • GitHub Check: unittest_flux_openmpi
  • GitHub Check: notebooks_integration
  • GitHub Check: unittest_win
🔇 Additional comments (2)
executorlib/task_scheduler/file/subprocess_spawner.py (1)

59-60: LGTM! Proper directory creation before subprocess execution.

The addition correctly ensures the working directory exists before launching the subprocess. The implementation is safe with exist_ok=True and properly guards against None values.

executorlib/task_scheduler/file/queue_spawner.py (1)

64-64: LGTM! Improved consistency by ensuring directory creation in all cases.

Moving the os.makedirs call outside the conditional block ensures the working directory is created regardless of whether cwd comes from resource_dict or is constructed from the command. This is a good improvement for consistency across different execution paths.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch create_working_directory

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 generate unit tests to generate unit tests 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.
@codecov
Copy link

codecov bot commented Jul 31, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.53%. Comparing base (ecfc2db) to head (623c1ea).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@ Coverage Diff @@ ## main #767 +/- ## ========================================== + Coverage 97.52% 97.53% +0.01%  ========================================== Files 33 33 Lines 1454 1460 +6 ========================================== + Hits 1418 1424 +6  Misses 36 36

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
coderabbitai[bot]
coderabbitai bot reviewed Jul 31, 2025
View reviewed changes
Copy link
Contributor

@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)
executorlib/task_scheduler/interactive/fluxspawner.py (1)

116-116: LGTM! Consider adding error handling for directory creation failures.

The directory creation logic is well-placed and uses appropriate parameters. The exist_ok=True flag prevents errors when the directory already exists.

Consider whether you want to handle potential OSError exceptions that could occur due to permission issues or invalid paths, or if letting them propagate is the desired behavior.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ecfc2db and 40f0614.

📒 Files selected for processing (2)
  • executorlib/standalone/interactive/spawner.py (2 hunks)
  • executorlib/task_scheduler/interactive/fluxspawner.py (1 hunks)
🔇 Additional comments (2)
executorlib/standalone/interactive/spawner.py (2)

1-1: Good addition of required import.

The os module import is necessary for the os.makedirs call added later in the file.

97-98: LGTM! Consistent implementation with FluxPythonSpawner.

The directory creation logic is well-implemented and matches the pattern used in the FluxPythonSpawner class. The placement right before subprocess.Popen ensures the working directory exists when needed.

The conditional check and exist_ok=True parameter are appropriate defensive programming practices.
@jan-janssen jan-janssen merged commit bbb65f9 into main Jul 31, 2025
31 checks passed
@jan-janssen jan-janssen deleted the create_working_directory branch July 31, 2025 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants

@jan-janssen