1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
# If the tests are broken, it's probably for one of two reasons:
#
# 1. The version of llvm used doesn't match the expectations of rustc and/or
# cargo-llvm-cov. This is relatively unlikely because we pull llvm out of
# rustc's attrset, so it *should* be the right version as long as this is the
# case.
# 2. Nixpkgs has changed its rust infrastructure in a way that causes
# cargo-llvm-cov to misbehave under test. It's likely that even though the
# tests are failing, cargo-llvm-cov will still function properly in actual
# use. This has happened before, and is described [here][0] (along with a
# feature request that would fix this instance of the problem).
#
# For previous test-troubleshooting discussion, see [here][1].
#
# [0]: https://github.com/taiki-e/cargo-llvm-cov/issues/242
# [1]: https://github.com/NixOS/nixpkgs/pull/197478
{ stdenv
, lib
, fetchurl
, fetchFromGitHub
, rustPlatform
, rustc
, git
}:
let
pname = "cargo-llvm-cov";
version = "0.6.6";
owner = "taiki-e";
homepage = "https://github.com/${owner}/${pname}";
llvm = rustc.llvmPackages.llvm;
# Download `Cargo.lock` from crates.io so we don't clutter up Nixpkgs
cargoLock = fetchurl {
name = "Cargo.lock";
url = "https://crates.io/api/v1/crates/${pname}/${version}/download";
sha256 = "sha256-kY0Nb7bwF3o6DKQemZSwoZ55vw57jFGftNTpyprFxM0=";
downloadToTemp = true;
postFetch = ''
tar xzf $downloadedFile ${pname}-${version}/Cargo.lock
mv ${pname}-${version}/Cargo.lock $out
'';
};
in
rustPlatform.buildRustPackage {
inherit pname version;
# Use `fetchFromGitHub` instead of `fetchCrate` because the latter does not
# pull in fixtures needed for the test suite
src = fetchFromGitHub {
inherit owner;
repo = pname;
rev = "v${version}";
sha256 = "sha256-lcB/GWEIg5Y+VUSWphNwzmTuFROfMaTm17HyokoKzrI=";
leaveDotGit = true;
};
# Upstream doesn't include the lockfile so we need to add it back
postUnpack = ''
cp ${cargoLock} source/Cargo.lock
'';
cargoSha256 = "sha256-DjWKjq5Vf4wOu6sDPT2yrGB00g80Z59oEpIUvIObjsQ=";
# `cargo-llvm-cov` reads these environment variables to find these binaries,
# which are needed to run the tests
LLVM_COV = "${llvm}/bin/llvm-cov";
LLVM_PROFDATA = "${llvm}/bin/llvm-profdata";
nativeCheckInputs = [
git
];
preCheck = ''
# `cargo-llvm-cov`'s tests rely on `git ls-files` so the staging area needs
# to not have everything staged as deleted, which is how `leaveDotGit` in
# `fetchFromGitHub` leaves the staging area for reproducibility reasons.
git restore --staged .
'';
meta = {
inherit homepage;
changelog = homepage + "/blob/v${version}/CHANGELOG.md";
description = "Cargo subcommand to easily use LLVM source-based code coverage";
longDescription = ''
In order for this to work, you either need to run `rustup component add llvm-
tools-preview` or install the `llvm-tools-preview` component using your Nix
library (e.g. fenix or rust-overlay)
'';
license = with lib.licenses; [ asl20 /* or */ mit ];
maintainers = with lib.maintainers; [ wucke13 matthiasbeyer CobaltCause ];
# The profiler runtime is (currently) disabled on non-Linux platforms
broken = !(stdenv.isLinux && !stdenv.targetPlatform.isRedox);
};
}
|