Auto merge of #7628 - ehuss:testsuite-comments, r=Eh2406

Minor testsuite organization.

I sometimes get a little lost when looking for the right module for tests.  This adds a brief comment to each one explaining what it is.  This also includes a few renamed modules, and a few tests have been placed in a location that makes a little more sense to me. There shouldn't be any functional changes here.

- Move `build_lib` into `build`.  It seemed a little strange to have these tests floating in a separate file.
- Rename `build_auth` to `git_auth`.
- Rename `small_fd_limits` to `git_gc`.
- Rename `resolve` to `minimal_versions`.
- Rename `overrides` to `replace`.
- Pull out `paths` overrides tests into a separate file.

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

@@ -1,3 +1,14 @@
+//! Support for cross-compile tests with the `--target` flag.
+//!
+//! Note that cross-testing is very limited. You need to install the
+//! "alternate" target to the host (32-bit for 64-bit hosts or vice-versa).
+//!
+//! Set CFG_DISABLE_CROSS_TESTS=1 environment variable to disable these tests
+//! if you are unable to use the alternate target. Unfortunately 32-bit
+//! support on macOS is going away, so macOS users are out of luck.
+//!
+//! These tests are all disabled on rust-lang/rust's CI, but run in Cargo's CI.
+
 use crate::{basic_bin_manifest, main_file, project};
 use std::env;
 use std::process::Command;

tests/testsuite/alt_registry.rs

@@ -1,3 +1,5 @@
+//! Tests for alternative registries.
+
 use cargo::util::IntoUrl;
 use cargo_test_support::publish::validate_alt_upload;
 use cargo_test_support::registry::{self, Package};

tests/testsuite/bad_config.rs

@@ -1,3 +1,5 @@
+//! Tests for some invalid .cargo/config files.
+
 use cargo_test_support::registry::Package;
 use cargo_test_support::{basic_manifest, project};
 

tests/testsuite/bad_manifest_path.rs

@@ -1,3 +1,5 @@
+//! Tests for invalid --manifest-path arguments.
+
 use cargo_test_support::{basic_bin_manifest, main_file, project};
 
 fn assert_not_a_cargo_toml(command: &str, manifest_path_argument: &str) {

tests/testsuite/bench.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo bench` command.
+
 use cargo_test_support::is_nightly;
 use cargo_test_support::paths::CargoPathExt;
 use cargo_test_support::{basic_bin_manifest, basic_lib_manifest, basic_manifest, project};

tests/testsuite/build.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo build` command.
+
 use cargo::util::paths::dylib_path_envvar;
 use cargo_test_support::paths::{root, CargoPathExt};
 use cargo_test_support::registry::Package;
@@ -4607,3 +4609,65 @@ d
         )
         .run();
 }
+
+#[cargo_test]
+fn build_lib_only() {
+    let p = project()
+        .file("src/main.rs", "fn main() {}")
+        .file("src/lib.rs", r#" "#)
+        .build();
+
+    p.cargo("build --lib -v")
+        .with_stderr(
+            "\
+[COMPILING] foo v0.0.1 ([CWD])
+[RUNNING] `rustc --crate-name foo src/lib.rs [..]--crate-type lib \
+        --emit=[..]link -C debuginfo=2 \
+        -C metadata=[..] \
+        --out-dir [..] \
+        -L dependency=[CWD]/target/debug/deps`
+[FINISHED] dev [unoptimized + debuginfo] target(s) in [..]",
+        )
+        .run();
+}
+
+#[cargo_test]
+fn build_with_no_lib() {
+    let p = project()
+        .file("Cargo.toml", &basic_bin_manifest("foo"))
+        .file("src/main.rs", "fn main() {}")
+        .build();
+
+    p.cargo("build --lib")
+        .with_status(101)
+        .with_stderr("[ERROR] no library targets found in package `foo`")
+        .run();
+}
+
+#[cargo_test]
+fn build_with_relative_cargo_home_path() {
+    let p = project()
+        .file(
+            "Cargo.toml",
+            r#"
+            [package]
+
+            name = "foo"
+            version = "0.0.1"
+            authors = ["wycats@example.com"]
+
+            [dependencies]
+
+            "test-dependency" = { path = "src/test_dependency" }
+        "#,
+        )
+        .file("src/main.rs", "fn main() {}")
+        .file("src/test_dependency/src/lib.rs", r#" "#)
+        .file(
+            "src/test_dependency/Cargo.toml",
+            &basic_manifest("test-dependency", "0.0.1"),
+        )
+        .build();
+
+    p.cargo("build").env("CARGO_HOME", "./cargo_home/").run();
+}

tests/testsuite/build_plan.rs

@@ -1,3 +1,5 @@
+//! Tests for --build-plan feature.
+
 use cargo_test_support::registry::Package;
 use cargo_test_support::{basic_bin_manifest, basic_manifest, main_file, project};
 

tests/testsuite/build_script.rs

@@ -1,3 +1,5 @@
+//! Tests for build.rs scripts.
+
 use std::env;
 use std::fs::{self, File};
 use std::io;

tests/testsuite/build_script_env.rs

@@ -1,3 +1,5 @@
+//! Tests for build.rs rerun-if-env-changed.
+
 use std::fs::File;
 
 use cargo_test_support::project;

tests/testsuite/cache_messages.rs

@@ -1,3 +1,5 @@
+//! Tests for caching compiler diagnostics.
+
 use cargo_test_support::{
     clippy_is_available, is_coarse_mtime, process, project, registry::Package, sleep_ms,
 };

tests/testsuite/cargo_alias_config.rs

@@ -1,3 +1,5 @@
+//! Tests for `[alias]` config command aliases.
+
 use cargo_test_support::{basic_bin_manifest, project};
 
 #[cargo_test]

tests/testsuite/cargo_command.rs

@@ -1,3 +1,5 @@
+//! Tests for custom cargo commands and other global command features.
+
 use std::env;
 use std::fs::{self, File};
 use std::io::prelude::*;

tests/testsuite/cargo_features.rs

@@ -1,3 +1,5 @@
+//! Tests for `cargo-features` definitions.
+
 use cargo_test_support::{project, registry};
 
 #[cargo_test]

tests/testsuite/cfg.rs

@@ -1,3 +1,5 @@
+//! Tests for cfg() expressions.
+
 use cargo_test_support::registry::Package;
 use cargo_test_support::rustc_host;
 use cargo_test_support::{basic_manifest, project};

tests/testsuite/check.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo check` command.
+
 use std::fmt::{self, Write};
 
 use cargo_test_support::install::exe;

tests/testsuite/clean.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo clean` command.
+
 use std::env;
 
 use cargo_test_support::registry::Package;

tests/testsuite/clippy.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo clippy` command.
+
 use cargo_test_support::{clippy_is_available, project, registry::Package};
 
 #[cargo_test]

tests/testsuite/collisions.rs

@@ -1,3 +1,8 @@
+//! Tests for when multiple artifacts have the same output filename.
+//! See https://github.com/rust-lang/cargo/issues/6313 for more details.
+//! Ideally these should never happen, but I don't think we'll ever be able to
+//! prevent all collisions.
+
 use cargo_test_support::basic_manifest;
 use cargo_test_support::project;
 use std::env;

tests/testsuite/concurrent.rs

@@ -1,3 +1,5 @@
+//! Tests for running multiple `cargo` processes at the same time.
+
 use std::fs::{self, File};
 use std::io::Write;
 use std::net::TcpListener;

tests/testsuite/config.rs

@@ -1,3 +1,5 @@
+//! Tests for config settings.
+
 use std::borrow::Borrow;
 use std::collections;
 use std::fs;

tests/testsuite/corrupt_git.rs

@@ -1,3 +1,5 @@
+//! Tests for corrupt git repos.
+
 use std::fs;
 use std::path::{Path, PathBuf};
 

tests/testsuite/cross_compile.rs

@@ -1,3 +1,7 @@
+//! Tests for cross compiling with --target.
+//!
+//! See `cargo_test_support::cross_compile` for more detail.
+
 use cargo_test_support::{basic_bin_manifest, basic_manifest, cross_compile, project};
 use cargo_test_support::{is_nightly, rustc_host};
 

tests/testsuite/cross_publish.rs

@@ -1,3 +1,5 @@
+//! Tests for publishing using the `--target` flag.
+
 use std::fs::File;
 
 use cargo_test_support::{cross_compile, project, publish, registry};

tests/testsuite/custom_target.rs

@@ -1,3 +1,5 @@
+//! Tests for custom json target specifications.
+
 use cargo_test_support::is_nightly;
 use cargo_test_support::{basic_manifest, project};
 

tests/testsuite/death.rs

@@ -1,3 +1,5 @@
+//! Tests for ctrl-C handling.
+
 use std::fs;
 use std::io::{self, Read};
 use std::net::TcpListener;

tests/testsuite/dep_info.rs

@@ -1,3 +1,6 @@
+//! Tests for dep-info files. This includes the dep-info file Cargo creates in
+//! the output directory, and the ones stored in the fingerprint.
+
 use cargo_test_support::paths::{self, CargoPathExt};
 use cargo_test_support::registry::Package;
 use cargo_test_support::{

tests/testsuite/directory.rs

@@ -1,3 +1,5 @@
+//! Tests for directory sources.
+
 use std::collections::HashMap;
 use std::fs::{self, File};
 use std::io::prelude::*;

tests/testsuite/doc.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo doc` command.
+
 use std::fs::{self, File};
 use std::io::Read;
 use std::str;

tests/testsuite/edition.rs

@@ -1,3 +1,5 @@
+//! Tests for edition setting.
+
 use cargo_test_support::{basic_lib_manifest, project};
 
 #[cargo_test]

tests/testsuite/features.rs

@@ -1,3 +1,5 @@
+//! Tests for `[features]` table.
+
 use std::fs::File;
 use std::io::prelude::*;
 

tests/testsuite/fetch.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo fetch` command.
+
 use cargo_test_support::registry::Package;
 use cargo_test_support::rustc_host;
 use cargo_test_support::{basic_manifest, cross_compile, project};

tests/testsuite/fix.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo fix` command.
+
 use std::fs::File;
 
 use cargo_test_support::git;

tests/testsuite/freshness.rs

@@ -1,3 +1,5 @@
+//! Tests for fingerprinting (rebuild detection).
+
 use filetime::FileTime;
 use std::fs::{self, File, OpenOptions};
 use std::io;

tests/testsuite/generate_lockfile.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo generate-lockfile` command.
+
 use std::fs::{self, File};
 use std::io::prelude::*;
 

tests/testsuite/git.rs

@@ -1,3 +1,5 @@
+//! Tests for git support.
+
 use git2;
 use std::env;
 use std::fs::{self, File};

tests/testsuite/build_auth.rs → tests/testsuite/git_auth.rs

@@ -1,3 +1,5 @@
+//! Tests for git authentication.
+
 use std::collections::HashSet;
 use std::io::prelude::*;
 use std::io::BufReader;

tests/testsuite/small_fd_limits.rs → tests/testsuite/git_gc.rs

@@ -1,3 +1,5 @@
+//! Tests for git garbage collection.
+
 use std::env;
 use std::ffi::OsStr;
 use std::path::PathBuf;

tests/testsuite/init.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo init` command.
+
 use cargo_test_support;
 use std::env;
 use std::fs::{self, File};

tests/testsuite/install.rs

@@ -1,3 +1,5 @@
+//! Tests for the `cargo install` command.
+
 use std::fs::{self, File, OpenOptions};
 use std::io::prelude::*;
 

tests/testsuite/install_upgrade.rs

@@ -1,3 +1,5 @@
+//! Tests for `cargo install` where it upgrades a package if it is out-of-date.
+
 use cargo::core::PackageId;
 use std::collections::BTreeSet;
 use std::env;

tests/testsuite/jobserver.rs

@@ -1,3 +1,5 @@
+//! Tests for the jobserver protocol.
+
 use std::net::TcpListener;
 use std::process::Command;
 use std::thread;

tests/testsuite/list_targets.rs

@@ -1,3 +1,5 @@
+//! Tests for target filter flags giving suggestions on which targets are available.
+
 use cargo_test_support::project;
 
 const EXAMPLE: u8 = 0x1;