From 55a6fdb7fdadd09ca93f91bb661a57942fd6ed8b Mon Sep 17 00:00:00 2001 From: Zack Weinberg Date: Thu, 5 Jan 2017 15:51:45 -0500 Subject: [PATCH 1/3] Add std::process::Command::envs() Command::envs() adds a vector of key-value pairs to the child process environment all at once. Suggested in #38526. --- src/libstd/process.rs | 32 +++++++++++++++++ src/test/run-pass/process-envs.rs | 60 +++++++++++++++++++++++++++++++ 2 files changed, 92 insertions(+) create mode 100644 src/test/run-pass/process-envs.rs diff --git a/src/libstd/process.rs b/src/libstd/process.rs index e15c37aaf2491..676ae286eaa50 100644 --- a/src/libstd/process.rs +++ b/src/libstd/process.rs @@ -377,6 +377,38 @@ impl Command { self } + /// Add or update multiple environment variable mappings. + /// + /// # Examples + /// + /// Basic usage: + /// ```no_run + /// use std::process::{Command, Stdio}; + /// use std::env; + /// + /// let filtered_env : Vec<(String, String)> = + /// env::vars().filter(|&(ref k, _)| + /// k == "TERM" || k == "TZ" || k == "LANG" || k == "PATH" + /// ).collect(); + /// + /// Command::new("printenv") + /// .stdin(Stdio::null()) + /// .stdout(Stdio::inherit()) + /// .env_clear() + /// .envs(&filtered_env) + /// .spawn() + /// .expect("printenv failed to start"); + /// ``` + #[stable(feature = "process", since = "1.16.0")] + pub fn envs(&mut self, vars: &[(K, V)]) -> &mut Command + where K: AsRef, V: AsRef + { + for &(ref key, ref val) in vars { + self.inner.env(key.as_ref(), val.as_ref()); + } + self + } + /// Removes an environment variable mapping. /// /// # Examples diff --git a/src/test/run-pass/process-envs.rs b/src/test/run-pass/process-envs.rs new file mode 100644 index 0000000000000..229f8488f19f0 --- /dev/null +++ b/src/test/run-pass/process-envs.rs @@ -0,0 +1,60 @@ +// Copyright 2014, 2017 The Rust Project Developers. See the COPYRIGHT +// file at the top-level directory of this distribution and at +// http://rust-lang.org/COPYRIGHT. +// +// Licensed under the Apache License, Version 2.0 or the MIT license +// , at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +// ignore-emscripten + +use std::process::Command; +use std::env; + +#[cfg(all(unix, not(target_os="android")))] +pub fn env_cmd() -> Command { + Command::new("env") +} +#[cfg(target_os="android")] +pub fn env_cmd() -> Command { + let mut cmd = Command::new("/system/bin/sh"); + cmd.arg("-c").arg("set"); + cmd +} + +#[cfg(windows)] +pub fn env_cmd() -> Command { + let mut cmd = Command::new("cmd"); + cmd.arg("/c").arg("set"); + cmd +} + +fn main() { + // save original environment + let old_env = env::var_os("RUN_TEST_NEW_ENV"); + + env::set_var("RUN_TEST_NEW_ENV", "123"); + + // create filtered environment vector + let filtered_env : Vec<(String, String)> = + env::vars().filter(|&(ref k, _)| k == "PATH").collect(); + + let mut cmd = env_cmd() + .env_clear() + .envs(&filtered_env); + + // restore original environment + match old_env { + None => env::remove_var("RUN_TEST_NEW_ENV"), + Some(val) => env::set_var("RUN_TEST_NEW_ENV", &val) + } + + let prog = cmd.spawn().unwrap(); + let result = prog.wait_with_output().unwrap(); + let output = String::from_utf8_lossy(&result.stdout); + + assert!(!output.contains("RUN_TEST_NEW_ENV"), + "found RUN_TEST_NEW_ENV inside of:\n\n{}", output); +} From c74efddc89859b9ddfbdccf8ccb2fa9862a1681d Mon Sep 17 00:00:00 2001 From: Zack Weinberg Date: Tue, 10 Jan 2017 13:00:07 -0500 Subject: [PATCH 2/3] Fixes: * give the new feature its own feature tag * correct a lifetime problem in the test * use .output() instead of .spawn() in the test so that output is actually collected * correct the same error in the test whose skeleton I cribbed --- src/libstd/process.rs | 2 +- src/test/run-pass/process-envs.rs | 9 ++++----- src/test/run-pass/process-remove-from-env.rs | 3 +-- 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/src/libstd/process.rs b/src/libstd/process.rs index 676ae286eaa50..1b1f2291826bf 100644 --- a/src/libstd/process.rs +++ b/src/libstd/process.rs @@ -399,7 +399,7 @@ impl Command { /// .spawn() /// .expect("printenv failed to start"); /// ``` - #[stable(feature = "process", since = "1.16.0")] + #[stable(feature = "command_envs", since = "1.16.0")] pub fn envs(&mut self, vars: &[(K, V)]) -> &mut Command where K: AsRef, V: AsRef { diff --git a/src/test/run-pass/process-envs.rs b/src/test/run-pass/process-envs.rs index 229f8488f19f0..80ff16aadb28d 100644 --- a/src/test/run-pass/process-envs.rs +++ b/src/test/run-pass/process-envs.rs @@ -41,9 +41,9 @@ fn main() { let filtered_env : Vec<(String, String)> = env::vars().filter(|&(ref k, _)| k == "PATH").collect(); - let mut cmd = env_cmd() - .env_clear() - .envs(&filtered_env); + let mut cmd = env_cmd(); + cmd.env_clear(); + cmd.envs(&filtered_env); // restore original environment match old_env { @@ -51,8 +51,7 @@ fn main() { Some(val) => env::set_var("RUN_TEST_NEW_ENV", &val) } - let prog = cmd.spawn().unwrap(); - let result = prog.wait_with_output().unwrap(); + let result = cmd.output().unwrap(); let output = String::from_utf8_lossy(&result.stdout); assert!(!output.contains("RUN_TEST_NEW_ENV"), diff --git a/src/test/run-pass/process-remove-from-env.rs b/src/test/run-pass/process-remove-from-env.rs index cce5ef4fe17c3..b7f296a65c216 100644 --- a/src/test/run-pass/process-remove-from-env.rs +++ b/src/test/run-pass/process-remove-from-env.rs @@ -46,8 +46,7 @@ fn main() { Some(val) => env::set_var("RUN_TEST_NEW_ENV", &val) } - let prog = cmd.spawn().unwrap(); - let result = prog.wait_with_output().unwrap(); + let result = cmd.output().unwrap(); let output = String::from_utf8_lossy(&result.stdout); assert!(!output.contains("RUN_TEST_NEW_ENV"), From 2580950fcd7c516ebd2fc090443b5406a18f77bb Mon Sep 17 00:00:00 2001 From: Zack Weinberg Date: Sat, 21 Jan 2017 11:01:11 -0500 Subject: [PATCH 3/3] Generalize envs() and args() to iterators. * Command::envs() now takes anything that is IntoIterator where both K and V are AsRef. * Since we're not 100% sure that's the right signature, envs() is now marked unstable. (You can use envs() with HashMap but not Vec<(str, str)>, for instance.) * Update the test to match. * By analogy, args() now takes any IntoIterator, S: AsRef. This should be uncontroversial. --- src/libstd/process.rs | 15 +++++++++------ src/test/run-pass/process-envs.rs | 5 ++++- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/src/libstd/process.rs b/src/libstd/process.rs index 1b1f2291826bf..d4dbbec1feec7 100644 --- a/src/libstd/process.rs +++ b/src/libstd/process.rs @@ -345,7 +345,9 @@ impl Command { /// .expect("ls command failed to start"); /// ``` #[stable(feature = "process", since = "1.0.0")] - pub fn args>(&mut self, args: &[S]) -> &mut Command { + pub fn args(&mut self, args: I) -> &mut Command + where I: IntoIterator, S: AsRef + { for arg in args { self.arg(arg.as_ref()); } @@ -385,8 +387,9 @@ impl Command { /// ```no_run /// use std::process::{Command, Stdio}; /// use std::env; + /// use std::collections::HashMap; /// - /// let filtered_env : Vec<(String, String)> = + /// let filtered_env : HashMap = /// env::vars().filter(|&(ref k, _)| /// k == "TERM" || k == "TZ" || k == "LANG" || k == "PATH" /// ).collect(); @@ -399,11 +402,11 @@ impl Command { /// .spawn() /// .expect("printenv failed to start"); /// ``` - #[stable(feature = "command_envs", since = "1.16.0")] - pub fn envs(&mut self, vars: &[(K, V)]) -> &mut Command - where K: AsRef, V: AsRef + #[unstable(feature = "command_envs", issue = "38526")] + pub fn envs(&mut self, vars: I) -> &mut Command + where I: IntoIterator, K: AsRef, V: AsRef { - for &(ref key, ref val) in vars { + for (ref key, ref val) in vars { self.inner.env(key.as_ref(), val.as_ref()); } self diff --git a/src/test/run-pass/process-envs.rs b/src/test/run-pass/process-envs.rs index 80ff16aadb28d..a131dcbe4ddc3 100644 --- a/src/test/run-pass/process-envs.rs +++ b/src/test/run-pass/process-envs.rs @@ -10,8 +10,11 @@ // ignore-emscripten +#![feature(command_envs)] + use std::process::Command; use std::env; +use std::collections::HashMap; #[cfg(all(unix, not(target_os="android")))] pub fn env_cmd() -> Command { @@ -38,7 +41,7 @@ fn main() { env::set_var("RUN_TEST_NEW_ENV", "123"); // create filtered environment vector - let filtered_env : Vec<(String, String)> = + let filtered_env : HashMap = env::vars().filter(|&(ref k, _)| k == "PATH").collect(); let mut cmd = env_cmd();