set exit code according ExitCodes.cs

Author: Bertk

Directory.Packages.props

@@ -54,18 +54,18 @@
     <PackageVersion Include="Tmds.ExecFunction" Version="0.8.0" />
     <PackageVersion Include="xunit.v3" Version="$(XunitV3Version)" />
     <PackageVersion Include="xunit.runner.visualstudio" Version="$(XunitRunnerVisualstudioVersion)" />
-    <PackageVersion Include="System.Buffers" Version="4.6.0" />
+    <PackageVersion Include="System.Buffers" Version="4.6.1" />
     <PackageVersion Include="System.Collections.Immutable" Version="8.0.0" />
     <PackageVersion Include="System.Configuration.ConfigurationManager" Version="8.0.0" />
     <PackageVersion Include="System.Linq.Async" Version="6.0.1" />
-    <PackageVersion Include="System.Memory" Version="4.6.0" />
+    <PackageVersion Include="System.Memory" Version="4.6.2" />
     <PackageVersion Include="System.Net.Http" Version="4.3.4" />
     <PackageVersion Include="System.Reflection.Metadata" Version="8.0.1" />
-    <PackageVersion Include="System.Runtime.CompilerServices.Unsafe" Version="6.1.0" />
+    <PackageVersion Include="System.Runtime.CompilerServices.Unsafe" Version="6.1.1" />
     <PackageVersion Include="System.Security.Cryptography.Pkcs" Version="6.0.5" />
     <PackageVersion Include="System.Text.Encoding.CodePages" Version="8.0.0" />
     <PackageVersion Include="System.Text.Json" Version="8.0.5" />
     <PackageVersion Include="System.Text.RegularExpressions" Version="4.3.1" />
-    <PackageVersion Include="System.Threading.Tasks.Extensions" Version="4.6.0" />
+    <PackageVersion Include="System.Threading.Tasks.Extensions" Version="4.6.2" />
   </ItemGroup>
 </Project>

Documentation/GlobalTool.md

@@ -275,5 +275,4 @@ Coverlet outputs specific exit codes to better support build automation systems
 2 - Coverage percentage is below threshold.
 3 - Test fails and also coverage percentage is below threshold.
 101 - General exception occurred during coverlet process.
-102 - Missing options or invalid arguments for coverlet process.
 ```

global.json

@@ -1,5 +1,5 @@
 {
     "sdk": {
-        "version": "8.0.113"
+        "version": "8.0.114"
     }
 }

src/coverlet.collector/coverlet.collector.csproj

@@ -27,7 +27,6 @@
     <Authors>tonerdo</Authors>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/coverlet-coverage/coverlet</PackageProjectUrl>
-    <PackageIconUrl>https://raw.githubusercontent.com/tonerdo/coverlet/master/_assets/coverlet-icon.svg?sanitize=true</PackageIconUrl>
     <PackageIcon>coverlet-icon.png</PackageIcon>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <Description>Coverlet is a cross platform code coverage library for .NET, with support for line, branch and method coverage.</Description>

src/coverlet.console/ExitCodes.cs

@@ -28,10 +28,5 @@ internal enum CommandExitCodes
   /// Indicates exception occurred during Coverlet process.
   /// </summary>
   Exception = 101,
-
-  /// <summary>
-  /// Indicates missing options or empty arguments for Coverlet process.
-  /// </summary>
-  CommandParsingException = 102
 }
 

src/coverlet.console/Program.cs

@@ -25,6 +25,7 @@ namespace Coverlet.Console
 {
   public static class Program
   {
+    static int s_exitCode;
     static int Main(string[] args)
     {
       var moduleOrAppDirectory = new Argument<string>("path", "Path to the test assembly or application directory.");
@@ -175,7 +176,7 @@ string sourceMappingFile
 
       // Adjust log level based on user input.
       logger.Level = verbosity;
-      int exitCode = (int)CommandExitCodes.Success;
+      s_exitCode = (int)CommandExitCodes.Success;
 
       try
       {
@@ -357,44 +358,44 @@ string sourceMappingFile
         logger.LogInformation(coverageTable.ToStringAlternative());
         if (process.ExitCode > 0)
         {
-          exitCode += (int)CommandExitCodes.TestFailed;
+          s_exitCode = (int)CommandExitCodes.TestFailed;
         }
 
         ThresholdTypeFlags thresholdTypeFlags = result.GetThresholdTypesBelowThreshold(thresholdTypeFlagValues, thresholdStat);
         if (thresholdTypeFlags != ThresholdTypeFlags.None)
         {
-          exitCode += (int)CommandExitCodes.CoverageBelowThreshold;
-          var exceptionMessageBuilder = new StringBuilder();
+          s_exitCode = (int)CommandExitCodes.CoverageBelowThreshold;
+          var errorMessageBuilder = new StringBuilder();
           if ((thresholdTypeFlags & ThresholdTypeFlags.Line) != ThresholdTypeFlags.None)
           {
-            exceptionMessageBuilder.AppendLine($"The {thresholdStat.ToString().ToLower()} line coverage is below the specified {thresholdTypeFlagValues[ThresholdTypeFlags.Line]}");
+            errorMessageBuilder.AppendLine($"The {thresholdStat.ToString().ToLower()} line coverage is below the specified {thresholdTypeFlagValues[ThresholdTypeFlags.Line]}");
           }
 
           if ((thresholdTypeFlags & ThresholdTypeFlags.Branch) != ThresholdTypeFlags.None)
           {
-            exceptionMessageBuilder.AppendLine($"The {thresholdStat.ToString().ToLower()} branch coverage is below the specified {thresholdTypeFlagValues[ThresholdTypeFlags.Branch]}");
+            errorMessageBuilder.AppendLine($"The {thresholdStat.ToString().ToLower()} branch coverage is below the specified {thresholdTypeFlagValues[ThresholdTypeFlags.Branch]}");
           }
 
           if ((thresholdTypeFlags & ThresholdTypeFlags.Method) != ThresholdTypeFlags.None)
           {
-            exceptionMessageBuilder.AppendLine($"The {thresholdStat.ToString().ToLower()} method coverage is below the specified {thresholdTypeFlagValues[ThresholdTypeFlags.Method]}");
+            errorMessageBuilder.AppendLine($"The {thresholdStat.ToString().ToLower()} method coverage is below the specified {thresholdTypeFlagValues[ThresholdTypeFlags.Method]}");
           }
-          throw new InvalidOperationException(exceptionMessageBuilder.ToString());
+          logger.LogError(errorMessageBuilder.ToString());
         }
 
-        return Task.FromResult(exitCode);
+        return Task.FromResult(s_exitCode);
 
       }
 
       catch (Win32Exception we) when (we.Source == "System.Diagnostics.Process")
       {
         logger.LogError($"Start process '{target}' failed with '{we.Message}'");
-        return Task.FromResult(exitCode > 0 ? exitCode : (int)CommandExitCodes.Exception);
+        return Task.FromResult(s_exitCode > 0 ? s_exitCode : (int)CommandExitCodes.Exception);
       }
       catch (Exception ex)
       {
         logger.LogError(ex.Message);
-        return Task.FromResult(exitCode > 0 ? exitCode : (int)CommandExitCodes.Exception);
+        return Task.FromResult(s_exitCode > 0 ? s_exitCode : (int)CommandExitCodes.Exception);
       }
 
     }

src/coverlet.console/coverlet.console.csproj

@@ -16,7 +16,6 @@
     <PackageTags>coverage;testing;unit-test;lcov;opencover;quality</PackageTags>
     <PackageReadmeFile>GlobalTool.md</PackageReadmeFile>
     <PackageReleaseNotes>https://github.com/coverlet-coverage/coverlet/blob/master/Documentation/Changelog.md</PackageReleaseNotes>
-    <PackageIconUrl>https://raw.githubusercontent.com/tonerdo/coverlet/master/_assets/coverlet-icon.svg?sanitize=true</PackageIconUrl>
     <PackageIcon>coverlet-icon.png</PackageIcon>
     <PackageProjectUrl>https://github.com/coverlet-coverage/coverlet</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>

src/coverlet.msbuild.tasks/coverlet.msbuild.tasks.csproj

@@ -28,7 +28,6 @@
     <Authors>tonerdo</Authors>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/coverlet-coverage/coverlet</PackageProjectUrl>
-    <PackageIconUrl>https://raw.githubusercontent.com/tonerdo/coverlet/master/_assets/coverlet-icon.svg?sanitize=true</PackageIconUrl>
     <PackageIcon>coverlet-icon.png</PackageIcon>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <DevelopmentDependency>true</DevelopmentDependency>

test/coverlet.integration.template/DeepThought.cs

@@ -1,10 +1,21 @@
-namespace Coverlet.Integration.Template
+namespace Coverlet.Integration.Template
 {
-    public class DeepThought
+  public class DeepThought
+  {
+    public int AnswerToTheUltimateQuestionOfLifeTheUniverseAndEverything()
     {
-        public int AnswerToTheUltimateQuestionOfLifeTheUniverseAndEverything()
-        {
-            return 42;
-        }
+      return 42;
     }
+
+    // This method is not covered by any test
+    // It is here to demonstrate how Coverlet will report on untested code
+    // required for Coverlet.Integration.Tests.DotnetGlobalTools.StandAloneThreshold
+    // required for Coverlet.Integration.Tests.DotnetGlobalTools.DotnetToolThreshold
+    public void TheUntestedMethod()
+    {
+#pragma warning disable CS0219 // Variable is assigned but its value is never used
+      string s = "this will never be covered by any test";
+#pragma warning restore CS0219 // Variable is assigned but its value is never used
+    }
+  }
 }

test/coverlet.integration.tests/DotnetTool.cs

@@ -35,13 +35,14 @@ public void DotnetTool()
       string outputPath = $"{clonedTemplateProject.ProjectRootPath}{Path.DirectorySeparatorChar}coverage.json";
       DotnetCli($"build -f {_buildTargetFramework} {clonedTemplateProject.ProjectRootPath}", out string buildOutput, out string buildError);
       string publishedTestFile = clonedTemplateProject.GetFiles("*" + ClonedTemplateProject.AssemblyName + ".dll").Single(f => !f.Contains("obj") && !f.Contains("ref"));
-      RunCommand(coverletToolCommandPath, $"\"{publishedTestFile}\" --target \"dotnet\" --targetargs \"test {Path.Combine(clonedTemplateProject.ProjectRootPath, ClonedTemplateProject.ProjectFileName)} --no-build\"  --include-test-assembly --output \"{outputPath}\"", out string standardOutput, out string standardError);
+      int cmdExitCode = RunCommand(coverletToolCommandPath, $"\"{publishedTestFile}\" --target \"dotnet\" --targetargs \"test {Path.Combine(clonedTemplateProject.ProjectRootPath, ClonedTemplateProject.ProjectFileName)} --no-build\"  --include-test-assembly --output \"{outputPath}\"", out string standardOutput, out string standardError);
       if (!string.IsNullOrEmpty(standardError))
       {
         _output.WriteLine(standardError);
       }
       Assert.Contains("Passed!", standardOutput);
       AssertCoverage(clonedTemplateProject, standardOutput: standardOutput);
+      Assert.Equal((int)CommandExitCodes.Success, cmdExitCode);
     }
 
     [Fact]
@@ -53,14 +54,15 @@ public void StandAlone()
       string outputPath = $"{clonedTemplateProject.ProjectRootPath}{Path.DirectorySeparatorChar}coverage.json";
       DotnetCli($"build -f {_buildTargetFramework} {clonedTemplateProject.ProjectRootPath}", out string buildOutput, out string buildError);
       string publishedTestFile = clonedTemplateProject.GetFiles("*" + ClonedTemplateProject.AssemblyName + ".dll").Single(f => !f.Contains("obj") && !f.Contains("ref"));
-      RunCommand(coverletToolCommandPath, $"\"{Path.GetDirectoryName(publishedTestFile)}\" --target \"dotnet\" --targetargs \"{publishedTestFile}\"  --output \"{outputPath}\"", out string standardOutput, out string standardError);
+      int cmdExitCode = RunCommand(coverletToolCommandPath, $"\"{Path.GetDirectoryName(publishedTestFile)}\" --target \"dotnet\" --targetargs \"{publishedTestFile}\"  --output \"{outputPath}\"", out string standardOutput, out string standardError);
       if (!string.IsNullOrEmpty(standardError))
       {
         _output.WriteLine(standardError);
       }
       //Assert.Contains("Hello World!", standardOutput);
       Assert.True(File.Exists(outputPath));
       AssertCoverage(clonedTemplateProject, standardOutput: standardOutput);
+      Assert.Equal((int)CommandExitCodes.Success, cmdExitCode);
     }
 
     [Fact]
@@ -85,10 +87,9 @@ public void StandAloneThreshold()
       //Assert.Contains("Hello World!", standardOutput);
       Assert.True(File.Exists(outputPath));
       AssertCoverage(clonedTemplateProject, standardOutput: standardOutput);
-      //Assert.Equal((int)CommandExitCodes.CoverageBelowThreshold, cmdExitCode);
-      // this messages are now in stderr available but standardError stream is empty in test environment
-      //Assert.Contains("The minimum line coverage is below the specified 80", standardError);
-      //Assert.Contains("The minimum method coverage is below the specified 80", standardOutput);
+      Assert.Equal((int)CommandExitCodes.CoverageBelowThreshold, cmdExitCode);
+      Assert.Contains("The minimum line coverage is below the specified 80", standardOutput);
+      Assert.Contains("The minimum method coverage is below the specified 80", standardOutput);
     }
 
     [Fact]
@@ -113,9 +114,9 @@ public void StandAloneThresholdLine()
       // Assert.Contains("Hello World!", standardOutput);
       Assert.True(File.Exists(outputPath));
       AssertCoverage(clonedTemplateProject, standardOutput: standardOutput);
-      //Assert.Equal((int)CommandExitCodes.CoverageBelowThreshold, cmdExitCode);
-      //Assert.Contains("The minimum line coverage is below the specified 80", standardError);
-      //Assert.DoesNotContain("The minimum method coverage is below the specified 80", standardOutput);
+      Assert.Equal((int)CommandExitCodes.CoverageBelowThreshold, cmdExitCode);
+      Assert.Contains("The minimum line coverage is below the specified 80", standardOutput);
+      Assert.DoesNotContain("The minimum method coverage is below the specified 80", standardOutput);
     }
 
     [Fact]
@@ -140,9 +141,9 @@ public void StandAloneThresholdLineAndMethod()
       // Assert.Contains("Hello World!", standardOutput);
       Assert.True(File.Exists(outputPath));
       AssertCoverage(clonedTemplateProject, standardOutput: standardOutput);
-      //Assert.Equal((int)CommandExitCodes.CoverageBelowThreshold, cmdExitCode);
-      //Assert.Contains("The minimum line coverage is below the specified 80", standardError);
-      //Assert.Contains("The minimum method coverage is below the specified 80", standardOutput);
+      Assert.Equal((int)CommandExitCodes.CoverageBelowThreshold, cmdExitCode);
+      Assert.Contains("The minimum line coverage is below the specified 80", standardOutput);
+      Assert.Contains("The minimum method coverage is below the specified 80", standardOutput);
     }
   }
 }