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.

Author: bors

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_lib.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_plan.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.rs

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