Allow conversion of `std::process::Command` into a `openssh::Command` given a `openssh::Session`. #112

aalekhpatel07 · 2023-01-31T03:03:39Z

The std::process::Command and the openssh::Command APIs are fairly similar, so I wonder if it is reasonable to allow an arbitrary std::process::Command to be run over ssh.

Example

use std::process;
use openssh::{OverSsh, Session, KnownHosts};

#[tokio::main]
pub async fn main() {
    let session = Session::connect_mux("[email protected]", KnownHosts::Strict).await.unwrap();

    let ls = process::Command::new("ls")
        .arg("-l")
        .arg("-h")
        .over_ssh(&session)
        .expect("no env vars or current_dir are specified")
        .output()
        .await
        .unwrap();

    println!("{}", String::from_utf8_lossy(&ls.stdout));
}

jonhoo · 2023-01-31T03:03:45Z

This change is

NobodyXu

Thanks!

I really like the design and the implementation is simple, but there are a few places where it can be improved.

src/command.rs

aalekhpatel07 · 2023-01-31T03:14:39Z

wow thank you for your kind words and a quick review. I'll clean it up right away! Thanks for your time.

src/command.rs

NobodyXu · 2023-01-31T05:21:55Z

Ehhh we now have a rustc ICE.

@aalekhpatel07 Would you like to open an issue in rust-lang/rust?

codecov-commenter · 2023-01-31T05:23:20Z

Codecov Report

Merging #112 (f30d34e) into master (3319a81) will increase coverage by 0.32%.
The diff coverage is 87.50%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

Files Changed	Coverage Δ
src/error.rs	`89.16% <ø> (ø)`
src/command.rs	`89.92% <69.23%> (-8.08%)`	⬇️
src/escape.rs	`100.00% <100.00%> (ø)`

... and 1 file with indirect coverage changes

aalekhpatel07 · 2023-01-31T05:35:30Z

Ehhh we now have a rustc ICE.

@aalekhpatel07 Would you like to open an issue in rust-lang/rust?

Haha for sure. Any preference for a name?

NobodyXu · 2023-01-31T05:54:58Z

@aalekhpatel07 Looks like some of the ICEs happens in mir borrow checking, so perhaps "mir borrow checking ICE in openssh-rust" will be a good name.

Also I recommend you to create a separate branch, containing the commit causing the ICEs just so it's easier for others to reproduce the ICEs.

aalekhpatel07 · 2023-01-31T06:12:23Z

I believe the new escape(s: &[u8]) -> String should do the job for us. lmk

(I'm sorry I think I accidentally removed the review request for jonhoo).

src/command.rs

src/escape.rs

src/lib.rs

src/escape.rs

NobodyXu · 2023-01-31T06:26:09Z

(I'm sorry I think I accidentally removed the review request for jonhoo).

No worries, I've re-requested it.

NobodyXu · 2023-01-31T06:29:16Z

Aha, the CI reliably failed with ICEs from rustc.

aalekhpatel07 · 2023-01-31T07:14:42Z

okay how about these changes? (thank you for being patient.)

src/command.rs

src/lib.rs

src/escape.rs

NobodyXu · 2023-01-31T07:49:57Z

okay how about these changes? (thank you for being patient.)

It's much better, but we would still need @jonhoo 's approval on this.
I'm not entirely sure about escaping since the utf encoding is a mess, so I just want to be safe and ask @jonhoo to also review this.

NobodyXu · 2023-01-31T07:51:51Z

@aalekhpatel07 BTW, don't forget to create a new issue on rust-lang/rust and linked it to this.
We would also have to waiting for the compiler guys to investigate and fix the issues.

Since we are on rust 1.67, not nightly channel, this might requires a new minor release.

I think this ICE might be a regression.

NobodyXu · 2023-01-31T08:38:41Z

@aalekhpatel07 Hmmm, let me create the bug report for this.

NobodyXu · 2023-01-31T08:43:15Z

@aalekhpatel07 I've created an ICE bug report on rust-lang/rust.

Note that the lint CI did work as intended and you need to fix all cargo-clippy warnings.

NobodyXu

Almost done from me, some small changes requested...

Regarding the ICEs, there's already a PR in rust-lang/rust to fix this.

src/escape.rs

NobodyXu

Now we just need to wait for @jonhoo to review this and upstream to fix the ICEs on stable channel.

aalekhpatel07 · 2023-02-01T01:10:21Z

They have a PR for that ICE already??

Wow! I'm blown away by how responsive, knowledgeable, and supportive the contributors are in the Rust ecosystem.

Thank you for all your help, @NobodyXu, for helping me improve the PR and develop my understanding of Cows and OsStrs in Rust.

NobodyXu · 2023-02-01T01:13:12Z

They have a PR for that ICE already??

Yes, rust-lang/rust#107532

Though I have no idea on whether it will land in 1.68 or will they have a backport it to 1.67.1 since whether a backport will happen depends on the severity of the bug.

Thank you for all your help, @NobodyXu, for helping me improve the PR and develop my understanding of Cows and OsStrs in Rust.

No worries!

jonhoo

This is a really neat idea! Thank you both for pushing it forward. I've left some notes.

src/command.rs

jonhoo · 2023-02-05T18:33:49Z

src/escape.rs

@@ -0,0 +1,90 @@
+//! Escape characters that may have special meaning in a shell, including spaces.
+//! This is a modified version of the [`shell-escape::unix`] module of [`shell-escape`] crate.


Can we submit a PR to shell-escape to add a version supporting OsStr there directly? I'm okay with us landing our own version initially, but it'd be way better if we could just use a version from them in the future.

Great suggestion! I've initiated a PR to shell-escape and if it gets merged, we can avoid having a src/escape.rs altogether.

src/escape.rs

tests/openssh.rs

… openssh::Session. Signed-off-by: Aalekh Patel <[email protected]>

Signed-off-by: Aalekh Patel <[email protected]>

Co-authored-by: Jiahao XU <[email protected]>

Signed-off-by: Aalekh Patel <[email protected]>

Co-authored-by: Jiahao XU <[email protected]>

Signed-off-by: Aalekh Patel <[email protected]>

Co-authored-by: Jiahao XU <[email protected]>

Signed-off-by: Aalekh Patel <[email protected]>

…the command. Signed-off-by: Aalekh Patel <[email protected]>

Signed-off-by: Aalekh Patel <[email protected]>

NobodyXu · 2023-07-28T08:09:07Z

Since the ICE is fixed and the CI has passed, I will merge this PR.

NobodyXu requested changes Jan 31, 2023

View reviewed changes

src/command.rs Show resolved Hide resolved

src/command.rs Show resolved Hide resolved

src/command.rs Outdated Show resolved Hide resolved

src/command.rs Outdated Show resolved Hide resolved

src/command.rs Outdated Show resolved Hide resolved

NobodyXu requested changes Jan 31, 2023

View reviewed changes

src/command.rs Outdated Show resolved Hide resolved

src/command.rs Outdated Show resolved Hide resolved

aalekhpatel07 requested a review from NobodyXu January 31, 2023 04:38

NobodyXu requested changes Jan 31, 2023

View reviewed changes

src/command.rs Outdated Show resolved Hide resolved

src/command.rs Outdated Show resolved Hide resolved

src/command.rs Outdated Show resolved Hide resolved

NobodyXu requested a review from jonhoo January 31, 2023 05:21

aalekhpatel07 requested review from NobodyXu and removed request for jonhoo January 31, 2023 06:11

NobodyXu requested a review from jonhoo January 31, 2023 06:17

NobodyXu requested changes Jan 31, 2023

View reviewed changes

src/command.rs Outdated Show resolved Hide resolved

src/lib.rs Outdated Show resolved Hide resolved

src/escape.rs Show resolved Hide resolved

src/escape.rs Outdated Show resolved Hide resolved

src/escape.rs Show resolved Hide resolved

src/escape.rs Outdated Show resolved Hide resolved

NobodyXu mentioned this pull request Jan 31, 2023

1.67 mir borrow checking ICE: thread 'rustc' panicked at 'region variables should not be hashed: '_#39r' rust-lang/rust#107505

Closed

NobodyXu requested changes Feb 1, 2023

View reviewed changes

src/escape.rs Outdated Show resolved Hide resolved

src/escape.rs Show resolved Hide resolved

src/escape.rs Outdated Show resolved Hide resolved

NobodyXu approved these changes Feb 1, 2023

View reviewed changes

jonhoo requested changes Feb 5, 2023

View reviewed changes

aalekhpatel07 and others added 27 commits July 28, 2023 17:54

Add OverSsh trait to allow conversion of std::process::Command into a…

e314422

… openssh::Session. Signed-off-by: Aalekh Patel <[email protected]>

Add a doc comment and example usage.

d9ba8d3

Signed-off-by: Aalekh Patel <[email protected]>

Add tests for OverSsh's with_session

dd64633

Signed-off-by: Aalekh Patel <[email protected]>

Use raw_command and raw_args. Refactor the name to 'over_ssh'.

9743a5e

Signed-off-by: Aalekh Patel <[email protected]>

Remove a dangling test import. Use better name for test.

0a69ed1

Signed-off-by: Aalekh Patel <[email protected]>

Clean up doc comment.

974cd52

Signed-off-by: Aalekh Patel <[email protected]>

Apply suggestions of code review.

cca22b1

Signed-off-by: Aalekh Patel <[email protected]>

Update src/command.rs

66cecba

Co-authored-by: Jiahao XU <[email protected]>

Apply more suggestions from the code review.

511c62c

Signed-off-by: Aalekh Patel <[email protected]>

Apply more suggestions from the code review.

d14a4c2

Signed-off-by: Aalekh Patel <[email protected]>

Update src/command.rs

32a8960

Co-authored-by: Jiahao XU <[email protected]>

Update src/lib.rs

08b77a5

Co-authored-by: Jiahao XU <[email protected]>

Update src/escape.rs

5d9a112

Co-authored-by: Jiahao XU <[email protected]>

Apply more suggestions. Add a test for non-utf8 chars for escape.

7d84871

Slight refactor of escape.

c4baafd

Signed-off-by: Aalekh Patel <[email protected]>

Run cargo clippy --fix and persist all modifications to escape.rs

7e84beb

Signed-off-by: Aalekh Patel <[email protected]>

Apply rustfmt to command.rs and escape.rs

7fcfaf2

Signed-off-by: Aalekh Patel <[email protected]>

Lint over_session test

13d865a

Signed-off-by: Aalekh Patel <[email protected]>

Update src/escape.rs

c4ded38

Co-authored-by: Jiahao XU <[email protected]>

Update src/escape.rs

67d0885

Co-authored-by: Jiahao XU <[email protected]>

Update src/escape.rs

6970753

Co-authored-by: Jiahao XU <[email protected]>

Apply more suggestions.

8207907

Signed-off-by: Aalekh Patel <[email protected]>

Rustfmt fix.

10687fb

Signed-off-by: Aalekh Patel <[email protected]>

Fix a doctest for overssh.

020366a

Signed-off-by: Aalekh Patel <[email protected]>

Add a test for overssh that requires escaping the argument passed to …

6842e5a

…the command. Signed-off-by: Aalekh Patel <[email protected]>

Update overssh require-escaping-arguments test to contain a space.

e09d2fd

Signed-off-by: Aalekh Patel <[email protected]>

Apply rustfmt to tests/openssh.rs

f30d34e

Signed-off-by: Aalekh Patel <[email protected]>

NobodyXu force-pushed the master branch from 04e93e6 to f30d34e Compare July 28, 2023 07:54

NobodyXu merged commit fefd900 into openssh-rust:master Jul 28, 2023
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow conversion of `std::process::Command` into a `openssh::Command` given a `openssh::Session`. #112

Allow conversion of `std::process::Command` into a `openssh::Command` given a `openssh::Session`. #112

aalekhpatel07 commented Jan 31, 2023 •

edited

Loading

jonhoo commented Jan 31, 2023

NobodyXu left a comment

aalekhpatel07 commented Jan 31, 2023

NobodyXu commented Jan 31, 2023

codecov-commenter commented Jan 31, 2023 •

edited

Loading

aalekhpatel07 commented Jan 31, 2023

NobodyXu commented Jan 31, 2023

aalekhpatel07 commented Jan 31, 2023 •

edited

Loading

NobodyXu commented Jan 31, 2023

NobodyXu commented Jan 31, 2023

aalekhpatel07 commented Jan 31, 2023

NobodyXu commented Jan 31, 2023

NobodyXu commented Jan 31, 2023 •

edited

Loading

NobodyXu commented Jan 31, 2023

NobodyXu commented Jan 31, 2023

NobodyXu left a comment

NobodyXu left a comment

aalekhpatel07 commented Feb 1, 2023

NobodyXu commented Feb 1, 2023

jonhoo left a comment

jonhoo Feb 5, 2023

aalekhpatel07 Feb 6, 2023

NobodyXu commented Jul 28, 2023

		@@ -0,0 +1,90 @@
		//! Escape characters that may have special meaning in a shell, including spaces.
		//! This is a modified version of the [`shell-escape::unix`] module of [`shell-escape`] crate.

Allow conversion of std::process::Command into a openssh::Command given a openssh::Session. #112

Allow conversion of std::process::Command into a openssh::Command given a openssh::Session. #112

Conversation

aalekhpatel07 commented Jan 31, 2023 • edited Loading

Example

jonhoo commented Jan 31, 2023

NobodyXu left a comment

Choose a reason for hiding this comment

aalekhpatel07 commented Jan 31, 2023

NobodyXu commented Jan 31, 2023

codecov-commenter commented Jan 31, 2023 • edited Loading

Codecov Report

aalekhpatel07 commented Jan 31, 2023

NobodyXu commented Jan 31, 2023

aalekhpatel07 commented Jan 31, 2023 • edited Loading

NobodyXu commented Jan 31, 2023

NobodyXu commented Jan 31, 2023

aalekhpatel07 commented Jan 31, 2023

NobodyXu commented Jan 31, 2023

NobodyXu commented Jan 31, 2023 • edited Loading

NobodyXu commented Jan 31, 2023

NobodyXu commented Jan 31, 2023

NobodyXu left a comment

Choose a reason for hiding this comment

NobodyXu left a comment

Choose a reason for hiding this comment

aalekhpatel07 commented Feb 1, 2023

NobodyXu commented Feb 1, 2023

jonhoo left a comment

Choose a reason for hiding this comment

jonhoo Feb 5, 2023

Choose a reason for hiding this comment

aalekhpatel07 Feb 6, 2023

Choose a reason for hiding this comment

NobodyXu commented Jul 28, 2023

Allow conversion of `std::process::Command` into a `openssh::Command` given a `openssh::Session`. #112

Allow conversion of `std::process::Command` into a `openssh::Command` given a `openssh::Session`. #112

aalekhpatel07 commented Jan 31, 2023 •

edited

Loading

codecov-commenter commented Jan 31, 2023 •

edited

Loading

aalekhpatel07 commented Jan 31, 2023 •

edited

Loading

NobodyXu commented Jan 31, 2023 •

edited

Loading