Add numerous more UI tests.

Author: Alexhuszagh

.github/workflows/ci.yml

@@ -74,6 +74,10 @@ jobs:
       - name: Run unit tests
         run: cargo test --locked --all-targets --workspace --all-features
         timeout-minutes: 10
+
+      - name: Run ignored unit tests
+        run: cargo test --locked --all-targets --workspace --all-features -- --ignored
+        timeout-minutes: 10
   check:
     runs-on: ubuntu-latest
     outputs:

src/tests.rs

@@ -138,7 +138,10 @@ release: {version}
 
 #[test]
 fn check_newlines() -> crate::Result<()> {
-    for file in walk_dir(get_cargo_workspace(), &[".git", "target"], |_| true) {
+    // tests contains the trycmd tests, which may have placeholders
+    for file in walk_dir(get_cargo_workspace(), &[".git", "target", "tests"], |_| {
+        true
+    }) {
         let file = file?;
         if !file.file_type().map_or(true, |f| f.is_file()) {
             continue;

tests/cli.rs

@@ -1,16 +1,27 @@
 use std::process::{Command, ExitStatus, Output};
 
 #[test]
+#[ignore]
 fn cli_tests() -> cross::Result<()> {
     let cargo_version = run_success("cargo", &["--version"])?;
     let cargo_help = run_success("cargo", &["--help"])?;
-    // TODO(ahuszagh) Should get some output here
-    // TODO(ahuszagh) Get version info from Rust
-    // TODO(ahuszagh) Get version info from cargo
-
+    // TODO(ahuszagh): We need to add the following:
+    //      Get version info from cross: this needs to use the same
+    //      code as cross itself
+    //
+    //      `cargo --quiet --verbose` prints the help menu
+    //      this is currently incorrect, it errors
+    //
+    //      Need `CARGO_TERM_VERBOSE=true cargo build --quiet` to pass
+    //
+    //      Need many additional unittests
+
+    // FIXME: `[CARGOHELP]` does not seem to work: we have the output hard-coded
+    // This is likely because of how it tries to replace the
+    // `[+toolchain] [OPTIONS] [SUBCOMMAND]` contents.
     trycmd::TestCases::new()
         .case("tests/cmd/*.toml")
-        .fail("tests/cmd/no-color.toml")
+        .case("tests/cmd/*.md")
         .insert_var("[CARGOVERSION]", cargo_version.stdout)?
         .insert_var("[CARGOHELP]", cargo_help.stdout)?;
 
@@ -33,6 +44,7 @@ fn run_with_status(bin: &str, args: &[&str], status: Option<i32>) -> cross::Resu
     Ok(output)
 }
 
+#[allow(dead_code)]
 struct Utf8Output {
     status: ExitStatus,
     stdout: String,

tests/cmd/build-no-color.stderr

@@ -0,0 +1 @@
+no-color.stderr

tests/cmd/build-no-color.stdout

@@ -0,0 +1 @@
+no-color.stdout

tests/cmd/build-no-color.toml

@@ -0,0 +1,3 @@
+bin.name = "cross"
+args = ["build", "--color"]
+status = "failed"

tests/cmd/help.stdout

@@ -1 +1,39 @@
-[CARGOHELP]
+Rust's package manager
+
+USAGE:
+    cargo [+toolchain] [OPTIONS] [SUBCOMMAND]
+
+OPTIONS:
+    -V, --version               Print version info and exit
+        --list                  List installed commands
+        --explain <CODE>        Run `rustc --explain CODE`
+    -v, --verbose               Use verbose output (-vv very verbose/build.rs output)
+    -q, --quiet                 Do not print cargo log messages
+        --color <WHEN>          Coloring: auto, always, never
+        --frozen                Require Cargo.lock and cache are up to date
+        --locked                Require Cargo.lock is up to date
+        --offline               Run without accessing the network
+        --config <KEY=VALUE>    Override a configuration value (unstable)
+    -Z <FLAG>                   Unstable (nightly-only) flags to Cargo, see 'cargo -Z help' for
+                                details
+    -h, --help                  Print help information
+
+Some common cargo commands are (see all commands with --list):
+    build, b    Compile the current package
+    check, c    Analyze the current package and report errors, but don't build object files
+    clean       Remove the target directory
+    doc, d      Build this package's and its dependencies' documentation
+    new         Create a new cargo package
+    init        Create a new cargo package in an existing directory
+    add         Add dependencies to a manifest file
+    run, r      Run a binary or example of the local package
+    test, t     Run the tests
+    bench       Run the benchmarks
+    update      Update dependencies listed in Cargo.lock
+    search      Search registry for crates
+    publish     Package and upload this package to the registry
+    install     Install a Rust binary. Default location is $HOME/.cargo/bin
+    uninstall   Uninstall a Rust binary
+
+See 'cargo help <command>' for more information on a specific command.
+

tests/cmd/list.stderr

@@ -0,0 +1 @@
+fallback.stderr

tests/cmd/list.stdout

@@ -0,0 +1,19 @@
+Cross Commands:
+    b [..] alias: build
+    bench [..] Execute all benchmarks of a local package
+    build [..] Compile a local package and all of its dependencies
+    c [..] alias: check
+    check [..] Check a local package and all of its dependencies for errors
+    clean [..] Remove artifacts that cargo has generated in the past
+    clippy [..] Checks a package to catch common mistakes and improve your Rust code.
+    doc [..] Build a package's documentation
+    metadata [..] Output the resolved dependencies of a package, the concrete used versions including overrides, in machine-readable format
+    r [..] alias: run
+    run [..] Run a binary or example of the local package
+    rustc [..] Compile a package, and pass extra options to the compiler
+    t [..] alias: test
+    test [..] Execute all unit and integration tests and build examples of a local package
+Host Commands:
+...
+    add                  Add dependencies to a Cargo.toml manifest file
+...

tests/cmd/list.toml

@@ -0,0 +1,2 @@
+bin.name = "cross"
+args = ["--list"]

tests/cmd/no-args.stderr

@@ -0,0 +1 @@
+help.stderr

tests/cmd/no-args.stdout

@@ -0,0 +1 @@
+help.stdout

tests/cmd/no-args.toml

@@ -0,0 +1 @@
+bin.name = "cross"

tests/cmd/no-color.stdout

@@ -1,2 +1,3 @@
 bin.name = "cross"
 args = ["--color"]
+status = "failed"

tests/cmd/no-color.toml

@@ -0,0 +1 @@
+quiet-verbose.stderr

tests/cmd/quiet-verbose-envvar-both.stderr

@@ -0,0 +1 @@
+quiet-verbose.stdout

tests/cmd/quiet-verbose-envvar-both.stdout

@@ -0,0 +1,7 @@
+bin.name = "cross"
+args = ["build"]
+status = "failed"
+
+[env.add]
+CARGO_TERM_VERBOSE = "true"
+CARGO_TERM_QUIET = "true"

tests/cmd/quiet-verbose-envvar-both.toml

@@ -0,0 +1 @@
+[cross] error: cannot set both --verbose and --quiet

tests/cmd/quiet-verbose.stderr

@@ -0,0 +1,3 @@
+bin.name = "cross"
+args = ["build", "--quiet", "--verbose"]
+status = "failed"

tests/cmd/quiet-verbose.stdout

@@ -1,2 +1,2 @@
-cross 0.2.4 (35a1e17 2022-11-01)
+cross [..]
 [CARGOVERSION]

tests/cmd/quiet-verbose.toml

@@ -286,7 +286,7 @@ fn cross_ui(
     )?;
 
     // check we can run custom binaries
-    cross_command("run", target, image, &workspace_dir.join("binary"), None)?
+    cross_command("run", target, image, workspace_dir.join("binary"), None)?
         .utf8_output(msg_info)?
         .runs("Hello from binary, binary/src/main.rs")?;
     check_file_exists(&workspace_dir, &format!("target/{target}/debug/binary"))?;
@@ -357,7 +357,7 @@ fn target_dir() -> PathBuf {
 fn cargo_bin(bin: impl AsRef<str>, cwd: impl AsRef<Path>) -> cross::Result<Command> {
     let bin = bin.as_ref();
     let env_var = format!("CARGO_BIN_EXE_{}", bin);
-    let path = env::var_os(&env_var)
+    let path = env::var_os(env_var)
         .map(|p| p.into())
         .unwrap_or_else(|| target_dir().join(format!("{}{}", bin, env::consts::EXE_SUFFIX)));