Merge pull request #31 from tonerdo/branch-coverage

tonerdo · web-flow · commit 6985035c1fca · 2018-04-08T17:27:21.000+01:00
Preliminary branch coverage support
diff --git a/src/coverlet.core/Coverage.cs b/src/coverlet.core/Coverage.cs
@@ -53,27 +53,27 @@ public CoverageResult GetCoverageResult()
                             {
                                 if (methods.TryGetValue(line.Method, out Lines lines))
                                 {
-                                    documents[doc.Path][line.Class][line.Method].Add(line.Number, line.Hits);
+                                    documents[doc.Path][line.Class][line.Method].Add(line.Number, new LineInfo { Hits = line.Hits, IsBranchPoint = line.IsBranchTarget });
                                 }
                                 else
                                 {
                                     documents[doc.Path][line.Class].Add(line.Method, new Lines());
-                                    documents[doc.Path][line.Class][line.Method].Add(line.Number, line.Hits);
+                                    documents[doc.Path][line.Class][line.Method].Add(line.Number,  new LineInfo { Hits = line.Hits, IsBranchPoint = line.IsBranchTarget });
                                 }
                             }
                             else
                             {
                                 documents[doc.Path].Add(line.Class, new Methods());
                                 documents[doc.Path][line.Class].Add(line.Method, new Lines());
-                                documents[doc.Path][line.Class][line.Method].Add(line.Number, line.Hits);
+                                documents[doc.Path][line.Class][line.Method].Add(line.Number,  new LineInfo { Hits = line.Hits, IsBranchPoint = line.IsBranchTarget });
                             }
                         }
                         else
                         {
                             documents.Add(doc.Path, new Classes());
                             documents[doc.Path].Add(line.Class, new Methods());
                             documents[doc.Path][line.Class].Add(line.Method, new Lines());
-                            documents[doc.Path][line.Class][line.Method].Add(line.Number, line.Hits);
+                            documents[doc.Path][line.Class][line.Method].Add(line.Number,  new LineInfo { Hits = line.Hits, IsBranchPoint = line.IsBranchTarget });
                         }
                     }
                 }
@@ -99,7 +99,7 @@ private void CalculateCoverage()
                 {
                     var info = lines[i].Split(',');
                     // Ignore malformed lines
-                    if (info.Length != 3)
+                    if (info.Length != 4)
                         continue;
 
                     var document = result.Documents.FirstOrDefault(d => d.Path == info[0]);
@@ -108,11 +108,15 @@ private void CalculateCoverage()
 
                     int start = int.Parse(info[1]);
                     int end = int.Parse(info[2]);
+                    bool target = info[3] == "B";
 
                     for (int j = start; j <= end; j++)
                     {
                         var line = document.Lines.First(l => l.Number == j);
                         line.Hits = line.Hits + 1;
+
+                        if (j == start)
+                            line.IsBranchTarget = target;
                     }
                 }
 
diff --git a/src/coverlet.core/CoverageResult.cs b/src/coverlet.core/CoverageResult.cs
@@ -6,7 +6,13 @@
 
 namespace Coverlet.Core
 {
-    public class Lines : SortedDictionary<int, int> { }
+    public class LineInfo
+    {
+        public int Hits { get; set; }
+        public bool IsBranchPoint { get; set; }
+    }
+
+    public class Lines : SortedDictionary<int, LineInfo> { }
     public class Methods : Dictionary<string, Lines> { }
     public class Classes : Dictionary<string, Methods> { }
     public class Documents : Dictionary<string, Classes> { }
diff --git a/src/coverlet.core/CoverageSummary.cs b/src/coverlet.core/CoverageSummary.cs
@@ -25,7 +25,7 @@ public CoverageSummaryResult CalculateSummary()
                             foreach (var line in method.Value)
                             {
                                 totalLines++;
-                                if (line.Value > 0)
+                                if (line.Value.Hits > 0)
                                     linesCovered++;
                             }
                         }
diff --git a/src/coverlet.core/Instrumentation/Instrumenter.cs b/src/coverlet.core/Instrumentation/Instrumenter.cs
@@ -124,7 +124,8 @@ private Instruction AddInstrumentationCode(MethodDefinition method, ILProcessor
                     document.Lines.Add(new Line { Number = i, Class = method.DeclaringType.FullName, Method = method.FullName });
             }
 
-            string marker = $"{document.Path},{sequencePoint.StartLine},{sequencePoint.EndLine}";
+            string flag = IsBranchTarget(processor, instruction) ? "B" : "L";
+            string marker = $"{document.Path},{sequencePoint.StartLine},{sequencePoint.EndLine},{flag}";
 
             var pathInstr = Instruction.Create(OpCodes.Ldstr, _result.HitsFilePath);
             var markInstr = Instruction.Create(OpCodes.Ldstr, marker);
@@ -137,6 +138,23 @@ private Instruction AddInstrumentationCode(MethodDefinition method, ILProcessor
             return pathInstr;
         }
 
+        private bool IsBranchTarget(ILProcessor processor, Instruction instruction)
+        {
+            foreach (var _instruction in processor.Body.Instructions)
+            {
+                if (_instruction.Operand is Instruction target)
+                {
+                    if (target == instruction)
+                        return true;
+                }
+
+                if (_instruction.Operand is Instruction[] targets)
+                    return targets.Any(t => t == instruction);
+            }
+
+            return false;
+        }
+
         private void ReplaceInstructionTarget(Instruction instruction, Instruction oldTarget, Instruction newTarget)
         {
             if (instruction.Operand is Instruction _instruction)
diff --git a/src/coverlet.core/Instrumentation/InstrumenterResult.cs b/src/coverlet.core/Instrumentation/InstrumenterResult.cs
@@ -7,6 +7,7 @@ internal class Line
         public int Number;
         public string Class;
         public string Method;
+        public bool IsBranchTarget;
         public int Hits;
     }
 
diff --git a/src/coverlet.core/Reporters/OpenCoverReporter.cs b/src/coverlet.core/Reporters/OpenCoverReporter.cs
@@ -22,8 +22,8 @@ public string Format(CoverageResult result)
 
             XmlElement modules = xml.CreateElement("Modules");
 
-            int numSequencePoints = 0, numClasses = 0, numMethods = 0;
-            int visitedSequencePoints = 0, visitedClasses = 0, visitedMethods = 0;
+            int numSequencePoints = 0, numBranchPoints = 0, numClasses = 0, numMethods = 0;
+            int visitedSequencePoints = 0, visitedBranchPoints = 0, visitedClasses = 0, visitedMethods = 0;
 
             int i = 1;
 
@@ -87,7 +87,7 @@ public string Format(CoverageResult result)
                             fileRef.SetAttribute("uid", i.ToString());
 
                             XmlElement methodPoint = xml.CreateElement("MethodPoint");
-                            methodPoint.SetAttribute("vc", meth.Value.Select(l => l.Value).Sum().ToString());
+                            methodPoint.SetAttribute("vc", meth.Value.Select(l => l.Value.Hits).Sum().ToString());
                             methodPoint.SetAttribute("upsid", "0");
                             methodPoint.SetAttribute("type", "xsi", "SequencePoint");
                             methodPoint.SetAttribute("ordinal", j.ToString());
@@ -102,14 +102,16 @@ public string Format(CoverageResult result)
 
                             // They're really just lines
                             XmlElement sequencePoints = xml.CreateElement("SequencePoints");
+                            XmlElement branchPoints = xml.CreateElement("BranchPoints");
                             XmlElement methodSummary = xml.CreateElement("Summary");
                             int k = 0;
+                            int kBr = 0;
                             var methodVisited = false;
 
                             foreach (var lines in meth.Value)
                             {
                                 XmlElement sequencePoint = xml.CreateElement("SequencePoint");
-                                sequencePoint.SetAttribute("vc", lines.Value.ToString());
+                                sequencePoint.SetAttribute("vc", lines.Value.Hits.ToString());
                                 sequencePoint.SetAttribute("upsid", lines.Key.ToString());
                                 sequencePoint.SetAttribute("ordinal", k.ToString());
                                 sequencePoint.SetAttribute("sl", lines.Key.ToString());
@@ -121,12 +123,27 @@ public string Format(CoverageResult result)
                                 sequencePoint.SetAttribute("fileid", i.ToString());
                                 sequencePoints.AppendChild(sequencePoint);
 
+                                if (lines.Value.IsBranchPoint)
+                                {
+                                    XmlElement branchPoint = xml.CreateElement("BranchPoint");
+                                    branchPoint.SetAttribute("vc", lines.Value.Hits.ToString());
+                                    branchPoint.SetAttribute("upsid", lines.Key.ToString());
+                                    branchPoint.SetAttribute("ordinal", kBr.ToString());
+                                    branchPoint.SetAttribute("sl", lines.Key.ToString());
+                                    branchPoint.SetAttribute("fileid", i.ToString());
+                                    branchPoints.AppendChild(branchPoint);
+                                    kBr++;
+                                    numBranchPoints++;
+                                }
+
                                 numSequencePoints++;
-                                if (lines.Value > 0)
+                                if (lines.Value.Hits > 0)
                                 {
                                     visitedSequencePoints++;
                                     classVisited = true;
                                     methodVisited = true;
+                                    if (lines.Value.IsBranchPoint)
+                                        visitedBranchPoints++;
                                 }
 
                                 k++;
@@ -137,9 +154,9 @@ public string Format(CoverageResult result)
                                 visitedMethods++;
 
                             methodSummary.SetAttribute("numSequencePoints", meth.Value.Count().ToString());
-                            methodSummary.SetAttribute("visitedSequencePoints", meth.Value.Where(l => l.Value > 0).Count().ToString());
-                            methodSummary.SetAttribute("numBranchPoints", "0");
-                            methodSummary.SetAttribute("visitedBranchPoints", "0");
+                            methodSummary.SetAttribute("visitedSequencePoints", meth.Value.Where(l => l.Value.Hits > 0).Count().ToString());
+                            methodSummary.SetAttribute("numBranchPoints", meth.Value.Where(l => l.Value.IsBranchPoint).Count().ToString());
+                            methodSummary.SetAttribute("visitedBranchPoints", meth.Value.Where(l => l.Value.IsBranchPoint && l.Value.Hits > 0).Count().ToString());
                             methodSummary.SetAttribute("sequenceCoverage", "0");
                             methodSummary.SetAttribute("branchCoverage", "0");
                             methodSummary.SetAttribute("maxCyclomaticComplexity", "0");
@@ -154,7 +171,7 @@ public string Format(CoverageResult result)
                             method.AppendChild(methodName);
                             method.AppendChild(fileRef);
                             method.AppendChild(sequencePoints);
-                            method.AppendChild(xml.CreateElement("BranchPoints"));
+                            method.AppendChild(branchPoints);
                             method.AppendChild(methodPoint);
                             methods.AppendChild(method);
                             j++;
@@ -165,9 +182,9 @@ public string Format(CoverageResult result)
                             visitedClasses++;
 
                         classSummary.SetAttribute("numSequencePoints", cls.Value.Select(c => c.Value.Count).Sum().ToString());
-                        classSummary.SetAttribute("visitedSequencePoints", cls.Value.Select(c => c.Value.Where(l => l.Value > 0).Count()).Sum().ToString());
-                        classSummary.SetAttribute("numBranchPoints", "0");
-                        classSummary.SetAttribute("visitedBranchPoints", "0");
+                        classSummary.SetAttribute("visitedSequencePoints", cls.Value.Select(c => c.Value.Where(l => l.Value.Hits > 0).Count()).Sum().ToString());
+                        classSummary.SetAttribute("numBranchPoints", cls.Value.Select(c => c.Value.Count(l => l.Value.IsBranchPoint)).Sum().ToString());
+                        classSummary.SetAttribute("visitedBranchPoints", cls.Value.Select(c => c.Value.Where(l => l.Value.Hits > 0 && l.Value.IsBranchPoint).Count()).Sum().ToString());
                         classSummary.SetAttribute("sequenceCoverage", "0");
                         classSummary.SetAttribute("branchCoverage", "0");
                         classSummary.SetAttribute("maxCyclomaticComplexity", "0");
@@ -192,8 +209,8 @@ public string Format(CoverageResult result)
 
             coverageSummary.SetAttribute("numSequencePoints", numSequencePoints.ToString());
             coverageSummary.SetAttribute("visitedSequencePoints", visitedSequencePoints.ToString());
-            coverageSummary.SetAttribute("numBranchPoints", "0");
-            coverageSummary.SetAttribute("visitedBranchPoints", "0");
+            coverageSummary.SetAttribute("numBranchPoints", numBranchPoints.ToString());
+            coverageSummary.SetAttribute("visitedBranchPoints", visitedBranchPoints.ToString());
             coverageSummary.SetAttribute("sequenceCoverage", "0");
             coverageSummary.SetAttribute("branchCoverage", "0");
             coverageSummary.SetAttribute("maxCyclomaticComplexity", "0");
diff --git a/test/coverlet.core.tests/CoverageSummaryTests.cs b/test/coverlet.core.tests/CoverageSummaryTests.cs
@@ -14,8 +14,8 @@ public void TestCalculateSummary()
             CoverageResult result = new CoverageResult();
             result.Identifier = Guid.NewGuid().ToString();
             Lines lines = new Lines();
-            lines.Add(1, 1);
-            lines.Add(2, 0);
+            lines.Add(1, new LineInfo { Hits = 1 });
+            lines.Add(2, new LineInfo { Hits = 0 });
             Methods methods = new Methods();
             methods.Add("System.Void Coverlet.Core.Tests.CoverageSummaryTests.TestCalculateSummary()", lines);
             Classes classes = new Classes();
diff --git a/test/coverlet.core.tests/Reporters/JsonReporterTests.cs b/test/coverlet.core.tests/Reporters/JsonReporterTests.cs
@@ -11,8 +11,8 @@ public void TestFormat()
             CoverageResult result = new CoverageResult();
             result.Identifier = Guid.NewGuid().ToString();
             Lines lines = new Lines();
-            lines.Add(1, 1);
-            lines.Add(2, 0);
+            lines.Add(1, new LineInfo { Hits = 1 });
+            lines.Add(2, new LineInfo { Hits = 0 });
             Methods methods = new Methods();
             methods.Add("System.Void Coverlet.Core.Reporters.Tests.JsonReporterTests.TestFormat()", lines);
             Classes classes = new Classes();
diff --git a/test/coverlet.core.tests/Reporters/LcovReporterTests.cs b/test/coverlet.core.tests/Reporters/LcovReporterTests.cs
@@ -11,8 +11,8 @@ public void TestFormat()
             CoverageResult result = new CoverageResult();
             result.Identifier = Guid.NewGuid().ToString();
             Lines lines = new Lines();
-            lines.Add(1, 1);
-            lines.Add(2, 0);
+            lines.Add(1, new LineInfo { Hits = 1 });
+            lines.Add(2, new LineInfo { Hits = 0 });
             Methods methods = new Methods();
             methods.Add("System.Void Coverlet.Core.Reporters.Tests.LcovReporterTests.TestFormat()", lines);
             Classes classes = new Classes();
diff --git a/test/coverlet.core.tests/Reporters/OpenCoverReporterTests.cs b/test/coverlet.core.tests/Reporters/OpenCoverReporterTests.cs
@@ -39,8 +39,8 @@ public void TestFilesHaveUniqueIdsOverMultipleModules()
         private static Documents CreateFirstDocuments()
         {
             Lines lines = new Lines();
-            lines.Add(1, 1);
-            lines.Add(2, 0);
+            lines.Add(1, new LineInfo { Hits = 1 });
+            lines.Add(2, new LineInfo { Hits = 0 });
             Methods methods = new Methods();
             methods.Add("System.Void Coverlet.Core.Reporters.Tests.OpenCoverReporterTests.TestFormat()", lines);
             Classes classes = new Classes();
@@ -53,8 +53,8 @@ private static Documents CreateFirstDocuments()
         private static Documents CreateSecondDocuments()
         {            
             Lines lines = new Lines();
-            lines.Add(1, 1);
-            lines.Add(2, 0);
+            lines.Add(1, new LineInfo { Hits = 1 });
+            lines.Add(2, new LineInfo { Hits = 0 });
 
             Methods methods = new Methods();
             methods.Add("System.Void Some.Other.Module.TestClass.TestMethod()", lines);

Original file line number	Diff line number	Diff line change
`@@ -53,27 +53,27 @@ public CoverageResult GetCoverageResult()`
`53`	`53`	`{`
`54`	`54`	`if (methods.TryGetValue(line.Method, out Lines lines))`
`55`	`55`	`{`
`56`		`- documents[doc.Path][line.Class][line.Method].Add(line.Number, line.Hits);`
	`56`	`+ documents[doc.Path][line.Class][line.Method].Add(line.Number, new LineInfo { Hits = line.Hits, IsBranchPoint = line.IsBranchTarget });`
`57`	`57`	`}`
`58`	`58`	`else`
`59`	`59`	`{`
`60`	`60`	`documents[doc.Path][line.Class].Add(line.Method, new Lines());`
`61`		`- documents[doc.Path][line.Class][line.Method].Add(line.Number, line.Hits);`
	`61`	`+ documents[doc.Path][line.Class][line.Method].Add(line.Number, new LineInfo { Hits = line.Hits, IsBranchPoint = line.IsBranchTarget });`
`62`	`62`	`}`
`63`	`63`	`}`
`64`	`64`	`else`
`65`	`65`	`{`
`66`	`66`	`documents[doc.Path].Add(line.Class, new Methods());`
`67`	`67`	`documents[doc.Path][line.Class].Add(line.Method, new Lines());`
`68`		`- documents[doc.Path][line.Class][line.Method].Add(line.Number, line.Hits);`
	`68`	`+ documents[doc.Path][line.Class][line.Method].Add(line.Number, new LineInfo { Hits = line.Hits, IsBranchPoint = line.IsBranchTarget });`
`69`	`69`	`}`
`70`	`70`	`}`
`71`	`71`	`else`
`72`	`72`	`{`
`73`	`73`	`documents.Add(doc.Path, new Classes());`
`74`	`74`	`documents[doc.Path].Add(line.Class, new Methods());`
`75`	`75`	`documents[doc.Path][line.Class].Add(line.Method, new Lines());`
`76`		`- documents[doc.Path][line.Class][line.Method].Add(line.Number, line.Hits);`
	`76`	`+ documents[doc.Path][line.Class][line.Method].Add(line.Number, new LineInfo { Hits = line.Hits, IsBranchPoint = line.IsBranchTarget });`
`77`	`77`	`}`
`78`	`78`	`}`
`79`	`79`	`}`
`@@ -99,7 +99,7 @@ private void CalculateCoverage()`
`99`	`99`	`{`
`100`	`100`	`var info = lines[i].Split(',');`
`101`	`101`	`// Ignore malformed lines`
`102`		`- if (info.Length != 3)`
	`102`	`+ if (info.Length != 4)`
`103`	`103`	`continue;`
`104`	`104`
`105`	`105`	`var document = result.Documents.FirstOrDefault(d => d.Path == info[0]);`
`@@ -108,11 +108,15 @@ private void CalculateCoverage()`
`108`	`108`
`109`	`109`	`int start = int.Parse(info[1]);`
`110`	`110`	`int end = int.Parse(info[2]);`
	`111`	`+ bool target = info[3] == "B";`
`111`	`112`
`112`	`113`	`for (int j = start; j <= end; j++)`
`113`	`114`	`{`
`114`	`115`	`var line = document.Lines.First(l => l.Number == j);`
`115`	`116`	`line.Hits = line.Hits + 1;`
	`117`	`+`
	`118`	`+ if (j == start)`
	`119`	`+ line.IsBranchTarget = target;`
`116`	`120`	`}`
`117`	`121`	`}`
`118`	`122`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public CoverageSummaryResult CalculateSummary()`
`25`	`25`	`foreach (var line in method.Value)`
`26`	`26`	`{`
`27`	`27`	`totalLines++;`
`28`		`- if (line.Value > 0)`
	`28`	`+ if (line.Value.Hits > 0)`
`29`	`29`	`linesCovered++;`
`30`	`30`	`}`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ internal class Line`
`7`	`7`	`public int Number;`
`8`	`8`	`public string Class;`
`9`	`9`	`public string Method;`
	`10`	`+ public bool IsBranchTarget;`
`10`	`11`	`public int Hits;`
`11`	`12`	`}`
`12`	`13`