#408: Fixed coverage of generic classes

danielpalme · danielpalme · commit 0bc6d22884bb · 2021-03-04T21:04:53.000+01:00
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -12,7 +12,7 @@ variables:
   - name: disable.coverage.autogenerate
     value: 'true'
   - name: version
-    value: '4.8.6'
+    value: '4.8.7'
 
 stages:
 - stage: Build
diff --git a/src/AzureDevopsTask/ReportGenerator/task.json b/src/AzureDevopsTask/ReportGenerator/task.json
@@ -13,7 +13,7 @@
     "version": {
         "Major": 4,
         "Minor": 8,
-        "Patch": 6
+        "Patch": 7
     },
     "instanceNameFormat": "ReportGenerator",
     "groups": [
diff --git a/src/AzureDevopsTask/vss-extension.json b/src/AzureDevopsTask/vss-extension.json
@@ -2,7 +2,7 @@
     "manifestVersion": 1,
     "id": "reportgenerator",
     "name": "ReportGenerator",
-    "version": "4.8.6",
+    "version": "4.8.7",
     "publisher": "Palmmedia",
     "public": true,
     "targets": [
diff --git a/src/Readme.txt b/src/Readme.txt
@@ -63,6 +63,10 @@ For further details take a look at LICENSE.txt.
 
 CHANGELOG
 
+4.8.7.0
+
+    * Fix: #408: Fixed coverage of generic classes
+
 4.8.6.0
 
     * New: #405: Added support for deterministic source paths
diff --git a/src/ReportGenerator.Console.NetCore/ReportGenerator.Console.NetCore.csproj b/src/ReportGenerator.Console.NetCore/ReportGenerator.Console.NetCore.csproj
@@ -7,8 +7,8 @@
     <AssemblyName>ReportGenerator</AssemblyName>
     <RootNamespace>Palmmedia.ReportGenerator</RootNamespace>
     <StartupObject>Palmmedia.ReportGenerator.Console.NetCore.Program</StartupObject>
-    <AssemblyVersion>4.8.6.0</AssemblyVersion>
-    <FileVersion>4.8.6.0</FileVersion>
+    <AssemblyVersion>4.8.7.0</AssemblyVersion>
+    <FileVersion>4.8.7.0</FileVersion>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/ReportGenerator.Console/Properties/AssemblyInfo.cs b/src/ReportGenerator.Console/Properties/AssemblyInfo.cs
@@ -31,5 +31,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("4.8.6.0")]
-[assembly: AssemblyFileVersion("4.8.6.0")]
+[assembly: AssemblyVersion("4.8.7.0")]
+[assembly: AssemblyFileVersion("4.8.7.0")]
diff --git a/src/ReportGenerator.Console/ReportGenerator.Console.Net.csproj b/src/ReportGenerator.Console/ReportGenerator.Console.Net.csproj
@@ -94,7 +94,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0" />
-    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="16.8.0" />
+    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="16.9.0" />
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
 </Project>
diff --git a/src/ReportGenerator.Core.Test/ReportGenerator.Core.Test.csproj b/src/ReportGenerator.Core.Test/ReportGenerator.Core.Test.csproj
@@ -4,18 +4,18 @@
     <TargetFramework>net5.0</TargetFramework>
     <IsPackable>false</IsPackable>
     <RootNamespace>Palmmedia.ReportGenerator.Core.Test</RootNamespace>
-    <AssemblyVersion>4.8.6.0</AssemblyVersion>
-    <FileVersion>4.8.6.0</FileVersion>
+    <AssemblyVersion>4.8.7.0</AssemblyVersion>
+    <FileVersion>4.8.7.0</FileVersion>
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
   </PropertyGroup>
   
   <ItemGroup>
-    <PackageReference Include="coverlet.msbuild" Version="3.0.2">
+    <PackageReference Include="coverlet.msbuild" Version="3.0.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.0-preview-20201020-06" />
-    <PackageReference Include="Moq" Version="4.16.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.9.1" />
+    <PackageReference Include="Moq" Version="4.16.1" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <PrivateAssets>all</PrivateAssets>
diff --git a/src/ReportGenerator.Core/Parser/Analysis/Class.cs b/src/ReportGenerator.Core/Parser/Analysis/Class.cs
@@ -45,6 +45,8 @@ internal Class(string name, Assembly assembly)
             this.Name = name ?? throw new ArgumentNullException(nameof(name));
             this.Assembly = assembly ?? throw new ArgumentNullException(nameof(assembly));
 
+            this.DisplayName = name;
+
             /*
              * Convert class name of generic classes:
              * See: https://github.com/coverlet-coverage/coverlet/issues/1077
@@ -59,29 +61,29 @@ internal Class(string name, Assembly assembly)
 
                 if (match.Success)
                 {
-                    this.Name = match.Groups["Name"].Value;
+                    this.DisplayName = match.Groups["Name"].Value;
 
                     int number = int.Parse(match.Groups["Number"].Value);
 
                     if (number == 1)
                     {
-                        this.Name += "<T>";
+                        this.DisplayName += "<T>";
                     }
                     else if (number > 1)
                     {
-                        this.Name += "<";
+                        this.DisplayName += "<";
 
                         for (int i = 1; i <= number; i++)
                         {
                             if (i > 1)
                             {
-                                this.Name += ", ";
+                                this.DisplayName += ", ";
                             }
 
-                            this.Name += "T" + i;
+                            this.DisplayName += "T" + i;
                         }
 
-                        this.Name += ">";
+                        this.DisplayName += ">";
                     }
                 }
             }
@@ -92,6 +94,11 @@ internal Class(string name, Assembly assembly)
         /// </summary>
         public string Name { get; }
 
+        /// <summary>
+        /// Gets the display name of the class.
+        /// </summary>
+        public string DisplayName { get; }
+
         /// <summary>
         /// Gets the assembly.
         /// </summary>
diff --git a/src/ReportGenerator.Core/ReportGenerator.Core.csproj b/src/ReportGenerator.Core/ReportGenerator.Core.csproj
@@ -7,8 +7,8 @@
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
     <AssemblyName>ReportGenerator.Core</AssemblyName>
-    <AssemblyVersion>4.8.6.0</AssemblyVersion>
-    <FileVersion>4.8.6.0</FileVersion>
+    <AssemblyVersion>4.8.7.0</AssemblyVersion>
+    <FileVersion>4.8.7.0</FileVersion>
   </PropertyGroup>
     
   <PropertyGroup>
diff --git a/src/ReportGenerator.Core/Reporting/Builders/Rendering/HtmlRenderer.cs b/src/ReportGenerator.Core/Reporting/Builders/Rendering/HtmlRenderer.cs
@@ -155,8 +155,9 @@ public void BeginSummaryReport(string targetDirectory, string fileName, string t
         /// <param name="targetDirectory">The target directory.</param>
         /// <param name="assemblyName">Name of the assembly.</param>
         /// <param name="className">Name of the class.</param>
+        /// <param name="classDisplayName">Display name of the class.</param>
         /// <param name="additionalTitle">Additional title.</param>
-        public void BeginClassReport(string targetDirectory, string assemblyName, string className, string additionalTitle)
+        public void BeginClassReport(string targetDirectory, string assemblyName, string className, string classDisplayName, string additionalTitle)
         {
             this.classReport = true;
 
@@ -171,7 +172,7 @@ public void BeginClassReport(string targetDirectory, string assemblyName, string
                     "<style type=\"text/css\">" + new StreamReader(cssStream).ReadToEnd() + "</style>"
                     : CssLink;
 
-                this.reportTextWriter.WriteLine(HtmlStart, WebUtility.HtmlEncode(className), WebUtility.HtmlEncode(additionalTitle + ReportResources.CoverageReport), style);
+                this.reportTextWriter.WriteLine(HtmlStart, WebUtility.HtmlEncode(classDisplayName), WebUtility.HtmlEncode(additionalTitle + ReportResources.CoverageReport), style);
             }
         }
 
@@ -480,7 +481,7 @@ public void CustomSummary(IEnumerable<Assembly> assemblies, IEnumerable<RiskHots
                     historicCoveragesSb.Append("]");
 
                     this.javaScriptContent.Append("      { ");
-                    this.javaScriptContent.AppendFormat("\"name\": \"{0}\",", @class.Name.Replace(@"\", @"\\"));
+                    this.javaScriptContent.AppendFormat("\"name\": \"{0}\",", @class.DisplayName.Replace(@"\", @"\\"));
                     this.javaScriptContent.AppendFormat(
                         " \"rp\": \"{0}\",",
                         this.onlySummary ? string.Empty : this.GetClassReportFilename(@class.Assembly.ShortName, @class.Name));
@@ -554,7 +555,7 @@ public void CustomSummary(IEnumerable<Assembly> assemblies, IEnumerable<RiskHots
             {
                 this.javaScriptContent.AppendLine("  {");
                 this.javaScriptContent.AppendFormat("    \"assembly\": \"{0}\",", riskHotspot.Assembly.ShortName);
-                this.javaScriptContent.AppendFormat(" \"class\": \"{0}\",", riskHotspot.Class.Name);
+                this.javaScriptContent.AppendFormat(" \"class\": \"{0}\",", riskHotspot.Class.DisplayName);
                 this.javaScriptContent.AppendFormat(" \"reportPath\": \"{0}\",", this.onlySummary ? string.Empty : this.GetClassReportFilename(riskHotspot.Assembly.ShortName, riskHotspot.Class.Name));
                 this.javaScriptContent.AppendFormat(" \"methodName\": \"{0}\",", riskHotspot.MethodMetric.FullName);
                 this.javaScriptContent.AppendFormat(" \"methodShortName\": \"{0}\",", riskHotspot.MethodMetric.ShortName);
@@ -1005,7 +1006,7 @@ public void RiskHotspots(IEnumerable<RiskHotspot> riskHotspots)
                         CultureInfo.InvariantCulture,
                         "<a href=\"{0}\">{1}</a>",
                         WebUtility.HtmlEncode(this.GetClassReportFilename(riskHotspot.Assembly.ShortName, riskHotspot.Class.Name)),
-                        WebUtility.HtmlEncode(riskHotspot.Class.Name));
+                        WebUtility.HtmlEncode(riskHotspot.Class.DisplayName));
                 }
 
                 this.reportTextWriter.WriteLine("<tr>");
@@ -1100,7 +1101,7 @@ public void SummaryClass(Class @class, bool branchCoverageAvailable)
                     CultureInfo.InvariantCulture,
                     "<a href=\"{0}\">{1}</a>",
                     WebUtility.HtmlEncode(this.GetClassReportFilename(@class.Assembly.ShortName, @class.Name)),
-                    WebUtility.HtmlEncode(@class.Name));
+                    WebUtility.HtmlEncode(@class.DisplayName));
             }
 
             this.reportTextWriter.Write("<tr>");
diff --git a/src/ReportGenerator.Core/Reporting/Builders/Rendering/IReportRenderer.cs b/src/ReportGenerator.Core/Reporting/Builders/Rendering/IReportRenderer.cs
@@ -28,8 +28,9 @@ public interface IReportRenderer
         /// <param name="targetDirectory">The target directory.</param>
         /// <param name="assemblyName">Name of the assembly.</param>
         /// <param name="className">Name of the class.</param>
+        /// <param name="classDisplayName">Display name of the class.</param>
         /// <param name="additionalTitle">Additional title.</param>
-        void BeginClassReport(string targetDirectory, string assemblyName, string className, string additionalTitle);
+        void BeginClassReport(string targetDirectory, string assemblyName, string className, string classDisplayName, string additionalTitle);
 
         /// <summary>
         /// Saves a summary report.
diff --git a/src/ReportGenerator.Core/Reporting/Builders/Rendering/LatexRenderer.cs b/src/ReportGenerator.Core/Reporting/Builders/Rendering/LatexRenderer.cs
@@ -122,8 +122,9 @@ public void BeginSummaryReport(string targetDirectory, string fileName, string t
         /// <param name="targetDirectory">The target directory.</param>
         /// <param name="assemblyName">Name of the assembly.</param>
         /// <param name="className">Name of the class.</param>
+        /// <param name="classDisplayName">Display name of the class.</param>
         /// <param name="additionalTitle">Additional title.</param>
-        public void BeginClassReport(string targetDirectory, string assemblyName, string className, string additionalTitle)
+        public void BeginClassReport(string targetDirectory, string assemblyName, string className, string classDisplayName, string additionalTitle)
         {
             if (this.classReportTextWriter == null)
             {
@@ -136,8 +137,8 @@ public void BeginClassReport(string targetDirectory, string assemblyName, string
             this.reportTextWriter = this.classReportTextWriter;
             this.reportTextWriter.WriteLine(@"\newpage");
 
-            className = string.Format(CultureInfo.InvariantCulture, @"\section{{{0}}}", EscapeLatexChars(className));
-            this.reportTextWriter.WriteLine(className);
+            classDisplayName = string.Format(CultureInfo.InvariantCulture, @"\section{{{0}}}", EscapeLatexChars(classDisplayName));
+            this.reportTextWriter.WriteLine(classDisplayName);
         }
 
         /// <summary>
@@ -537,7 +538,7 @@ public void RiskHotspots(IEnumerable<RiskHotspot> riskHotspots)
                 this.reportTextWriter.Write(
                     "{0} & {1} & {2}",
                     EscapeLatexChars(riskHotspot.Assembly.ShortName),
-                    EscapeLatexChars(riskHotspot.Class.Name),
+                    EscapeLatexChars(riskHotspot.Class.DisplayName),
                     EscapeLatexChars(riskHotspot.MethodMetric.ShortName));
 
                 foreach (var statusMetric in riskHotspot.StatusMetrics)
@@ -612,7 +613,7 @@ public void SummaryClass(Class @class, bool branchCoverageAvailable)
             string row = string.Format(
                 CultureInfo.InvariantCulture,
                 @"{0} & {1} & {2} & {3} & {4} & {5}",
-                EscapeLatexChars(@class.Name),
+                EscapeLatexChars(@class.DisplayName),
                 @class.CoveredLines,
                 @class.CoverableLines - @class.CoveredLines,
                 @class.CoverableLines,
@@ -765,6 +766,8 @@ private static string EscapeLatexChars(string text) => text
                 .Replace(@"\", @"\textbackslash ")
                 .Replace("%", @"\%")
                 .Replace("#", @"\#")
-                .Replace("_", @"\_");
+                .Replace("_", @"\_")
+                .Replace("<", "$<$")
+                .Replace(">", "$>$");
     }
 }
diff --git a/src/ReportGenerator.Core/Reporting/Builders/ReportBuilderBase.cs b/src/ReportGenerator.Core/Reporting/Builders/ReportBuilderBase.cs
@@ -62,7 +62,7 @@ public virtual void CreateClassReport(IReportRenderer reportRenderer, Class @cla
 
             string additionalTitle = this.ReportContext.ReportConfiguration.Title != null ? $"{this.ReportContext.ReportConfiguration.Title} - " : null;
 
-            reportRenderer.BeginClassReport(this.CreateTargetDirectory(), @class.Assembly.ShortName, @class.Name, additionalTitle);
+            reportRenderer.BeginClassReport(this.CreateTargetDirectory(), @class.Assembly.ShortName, @class.Name, @class.DisplayName, additionalTitle);
 
             if (this.ReportContext.ReportConfiguration.Title != null)
             {
@@ -74,7 +74,7 @@ public virtual void CreateClassReport(IReportRenderer reportRenderer, Class @cla
             }
 
             reportRenderer.BeginKeyValueTable();
-            reportRenderer.KeyValueRow(ReportResources.Class, @class.Name);
+            reportRenderer.KeyValueRow(ReportResources.Class, @class.DisplayName);
             reportRenderer.KeyValueRow(ReportResources.Assembly, @class.Assembly.ShortName);
             reportRenderer.KeyValueRow(ReportResources.Files3, @class.Files.Select(f => f.Path));
             reportRenderer.KeyValueRow(ReportResources.CoveredLines, @class.CoveredLines.ToString(CultureInfo.InvariantCulture));
diff --git a/src/ReportGenerator.Core/Reporting/Builders/TextSummaryReportBuilder.cs b/src/ReportGenerator.Core/Reporting/Builders/TextSummaryReportBuilder.cs
@@ -98,7 +98,7 @@ public void CreateSummaryReport(SummaryResult summaryResult)
                 if (summaryResult.Assemblies.Any())
                 {
                     var maximumNameLength = summaryResult.Assemblies
-                        .SelectMany(a => a.Classes).Select(c => c.Name)
+                        .SelectMany(a => a.Classes).Select(c => c.DisplayName)
                         .Union(summaryResult.Assemblies.Select(a => a.Name))
                         .Max(n => n.Length);
 
@@ -117,8 +117,8 @@ public void CreateSummaryReport(SummaryResult summaryResult)
                             string classQuota = @class.CoverageQuota.HasValue ? @class.CoverageQuota.Value.ToString("f1", CultureInfo.InvariantCulture) + "%" : string.Empty;
                             reportTextWriter.WriteLine(
                                 "  {0}{1}  {2}",
-                                @class.Name,
-                                new string(' ', maximumNameLength - @class.Name.Length + 6 - classQuota.Length),
+                                @class.DisplayName,
+                                new string(' ', maximumNameLength - @class.DisplayName.Length + 6 - classQuota.Length),
                                 classQuota);
                         }
                     }
diff --git a/src/ReportGenerator.DotnetCorePluginLoader/ReportGenerator.DotnetCorePluginLoader.csproj b/src/ReportGenerator.DotnetCorePluginLoader/ReportGenerator.DotnetCorePluginLoader.csproj
@@ -2,8 +2,8 @@
   <PropertyGroup>
     <TargetFrameworks>netcoreapp2.0;net5.0</TargetFrameworks>
     <RootNamespace>ReportGenerator.DotnetCorePluginLoader</RootNamespace>
-    <AssemblyVersion>4.8.6.0</AssemblyVersion>
-    <FileVersion>4.8.6.0</FileVersion>
+    <AssemblyVersion>4.8.7.0</AssemblyVersion>
+    <FileVersion>4.8.7.0</FileVersion>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/ReportGenerator.DotnetGlobalTool/ReportGenerator.DotnetGlobalTool.csproj b/src/ReportGenerator.DotnetGlobalTool/ReportGenerator.DotnetGlobalTool.csproj
@@ -7,8 +7,8 @@
     <AssemblyName>ReportGenerator</AssemblyName>
     <RootNamespace>Palmmedia.ReportGenerator</RootNamespace>
     <StartupObject>Palmmedia.ReportGenerator.DotnetGlobalTool.Program</StartupObject>
-    <AssemblyVersion>4.8.6.0</AssemblyVersion>
-    <FileVersion>4.8.6.0</FileVersion>
+    <AssemblyVersion>4.8.7.0</AssemblyVersion>
+    <FileVersion>4.8.7.0</FileVersion>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/ReportGenerator.MSBuild/ReportGenerator.MSBuild.csproj b/src/ReportGenerator.MSBuild/ReportGenerator.MSBuild.csproj
@@ -5,12 +5,12 @@
     <RootNamespace>Palmmedia.ReportGenerator.MSBuild</RootNamespace>
     <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
-    <AssemblyVersion>4.8.6.0</AssemblyVersion>
-    <FileVersion>4.8.6.0</FileVersion>
+    <AssemblyVersion>4.8.7.0</AssemblyVersion>
+    <FileVersion>4.8.7.0</FileVersion>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="16.8.0" />
+    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="16.9.0" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/build.proj b/src/build.proj
@@ -22,7 +22,7 @@
 
   <!-- Version, adjust before build -->
   <PropertyGroup>
-    <Version>4.8.6</Version>
+    <Version>4.8.7</Version>
   </PropertyGroup>
   
   <!-- Tools -->

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,8 @@ internal Class(string name, Assembly assembly)`
`45`	`45`	`this.Name = name ?? throw new ArgumentNullException(nameof(name));`
`46`	`46`	`this.Assembly = assembly ?? throw new ArgumentNullException(nameof(assembly));`
`47`	`47`
	`48`	`+ this.DisplayName = name;`
	`49`	`+`
`48`	`50`	`/*`
`49`	`51`	`* Convert class name of generic classes:`
`50`	`52`	`* See: https://github.com/coverlet-coverage/coverlet/issues/1077`
`@@ -59,29 +61,29 @@ internal Class(string name, Assembly assembly)`
`59`	`61`
`60`	`62`	`if (match.Success)`
`61`	`63`	`{`
`62`		`- this.Name = match.Groups["Name"].Value;`
	`64`	`+ this.DisplayName = match.Groups["Name"].Value;`
`63`	`65`
`64`	`66`	`int number = int.Parse(match.Groups["Number"].Value);`
`65`	`67`
`66`	`68`	`if (number == 1)`
`67`	`69`	`{`
`68`		`- this.Name += "<T>";`
	`70`	`+ this.DisplayName += "<T>";`
`69`	`71`	`}`
`70`	`72`	`else if (number > 1)`
`71`	`73`	`{`
`72`		`- this.Name += "<";`
	`74`	`+ this.DisplayName += "<";`
`73`	`75`
`74`	`76`	`for (int i = 1; i <= number; i++)`
`75`	`77`	`{`
`76`	`78`	`if (i > 1)`
`77`	`79`	`{`
`78`		`- this.Name += ", ";`
	`80`	`+ this.DisplayName += ", ";`
`79`	`81`	`}`
`80`	`82`
`81`		`- this.Name += "T" + i;`
	`83`	`+ this.DisplayName += "T" + i;`
`82`	`84`	`}`
`83`	`85`
`84`		`- this.Name += ">";`
	`86`	`+ this.DisplayName += ">";`
`85`	`87`	`}`
`86`	`88`	`}`
`87`	`89`	`}`
`@@ -92,6 +94,11 @@ internal Class(string name, Assembly assembly)`
`92`	`94`	`/// </summary>`
`93`	`95`	`public string Name { get; }`
`94`	`96`
	`97`	`+ /// <summary>`
	`98`	`+ /// Gets the display name of the class.`
	`99`	`+ /// </summary>`
	`100`	`+ public string DisplayName { get; }`
	`101`	`+`
`95`	`102`	`/// <summary>`
`96`	`103`	`/// Gets the assembly.`
`97`	`104`	`/// </summary>`