[llvm-cov] Add a project coverage summary above the index page.

[MaggieYi]

Summary

Currently, the project coverage summary is given in the bottom row of the index table. If there are a large number of source files listed in the index table, the summary row is not immediately visible. This patch adds the project coverage summary above the index page to improve the report readability. I have also added the project directory to the summary.

In addition, filenames are only shown as a part of path name in the filename column of the index page. If the file path includes many directory levels, this column doesnÎéÎ÷t look nice. This patch separates the filename and path into two columns, and the path is shown the relative to the project directory specified in the summary, which also improves clarity.

[vsk]

Currently, the project coverage summary is given in the bottom row of the index table. If there are a large number of source files listed in the index table, the summary row is not immediately visible. This patch adds the project coverage summary above the index page to improve the report readability.

I'd prefer to just tackle this issue in this patch. IMO it would be better to drop (or at least defer) the other changes.

I have also added the project directory to the summary.

I don't think this clarifies anything, and would prefer not to add it.

In addition, filenames are only shown as a part of path name in the filename column of the index page. If the file path includes many directory levels, this column doesnÎéÎ÷t look nice.

This is intentional and it matches the behavior of the text reports. The longest-common prefix of the path names are stripped away to make it easier to see the filename. This prefix is visually distracting and doesn't convey any useful information.

[MaggieYi]

In D24687#546833, @vsk wrote:

I'd prefer to just tackle this issue in this patch. IMO it would be better to drop (or at least defer) the other changes.

Ok, I have updated the patch following your advice.

This is intentional and it matches the behavior of the text reports. The longest-common prefix of the path names are stripped away to make it easier to see the filename. This prefix is visually distracting and doesn't convey any useful information.

If the project is branched, the longest-common prefix of the path (I called the project directory) will show the branch name. The project directory will tell the user where the source code come from.

[vsk]

If the project is branched, the longest-common prefix of the path (I called the project directory) will show the branch name. The project directory will tell the user where the source code come from.

It would be easier for me to understand the motivation behind this if you could upload an example report with your changes. I still don't understand what it is about the current scheme that makes it difficult for readers to figure out where some source file comes from.

tools/llvm-cov/SourceCoverageViewHTML.cpp

431

This patch still seems larger than it needs to be. Can't we get the entire desired functional change by just inserting another emitFileSummary(OSRef, "Totals", Totals, /*IsTotals=*/true) here?

test/tools/llvm-cov/Inputs/showProjectSummary.test

 TEXT-TITLE: Test Suite
 TEXT-NOT: Coverage Report
 TEXT-NOT: Created:
 TEXT-FILE-NOT: (Binary: showProjectSummary.covmapping)
 TEXT-FUNCTION: main:
 TEXT-FOOTER: Generated by llvm-cov
 
 HTML-TITLE: <h1>Test Suite</h1>
 HTML: <h2>Coverage Report</h2>
 HTML: <h4>Created:{{.*}}</h4>
+HTML-TOTAL: <td class='column-entry'>Function Coverage:</td>
+HTML-TOTAL: <td class='column-entry'>Instantiation Coverage:</td>
+HTML-TOTAL: <td class='column-entry'>Line Coverage:</td>
+HTML-TOTAL: <td class='column-entry'>Region Coverage:</td>
 HTML-FILE: <pre>{{.*}}showProjectSummary.cpp (Binary: showProjectSummary.covmapping)</pre>
 HTML-FUNCTION: <pre>main</pre>
 HTML-HEADER: <td><pre>Line</pre></td>
 HTML-HEADER: <td><pre>Count</pre></td>
 HTML-HEADER: <td><pre>Source (<a href='#L8'>jump to first uncovered line</a>)</pre></td>
 HTML-FOOTER: <h5>Generated by llvm-cov{{.*}}</h5>

test/tools/llvm-cov/showProjectSummary.cpp

 // RUN: llvm-cov show %S/Inputs/showProjectSummary.covmapping -instr-profile=%t.profdata -o %t.dir -filename-equivalence %s
 // RUN: FileCheck -check-prefixes=TEXT-FOOTER -input-file=%t.dir/index.txt %S/Inputs/showProjectSummary.test
 
 // Test html output.
 // RUN: llvm-cov show %S/Inputs/showProjectSummary.covmapping -format=html -o %t.dir -instr-profile %t.profdata -filename-equivalence %s
 // RUN: FileCheck -check-prefixes=HTML,HTML-FILE,HTML-HEADER -input-file %t.dir/coverage/tmp/showProjectSummary.cpp.html %S/Inputs/showProjectSummary.test
 // RUN: llvm-cov show %S/Inputs/showProjectSummary.covmapping -format=html -o %t.dir -instr-profile %t.profdata -project-title "Test Suite" -filename-equivalence %s
 // RUN: FileCheck -check-prefixes=HTML-TITLE,HTML,HTML-FILE,HTML-HEADER -input-file %t.dir/coverage/tmp/showProjectSummary.cpp.html %S/Inputs/showProjectSummary.test
-// RUN: FileCheck -check-prefixes=HTML-TITLE,HTML,HTML-FOOTER -input-file %t.dir/index.html %S/Inputs/showProjectSummary.test
+// RUN: FileCheck -check-prefixes=HTML-TITLE,HTML,HTML-TOTAL,HTML-FOOTER -input-file %t.dir/index.html %S/Inputs/showProjectSummary.test
 // RUN: llvm-cov show %S/Inputs/showProjectSummary.covmapping -format=html -o %t.dir -instr-profile %t.profdata  -project-title "Test Suite" -filename-equivalence -name=main %s
 // RUN: FileCheck -check-prefixes=HTML-FUNCTION,HTML-HEADER -input-file %t.dir/functions.html %S/Inputs/showProjectSummary.test

tools/llvm-cov/SourceCoverageViewHTML.h

public:
 
   CoveragePrinterHTML(const CoverageViewOptions &Opts)
       : CoveragePrinter(Opts) {}
 
 private:
   void emitFileSummary(raw_ostream &OS, StringRef SF,
                        const FileCoverageSummary &FCS,
                        bool IsTotals = false) const;
+
+  void emitProjectSummary(raw_ostream &OS,
+                          const FileCoverageSummary &PCS) const;
 };
 
 /// \brief A code coverage view which supports html-based rendering.
 class SourceCoverageViewHTML : public SourceCoverageView {
   void renderViewHeader(raw_ostream &OS) override;
 
   void renderViewFooter(raw_ostream &OS) override;
 

tools/llvm-cov/SourceCoverageViewHTML.cpp

static void emitColumnLabelsForIndex(raw_ostream &OS) {
   SmallVector<std::string, 4> Columns;
   Columns.emplace_back(tag("td", "Filename", "column-entry-left"));
   for (const char *Label : {"Function Coverage", "Instantiation Coverage",
                             "Line Coverage", "Region Coverage"})
     Columns.emplace_back(tag("td", Label, "column-entry"));
   OS << tag("tr", join(Columns.begin(), Columns.end(), ""));
 }
 
-/// Render a file coverage summary (\p FCS) in a table row. If \p IsTotals is
-/// false, link the summary to \p SF.
-void CoveragePrinterHTML::emitFileSummary(raw_ostream &OS, StringRef SF,
-                                          const FileCoverageSummary &FCS,
-                                          bool IsTotals) const {
-  SmallVector<std::string, 4> Columns;
-
-  // Format a coverage triple and add the result to the list of columns.
-  auto AddCoverageTripleToColumn = [&Columns](unsigned Hit, unsigned Total,
-                                              float Pctg) {
-    std::string S;
-    {
-      raw_string_ostream RSO{S};
-      RSO << format("%*.2f", 7, Pctg) << "% (" << Hit << '/' << Total << ')';
-    }
-    const char *CellClass = "column-entry-yellow";
-    if (Pctg < 80.0)
-      CellClass = "column-entry-red";
-    else if (Hit == Total)
-      CellClass = "column-entry-green";
-    Columns.emplace_back(tag("td", tag("pre", S), CellClass));
-  };
+/// Get the HTML for a coverage triple.
+static std::string getCoverageTriple(unsigned Hit, unsigned Total, float Pctg) {
+  return tag("td", tag("pre", RSO.str()), CellClass);
+}
+
+/// Render a file coverage summary (\p FCS) in a table row. If \p IsTotals is
+/// false, link the summary to \p SF.
+void CoveragePrinterHTML::emitFileSummary(raw_ostream &OS, StringRef SF,
+                                          const FileCoverageSummary &FCS,
+                                          bool IsTotals) const {
+  SmallVector<std::string, 4> Columns;
 
   // Simplify the display file path, and wrap it in a link if requested.
   std::string Filename;
   SmallString<128> LinkTextStr(sys::path::relative_path(FCS.Name));
   sys::path::remove_dots(LinkTextStr, /*remove_dot_dots=*/true);
   sys::path::native(LinkTextStr);
   std::string LinkText = escape(LinkTextStr, Opts);
   if (IsTotals) {
     Filename = LinkText;
   } else {
     std::string LinkTarget =
         escape(getOutputPath(SF, "html", /*InToplevel=*/false), Opts);
     Filename = a(LinkTarget, LinkText);
   }
 
   Columns.emplace_back(tag("td", tag("pre", Filename)));
-  AddCoverageTripleToColumn(FCS.FunctionCoverage.Executed,
-                            FCS.FunctionCoverage.NumFunctions,
-                            FCS.FunctionCoverage.getPercentCovered());
-  AddCoverageTripleToColumn(FCS.InstantiationCoverage.Executed,
-                            FCS.InstantiationCoverage.NumFunctions,
-                            FCS.InstantiationCoverage.getPercentCovered());
-  AddCoverageTripleToColumn(FCS.LineCoverage.Covered, FCS.LineCoverage.NumLines,
-                            FCS.LineCoverage.getPercentCovered());
-  AddCoverageTripleToColumn(FCS.RegionCoverage.Covered,
-                            FCS.RegionCoverage.NumRegions,
-                            FCS.RegionCoverage.getPercentCovered());
-
+  Columns.emplace_back(getCoverageTriple(
+      FCS.FunctionCoverage.Executed, FCS.FunctionCoverage.NumFunctions,
+      FCS.FunctionCoverage.getPercentCovered()));
+  Columns.emplace_back(
+      getCoverageTriple(FCS.InstantiationCoverage.Executed,
+                        FCS.InstantiationCoverage.getPercentCovered()));
+  Columns.emplace_back(getCoverageTriple(
+      FCS.LineCoverage.NumLines - FCS.LineCoverage.NotCovered,
+      FCS.LineCoverage.NumLines, FCS.LineCoverage.getPercentCovered()));
+  Columns.emplace_back(getCoverageTriple(
+      FCS.RegionCoverage.NumRegions - FCS.RegionCoverage.NotCovered,
+      FCS.RegionCoverage.NumRegions, FCS.RegionCoverage.getPercentCovered()));
   OS << tag("tr", join(Columns.begin(), Columns.end(), ""), "light-row");
 }
 
+/// Render the project coverage summary (\p PCS) and the project directory (\p
+/// ProjectDir) above the index table.
+void CoveragePrinterHTML::emitProjectSummary(
+    raw_ostream &OS, const FileCoverageSummary &PCS) const {
+
+  OS << "<table border=\"0\">"
+     << "<tbody>";
+
+  // Add a coverage row to the coverage summary table.
+  auto AddCoverageSummaryRow = [&OS](StringRef CoverageTitle,
+                                     StringRef CoverageValue) {
+    OS << tag("tr",
+              tag("td", CoverageTitle, "column-entry") + CoverageValue.str());
+  };
+
+  AddCoverageSummaryRow(
+      "Function Coverage:",
+      getCoverageTriple(PCS.FunctionCoverage.Executed,
+                        PCS.FunctionCoverage.NumFunctions,
+                        PCS.FunctionCoverage.getPercentCovered()));
+  AddCoverageSummaryRow(
+      "Instantiation Coverage:",
+      getCoverageTriple(PCS.InstantiationCoverage.Executed,
+                        PCS.InstantiationCoverage.NumFunctions,
+                        PCS.InstantiationCoverage.getPercentCovered()));
+  AddCoverageSummaryRow(
+      "Line Coverage:",
+      getCoverageTriple(PCS.LineCoverage.NumLines - PCS.LineCoverage.NotCovered,
+                        PCS.LineCoverage.NumLines,
+                        PCS.LineCoverage.getPercentCovered()));
+  AddCoverageSummaryRow(
+      "Region Coverage:",
+      getCoverageTriple(PCS.RegionCoverage.NumRegions -
+                            PCS.RegionCoverage.NotCovered,
+                        PCS.RegionCoverage.NumRegions,
+                        PCS.RegionCoverage.getPercentCovered()));
+
+  OS << "</tbody>"
+     << "</table>" << "<br>";
+}
+
 Error CoveragePrinterHTML::createIndexFile(
     ArrayRef<StringRef> SourceFiles,
     const coverage::CoverageMapping &Coverage) {
   // Emit the default stylesheet.
   auto CSSOrErr = createOutputStream("style", "css", /*InToplevel=*/true);
   if (Error E = CSSOrErr.takeError())
     return E;
 
Error CoveragePrinterHTML::createIndexFile(
 
   // Emit a link to some documentation.
   OSRef << tag("p", "Click " +
                         a("http://clang.llvm.org/docs/"
                           "SourceBasedCodeCoverage.html#interpreting-reports",
                           "here") +
                         " for information about interpreting this report.");
 
-  // Emit a table containing links to reports for each file in the covmapping.
-  OSRef << BeginCenteredDiv << BeginTable;
-  emitColumnLabelsForIndex(OSRef);
+  // Emit a table containing the project coverage summary.
   FileCoverageSummary Totals("TOTALS");
   auto FileReports =
       CoverageReport::prepareFileReports(Coverage, Totals, SourceFiles);
+  emitProjectSummary(OSRef, Totals);
+
+  // Emit a table containing links to reports for each file in the covmapping.
+  OSRef << BeginCenteredDiv << BeginTable;
+  emitColumnLabelsForIndex(OSRef);
   for (unsigned I = 0, E = FileReports.size(); I < E; ++I)
     emitFileSummary(OSRef, SourceFiles[I], FileReports[I]);
   emitFileSummary(OSRef, "Totals", Totals, /*IsTotals=*/true);
   OSRef << EndTable << EndCenteredDiv
         << tag("h5", escape(Opts.getLLVMVersionString(), Opts));
   emitEpilog(OSRef);
 
   return Error::success();