Merge pull request #3209 from hi-rustin/rustin-patch-rust-init-sh-ui

Add ui test for the rustup-init.sh
rust-lang · Feb 19, 2023 · 26fea62 · 26fea62
2 parents 7659519 + 00c930f
commit 26fea62
Show file tree

Hide file tree

Showing 48 changed files with 93 additions and 20 deletions.
diff --git a/rustup-init.sh b/rustup-init.sh
@@ -22,28 +22,30 @@ set -u
 # If RUSTUP_UPDATE_ROOT is unset or empty, default it.
 RUSTUP_UPDATE_ROOT="${RUSTUP_UPDATE_ROOT:-https://static.rust-lang.org/rustup}"
 
-#XXX: If you change anything here, please make the same changes in setup_mode.rs
+# NOTICE: If you change anything here, please make the same changes in setup_mode.rs
 usage() {
-    cat 1>&2 <<EOF
+    cat <<EOF
 rustup-init 1.25.2 (8c4dad73d 2023-02-01)
 The installer for rustup
 
 USAGE:
     rustup-init [FLAGS] [OPTIONS]
 
 FLAGS:
-    -v, --verbose           Enable verbose output
-    -q, --quiet             Disable progress output
-    -y                      Disable confirmation prompt.
-        --no-modify-path    Don't configure the PATH environment variable
-    -h, --help              Prints help information
-    -V, --version           Prints version information
+    -v, --verbose                        Enable verbose output
+    -q, --quiet                          Disable progress output
+    -y                                   Disable confirmation prompt.
+        --no-update-default-toolchain    Don't update any existing default toolchain after install
+        --no-modify-path                 Don't configure the PATH environment variable
+    -h, --help                           Prints help information
+    -V, --version                        Prints version information
 
 OPTIONS:
         --default-host <default-host>              Choose a default host triple
-        --default-toolchain <default-toolchain>    Choose a default toolchain to install
-        --default-toolchain none                   Do not install any toolchains
-        --profile [minimal|default|complete]       Choose a profile
+        --default-toolchain <default-toolchain>
+            Choose a default toolchain to install. Use 'none' to not install any toolchains at all
+
+        --profile <profile>                         [default: default]  [possible values: minimal, default, complete]
     -c, --component <components>...                Component name to also install
     -t, --target <targets>...                      Target name to also install
 EOF

diff --git a/src/cli/setup_mode.rs b/src/cli/setup_mode.rs
@@ -22,7 +22,7 @@ pub fn main() -> Result<utils::ExitCode> {
         return Ok(utils::ExitCode(0));
     }
 
-    // XXX: If you change anything here, please make the same changes in rustup-init.sh
+    // NOTICE: If you change anything here, please make the same changes in rustup-init.sh.
     let cli = App::new("rustup-init")
         .version(common::version())
         .about("The installer for rustup")
@@ -55,7 +55,7 @@ pub fn main() -> Result<utils::ExitCode> {
             Arg::with_name("default-toolchain")
                 .long("default-toolchain")
                 .takes_value(true)
-                .help("Choose a default toolchain to install"),
+                .help("Choose a default toolchain to install. Use 'none' to not install any toolchains at all"),
         )
         .arg(
             Arg::with_name("profile")

diff --git a/tests/cli-ui.rs b/tests/cli-ui.rs
@@ -1,18 +1,58 @@
-use std::fs;
+use std::{fs, path::PathBuf};
 
 #[test]
-fn ui_doc_text_tests() {
+fn rustup_ui_doc_text_tests() {
     let t = trycmd::TestCases::new();
     let rustup_init = trycmd::cargo::cargo_bin("rustup-init");
     let rustup = trycmd::cargo::cargo_bin("rustup");
-    t.register_bin("rustup-init", &rustup_init);
     // Copy rustup-init to rustup so that the tests can run it.
     fs::copy(&rustup_init, &rustup).unwrap();
     t.register_bin("rustup", &rustup);
-    t.case("tests/cli-ui/*.toml");
+    t.case("tests/cli-ui/rustup/*.toml");
     #[cfg(target_os = "windows")]
     {
-        // On windows, we don't have man command, so skip the tests.
-        t.skip("tests/cli-ui/rustup_man_cmd_help_flag_stdout.toml");
+        // On windows, we don't have man command, so skip the test.
+        t.skip("tests/cli-ui/rustup/rustup_man_cmd_help_flag_stdout.toml");
+    }
+}
+
+#[test]
+fn rustup_init_ui_doc_text_tests() {
+    let t = trycmd::TestCases::new();
+    let rustup_init = trycmd::cargo::cargo_bin("rustup-init");
+    let project_root = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
+    t.register_bin("rustup-init", &rustup_init);
+    t.register_bin("rustup-init.sh", &project_root.join("rustup-init.sh"));
+    t.case("tests/cli-ui/rustup-init/*.toml");
+    #[cfg(target_os = "windows")]
+    {
+        // On non-windows, we don't use rustup-init.sh, so skip the test.
+        t.skip("tests/cli-ui/rustup-init/rustup-init_sh_help_flag_stdout.toml");
+    }
+
+    // On non-windows, we don't use rustup-init.sh, so skip the test.
+    #[cfg(not(target_os = "windows"))]
+    {
+        let rustup_init_help_toml =
+            project_root.join("tests/cli-ui/rustup-init/rustup-init_help_flag_stdout.toml");
+        let rustup_init_sh_help_toml =
+            project_root.join("tests/cli-ui/rustup-init/rustup-init_sh_help_flag_stdout.toml");
+
+        #[derive(Debug, PartialEq, Eq, serde::Deserialize, serde::Serialize)]
+        struct Stdout {
+            #[serde(default)]
+            pub(crate) stdout: Option<String>,
+        }
+        let rustup_init_help_std_out: Stdout =
+            toml::from_str(fs::read_to_string(rustup_init_help_toml).unwrap().as_str()).unwrap();
+        let rustup_init_sh_help_std_out: Stdout = toml::from_str(
+            fs::read_to_string(rustup_init_sh_help_toml)
+                .unwrap()
+                .as_str(),
+        )
+        .unwrap();
+
+        // Make sure that the help output of rustup-init and rustup-init.sh are the same.
+        assert!(rustup_init_help_std_out == rustup_init_sh_help_std_out)
     }
 }
diff --git a/.../cli-ui/rustup-init_help_flag_stdout.toml → ...up-init/rustup-init_help_flag_stdout.toml b/.../cli-ui/rustup-init_help_flag_stdout.toml → ...up-init/rustup-init_help_flag_stdout.toml
@@ -19,7 +19,9 @@ FLAGS:
 
 OPTIONS:
         --default-host <default-host>              Choose a default host triple
-        --default-toolchain <default-toolchain>    Choose a default toolchain to install
+        --default-toolchain <default-toolchain>
+            Choose a default toolchain to install. Use 'none' to not install any toolchains at all
+
         --profile <profile>                         [default: default]  [possible values: minimal, default, complete]
     -c, --component <components>...                Component name to also install
     -t, --target <targets>...                      Target name to also install

diff --git a/tests/cli-ui/rustup-init/rustup-init_sh_help_flag_stdout.toml b/tests/cli-ui/rustup-init/rustup-init_sh_help_flag_stdout.toml
@@ -0,0 +1,29 @@
+bin.name = "rustup-init.sh"
+args = ["--help"]
+status.code = 0
+stdout = """
+rustup-init [..]
+The installer for rustup
+
+USAGE:
+    rustup-init[EXE] [FLAGS] [OPTIONS]
+
+FLAGS:
+    -v, --verbose                        Enable verbose output
+    -q, --quiet                          Disable progress output
+    -y                                   Disable confirmation prompt.
+        --no-update-default-toolchain    Don't update any existing default toolchain after install
+        --no-modify-path                 Don't configure the PATH environment variable
+    -h, --help                           Prints help information
+    -V, --version                        Prints version information
+
+OPTIONS:
+        --default-host <default-host>              Choose a default host triple
+        --default-toolchain <default-toolchain>
+            Choose a default toolchain to install. Use 'none' to not install any toolchains at all
+
+        --profile <profile>                         [default: default]  [possible values: minimal, default, complete]
+    -c, --component <components>...                Component name to also install
+    -t, --target <targets>...                      Target name to also install
+"""
+stderr = ""
diff --git a/...ui/rustup_check_cmd_help_flag_stdout.toml → ...up/rustup_check_cmd_help_flag_stdout.toml b/...ui/rustup_check_cmd_help_flag_stdout.toml → ...up/rustup_check_cmd_help_flag_stdout.toml
diff --git a/...tup_completions_cmd_help_flag_stdout.toml → ...tup_completions_cmd_help_flag_stdout.toml b/...tup_completions_cmd_help_flag_stdout.toml → ...tup_completions_cmd_help_flag_stdout.toml
diff --git a/...mponent_cmd_add_cmd_help_flag_stdout.toml → ...mponent_cmd_add_cmd_help_flag_stdout.toml b/...mponent_cmd_add_cmd_help_flag_stdout.toml → ...mponent_cmd_add_cmd_help_flag_stdout.toml
diff --git a/...ponent_cmd_list_cmd_help_flag_stdout.toml → ...ponent_cmd_list_cmd_help_flag_stdout.toml b/...ponent_cmd_list_cmd_help_flag_stdout.toml → ...ponent_cmd_list_cmd_help_flag_stdout.toml
diff --git a/...nent_cmd_remove_cmd_help_flag_stdout.toml → ...nent_cmd_remove_cmd_help_flag_stdout.toml b/...nent_cmd_remove_cmd_help_flag_stdout.toml → ...nent_cmd_remove_cmd_help_flag_stdout.toml
diff --git a/.../rustup_default_cmd_help_flag_stdout.toml → .../rustup_default_cmd_help_flag_stdout.toml b/.../rustup_default_cmd_help_flag_stdout.toml → .../rustup_default_cmd_help_flag_stdout.toml
diff --git a/...i-ui/rustup_doc_cmd_help_flag_stdout.toml → ...stup/rustup_doc_cmd_help_flag_stdout.toml b/...i-ui/rustup_doc_cmd_help_flag_stdout.toml → ...stup/rustup_doc_cmd_help_flag_stdout.toml
diff --git a/tests/cli-ui/rustup_help_cmd_stdout.toml → ...cli-ui/rustup/rustup_help_cmd_stdout.toml b/tests/cli-ui/rustup_help_cmd_stdout.toml → ...cli-ui/rustup/rustup_help_cmd_stdout.toml
diff --git a/tests/cli-ui/rustup_help_flag_stdout.toml → ...li-ui/rustup/rustup_help_flag_stdout.toml b/tests/cli-ui/rustup_help_flag_stdout.toml → ...li-ui/rustup/rustup_help_flag_stdout.toml
diff --git a/...i-ui/rustup_man_cmd_help_flag_stdout.toml → ...stup/rustup_man_cmd_help_flag_stdout.toml b/...i-ui/rustup_man_cmd_help_flag_stdout.toml → ...stup/rustup_man_cmd_help_flag_stdout.toml
diff --git a/...verride_cmd_add_cmd_help_flag_stdout.toml → ...verride_cmd_add_cmd_help_flag_stdout.toml b/...verride_cmd_add_cmd_help_flag_stdout.toml → ...verride_cmd_add_cmd_help_flag_stdout.toml
diff --git a/...rustup_override_cmd_help_flag_stdout.toml → ...rustup_override_cmd_help_flag_stdout.toml b/...rustup_override_cmd_help_flag_stdout.toml → ...rustup_override_cmd_help_flag_stdout.toml
diff --git a/...erride_cmd_list_cmd_help_flag_stdout.toml → ...erride_cmd_list_cmd_help_flag_stdout.toml b/...erride_cmd_list_cmd_help_flag_stdout.toml → ...erride_cmd_list_cmd_help_flag_stdout.toml
diff --git a/...ride_cmd_remove_cmd_help_flag_stdout.toml → ...ride_cmd_remove_cmd_help_flag_stdout.toml b/...ride_cmd_remove_cmd_help_flag_stdout.toml → ...ride_cmd_remove_cmd_help_flag_stdout.toml
diff --git a/...verride_cmd_set_cmd_help_flag_stdout.toml → ...verride_cmd_set_cmd_help_flag_stdout.toml b/...verride_cmd_set_cmd_help_flag_stdout.toml → ...verride_cmd_set_cmd_help_flag_stdout.toml
diff --git a/...rride_cmd_unset_cmd_help_flag_stdout.toml → ...rride_cmd_unset_cmd_help_flag_stdout.toml b/...rride_cmd_unset_cmd_help_flag_stdout.toml → ...rride_cmd_unset_cmd_help_flag_stdout.toml
diff --git a/...i-ui/rustup_run_cmd_help_flag_stdout.toml → ...stup/rustup_run_cmd_help_flag_stdout.toml b/...i-ui/rustup_run_cmd_help_flag_stdout.toml → ...stup/rustup_run_cmd_help_flag_stdout.toml
diff --git a/...-ui/rustup_self_cmd_help_flag_stdout.toml → ...tup/rustup_self_cmd_help_flag_stdout.toml b/...-ui/rustup_self_cmd_help_flag_stdout.toml → ...tup/rustup_self_cmd_help_flag_stdout.toml
diff --git a/...f_cmd_uninstall_cmd_help_flag_stdout.toml → ...f_cmd_uninstall_cmd_help_flag_stdout.toml b/...f_cmd_uninstall_cmd_help_flag_stdout.toml → ...f_cmd_uninstall_cmd_help_flag_stdout.toml
diff --git a/...self_cmd_update_cmd_help_flag_stdout.toml → ...self_cmd_update_cmd_help_flag_stdout.toml b/...self_cmd_update_cmd_help_flag_stdout.toml → ...self_cmd_update_cmd_help_flag_stdout.toml
diff --git a/...d_upgrade-data _cmd_help_flag_stdout.toml → ...d_upgrade-data _cmd_help_flag_stdout.toml b/...d_upgrade-data _cmd_help_flag_stdout.toml → ...d_upgrade-data _cmd_help_flag_stdout.toml
diff --git a/...uto-self-update_cmd_help_flag_stdout.toml → ...uto-self-update_cmd_help_flag_stdout.toml b/...uto-self-update_cmd_help_flag_stdout.toml → ...uto-self-update_cmd_help_flag_stdout.toml
diff --git a/...md_default-host_cmd_help_flag_stdout.toml → ...md_default-host_cmd_help_flag_stdout.toml b/...md_default-host_cmd_help_flag_stdout.toml → ...md_default-host_cmd_help_flag_stdout.toml
diff --git a/...i-ui/rustup_set_cmd_help_flag_stdout.toml → ...stup/rustup_set_cmd_help_flag_stdout.toml b/...i-ui/rustup_set_cmd_help_flag_stdout.toml → ...stup/rustup_set_cmd_help_flag_stdout.toml
diff --git a/...set_cmd_profile_cmd_help_flag_stdout.toml → ...set_cmd_profile_cmd_help_flag_stdout.toml b/...set_cmd_profile_cmd_help_flag_stdout.toml → ...set_cmd_profile_cmd_help_flag_stdout.toml
diff --git a/...ctive-toolchain_cmd_help_flag_stdout.toml → ...ctive-toolchain_cmd_help_flag_stdout.toml b/...ctive-toolchain_cmd_help_flag_stdout.toml → ...ctive-toolchain_cmd_help_flag_stdout.toml
diff --git a/...-ui/rustup_show_cmd_help_flag_stdout.toml → ...tup/rustup_show_cmd_help_flag_stdout.toml b/...-ui/rustup_show_cmd_help_flag_stdout.toml → ...tup/rustup_show_cmd_help_flag_stdout.toml
diff --git a/...p_show_cmd_home_cmd_help_flag_stdout.toml → ...p_show_cmd_home_cmd_help_flag_stdout.toml b/...p_show_cmd_home_cmd_help_flag_stdout.toml → ...p_show_cmd_home_cmd_help_flag_stdout.toml
diff --git a/...p_show_cmd_keys_cmd_help_flag_stdout.toml → ...p_show_cmd_keys_cmd_help_flag_stdout.toml b/...p_show_cmd_keys_cmd_help_flag_stdout.toml → ...p_show_cmd_keys_cmd_help_flag_stdout.toml
diff --git a/...how_cmd_profile_cmd_help_flag_stdout.toml → ...how_cmd_profile_cmd_help_flag_stdout.toml b/...how_cmd_profile_cmd_help_flag_stdout.toml → ...how_cmd_profile_cmd_help_flag_stdout.toml
diff --git a/..._target_cmd_add_cmd_help_flag_stdout.toml → ..._target_cmd_add_cmd_help_flag_stdout.toml b/..._target_cmd_add_cmd_help_flag_stdout.toml → ..._target_cmd_add_cmd_help_flag_stdout.toml
diff --git a/...i/rustup_target_cmd_help_flag_stdout.toml → ...p/rustup_target_cmd_help_flag_stdout.toml b/...i/rustup_target_cmd_help_flag_stdout.toml → ...p/rustup_target_cmd_help_flag_stdout.toml
diff --git a/...target_cmd_list_cmd_help_flag_stdout.toml → ...target_cmd_list_cmd_help_flag_stdout.toml b/...target_cmd_list_cmd_help_flag_stdout.toml → ...target_cmd_list_cmd_help_flag_stdout.toml
diff --git a/...rget_cmd_remove_cmd_help_flag_stdout.toml → ...rget_cmd_remove_cmd_help_flag_stdout.toml b/...rget_cmd_remove_cmd_help_flag_stdout.toml → ...rget_cmd_remove_cmd_help_flag_stdout.toml
diff --git a/...ustup_toolchain_cmd_help_flag_stdout.toml → ...ustup_toolchain_cmd_help_flag_stdout.toml b/...ustup_toolchain_cmd_help_flag_stdout.toml → ...ustup_toolchain_cmd_help_flag_stdout.toml
diff --git a/...ain_cmd_install_cmd_help_flag_stdout.toml → ...ain_cmd_install_cmd_help_flag_stdout.toml b/...ain_cmd_install_cmd_help_flag_stdout.toml → ...ain_cmd_install_cmd_help_flag_stdout.toml
diff --git a/...lchain_cmd_link_cmd_help_flag_stdout.toml → ...lchain_cmd_link_cmd_help_flag_stdout.toml b/...lchain_cmd_link_cmd_help_flag_stdout.toml → ...lchain_cmd_link_cmd_help_flag_stdout.toml
diff --git a/...lchain_cmd_list_cmd_help_flag_stdout.toml → ...lchain_cmd_list_cmd_help_flag_stdout.toml b/...lchain_cmd_list_cmd_help_flag_stdout.toml → ...lchain_cmd_list_cmd_help_flag_stdout.toml
diff --git a/...n_cmd_uninstall_cmd_help_flag_stdout.toml → ...n_cmd_uninstall_cmd_help_flag_stdout.toml b/...n_cmd_uninstall_cmd_help_flag_stdout.toml → ...n_cmd_uninstall_cmd_help_flag_stdout.toml
diff --git a/...li-ui/rustup_up_cmd_help_flag_stdout.toml → ...ustup/rustup_up_cmd_help_flag_stdout.toml b/...li-ui/rustup_up_cmd_help_flag_stdout.toml → ...ustup/rustup_up_cmd_help_flag_stdout.toml
diff --git a/...i/rustup_update_cmd_help_flag_stdout.toml → ...p/rustup_update_cmd_help_flag_stdout.toml b/...i/rustup_update_cmd_help_flag_stdout.toml → ...p/rustup_update_cmd_help_flag_stdout.toml
diff --git a/.../rustup_upgrade_cmd_help_flag_stdout.toml → .../rustup_upgrade_cmd_help_flag_stdout.toml b/.../rustup_upgrade_cmd_help_flag_stdout.toml → .../rustup_upgrade_cmd_help_flag_stdout.toml
diff --git a/...ui/rustup_which_cmd_help_flag_stdout.toml → ...up/rustup_which_cmd_help_flag_stdout.toml b/...ui/rustup_which_cmd_help_flag_stdout.toml → ...up/rustup_which_cmd_help_flag_stdout.toml