Auto merge of #10620 - weihanglo:snapbox-cargo-init, r=epage

Migrate tests of `cargo-init` to snapbox

### What does this PR try to resolve?

An attempt of migrating tests of `cargo-init` to [snapbox](https://crates.io/crates/snapbox/).

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

To review this PR, you may compare the old and the new version one by one. Files not listed in `<test-name>.out` are not asserted, so please help me make sure we don't miss any essential file to check.

Some redundant tests are covered by other tests or renamed.

### Additional information

I won't say the process of the migration was pleasant, but overall it results to a higher coverage of output file changes. Here are steps I performed to migrate a test case:

1. Run the old test and observe its output layout. Recommend using a separate worktree to preserve the temporary test output files.
2. Read the test code to arrange its input fixture at `<test-name>.in`.
3. Copy the old output layout or hand-pick the output layout you need. You don't need to fill contents of those files. `snapbox` will do it for you.
4. Run `SNAPSHOTS=overwrite cargo test --test testsuite <your-test-filter>` to assert and generate snapshots.
5. Compare the old layout and the new layout to see if anything missing.

Something observations when dealing with the migration:

* snapbox hasn't yet support unordered assertion.
* snapbox cannot assert inexistence of a file (And probably never?).
* No performance hit so far (measured with hyperfine).

tests/snapshots/init/auto_git.in

@@ -0,0 +1 @@
+empty-dir

tests/snapshots/init/auto_git.out/.gitignore

@@ -0,0 +1,2 @@
+/target
+/Cargo.lock

tests/snapshots/init/auto_git.out/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

tests/snapshots/init/auto_git.out/src/lib.rs

@@ -0,0 +1,8 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        let result = 2 + 2;
+        assert_eq!(result, 4);
+    }
+}

tests/snapshots/init/auto_git.stderr

@@ -0,0 +1 @@
+     Created library package

tests/snapshots/init/bin_already_exists_explicit.in/src/main.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_explicit.out/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

tests/snapshots/init/bin_already_exists_explicit.out/src/main.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_explicit.stderr

@@ -0,0 +1 @@
+     Created binary (application) package

tests/snapshots/init/bin_already_exists_explicit_nosrc.in/main.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_explicit_nosrc.out/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+[[bin]]
+name = "case"
+path = "main.rs"

tests/snapshots/init/bin_already_exists_explicit_nosrc.out/main.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_explicit_nosrc.stderr

@@ -0,0 +1 @@
+     Created binary (application) package

tests/snapshots/init/bin_already_exists_implicit.in/src/main.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_implicit.out/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

tests/snapshots/init/bin_already_exists_implicit.out/src/main.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_implicit.stderr

@@ -0,0 +1 @@
+     Created binary (application) package

tests/snapshots/init/bin_already_exists_implicit_namenosrc.in/case.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_implicit_namenosrc.out/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+[[bin]]
+name = "case"
+path = "case.rs"

tests/snapshots/init/bin_already_exists_implicit_namenosrc.out/case.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_implicit_namenosrc.stderr

@@ -0,0 +1 @@
+     Created binary (application) package

tests/snapshots/init/bin_already_exists_implicit_namesrc.in/src/case.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_implicit_namesrc.out/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+[[bin]]
+name = "case"
+path = "src/case.rs"

tests/snapshots/init/bin_already_exists_implicit_namesrc.out/src/case.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_implicit_namesrc.stderr

@@ -0,0 +1 @@
+     Created binary (application) package

tests/snapshots/init/bin_already_exists_implicit_nosrc.in/main.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_implicit_nosrc.out/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+[[bin]]
+name = "case"
+path = "main.rs"

tests/snapshots/init/bin_already_exists_implicit_nosrc.out/main.rs

@@ -0,0 +1,4 @@
+fn main() {
+    println!("Check that our file is not overwritten")
+}
+

tests/snapshots/init/bin_already_exists_implicit_nosrc.stderr

@@ -0,0 +1 @@
+     Created binary (application) package

tests/snapshots/init/both_lib_and_bin.stderr

@@ -0,0 +1 @@
+error: can't specify both lib and binary outputs

tests/snapshots/init/cant_create_library_when_both_binlib_present.in/case.rs

@@ -0,0 +1 @@
+fn main() {}

tests/snapshots/init/cant_create_library_when_both_binlib_present.in/lib.rs

@@ -0,0 +1 @@
+fn f() {}

tests/snapshots/init/cant_create_library_when_both_binlib_present.stderr

@@ -0,0 +1 @@
+error: cannot have a package with multiple libraries, found both `case.rs` and `lib.rs`

tests/snapshots/init/confused_by_multiple_lib_files.in/lib.rs

@@ -0,0 +1 @@
+fn f() { println!("lib.rs"); }

tests/snapshots/init/confused_by_multiple_lib_files.in/src/lib.rs

@@ -0,0 +1 @@
+fn f() { println!("src/lib.rs"); }

tests/snapshots/init/confused_by_multiple_lib_files.out/lib.rs

@@ -0,0 +1 @@
+fn f() { println!("lib.rs"); }

tests/snapshots/init/confused_by_multiple_lib_files.out/src/lib.rs

@@ -0,0 +1 @@
+fn f() { println!("src/lib.rs"); }

tests/snapshots/init/confused_by_multiple_lib_files.stderr

@@ -0,0 +1 @@
+error: cannot have a package with multiple libraries, found both `src/lib.rs` and `lib.rs`

tests/snapshots/init/creates_binary_when_both_binlib_present.in/case.rs

@@ -0,0 +1 @@
+fn main() {}

tests/snapshots/init/creates_binary_when_both_binlib_present.in/lib.rs

@@ -0,0 +1 @@
+fn f() {}

tests/snapshots/init/creates_binary_when_both_binlib_present.out/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+[[bin]]
+name = "case"
+path = "case.rs"
+
+[lib]
+name = "case"
+path = "lib.rs"

tests/snapshots/init/creates_binary_when_both_binlib_present.out/case.rs

@@ -0,0 +1 @@
+fn main() {}

tests/snapshots/init/creates_binary_when_both_binlib_present.out/lib.rs

@@ -0,0 +1 @@
+fn f() {}

tests/snapshots/init/creates_binary_when_both_binlib_present.stderr

@@ -0,0 +1 @@
+     Created binary (application) package

tests/snapshots/init/creates_binary_when_instructed_and_has_lib_file.in/case.rs

@@ -0,0 +1 @@
+fn f() {}

tests/snapshots/init/creates_binary_when_instructed_and_has_lib_file.out/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+[[bin]]
+name = "case"
+path = "case.rs"

tests/snapshots/init/creates_binary_when_instructed_and_has_lib_file.out/case.rs

@@ -0,0 +1 @@
+fn f() {}

tests/snapshots/init/creates_binary_when_instructed_and_has_lib_file.stderr

@@ -0,0 +1,2 @@
+warning: file `case.rs` seems to be a library file
+     Created binary (application) package

tests/snapshots/init/creates_library_when_instructed_and_has_bin_file.in/case.rs

@@ -0,0 +1 @@
+fn main() {}

tests/snapshots/init/creates_library_when_instructed_and_has_bin_file.out/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+
+[lib]
+name = "case"
+path = "case.rs"

tests/snapshots/init/creates_library_when_instructed_and_has_bin_file.out/case.rs

@@ -0,0 +1 @@
+fn main() {}

tests/snapshots/init/creates_library_when_instructed_and_has_bin_file.stderr

@@ -0,0 +1,2 @@
+warning: file `case.rs` seems to be a binary (application) file
+     Created library package

tests/snapshots/init/explicit_bin_with_git.in

@@ -0,0 +1 @@
+empty-dir

tests/snapshots/init/explicit_bin_with_git.out/.gitignore

@@ -0,0 +1 @@
+/target

tests/snapshots/init/explicit_bin_with_git.out/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

tests/snapshots/init/explicit_bin_with_git.out/src/main.rs

@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}

tests/snapshots/init/explicit_bin_with_git.stderr

@@ -0,0 +1 @@
+     Created binary (application) package

tests/snapshots/init/formats_source.in/rustfmt.toml

@@ -0,0 +1 @@
+tab_spaces = 2

tests/snapshots/init/formats_source.out/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

tests/snapshots/init/formats_source.out/rustfmt.toml

@@ -0,0 +1 @@
+tab_spaces = 2

tests/snapshots/init/formats_source.out/src/lib.rs

@@ -0,0 +1,8 @@
+#[cfg(test)]
+mod tests {
+  #[test]
+  fn it_works() {
+    let result = 2 + 2;
+    assert_eq!(result, 4);
+  }
+}

tests/snapshots/init/formats_source.stderr

@@ -0,0 +1 @@
+     Created library package

tests/snapshots/init/fossil_autodetect.out/.fossil-settings/clean-glob

@@ -0,0 +1,2 @@
+target
+Cargo.lock

tests/snapshots/init/fossil_autodetect.out/.fossil-settings/ignore-glob

@@ -0,0 +1,2 @@
+target
+Cargo.lock

tests/snapshots/init/fossil_autodetect.out/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

tests/snapshots/init/fossil_autodetect.out/src/lib.rs

@@ -0,0 +1,8 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        let result = 2 + 2;
+        assert_eq!(result, 4);
+    }
+}

tests/snapshots/init/fossil_autodetect.stderr

@@ -0,0 +1 @@
+     Created library package

tests/snapshots/init/git_autodetect.out/.gitignore

@@ -0,0 +1,2 @@
+/target
+/Cargo.lock

tests/snapshots/init/git_autodetect.out/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "foo"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

tests/snapshots/init/git_autodetect.out/src/lib.rs

@@ -0,0 +1,8 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        let result = 2 + 2;
+        assert_eq!(result, 4);
+    }
+}

tests/snapshots/init/git_autodetect.stderr

@@ -0,0 +1 @@
+     Created library package

tests/snapshots/init/git_ignore_exists_no_conflicting_entries.in/.gitignore

@@ -0,0 +1 @@
+**/some.file

tests/snapshots/init/git_ignore_exists_no_conflicting_entries.out/.gitignore

@@ -0,0 +1,6 @@
+**/some.file
+
+# Added by cargo
+
+/target
+/Cargo.lock

tests/snapshots/init/git_ignore_exists_no_conflicting_entries.out/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2015"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

tests/snapshots/init/git_ignore_exists_no_conflicting_entries.out/src/lib.rs

@@ -0,0 +1,8 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        let result = 2 + 2;
+        assert_eq!(result, 4);
+    }
+}

tests/snapshots/init/git_ignore_exists_no_conflicting_entries.stderr

@@ -0,0 +1 @@
+     Created library package

tests/snapshots/init/ignores_failure_to_format_source.in/rustfmt.toml

@@ -0,0 +1 @@
+tab_spaces = 2

tests/snapshots/init/ignores_failure_to_format_source.out/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "case"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]

tests/snapshots/init/ignores_failure_to_format_source.out/rustfmt.toml

@@ -0,0 +1 @@
+tab_spaces = 2

tests/snapshots/init/ignores_failure_to_format_source.out/src/lib.rs

@@ -0,0 +1,8 @@
+#[cfg(test)]
+mod tests {
+    #[test]
+    fn it_works() {
+        let result = 2 + 2;
+        assert_eq!(result, 4);
+    }
+}

tests/snapshots/init/ignores_failure_to_format_source.stderr

@@ -0,0 +1 @@
+     Created library package