#625 Improved support for local methods (Cobertura, dotCover, OpenCov…

…er, VisualStudio)
danielpalme · Oct 5, 2023 · 949fa35 · 949fa35
1 parent ae8c4fc
commit 949fa35
Show file tree

Hide file tree

Showing 13 changed files with 618 additions and 383 deletions.
diff --git a/src/Readme.txt b/src/Readme.txt
@@ -70,6 +70,7 @@ CHANGELOG
 5.1.26.0
 
     * New: #595 Added new report type 'Html_BlueRed_Summary' to improve red-green colorblind accessibility
+    * New: #625 Improved support for local methods (Cobertura, dotCover, OpenCover, VisualStudio)
     * New: #627 Removed PNG badges and replaced report type 'PngChart' with 'SvgChart'
     * Fix: #623 Improved Cobertura output (complexity metric)
 

diff --git a/src/ReportGenerator.Core/Parser/CoberturaParser.cs b/src/ReportGenerator.Core/Parser/CoberturaParser.cs
@@ -44,6 +44,11 @@ internal class CoberturaParser : ParserBase
         /// </summary>
         private static readonly Regex CompilerGeneratedMethodNameRegex = new Regex(@"(?<ClassName>.+)(/|\.)<(?<CompilerGeneratedName>.+)>.+__.+MoveNext\(\)$", RegexOptions.Compiled);
 
+        /// <summary>
+        /// Regex to analyze if a method name is a nested method (a method nested within a method).
+        /// </summary>
+        private static readonly Regex LocalFunctionMethodNameRegex = new Regex(@"^.*(?<ParentMethodName><.+>).*__(?<NestedMethodName>[^\|]+)\|.*$", RegexOptions.Compiled);
+
         /// <summary>
         /// Regex to analyze the branch coverage of a line element.
         /// </summary>
@@ -480,8 +485,16 @@ private static Dictionary<int, ICollection<Branch>> GetBranches(IEnumerable<XEle
         /// <returns>The method name.</returns>
         private static string ExtractMethodName(string methodName, string className)
         {
-            // Quick check before expensive regex is called
-            if (methodName.EndsWith("MoveNext()"))
+            if (methodName.Contains("|") || className.Contains("|"))
+            {
+                Match match = LocalFunctionMethodNameRegex.Match(className + methodName);
+
+                if (match.Success)
+                {
+                    methodName = match.Groups["NestedMethodName"].Value + "()";
+                }
+            }
+            else if (methodName.EndsWith("MoveNext()"))
             {
                 Match match = CompilerGeneratedMethodNameRegex.Match(className + methodName);
 

diff --git a/src/ReportGenerator.Core/Parser/DotCoverParser.cs b/src/ReportGenerator.Core/Parser/DotCoverParser.cs
@@ -32,6 +32,11 @@ internal class DotCoverParser : ParserBase
         /// </summary>
         private static readonly Regex CompilerGeneratedMethodNameRegex = new Regex(@"<(?<CompilerGeneratedName>.+)>.+__.+MoveNext\(\):.+$", RegexOptions.Compiled);
 
+        /// <summary>
+        /// Regex to analyze if a method name is a nested method (a method nested within a method).
+        /// </summary>
+        private static readonly Regex LocalFunctionMethodNameRegex = new Regex(@"^.*(?<ParentMethodName><.+>).*__(?<NestedMethodName>[^\|]+)\|.+\((?<Arguments>.*)\):.+$", RegexOptions.Compiled);
+
         /// <summary>
         /// Initializes a new instance of the <see cref="DotCoverParser" /> class.
         /// </summary>
@@ -278,8 +283,16 @@ private static void SetCodeElements(CodeFile codeFile, string fileId, IEnumerabl
         /// <returns>The method name.</returns>
         private static string ExtractMethodName(string typeName, string methodName)
         {
-            // Quick check before expensive regex is called
-            if (methodName.Contains("MoveNext()"))
+            if (typeName.Contains("|") || methodName.Contains("|"))
+            {
+                Match match = LocalFunctionMethodNameRegex.Match(typeName + methodName);
+
+                if (match.Success)
+                {
+                    return match.Groups["NestedMethodName"].Value + "(" + match.Groups["Arguments"].Value + ")";
+                }
+            }
+            else if (methodName.Contains("MoveNext()"))
             {
                 Match match = CompilerGeneratedMethodNameRegex.Match(typeName + methodName);
 

diff --git a/src/ReportGenerator.Core/Parser/OpenCoverParser.cs b/src/ReportGenerator.Core/Parser/OpenCoverParser.cs
@@ -39,13 +39,18 @@ internal class OpenCoverParser : ParserBase
         /// <summary>
         /// Regex to analyze if a method name belongs to a lamda expression.
         /// </summary>
-        private static readonly Regex LambdaMethodNameRegex = new Regex("::<.+>.+__", RegexOptions.Compiled);
+        private static readonly Regex LambdaMethodNameRegex = new Regex("::<.+>.+__[^\\|]+$", RegexOptions.Compiled);
 
         /// <summary>
         /// Regex to analyze if a method name is generated by compiler.
         /// </summary>
         private static readonly Regex CompilerGeneratedMethodNameRegex = new Regex(@"<(?<CompilerGeneratedName>.+)>.+__.+::MoveNext\(\)$", RegexOptions.Compiled);
 
+        /// <summary>
+        /// Regex to analyze if a method name is a nested method (a method nested within a method).
+        /// </summary>
+        private static readonly Regex LocalFunctionMethodNameRegex = new Regex(@"^.*(?<ParentMethodName><.+>).*__(?<NestedMethodName>[^\|]+)\|.+\((?<Arguments>.*)\).*$", RegexOptions.Compiled);
+
         /// <summary>
         /// Regex to extract short method name.
         /// </summary>
@@ -586,8 +591,16 @@ private static string ExtractMethodName(string methodName)
         {
             if (!MethodNameMap.TryGetValue(methodName, out var fullName))
             {
-                // Quick check before expensive regex is called
-                if (methodName.EndsWith("::MoveNext()"))
+                if (methodName.Contains("|"))
+                {
+                    Match match = LocalFunctionMethodNameRegex.Match(methodName);
+
+                    if (match.Success)
+                    {
+                        methodName = match.Groups["NestedMethodName"].Value + "(" + match.Groups["Arguments"].Value + ")";
+                    }
+                }
+                else if (methodName.EndsWith("::MoveNext()"))
                 {
                     Match match = CompilerGeneratedMethodNameRegex.Match(methodName);
 

diff --git a/src/ReportGenerator.Core/Parser/VisualStudioParser.cs b/src/ReportGenerator.Core/Parser/VisualStudioParser.cs
@@ -26,13 +26,18 @@ internal class VisualStudioParser : ParserBase
         /// <summary>
         /// Regex to analyze if a method name belongs to a lamda expression.
         /// </summary>
-        private static readonly Regex LambdaMethodNameRegex = new Regex("<.+>.+__", RegexOptions.Compiled);
+        private static readonly Regex LambdaMethodNameRegex = new Regex("<.+>.+__[^\\|]+$", RegexOptions.Compiled);
 
         /// <summary>
         /// Regex to analyze if a method name is generated by compiler.
         /// </summary>
         private static readonly Regex CompilerGeneratedMethodNameRegex = new Regex(@"^.*<(?<CompilerGeneratedName>.+)>.+__.+!MoveNext\(\)!.+$", RegexOptions.Compiled);
 
+        /// <summary>
+        /// Regex to analyze if a method name is a nested method (a method nested within a method).
+        /// </summary>
+        private static readonly Regex LocalFunctionMethodNameRegex = new Regex(@"^.*(?<ParentMethodName><.+>).*__(?<NestedMethodName>[^\|]+)\|.+\((?<Arguments>.*)\).*$", RegexOptions.Compiled);
+
         /// <summary>
         /// Regex to extract short method name.
         /// </summary>
@@ -329,8 +334,16 @@ private static void SetCodeElements(CodeFile codeFile, IEnumerable<XElement> met
         /// <returns>The method name.</returns>
         private static string ExtractMethodName(string methodName, string methodKeyName)
         {
-            // Quick check before expensive regex is called
-            if (methodKeyName.Contains("MoveNext()"))
+            if (methodKeyName.Contains("|"))
+            {
+                Match match = LocalFunctionMethodNameRegex.Match(methodKeyName);
+
+                if (match.Success)
+                {
+                    methodName = match.Groups["NestedMethodName"].Value + "(" + match.Groups["Arguments"].Value + ")";
+                }
+            }
+            else if (methodKeyName.Contains("MoveNext()"))
             {
                 Match match = CompilerGeneratedMethodNameRegex.Match(methodKeyName);
 

diff --git a/src/ReportGenerator.sln b/src/ReportGenerator.sln
@@ -44,6 +44,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Reports", "Reports", "{8775
 		Testprojects\FSharp\Reports\OpenCover.xml = Testprojects\FSharp\Reports\OpenCover.xml
 		Testprojects\FSharp\Reports\VisualStudio2010.coveragexml = Testprojects\FSharp\Reports\VisualStudio2010.coveragexml
 		Testprojects\FSharp\Reports\VisualStudio2013.coveragexml = Testprojects\FSharp\Reports\VisualStudio2013.coveragexml
+		Testprojects\CSharp\Reports\VisualStudio2022.coveragexml = Testprojects\CSharp\Reports\VisualStudio2022.coveragexml
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Java", "Java", "{89813866-CE17-47E5-BCA3-4740F8624BA5}"

diff --git a/src/Testprojects/CSharp/Project_DotNetCore/Test/Program.cs b/src/Testprojects/CSharp/Project_DotNetCore/Test/Program.cs
@@ -9,6 +9,8 @@ public class Program
         public static void Main(string[] args)
         {
             new TestClass().SampleFunction();
+            new TestClass().ParentMethod();
+            new TestClass().MethodWithLambda();
 
             new TestClass2("Test").ExecutedMethod();
             new TestClass2("Test").SampleFunction("Munich");

diff --git a/src/Testprojects/CSharp/Project_DotNetCore/Test/TestClass.cs b/src/Testprojects/CSharp/Project_DotNetCore/Test/TestClass.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Linq;
 
 namespace Test
 {
@@ -24,6 +25,27 @@ public void SampleFunction()
             }
         }
 
+        public void ParentMethod()
+        {
+            string resultFromLocalFunction = NestedLocalFunction("Hello");
+
+            Console.WriteLine(resultFromLocalFunction);
+
+            string NestedLocalFunction(string input)
+            {
+                return input + " world";
+            }
+        }
+
+        public void MethodWithLambda()
+        {
+            var chars = "abc".Where(c => c == 'a').ToArray();
+
+            var lambda = (char c) => c == 'a';
+
+            var chars2 = "abc".Where(lambda).ToArray();
+        }
+
         public class NestedClass
         {
             public void SampleFunction()