Skip to content

Add bootstrap snapshot tests for {install, install src} #152840

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rust-bors merged 1 commit into from
Feb 20, 2026
+157 −3
Merged

Add bootstrap snapshot tests for {install, install src} #152840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 152 additions & 3 deletions src/bootstrap/src/core/builder/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2854,19 +2854,168 @@ mod snapshot {
.render_steps(), @"[clippy] rustc 0 <host> -> bootstrap 1 <host>");
}

#[test]
fn install_plain() {
let ctx = TestCtx::new();
insta::assert_snapshot!(
ctx.config("install")
.args(&[
// Using backslashes fails with `--set`
"--set", &format!("install.prefix={}", ctx.normalized_dir()),
"--set", &format!("install.bindir={}", ctx.normalized_dir()),
"--set", &format!("install.libdir={}", ctx.normalized_dir()),
"--set", &format!("install.datadir={}", ctx.normalized_dir()),
"--set", &format!("install.mandir={}", ctx.normalized_dir()),
"--set", &format!("install.sysconfdir={}", ctx.normalized_dir()),
"--build", "x86_64-unknown-linux-gnu",
"--host", "x86_64-unknown-linux-gnu",
"--target", "x86_64-unknown-linux-gnu",
])
.get_steps()
.render_with(RenderConfig {
normalize_host: false
}), @r"
[build] llvm <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> rustc 1 <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> UnstableBookGen 1 <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> Rustbook 1 <x86_64-unknown-linux-gnu>
[doc] unstable-book (book) <x86_64-unknown-linux-gnu>
[build] rustc 1 <x86_64-unknown-linux-gnu> -> std 1 <x86_64-unknown-linux-gnu>
[doc] book (book) <x86_64-unknown-linux-gnu>
[doc] book/first-edition (book) <x86_64-unknown-linux-gnu>
[doc] book/second-edition (book) <x86_64-unknown-linux-gnu>
[doc] book/2018-edition (book) <x86_64-unknown-linux-gnu>
[build] rustdoc 1 <x86_64-unknown-linux-gnu>
[doc] rustc 1 <x86_64-unknown-linux-gnu> -> standalone 2 <x86_64-unknown-linux-gnu>
[doc] rustc 1 <x86_64-unknown-linux-gnu> -> std 1 <x86_64-unknown-linux-gnu> crates=[alloc,compiler_builtins,core,panic_abort,panic_unwind,proc_macro,rustc-std-workspace-core,std,std_detect,sysroot,test,unwind]
[build] rustc 1 <x86_64-unknown-linux-gnu> -> rustc 2 <x86_64-unknown-linux-gnu>
[build] rustc 1 <x86_64-unknown-linux-gnu> -> error-index 2 <x86_64-unknown-linux-gnu>
[doc] rustc 1 <x86_64-unknown-linux-gnu> -> error-index 2 <x86_64-unknown-linux-gnu>
[doc] nomicon (book) <x86_64-unknown-linux-gnu>
[doc] rustc 1 <x86_64-unknown-linux-gnu> -> reference (book) 2 <x86_64-unknown-linux-gnu>
[doc] rustdoc (book) <x86_64-unknown-linux-gnu>
[doc] rust-by-example (book) <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> LintDocs 1 <x86_64-unknown-linux-gnu>
[doc] rustc (book) <x86_64-unknown-linux-gnu>
[doc] cargo (book) <x86_64-unknown-linux-gnu>
[doc] clippy (book) <x86_64-unknown-linux-gnu>
[doc] embedded-book (book) <x86_64-unknown-linux-gnu>
[doc] edition-guide (book) <x86_64-unknown-linux-gnu>
[doc] style-guide (book) <x86_64-unknown-linux-gnu>
[doc] rustc 1 <x86_64-unknown-linux-gnu> -> releases 2 <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> RustInstaller 1 <x86_64-unknown-linux-gnu>
[dist] docs <x86_64-unknown-linux-gnu>
[dist] rustc 1 <x86_64-unknown-linux-gnu> -> std 1 <x86_64-unknown-linux-gnu>
[build] rustdoc 2 <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> GenerateCopyright 1 <x86_64-unknown-linux-gnu>
[dist] rustc <x86_64-unknown-linux-gnu>
");
}

#[test]
fn install_src() {
let ctx = TestCtx::new();
insta::assert_snapshot!(
ctx.config("install")
.path("src")
.args(&[
// Using backslashes fails with `--set`
"--set", &format!("install.prefix={}", ctx.normalized_dir()),
"--set", &format!("install.bindir={}", ctx.normalized_dir()),
"--set", &format!("install.libdir={}", ctx.normalized_dir()),
"--set", &format!("install.datadir={}", ctx.normalized_dir()),
"--set", &format!("install.mandir={}", ctx.normalized_dir()),
"--set", &format!("install.sysconfdir={}", ctx.normalized_dir()),
"--build", "x86_64-unknown-linux-gnu",
"--host", "x86_64-unknown-linux-gnu",
"--target", "x86_64-unknown-linux-gnu",
])
.get_steps()
.render_with(RenderConfig {
normalize_host: false
}), @r"
[build] llvm <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> rustc 1 <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> UnstableBookGen 1 <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> Rustbook 1 <x86_64-unknown-linux-gnu>
[doc] unstable-book (book) <x86_64-unknown-linux-gnu>
[build] rustc 1 <x86_64-unknown-linux-gnu> -> std 1 <x86_64-unknown-linux-gnu>
[doc] book (book) <x86_64-unknown-linux-gnu>
[doc] book/first-edition (book) <x86_64-unknown-linux-gnu>
[doc] book/second-edition (book) <x86_64-unknown-linux-gnu>
[doc] book/2018-edition (book) <x86_64-unknown-linux-gnu>
[build] rustdoc 1 <x86_64-unknown-linux-gnu>
[doc] rustc 1 <x86_64-unknown-linux-gnu> -> standalone 2 <x86_64-unknown-linux-gnu>
[doc] rustc 1 <x86_64-unknown-linux-gnu> -> std 1 <x86_64-unknown-linux-gnu> crates=[alloc,compiler_builtins,core,panic_abort,panic_unwind,proc_macro,rustc-std-workspace-core,std,std_detect,sysroot,test,unwind]
[build] rustc 1 <x86_64-unknown-linux-gnu> -> rustc 2 <x86_64-unknown-linux-gnu>
[build] rustc 1 <x86_64-unknown-linux-gnu> -> error-index 2 <x86_64-unknown-linux-gnu>
[doc] rustc 1 <x86_64-unknown-linux-gnu> -> error-index 2 <x86_64-unknown-linux-gnu>
[doc] nomicon (book) <x86_64-unknown-linux-gnu>
[doc] rustc 1 <x86_64-unknown-linux-gnu> -> reference (book) 2 <x86_64-unknown-linux-gnu>
[doc] rustdoc (book) <x86_64-unknown-linux-gnu>
[doc] rust-by-example (book) <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> LintDocs 1 <x86_64-unknown-linux-gnu>
[doc] rustc (book) <x86_64-unknown-linux-gnu>
[doc] cargo (book) <x86_64-unknown-linux-gnu>
[doc] clippy (book) <x86_64-unknown-linux-gnu>
[doc] embedded-book (book) <x86_64-unknown-linux-gnu>
[doc] edition-guide (book) <x86_64-unknown-linux-gnu>
[doc] style-guide (book) <x86_64-unknown-linux-gnu>
[doc] rustc 1 <x86_64-unknown-linux-gnu> -> releases 2 <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> RustInstaller 1 <x86_64-unknown-linux-gnu>
[dist] docs <x86_64-unknown-linux-gnu>
[dist] src <>
");
}

#[test]
fn install_src_no_docs() {
let ctx = TestCtx::new();
insta::assert_snapshot!(
ctx.config("install")
.path("src")
.args(&[
// Using backslashes fails with `--set`
"--set", &format!("install.prefix={}", ctx.normalized_dir()),
"--set", &format!("install.bindir={}", ctx.normalized_dir()),
"--set", &format!("install.libdir={}", ctx.normalized_dir()),
"--set", &format!("install.datadir={}", ctx.normalized_dir()),
"--set", &format!("install.mandir={}", ctx.normalized_dir()),
"--set", &format!("install.sysconfdir={}", ctx.normalized_dir()),
"--set", "build.docs=false",
"--build", "x86_64-unknown-linux-gnu",
"--host", "x86_64-unknown-linux-gnu",
"--target", "x86_64-unknown-linux-gnu",
])
.get_steps()
.render_with(RenderConfig {
normalize_host: false
}), @r"
[build] llvm <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> rustc 1 <x86_64-unknown-linux-gnu>
[build] rustc 0 <x86_64-unknown-linux-gnu> -> RustInstaller 1 <x86_64-unknown-linux-gnu>
[dist] docs <x86_64-unknown-linux-gnu>
[dist] src <>
");
}

#[test]
fn install_extended() {
let ctx = TestCtx::new();
insta::assert_snapshot!(
ctx.config("install")
.args(&[
// Using backslashes fails with `--set`
"--set", &format!("install.prefix={}", ctx.dir().display()).replace("\\", "/"),
"--set", &format!("install.sysconfdir={}", ctx.dir().display()).replace("\\", "/"),
"--set", &format!("install.prefix={}", ctx.normalized_dir()),
"--set", &format!("install.bindir={}", ctx.normalized_dir()),
"--set", &format!("install.libdir={}", ctx.normalized_dir()),
"--set", &format!("install.datadir={}", ctx.normalized_dir()),
"--set", &format!("install.mandir={}", ctx.normalized_dir()),
"--set", &format!("install.sysconfdir={}", ctx.normalized_dir()),
Comment on lines +3009 to +3014
Copy link
Member Author

@jieyouxu jieyouxu Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remark: drive-by change to cover all of the install.*dirs + extract the common dir normalization logic.

"--set", "build.extended=true",
// For Cranelift to be disted
"--build", "x86_64-unknown-linux-gnu",
"--host", "x86_64-unknown-linux-gnu"
"--host", "x86_64-unknown-linux-gnu",
])
.get_steps()
.render_with(RenderConfig {
Expand Down
5 changes: 5 additions & 0 deletions src/bootstrap/src/utils/tests/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ impl TestCtx {
self.directory.path()
}

/// Using backslashes fails with `--set`
pub fn normalized_dir(&self) -> String {
self.dir().to_string_lossy().replace("\\", "/")
}

/// Starts a new invocation of bootstrap that executes `kind` as its top level command
/// (i.e. `x <kind>`). Returns a builder that configures the created config through CLI flags.
pub fn config(&self, kind: &str) -> ConfigBuilder {
Expand Down
Loading