Skip to content

Commit

Permalink
Rewrite and rename issue-26092 to rmake
Browse files Browse the repository at this point in the history
  • Loading branch information
Oneirical committed Jun 17, 2024
1 parent 5f44f95 commit d2e8671
Show file tree
Hide file tree
Showing 10 changed files with 77 additions and 63 deletions.
35 changes: 24 additions & 11 deletions src/tools/run-make-support/src/command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use std::path::Path;
use std::process::{Command as StdCommand, ExitStatus, Output, Stdio};

use crate::drop_bomb::DropBomb;
use crate::{assert_contains, assert_not_contains, handle_failed_output};
use crate::{assert_contains, assert_equals, assert_not_contains, handle_failed_output};

/// This is a custom command wrapper that simplifies working with commands and makes it easier to
/// ensure that we check the exit status of executed processes.
Expand All @@ -21,6 +21,7 @@ use crate::{assert_contains, assert_not_contains, handle_failed_output};
///
/// [`run`]: Self::run
/// [`run_fail`]: Self::run_fail
/// [`run_unchecked`]: Self::run_unchecked
#[derive(Debug)]
pub struct Command {
cmd: StdCommand,
Expand Down Expand Up @@ -116,6 +117,14 @@ impl Command {
output
}

/// Run the command but do not check its exit status.
/// Only use if you explicitly don't care about the exit status.
/// Prefer to use [`run`] and [`run_fail`] whenever possible.
#[track_caller]
pub fn run_unchecked(&mut self) -> CompletedProcess {
self.command_output()
}

#[track_caller]
fn command_output(&mut self) -> CompletedProcess {
self.drop_bomb.defuse();
Expand Down Expand Up @@ -163,38 +172,42 @@ impl CompletedProcess {
self.output.status
}

/// Checks that trimmed `stdout` matches trimmed `content`.
/// Checks that trimmed `stdout` matches trimmed `expected`.
#[track_caller]
pub fn assert_stdout_equals<S: AsRef<str>>(&self, content: S) -> &Self {
assert_eq!(self.stdout_utf8().trim(), content.as_ref().trim());
pub fn assert_stdout_equals<S: AsRef<str>>(&self, expected: S) -> &Self {
assert_equals(self.stdout_utf8().trim(), expected.as_ref().trim());
self
}

/// Checks that `stdout` does not contain `content`.
#[track_caller]
pub fn assert_stdout_contains<S: AsRef<str>>(self, needle: S) -> Self {
assert_contains(&self.stdout_utf8(), needle.as_ref());
pub fn assert_stdout_not_contains<S: AsRef<str>>(&self, needle: S) -> &Self {
assert_not_contains(&self.stdout_utf8(), needle.as_ref());
self
}

/// Checks that `stdout` contains `content`.
#[track_caller]
pub fn assert_stdout_not_contains<S: AsRef<str>>(&self, needle: S) -> &Self {
assert_not_contains(&self.stdout_utf8(), needle.as_ref());
pub fn assert_stdout_contains<S: AsRef<str>>(&self, needle: S) -> &Self {
assert_contains(&self.stdout_utf8(), needle.as_ref());
self
}

/// Checks that trimmed `stderr` matches trimmed `content`.
/// Checks that trimmed `stderr` matches trimmed `expected`.
#[track_caller]
pub fn assert_stderr_equals<S: AsRef<str>>(&self, content: S) -> &Self {
assert_eq!(self.stderr_utf8().trim(), content.as_ref().trim());
pub fn assert_stderr_equals<S: AsRef<str>>(&self, expected: S) -> &Self {
assert_equals(self.stderr_utf8().trim(), expected.as_ref().trim());
self
}

/// Checks that `stderr` contains `content`.
#[track_caller]
pub fn assert_stderr_contains<S: AsRef<str>>(&self, needle: S) -> &Self {
assert_contains(&self.stderr_utf8(), needle.as_ref());
self
}

/// Checks that `stderr` does not contain `content`.
#[track_caller]
pub fn assert_stderr_not_contains<S: AsRef<str>>(&self, needle: S) -> &Self {
assert_not_contains(&self.stdout_utf8(), needle.as_ref());
Expand Down
20 changes: 20 additions & 0 deletions src/tools/run-make-support/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,18 @@ pub fn read_dir<F: Fn(&Path)>(dir: impl AsRef<Path>, callback: F) {
}
}

/// Check that `actual` is equal to `expected`. Panic otherwise.
#[track_caller]
pub fn assert_equals(actual: &str, expected: &str) {
if actual != expected {
eprintln!("=== ACTUAL TEXT ===");
eprintln!("{}", actual);
eprintln!("=== EXPECTED ===");
eprintln!("{}", expected);
panic!("expected text was not found in actual text");
}
}

/// Check that `haystack` contains `needle`. Panic otherwise.
#[track_caller]
pub fn assert_contains(haystack: &str, needle: &str) {
Expand Down Expand Up @@ -468,6 +480,14 @@ macro_rules! impl_common_helpers {
self.cmd.run_fail()
}

/// Run the command but do not check its exit status.
/// Only use if you explicitly don't care about the exit status.
/// Prefer to use [`run`] and [`run_fail`] whenever possible.
#[track_caller]
pub fn run_unchecked(&mut self) -> crate::command::CompletedProcess {
self.cmd.run_unchecked()
}

/// Set the path where the command will be run.
pub fn current_dir<P: AsRef<::std::path::Path>>(&mut self, path: P) -> &mut Self {
self.cmd.current_dir(path);
Expand Down
1 change: 0 additions & 1 deletion src/tools/tidy/src/allowed_run_make_makefiles.txt
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ run-make/issue-20626/Makefile
run-make/issue-22131/Makefile
run-make/issue-25581/Makefile
run-make/issue-26006/Makefile
run-make/issue-26092/Makefile
run-make/issue-28595/Makefile
run-make/issue-33329/Makefile
run-make/issue-35164/Makefile
Expand Down
1 change: 0 additions & 1 deletion tests/run-make/CURRENT_RUSTC_VERSION/rmake.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ fn main() {

let output =
rustc().input("main.rs").emit("metadata").extern_("stable", "libstable.rmeta").run();

let version = fs_wrapper::read_to_string(source_root().join("src/version"));
let expected_string = format!("stable since {}", version.trim());
output.assert_stderr_contains(expected_string);
Expand Down
File renamed without changes.
13 changes: 13 additions & 0 deletions tests/run-make/clear-error-blank-output/rmake.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// When an empty output file is passed to rustc, the ensuing error message
// should be clear. However, calling file_stem on an empty path returns None,
// which, when unwrapped, causes a panic, stopping execution of rustc
// and printing an obscure message instead of reaching the helpful
// error message. This test checks that the panic does not occur.
// See https://github.com/rust-lang/rust/pull/26199

use run_make_support::rustc;

fn main() {
let output = rustc().output("").stdin(b"fn main() {}").run_fail();
output.assert_stderr_not_contains("panic");
}
6 changes: 0 additions & 6 deletions tests/run-make/issue-26092/Makefile

This file was deleted.

24 changes: 10 additions & 14 deletions tests/run-make/link-arg/rmake.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,14 @@
use run_make_support::rustc;

fn main() {
let output = String::from_utf8(
rustc()
.input("empty.rs")
.link_arg("-lfoo")
.link_arg("-lbar")
.print("link-args")
.command_output()
.stdout,
)
.unwrap();
assert!(
output.contains("lfoo") || output.contains("lbar"),
"The output did not contain the expected \"lfoo\" or \"lbar\" strings."
);
// We are only checking for the output of --print=link-args,
// rustc failing or succeeding does not matter.
let out = rustc()
.input("empty.rs")
.link_arg("-lfoo")
.link_arg("-lbar")
.print("link-args")
.run_unchecked();
out.assert_stdout_contains("lfoo");
out.assert_stdout_contains("lbar");
}
12 changes: 0 additions & 12 deletions tests/run-make/link-dedup/Makefile

This file was deleted.

28 changes: 10 additions & 18 deletions tests/run-make/link-dedup/rmake.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,18 @@

//@ ignore-msvc

use run_make_support::rustc;

fn main() {
rustc().input("depa.rs").run();
rustc().input("depb.rs").run();
rustc().input("depc.rs").run();
let output =
String::from_utf8(rustc().input("empty.rs").cfg("bar").command_output().stderr).unwrap();
let pos_a1 =
output.find("-ltesta").expect("empty.rs, compiled with --cfg, should contain -ltesta");
let pos_b = output[pos_a1..]
.find("-ltestb")
.map(|pos| pos + pos_a1)
.expect("empty.rs, compiled with --cfg, should contain -ltestb");
let _ = output[pos_b..]
.find("-ltesta")
.map(|pos| pos + pos_b)
.expect("empty.rs, compiled with --cfg, should contain a second -ltesta");
let output = String::from_utf8(rustc().input("empty.rs").command_output().stderr).unwrap();
assert!(output.contains("-ltesta"));
let output = String::from_utf8(rustc().input("empty.rs").command_output().stderr).unwrap();
assert!(!output.contains("-ltestb"));
let output = String::from_utf8(rustc().input("empty.rs").command_output().stderr).unwrap();
assert_eq!(output.matches("-ltesta").count, 1);
let output = rustc().input("empty.rs").cfg("bar").run_fail();
output.assert_stderr_contains(r#""-ltesta" "-ltestb" "-ltesta""#);
let output = rustc().input("empty.rs").run_fail();
output.assert_stderr_contains(r#""-ltesta""#);
let output = rustc().input("empty.rs").run_fail();
output.assert_stderr_not_contains(r#""-ltestb""#);
let output = rustc().input("empty.rs").run_fail();
output.assert_stderr_not_contains(r#""-ltesta" "-ltesta" "-ltesta""#);
}

0 comments on commit d2e8671

Please sign in to comment.