Rename coverageReport/coverageReport'

sevanspowell · sevanspowell · commit 7efa4830c291 · 2020-09-07T12:52:36.000+08:00
diff --git a/docs/tutorials/coverage.md b/docs/tutorials/coverage.md
@@ -36,7 +36,7 @@ in {
 ## Per-package
 
 ```bash
-nix-build default.nix -A "projectWithCoverage.$pkg.coverageReport'"
+nix-build default.nix -A "projectWithCoverage.$pkg.coverageReport"
 ```
 
 This will generate a coverage report for the package you requested. By
@@ -48,7 +48,7 @@ See the [developer coverage docs](../dev/coverage.md#package-reports) for more i
 ## Project-wide
 
 ```bash
-nix-build default.nix -A "projectWithCoverage.projectCoverageReport'"
+nix-build default.nix -A "projectWithCoverage.projectCoverageReport"
 ```
 
 This will generate a coverage report for all the local packages in
@@ -58,8 +58,8 @@ See the [developer coverage docs](../dev/coverage.md#project-wide-reports) for m
 
 ## Custom
 
-By default, `projectCoverageReport'` generates a coverage report
-including all the packages in your project, and `coverageReport'`
+By default, `projectCoverageReport` generates a coverage report
+including all the packages in your project, and `coverageReport`
 generates a report for the library and all enabled tests in the
 requested package. You can modify what is included in each report by
 using the `coverageReport` and `projectCoverageReport` functions.
@@ -85,14 +85,14 @@ let
 
   # Choose the library and tests you want included in the coverage
   # report for a package.
-  custom$pkgCoverageReport = haskellLib.coverageReport {
+  custom$pkgCoverageReport = haskellLib.coverageReport' {
     inherit (projectWithCoverage.$pkg.identifier) name version;
     inherit (projectWithCoverage.$pkg.components) library tests;
   };
 
   # Override the coverage report for a package, and also choose which
   # packages you want included in the coverage report.
-  customProjectCoverageReport = haskellLib.projectCoverageReport {
+  customProjectCoverageReport = haskellLib.projectCoverageReport' {
     packages                = haskellLib.selectProjectPackages projectWithCoverage;
     coverageReportOverrides = { "${projectWithCoverage.$pkg.identifier.name}" = custom$pkgCoverageReport; };
   };
diff --git a/lib/cover-project.nix b/lib/cover-project.nix
@@ -6,45 +6,27 @@
 }:
 
 let
-  getPackageCoverageReport = packageName: (coverageReportOverrides."${packageName}" or packages."${packageName}".coverageReport');
+  getPackageCoverageReport = packageName: (coverageReportOverrides."${packageName}" or packages."${packageName}".coverageReport);
 
   # Create table rows for an project coverage index page that look something like:
   #
-  # | Package          | TestSuite |
-  # |------------------+-----------|
-  # | cardano-shell    | test-1    |
-  # |                  | test-2    |
-  # | cardano-launcher | test-1    |
-  # |                  | test-2    |
-  #
-  # The logic is a little complex to ensure that only the first test
-  # is listed alongside the package, the second test is accompanied by
-  # a blank 'Package' entry.
+  # | Package          |
+  # |------------------|
+  # | cardano-shell    |
+  # | cardano-launcher |
   packageTableRows = package: with lib;
     let
       testsOnly = filterAttrs (n: d: isDerivation d) package.components.tests;
       testNames = mapAttrsToList (testName: _: testName) testsOnly;
-      firstPosition = 1;
-      positions = range firstPosition (length testNames);
-      testNamesWithPosition = zipLists positions testNames;
-      isFirst = pos: pos == firstPosition;
     in
-      concatStringsSep "\n" (map (tuple:
-        let
-          pos = tuple.fst;
-          testName = tuple.snd;
-        in ''
+      concatStringsSep "\n" (map (testName:
+      ''
       <tr>
         <td>
-          ${if isFirst pos then ''
           <a href="${package.identifier.name}-${package.identifier.version}/hpc_index.html">${package.identifier.name}</href>
-          '' else ""} 
-        </td>
-        <td>
-          <a href="${testName}/hpc_index.html">${testName}</a>
         </td>
       </tr>
-    '') testNamesWithPosition);
+      '') testNames);
 
   projectIndexHtml = pkgs.writeText "index.html" ''
   <html>
@@ -56,7 +38,6 @@ let
         <tbody>
           <tr>
             <th>Package</th>
-            <th>TestSuite</th>
           </tr>
 
           ${with lib; concatStringsSep "\n" (mapAttrsToList (_ : packageTableRows) packages)}
@@ -73,11 +54,8 @@ in pkgs.runCommand "project-coverage-report"
     mkdir -p $out/share/hpc/vanilla/mix/
     mkdir -p $out/share/hpc/vanilla/html/
 
-    # 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")
+    # Find all tix files in each package
     tixFiles=()
-
     ${with lib; concatStringsSep "\n" (mapAttrsToList (n: package: ''
       identifier="${package.identifier.name}-${package.identifier.version}"
       report=${getPackageCoverageReport n}
@@ -93,10 +71,14 @@ in pkgs.runCommand "project-coverage-report"
     '') packages)}
 
     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
     fi
   ''
diff --git a/lib/default.nix b/lib/default.nix
@@ -240,12 +240,12 @@ in {
   };
 
   # Do coverage of a package
-  coverageReport = import ./cover.nix {
+  coverageReport' = import ./cover.nix {
     inherit lib haskellLib pkgs;
   };
 
   # Do coverage of a project
-  projectCoverageReport = import ./cover-project.nix {
+  projectCoverageReport' = import ./cover-project.nix {
     inherit lib haskellLib pkgs;
   };
 
diff --git a/overlays/haskell.nix b/overlays/haskell.nix
@@ -480,7 +480,7 @@ final: prev: {
                   inherit (callProjectResults) index-state;
                 };
             in project // {
-              projectCoverageReport' = haskellLib.projectCoverageReport { packages = haskellLib.selectProjectPackages project.hsPkgs; };
+              projectCoverageReport = haskellLib.projectCoverageReport' { packages = haskellLib.selectProjectPackages project.hsPkgs; };
               overrideModules = f: cabalProject' (args // { modules = f args.modules; });
             };
 
@@ -504,7 +504,7 @@ final: prev: {
                       ) package'.components;
                       inherit project;
 
-                      coverageReport' = haskellLib.coverageReport {
+                      coverageReport = haskellLib.coverageReport' {
                         inherit (package.identifier) name version;
                         inherit (components) library;
                         tests = final.lib.filterAttrs (_: d: d.config.doCheck) components.tests;
@@ -519,7 +519,7 @@ final: prev: {
 
         cabalProject = args: let p = cabalProject' args;
             in p.hsPkgs // {
-              inherit (p) plan-nix projectCoverageReport' overrideModules;
+              inherit (p) plan-nix projectCoverageReport overrideModules;
               # Provide `nix-shell -A shells.ghc` for users migrating from the reflex-platform.
               # But we should encourage use of `nix-shell -A shellFor`
               shells.ghc = p.hsPkgs.shellFor {};
@@ -543,13 +543,13 @@ final: prev: {
                   stack-nix = callProjectResults.projectNix;
                 };
             in project // {
-              projectCoverageReport' = haskellLib.projectCoverageReport { packages = haskellLib.selectProjectPackages project.hsPkgs; };
+              projectCoverageReport = haskellLib.projectCoverageReport' { packages = haskellLib.selectProjectPackages project.hsPkgs; };
               overrideModules = f: stackProject' (args // { modules = f args.modules; });
             };
 
         stackProject = args: let p = stackProject' args;
             in p.hsPkgs // {
-              inherit (p) stack-nix projectCoverageReport' overrideModules;
+              inherit (p) stack-nix projectCoverageReport overrideModules;
               # Provide `nix-shell -A shells.ghc` for users migrating from the reflex-platform.
               # But we should encourage use of `nix-shell -A shellFor`
               shells.ghc = p.hsPkgs.shellFor {};
diff --git a/test/coverage/default.nix b/test/coverage/default.nix
@@ -76,12 +76,12 @@ in recurseIntoAttrs ({
       }
 
       ${concatStringsSep "\n" (map (project: ''
-        pkga_basedir="${project.hsPkgs.pkga.coverageReport'}/share/hpc/"
+        pkga_basedir="${project.hsPkgs.pkga.coverageReport}/share/hpc/"
         findFileExistsNonEmpty "$pkga_basedir/mix/pkga-0.1.0.0/" "PkgA.mix"
         dirExistsEmpty "$pkga_basedir/tix/pkga-0.1.0.0"
         dirExistsEmpty "$pkga_basedir/html/pkga-0.1.0.0"
   
-        pkgb_basedir="${project.hsPkgs.pkgb.coverageReport'}/share/hpc/"
+        pkgb_basedir="${project.hsPkgs.pkgb.coverageReport}/share/hpc/"
         testTix="$pkgb_basedir/tix/tests/tests.tix"
         libTix="$pkgb_basedir/tix/pkgb-0.1.0.0/pkgb-0.1.0.0.tix"
         fileExistsNonEmpty "$testTix"
@@ -99,7 +99,7 @@ in recurseIntoAttrs ({
           exit 1
         fi
 
-        project_basedir="${project.projectCoverageReport'}/share/hpc/"
+        project_basedir="${project.projectCoverageReport}/share/hpc/"
         fileExistsNonEmpty "$project_basedir/html/index.html"
         fileExistsNonEmpty "$project_basedir/tix/all/all.tix"
         dirExists "$project_basedir/html/pkga-0.1.0.0"
