options for risk hotspot thresholds

Author: tonyhallett

FineCodeCoverage/Core/ReportGenerator/ReportGeneratorUtil.cs

@@ -6,6 +6,7 @@
 using System.Text;
 using System.Threading.Tasks;
 using FineCodeCoverage.Core.Utilities;
+using FineCodeCoverage.Options;
 using Fizzler.Systems.HtmlAgilityPack;
 using HtmlAgilityPack;
 using Newtonsoft.Json;
@@ -38,7 +39,8 @@ internal partial class ReportGeneratorUtil: IReportGeneratorUtil
         private readonly IToolFolder toolFolder;
         private readonly IToolZipProvider toolZipProvider;
 		private readonly IFileUtil fileUtil;
-		private const string zipPrefix = "reportGenerator";
+        private readonly IAppOptionsProvider appOptionsProvider;
+        private const string zipPrefix = "reportGenerator";
 		private const string zipDirectoryName = "reportGenerator";
 
         public string ReportGeneratorExePath { get; private set; }
@@ -50,10 +52,12 @@ public ReportGeneratorUtil(
 			ILogger logger,
 			IToolFolder toolFolder,
 			IToolZipProvider toolZipProvider,
-			IFileUtil fileUtil
+			IFileUtil fileUtil,
+			IAppOptionsProvider appOptionsProvider
 			)
 		{
 			this.fileUtil = fileUtil;
+            this.appOptionsProvider = appOptionsProvider;
             this.assemblyUtil = assemblyUtil;
             this.processUtil = processUtil;
             this.logger = logger;
@@ -87,6 +91,15 @@ async Task<bool> run(string outputReportType, string inputReports)
 				{
 					reportTypeSettings.Add($@"""-reports:{inputReports}""");
 					reportTypeSettings.Add($@"""-reporttypes:Cobertura""");
+					var options = appOptionsProvider.Get();
+					var cyclomaticThreshold = options.ThresholdForCyclomaticComplexity;
+					var crapScoreThreshold = options.ThresholdForCrapScore;
+					var nPathThreshold = options.ThresholdForNPathComplexity;
+					
+					reportTypeSettings.Add($@"""-riskHotspotsAnalysisThresholds:metricThresholdForCyclomaticComplexity={cyclomaticThreshold}""");
+					reportTypeSettings.Add($@"""-riskHotspotsAnalysisThresholds:metricThresholdForCrapScore={crapScoreThreshold}""");
+					reportTypeSettings.Add($@"""-riskHotspotsAnalysisThresholds:metricThresholdForNPathComplexity={nPathThreshold}""");
+
 				}
 				else if (outputReportType.Equals("HtmlInline_AzurePipelines", StringComparison.OrdinalIgnoreCase))
 				{

FineCodeCoverage/Options/AppOptions.cs

@@ -13,6 +13,7 @@ internal class AppOptions : DialogPage, IAppOptions
         private const string coverletCategory = "Coverlet";
         private const string openCoverCategory = "OpenCover";
         private const string outputCategory = "Output";
+        private const string reportCategory = "Report";
 
         public AppOptions():this(false)
         {
@@ -137,6 +138,16 @@ You can also ignore additional attributes by adding to this list (short name or
         [Category(outputCategory)]
         public string FCCSolutionOutputDirectoryName { get; set; }
 
+        [Category(reportCategory)]
+        [Description("When cyclomatic complexity exceeds this value for a method then the method will be present in the risk hotspots tab.")]
+        public int ThresholdForCyclomaticComplexity { get; set; } = 30
+        [Category(reportCategory)]
+        [Description("When npath complexity exceeds this value for a method then the method will be present in the risk hotspots tab. OpenCover only")]
+        public int ThresholdForNPathComplexity { get; set; } = 200
+        [Category(reportCategory)]
+        [Description("When crap score exceeds this value for a method then the method will be present in the risk hotspots tab. OpenCover only")]
+        public int ThresholdForCrapScore { get; set; } = 15
+
         [SuppressMessage("Usage", "VSTHRD010:Invoke single-threaded types on Main thread")]
         public override void SaveSettingsToStorage()
         {

FineCodeCoverage/Options/IAppOptions.cs

@@ -18,5 +18,8 @@ public interface IAppOptions
         string CoverletCollectorDirectoryPath { get; }
         string OpenCoverCustomPath { get; }
         string FCCSolutionOutputDirectoryName { get; }
+        int ThresholdForCyclomaticComplexity { get; }
+        int ThresholdForNPathComplexity { get; }
+        int ThresholdForCrapScore { get; }
     }
 }

README.md

@@ -121,6 +121,10 @@ ExcludeByFile					Glob patterns specifying source files to exclude e.g. **/Migra
 ExcludeByAttribute				Attributes to exclude from code coverage (multiple values)
 IncludeTestAssembly				Specifies whether to report code coverage of the test assembly
 
+ThresholdForCyclomaticComplexity When [cyclomatic complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) exceeds this value for a method then the method will be present in the risk hotspots tab. 
+ThresholdForNPathComplexity     When [npath complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) exceeds this value for a method then the method will be present in the risk hotspots tab. OpenCover only.
+ThresholdForCrapScore           When [crap score](https://testing.googleblog.com/2011/02/this-code-is-crap.html) exceeds this value for a method then the method will be present in the risk hotspots tab. OpenCover only. 
+
 RunSettingsOnly					Specify false for global and project options to be used for coverlet data collector configuration elements when not specified in runsettings
 CoverletCollectorDirectoryPath	Specify path to directory containing coverlet collector files if you need functionality that the FCC version does not provide.
 
@@ -138,6 +142,8 @@ You can ignore a method or an entire class from code coverage by creating and ap
 You can also ignore additional attributes by adding to the 'ExcludeByAttributes' list (short name or full name supported) e.g. :
 [GeneratedCode] => Present in System.CodeDom.Compiler namespace
 [MyCustomExcludeFromCodeCoverage] => Any custom attribute that you may define
+
+ 
 ```
 
 #### Filter Expressions