ilyakooo0/haskell.nix
1
0
Fork 0
mirror of https://github.com/ilyakooo0/haskell.nix.git synced 2024-11-10 15:19:01 +03:00
Code Issues Projects Releases Wiki Activity
13164ac0d8
haskell.nix/lib/cover-project.nix

154 lines
4.5 KiB
Nix
Raw Normal View History

Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
# A project coverage report is a composition of package coverage
# reports
{ stdenv, pkgs, lib, haskellLib }:
Coverage: allow projects with no libraries (#962) * Coverage: allow projects with no libraries - Prevent projects without a library from breaking the coverage report generators. - Added a test to ensure projects without libraries can build coverage reports. * Ensure the correct GHC version is used in project coverage reports - Previously, when trying to determine the version of GHC to use for a project coverage report, we would attempt to find the version of GHC used in the constituent coverage reports, or default to the GHC that is shipped with Nixpkgs. Using the GHC that ships with Nixpkgs is problematic (specifically the coverage-no-libs tests fail to run on Hydra), so we now ask the user to pass in the project to the "projectCoverageReport" function so we can find the correct version of GHC to use in a foolproof manner.
2020-12-10 10:47:57 +03:00
# haskell.nix project
project:
Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
# List of coverage reports to accumulate
coverageReports:
let
toBashArray = arr: "(" + (lib.concatStringsSep " " arr) + ")";
# Create table rows for a project coverage index page that look something like:
#
# | Package |
# |------------------|
# | cardano-shell |
# | cardano-launcher |
coverageTableRows = coverageReport:
''
<tr>
<td>
<a href="${coverageReport.passthru.name}/hpc_index.html">${coverageReport.passthru.name}</href>
</td>
</tr>
'';
projectIndexHtml = pkgs.writeText "index.html" ''
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table border="1" width="100%">
<tbody>
<tr>
<th>Report</th>
</tr>
${with lib; concatStringsSep "\n" (map coverageTableRows coverageReports)}
</tbody>
</table>
</body>
</html>
'';
Coverage: allow projects with no libraries (#962) * Coverage: allow projects with no libraries - Prevent projects without a library from breaking the coverage report generators. - Added a test to ensure projects without libraries can build coverage reports. * Ensure the correct GHC version is used in project coverage reports - Previously, when trying to determine the version of GHC to use for a project coverage report, we would attempt to find the version of GHC used in the constituent coverage reports, or default to the GHC that is shipped with Nixpkgs. Using the GHC that ships with Nixpkgs is problematic (specifically the coverage-no-libs tests fail to run on Hydra), so we now ask the user to pass in the project to the "projectCoverageReport" function so we can find the correct version of GHC to use in a foolproof manner.
2020-12-10 10:47:57 +03:00
ghc = project.pkg-set.config.ghc.package;
Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
Coverage: allow projects with no libraries (#962) * Coverage: allow projects with no libraries - Prevent projects without a library from breaking the coverage report generators. - Added a test to ensure projects without libraries can build coverage reports. * Ensure the correct GHC version is used in project coverage reports - Previously, when trying to determine the version of GHC to use for a project coverage report, we would attempt to find the version of GHC used in the constituent coverage reports, or default to the GHC that is shipped with Nixpkgs. Using the GHC that ships with Nixpkgs is problematic (specifically the coverage-no-libs tests fail to run on Hydra), so we now ask the user to pass in the project to the "projectCoverageReport" function so we can find the correct version of GHC to use in a foolproof manner.
2020-12-10 10:47:57 +03:00
libs = lib.remove null (map (r: r.library) coverageReports);
Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
mixDirs =
map
(l: "${l}/share/hpc/vanilla/mix/${l.identifier.name}-${l.identifier.version}")
Coverage: allow projects with no libraries (#962) * Coverage: allow projects with no libraries - Prevent projects without a library from breaking the coverage report generators. - Added a test to ensure projects without libraries can build coverage reports. * Ensure the correct GHC version is used in project coverage reports - Previously, when trying to determine the version of GHC to use for a project coverage report, we would attempt to find the version of GHC used in the constituent coverage reports, or default to the GHC that is shipped with Nixpkgs. Using the GHC that ships with Nixpkgs is problematic (specifically the coverage-no-libs tests fail to run on Hydra), so we now ask the user to pass in the project to the "projectCoverageReport" function so we can find the correct version of GHC to use in a foolproof manner.
2020-12-10 10:47:57 +03:00
libs;
Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
Support githash package and cross package refs (#843) * Adds support for cross package refs (with a project). Relative directory references between packages within a project should now work. * Adds `includeSiblings` to `cleanSourceWith`. When `true` it prevents the `subDir` arg from causing filtering of other directories. * Adds `keepGitDir` to `cleanGit` to allow `.git` directory to be kept (useful for components that use the `githash` package).
2021-01-14 02:34:06 +03:00
srcDirs = map (l: l.srcSubDirPath) libs;
Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
in pkgs.runCommand "project-coverage-report"
Fix hpc for cross-compiled builds (#862) * Add Hydra build products for test coverage reports (HTML links and zip files) * Fix hpc on cross builds
2020-10-06 06:29:57 +03:00
({ nativeBuildInputs = [ (ghc.buildGHC or ghc) pkgs.buildPackages.zip ];
LANG = "en_US.UTF-8";
LC_ALL = "en_US.UTF-8";
Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
} // lib.optionalAttrs (stdenv.buildPlatform.libc == "glibc") {
LOCALE_ARCHIVE = "${pkgs.buildPackages.glibcLocales}/lib/locale/locale-archive";
})
''
function markup() {
local -n srcDs=$1
local -n mixDs=$2
local -n includedModules=$3
local destDir=$4
local tixFile=$5
local hpcMarkupCmd=("hpc" "markup" "--destdir=$destDir")
for srcDir in "''${srcDs[@]}"; do
hpcMarkupCmd+=("--srcdir=$srcDir")
done
for mixDir in "''${mixDs[@]}"; do
hpcMarkupCmd+=("--hpcdir=$mixDir")
done
for module in "''${includedModules[@]}"; do
hpcMarkupCmd+=("--include=$module")
done
hpcMarkupCmd+=("$tixFile")
echo "''${hpcMarkupCmd[@]}"
eval "''${hpcMarkupCmd[@]}"
}
function findModules() {
local searchDir=$2
local pattern=$3
pushd $searchDir
mapfile -d $'\0' $1 < <(find ./ -type f \
-wholename "$pattern" -not -name "Paths*" \
-exec basename {} \; \
| sed "s/\.mix$//" \
| tr "\n" "\0")
popd
}
Fix hpc for cross-compiled builds (#862) * Add Hydra build products for test coverage reports (HTML links and zip files) * Fix hpc on cross builds
2020-10-06 06:29:57 +03:00
mkdir -p $out/nix-support
Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
mkdir -p $out/share/hpc/vanilla/tix/all
mkdir -p $out/share/hpc/vanilla/mix/
mkdir -p $out/share/hpc/vanilla/html/
# Find all tix files in each package
tixFiles=()
${with lib; concatStringsSep "\n" (map (coverageReport: ''
identifier="${coverageReport.name}"
report=${coverageReport}
tix="$report/share/hpc/vanilla/tix/$identifier/$identifier.tix"
if test -f "$tix"; then
tixFiles+=("$tix")
fi
# Copy mix, tix, and html information over from each report
Coverage: allow projects with no libraries (#962) * Coverage: allow projects with no libraries - Prevent projects without a library from breaking the coverage report generators. - Added a test to ensure projects without libraries can build coverage reports. * Ensure the correct GHC version is used in project coverage reports - Previously, when trying to determine the version of GHC to use for a project coverage report, we would attempt to find the version of GHC used in the constituent coverage reports, or default to the GHC that is shipped with Nixpkgs. Using the GHC that ships with Nixpkgs is problematic (specifically the coverage-no-libs tests fail to run on Hydra), so we now ask the user to pass in the project to the "projectCoverageReport" function so we can find the correct version of GHC to use in a foolproof manner.
2020-12-10 10:47:57 +03:00
cp -Rn $report/share/hpc/vanilla/mix/$identifier $out/share/hpc/vanilla/mix/
Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
cp -R $report/share/hpc/vanilla/tix/* $out/share/hpc/vanilla/tix/
cp -R $report/share/hpc/vanilla/html/* $out/share/hpc/vanilla/html/
'') coverageReports)}
if [ ''${#tixFiles[@]} -ne 0 ]; then
# Create tix file with test run information for all packages
tixFile="$out/share/hpc/vanilla/tix/all/all.tix"
hpcSumCmd=("hpc" "sum" "--union" "--output=$tixFile")
hpcSumCmd+=("''${tixFiles[@]}")
echo "''${hpcSumCmd[@]}"
eval "''${hpcSumCmd[@]}"
# Markup a HTML coverage report for the entire project
cp ${projectIndexHtml} $out/share/hpc/vanilla/html/index.html
Fix hpc for cross-compiled builds (#862) * Add Hydra build products for test coverage reports (HTML links and zip files) * Fix hpc on cross builds
2020-10-06 06:29:57 +03:00
echo "report coverage-per-package $out/share/hpc/vanilla/html/index.html" >> $out/nix-support/hydra-build-products
Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
local markupOutDir="$out/share/hpc/vanilla/html/all"
local srcDirs=${toBashArray srcDirs}
local mixDirs=${toBashArray mixDirs}
local allMixModules=()
mkdir $markupOutDir
findModules allMixModules "$out/share/hpc/vanilla/mix/" "*.mix"
markup srcDirs mixDirs allMixModules "$markupOutDir" "$tixFile"
Fix hpc for cross-compiled builds (#862) * Add Hydra build products for test coverage reports (HTML links and zip files) * Fix hpc on cross builds
2020-10-06 06:29:57 +03:00
echo "report coverage $markupOutDir/hpc_index.html" >> $out/nix-support/hydra-build-products
( cd $out/share/hpc/vanilla/html ; zip -r $out/share/hpc/vanilla/html.zip . )
echo "file zip $out/share/hpc/vanilla/html.zip" >> $out/nix-support/hydra-build-products
Add support for coverage (#762) - Added the ability to generate coverage reports for packages and projects. - Outputs mix and tix information, as well as a HTML report. - Added the "doCoverage" module option that allows users to choose packages to enable coverage for. - Added a "doCoverage" flag to the component builder that outputs HPC information when coverage is enabled. - Added the "overrideModules" library function to make it more ergonomic fo users to enable coverage on existing projects. - Modified the "check" builder to also output ".tix" files (if they exist). This information is required to generate the coverage report. - Added a test for coverage.
2020-09-29 06:56:24 +03:00
fi
''
Reference in New Issue Copy Permalink