Improve test suite for -Zbuild-std

This commit is aimed directly at rust-lang/wg-cargo-std-aware#33 and in
general making the `-Zbuild-std` tests more robust. The main change here
is that a new source tree is checked in, `tests/testsuite/mock-std`,
which mirrors rust-lang/rust's own tree for libstd. This mock tree is as
empty as it can be, ideally duplicating almost nothing but for not
requiring duplication of Cargo metadata about patches and such.

The end result here looks like:

* All `-Zbuild-std` tests are now run in parallel
* All tests run much more quickly since they're compiling tiny crates
  instead of actually compiling libstd/libcore
* No tests require network access
* We verify that crates have access to the "custom" libraries
  that we build

Coverage of tests is not currently expanded, but it's hoped that we
could add that shortly afterwards. Coverage has actually gone down
slightly since the custom target test was commented out temporarily and
the full integration test of running `-Zbuild-std` isn't run on CI any
more.

Closes rust-lang/wg-cargo-std-aware#33
This commit is contained in:
Alex Crichton 2019-09-10 11:01:31 -07:00
parent b2d4f20a27
commit 4cbfd02eff
24 changed files with 587 additions and 200 deletions

View File

@ -7,6 +7,7 @@ use crate::core::{Dependency, PackageId, PackageSet, Resolve, SourceId, Workspac
use crate::ops::{self, Packages};
use crate::util::errors::CargoResult;
use std::collections::{HashMap, HashSet};
use std::env;
use std::path::PathBuf;
/// Parse the `-Zbuild-std` flag.
@ -148,6 +149,10 @@ pub fn generate_std_roots<'a>(
}
fn detect_sysroot_src_path(ws: &Workspace<'_>) -> CargoResult<PathBuf> {
if let Some(s) = env::var_os("__CARGO_TESTS_ONLY_SRC_ROOT") {
return Ok(s.into());
}
// NOTE: This is temporary until we figure out how to acquire the source.
// If we decide to keep the sysroot probe, then BuildConfig will need to
// be restructured so that the TargetInfo is created earlier and passed

View File

@ -0,0 +1,9 @@
[workspace]
members = [
"src/libtest",
]
[patch.crates-io]
rustc-std-workspace-std = { path = 'src/tools/rustc-std-workspace-std' }
rustc-std-workspace-core = { path = 'src/tools/rustc-std-workspace-core' }
rustc-std-workspace-alloc = { path = 'src/tools/rustc-std-workspace-alloc' }

View File

@ -0,0 +1,11 @@
[package]
name = "alloc"
version = "0.1.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]
edition = "2018"
[lib]
path = "lib.rs"
[dependencies]
core = { path = "../libcore" }

View File

@ -0,0 +1 @@
pub fn custom_api() {}

View File

@ -0,0 +1,11 @@
[package]
name = "compiler_builtins"
version = "0.1.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]
edition = "2018"
[lib]
path = "lib.rs"
[dependencies]
core = { path = "../libcore" }

View File

@ -0,0 +1 @@
// intentionally blank

View File

@ -0,0 +1,8 @@
[package]
name = "core"
version = "0.1.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]
edition = "2018"
[lib]
path = "lib.rs"

View File

@ -0,0 +1,23 @@
//! This build script is basically the whole hack that makes this entire "mock
//! std" feature work. Here we print out `rustc-link-search` pointing to the
//! sysroot of the actual compiler itself, and that way we can indeed implicitly
//! pull in those crates, but only via `extern crate`. That means that we can
//! build tiny shim core/std/etc crates while they actually load all the various
//! language/library details from the actual crates, meaning that instead of
//! literally compiling libstd we compile just our own tiny shims.
use std::process::Command;
use std::env;
fn main() {
let output = Command::new("rustc")
.arg("--print")
.arg("sysroot")
.output()
.unwrap();
assert!(output.status.success());
let stdout = String::from_utf8(output.stdout).unwrap();
let stdout = stdout.trim();
let host = env::var("HOST").unwrap();
println!("cargo:rustc-link-search={}/lib/rustlib/{}/lib", stdout, host);
}

View File

@ -0,0 +1,4 @@
#![no_std]
pub use core::*;
pub fn custom_api() {}

View File

@ -0,0 +1,11 @@
[package]
name = "panic_unwind"
version = "0.1.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]
edition = "2018"
[lib]
path = "lib.rs"
[dependencies]
core = { path = "../libcore" }

View File

@ -0,0 +1,5 @@
#![feature(panic_unwind, panic_runtime)]
#![panic_runtime]
#![no_std]
extern crate panic_unwind;

View File

@ -0,0 +1,11 @@
[package]
name = "proc_macro"
version = "0.1.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]
edition = "2018"
[lib]
path = "lib.rs"
[dependencies]
std = { path = "../libstd" }

View File

@ -0,0 +1,3 @@
extern crate proc_macro;
pub use proc_macro::*;
pub fn custom_api() {}

View File

@ -0,0 +1,15 @@
[package]
name = "std"
version = "0.1.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]
edition = "2018"
[lib]
path = "lib.rs"
[dependencies]
core = { path = "../libcore" }
compiler_builtins = { path = "../libcompiler_builtins" }
panic_unwind = { path = "../libpanic_unwind" }
registry-dep-using-core = { version = "1.0", features = ['mockbuild'] }
registry-dep-using-alloc = { version = "1.0", features = ['mockbuild'] }

View File

@ -0,0 +1,6 @@
pub use std::*;
pub fn custom_api() {
registry_dep_using_core::custom_api();
registry_dep_using_alloc::custom_api();
}

View File

@ -0,0 +1,17 @@
[package]
name = "test"
version = "0.1.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]
edition = "2018"
[lib]
path = "lib.rs"
[dependencies]
proc_macro = { path = "../libproc_macro" }
registry-dep-using-std = { version = "1.0", features = ['mockbuild'] }
std = { path = "../libstd" }
[features]
panic-unwind = []
backtrace = []

View File

@ -0,0 +1,9 @@
#![feature(test)]
extern crate test;
pub use test::*;
pub fn custom_api() {
registry_dep_using_std::custom_api();
}

View File

@ -0,0 +1,12 @@
[package]
name = "rustc-std-workspace-alloc"
version = "1.9.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]
edition = "2018"
[lib]
name = "alloc"
path = "lib.rs"
[dependencies]
alloc = { path = "../../liballoc" }

View File

@ -0,0 +1,3 @@
#![no_std]
pub use alloc::*;

View File

@ -0,0 +1,12 @@
[package]
name = "rustc-std-workspace-core"
version = "1.9.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]
edition = "2018"
[lib]
name = "core"
path = "lib.rs"
[dependencies]
core = { path = "../../libcore" }

View File

@ -0,0 +1,3 @@
#![no_std]
pub use core::*;

View File

@ -0,0 +1,12 @@
[package]
name = "rustc-std-workspace-std"
version = "1.9.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]
edition = "2018"
[lib]
name = "std"
path = "lib.rs"
[dependencies]
std = { path = "../../libstd" }

View File

@ -0,0 +1 @@
pub use std::*;

View File

@ -1,283 +1,396 @@
use crate::support::{is_nightly, paths, project, rustc_host, Execs, Project};
use crate::support::registry::{Dependency, Package};
use crate::support::{is_nightly, paths, project, rustc_host, Execs};
fn cargo_build_std(project: &Project, cmd: &str, crates: &str) -> Execs {
let unstable = if crates.is_empty() {
"-Zbuild-std".to_string()
} else {
format!("-Zbuild-std={}", crates)
};
let target = paths::root().join("target");
let mut execs = project.cargo(cmd);
if !cmd.contains("--target") {
execs.arg("--target").arg(rustc_host());
}
execs
.arg(unstable)
.arg("-Zno-index-update")
.env_remove("CARGO_HOME")
.env_remove("HOME")
.env("CARGO_TARGET_DIR", target.as_os_str())
.masquerade_as_nightly_cargo();
execs
}
#[cargo_test]
fn std_lib() {
fn setup() -> bool {
if !is_nightly() {
// -Zbuild-std is nightly
// -Zno-index-update is nightly
// We don't want these tests to run on rust-lang/rust.
return;
return false;
}
simple_lib_std();
simple_bin_std();
lib_nostd();
check_core();
cross_custom();
hashbrown();
libc();
test();
custom_test_framework();
target_proc_macro();
bench();
doc();
check_std();
doctest();
// Our mock sysroot requires a few packages from crates.io, so make sure
// they're "published" to crates.io. Also edit their code a bit to make sure
// that they have access to our custom crates with custom apis.
Package::new("registry-dep-using-core", "1.0.0")
.file(
"src/lib.rs",
"
#![no_std]
#[cfg(feature = \"mockbuild\")]
pub fn custom_api() {
core::custom_api();
}
#[cfg(not(feature = \"mockbuild\"))]
pub fn non_sysroot_api() {
core::custom_api();
}
",
)
.add_dep(Dependency::new("rustc-std-workspace-core", "*").optional(true))
.feature("mockbuild", &["rustc-std-workspace-core"])
.publish();
Package::new("registry-dep-using-alloc", "1.0.0")
.file(
"src/lib.rs",
"
#![no_std]
extern crate alloc;
#[cfg(feature = \"mockbuild\")]
pub fn custom_api() {
core::custom_api();
alloc::custom_api();
}
#[cfg(not(feature = \"mockbuild\"))]
pub fn non_sysroot_api() {
core::custom_api();
alloc::custom_api();
}
",
)
.add_dep(Dependency::new("rustc-std-workspace-core", "*").optional(true))
.add_dep(Dependency::new("rustc-std-workspace-alloc", "*").optional(true))
.feature(
"mockbuild",
&["rustc-std-workspace-core", "rustc-std-workspace-alloc"],
)
.publish();
Package::new("registry-dep-using-std", "1.0.0")
.file(
"src/lib.rs",
"
#[cfg(feature = \"mockbuild\")]
pub fn custom_api() {
std::custom_api();
}
#[cfg(not(feature = \"mockbuild\"))]
pub fn non_sysroot_api() {
std::custom_api();
}
",
)
.add_dep(Dependency::new("rustc-std-workspace-std", "*").optional(true))
.feature("mockbuild", &["rustc-std-workspace-std"])
.publish();
return true;
}
fn enable_build_std(e: &mut Execs, arg: Option<&str>) {
// First up, force Cargo to use our "mock sysroot" which mimics what
// libstd looks like upstream.
let root = paths::root();
let root = root
.parent() // chop off test name
.unwrap()
.parent() // chop off `citN`
.unwrap()
.parent() // chop off `target`
.unwrap()
.join("tests/testsuite/mock-std");
e.env("__CARGO_TESTS_ONLY_SRC_ROOT", &root);
// Next, make sure it doesn't have implicit access to the host's sysroot
e.env("RUSTFLAGS", "--sysroot=/path/to/nowhere");
// And finally actually enable `build-std` for now
let arg = match arg {
Some(s) => format!("-Zbuild-std={}", s),
None => "-Zbuild-std".to_string(),
};
e.arg(arg);
e.masquerade_as_nightly_cargo();
}
// Helper methods used in the tests below
trait BuildStd: Sized {
fn build_std(&mut self) -> &mut Self;
fn build_std_arg(&mut self, arg: &str) -> &mut Self;
fn target_host(&mut self) -> &mut Self;
}
impl BuildStd for Execs {
fn build_std(&mut self) -> &mut Self {
enable_build_std(self, None);
self
}
fn build_std_arg(&mut self, arg: &str) -> &mut Self {
enable_build_std(self, Some(arg));
self
}
fn target_host(&mut self) -> &mut Self {
self.arg("--target").arg(rustc_host());
self
}
}
#[cargo_test]
fn basic() {
if !setup() {
return;
}
let p = project()
.file(
"src/main.rs",
"
fn main() {
std::custom_api();
foo::f();
}
#[test]
fn smoke_bin_unit() {
std::custom_api();
foo::f();
}
",
)
.file(
"src/lib.rs",
"
extern crate alloc;
extern crate proc_macro;
/// ```
/// foo::f();
/// ```
pub fn f() {
core::custom_api();
std::custom_api();
alloc::custom_api();
proc_macro::custom_api();
}
#[test]
fn smoke_lib_unit() {
std::custom_api();
f();
}
",
)
.file(
"tests/smoke.rs",
"
#[test]
fn smoke_integration() {
std::custom_api();
foo::f();
}
",
)
.build();
p.cargo("check").build_std().target_host().run();
p.cargo("build").build_std().target_host().run();
p.cargo("run").build_std().target_host().run();
p.cargo("test").build_std().target_host().run();
}
#[cargo_test]
fn simple_lib_std() {
if !setup() {
return;
}
let p = project().file("src/lib.rs", "").build();
cargo_build_std(&p, "build -v", "")
p.cargo("build -v")
.build_std()
.target_host()
.with_stderr_contains("[RUNNING] `rustc [..]--crate-name std [..]")
.run();
// Check freshness.
p.change_file("src/lib.rs", " ");
cargo_build_std(&p, "build -v", "std")
p.cargo("build -v")
.build_std()
.target_host()
.with_stderr_contains("[FRESH] std[..]")
.run();
}
#[cargo_test]
fn simple_bin_std() {
if !setup() {
return;
}
let p = project().file("src/main.rs", "fn main() {}").build();
cargo_build_std(&p, "run -v", "std").run();
p.cargo("run -v").build_std().target_host().run();
}
#[cargo_test]
fn lib_nostd() {
if !setup() {
return;
}
let p = project()
.file(
"src/lib.rs",
r#"
#![no_std]
pub fn foo() {
assert_eq!(core::u8::MIN, 0);
}
#![no_std]
pub fn foo() {
assert_eq!(core::u8::MIN, 0);
}
"#,
)
.build();
cargo_build_std(&p, "build -v --lib", "core")
p.cargo("build -v --lib")
.build_std_arg("core")
.target_host()
.with_stderr_does_not_contain("[..]libstd[..]")
.run();
}
#[cargo_test]
fn check_core() {
if !setup() {
return;
}
let p = project()
.file("src/lib.rs", "#![no_std] fn unused_fn() {}")
.build();
cargo_build_std(&p, "check -v", "core")
p.cargo("check -v")
.build_std_arg("core")
.target_host()
.with_stderr_contains("[WARNING] [..]unused_fn[..]`")
.run();
}
fn cross_custom() {
let p = project()
.file("src/lib.rs", "#![no_std] pub fn f() {}")
.file(
"custom-target.json",
r#"
{
"llvm-target": "x86_64-unknown-none-gnu",
"data-layout": "e-m:e-i64:64-f80:128-n8:16:32:64-S128",
"arch": "x86_64",
"target-endian": "little",
"target-pointer-width": "64",
"target-c-int-width": "32",
"os": "none",
"linker-flavor": "ld.lld"
}
"#,
)
.build();
#[cargo_test]
fn depend_same_as_std() {
if !setup() {
return;
}
cargo_build_std(&p, "build --target custom-target.json -v", "core").run();
}
fn hashbrown() {
let p = project()
.file(
"src/lib.rs",
r#"
pub fn f() -> hashbrown::HashMap<i32, i32> {
hashbrown::HashMap::new()
}
"#,
)
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.1.0"
edition = "2018"
[dependencies]
hashbrown = "=0.4.0"
"#,
)
.build();
cargo_build_std(&p, "build -v", "std").run();
}
fn libc() {
let p = project()
.file(
"src/lib.rs",
r#"
pub fn f() -> ! {
unsafe { libc::exit(123); }
}
"#,
)
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.1.0"
edition = "2018"
[dependencies]
libc = "=0.2.54"
"#,
)
.build();
cargo_build_std(&p, "build -v", "std").run();
}
fn test() {
let p = project()
.file(
"src/lib.rs",
r#"
#[cfg(test)]
mod tests {
#[test]
fn it_works() {
assert_eq!(2 + 2, 4);
pub fn f() {
registry_dep_using_core::non_sysroot_api();
registry_dep_using_alloc::non_sysroot_api();
registry_dep_using_std::non_sysroot_api();
}
}
"#,
)
.file(
"Cargo.toml",
r#"
[package]
name = "foo"
version = "0.1.0"
edition = "2018"
[dependencies]
registry-dep-using-core = "1.0"
registry-dep-using-alloc = "1.0"
registry-dep-using-std = "1.0"
"#,
)
.build();
cargo_build_std(&p, "test -v", "std")
p.cargo("build -v").build_std().target_host().run();
}
#[cargo_test]
fn test() {
if !setup() {
return;
}
let p = project()
.file(
"src/lib.rs",
r#"
#[cfg(test)]
mod tests {
#[test]
fn it_works() {
assert_eq!(2 + 2, 4);
}
}
"#,
)
.build();
p.cargo("test -v")
.build_std()
.target_host()
.with_stdout_contains("test tests::it_works ... ok")
.run();
}
fn custom_test_framework() {
let p = project()
.file(
"src/lib.rs",
r#"
#![no_std]
#![cfg_attr(test, no_main)]
#![feature(custom_test_frameworks)]
#![test_runner(crate::test_runner)]
pub fn test_runner(_tests: &[&dyn Fn()]) {}
#[panic_handler]
fn panic(_info: &core::panic::PanicInfo) -> ! {
loop {}
}
"#,
)
.file(
"target.json",
r#"
{
"llvm-target": "x86_64-unknown-none-gnu",
"data-layout": "e-m:e-i64:64-f80:128-n8:16:32:64-S128",
"arch": "x86_64",
"target-endian": "little",
"target-pointer-width": "64",
"target-c-int-width": "32",
"os": "none",
"linker-flavor": "ld.lld",
"linker": "rust-lld",
"executables": true,
"panic-strategy": "abort"
}
"#,
)
.build();
cargo_build_std(&p, "test --target target.json --no-run -v", "core").run();
}
#[cargo_test]
fn target_proc_macro() {
if !setup() {
return;
}
let p = project()
.file(
"src/lib.rs",
r#"
extern crate proc_macro;
pub fn f() {
let _ts = proc_macro::TokenStream::new();
}
extern crate proc_macro;
pub fn f() {
let _ts = proc_macro::TokenStream::new();
}
"#,
)
.build();
cargo_build_std(&p, "build -v", "std,proc_macro").run();
p.cargo("build -v").build_std().target_host().run();
}
#[cargo_test]
fn bench() {
if !setup() {
return;
}
let p = project()
.file(
"src/lib.rs",
r#"
#![feature(test)]
extern crate test;
#![feature(test)]
extern crate test;
#[bench]
fn b1(b: &mut test::Bencher) {
b.iter(|| ())
}
#[bench]
fn b1(b: &mut test::Bencher) {
b.iter(|| ())
}
"#,
)
.build();
cargo_build_std(&p, "bench -v", "std").run();
p.cargo("bench -v").build_std().target_host().run();
}
#[cargo_test]
fn doc() {
if !setup() {
return;
}
let p = project()
.file(
"src/lib.rs",
r#"
/// Doc
pub fn f() -> Result<(), ()> {Ok(())}
/// Doc
pub fn f() -> Result<(), ()> {Ok(())}
"#,
)
.build();
cargo_build_std(&p, "doc -v", "std").run();
p.cargo("doc -v").build_std().target_host().run();
}
#[cargo_test]
fn check_std() {
if !setup() {
return;
}
let p = project()
.file(
"src/lib.rs",
@ -292,31 +405,112 @@ fn check_std() {
.file(
"tests/t1.rs",
r#"
#[test]
fn t1() {
assert_eq!(1, 2);
}
#[test]
fn t1() {
assert_eq!(1, 2);
}
"#,
)
.build();
cargo_build_std(&p, "check -v --all-targets", "std").run();
cargo_build_std(&p, "check -v --all-targets --profile=test", "std").run();
p.cargo("check -v --all-targets")
.build_std()
.target_host()
.run();
p.cargo("check -v --all-targets --profile=test")
.build_std()
.target_host()
.run();
}
#[cargo_test]
fn doctest() {
if !setup() {
return;
}
let p = project()
.file(
"src/lib.rs",
r#"
/// Doc
/// ```
/// assert_eq!(1, 1);
/// ```
pub fn f() {}
/// Doc
/// ```
/// assert_eq!(1, 1);
/// ```
pub fn f() {}
"#,
)
.build();
cargo_build_std(&p, "test --doc -v", "std").run();
p.cargo("test --doc -v").build_std().target_host().run();
}
// FIXME: set up a dedicated builder to run a full integration test?
// #[cargo_test]
// fn cross_custom() {
// if !setup() {
// return;
// }
// let p = project()
// .file("src/lib.rs", "#![no_std] pub fn f() {}")
// .file(
// "custom-target.json",
// r#"
// {
// "llvm-target": "x86_64-unknown-none-gnu",
// "data-layout": "e-m:e-i64:64-f80:128-n8:16:32:64-S128",
// "arch": "x86_64",
// "target-endian": "little",
// "target-pointer-width": "64",
// "target-c-int-width": "32",
// "os": "none",
// "linker-flavor": "ld.lld"
// }
// "#,
// )
// .build();
//
// p.cargo("build --target custom-target.json -v")
// .build_std()
// .run();
// }
//
// fn custom_test_framework() {
// let p = project()
// .file(
// "src/lib.rs",
// r#"
// #![no_std]
// #![cfg_attr(test, no_main)]
// #![feature(custom_test_frameworks)]
// #![test_runner(crate::test_runner)]
//
// pub fn test_runner(_tests: &[&dyn Fn()]) {}
//
// #[panic_handler]
// fn panic(_info: &core::panic::PanicInfo) -> ! {
// loop {}
// }
// "#,
// )
// .file(
// "target.json",
// r#"
// {
// "llvm-target": "x86_64-unknown-none-gnu",
// "data-layout": "e-m:e-i64:64-f80:128-n8:16:32:64-S128",
// "arch": "x86_64",
// "target-endian": "little",
// "target-pointer-width": "64",
// "target-c-int-width": "32",
// "os": "none",
// "linker-flavor": "ld.lld",
// "linker": "rust-lld",
// "executables": true,
// "panic-strategy": "abort"
// }
// "#,
// )
// .build();
//
// cargo_build_std(&p, "test --target target.json --no-run -v", "core").run();
// }