Merge pull request #227 from Reptarsrage/226_teamcity_support

tonerdo · web-flow · commit 7ede9d7cba38 · 2018-11-13T21:45:34.000+01:00
226 teamcity support
diff --git a/README.md b/README.md
@@ -98,6 +98,7 @@ Supported Formats:
 * lcov
 * opencover
 * cobertura
+* teamcity
 
 The `--format` option can be specified multiple times to output multiple formats in a single run:
 
@@ -117,6 +118,28 @@ The above command will write the results to the supplied path, if no file extens
 coverlet <ASSEMBLY> --target <TARGET> --targetargs <TARGETARGS> --output "/custom/directory/" -f json -f lcov
 ```
 
+#### TeamCity Output
+
+Coverlet can output basic code coverage statistics using [TeamCity service messages](https://confluence.jetbrains.com/display/TCD18/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ServiceMessages).
+
+```bash
+coverlet <ASSEMBLY> --target <TARGET> --targetargs <TARGETARGS> --output teamcity
+```
+
+The currently supported [TeamCity statistics](https://confluence.jetbrains.com/display/TCD18/Build+Script+Interaction+with+TeamCity#BuildScriptInteractionwithTeamCity-ServiceMessages) are:
+
+| TeamCity Statistic Key  | Description                    |
+| :---                    | :---                           |
+| CodeCoverageL           | Line-level code coverage       |
+| CodeCoverageC           | Class-level code coverage      |
+| CodeCoverageM           | Method-level code coverage     |
+| CodeCoverageAbsLTotal   | The total number of lines      |
+| CodeCoverageAbsLCovered | The number of covered lines    |
+| CodeCoverageAbsCTotal   | The total number of classes    |
+| CodeCoverageAbsCCovered | The number of covered classes  |
+| CodeCoverageAbsMTotal   | The total number of methods    |
+| CodeCoverageAbsMCovered | The number of covered methods  |
+
 #### Merging Results
 
 With Coverlet you can combine the output of multiple coverage runs into a single result.
@@ -234,6 +257,7 @@ Supported Formats:
 * lcov
 * opencover
 * cobertura
+* teamcity
 
 You can specify multiple output formats by separating them with a comma (`,`).
 
diff --git a/src/coverlet.console/Program.cs b/src/coverlet.console/Program.cs
@@ -3,7 +3,6 @@
 using System.Diagnostics;
 using System.IO;
 using System.Text;
-
 using ConsoleTables;
 using Coverlet.Console.Logging;
 using Coverlet.Core;
@@ -73,22 +72,32 @@ static int Main(string[] args)
                     if (reporter == null)
                         throw new Exception($"Specified output format '{format}' is not supported");
 
-                    var filename = Path.GetFileName(dOutput);
-                    filename = (filename == string.Empty) ? $"coverage.{reporter.Extension}" : filename;
-                    filename = Path.HasExtension(filename) ? filename : $"{filename}.{reporter.Extension}";
-
-                    var report = Path.Combine(directory, filename);
-                    logger.LogInformation($"  Generating report '{report}'");
-                    File.WriteAllText(report, reporter.Report(result));
+                    if (reporter.OutputType == ReporterOutputType.Console)
+                    {
+                        // Output to console
+                        logger.LogInformation("  Outputting results to console");
+                        logger.LogInformation(reporter.Report(result));
+                    }
+                    else
+                    {
+                        // Output to file
+                        var filename = Path.GetFileName(dOutput);
+                        filename = (filename == string.Empty) ? $"coverage.{reporter.Extension}" : filename;
+                        filename = Path.HasExtension(filename) ? filename : $"{filename}.{reporter.Extension}";
+
+                        var report = Path.Combine(directory, filename);
+                        logger.LogInformation($"  Generating report '{report}'");
+                        File.WriteAllText(report, reporter.Report(result));
+                    }
                 }
 
                 var summary = new CoverageSummary();
                 var exceptionBuilder = new StringBuilder();
                 var coverageTable = new ConsoleTable("Module", "Line", "Branch", "Method");
                 var thresholdFailed = false;
-                var overallLineCoverage = summary.CalculateLineCoverage(result.Modules).Percent * 100;
-                var overallBranchCoverage = summary.CalculateBranchCoverage(result.Modules).Percent * 100;
-                var overallMethodCoverage = summary.CalculateMethodCoverage(result.Modules).Percent * 100;
+                var overallLineCoverage = summary.CalculateLineCoverage(result.Modules);
+                var overallBranchCoverage = summary.CalculateBranchCoverage(result.Modules);
+                var overallMethodCoverage = summary.CalculateMethodCoverage(result.Modules);
 
                 foreach (var _module in result.Modules)
                 {
@@ -122,9 +131,9 @@ static int Main(string[] args)
 
                 logger.LogInformation(string.Empty);
                 logger.LogInformation(coverageTable.ToStringAlternative());
-                logger.LogInformation($"Total Line: {overallLineCoverage}%");
-                logger.LogInformation($"Total Branch: {overallBranchCoverage}%");
-                logger.LogInformation($"Total Method: {overallMethodCoverage}%");
+                logger.LogInformation($"Total Line: {overallLineCoverage.Percent * 100}%");
+                logger.LogInformation($"Total Branch: {overallBranchCoverage.Percent * 100}%");
+                logger.LogInformation($"Total Method: {overallMethodCoverage.Percent * 100}%");
 
                 if (thresholdFailed)
                     throw new Exception(exceptionBuilder.ToString().TrimEnd(Environment.NewLine.ToCharArray()));
diff --git a/src/coverlet.core/Reporters/CoberturaReporter.cs b/src/coverlet.core/Reporters/CoberturaReporter.cs
@@ -10,6 +10,8 @@ namespace Coverlet.Core.Reporters
 {
     public class CoberturaReporter : IReporter
     {
+        public ReporterOutputType OutputType => ReporterOutputType.File;
+
         public string Format => "cobertura";
 
         public string Extension => "cobertura.xml";
diff --git a/src/coverlet.core/Reporters/IReporter.cs b/src/coverlet.core/Reporters/IReporter.cs
@@ -2,8 +2,15 @@ namespace Coverlet.Core.Reporters
 {
     public interface IReporter
     {
+        ReporterOutputType OutputType { get; }
         string Format { get; }
         string Extension { get; }
         string Report(CoverageResult result);
     }
+
+    public enum ReporterOutputType
+    {
+        File,
+        Console,
+    }
 }
diff --git a/src/coverlet.core/Reporters/JsonReporter.cs b/src/coverlet.core/Reporters/JsonReporter.cs
@@ -4,6 +4,8 @@ namespace Coverlet.Core.Reporters
 {
     public class JsonReporter : IReporter
     {
+        public ReporterOutputType OutputType => ReporterOutputType.File;
+        
         public string Format => "json";
 
         public string Extension => "json";
diff --git a/src/coverlet.core/Reporters/LcovReporter.cs b/src/coverlet.core/Reporters/LcovReporter.cs
@@ -6,6 +6,8 @@ namespace Coverlet.Core.Reporters
 {
     public class LcovReporter : IReporter
     {
+        public ReporterOutputType OutputType => ReporterOutputType.File;
+        
         public string Format => "lcov";
 
         public string Extension => "info";
diff --git a/src/coverlet.core/Reporters/OpenCoverReporter.cs b/src/coverlet.core/Reporters/OpenCoverReporter.cs
@@ -9,6 +9,8 @@ namespace Coverlet.Core.Reporters
 {
     public class OpenCoverReporter : IReporter
     {
+        public ReporterOutputType OutputType => ReporterOutputType.File;
+        
         public string Format => "opencover";
 
         public string Extension => "opencover.xml";
diff --git a/src/coverlet.core/Reporters/ReporterFactory.cs b/src/coverlet.core/Reporters/ReporterFactory.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Linq;
 using System.Collections.Generic;
+using coverlet.core.Reporters;
 
 namespace Coverlet.Core.Reporters
 {
@@ -14,7 +15,8 @@ public ReporterFactory(string format)
             _format = format;
             _reporters = new IReporter[] {
                 new JsonReporter(), new LcovReporter(),
-                new OpenCoverReporter(), new CoberturaReporter()
+                new OpenCoverReporter(), new CoberturaReporter(),
+                new TeamCityReporter()
             };
         }
 
diff --git a/src/coverlet.core/Reporters/TeamCityReporter.cs b/src/coverlet.core/Reporters/TeamCityReporter.cs
@@ -0,0 +1,74 @@
+﻿using Coverlet.Core;
+using Coverlet.Core.Reporters;
+using System.Text;
+
+namespace coverlet.core.Reporters
+{
+    public class TeamCityReporter : IReporter
+    {
+        public ReporterOutputType OutputType => ReporterOutputType.Console;
+
+        public string Format => "teamcity";
+
+        public string Extension => null;
+
+        public string Report(CoverageResult result)
+        {
+            // Calculate coverage
+            var summary = new CoverageSummary();
+            var overallLineCoverage = summary.CalculateLineCoverage(result.Modules);
+            var overallBranchCoverage = summary.CalculateBranchCoverage(result.Modules);
+            var overallMethodCoverage = summary.CalculateMethodCoverage(result.Modules);
+
+            // Report coverage
+            var stringBuilder = new StringBuilder();
+            OutputLineCoverage(overallLineCoverage, stringBuilder);
+            OutputBranchCoverage(overallBranchCoverage, stringBuilder);
+            OutputMethodCoverage(overallMethodCoverage, stringBuilder);
+
+            // Return a placeholder
+            return stringBuilder.ToString();
+        }
+
+        private void OutputLineCoverage(CoverageDetails coverageDetails, StringBuilder builder)
+        {
+            // The total number of lines
+            OutputTeamCityServiceMessage("CodeCoverageL", coverageDetails.Total, builder);
+
+            // The number of covered lines
+            OutputTeamCityServiceMessage("CodeCoverageAbsLCovered", coverageDetails.Covered, builder);
+
+            // Line-level code coverage
+            OutputTeamCityServiceMessage("CodeCoverageAbsLTotal", coverageDetails.Percent * 100, builder);
+        }
+
+        private void OutputBranchCoverage(CoverageDetails coverageDetails, StringBuilder builder)
+        {
+            // The total number of branches
+            OutputTeamCityServiceMessage("CodeCoverageR", coverageDetails.Total, builder);
+
+            // The number of covered branches
+            OutputTeamCityServiceMessage("CodeCoverageAbsRCovered", coverageDetails.Covered, builder);
+
+            // Branch-level code coverage
+            OutputTeamCityServiceMessage("CodeCoverageAbsRTotal", coverageDetails.Percent * 100, builder);
+        }
+
+        private void OutputMethodCoverage(CoverageDetails coverageDetails, StringBuilder builder)
+        {
+            // The total number of methods
+            OutputTeamCityServiceMessage("CodeCoverageM", coverageDetails.Total, builder);
+
+            // The number of covered methods
+            OutputTeamCityServiceMessage("CodeCoverageAbsMCovered", coverageDetails.Covered, builder);
+
+            // Method-level code coverage
+            OutputTeamCityServiceMessage("CodeCoverageAbsMTotal", coverageDetails.Percent * 100, builder);
+        }
+
+        private void OutputTeamCityServiceMessage(string key, object value, StringBuilder builder)
+        {
+            builder.AppendLine($"##teamcity[buildStatisticValue key='{key}' value='{value}']");
+        }
+    }
+}
diff --git a/src/coverlet.msbuild.tasks/CoverageResultTask.cs b/src/coverlet.msbuild.tasks/CoverageResultTask.cs
@@ -65,23 +65,33 @@ public override bool Execute()
                     if (reporter == null)
                         throw new Exception($"Specified output format '{format}' is not supported");
 
-                    var filename = Path.GetFileName(_output);
-                    filename = (filename == string.Empty) ? $"coverage.{reporter.Extension}" : filename;
-                    filename = Path.HasExtension(filename) ? filename : $"{filename}.{reporter.Extension}";
-
-                    var report = Path.Combine(directory, filename);
-                    Console.WriteLine($"  Generating report '{report}'");
-                    File.WriteAllText(report, reporter.Report(result));
+                    if (reporter.OutputType == ReporterOutputType.Console)
+                    {
+                        // Output to console
+                        Console.WriteLine("  Outputting results to console");
+                        Console.WriteLine(reporter.Report(result));
+                    }
+                    else
+                    {
+                        // Output to file
+                        var filename = Path.GetFileName(_output);
+                        filename = (filename == string.Empty) ? $"coverage.{reporter.Extension}" : filename;
+                        filename = Path.HasExtension(filename) ? filename : $"{filename}.{reporter.Extension}";
+
+                        var report = Path.Combine(directory, filename);
+                        Console.WriteLine($"  Generating report '{report}'");
+                        File.WriteAllText(report, reporter.Report(result));
+                    }
                 }
 
                 var thresholdFailed = false;
                 var thresholdTypes = _thresholdType.Split(',').Select(t => t.Trim());
                 var summary = new CoverageSummary();
                 var exceptionBuilder = new StringBuilder();
                 var coverageTable = new ConsoleTable("Module", "Line", "Branch", "Method");
-                var overallLineCoverage = summary.CalculateLineCoverage(result.Modules).Percent * 100;
-                var overallBranchCoverage = summary.CalculateBranchCoverage(result.Modules).Percent * 100;
-                var overallMethodCoverage = summary.CalculateMethodCoverage(result.Modules).Percent * 100;
+                var overallLineCoverage = summary.CalculateLineCoverage(result.Modules);
+                var overallBranchCoverage = summary.CalculateBranchCoverage(result.Modules);
+                var overallMethodCoverage = summary.CalculateMethodCoverage(result.Modules);
 
                 foreach (var module in result.Modules)
                 {
@@ -115,9 +125,9 @@ public override bool Execute()
 
                 Console.WriteLine();
                 Console.WriteLine(coverageTable.ToStringAlternative());
-                Console.WriteLine($"Total Line: {overallLineCoverage}%");
-                Console.WriteLine($"Total Branch: {overallBranchCoverage}%");
-                Console.WriteLine($"Total Method: {overallMethodCoverage}%");
+                Console.WriteLine($"Total Line: {overallLineCoverage.Percent * 100}%");
+                Console.WriteLine($"Total Branch: {overallBranchCoverage.Percent * 100}%");
+                Console.WriteLine($"Total Method: {overallMethodCoverage.Percent * 100}%");
 
                 if (thresholdFailed)
                     throw new Exception(exceptionBuilder.ToString().TrimEnd(Environment.NewLine.ToCharArray()));
diff --git a/test/coverlet.core.tests/Reporters/ReporterFactoryTests.cs b/test/coverlet.core.tests/Reporters/ReporterFactoryTests.cs
@@ -1,4 +1,4 @@
-using System;
+using coverlet.core.Reporters;
 using Xunit;
 
 namespace Coverlet.Core.Reporters.Tests
@@ -12,6 +12,7 @@ public void TestCreateReporter()
             Assert.Equal(typeof(LcovReporter), new ReporterFactory("lcov").CreateReporter().GetType());
             Assert.Equal(typeof(OpenCoverReporter), new ReporterFactory("opencover").CreateReporter().GetType());
             Assert.Equal(typeof(CoberturaReporter), new ReporterFactory("cobertura").CreateReporter().GetType());
+            Assert.Equal(typeof(TeamCityReporter), new ReporterFactory("teamcity").CreateReporter().GetType());
             Assert.Null(new ReporterFactory("").CreateReporter());
         }
     }
diff --git a/test/coverlet.core.tests/Reporters/TeamCityReporter.cs b/test/coverlet.core.tests/Reporters/TeamCityReporter.cs

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ namespace Coverlet.Core.Reporters`
`10`	`10`	`{`
`11`	`11`	`public class CoberturaReporter : IReporter`
`12`	`12`	`{`
	`13`	`+ public ReporterOutputType OutputType => ReporterOutputType.File;`
	`14`	`+`
`13`	`15`	`public string Format => "cobertura";`
`14`	`16`
`15`	`17`	`public string Extension => "cobertura.xml";`
Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,15 @@ namespace Coverlet.Core.Reporters`
`2`	`2`	`{`
`3`	`3`	`public interface IReporter`
`4`	`4`	`{`
	`5`	`+ ReporterOutputType OutputType { get; }`
`5`	`6`	`string Format { get; }`
`6`	`7`	`string Extension { get; }`
`7`	`8`	`string Report(CoverageResult result);`
`8`	`9`	`}`
	`10`	`+`
	`11`	`+ public enum ReporterOutputType`
	`12`	`+ {`
	`13`	`+ File,`
	`14`	`+ Console,`
	`15`	`+ }`
`9`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@ namespace Coverlet.Core.Reporters`
`4`	`4`	`{`
`5`	`5`	`public class JsonReporter : IReporter`
`6`	`6`	`{`
	`7`	`+ public ReporterOutputType OutputType => ReporterOutputType.File;`
	`8`	`+`
`7`	`9`	`public string Format => "json";`
`8`	`10`
`9`	`11`	`public string Extension => "json";`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@ namespace Coverlet.Core.Reporters`
`6`	`6`	`{`
`7`	`7`	`public class LcovReporter : IReporter`
`8`	`8`	`{`
	`9`	`+ public ReporterOutputType OutputType => ReporterOutputType.File;`
	`10`	`+`
`9`	`11`	`public string Format => "lcov";`
`10`	`12`
`11`	`13`	`public string Extension => "info";`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@ namespace Coverlet.Core.Reporters`
`9`	`9`	`{`
`10`	`10`	`public class OpenCoverReporter : IReporter`
`11`	`11`	`{`
	`12`	`+ public ReporterOutputType OutputType => ReporterOutputType.File;`
	`13`	`+`
`12`	`14`	`public string Format => "opencover";`
`13`	`15`
`14`	`16`	`public string Extension => "opencover.xml";`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using System;`
	`1`	`+using coverlet.core.Reporters;`
`2`	`2`	`using Xunit;`
`3`	`3`
`4`	`4`	`namespace Coverlet.Core.Reporters.Tests`
`@@ -12,6 +12,7 @@ public void TestCreateReporter()`
`12`	`12`	`Assert.Equal(typeof(LcovReporter), new ReporterFactory("lcov").CreateReporter().GetType());`
`13`	`13`	`Assert.Equal(typeof(OpenCoverReporter), new ReporterFactory("opencover").CreateReporter().GetType());`
`14`	`14`	`Assert.Equal(typeof(CoberturaReporter), new ReporterFactory("cobertura").CreateReporter().GetType());`
	`15`	`+ Assert.Equal(typeof(TeamCityReporter), new ReporterFactory("teamcity").CreateReporter().GetType());`
`15`	`16`	`Assert.Null(new ReporterFactory("").CreateReporter());`
`16`	`17`	`}`
`17`	`18`	`}`