Merge pull request #373 from tonyhallett/further-report-hiding

add options for hiding 0 coverable and 0% coverage rows in report
FortuneN · Jan 12, 2024 · 384e253 · 384e253
2 parents a77028b + a3cdf8c
commit 384e253
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 4 deletions.
diff --git a/FineCodeCoverageTests/AppOptionsProvider_Tests.cs b/FineCodeCoverageTests/AppOptionsProvider_Tests.cs
@@ -197,7 +197,8 @@ public void Should_Not_Default_Any_Other_AppOptions_Properties()
                 nameof(IAppOptions.ShowCoveredInOverviewMargin),
                 nameof(IAppOptions.ShowUncoveredInOverviewMargin),
                 nameof(IAppOptions.ShowPartiallyCoveredInOverviewMargin),
-                nameof(IAppOptions.ShowToolWindowToolbar)
+                nameof(IAppOptions.ShowToolWindowToolbar),
+                nameof(IAppOptions.Hide0Coverable)
             };
             CollectionAssert.AreEquivalent(expectedSetters.Select(s => $"set_{s}"), invocationNames);
         }
@@ -278,6 +279,8 @@ internal void Should_Use_Deseralized_String_From_Store_For_AppOption_Property(Fu
                 { nameof(IAppOptions.FunctionsExclude), new string[]{ "FunctionsExclude" } },
                 { nameof(IAppOptions.FunctionsInclude), new string[]{ "FunctionsInclude" } },
                 { nameof(IAppOptions.HideFullyCovered), true },
+                { nameof(IAppOptions.Hide0Coverable),true },
+                { nameof(IAppOptions.Hide0Coverage),true },
                 { nameof(IAppOptions.Include), new string[]{ "Include" } },
                 { nameof(IAppOptions.IncludeReferencedProjects),true},
                 { nameof(IAppOptions.IncludeTestAssembly),true},

diff --git a/FineCodeCoverageTests/MsCodeCoverage/RunSettingsTemplateReplacementsFactory_Tests.cs b/FineCodeCoverageTests/MsCodeCoverage/RunSettingsTemplateReplacementsFactory_Tests.cs
@@ -692,5 +692,7 @@ internal class TestCoverageProjectOptions : IAppOptions
         public bool ShowUncoveredInOverviewMargin { get; set; }
         public bool ShowPartiallyCoveredInOverviewMargin { get; set; }
         public bool ShowToolWindowToolbar { get; set; }
+        public bool Hide0Coverable { get; set; }
+        public bool Hide0Coverage { get; set; }
     }
 }
diff --git a/README.md b/README.md
@@ -249,6 +249,8 @@ ThresholdForCyclomaticComplexity     When [cyclomatic complexity](https://en.wik
 StickyCoverageTable                  Set to true for coverage table to have a sticky thead.
 NamespacedClasses                    Set to false to show classes in report in short form. Affects grouping.
 HideFullyCovered                     Set to true to hide classes, namespaces and assemblies that are fully covered.
+Hide0Coverage                        Set to true to hide classes, namespaces and assemblies that have 0% coverage.
+Hide0Coverable                       Set to false to show classes, namespaces and assemblies that are not coverable.
 
 Enabled							     Specifies whether or not coverage output is enabled
 RunWhenTestsFail				     By default coverage runs when tests fail.  Set to false to prevent this.  **Cannot be used in conjunction with RunInParallel**

diff --git a/SharedProject/Core/ReportGenerator/ReportGeneratorUtil.cs b/SharedProject/Core/ReportGenerator/ReportGeneratorUtil.cs
@@ -831,11 +831,12 @@ private string HideGroupingCss()
 
 		private string ObserveAndHideFullyCovered()
         {
-            if (!appOptionsProvider.Get().HideFullyCovered)
+			var appOptions = appOptionsProvider.Get();
+            if (!(appOptions.HideFullyCovered | appOptions.Hide0Coverage | appOptions.Hide0Coverable))
             {
 				return "";
             }
-			return @"
+			var old = @"
 var targetNode = document;//document.querySelector('table.overview.table-fixed.stripped');
 
 var config = { attributes: false, childList: true, subtree: true };
@@ -883,7 +884,54 @@ private string ObserveAndHideFullyCovered()
 var observer = new MutationObserver(callback);
 observer.observe(targetNode, config);
 ";
-        }
+			var code = $@"
+function getCellValue(row, index){{
+  return parseInt(row.cells[index].innerText);
+}}
+var targetNode = document;
+
+var config = {{ attributes: false, childList: true, subtree: true }};
+
+var callback = function(mutationsList, observer) {{
+	var rows = document.querySelectorAll(""coverage-info table tbody tr"");
+	for(var i=0;i<rows.length;i++){{
+		var row = rows[i];
+		let hide = false;
+    
+		const coverable = getCellValue(row,3);
+		const covered = getCellValue(row,1)
+	   if(coverable === 0){{
+		if({appOptions.Hide0Coverable.ToString().ToLower()}){{
+			hide = true;
+		}}
+	   }} else if(covered === 0){{
+		if({appOptions.Hide0Coverage.ToString().ToLower()}){{
+			hide = true;
+		}}
+	   }} else if(covered === coverable){{
+  
+		 const branchCovered = getCellValue(row,7);
+		 const branchTotal = getCellValue(row,8);
+    
+		  if(branchTotal === branchCovered){{
+			if({appOptions.HideFullyCovered.ToString().ToLower()}){{
+			  hide = true;
+			}}
+		}}
+	  }}
+
+	  if(hide){{
+		row.style.display = ""none"";
+	  }}
+    
+	}};
+}};
+
+var observer = new MutationObserver(callback);
+observer.observe(targetNode, config);
+";
+			return code;
+		}
 
 		private string HackGroupingToAllowAll(int groupingLevel)
         {

diff --git a/SharedProject/Options/AppOptionsPage.cs b/SharedProject/Options/AppOptionsPage.cs
@@ -253,6 +253,14 @@ You can also ignore additional attributes by adding to this list (short name or
         [Category(commonReportCategory)]
         [Description("Set to true to hide classes, namespaces and assemblies that are fully covered.")]
         public bool HideFullyCovered { get; set; }
+
+        [Category(commonReportCategory)]
+        [Description("Set to false to show classes, namespaces and assemblies that are not coverable.")]
+        public bool Hide0Coverable { get; set; }
+
+        [Category(commonReportCategory)]
+        [Description("Set to true to hide classes, namespaces and assemblies that have 0% coverage.")]
+        public bool Hide0Coverage { get; set; }
         #endregion
 
         #region OpenCover report category

diff --git a/SharedProject/Options/AppOptionsProvider.cs b/SharedProject/Options/AppOptionsProvider.cs
@@ -68,6 +68,7 @@ private void AddDefaults(IAppOptions appOptions)
             appOptions.ShowCoveredInOverviewMargin = true;
             appOptions.ShowPartiallyCoveredInOverviewMargin = true;
             appOptions.ShowUncoveredInOverviewMargin = true;
+            appOptions.Hide0Coverable = true;
         }
 
         public void LoadSettingsFromStorage(IAppOptions instance)
@@ -179,6 +180,9 @@ internal class AppOptions : IAppOptions
 
         public bool HideFullyCovered { get; set; }
 
+        public bool Hide0Coverable { get; set; }
+        public bool Hide0Coverage { get; set; }
+
         public bool AdjacentBuildOutput { get; set; }
 
         public RunMsCodeCoverage RunMsCodeCoverage { get; set; }

diff --git a/SharedProject/Options/IAppOptions.cs b/SharedProject/Options/IAppOptions.cs
@@ -54,6 +54,8 @@ internal interface IAppOptions : IMsCodeCoverageOptions, IFCCCommonOptions
         bool StickyCoverageTable { get; set; }
         bool NamespacedClasses { get; set; }
         bool HideFullyCovered { get; set; }
+        bool Hide0Coverable { get; set; }
+        bool Hide0Coverage { get; set; }
         bool AdjacentBuildOutput { get; set; }
         RunMsCodeCoverage RunMsCodeCoverage { get; set; } 
         bool ShowToolWindowToolbar { get; set; }