git.iko.soy/haskell.nix
on e94de40 help sign in
haskell.nix/lib/cover.nix
171 lines 5.7 kB history raw
1{ stdenv, lib, haskellLib, pkgs }:
3# Name of the coverage report, which should be unique
4{ name
5# Library to check coverage of
6, library
7# List of check derivations that generate coverage
8, checks
9# List of other libraries to include in the coverage report. The
10# default value if just the derivation provided as the `library`
11# argument. Use a larger list of libraries if you would like the tests
12# of one local package to generate coverage for another.
13, mixLibraries ? [library]
14# hack for project-less projects
15, ghc ? library.project.pkg-set.config.ghc.package
16}:
18let
19 toBashArray = arr: "(" + (lib.concatStringsSep " " arr) + ")";
21 mixDir = l: "${l}/share/hpc/vanilla/mix/${l.identifier.name}-${l.identifier.version}";
22 mixDirs = map mixDir mixLibraries;
24 srcDirs = map (l: l.src.outPath) mixLibraries;
26in pkgs.runCommand (name + "-coverage-report")
27 ({nativeBuildInputs = [ (ghc.buildGHC or ghc) pkgs.buildPackages.zip ];
28 passthru = {
29 inherit name library checks;
30 };
31 # HPC will fail if the Haskell file contains non-ASCII characters,
32 # unless our locale is set correctly. This has been fixed, but we
33 # don't know what version of HPC we will be using, hence we should
34 # always use the workaround.
35 # https://gitlab.haskell.org/ghc/ghc/-/issues/17073
36 LANG = "en_US.UTF-8";
37 LC_ALL = "en_US.UTF-8";
38 } // lib.optionalAttrs (stdenv.buildPlatform.libc == "glibc") {
39 LOCALE_ARCHIVE = "${pkgs.buildPackages.glibcLocales}/lib/locale/locale-archive";
40 })
41 ''
42 function markup() {
43 local -n srcDs=$1
44 local -n mixDs=$2
45 local -n includedModules=$3
46 local destDir=$4
47 local tixFile=$5
49 local hpcMarkupCmd=("hpc" "markup" "--destdir=$destDir")
50 for srcDir in "''${srcDs[@]}"; do
51 hpcMarkupCmd+=("--srcdir=$srcDir")
52 done
54 for mixDir in "''${mixDs[@]}"; do
55 hpcMarkupCmd+=("--hpcdir=$mixDir")
56 done
58 for module in "''${includedModules[@]}"; do
59 hpcMarkupCmd+=("--include=$module")
60 done
62 hpcMarkupCmd+=("$tixFile")
64 echo "''${hpcMarkupCmd[@]}"
65 eval "''${hpcMarkupCmd[@]}"
66 }
68 function sumTix() {
69 local -n includedModules=$1
70 local -n tixFs=$2
71 local outFile="$3"
73 local hpcSumCmd=("hpc" "sum" "--union" "--output=$outFile")
75 for module in "''${includedModules[@]}"; do
76 hpcSumCmd+=("--include=$module")
77 done
79 for tixFile in "''${tixFs[@]}"; do
80 hpcSumCmd+=("$tixFile")
81 done
83 echo "''${hpcSumCmd[@]}"
84 eval "''${hpcSumCmd[@]}"
85 }
87 function findModules() {
88 local searchDir=$2
89 local pattern=$3
91 pushd $searchDir
92 mapfile -d $'\0' $1 < <(find ./ -type f \
93 -wholename "$pattern" -not -name "Paths*" \
94 -exec basename {} \; \
95 | sed "s/\.mix$//" \
96 | tr "\n" "\0")
97 popd
98 }
100 local mixDirs=${toBashArray mixDirs}
102 mkdir -p $out/nix-support
103 mkdir -p $out/share/hpc/vanilla/mix/${name}
104 mkdir -p $out/share/hpc/vanilla/tix/${name}
105 mkdir -p $out/share/hpc/vanilla/html/${name}
107 # Copy over mix files verbatim
108 for dir in "''${mixDirs[@]}"; do
109 if [ -d "$dir" ]; then
110 cp -R "$dir"/* $out/share/hpc/vanilla/mix/${name}
111 fi
112 done
114 local srcDirs=${toBashArray srcDirs}
115 local allMixModules=()
116 local pkgMixModules=()
118 # The behaviour of stack coverage reports is to provide tix files
119 # that include coverage information for every local package, but
120 # to provide HTML reports that only include coverage info for the
121 # current package. We emulate the same behaviour here. If the user
122 # includes all local packages in the mix libraries argument, they
123 # will get a coverage report very similar to stack.
125 # All mix modules
126 findModules allMixModules "$out/share/hpc/vanilla/mix/${name}" "*.mix"
127 # Only mix modules corresponding to this package
128 findModules pkgMixModules "$out/share/hpc/vanilla/mix/${name}" "*${name}*/*.mix"
130 # For each test
131 local tixFiles=()
132 ${lib.concatStringsSep "\n" (builtins.map (check: ''
133 if [ -d "${check}/share/hpc/vanilla/tix" ]; then
134 pushd ${check}/share/hpc/vanilla/tix
136 tixFile="$(find . -iwholename "*.tix" -type f -print -quit)"
137 local newTixFile=$out/share/hpc/vanilla/tix/${name}/"$tixFile"
139 mkdir -p "$(dirname $newTixFile)"
140 # Copy over the tix file verbatim
141 cp "$tixFile" "$newTixFile"
143 # Add the tix file to our list
144 tixFiles+=("$newTixFile")
146 # Create a coverage report for *just that test*
147 markup srcDirs mixDirs pkgMixModules "$out/share/hpc/vanilla/html/${name}/${check.exeName}/" "$newTixFile"
149 popd
150 fi
151 '') checks)
152 }
154 # Sum tix files to create a tix file with all relevant tix
155 # information and markup a HTML report from this info.
156 if (( "''${#tixFiles[@]}" > 0 )); then
157 local sumTixFile="$out/share/hpc/vanilla/tix/${name}/${name}.tix"
158 local markupOutDir="$out/share/hpc/vanilla/html/${name}"
160 # Sum all of our tix file, including modules from any local package
161 sumTix allMixModules tixFiles "$sumTixFile"
163 # Markup a HTML report, included modules from only this package
164 markup srcDirs mixDirs pkgMixModules "$markupOutDir" "$sumTixFile"
166 # Provide a HTML zipfile and Hydra links
167 ( cd "$markupOutDir" ; zip -r $out/share/hpc/vanilla/${name}-html.zip . )
168 echo "report coverage $markupOutDir/hpc_index.html" >> $out/nix-support/hydra-build-products
169 echo "file zip $out/share/hpc/vanilla/${name}-html.zip" >> $out/nix-support/hydra-build-products
170 fi
171 ''