Skip to content

tests: deduplicate distribution installation tests #4495

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
merged 1 commit into from
Sep 24, 2025
+86 −122
Merged

tests: deduplicate distribution installation tests #4495

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
208 changes: 86 additions & 122 deletions tests/suite/dist_install.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,6 @@ fn package_bad_version() {

#[test]
fn basic_install() {
let pkgdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();

let mock = MockInstallerBuilder {
components: vec![MockComponentBuilder {
name: "mycomponent".to_string(),
Expand All @@ -105,40 +103,25 @@ fn basic_install() {
}],
};

mock.build(pkgdir.path());

let instdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();
let prefix = InstallPrefix::from(instdir.path().to_owned());

let tmpdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();
let tmp_cx = temp::Context::new(
tmpdir.path().to_owned(),
DEFAULT_DIST_SERVER,
Box::new(|_| ()),
);
let notify = |_: Notification<'_>| ();
let tp = TestProcess::default();
let tx = Transaction::new(prefix.clone(), &tmp_cx, &notify, &tp.process);

let components = Components::open(prefix).unwrap();

let pkg = DirectoryPackage::new(pkgdir.path().to_owned(), true).unwrap();

let cx = DistContext::new(mock).unwrap();
let (tx, components, pkg) = cx.start().unwrap();
let tx = pkg.install(&components, "mycomponent", None, tx).unwrap();
tx.commit();

assert!(utils::path_exists(instdir.path().join("bin/foo")));
assert!(utils::path_exists(instdir.path().join("lib/bar")));
assert!(utils::path_exists(instdir.path().join("doc/stuff/doc1")));
assert!(utils::path_exists(instdir.path().join("doc/stuff/doc2")));
assert!(utils::path_exists(cx.inst_dir.path().join("bin/foo")));
assert!(utils::path_exists(cx.inst_dir.path().join("lib/bar")));
assert!(utils::path_exists(
cx.inst_dir.path().join("doc/stuff/doc1")
));
assert!(utils::path_exists(
cx.inst_dir.path().join("doc/stuff/doc2")
));

assert!(components.find("mycomponent").unwrap().is_some());
}

#[test]
fn multiple_component_install() {
let pkgdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();

let mock = MockInstallerBuilder {
components: vec![
MockComponentBuilder {
Expand All @@ -152,40 +135,21 @@ fn multiple_component_install() {
],
};

mock.build(pkgdir.path());

let instdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();
let prefix = InstallPrefix::from(instdir.path().to_owned());

let tmpdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();
let tmp_cx = temp::Context::new(
tmpdir.path().to_owned(),
DEFAULT_DIST_SERVER,
Box::new(|_| ()),
);
let notify = |_: Notification<'_>| ();
let tp = TestProcess::default();
let tx = Transaction::new(prefix.clone(), &tmp_cx, &notify, &tp.process);

let components = Components::open(prefix).unwrap();

let pkg = DirectoryPackage::new(pkgdir.path().to_owned(), true).unwrap();

let cx = DistContext::new(mock).unwrap();
let (tx, components, pkg) = cx.start().unwrap();
let tx = pkg.install(&components, "mycomponent", None, tx).unwrap();
let tx = pkg.install(&components, "mycomponent2", None, tx).unwrap();
tx.commit();

assert!(utils::path_exists(instdir.path().join("bin/foo")));
assert!(utils::path_exists(instdir.path().join("lib/bar")));
assert!(utils::path_exists(cx.inst_dir.path().join("bin/foo")));
assert!(utils::path_exists(cx.inst_dir.path().join("lib/bar")));

assert!(components.find("mycomponent").unwrap().is_some());
assert!(components.find("mycomponent2").unwrap().is_some());
}

#[test]
fn uninstall() {
let pkgdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();

let mock = MockInstallerBuilder {
components: vec![
MockComponentBuilder {
Expand All @@ -203,43 +167,29 @@ fn uninstall() {
],
};

mock.build(pkgdir.path());

let instdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();
let prefix = InstallPrefix::from(instdir.path().to_owned());

let tmpdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();
let tmp_cx = temp::Context::new(
tmpdir.path().to_owned(),
DEFAULT_DIST_SERVER,
Box::new(|_| ()),
);
let notify = |_: Notification<'_>| ();
let tp = TestProcess::default();
let tx = Transaction::new(prefix.clone(), &tmp_cx, &notify, &tp.process);

let components = Components::open(prefix.clone()).unwrap();

let pkg = DirectoryPackage::new(pkgdir.path().to_owned(), true).unwrap();

let cx = DistContext::new(mock).unwrap();
let (tx, components, pkg) = cx.start().unwrap();
let tx = pkg.install(&components, "mycomponent", None, tx).unwrap();
let tx = pkg.install(&components, "mycomponent2", None, tx).unwrap();
tx.commit();

// Now uninstall
let notify = |_: Notification<'_>| ();
let tp = TestProcess::default();
let mut tx = Transaction::new(prefix.clone(), &tmp_cx, &notify, &tp.process);
let mut tx = Transaction::new(cx.prefix.clone(), &cx.cx, &notify, &cx.tp.process);
for component in components.list().unwrap() {
tx = component.uninstall(tx, &tp.process).unwrap();
tx = component.uninstall(tx, &cx.tp.process).unwrap();
}
tx.commit();

assert!(!utils::path_exists(instdir.path().join("bin/foo")));
assert!(!utils::path_exists(instdir.path().join("lib/bar")));
assert!(!utils::path_exists(instdir.path().join("doc/stuff/doc1")));
assert!(!utils::path_exists(instdir.path().join("doc/stuff/doc2")));
assert!(!utils::path_exists(instdir.path().join("doc/stuff")));
assert!(!utils::path_exists(cx.inst_dir.path().join("bin/foo")));
assert!(!utils::path_exists(cx.inst_dir.path().join("lib/bar")));
assert!(!utils::path_exists(
cx.inst_dir.path().join("doc/stuff/doc1")
));
assert!(!utils::path_exists(
cx.inst_dir.path().join("doc/stuff/doc2")
));
assert!(!utils::path_exists(cx.inst_dir.path().join("doc/stuff")));
assert!(components.find("mycomponent").unwrap().is_none());
assert!(components.find("mycomponent2").unwrap().is_none());
}
Expand All @@ -253,42 +203,28 @@ fn uninstall_best_effort() {

#[test]
fn component_bad_version() {
let pkgdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();

let mock = MockInstallerBuilder {
components: vec![MockComponentBuilder {
name: "mycomponent".to_string(),
files: vec![MockFile::new("bin/foo", b"foo")],
}],
};

mock.build(pkgdir.path());

let instdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();
let prefix = InstallPrefix::from(instdir.path().to_owned());

let tmpdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();
let tmp_cx = temp::Context::new(
tmpdir.path().to_owned(),
DEFAULT_DIST_SERVER,
Box::new(|_| ()),
);
let notify = |_: Notification<'_>| ();
let tp = TestProcess::default();
let tx = Transaction::new(prefix.clone(), &tmp_cx, &notify, &tp.process);

let components = Components::open(prefix.clone()).unwrap();

let pkg = DirectoryPackage::new(pkgdir.path().to_owned(), true).unwrap();

let cx = DistContext::new(mock).unwrap();
let (tx, components, pkg) = cx.start().unwrap();
let tx = pkg.install(&components, "mycomponent", None, tx).unwrap();
tx.commit();

// Write a bogus version to the component manifest directory
utils::write_file("", &prefix.manifest_file("rust-installer-version"), "100\n").unwrap();
utils::write_file(
"",
&cx.prefix.manifest_file("rust-installer-version"),
"100\n",
)
.unwrap();

// Can't open components now
let e = Components::open(prefix).unwrap_err();
let e = Components::open(cx.prefix).unwrap_err();
assert_eq!(
"unsupported metadata version in existing installation: 100",
format!("{e}")
Expand All @@ -298,38 +234,66 @@ fn component_bad_version() {
// Installing to a prefix that doesn't exist creates it automatically
#[test]
fn install_to_prefix_that_does_not_exist() {
let pkgdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();

let mock = MockInstallerBuilder {
components: vec![MockComponentBuilder {
name: "mycomponent".to_string(),
files: vec![MockFile::new("bin/foo", b"foo")],
}],
};

mock.build(pkgdir.path());
let mut cx = DistContext::new(mock).unwrap();
let does_not_exist = cx.inst_dir.path().join("does_not_exist");
cx.prefix = InstallPrefix::from(does_not_exist.clone());
let (tx, components, pkg) = cx.start().unwrap();
let tx = pkg.install(&components, "mycomponent", None, tx).unwrap();
tx.commit();

let instdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();
// The directory that does not exist
let does_not_exist = instdir.path().join("super_not_real");
let prefix = InstallPrefix::from(does_not_exist.clone());

let tmpdir = tempfile::Builder::new().prefix("rustup").tempdir().unwrap();
let tmp_cx = temp::Context::new(
tmpdir.path().to_owned(),
DEFAULT_DIST_SERVER,
Box::new(|_| ()),
);
let notify = |_: Notification<'_>| ();
let tp = TestProcess::default();
let tx = Transaction::new(prefix.clone(), &tmp_cx, &notify, &tp.process);

let components = Components::open(prefix).unwrap();
assert!(utils::path_exists(does_not_exist.join("bin/foo")));
}

let pkg = DirectoryPackage::new(pkgdir.path().to_owned(), true).unwrap();
struct DistContext {
pkg_dir: tempfile::TempDir,
inst_dir: tempfile::TempDir,
prefix: InstallPrefix,
_tmp_dir: tempfile::TempDir,
cx: temp::Context,
tp: TestProcess,
}

let tx = pkg.install(&components, "mycomponent", None, tx).unwrap();
tx.commit();
impl DistContext {
fn new(mock: MockInstallerBuilder) -> anyhow::Result<Self> {
let pkg_dir = tempfile::Builder::new().prefix("rustup").tempdir()?;
mock.build(pkg_dir.path());

let inst_dir = tempfile::Builder::new().prefix("rustup").tempdir()?;
let prefix = InstallPrefix::from(inst_dir.path().to_owned());
let tmp_dir = tempfile::Builder::new().prefix("rustup").tempdir()?;

Ok(Self {
pkg_dir,
inst_dir,
prefix,
cx: temp::Context::new(
tmp_dir.path().to_owned(),
DEFAULT_DIST_SERVER,
Box::new(|_| ()),
),
tp: TestProcess::default(),
_tmp_dir: tmp_dir,
})
}

assert!(utils::path_exists(does_not_exist.join("bin/foo")));
fn start(&self) -> anyhow::Result<(Transaction<'_>, Components, DirectoryPackage)> {
let tx = Transaction::new(
self.prefix.clone(),
&self.cx,
&|_: Notification<'_>| (),
&self.tp.process,
);

let components = Components::open(self.prefix.clone())?;
let pkg = DirectoryPackage::new(self.pkg_dir.path().to_owned(), true)?;
Ok((tx, components, pkg))
}
}
Loading