assert_cmd/src/cmd.rs at master · iCodeIN/assert_cmd · GitHub

History

565 lines (533 loc) · 15.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

//! [`std::process::Command`][Command] customized for testing.

//!

//! [Command]: https://doc.rust-lang.org/std/process/struct.Command.html

use std::ffi;

use std::io;

use std::io::{Read, Write};

use std::path;

use std::process;

use crate::assert::Assert;

use crate::assert::OutputAssertExt;

use crate::output::DebugBuffer;

use crate::output::DebugBytes;

use crate::output::OutputError;

use crate::output::OutputOkExt;

use crate::output::OutputResult;

/// [`std::process::Command`][Command] customized for testing.

///

/// [Command]: https://doc.rust-lang.org/std/process/struct.Command.html

#[derive(Debug)]

pub struct Command {

cmd: process::Command,

stdin: Option<Vec<u8>>,

timeout: Option<std::time::Duration>,

}

impl Command {

/// Constructs a new `Command` from a `std` `Command`.

pub fn from_std(cmd: process::Command) -> Self {

Self {

cmd,

stdin: None,

timeout: None,

}

/// Create a `Command` to run a specific binary of the current crate.

///

/// See the [`cargo` module documentation][`cargo`] for caveats and workarounds.

///

/// # Examples

///

/// ```rust,no_run

/// use assert_cmd::Command;

///

/// let mut cmd = Command::cargo_bin(env!("CARGO_PKG_NAME"))

/// .unwrap();

/// let output = cmd.unwrap();

/// println!("{:?}", output);

/// ```

///

/// ```rust,no_run

/// use assert_cmd::Command;

///

/// let mut cmd = Command::cargo_bin("bin_fixture")

/// .unwrap();

/// let output = cmd.unwrap();

/// println!("{:?}", output);

/// ```

///

/// [`cargo`]: index.html

pub fn cargo_bin<S: AsRef<str>>(name: S) -> Result<Self, crate::cargo::CargoError> {

let cmd = crate::cargo::cargo_bin_cmd(name)?;

Ok(Self::from_std(cmd))

}

/// Write `buffer` to `stdin` when the `Command` is run.

///

/// # Examples

///

/// ```rust

/// use assert_cmd::Command;

///

/// let mut cmd = Command::new("cat")

/// .arg("-et")

/// .write_stdin("42")

/// .assert()

/// .stdout("42");

/// ```

pub fn write_stdin<S>(&mut self, buffer: S) -> &mut Self

where

S: Into<Vec<u8>>,

{

self.stdin = Some(buffer.into());

self

}

/// Error out if a timeout is reached

///

/// ```rust,no_run

/// use assert_cmd::Command;

///

/// let assert = Command::cargo_bin("bin_fixture")

/// .unwrap()

/// .timeout(std::time::Duration::from_secs(1))

/// .env("sleep", "100")

/// .assert();

/// assert.failure();

/// ```

pub fn timeout(&mut self, timeout: std::time::Duration) -> &mut Self {

self.timeout = Some(timeout);

self

}

/// Write `path`s content to `stdin` when the `Command` is run.

///

/// Paths are relative to the [`env::current_dir`][env_current_dir] and not

/// [`Command::current_dir`][Command_current_dir].

///

/// [env_current_dir]: https://doc.rust-lang.org/std/env/fn.current_dir.html

/// [Command_current_dir]: https://doc.rust-lang.org/std/process/struct.Command.html#method.current_dir

pub fn pipe_stdin<P>(&mut self, file: P) -> io::Result<&mut Self>

where

P: AsRef<path::Path>,

{

let buffer = std::fs::read(file)?;

Ok(self.write_stdin(buffer))

}

/// Run a `Command`, returning an [`OutputResult`][OutputResult].

///

/// # Examples

///

/// ```rust

/// use assert_cmd::Command;

///

/// let result = Command::new("echo")

/// .args(&["42"])

/// .ok();

/// assert!(result.is_ok());

/// ```

///

/// [OutputResult]: type.OutputResult.html

pub fn ok(&mut self) -> OutputResult {

OutputOkExt::ok(self)

}

/// Run a `Command`, unwrapping the [`OutputResult`][OutputResult].

///

/// # Examples

///

/// ```rust

/// use assert_cmd::Command;

///

/// let output = Command::new("echo")

/// .args(&["42"])

/// .unwrap();

/// ```

///

/// [OutputResult]: type.OutputResult.html

pub fn unwrap(&mut self) -> process::Output {

OutputOkExt::unwrap(self)

}

/// Run a `Command`, unwrapping the error in the [`OutputResult`][OutputResult].

///

/// # Examples

///

/// ```rust,no_run

/// use assert_cmd::Command;

///

/// let err = Command::new("a-command")

/// .args(&["--will-fail"])

/// .unwrap_err();

/// ```

///

/// [Output]: https://doc.rust-lang.org/std/process/struct.Output.html

pub fn unwrap_err(&mut self) -> OutputError {

OutputOkExt::unwrap_err(self)

}

/// Run a `Command` and make assertions on the [`Output`].

///

/// # Examples

///

/// ```rust,no_run

/// use assert_cmd::Command;

///

/// let mut cmd = Command::cargo_bin("bin_fixture")

/// .unwrap()

/// .assert()

/// .success();

/// ```

///

/// [`Output`]: https://doc.rust-lang.org/std/process/struct.Output.html

pub fn assert(&mut self) -> Assert {

OutputAssertExt::assert(self)

}

/// Mirror [`std::process::Command`][Command]'s API

///

/// [Command]: https://doc.rust-lang.org/std/process/struct.Command.html

impl Command {

/// Constructs a new `Command` for launching the program at

/// path `program`, with the following default configuration:

///

/// * No arguments to the program

/// * Inherit the current process's environment

/// * Inherit the current process's working directory

/// * Inherit stdin/stdout/stderr for `spawn` or `status`, but create pipes for `output`

///

/// Builder methods are provided to change these defaults and

/// otherwise configure the process.

///

/// If `program` is not an absolute path, the `PATH` will be searched in

/// an OS-defined way.

///

/// The search path to be used may be controlled by setting the

/// `PATH` environment variable on the Command,

/// but this has some implementation limitations on Windows

/// (see issue #37519).

///

/// # Examples

///

/// Basic usage:

///

/// ```no_run

/// use assert_cmd::Command;

///

/// Command::new("sh").unwrap();

/// ```

pub fn new<S: AsRef<ffi::OsStr>>(program: S) -> Self {

let cmd = process::Command::new(program);

Self::from_std(cmd)

}

/// Adds an argument to pass to the program.

///

/// Only one argument can be passed per use. So instead of:

///

/// ```no_run

/// # assert_cmd::Command::new("sh")

/// .arg("-C /path/to/repo")

/// # ;

/// ```

///

/// usage would be:

///

/// ```no_run

/// # assert_cmd::Command::new("sh")

/// .arg("-C")

/// .arg("/path/to/repo")

/// # ;

/// ```

///

/// To pass multiple arguments see [`args`].

///

/// [`args`]: #method.args

///

/// # Examples

///

/// Basic usage:

///

/// ```no_run

/// use assert_cmd::Command;

///

/// Command::new("ls")

/// .arg("-l")

/// .arg("-a")

/// .unwrap();

/// ```

pub fn arg<S: AsRef<ffi::OsStr>>(&mut self, arg: S) -> &mut Self {

self.cmd.arg(arg);

self

}

/// Adds multiple arguments to pass to the program.

///

/// To pass a single argument see [`arg`].

///

/// [`arg`]: #method.arg

///

/// # Examples

///

/// Basic usage:

///

/// ```no_run

/// use assert_cmd::Command;

///

/// Command::new("ls")

/// .args(&["-l", "-a"])

/// .unwrap();

/// ```

pub fn args<I, S>(&mut self, args: I) -> &mut Self

where

I: IntoIterator<Item = S>,

S: AsRef<ffi::OsStr>,

{

self.cmd.args(args);

self

}

/// Inserts or updates an environment variable mapping.

///

/// Note that environment variable names are case-insensitive (but case-preserving) on Windows,

/// and case-sensitive on all other platforms.

///

/// # Examples

///

/// Basic usage:

///

/// ```no_run

/// use assert_cmd::Command;

///

/// Command::new("ls")

/// .env("PATH", "/bin")

/// .unwrap_err();

/// ```

pub fn env<K, V>(&mut self, key: K, val: V) -> &mut Self

where

K: AsRef<ffi::OsStr>,

V: AsRef<ffi::OsStr>,

{

self.cmd.env(key, val);

self

}

/// Adds or updates multiple environment variable mappings.

///

/// # Examples

///

/// Basic usage:

///

/// ```no_run

/// use assert_cmd::Command;

/// use std::process::Stdio;

/// use std::env;

/// use std::collections::HashMap;

///

/// let filtered_env : HashMap<String, String> =

/// env::vars().filter(|&(ref k, _)|

/// k == "TERM" || k == "TZ" || k == "LANG" || k == "PATH"

/// ).collect();

///

/// Command::new("printenv")

/// .env_clear()

/// .envs(&filtered_env)

/// .unwrap();

/// ```

pub fn envs<I, K, V>(&mut self, vars: I) -> &mut Self

where

I: IntoIterator<Item = (K, V)>,

K: AsRef<ffi::OsStr>,

V: AsRef<ffi::OsStr>,

{

self.cmd.envs(vars);

self

}

/// Removes an environment variable mapping.

///

/// # Examples

///

/// Basic usage:

///

/// ```no_run

/// use assert_cmd::Command;

///

/// Command::new("ls")

/// .env_remove("PATH")

/// .unwrap_err();

/// ```

pub fn env_remove<K: AsRef<ffi::OsStr>>(&mut self, key: K) -> &mut Self {

self.cmd.env_remove(key);

self

}

/// Clears the entire environment map for the child process.

///

/// # Examples

///

/// Basic usage:

///

/// use std::process::Command;;

///

/// Command::new("ls")

/// .env_clear()

/// .unwrap_err();

/// ```

pub fn env_clear(&mut self) -> &mut Self {

self.cmd.env_clear();

self

}

/// Sets the working directory for the child process.

///

/// # Platform-specific behavior

///

/// If the program path is relative (e.g., `"./script.sh"`), it's ambiguous

/// whether it should be interpreted relative to the parent's working

/// directory or relative to `current_dir`. The behavior in this case is

/// platform specific and unstable, and it's recommended to use

/// [`canonicalize`] to get an absolute program path instead.

///

/// # Examples

///

/// Basic usage:

///

/// ```no_run

/// use assert_cmd::Command;

///

/// Command::new("ls")

/// .current_dir("/bin")

/// .unwrap();

/// ```

///

/// [`canonicalize`]: ../fs/fn.canonicalize.html

pub fn current_dir<P: AsRef<path::Path>>(&mut self, dir: P) -> &mut Self {

self.cmd.current_dir(dir);

self

}

/// Executes the `Command` as a child process, waiting for it to finish and collecting all of its

/// output.

///

/// By default, stdout and stderr are captured (and used to provide the resulting output).

/// Stdin is not inherited from the parent and any attempt by the child process to read from

/// the stdin stream will result in the stream immediately closing.

///

/// # Examples

///

/// ```should_panic

/// use assert_cmd::Command;

/// use std::io::{self, Write};

/// let output = Command::new("/bin/cat")

/// .arg("file.txt")

/// .output()

/// .expect("failed to execute process");

///

/// println!("status: {}", output.status);

/// io::stdout().write_all(&output.stdout).unwrap();

/// io::stderr().write_all(&output.stderr).unwrap();

///

/// assert!(output.status.success());

/// ```

pub fn output(&mut self) -> io::Result<process::Output> {

let spawn = self.spawn()?;

Self::wait_with_input_output(spawn, self.stdin.clone(), self.timeout)

}

/// If `input`, write it to `child`'s stdin while also reading `child`'s

/// stdout and stderr, then wait on `child` and return its status and output.

///

/// This was lifted from `std::process::Child::wait_with_output` and modified

/// to also write to stdin.

fn wait_with_input_output(

mut child: process::Child,

input: Option<Vec<u8>>,

timeout: Option<std::time::Duration>,

) -> io::Result<process::Output> {

let stdin = input.and_then(|i| {

child

.stdin

.take()

.map(|mut stdin| std::thread::spawn(move || stdin.write_all(&i)))

});

fn read<R>(mut input: R) -> std::thread::JoinHandle<io::Result<Vec<u8>>>

where

R: Read + Send + 'static,

{

std::thread::spawn(move || {

let mut ret = Vec::new();

input.read_to_end(&mut ret).map(|_| ret)

})

}

let stdout = child.stdout.take().map(read);

let stderr = child.stderr.take().map(read);

// Finish writing stdin before waiting, because waiting drops stdin.

stdin.and_then(|t| t.join().unwrap().ok());

let status = if let Some(timeout) = timeout {

wait_timeout::ChildExt::wait_timeout(&mut child, timeout)

.transpose()

.unwrap_or_else(|| {

let _ = child.kill();

child.wait()

})

} else {

child.wait()

}?;

let stdout = stdout

.and_then(|t| t.join().unwrap().ok())

.unwrap_or_default();

let stderr = stderr

.and_then(|t| t.join().unwrap().ok())

.unwrap_or_default();

Ok(process::Output {

status,

stdout,

stderr,

})

}

fn spawn(&mut self) -> io::Result<process::Child> {

// stdout/stderr should only be piped for `output` according to `process::Command::new`.

self.cmd.stdin(process::Stdio::piped());

self.cmd.stdout(process::Stdio::piped());

self.cmd.stderr(process::Stdio::piped());

self.cmd.spawn()

}

impl From<process::Command> for Command {

fn from(cmd: process::Command) -> Self {

Command::from_std(cmd)

}

impl<'c> OutputOkExt for &'c mut Command {

fn ok(self) -> OutputResult {

let output = self.output().map_err(OutputError::with_cause)?;

if output.status.success() {

Ok(output)

} else {

let error = OutputError::new(output).set_cmd(format!("{:?}", self.cmd));

let error = if let Some(stdin) = self.stdin.as_ref() {

error.set_stdin(stdin.clone())

} else {

error

};

Err(error)

}

fn unwrap_err(self) -> OutputError {

match self.ok() {

Ok(output) => {

if let Some(stdin) = self.stdin.as_ref() {

panic!(

"Completed successfully:\ncommand=`{:?}`\nstdin=```{}```\nstdout=```{}```",

self.cmd,

DebugBytes::new(&stdin),

DebugBytes::new(&output.stdout)

)

} else {

panic!(

"Completed successfully:\ncommand=`{:?}`\nstdout=```{}```",

self.cmd,

DebugBytes::new(&output.stdout)

)

}

Err(err) => err,

}

impl<'c> OutputAssertExt for &'c mut Command {

fn assert(self) -> Assert {

let output = self.output().unwrap();

let assert = Assert::new(output).append_context("command", format!("{:?}", self.cmd));

if let Some(stdin) = self.stdin.as_ref() {

assert.append_context("stdin", DebugBuffer::new(stdin.clone()))

} else {

assert

}

assert_cmd/src/cmd.rs at master · iCodeIN/assert_cmd · GitHub

Expand file tree

Breadcrumbs

cmd.rs

Latest commit

History

Breadcrumbs

cmd.rs

File metadata and controls