Skip to content

fix: expand environment variables in --remote-job-local-storage-prefix within the remote job, not the main snakemake job#3222

Merged
johanneskoester merged 1 commit intomainfrom
fix/envvar-expand-remote-job
Nov 29, 2024
Merged

fix: expand environment variables in --remote-job-local-storage-prefix within the remote job, not the main snakemake job#3222
johanneskoester merged 1 commit intomainfrom
fix/envvar-expand-remote-job

Conversation

@johanneskoester
Copy link
Copy Markdown
Contributor

@johanneskoester johanneskoester commented Nov 29, 2024 •
edited
Loading

fixes #3049, snakemake/snakemake-storage-plugin-fs#22

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case.
  • The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).

Summary by CodeRabbit

  • New Features

    • No new features introduced.

  • Bug Fixes

    • Clarified help text for the --remote-job-local-storage-prefix argument.

  • Chores

    • Minor formatting adjustments and removal of unnecessary comments in the argument parser.

@johanneskoester
fix: expand environment variables given to --remote-job-local-storage…
cf27db7 
…-prefix within the remote job, not the main snakemake job
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 29, 2024 •
edited
Loading

📝 Walkthrough

Walkthrough

The changes in this pull request modify the argument parser in the snakemake/cli.py file, specifically updating the type of the --remote-job-local-storage-prefix argument. The type was simplified from maybe_base64(expandvars(Path)) to maybe_base64(Path), eliminating unnecessary environment variable expansion. Additionally, the help text was revised to clarify the context of environment variable expansion. Minor formatting changes and the removal of extraneous comments were also made, but no new features were introduced, nor were any existing features removed.

Changes

File Change Summary
snakemake/cli.py Updated argument type for --remote-job-local-storage-prefix from maybe_base64(expandvars(Path)) to maybe_base64(Path); revised help text; minor formatting adjustments and comment removals.

Assessment against linked issues

Objective Addressed Explanation
$SLURM_JOB_ID not set correctly in remote-job-local-storage-prefix when running snakemake in a SLURM job context (3049) ✅

Possibly related PRs

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between dea213d and cf27db7.

📒 Files selected for processing (1)
  • snakemake/cli.py (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
snakemake/cli.py (1)

Pattern **/*.py: Do not try to improve formatting.
Do not suggest type annotations for functions that are defined inside of functions or methods.
Do not suggest type annotation of the self argument of methods.
Do not suggest type annotation of the cls argument of classmethods.
Do not suggest return type annotation if a function or method does not contain a return statement.

🔇 Additional comments (1)
snakemake/cli.py (1)

1435-1441: LGTM! The changes correctly fix environment variable expansion timing.

The modification to remove expandvars from the argument type and update the help text is the right approach. This ensures that environment variables in the --remote-job-local-storage-prefix are expanded within the remote job context rather than prematurely in the parent job. This is particularly important for variables like $SLURM_JOB_ID that need to reflect the remote job's environment.

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

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Nov 29, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

This was referenced Nov 29, 2024
Closed
Closed
Closed
@johanneskoester johanneskoester changed the title fix: expand environment variables given to --remote-job-local-storage-prefix within the remote job, not the main snakemake job fix: expand environment variables in --remote-job-local-storage-prefix within the remote job, not the main snakemake job Nov 29, 2024
@johanneskoester johanneskoester merged commit 59c86a4 into main Nov 29, 2024
@johanneskoester johanneskoester deleted the fix/envvar-expand-remote-job branch November 29, 2024 12:28
@github-actions github-actions Bot mentioned this pull request Nov 29, 2024
Merged
johanneskoester pushed a commit that referenced this pull request Nov 29, 2024
@github-actions
chore(main): release 8.25.5 (#3223)
45cb082 
🤖 I have created a release *beep* *boop*
---


##
[8.25.5](v8.25.4...v8.25.5)
(2024-11-29)


### Bug Fixes

* expand environment variables in --remote-job-local-storage-prefix
within the remote job, not the main snakemake job
([#3222](#3222))
([59c86a4](59c86a4))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@coderabbitai coderabbitai Bot mentioned this pull request Nov 13, 2025
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

1 participant

@johanneskoester