rustPlatform: add buildAndTestSubdir-argument

There are several tarballs (such as the `rust-lang/rust`-source) with a
`Cargo.toml` at root and several sub-packages (with their own Cargo.toml)
without using workspaces[1].

In such a case it's needed to move into a subdir to only build the
specified sub-package (e.g. `rustfmt` or `rsl`), however the artifacts
are at `/target` in the root-dir of the build environment. This breaks
the build since `buildRustPackage` searches for executables in `target`
(which is at the build-env's root) at the end of the `buildPhase`.

With the optional `buildAndTestSubdir`-argument, the builder moves into
the specified subdir using `pushd`/`popd` during `buildPhase` and
`checkPhase`.

Also moved the logic to find executables and libs to the end of the `buildPhase`
from a custom `postBuild`-hook to fix packages with custom `build`/`install`-procedures
such as `uutils-coreutils`.

[1] https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html
This commit is contained in:
Maximilian Bosch 2020-05-13 01:28:24 +02:00
parent 736462d995
commit 6b23cfe689
No known key found for this signature in database
GPG key ID: 091DBF4D1FC46B8E
6 changed files with 16 additions and 20 deletions

View file

@ -29,6 +29,12 @@
, target ? null
, cargoVendorDir ? null
, checkType ? buildType
# Needed to `pushd`/`popd` into a subdir of a tarball if this subdir
# contains a Cargo.toml, but isn't part of a workspace (which is e.g. the
# case for `rustfmt`/etc from the `rust-sources).
# Otherwise, everything from the tarball would've been built/tested.
, buildAndTestSubdir ? null
, ... } @ args:
assert cargoVendorDir == null -> cargoSha256 != "unset";
@ -162,6 +168,7 @@ stdenv.mkDerivation (args // {
'';
buildPhase = with builtins; args.buildPhase or ''
${stdenv.lib.optionalString (buildAndTestSubdir != null) "pushd ${buildAndTestSubdir}"}
runHook preBuild
(
@ -178,9 +185,8 @@ stdenv.mkDerivation (args // {
)
runHook postBuild
'';
postBuild = args.postBuild or "" + ''
${stdenv.lib.optionalString (buildAndTestSubdir != null) "popd"}
# This needs to be done after postBuild: packages like `cargo` do a pushd/popd in
# the pre/postBuild-hooks that need to be taken into account before gathering
@ -194,10 +200,12 @@ stdenv.mkDerivation (args // {
checkPhase = args.checkPhase or (let
argstr = "${stdenv.lib.optionalString (checkType == "release") "--release"} --target ${rustTarget} --frozen";
in ''
${stdenv.lib.optionalString (buildAndTestSubdir != null) "pushd ${buildAndTestSubdir}"}
runHook preCheck
echo "Running cargo test ${argstr} -- ''${checkFlags} ''${checkFlagsArray+''${checkFlagsArray[@]}}"
cargo test ${argstr} -- ''${checkFlags} ''${checkFlagsArray+"''${checkFlagsArray[@]}"}
runHook postCheck
${stdenv.lib.optionalString (buildAndTestSubdir != null) "popd"}
'');
doCheck = args.doCheck or true;

View file

@ -9,8 +9,7 @@ rustPlatform.buildRustPackage {
# the rust source tarball already has all the dependencies vendored, no need to fetch them again
cargoVendorDir = "vendor";
preBuild = "pushd src/tools/cargo";
postBuild = "popd";
buildAndTestSubdir = "src/tools/cargo";
passthru.rustc = rustc;

View file

@ -5,8 +5,7 @@ rustPlatform.buildRustPackage {
# the rust source tarball already has all the dependencies vendored, no need to fetch them again
cargoVendorDir = "vendor";
preBuild = "pushd src/tools/clippy";
postBuild = "popd";
buildAndTestSubdir = "src/tools/clippy";
# changes hash of vendor directory otherwise
dontUpdateAutotoolsGnuConfigScripts = true;

View file

@ -10,8 +10,9 @@ rustPlatform.buildRustPackage {
dontUpdateAutotoolsGnuConfigScripts = true;
cargoVendorDir = "vendor";
buildAndTestSubdir = "src/tools/rls";
preBuild = ''
pushd src/tools/rls
# client tests are flaky
rm tests/client.rs
'';
@ -28,8 +29,6 @@ rustPlatform.buildRustPackage {
doCheck = true;
preInstall = "popd";
doInstallCheck = true;
installCheckPhase = ''
$out/bin/rls --version

View file

@ -6,8 +6,7 @@ rustPlatform.buildRustPackage rec {
# the rust source tarball already has all the dependencies vendored, no need to fetch them again
cargoVendorDir = "vendor";
preBuild = "pushd src/tools/rustfmt";
preInstall = "popd";
buildAndTestSubdir = "src/tools/rustfmt";
# changes hash of vendor directory otherwise
dontUpdateAutotoolsGnuConfigScripts = true;
@ -17,12 +16,6 @@ rustPlatform.buildRustPackage rec {
# As of 1.0.0 and rustc 1.30 rustfmt requires a nightly compiler
RUSTC_BOOTSTRAP = 1;
# we run tests in debug mode so tests look for a debug build of
# rustfmt. Anyway this adds nearly no compilation time.
preCheck = ''
cargo build
'';
meta = with stdenv.lib; {
description = "A tool for formatting Rust code according to style guidelines";
homepage = "https://github.com/rust-lang-nursery/rustfmt";

View file

@ -15,9 +15,7 @@ rustPlatform.buildRustPackage {
inherit rev sha256;
};
preBuild = "pushd crates/rust-analyzer";
# Do not checking other crates in checkPhase.
preInstall = "popd";
buildAndTestSubdir = "crates/rust-analyzer";
cargoBuildFlags = lib.optional useJemalloc "--features=jemalloc";