Merge pull request #96 from binarymash/feature/testCoverage

Test coverage reporting
2025-11-04 18:30:48 +08:00 · 2017-05-09 20:38:56 +01:00
parent e34317a539 e9ab5d64ea
commit 64814358fa
5 changed files with 85 additions and 11 deletions
--- a/build.cake
+++ b/build.cake
@@ -1,6 +1,10 @@
 #tool "nuget:?package=GitVersion.CommandLine"
 #tool "nuget:?package=GitReleaseNotes"
 #addin "nuget:?package=Cake.Json"
+#tool "nuget:?package=OpenCover"
+#tool "nuget:?package=ReportGenerator"
+#tool coveralls.net
+#addin Cake.Coveralls

 // compile
 var compileConfig = Argument("configuration", "Release");
@@ -12,6 +16,9 @@ var artifactsDir = Directory("artifacts");
 // unit testing
 var artifactsForUnitTestsDir = artifactsDir + Directory("UnitTests");
 var unitTestAssemblies = @"./test/Ocelot.UnitTests/Ocelot.UnitTests.csproj";
+var minCodeCoverage = 75d;
+var coverallsRepoToken = "coveralls-repo-token-ocelot";
+var coverallsRepo = "https://coveralls.io/github/TomPallister/Ocelot";

 // acceptance testing
 var artifactsForAcceptanceTestsDir = artifactsDir + Directory("AcceptanceTests");
@@ -117,6 +124,62 @@ Task("Compile")
 Task("RunUnitTests")
 	.IsDependentOn("Compile")
 	.Does(() =>
+	{
+		if (IsRunningOnWindows())
+		{
+			var coverageSummaryFile = artifactsForUnitTestsDir + File("coverage.xml");
+        
+			EnsureDirectoryExists(artifactsForUnitTestsDir);
+        
+			OpenCover(tool => 
+				{
+					tool.DotNetCoreTest(unitTestAssemblies);
+				},
+				new FilePath(coverageSummaryFile),
+				new OpenCoverSettings()
+				{
+					Register="user",
+					ArgumentCustomization=args=>args.Append(@"-oldstyle -returntargetcode")
+				}
+				.WithFilter("+[Ocelot*]*")
+				.WithFilter("-[xunit*]*")
+				.WithFilter("-[Ocelot*Tests]*")
+			);
+        
+			ReportGenerator(coverageSummaryFile, artifactsForUnitTestsDir);
+		
+			if (AppVeyor.IsRunningOnAppVeyor)
+			{
+				var repoToken = EnvironmentVariable(coverallsRepoToken);
+				if (string.IsNullOrEmpty(repoToken))
+				{
+					throw new Exception(string.Format("Coveralls repo token not found. Set environment variable '{0}'", coverallsRepoToken));
+				}
+
+				Information(string.Format("Uploading test coverage to {0}", coverallsRepo));
+				CoverallsNet(coverageSummaryFile, CoverallsNetReportType.OpenCover, new CoverallsNetSettings()
+				{
+					RepoToken = repoToken
+				});
+			}
+			else
+			{
+				Information("We are not running on the build server so we won't publish the coverage report to coveralls.io");
+			}
+
+			var sequenceCoverage = XmlPeek(coverageSummaryFile, "//CoverageSession/Summary/@sequenceCoverage");
+			var branchCoverage = XmlPeek(coverageSummaryFile, "//CoverageSession/Summary/@branchCoverage");
+
+			Information("Sequence Coverage: " + sequenceCoverage);
+		
+			if(double.Parse(sequenceCoverage) < minCodeCoverage)
+			{
+				var whereToCheck = !AppVeyor.IsRunningOnAppVeyor ? coverallsRepo : artifactsForUnitTestsDir;
+				throw new Exception(string.Format("Code coverage fell below the threshold of {0}%. You can find the code coverage report at {1}", minCodeCoverage, whereToCheck));
+			};
+		
+		}
+		else
 		{
 			var settings = new DotNetCoreTestSettings
 			{
@@ -125,6 +188,7 @@ Task("RunUnitTests")

 			EnsureDirectoryExists(artifactsForUnitTestsDir);
 			DotNetCoreTest(unitTestAssemblies, settings);
+		}
 	});

 Task("RunAcceptanceTests")
--- a/src/Ocelot/Ocelot.csproj
+++ b/src/Ocelot/Ocelot.csproj
@@ -20,6 +20,11 @@
 	<Authors>Tom Pallister</Authors>
  </PropertyGroup>

+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DebugType>full</DebugType>
+    <DebugSymbols>True</DebugSymbols>
+  </PropertyGroup>
+
  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.Server.IISIntegration" Version="1.1.1" />
    <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="1.1.1" />
--- a/test/Ocelot.AcceptanceTests/Ocelot.AcceptanceTests.csproj
+++ b/test/Ocelot.AcceptanceTests/Ocelot.AcceptanceTests.csproj
@@ -31,7 +31,7 @@

  <ItemGroup>
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0-preview-20170106-08" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0-beta5-build1225" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.3.0-beta2-build1317" />
    <PackageReference Include="Microsoft.AspNetCore.Server.IISIntegration" Version="1.1.1" />
    <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="1.1.1" />
    <PackageReference Include="Microsoft.Extensions.Configuration.FileExtensions" Version="1.1.1" />
@@ -51,7 +51,7 @@
    <PackageReference Include="TestStack.BDDfy" Version="4.3.2" />
    <PackageReference Include="Consul" Version="0.7.2.1" />
    <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="1.1.1" />
-    <PackageReference Include="xunit" Version="2.2.0-beta5-build3474" />
+    <PackageReference Include="xunit" Version="2.3.0-beta2-build3683" />
  </ItemGroup>

 </Project>
--- a/test/Ocelot.IntegrationTests/Ocelot.IntegrationTests.csproj
+++ b/test/Ocelot.IntegrationTests/Ocelot.IntegrationTests.csproj
@@ -31,7 +31,7 @@

  <ItemGroup>
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0-preview-20170106-08" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0-beta5-build1225" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.3.0-beta2-build1317" />
    <PackageReference Include="Microsoft.AspNetCore.Server.IISIntegration" Version="1.1.1" />
    <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="1.1.1" />
    <PackageReference Include="Microsoft.Extensions.Configuration.FileExtensions" Version="1.1.1" />
@@ -42,7 +42,7 @@
    <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="1.1.1" />
    <PackageReference Include="Microsoft.AspNetCore.Http" Version="1.1.1" />
    <PackageReference Include="Microsoft.DotNet.InternalAbstractions" Version="1.0.0" />
-    <PackageReference Include="xunit" Version="2.2.0-beta5-build3474" />
+    <PackageReference Include="xunit" Version="2.3.0-beta2-build3683" />
    <PackageReference Include="Microsoft.AspNetCore.TestHost" Version="1.1.1" />
    <PackageReference Include="IdentityServer4" Version="1.0.1" />
    <PackageReference Include="Microsoft.AspNetCore.Mvc" Version="1.1.2" />
--- a/test/Ocelot.UnitTests/Ocelot.UnitTests.csproj
+++ b/test/Ocelot.UnitTests/Ocelot.UnitTests.csproj
@@ -14,6 +14,11 @@
    <GenerateAssemblyProductAttribute>false</GenerateAssemblyProductAttribute>
  </PropertyGroup>

+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DebugType>full</DebugType>
+    <DebugSymbols>True</DebugSymbols>
+  </PropertyGroup>
+
  <ItemGroup>
    <ProjectReference Include="..\..\src\Ocelot\Ocelot.csproj" />
  </ItemGroup>
@@ -24,7 +29,7 @@

  <ItemGroup>
    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0-preview-20170106-08" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0-beta5-build1225" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.3.0-beta2-build1317" />
    <PackageReference Include="Microsoft.AspNetCore.Authentication.OAuth" Version="1.1.1" />
    <PackageReference Include="Microsoft.AspNetCore.Cryptography.KeyDerivation" Version="1.1.1" />
    <PackageReference Include="Microsoft.AspNetCore.Http" Version="1.1.1" />
@@ -43,7 +48,7 @@
    <PackageReference Include="Moq" Version="4.6.38-alpha" />
    <PackageReference Include="Shouldly" Version="2.8.2" />
    <PackageReference Include="TestStack.BDDfy" Version="4.3.2" />
-    <PackageReference Include="xunit" Version="2.2.0-beta5-build3474" />
+    <PackageReference Include="xunit" Version="2.3.0-beta2-build3683" />
  </ItemGroup>

 </Project>