src/libstd/process.rs

   1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Working with processes.
  12
  13 #![stable(feature = "process", since = "1.0.0")]
  14 #![allow(non_upper_case_globals)]
  15
  16 use prelude::v1::*;
  17 use io::prelude::*;
  18
  19 use ffi::OsStr;
  20 use fmt;
  21 use io::{self, Error, ErrorKind};
  22 use path;
  23 use str;
  24 use sys::pipe::{self, AnonPipe};
  25 use sys::process as imp;
  26 use sys_common::{AsInner, AsInnerMut, FromInner, IntoInner};
  27 use thread::{self, JoinHandle};
  28
  29 /// Representation of a running or exited child process.
  30 ///
  31 /// This structure is used to represent and manage child processes. A child
  32 /// process is created via the `Command` struct, which configures the spawning
  33 /// process and can itself be constructed using a builder-style interface.
  34 ///
  35 /// # Examples
  36 ///
  37 /// ```should_panic
  38 /// use std::process::Command;
  39 ///
  40 /// let mut child = Command::new("/bin/cat")
  41 ///                         .arg("file.txt")
  42 ///                         .spawn()
  43 ///                         .unwrap_or_else(|e| { panic!("failed to execute child: {}", e) });
  44 ///
  45 /// let ecode = child.wait()
  46 ///                  .unwrap_or_else(|e| { panic!("failed to wait on child: {}", e) });
  47 ///
  48 /// assert!(ecode.success());
  49 /// ```
  50 #[stable(feature = "process", since = "1.0.0")]
  51 pub struct Child {
  52     handle: imp::Process,
  53
  54     /// None until wait() or wait_with_output() is called.
  55     status: Option<imp::ExitStatus>,
  56
  57     /// The handle for writing to the child's stdin, if it has been captured
  58     #[stable(feature = "process", since = "1.0.0")]
  59     pub stdin: Option<ChildStdin>,
  60
  61     /// The handle for reading from the child's stdout, if it has been captured
  62     #[stable(feature = "process", since = "1.0.0")]
  63     pub stdout: Option<ChildStdout>,
  64
  65     /// The handle for reading from the child's stderr, if it has been captured
  66     #[stable(feature = "process", since = "1.0.0")]
  67     pub stderr: Option<ChildStderr>,
  68 }
  69
  70 impl AsInner<imp::Process> for Child {
  71     fn as_inner(&self) -> &imp::Process { &self.handle }
  72 }
  73
  74 impl IntoInner<imp::Process> for Child {
  75     fn into_inner(self) -> imp::Process { self.handle }
  76 }
  77
  78 /// A handle to a child process's stdin
  79 #[stable(feature = "process", since = "1.0.0")]
  80 pub struct ChildStdin {
  81     inner: AnonPipe
  82 }
  83
  84 #[stable(feature = "process", since = "1.0.0")]
  85 impl Write for ChildStdin {
  86     fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
  87         self.inner.write(buf)
  88     }
  89
  90     fn flush(&mut self) -> io::Result<()> {
  91         Ok(())
  92     }
  93 }
  94
  95 impl AsInner<AnonPipe> for ChildStdin {
  96     fn as_inner(&self) -> &AnonPipe { &self.inner }
  97 }
  98
  99 impl IntoInner<AnonPipe> for ChildStdin {
 100     fn into_inner(self) -> AnonPipe { self.inner }
 101 }
 102
 103 /// A handle to a child process's stdout
 104 #[stable(feature = "process", since = "1.0.0")]
 105 pub struct ChildStdout {
 106     inner: AnonPipe
 107 }
 108
 109 #[stable(feature = "process", since = "1.0.0")]
 110 impl Read for ChildStdout {
 111     fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
 112         self.inner.read(buf)
 113     }
 114 }
 115
 116 impl AsInner<AnonPipe> for ChildStdout {
 117     fn as_inner(&self) -> &AnonPipe { &self.inner }
 118 }
 119
 120 impl IntoInner<AnonPipe> for ChildStdout {
 121     fn into_inner(self) -> AnonPipe { self.inner }
 122 }
 123
 124 /// A handle to a child process's stderr
 125 #[stable(feature = "process", since = "1.0.0")]
 126 pub struct ChildStderr {
 127     inner: AnonPipe
 128 }
 129
 130 #[stable(feature = "process", since = "1.0.0")]
 131 impl Read for ChildStderr {
 132     fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
 133         self.inner.read(buf)
 134     }
 135 }
 136
 137 impl AsInner<AnonPipe> for ChildStderr {
 138     fn as_inner(&self) -> &AnonPipe { &self.inner }
 139 }
 140
 141 impl IntoInner<AnonPipe> for ChildStderr {
 142     fn into_inner(self) -> AnonPipe { self.inner }
 143 }
 144
 145 /// The `Command` type acts as a process builder, providing fine-grained control
 146 /// over how a new process should be spawned. A default configuration can be
 147 /// generated using `Command::new(program)`, where `program` gives a path to the
 148 /// program to be executed. Additional builder methods allow the configuration
 149 /// to be changed (for example, by adding arguments) prior to spawning:
 150 ///
 151 /// ```
 152 /// use std::process::Command;
 153 ///
 154 /// let output = Command::new("sh")
 155 ///                      .arg("-c")
 156 ///                      .arg("echo hello")
 157 ///                      .output()
 158 ///                      .unwrap_or_else(|e| { panic!("failed to execute process: {}", e) });
 159 /// let hello = output.stdout;
 160 /// ```
 161 #[stable(feature = "process", since = "1.0.0")]
 162 pub struct Command {
 163     inner: imp::Command,
 164
 165     // Details explained in the builder methods
 166     stdin: Option<Stdio>,
 167     stdout: Option<Stdio>,
 168     stderr: Option<Stdio>,
 169 }
 170
 171 impl Command {
 172     /// Constructs a new `Command` for launching the program at
 173     /// path `program`, with the following default configuration:
 174     ///
 175     /// * No arguments to the program
 176     /// * Inherit the current process's environment
 177     /// * Inherit the current process's working directory
 178     /// * Inherit stdin/stdout/stderr for `spawn` or `status`, but create pipes for `output`
 179     ///
 180     /// Builder methods are provided to change these defaults and
 181     /// otherwise configure the process.
 182     #[stable(feature = "process", since = "1.0.0")]
 183     pub fn new<S: AsRef<OsStr>>(program: S) -> Command {
 184         Command {
 185             inner: imp::Command::new(program.as_ref()),
 186             stdin: None,
 187             stdout: None,
 188             stderr: None,
 189         }
 190     }
 191
 192     /// Add an argument to pass to the program.
 193     #[stable(feature = "process", since = "1.0.0")]
 194     pub fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Command {
 195         self.inner.arg(arg.as_ref());
 196         self
 197     }
 198
 199     /// Add multiple arguments to pass to the program.
 200     #[stable(feature = "process", since = "1.0.0")]
 201     pub fn args<S: AsRef<OsStr>>(&mut self, args: &[S]) -> &mut Command {
 202         self.inner.args(args.iter().map(AsRef::as_ref));
 203         self
 204     }
 205
 206     /// Inserts or updates an environment variable mapping.
 207     ///
 208     /// Note that environment variable names are case-insensitive (but case-preserving) on Windows,
 209     /// and case-sensitive on all other platforms.
 210     #[stable(feature = "process", since = "1.0.0")]
 211     pub fn env<K, V>(&mut self, key: K, val: V) -> &mut Command
 212         where K: AsRef<OsStr>, V: AsRef<OsStr>
 213     {
 214         self.inner.env(key.as_ref(), val.as_ref());
 215         self
 216     }
 217
 218     /// Removes an environment variable mapping.
 219     #[stable(feature = "process", since = "1.0.0")]
 220     pub fn env_remove<K: AsRef<OsStr>>(&mut self, key: K) -> &mut Command {
 221         self.inner.env_remove(key.as_ref());
 222         self
 223     }
 224
 225     /// Clears the entire environment map for the child process.
 226     #[stable(feature = "process", since = "1.0.0")]
 227     pub fn env_clear(&mut self) -> &mut Command {
 228         self.inner.env_clear();
 229         self
 230     }
 231
 232     /// Sets the working directory for the child process.
 233     #[stable(feature = "process", since = "1.0.0")]
 234     pub fn current_dir<P: AsRef<path::Path>>(&mut self, dir: P) -> &mut Command {
 235         self.inner.cwd(dir.as_ref().as_ref());
 236         self
 237     }
 238
 239     /// Configuration for the child process's stdin handle (file descriptor 0).
 240     #[stable(feature = "process", since = "1.0.0")]
 241     pub fn stdin(&mut self, cfg: Stdio) -> &mut Command {
 242         self.stdin = Some(cfg);
 243         self
 244     }
 245
 246     /// Configuration for the child process's stdout handle (file descriptor 1).
 247     #[stable(feature = "process", since = "1.0.0")]
 248     pub fn stdout(&mut self, cfg: Stdio) -> &mut Command {
 249         self.stdout = Some(cfg);
 250         self
 251     }
 252
 253     /// Configuration for the child process's stderr handle (file descriptor 2).
 254     #[stable(feature = "process", since = "1.0.0")]
 255     pub fn stderr(&mut self, cfg: Stdio) -> &mut Command {
 256         self.stderr = Some(cfg);
 257         self
 258     }
 259
 260     fn spawn_inner(&self, default_io: StdioImp) -> io::Result<Child> {
 261         let default_io = Stdio(default_io);
 262
 263         // See comment on `setup_io` for what `_drop_later` is.
 264         let (their_stdin, our_stdin, _drop_later) = try!(
 265             setup_io(self.stdin.as_ref().unwrap_or(&default_io), true)
 266         );
 267         let (their_stdout, our_stdout, _drop_later) = try!(
 268             setup_io(self.stdout.as_ref().unwrap_or(&default_io), false)
 269         );
 270         let (their_stderr, our_stderr, _drop_later) = try!(
 271             setup_io(self.stderr.as_ref().unwrap_or(&default_io), false)
 272         );
 273
 274         match imp::Process::spawn(&self.inner, their_stdin, their_stdout,
 275                                   their_stderr) {
 276             Err(e) => Err(e),
 277             Ok(handle) => Ok(Child {
 278                 handle: handle,
 279                 status: None,
 280                 stdin: our_stdin.map(|fd| ChildStdin { inner: fd }),
 281                 stdout: our_stdout.map(|fd| ChildStdout { inner: fd }),
 282                 stderr: our_stderr.map(|fd| ChildStderr { inner: fd }),
 283             })
 284         }
 285     }
 286
 287     /// Executes the command as a child process, returning a handle to it.
 288     ///
 289     /// By default, stdin, stdout and stderr are inherited from the parent.
 290     #[stable(feature = "process", since = "1.0.0")]
 291     pub fn spawn(&mut self) -> io::Result<Child> {
 292         self.spawn_inner(StdioImp::Inherit)
 293     }
 294
 295     /// Executes the command as a child process, waiting for it to finish and
 296     /// collecting all of its output.
 297     ///
 298     /// By default, stdin, stdout and stderr are captured (and used to
 299     /// provide the resulting output).
 300     ///
 301     /// # Examples
 302     ///
 303     /// ```
 304     /// use std::process::Command;
 305     /// let output = Command::new("cat").arg("foo.txt").output().unwrap_or_else(|e| {
 306     ///     panic!("failed to execute process: {}", e)
 307     /// });
 308     ///
 309     /// println!("status: {}", output.status);
 310     /// println!("stdout: {}", String::from_utf8_lossy(&output.stdout));
 311     /// println!("stderr: {}", String::from_utf8_lossy(&output.stderr));
 312     /// ```
 313     #[stable(feature = "process", since = "1.0.0")]
 314     pub fn output(&mut self) -> io::Result<Output> {
 315         self.spawn_inner(StdioImp::MakePipe).and_then(|p| p.wait_with_output())
 316     }
 317
 318     /// Executes a command as a child process, waiting for it to finish and
 319     /// collecting its exit status.
 320     ///
 321     /// By default, stdin, stdout and stderr are inherited from the parent.
 322     ///
 323     /// # Examples
 324     ///
 325     /// ```
 326     /// use std::process::Command;
 327     ///
 328     /// let status = Command::new("ls").status().unwrap_or_else(|e| {
 329     ///     panic!("failed to execute process: {}", e)
 330     /// });
 331     ///
 332     /// println!("process exited with: {}", status);
 333     /// ```
 334     #[stable(feature = "process", since = "1.0.0")]
 335     pub fn status(&mut self) -> io::Result<ExitStatus> {
 336         self.spawn().and_then(|mut p| p.wait())
 337     }
 338 }
 339
 340 #[stable(feature = "rust1", since = "1.0.0")]
 341 impl fmt::Debug for Command {
 342     /// Format the program and arguments of a Command for display. Any
 343     /// non-utf8 data is lossily converted using the utf8 replacement
 344     /// character.
 345     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 346         try!(write!(f, "{:?}", self.inner.program));
 347         for arg in &self.inner.args {
 348             try!(write!(f, " {:?}", arg));
 349         }
 350         Ok(())
 351     }
 352 }
 353
 354 impl AsInner<imp::Command> for Command {
 355     fn as_inner(&self) -> &imp::Command { &self.inner }
 356 }
 357
 358 impl AsInnerMut<imp::Command> for Command {
 359     fn as_inner_mut(&mut self) -> &mut imp::Command { &mut self.inner }
 360 }
 361
 362 // Takes a `Stdio` configuration (this module) and whether the to-be-owned
 363 // handle will be readable.
 364 //
 365 // Returns a triple of (stdio to spawn with, stdio to store, stdio to drop). The
 366 // stdio to spawn with is passed down to the `sys` module and indicates how the
 367 // stdio stream should be set up. The "stdio to store" is an object which
 368 // should be returned in the `Child` that makes its way out. The "stdio to drop"
 369 // represents the raw value of "stdio to spawn with", but is the owned variant
 370 // for it. This needs to be dropped after the child spawns
 371 fn setup_io(io: &Stdio, readable: bool)
 372             -> io::Result<(imp::Stdio, Option<AnonPipe>, Option<AnonPipe>)>
 373 {
 374     Ok(match io.0 {
 375         StdioImp::MakePipe => {
 376             let (reader, writer) = try!(pipe::anon_pipe());
 377             if readable {
 378                 (imp::Stdio::Raw(reader.raw()), Some(writer), Some(reader))
 379             } else {
 380                 (imp::Stdio::Raw(writer.raw()), Some(reader), Some(writer))
 381             }
 382         }
 383         StdioImp::Raw(ref owned) => (imp::Stdio::Raw(owned.raw()), None, None),
 384         StdioImp::Inherit => (imp::Stdio::Inherit, None, None),
 385         StdioImp::None => (imp::Stdio::None, None, None),
 386     })
 387 }
 388
 389 /// The output of a finished process.
 390 #[derive(PartialEq, Eq, Clone)]
 391 #[stable(feature = "process", since = "1.0.0")]
 392 pub struct Output {
 393     /// The status (exit code) of the process.
 394     #[stable(feature = "process", since = "1.0.0")]
 395     pub status: ExitStatus,
 396     /// The data that the process wrote to stdout.
 397     #[stable(feature = "process", since = "1.0.0")]
 398     pub stdout: Vec<u8>,
 399     /// The data that the process wrote to stderr.
 400     #[stable(feature = "process", since = "1.0.0")]
 401     pub stderr: Vec<u8>,
 402 }
 403
 404 // If either stderr or stdout are valid utf8 strings it prints the valid
 405 // strings, otherwise it prints the byte sequence instead
 406 #[stable(feature = "process_output_debug", since = "1.7.0")]
 407 impl fmt::Debug for Output {
 408     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
 409
 410         let stdout_utf8 = str::from_utf8(&self.stdout);
 411         let stdout_debug: &fmt::Debug = match stdout_utf8 {
 412             Ok(ref str) => str,
 413             Err(_) => &self.stdout
 414         };
 415
 416         let stderr_utf8 = str::from_utf8(&self.stderr);
 417         let stderr_debug: &fmt::Debug = match stderr_utf8 {
 418             Ok(ref str) => str,
 419             Err(_) => &self.stderr
 420         };
 421
 422         fmt.debug_struct("Output")
 423             .field("status", &self.status)
 424             .field("stdout", stdout_debug)
 425             .field("stderr", stderr_debug)
 426             .finish()
 427     }
 428 }
 429
 430 /// Describes what to do with a standard I/O stream for a child process.
 431 #[stable(feature = "process", since = "1.0.0")]
 432 pub struct Stdio(StdioImp);
 433
 434 // The internal enum for stdio setup; see below for descriptions.
 435 enum StdioImp {
 436     MakePipe,
 437     Raw(imp::RawStdio),
 438     Inherit,
 439     None,
 440 }
 441
 442 impl Stdio {
 443     /// A new pipe should be arranged to connect the parent and child processes.
 444     #[stable(feature = "process", since = "1.0.0")]
 445     pub fn piped() -> Stdio { Stdio(StdioImp::MakePipe) }
 446
 447     /// The child inherits from the corresponding parent descriptor.
 448     #[stable(feature = "process", since = "1.0.0")]
 449     pub fn inherit() -> Stdio { Stdio(StdioImp::Inherit) }
 450
 451     /// This stream will be ignored. This is the equivalent of attaching the
 452     /// stream to `/dev/null`
 453     #[stable(feature = "process", since = "1.0.0")]
 454     pub fn null() -> Stdio { Stdio(StdioImp::None) }
 455 }
 456
 457 impl FromInner<imp::RawStdio> for Stdio {
 458     fn from_inner(inner: imp::RawStdio) -> Stdio {
 459         Stdio(StdioImp::Raw(inner))
 460     }
 461 }
 462
 463 /// Describes the result of a process after it has terminated.
 464 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 465 #[stable(feature = "process", since = "1.0.0")]
 466 pub struct ExitStatus(imp::ExitStatus);
 467
 468 impl ExitStatus {
 469     /// Was termination successful? Signal termination not considered a success,
 470     /// and success is defined as a zero exit status.
 471     #[stable(feature = "process", since = "1.0.0")]
 472     pub fn success(&self) -> bool {
 473         self.0.success()
 474     }
 475
 476     /// Returns the exit code of the process, if any.
 477     ///
 478     /// On Unix, this will return `None` if the process was terminated
 479     /// by a signal; `std::os::unix` provides an extension trait for
 480     /// extracting the signal and other details from the `ExitStatus`.
 481     #[stable(feature = "process", since = "1.0.0")]
 482     pub fn code(&self) -> Option<i32> {
 483         self.0.code()
 484     }
 485 }
 486
 487 impl AsInner<imp::ExitStatus> for ExitStatus {
 488     fn as_inner(&self) -> &imp::ExitStatus { &self.0 }
 489 }
 490
 491 #[stable(feature = "process", since = "1.0.0")]
 492 impl fmt::Display for ExitStatus {
 493     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 494         self.0.fmt(f)
 495     }
 496 }
 497
 498 impl Child {
 499     /// Forces the child to exit. This is equivalent to sending a
 500     /// SIGKILL on unix platforms.
 501     #[stable(feature = "process", since = "1.0.0")]
 502     pub fn kill(&mut self) -> io::Result<()> {
 503         #[cfg(unix)] fn collect_status(p: &mut Child) {
 504             // On Linux (and possibly other unices), a process that has exited will
 505             // continue to accept signals because it is "defunct". The delivery of
 506             // signals will only fail once the child has been reaped. For this
 507             // reason, if the process hasn't exited yet, then we attempt to collect
 508             // their status with WNOHANG.
 509             if p.status.is_none() {
 510                 match p.handle.try_wait() {
 511                     Some(status) => { p.status = Some(status); }
 512                     None => {}
 513                 }
 514             }
 515         }
 516         #[cfg(windows)] fn collect_status(_p: &mut Child) {}
 517
 518         collect_status(self);
 519
 520         // if the process has finished, and therefore had waitpid called,
 521         // and we kill it, then on unix we might ending up killing a
 522         // newer process that happens to have the same (re-used) id
 523         if self.status.is_some() {
 524             return Err(Error::new(
 525                 ErrorKind::InvalidInput,
 526                 "invalid argument: can't kill an exited process",
 527             ))
 528         }
 529
 530         unsafe { self.handle.kill() }
 531     }
 532
 533     /// Returns the OS-assigned process identifier associated with this child.
 534     #[stable(feature = "process_id", since = "1.3.0")]
 535     pub fn id(&self) -> u32 {
 536         self.handle.id()
 537     }
 538
 539     /// Waits for the child to exit completely, returning the status that it
 540     /// exited with. This function will continue to have the same return value
 541     /// after it has been called at least once.
 542     ///
 543     /// The stdin handle to the child process, if any, will be closed
 544     /// before waiting. This helps avoid deadlock: it ensures that the
 545     /// child does not block waiting for input from the parent, while
 546     /// the parent waits for the child to exit.
 547     #[stable(feature = "process", since = "1.0.0")]
 548     pub fn wait(&mut self) -> io::Result<ExitStatus> {
 549         drop(self.stdin.take());
 550         match self.status {
 551             Some(code) => Ok(ExitStatus(code)),
 552             None => {
 553                 let status = try!(self.handle.wait());
 554                 self.status = Some(status);
 555                 Ok(ExitStatus(status))
 556             }
 557         }
 558     }
 559
 560     /// Simultaneously waits for the child to exit and collect all remaining
 561     /// output on the stdout/stderr handles, returning an `Output`
 562     /// instance.
 563     ///
 564     /// The stdin handle to the child process, if any, will be closed
 565     /// before waiting. This helps avoid deadlock: it ensures that the
 566     /// child does not block waiting for input from the parent, while
 567     /// the parent waits for the child to exit.
 568     #[stable(feature = "process", since = "1.0.0")]
 569     pub fn wait_with_output(mut self) -> io::Result<Output> {
 570         drop(self.stdin.take());
 571         fn read<R>(mut input: R) -> JoinHandle<io::Result<Vec<u8>>>
 572             where R: Read + Send + 'static
 573         {
 574             thread::spawn(move || {
 575                 let mut ret = Vec::new();
 576                 input.read_to_end(&mut ret).map(|_| ret)
 577             })
 578         }
 579         let stdout = self.stdout.take().map(read);
 580         let stderr = self.stderr.take().map(read);
 581         let status = try!(self.wait());
 582         let stdout = stdout.and_then(|t| t.join().unwrap().ok());
 583         let stderr = stderr.and_then(|t| t.join().unwrap().ok());
 584
 585         Ok(Output {
 586             status: status,
 587             stdout: stdout.unwrap_or(Vec::new()),
 588             stderr: stderr.unwrap_or(Vec::new()),
 589         })
 590     }
 591 }
 592
 593 /// Terminates the current process with the specified exit code.
 594 ///
 595 /// This function will never return and will immediately terminate the current
 596 /// process. The exit code is passed through to the underlying OS and will be
 597 /// available for consumption by another process.
 598 ///
 599 /// Note that because this function never returns, and that it terminates the
 600 /// process, no destructors on the current stack or any other thread's stack
 601 /// will be run. If a clean shutdown is needed it is recommended to only call
 602 /// this function at a known point where there are no more destructors left
 603 /// to run.
 604 #[stable(feature = "rust1", since = "1.0.0")]
 605 pub fn exit(code: i32) -> ! {
 606     ::sys_common::cleanup();
 607     ::sys::os::exit(code)
 608 }
 609
 610 #[cfg(test)]
 611 mod tests {
 612     use prelude::v1::*;
 613     use io::prelude::*;
 614
 615     use io::ErrorKind;
 616     use str;
 617     use super::{Command, Output, Stdio};
 618
 619     // FIXME(#10380) these tests should not all be ignored on android.
 620
 621     #[cfg(not(target_os="android"))]
 622     #[test]
 623     fn smoke() {
 624         let p = Command::new("true").spawn();
 625         assert!(p.is_ok());
 626         let mut p = p.unwrap();
 627         assert!(p.wait().unwrap().success());
 628     }
 629
 630     #[cfg(not(target_os="android"))]
 631     #[test]
 632     fn smoke_failure() {
 633         match Command::new("if-this-is-a-binary-then-the-world-has-ended").spawn() {
 634             Ok(..) => panic!(),
 635             Err(..) => {}
 636         }
 637     }
 638
 639     #[cfg(not(target_os="android"))]
 640     #[test]
 641     fn exit_reported_right() {
 642         let p = Command::new("false").spawn();
 643         assert!(p.is_ok());
 644         let mut p = p.unwrap();
 645         assert!(p.wait().unwrap().code() == Some(1));
 646         drop(p.wait());
 647     }
 648
 649     #[cfg(all(unix, not(target_os="android")))]
 650     #[test]
 651     fn signal_reported_right() {
 652         use os::unix::process::ExitStatusExt;
 653
 654         let mut p = Command::new("/bin/sh")
 655                             .arg("-c").arg("read a")
 656                             .stdin(Stdio::piped())
 657                             .spawn().unwrap();
 658         p.kill().unwrap();
 659         match p.wait().unwrap().signal() {
 660             Some(9) => {},
 661             result => panic!("not terminated by signal 9 (instead, {:?})",
 662                              result),
 663         }
 664     }
 665
 666     pub fn run_output(mut cmd: Command) -> String {
 667         let p = cmd.spawn();
 668         assert!(p.is_ok());
 669         let mut p = p.unwrap();
 670         assert!(p.stdout.is_some());
 671         let mut ret = String::new();
 672         p.stdout.as_mut().unwrap().read_to_string(&mut ret).unwrap();
 673         assert!(p.wait().unwrap().success());
 674         return ret;
 675     }
 676
 677     #[cfg(not(target_os="android"))]
 678     #[test]
 679     fn stdout_works() {
 680         let mut cmd = Command::new("echo");
 681         cmd.arg("foobar").stdout(Stdio::piped());
 682         assert_eq!(run_output(cmd), "foobar\n");
 683     }
 684
 685     #[cfg(all(unix, not(target_os="android")))]
 686     #[test]
 687     fn set_current_dir_works() {
 688         let mut cmd = Command::new("/bin/sh");
 689         cmd.arg("-c").arg("pwd")
 690            .current_dir("/")
 691            .stdout(Stdio::piped());
 692         assert_eq!(run_output(cmd), "/\n");
 693     }
 694
 695     #[cfg(all(unix, not(target_os="android")))]
 696     #[test]
 697     fn stdin_works() {
 698         let mut p = Command::new("/bin/sh")
 699                             .arg("-c").arg("read line; echo $line")
 700                             .stdin(Stdio::piped())
 701                             .stdout(Stdio::piped())
 702                             .spawn().unwrap();
 703         p.stdin.as_mut().unwrap().write("foobar".as_bytes()).unwrap();
 704         drop(p.stdin.take());
 705         let mut out = String::new();
 706         p.stdout.as_mut().unwrap().read_to_string(&mut out).unwrap();
 707         assert!(p.wait().unwrap().success());
 708         assert_eq!(out, "foobar\n");
 709     }
 710
 711
 712     #[cfg(all(unix, not(target_os="android")))]
 713     #[test]
 714     fn uid_works() {
 715         use os::unix::prelude::*;
 716         use libc;
 717         let mut p = Command::new("/bin/sh")
 718                             .arg("-c").arg("true")
 719                             .uid(unsafe { libc::getuid() })
 720                             .gid(unsafe { libc::getgid() })
 721                             .spawn().unwrap();
 722         assert!(p.wait().unwrap().success());
 723     }
 724
 725     #[cfg(all(unix, not(target_os="android")))]
 726     #[test]
 727     fn uid_to_root_fails() {
 728         use os::unix::prelude::*;
 729         use libc;
 730
 731         // if we're already root, this isn't a valid test. Most of the bots run
 732         // as non-root though (android is an exception).
 733         if unsafe { libc::getuid() == 0 } { return }
 734         assert!(Command::new("/bin/ls").uid(0).gid(0).spawn().is_err());
 735     }
 736
 737     #[cfg(not(target_os="android"))]
 738     #[test]
 739     fn test_process_status() {
 740         let mut status = Command::new("false").status().unwrap();
 741         assert!(status.code() == Some(1));
 742
 743         status = Command::new("true").status().unwrap();
 744         assert!(status.success());
 745     }
 746
 747     #[test]
 748     fn test_process_output_fail_to_start() {
 749         match Command::new("/no-binary-by-this-name-should-exist").output() {
 750             Err(e) => assert_eq!(e.kind(), ErrorKind::NotFound),
 751             Ok(..) => panic!()
 752         }
 753     }
 754
 755     #[cfg(not(target_os="android"))]
 756     #[test]
 757     fn test_process_output_output() {
 758         let Output {status, stdout, stderr}
 759              = Command::new("echo").arg("hello").output().unwrap();
 760         let output_str = str::from_utf8(&stdout).unwrap();
 761
 762         assert!(status.success());
 763         assert_eq!(output_str.trim().to_string(), "hello");
 764         assert_eq!(stderr, Vec::new());
 765     }
 766
 767     #[cfg(not(target_os="android"))]
 768     #[test]
 769     fn test_process_output_error() {
 770         let Output {status, stdout, stderr}
 771              = Command::new("mkdir").arg(".").output().unwrap();
 772
 773         assert!(status.code() == Some(1));
 774         assert_eq!(stdout, Vec::new());
 775         assert!(!stderr.is_empty());
 776     }
 777
 778     #[cfg(not(target_os="android"))]
 779     #[test]
 780     fn test_finish_once() {
 781         let mut prog = Command::new("false").spawn().unwrap();
 782         assert!(prog.wait().unwrap().code() == Some(1));
 783     }
 784
 785     #[cfg(not(target_os="android"))]
 786     #[test]
 787     fn test_finish_twice() {
 788         let mut prog = Command::new("false").spawn().unwrap();
 789         assert!(prog.wait().unwrap().code() == Some(1));
 790         assert!(prog.wait().unwrap().code() == Some(1));
 791     }
 792
 793     #[cfg(not(target_os="android"))]
 794     #[test]
 795     fn test_wait_with_output_once() {
 796         let prog = Command::new("echo").arg("hello").stdout(Stdio::piped())
 797             .spawn().unwrap();
 798         let Output {status, stdout, stderr} = prog.wait_with_output().unwrap();
 799         let output_str = str::from_utf8(&stdout).unwrap();
 800
 801         assert!(status.success());
 802         assert_eq!(output_str.trim().to_string(), "hello");
 803         assert_eq!(stderr, Vec::new());
 804     }
 805
 806     #[cfg(all(unix, not(target_os="android")))]
 807     pub fn env_cmd() -> Command {
 808         Command::new("env")
 809     }
 810     #[cfg(target_os="android")]
 811     pub fn env_cmd() -> Command {
 812         let mut cmd = Command::new("/system/bin/sh");
 813         cmd.arg("-c").arg("set");
 814         cmd
 815     }
 816
 817     #[cfg(windows)]
 818     pub fn env_cmd() -> Command {
 819         let mut cmd = Command::new("cmd");
 820         cmd.arg("/c").arg("set");
 821         cmd
 822     }
 823
 824     #[cfg(not(target_os="android"))]
 825     #[test]
 826     fn test_inherit_env() {
 827         use env;
 828
 829         let result = env_cmd().output().unwrap();
 830         let output = String::from_utf8(result.stdout).unwrap();
 831
 832         for (ref k, ref v) in env::vars() {
 833             // Windows has hidden environment variables whose names start with
 834             // equals signs (`=`). Those do not show up in the output of the
 835             // `set` command.
 836             assert!((cfg!(windows) && k.starts_with("=")) ||
 837                     k.starts_with("DYLD") ||
 838                     output.contains(&format!("{}={}", *k, *v)),
 839                     "output doesn't contain `{}={}`\n{}",
 840                     k, v, output);
 841         }
 842     }
 843     #[cfg(target_os="android")]
 844     #[test]
 845     fn test_inherit_env() {
 846         use env;
 847
 848         let mut result = env_cmd().output().unwrap();
 849         let output = String::from_utf8(result.stdout).unwrap();
 850
 851         for (ref k, ref v) in env::vars() {
 852             // don't check android RANDOM variables
 853             if *k != "RANDOM".to_string() {
 854                 assert!(output.contains(&format!("{}={}",
 855                                                  *k,
 856                                                  *v)) ||
 857                         output.contains(&format!("{}=\'{}\'",
 858                                                  *k,
 859                                                  *v)));
 860             }
 861         }
 862     }
 863
 864     #[test]
 865     fn test_override_env() {
 866         use env;
 867
 868         // In some build environments (such as chrooted Nix builds), `env` can
 869         // only be found in the explicitly-provided PATH env variable, not in
 870         // default places such as /bin or /usr/bin. So we need to pass through
 871         // PATH to our sub-process.
 872         let mut cmd = env_cmd();
 873         cmd.env_clear().env("RUN_TEST_NEW_ENV", "123");
 874         if let Some(p) = env::var_os("PATH") {
 875             cmd.env("PATH", &p);
 876         }
 877         let result = cmd.output().unwrap();
 878         let output = String::from_utf8_lossy(&result.stdout).to_string();
 879
 880         assert!(output.contains("RUN_TEST_NEW_ENV=123"),
 881                 "didn't find RUN_TEST_NEW_ENV inside of:\n\n{}", output);
 882     }
 883
 884     #[test]
 885     fn test_add_to_env() {
 886         let result = env_cmd().env("RUN_TEST_NEW_ENV", "123").output().unwrap();
 887         let output = String::from_utf8_lossy(&result.stdout).to_string();
 888
 889         assert!(output.contains("RUN_TEST_NEW_ENV=123"),
 890                 "didn't find RUN_TEST_NEW_ENV inside of:\n\n{}", output);
 891     }
 892 }