chore: Moved tools and some cross compiling logic into testsuite

Author: ranger-ross

crates/cargo-test-support/src/cross_compile.rs

@@ -9,189 +9,7 @@
 //!
 //! These tests are all disabled on rust-lang/rust's CI, but run in Cargo's CI.
 
-use crate::{basic_manifest, main_file, project};
-use cargo_util::ProcessError;
 use std::env;
-use std::fmt::Write;
-use std::process::{Command, Output};
-use std::sync::atomic::{AtomicBool, Ordering};
-use std::sync::Once;
-
-/// Whether or not the resulting cross binaries can run on the host.
-static CAN_RUN_ON_HOST: AtomicBool = AtomicBool::new(false);
-
-pub fn disabled() -> bool {
-    // First, disable if requested.
-    match env::var("CFG_DISABLE_CROSS_TESTS") {
-        Ok(ref s) if *s == "1" => return true,
-        _ => {}
-    }
-
-    // It requires setting `target.linker` for cross-compilation to work on aarch64,
-    // so not going to bother now.
-    if cfg!(all(target_arch = "aarch64", target_os = "linux")) {
-        return true;
-    }
-
-    // Cross tests are only tested to work on macos, linux, and MSVC windows.
-    if !(cfg!(target_os = "macos") || cfg!(target_os = "linux") || cfg!(target_env = "msvc")) {
-        return true;
-    }
-
-    // It's not particularly common to have a cross-compilation setup, so
-    // try to detect that before we fail a bunch of tests through no fault
-    // of the user.
-    static CAN_BUILD_CROSS_TESTS: AtomicBool = AtomicBool::new(false);
-    static CHECK: Once = Once::new();
-
-    let cross_target = alternate();
-
-    let run_cross_test = || -> anyhow::Result<Output> {
-        let p = project()
-            .at("cross_test")
-            .file("Cargo.toml", &basic_manifest("cross_test", "1.0.0"))
-            .file("src/main.rs", &main_file(r#""testing!""#, &[]))
-            .build();
-
-        let build_result = p
-            .cargo("build --target")
-            .arg(&cross_target)
-            .exec_with_output();
-
-        if build_result.is_ok() {
-            CAN_BUILD_CROSS_TESTS.store(true, Ordering::SeqCst);
-        }
-
-        let result = p
-            .cargo("run --target")
-            .arg(&cross_target)
-            .exec_with_output();
-
-        if result.is_ok() {
-            CAN_RUN_ON_HOST.store(true, Ordering::SeqCst);
-        }
-        build_result
-    };
-
-    CHECK.call_once(|| {
-        drop(run_cross_test());
-    });
-
-    if CAN_BUILD_CROSS_TESTS.load(Ordering::SeqCst) {
-        // We were able to compile a simple project, so the user has the
-        // necessary `std::` bits installed. Therefore, tests should not
-        // be disabled.
-        return false;
-    }
-
-    // We can't compile a simple cross project. We want to warn the user
-    // by failing a single test and having the remainder of the cross tests
-    // pass. We don't use `std::sync::Once` here because panicking inside its
-    // `call_once` method would poison the `Once` instance, which is not what
-    // we want.
-    static HAVE_WARNED: AtomicBool = AtomicBool::new(false);
-
-    if HAVE_WARNED.swap(true, Ordering::SeqCst) {
-        // We are some other test and somebody else is handling the warning.
-        // Just disable the current test.
-        return true;
-    }
-
-    // We are responsible for warning the user, which we do by panicking.
-    let mut message = format!(
-        "
-Cannot cross compile to {}.
-
-This failure can be safely ignored. If you would prefer to not see this
-failure, you can set the environment variable CFG_DISABLE_CROSS_TESTS to \"1\".
-
-Alternatively, you can install the necessary libraries to enable cross
-compilation tests. Cross compilation tests depend on your host platform.
-",
-        cross_target
-    );
-
-    if cfg!(target_os = "linux") {
-        message.push_str(
-            "
-Linux cross tests target i686-unknown-linux-gnu, which requires the ability to
-build and run 32-bit targets. This requires the 32-bit libraries to be
-installed. For example, on Ubuntu, run `sudo apt install gcc-multilib` to
-install the necessary libraries.
-",
-        );
-    } else if cfg!(all(target_os = "macos", target_arch = "aarch64")) {
-        message.push_str(
-            "
-macOS on aarch64 cross tests to target x86_64-apple-darwin.
-This should be natively supported via Xcode, nothing additional besides the
-rustup target should be needed.
-",
-        );
-    } else if cfg!(target_os = "macos") {
-        message.push_str(
-            "
-macOS on x86_64 cross tests to target x86_64-apple-ios, which requires the iOS
-SDK to be installed. This should be included with Xcode automatically. If you
-are using the Xcode command line tools, you'll need to install the full Xcode
-app (from the Apple App Store), and switch to it with this command:
-
-    sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
-
-Some cross-tests want to *run* the executables on the host. These tests will
-be ignored if this is not possible. On macOS, this means you need an iOS
-simulator installed to run these tests. To install a simulator, open Xcode, go
-to preferences > Components, and download the latest iOS simulator.
-",
-        );
-    } else if cfg!(target_os = "windows") {
-        message.push_str(
-            "
-Windows cross tests target i686-pc-windows-msvc, which requires the ability
-to build and run 32-bit targets. This should work automatically if you have
-properly installed Visual Studio build tools.
-",
-        );
-    } else {
-        // The check at the top should prevent this.
-        panic!("platform should have been skipped");
-    }
-
-    let rustup_available = Command::new("rustup").output().is_ok();
-    if rustup_available {
-        write!(
-            message,
-            "
-Make sure that the appropriate `rustc` target is installed with rustup:
-
-    rustup target add {}
-",
-            cross_target
-        )
-        .unwrap();
-    } else {
-        write!(
-            message,
-            "
-rustup does not appear to be installed. Make sure that the appropriate
-`rustc` target is installed for the target `{}`.
-",
-            cross_target
-        )
-        .unwrap();
-    }
-
-    // Show the actual error message.
-    match run_cross_test() {
-        Ok(_) => message.push_str("\nUh oh, second run succeeded?\n"),
-        Err(err) => match err.downcast_ref::<ProcessError>() {
-            Some(proc_err) => write!(message, "\nTest error: {}\n", proc_err).unwrap(),
-            None => write!(message, "\nUnexpected non-process error: {}\n", err).unwrap(),
-        },
-    }
-
-    panic!("{}", message);
-}
 
 /// The arch triple of the test-running host.
 pub fn native() -> &'static str {
@@ -252,31 +70,9 @@ pub fn unused() -> &'static str {
     "wasm32-unknown-unknown"
 }
 
-/// Whether or not the host can run cross-compiled executables.
-pub fn can_run_on_host() -> bool {
-    if disabled() {
-        return false;
-    }
-    // macos is currently configured to cross compile to x86_64-apple-ios
-    // which requires a simulator to run. Azure's CI image appears to have the
-    // SDK installed, but are not configured to launch iOS images with a
-    // simulator.
-    if cfg!(target_os = "macos") {
-        if CAN_RUN_ON_HOST.load(Ordering::SeqCst) {
-            return true;
-        } else {
-            println!("Note: Cannot run on host, skipping.");
-            return false;
-        }
-    } else {
-        assert!(CAN_RUN_ON_HOST.load(Ordering::SeqCst));
-        return true;
-    }
-}
-
 /// Check if the given target has been installed.
 ///
-/// Generally [`disabled`] should be used to check if cross-compilation is allowed.
+/// Generally `testsuite::utils::cross_compile::disabled` should be used to check if cross-compilation is allowed.
 /// And [`alternate`] to get the cross target.
 ///
 /// You should only use this as a last resort to skip tests,

crates/cargo-test-support/src/lib.rs

@@ -110,7 +110,6 @@ pub mod install;
 pub mod paths;
 pub mod publish;
 pub mod registry;
-pub mod tools;
 
 pub mod prelude {
     pub use crate::cargo_test;
@@ -643,8 +642,8 @@ pub struct RawOutput {
 ///
 /// Construct with
 /// - [`execs`]
-/// - [`cargo_process`]
 /// - [`Project`] methods
+/// - `cargo_process` in testsuite
 #[must_use]
 #[derive(Clone)]
 pub struct Execs {

tests/testsuite/artifact_dep.rs

@@ -1,6 +1,9 @@
 //! Tests specific to artifact dependencies, designated using
 //! the new `dep = { artifact = "bin", … }` syntax in manifests.
 
+use crate::utils::cross_compile::{
+    can_run_on_host as cross_compile_can_run_on_host, disabled as cross_compile_disabled,
+};
 use cargo_test_support::compare::assert_e2e;
 use cargo_test_support::prelude::*;
 use cargo_test_support::registry::{Package, RegistryBuilder};
@@ -340,7 +343,7 @@ fn features_are_unified_among_lib_and_bin_dep_of_same_target() {
 
 #[cargo_test]
 fn features_are_not_unified_among_lib_and_bin_dep_of_different_target() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
     let target = cross_compile::alternate();
@@ -455,7 +458,7 @@ For more information about this error, try `rustc --explain E0425`.
 
 #[cargo_test]
 fn feature_resolution_works_for_cfg_target_specification() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
     let target = cross_compile::alternate();
@@ -1079,7 +1082,7 @@ fn allow_artifact_and_non_artifact_dependency_to_same_crate() {
 
 #[cargo_test]
 fn build_script_deps_adopt_specified_target_unconditionally() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
 
@@ -1137,7 +1140,7 @@ fn build_script_deps_adopt_specified_target_unconditionally() {
 /// inverse RFC-3176
 #[cargo_test]
 fn build_script_deps_adopt_do_not_allow_multiple_targets_under_different_name_and_same_version() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
 
@@ -1196,7 +1199,7 @@ fn build_script_deps_adopt_do_not_allow_multiple_targets_under_different_name_an
 
 #[cargo_test]
 fn non_build_script_deps_adopt_specified_target_unconditionally() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
 
@@ -1247,7 +1250,7 @@ fn non_build_script_deps_adopt_specified_target_unconditionally() {
 
 #[cargo_test]
 fn cross_doctests_works_with_artifacts() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
 
@@ -1302,7 +1305,7 @@ fn cross_doctests_works_with_artifacts() {
     println!("c");
     let target = cross_compile::alternate();
 
-    if !cross_compile::can_run_on_host() {
+    if !cross_compile_can_run_on_host() {
         return;
     }
 
@@ -1327,7 +1330,7 @@ fn cross_doctests_works_with_artifacts() {
 
 #[cargo_test]
 fn build_script_deps_adopts_target_platform_if_target_equals_target() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
 
@@ -1498,7 +1501,7 @@ foo v0.0.0 ([ROOT]/foo)
 
 #[cargo_test]
 fn artifact_dep_target_specified() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
     let target = cross_compile::alternate();
@@ -1554,7 +1557,7 @@ foo v0.0.0 ([ROOT]/foo)
 /// *   the target is not activated.
 #[cargo_test]
 fn dep_of_artifact_dep_same_target_specified() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
     let target = cross_compile::alternate();
@@ -1629,7 +1632,7 @@ foo v0.1.0 ([ROOT]/foo)
 
 #[cargo_test]
 fn targets_are_picked_up_from_non_workspace_artifact_deps() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
     let target = cross_compile::alternate();
@@ -1675,7 +1678,7 @@ fn targets_are_picked_up_from_non_workspace_artifact_deps() {
 
 #[cargo_test]
 fn index_version_filtering() {
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
     let target = cross_compile::alternate();
@@ -1748,7 +1751,7 @@ required by package `foo v0.1.0 ([ROOT]/foo)`
 fn proc_macro_in_artifact_dep() {
     // Forcing FeatureResolver to check a proc-macro for a dependency behind a
     // target dependency.
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
     Package::new("pm", "1.0.0")
@@ -2563,7 +2566,7 @@ fn build_script_features_for_shared_dependency() {
     //
     // When common is built as a dependency of foo, it should have features
     // `f1` (for the library and the build script).
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
     let target = cross_compile::alternate();
@@ -2728,7 +2731,7 @@ fn calc_bin_artifact_fingerprint() {
 #[cargo_test]
 fn with_target_and_optional() {
     // See rust-lang/cargo#10526
-    if cross_compile::disabled() {
+    if cross_compile_disabled() {
         return;
     }
     let target = cross_compile::alternate();