1 //===- CoverageReport.cpp - Code coverage report -------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This class implements rendering of a code coverage report.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CoverageReport.h"
15 #include "RenderingSupport.h"
16 #include "llvm/Support/FileSystem.h"
17 #include "llvm/Support/Format.h"
18 #include "llvm/Support/Path.h"
19 #include <numeric>
20 
21 using namespace llvm;
22 
23 namespace {
24 
25 /// \brief Helper struct which prints trimmed and aligned columns.
26 struct Column {
27   enum TrimKind { NoTrim, WidthTrim, RightTrim };
28 
29   enum AlignmentKind { LeftAlignment, RightAlignment };
30 
31   StringRef Str;
32   unsigned Width;
33   TrimKind Trim;
34   AlignmentKind Alignment;
35 
36   Column(StringRef Str, unsigned Width)
37       : Str(Str), Width(Width), Trim(WidthTrim), Alignment(LeftAlignment) {}
38 
39   Column &set(TrimKind Value) {
40     Trim = Value;
41     return *this;
42   }
43 
44   Column &set(AlignmentKind Value) {
45     Alignment = Value;
46     return *this;
47   }
48 
49   void render(raw_ostream &OS) const {
50     if (Str.size() <= Width) {
51       if (Alignment == RightAlignment) {
52         OS.indent(Width - Str.size());
53         OS << Str;
54         return;
55       }
56       OS << Str;
57       OS.indent(Width - Str.size());
58       return;
59     }
60 
61     switch (Trim) {
62     case NoTrim:
63       OS << Str;
64       break;
65     case WidthTrim:
66       OS << Str.substr(0, Width);
67       break;
68     case RightTrim:
69       OS << Str.substr(0, Width - 3) << "...";
70       break;
71     }
72   }
73 };
74 
75 raw_ostream &operator<<(raw_ostream &OS, const Column &Value) {
76   Value.render(OS);
77   return OS;
78 }
79 
80 Column column(StringRef Str, unsigned Width) { return Column(Str, Width); }
81 
82 template <typename T>
83 Column column(StringRef Str, unsigned Width, const T &Value) {
84   return Column(Str, Width).set(Value);
85 }
86 
87 // Specify the default column widths.
88 size_t FileReportColumns[] = {25, 12, 18, 10, 12, 18, 10, 12, 18, 10};
89 size_t FunctionReportColumns[] = {25, 10, 8, 8, 10, 8, 8};
90 
91 /// \brief Adjust column widths to fit long file paths and function names.
92 void adjustColumnWidths(const coverage::CoverageMapping &CM) {
93   for (StringRef Filename : CM.getUniqueSourceFiles()) {
94     FileReportColumns[0] = std::max(FileReportColumns[0], Filename.size());
95     for (const auto &F : CM.getCoveredFunctions(Filename)) {
96       FunctionReportColumns[0] =
97           std::max(FunctionReportColumns[0], F.Name.size());
98     }
99   }
100 }
101 
102 /// \brief Prints a horizontal divider long enough to cover the given column
103 /// widths.
104 void renderDivider(ArrayRef<size_t> ColumnWidths, raw_ostream &OS) {
105   size_t Length = std::accumulate(ColumnWidths.begin(), ColumnWidths.end(), 0);
106   for (size_t I = 0; I < Length; ++I)
107     OS << '-';
108 }
109 
110 /// \brief Return the color which correponds to the coverage percentage of a
111 /// certain metric.
112 template <typename T>
113 raw_ostream::Colors determineCoveragePercentageColor(const T &Info) {
114   if (Info.isFullyCovered())
115     return raw_ostream::GREEN;
116   return Info.getPercentCovered() >= 80.0 ? raw_ostream::YELLOW
117                                           : raw_ostream::RED;
118 }
119 
120 /// \brief Determine the length of the longest common prefix of the strings in
121 /// \p Strings.
122 unsigned getLongestCommonPrefixLen(ArrayRef<StringRef> Strings) {
123   unsigned LCP = Strings[0].size();
124   for (unsigned I = 1, E = Strings.size(); LCP > 0 && I < E; ++I) {
125     auto Mismatch =
126         std::mismatch(Strings[0].begin(), Strings[0].end(), Strings[I].begin())
127             .first;
128     LCP = std::min(LCP, (unsigned)std::distance(Strings[0].begin(), Mismatch));
129   }
130   return LCP;
131 }
132 
133 } // end anonymous namespace
134 
135 namespace llvm {
136 
137 void CoverageReport::render(const FileCoverageSummary &File,
138                             raw_ostream &OS) const {
139   auto FileCoverageColor =
140       determineCoveragePercentageColor(File.RegionCoverage);
141   auto FuncCoverageColor =
142       determineCoveragePercentageColor(File.FunctionCoverage);
143   auto LineCoverageColor = determineCoveragePercentageColor(File.LineCoverage);
144   SmallString<256> FileName = File.Name;
145   sys::path::remove_dots(FileName, /*remove_dot_dots=*/true);
146   sys::path::native(FileName);
147   OS << column(FileName, FileReportColumns[0], Column::NoTrim)
148      << format("%*u", FileReportColumns[1],
149                (unsigned)File.RegionCoverage.NumRegions);
150   Options.colored_ostream(OS, FileCoverageColor) << format(
151       "%*u", FileReportColumns[2], (unsigned)File.RegionCoverage.NotCovered);
152   Options.colored_ostream(OS, FileCoverageColor)
153       << format("%*.2f", FileReportColumns[3] - 1,
154                 File.RegionCoverage.getPercentCovered())
155       << '%';
156   OS << format("%*u", FileReportColumns[4],
157                (unsigned)File.FunctionCoverage.NumFunctions);
158   OS << format("%*u", FileReportColumns[5],
159                (unsigned)(File.FunctionCoverage.NumFunctions -
160                           File.FunctionCoverage.Executed));
161   Options.colored_ostream(OS, FuncCoverageColor)
162       << format("%*.2f", FileReportColumns[6] - 1,
163                 File.FunctionCoverage.getPercentCovered())
164       << '%';
165   OS << format("%*u", FileReportColumns[7],
166                (unsigned)File.LineCoverage.NumLines);
167   Options.colored_ostream(OS, LineCoverageColor) << format(
168       "%*u", FileReportColumns[8], (unsigned)File.LineCoverage.NotCovered);
169   Options.colored_ostream(OS, LineCoverageColor)
170       << format("%*.2f", FileReportColumns[9] - 1,
171                 File.LineCoverage.getPercentCovered())
172       << '%';
173   OS << "\n";
174 }
175 
176 void CoverageReport::render(const FunctionCoverageSummary &Function,
177                             raw_ostream &OS) const {
178   auto FuncCoverageColor =
179       determineCoveragePercentageColor(Function.RegionCoverage);
180   auto LineCoverageColor =
181       determineCoveragePercentageColor(Function.LineCoverage);
182   OS << column(Function.Name, FunctionReportColumns[0], Column::RightTrim)
183      << format("%*u", FunctionReportColumns[1],
184                (unsigned)Function.RegionCoverage.NumRegions);
185   Options.colored_ostream(OS, FuncCoverageColor)
186       << format("%*u", FunctionReportColumns[2],
187                 (unsigned)Function.RegionCoverage.NotCovered);
188   Options.colored_ostream(
189       OS, determineCoveragePercentageColor(Function.RegionCoverage))
190       << format("%*.2f", FunctionReportColumns[3] - 1,
191                 Function.RegionCoverage.getPercentCovered())
192       << '%';
193   OS << format("%*u", FunctionReportColumns[4],
194                (unsigned)Function.LineCoverage.NumLines);
195   Options.colored_ostream(OS, LineCoverageColor)
196       << format("%*u", FunctionReportColumns[5],
197                 (unsigned)Function.LineCoverage.NotCovered);
198   Options.colored_ostream(
199       OS, determineCoveragePercentageColor(Function.LineCoverage))
200       << format("%*.2f", FunctionReportColumns[6] - 1,
201                 Function.LineCoverage.getPercentCovered())
202       << '%';
203   OS << "\n";
204 }
205 
206 void CoverageReport::renderFunctionReports(ArrayRef<StringRef> Files,
207                                            raw_ostream &OS) {
208   adjustColumnWidths(Coverage);
209   bool isFirst = true;
210   for (StringRef Filename : Files) {
211     if (isFirst)
212       isFirst = false;
213     else
214       OS << "\n";
215     OS << "File '" << Filename << "':\n";
216     OS << column("Name", FunctionReportColumns[0])
217        << column("Regions", FunctionReportColumns[1], Column::RightAlignment)
218        << column("Miss", FunctionReportColumns[2], Column::RightAlignment)
219        << column("Cover", FunctionReportColumns[3], Column::RightAlignment)
220        << column("Lines", FunctionReportColumns[4], Column::RightAlignment)
221        << column("Miss", FunctionReportColumns[5], Column::RightAlignment)
222        << column("Cover", FunctionReportColumns[6], Column::RightAlignment);
223     OS << "\n";
224     renderDivider(FunctionReportColumns, OS);
225     OS << "\n";
226     FunctionCoverageSummary Totals("TOTAL");
227     for (const auto &F : Coverage.getCoveredFunctions(Filename)) {
228       FunctionCoverageSummary Function = FunctionCoverageSummary::get(F);
229       ++Totals.ExecutionCount;
230       Totals.RegionCoverage += Function.RegionCoverage;
231       Totals.LineCoverage += Function.LineCoverage;
232       render(Function, OS);
233     }
234     if (Totals.ExecutionCount) {
235       renderDivider(FunctionReportColumns, OS);
236       OS << "\n";
237       render(Totals, OS);
238     }
239   }
240 }
241 
242 std::vector<FileCoverageSummary>
243 CoverageReport::prepareFileReports(FileCoverageSummary &Totals,
244                                    ArrayRef<StringRef> Files) const {
245   std::vector<FileCoverageSummary> FileReports;
246   unsigned LCP = 0;
247   if (Files.size() > 1)
248     LCP = getLongestCommonPrefixLen(Files);
249 
250   for (StringRef Filename : Files) {
251     FileCoverageSummary Summary(Filename.drop_front(LCP));
252     for (const auto &F : Coverage.getCoveredFunctions(Filename)) {
253       FunctionCoverageSummary Function = FunctionCoverageSummary::get(F);
254       Summary.addFunction(Function);
255       Totals.addFunction(Function);
256     }
257     FileReports.push_back(Summary);
258   }
259 
260   return FileReports;
261 }
262 
263 void CoverageReport::renderFileReports(raw_ostream &OS) const {
264   std::vector<StringRef> UniqueSourceFiles = Coverage.getUniqueSourceFiles();
265   renderFileReports(OS, UniqueSourceFiles);
266 }
267 
268 void CoverageReport::renderFileReports(raw_ostream &OS,
269                                        ArrayRef<StringRef> Files) const {
270   adjustColumnWidths(Coverage);
271   OS << column("Filename", FileReportColumns[0])
272      << column("Regions", FileReportColumns[1], Column::RightAlignment)
273      << column("Missed Regions", FileReportColumns[2], Column::RightAlignment)
274      << column("Cover", FileReportColumns[3], Column::RightAlignment)
275      << column("Functions", FileReportColumns[4], Column::RightAlignment)
276      << column("Missed Functions", FileReportColumns[5], Column::RightAlignment)
277      << column("Executed", FileReportColumns[6], Column::RightAlignment)
278      << column("Lines", FileReportColumns[7], Column::RightAlignment)
279      << column("Missed Lines", FileReportColumns[8], Column::RightAlignment)
280      << column("Cover", FileReportColumns[9], Column::RightAlignment) << "\n";
281   renderDivider(FileReportColumns, OS);
282   OS << "\n";
283 
284   FileCoverageSummary Totals("TOTAL");
285   auto FileReports = prepareFileReports(Totals, Files);
286   for (const FileCoverageSummary &FCS : FileReports)
287     render(FCS, OS);
288 
289   renderDivider(FileReportColumns, OS);
290   OS << "\n";
291   render(Totals, OS);
292 }
293 
294 } // end namespace llvm
295