Auto merge of #14243 - epage:prelude, r=weihanglo

feat(test): Add cargo_test to test-support prelude

### What does this PR try to resolve?

With where we are at with #14039, I was revisiting our test writing documentation.  I was wanting to put more emphasis on rustdoc and found it would be helpful to talk about the concepts if a prelude was used instead of `extern crate`.

### How should we test and review this PR?

Yes, this included some `use` clean ups in tangentially-related commit but its already painful enough
walking through every test file, I didn't want to do it twice.

### Additional information

Cargo.toml

@@ -237,7 +237,6 @@ features = [
 
 [dev-dependencies]
 annotate-snippets = { workspace = true, features = ["testing-colors"] }
-cargo-test-macro.workspace = true
 cargo-test-support.workspace = true
 gix = { workspace = true, features = ["revision"] }
 same-file.workspace = true

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

@@ -73,6 +73,7 @@ pub mod registry;
 pub mod tools;
 
 pub mod prelude {
+    pub use crate::cargo_test;
     pub use crate::ArgLine;
     pub use crate::CargoCommand;
     pub use crate::ChannelChanger;

src/doc/contrib/src/tests/writing.md

@@ -30,6 +30,8 @@ stdout and stderr output against the expected output.
 
 Generally, a functional test will be placed in `tests/testsuite/<command>.rs` and will look roughly like:
 ```rust,ignore
+use cargo_test_support::prelude::*;
+
 #[cargo_test]
 fn <description>() {
     let p = project()

tests/build-std/main.rs

@@ -21,7 +21,7 @@
 #![allow(clippy::disallowed_methods)]
 
 use cargo_test_support::prelude::*;
-use cargo_test_support::*;
+use cargo_test_support::{basic_manifest, paths, project, rustc_host, str, Execs};
 use std::env;
 use std::path::Path;
 

tests/testsuite/advanced_env.rs

@@ -1,5 +1,6 @@
 //! -Zadvanced-env tests
 
+use cargo_test_support::prelude::*;
 use cargo_test_support::{paths, project, registry::Package};
 
 #[cargo_test]

tests/testsuite/alt_registry.rs

@@ -1,12 +1,13 @@
 //! Tests for alternative registries.
 
+use std::fs;
+
 use cargo_test_support::compare::assert_e2e;
 use cargo_test_support::prelude::*;
 use cargo_test_support::publish::validate_alt_upload;
 use cargo_test_support::registry::{self, Package, RegistryBuilder};
 use cargo_test_support::str;
 use cargo_test_support::{basic_manifest, paths, project};
-use std::fs;
 
 #[cargo_test]
 fn depend_on_alt_registry() {

tests/testsuite/artifact_dir.rs

@@ -1,12 +1,13 @@
 //! Tests for --artifact-dir flag.
 
+use std::env;
+use std::fs;
+use std::path::Path;
+
 use cargo_test_support::prelude::*;
 use cargo_test_support::sleep_ms;
 use cargo_test_support::str;
 use cargo_test_support::{basic_manifest, project};
-use std::env;
-use std::fs;
-use std::path::Path;
 
 #[cargo_test]
 fn binary_with_debug() {

tests/testsuite/build.rs

@@ -1,5 +1,10 @@
 //! Tests for the `cargo build` command.
 
+use std::env;
+use std::fs;
+use std::io::Read;
+use std::process::Stdio;
+
 use cargo::{
     core::compiler::CompileMode,
     core::{Shell, Workspace},
@@ -17,10 +22,6 @@ use cargo_test_support::{
     tools, Execs, ProjectBuilder,
 };
 use cargo_util::paths::dylib_path_envvar;
-use std::env;
-use std::fs;
-use std::io::Read;
-use std::process::Stdio;
 
 #[cargo_test]
 fn cargo_compile_simple() {

tests/testsuite/build_script.rs

@@ -1,5 +1,10 @@
 //! Tests for build.rs scripts.
 
+use std::env;
+use std::fs;
+use std::io;
+use std::thread;
+
 use cargo_test_support::compare::assert_e2e;
 use cargo_test_support::install::cargo_home;
 use cargo_test_support::paths::CargoPathExt;
@@ -12,10 +17,6 @@ use cargo_test_support::{
 };
 use cargo_test_support::{rustc_host, sleep_ms, slow_cpu_multiplier, symlink_supported};
 use cargo_util::paths::{self, remove_dir_all};
-use std::env;
-use std::fs;
-use std::io;
-use std::thread;
 
 #[cargo_test]
 fn custom_build_script_failed() {

tests/testsuite/build_script_env.rs

@@ -1,6 +1,7 @@
 //! Tests for build.rs rerun-if-env-changed and rustc-env
 
 use cargo_test_support::basic_manifest;
+use cargo_test_support::prelude::*;
 use cargo_test_support::project;
 use cargo_test_support::sleep_ms;
 use cargo_test_support::str;

tests/testsuite/build_script_extra_link_arg.rs

@@ -4,6 +4,7 @@
 // because MSVC link.exe just gives a warning on unknown flags (how helpful!),
 // and other linkers will return an error.
 
+use cargo_test_support::prelude::*;
 use cargo_test_support::registry::Package;
 use cargo_test_support::str;
 use cargo_test_support::{basic_bin_manifest, basic_lib_manifest, basic_manifest, project};

tests/testsuite/cache_lock.rs

@@ -1,10 +1,13 @@
 //! Tests for `CacheLock`.
 
-use crate::config::GlobalContextBuilder;
+use std::thread::JoinHandle;
+
 use cargo::util::cache_lock::{CacheLockMode, CacheLocker};
 use cargo_test_support::paths::{self, CargoPathExt};
+use cargo_test_support::prelude::*;
 use cargo_test_support::{retry, thread_wait_timeout, threaded_timeout};
-use std::thread::JoinHandle;
+
+use crate::config::GlobalContextBuilder;
 
 /// Helper to verify that it is OK to acquire the given lock (it shouldn't block).
 fn verify_lock_is_ok(mode: CacheLockMode) {

tests/testsuite/cache_messages.rs

@@ -1,10 +1,12 @@
 //! Tests for caching compiler diagnostics.
 
-use super::messages::raw_rustc_output;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::tools;
 use cargo_test_support::{basic_manifest, is_coarse_mtime, project, registry::Package, sleep_ms};
 
+use super::messages::raw_rustc_output;
+
 fn as_str(bytes: &[u8]) -> &str {
     std::str::from_utf8(bytes).expect("valid utf-8")
 }

tests/testsuite/cargo_alias_config.rs

@@ -2,6 +2,7 @@
 
 use std::env;
 
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::tools::echo_subcommand;
 use cargo_test_support::{basic_bin_manifest, project};

tests/testsuite/cargo_bench/no_keep_going/mod.rs

@@ -1,5 +1,6 @@
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_command.rs

@@ -9,6 +9,7 @@ use std::str;
 
 use cargo_test_support::basic_manifest;
 use cargo_test_support::paths::CargoPathExt;
+use cargo_test_support::prelude::*;
 use cargo_test_support::registry::Package;
 use cargo_test_support::str;
 use cargo_test_support::tools::echo_subcommand;

tests/testsuite/cargo_env_config.rs

@@ -1,6 +1,7 @@
 //! Tests for `[env]` config.
 
 use cargo_test_support::basic_manifest;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::{basic_bin_manifest, project};
 

tests/testsuite/cargo_features.rs

@@ -1,5 +1,6 @@
 //! Tests for `cargo-features` definitions.
 
+use cargo_test_support::prelude::*;
 use cargo_test_support::registry::Package;
 use cargo_test_support::str;
 use cargo_test_support::{project, registry};

tests/testsuite/cargo_init/inherit_workspace_package_table/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_init/reserved_name/mod.rs

@@ -1,8 +1,9 @@
+use std::fs;
+
 use cargo_test_support::file;
 use cargo_test_support::paths;
 use cargo_test_support::prelude::*;
 use cargo_test_support::str;
-use std::fs;
 
 #[cargo_test]
 fn case() {

tests/testsuite/cargo_new/add_members_to_non_workspace/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/add_members_to_workspace_format_previous_items/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/add_members_to_workspace_format_sorted/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/add_members_to_workspace_with_absolute_package_path/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/add_members_to_workspace_with_empty_members/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/add_members_to_workspace_with_exclude_list/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/add_members_to_workspace_with_members_glob/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/add_members_to_workspace_without_members/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/empty_name/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/inherit_workspace_lints/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/inherit_workspace_package_table/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/inherit_workspace_package_table_with_edition/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/inherit_workspace_package_table_with_registry/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/inherit_workspace_package_table_without_version/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_new/not_inherit_workspace_package_table_if_not_members/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_remove/avoid_empty_tables/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_remove/build/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_remove/dev/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_remove/dry_run/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_remove/gc_keep_used_patch/mod.rs

@@ -1,6 +1,7 @@
 use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
+use cargo_test_support::prelude::*;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;
 use cargo_test_support::Project;

tests/testsuite/cargo_remove/gc_patch/mod.rs

@@ -3,6 +3,7 @@ use cargo_test_support::compare::assert_ui;
 use cargo_test_support::current_dir;
 use cargo_test_support::file;
 use cargo_test_support::git;
+use cargo_test_support::prelude::*;
 use cargo_test_support::project;
 use cargo_test_support::str;
 use cargo_test_support::CargoCommand;