cargo.nix

{
  lib,
  stdenv,
  pkgsHostHost,
  file,
  curl,
  pkg-config,
  python3,
  openssl,
  cmake,
  zlib,
  installShellFiles,
  makeWrapper,
  rustPlatform,
  rustc,
  auditable ? !cargo-auditable.meta.broken,
  cargo-auditable,
}:

rustPlatform.buildRustPackage.override
  {
    cargo-auditable = cargo-auditable.bootstrap;
  }
  {
    pname = "cargo";
    inherit (rustc.unwrapped) version src;

    # the rust source tarball already has all the dependencies vendored, no need to fetch them again
    cargoVendorDir = "vendor";
    buildAndTestSubdir = "src/tools/cargo";

    inherit auditable;

    passthru = {
      rustc = rustc;
      inherit (rustc.unwrapped) tests;
    };

    # changes hash of vendor directory otherwise
    dontUpdateAutotoolsGnuConfigScripts = true;

    nativeBuildInputs = [
      pkg-config
      cmake
      installShellFiles
      makeWrapper
      (lib.getDev pkgsHostHost.curl)
      zlib
    ];
    buildInputs = [
      file
      curl
      python3
      openssl
      zlib
    ];

    env = {
      # cargo uses git-rs which is made for a version of libgit2 from recent master that
      # is not compatible with the current version in nixpkgs.
      #LIBGIT2_SYS_USE_PKG_CONFIG = 1;

      # fixes: the cargo feature `edition` requires a nightly version of Cargo, but this is the `stable` channel
      RUSTC_BOOTSTRAP = 1;

    }
    // lib.optionalAttrs (stdenv.hostPlatform.rust.rustcTargetSpec == "x86_64-unknown-linux-gnu") {
      # Upstream defaults to lld on x86_64-unknown-linux-gnu, we want to use our linker
      RUSTFLAGS = "-Clinker-features=-lld -Clink-self-contained=-linker";
    };

    postInstall = ''
      wrapProgram "$out/bin/cargo" --suffix PATH : "${rustc}/bin"

      installManPage src/tools/cargo/src/etc/man/*

      installShellCompletion --bash --name cargo \
        src/tools/cargo/src/etc/cargo.bashcomp.sh

      installShellCompletion --zsh src/tools/cargo/src/etc/_cargo
    '';

    checkPhase = ''
      # Disable cross compilation tests
      export CFG_DISABLE_CROSS_TESTS=1
      cargo test
    '';

    # Disable check phase as there are failures (4 tests fail)
    doCheck = false;

    doInstallCheck = !stdenv.hostPlatform.isStatic && stdenv.hostPlatform.isElf;
    installCheckPhase = ''
      runHook preInstallCheck
      ${stdenv.cc.targetPrefix}readelf -a $out/bin/.cargo-wrapped | grep -F 'Shared library: [libcurl.so'
      runHook postInstallCheck
    '';

    meta = {
      homepage = "https://crates.io";
      description = "Downloads your Rust project's dependencies and builds your project";
      mainProgram = "cargo";
      teams = [ lib.teams.rust ];
      license = [
        lib.licenses.mit
        lib.licenses.asl20
      ];
      platforms = lib.platforms.unix;
      # https://github.com/alexcrichton/nghttp2-rs/issues/2
      broken = stdenv.hostPlatform.isx86 && stdenv.buildPlatform != stdenv.hostPlatform;
    };
  }