improve path check #501

thangckt · 2024-10-06T13:06:45Z

avoid raise error on some sombinations of python version + platform

Summary by CodeRabbit

New Features
- Enhanced upload and download methods for improved file transfer operations.
Bug Fixes
- Improved error handling in file writing to prevent overwriting existing files.
Refactor
- Updated method signatures and streamlined property access for better clarity and functionality.
- Removed unnecessary commented code to enhance code readability.

- add option: "strategy": {"customized_script_header_template_file": ""}, - add option: `sge_pe_name`

for more information, see https://pre-commit.ci

u

for more information, see https://pre-commit.ci

u

for more information, see https://pre-commit.ci

u

for more information, see https://pre-commit.ci

u

for more information, see https://pre-commit.ci

Update pbs.py

for more information, see https://pre-commit.ci

put `sge_pe_name` in `kwargs`

fetch

for more information, see https://pre-commit.ci

fetch

for more information, see https://pre-commit.ci

fetch

codecov · 2024-10-06T13:07:49Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.04%. Comparing base (25668e7) to head (be99e41).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #501      +/-   ##
==========================================
- Coverage   60.19%   59.04%   -1.16%     
==========================================
  Files          39       40       +1     
  Lines        3859     3870      +11     
==========================================
- Hits         2323     2285      -38     
- Misses       1536     1585      +49

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

coderabbitai · 2024-10-06T13:11:11Z

📝 Walkthrough

Walkthrough

The changes in this pull request primarily focus on the SSHContext class in the dpdispatcher/contexts/ssh_context.py file. Key modifications include updating assertions for remote_root, removing commented-out code, enhancing method signatures for put and get to incorporate self.remote, improving error handling in the write_file method, and refining the upload and download methods with additional checks and logging. These updates aim to enhance the overall functionality and maintainability of the class.

Changes

File	Change Summary
dpdispatcher/contexts/ssh_context.py	- Updated assertion for `remote_root` to use `os.path.realpath()`.
	- Removed commented-out code in `__init__` and `load_from_dict` methods.
	- Modified `put` and `get` methods to utilize `self.remote` for remote file paths.
	- Enhanced error handling in `write_file` with a temporary file mechanism.
	- Improved `upload` and `download` methods with additional checks and logging.
	- Streamlined access to `sftp` and `ssh` properties for session validation.

Possibly related PRs

fix: fix the remote path in SSH when local is Windows #472: This PR modifies the handling of file paths in the upload method of ssh_context.py, which is directly related to the changes made in the main PR regarding the put and get methods that also involve remote file path handling.

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.

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

dpdispatcher/contexts/ssh_context.py (1)
453-455: Fix Typographical Error in Assertion Message

The assertion message should read "remote_root must be an absolute path" instead of "remote_root must be a abspath".

Apply this diff to correct the message:
-            ), "remote_root must be a abspath"
+            ), "remote_root must be an absolute path"

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 25668e7 and be99e41.

📒 Files selected for processing (1)

dpdispatcher/contexts/ssh_context.py (1 hunks)

🧰 Additional context used

🔇 Additional comments (1)

dpdispatcher/contexts/ssh_context.py (1)

453-455: Improved Path Validation with os.path.realpath

Using os.path.realpath(remote_root) ensures that symbolic links are resolved before checking if the path is absolute. This change enhances the robustness of the path validation.

improve path check (deepmodeling#501)

thangckt and others added 30 commits March 26, 2024 16:25

revise SGE

11fe336

- add option: "strategy": {"customized_script_header_template_file": ""}, - add option: `sge_pe_name`

Update pbs.py

8140a43

Update pbs.py

b893544

Update pbs.py

82b7262

add sge_qe_name

01ffd14

Update pbs.py

56e3afe

y

703aa49

Update submission.py

2c3b38a

u

f73e0f9

[pre-commit.ci] auto fixes from pre-commit.com hooks

957cf4a

for more information, see https://pre-commit.ci

Update pbs.py

034c9d7

Update pbs.py

3f07742

Merge branch 'PR' into master

499c691

Merge pull request #1 from thangckt/master

76150bf

u

[pre-commit.ci] auto fixes from pre-commit.com hooks

ef28a1b

for more information, see https://pre-commit.ci

u

65dca91

Merge pull request #2 from thangckt/master

ffe52e1

u

[pre-commit.ci] auto fixes from pre-commit.com hooks

8d7b566

for more information, see https://pre-commit.ci

u

8c50c4f

Merge branch 'PR' into master

89d2a41

Merge pull request #3 from thangckt/master

2093336

u

[pre-commit.ci] auto fixes from pre-commit.com hooks

920984d

for more information, see https://pre-commit.ci

y

c8f5657

Merge branch 'master' of https://github.com/thangckt/dpdispatcher

ef6ebeb

Merge branch 'PR' into master

f56fa50

Merge pull request #4 from thangckt/master

e06c648

u

[pre-commit.ci] auto fixes from pre-commit.com hooks

6d6c973

for more information, see https://pre-commit.ci

Update pbs.py

dae7909

Merge pull request #5 from thangckt/master

4ca179c

Update pbs.py

[pre-commit.ci] auto fixes from pre-commit.com hooks

83644c3

for more information, see https://pre-commit.ci

thangckt and others added 24 commits May 29, 2024 10:25

Merge branch 'PR' of https://github.com/thangckt/dpdispatcher into PR

10cf5d3

Merge pull request #12 from thangckt/PR

416a767

put `sge_pe_name` in `kwargs`

Update test_lsf_script_generation.py

e530cf6

Merge pull request #13 from deepmodeling/master

5adce1b

fetch

Update pbs.py

4084a31

[pre-commit.ci] auto fixes from pre-commit.com hooks

9b1c566

for more information, see https://pre-commit.ci

change sge_pe_name to pe_name

fc690ae

Update ssh_context.py

cfbc5dd

Merge branch 'master' into master

81f52a3

[pre-commit.ci] auto fixes from pre-commit.com hooks

7bbc485

for more information, see https://pre-commit.ci

u

37da47c

[pre-commit.ci] auto fixes from pre-commit.com hooks

bca9728

for more information, see https://pre-commit.ci

Merge pull request #14 from deepmodeling/master

02f1449

fetch

Update SSHcontext: add execute command

c13be3b

[pre-commit.ci] auto fixes from pre-commit.com hooks

a9fbadf

for more information, see https://pre-commit.ci

Update pbs.py

fba9574

Merge remote-tracking branch 'upstream/master' into dev

0d2cd71

Update dlog.py

5f42bc8

Update dlog.py

bfe1615

Merge pull request #16 from deepmodeling/master

1ded55e

fetch

Merge pull request #17 from deepmodeling/master

4033a20

fetch

Merge pull request #18 from deepmodeling/master

59b6139

fetch

Update ssh_context.py

1f514de

Update ssh_context.py

be99e41

coderabbitai bot reviewed Oct 6, 2024

View reviewed changes

njzjz approved these changes Oct 6, 2024

View reviewed changes

njzjz merged commit da8e4d8 into deepmodeling:master Oct 6, 2024
26 checks passed

thangckt added a commit to thangckt/dpdispatcher that referenced this pull request Oct 15, 2024

Merge pull request #19 from deepmodeling/master

d28233d

improve path check (deepmodeling#501)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

improve path check #501

improve path check #501

thangckt commented Oct 6, 2024 •

edited by coderabbitai bot

Loading

codecov bot commented Oct 6, 2024 •

edited

Loading

coderabbitai bot commented Oct 6, 2024

Walkthrough

Changes

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

improve path check #501

improve path check #501

Conversation

thangckt commented Oct 6, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

codecov bot commented Oct 6, 2024 • edited Loading

Codecov Report

coderabbitai bot commented Oct 6, 2024

Walkthrough

Changes

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

thangckt commented Oct 6, 2024 •

edited by coderabbitai bot

Loading

codecov bot commented Oct 6, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)