#366: Clover: Filtering of test projects (settings:excludeTestProjects=true)

Author: danielpalme

src/Readme.txt

@@ -66,6 +66,7 @@ CHANGELOG
 4.6.3.0
 
     * New: #364: Added tooltips to show coverage as ratio
+    * New: #366: Clover: Filtering of test projects (settings:excludeTestProjects=true)
 
 4.6.2.0
 

src/ReportGenerator.Core/Generator.cs

@@ -126,6 +126,7 @@ public bool GenerateReport(
                 var parserResult = new CoverageReportParser(
                     settings.NumberOfReportsParsedInParallel,
                     settings.NumberOfReportsMergedInParallel,
+                    settings.ExcludeTestProjects,
                     reportConfiguration.SourceDirectories,
                     new DefaultFilter(reportConfiguration.AssemblyFilters),
                     new DefaultFilter(reportConfiguration.ClassFilters),

src/ReportGenerator.Core/Parser/CloverParser.cs

@@ -22,15 +22,33 @@ internal class CloverParser : ParserBase
         /// </summary>
         private static readonly ILogger Logger = LoggerFactory.GetLogger(typeof(CloverParser));
 
+        /// <summary>
+        /// Indicates whether test projects should be included.
+        /// </summary>
+        private readonly bool excludeTestProjects;
+
         /// <summary>
         /// Initializes a new instance of the <see cref="CloverParser" /> class.
         /// </summary>
         /// <param name="assemblyFilter">The assembly filter.</param>
         /// <param name="classFilter">The class filter.</param>
         /// <param name="fileFilter">The file filter.</param>
         internal CloverParser(IFilter assemblyFilter, IFilter classFilter, IFilter fileFilter)
+            : this(assemblyFilter, classFilter, fileFilter, false)
+        {
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CloverParser" /> class.
+        /// </summary>
+        /// <param name="assemblyFilter">The assembly filter.</param>
+        /// <param name="classFilter">The class filter.</param>
+        /// <param name="fileFilter">The file filter.</param>
+        /// <param name="excludeTestProjects">Indicates whether test projects should be included.</param>
+        internal CloverParser(IFilter assemblyFilter, IFilter classFilter, IFilter fileFilter, bool excludeTestProjects)
             : base(assemblyFilter, classFilter, fileFilter)
         {
+            this.excludeTestProjects = excludeTestProjects;
         }
 
         /// <summary>
@@ -47,8 +65,10 @@ public ParserResult Parse(XContainer report)
 
             var assemblies = new List<Assembly>();
 
-            var modules = report.Descendants("package")
+            var modules = report
+                .Descendants("package")
                 .Where(p => p.Attribute("name") != null)
+                .Where(p => !this.excludeTestProjects || p.Parent.Name != "testproject")
                 .ToArray();
 
             if (modules.Length == 0)

src/ReportGenerator.Core/Parser/CoverageReportParser.cs

@@ -35,6 +35,11 @@ public class CoverageReportParser
         /// </summary>
         private readonly int numberOfReportsMergedInParallel;
 
+        /// <summary>
+        /// Indicates whether test projects should be included.
+        /// </summary>
+        private readonly bool excludeTestProjects;
+
         /// <summary>
         /// The source directories.
         /// </summary>
@@ -79,6 +84,27 @@ public CoverageReportParser(int numberOfReportsParsedInParallel, int numberOfRep
             this.fileFilter = fileFilter ?? throw new ArgumentNullException(nameof(fileFilter));
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CoverageReportParser" /> class.
+        /// </summary>
+        /// <param name="numberOfReportsParsedInParallel">The number reports that are parsed and processed in parallel.</param>
+        /// <param name="numberOfReportsMergedInParallel">The number reports that are merged in parallel.</param>
+        /// <param name="excludeTestProjects">Indicates whether test projects should be included.</param>
+        /// <param name="sourceDirectories">The source directories.</param>
+        /// <param name="assemblyFilter">The assembly filter.</param>
+        /// <param name="classFilter">The class filter.</param>
+        /// <param name="fileFilter">The file filter.</param>
+        public CoverageReportParser(int numberOfReportsParsedInParallel, int numberOfReportsMergedInParallel, bool excludeTestProjects, IEnumerable<string> sourceDirectories, IFilter assemblyFilter, IFilter classFilter, IFilter fileFilter)
+        {
+            this.numberOfReportsParsedInParallel = Math.Max(1, numberOfReportsParsedInParallel);
+            this.numberOfReportsMergedInParallel = Math.Max(1, numberOfReportsMergedInParallel);
+            this.excludeTestProjects = excludeTestProjects;
+            this.sourceDirectories = sourceDirectories ?? throw new ArgumentNullException(nameof(sourceDirectories));
+            this.assemblyFilter = assemblyFilter ?? throw new ArgumentNullException(nameof(assemblyFilter));
+            this.classFilter = classFilter ?? throw new ArgumentNullException(nameof(classFilter));
+            this.fileFilter = fileFilter ?? throw new ArgumentNullException(nameof(fileFilter));
+        }
+
         /// <summary>
         /// Tries to initiate the correct parsers for the given reports.
         /// </summary>
@@ -342,7 +368,7 @@ private IEnumerable<ParserResult> ParseXmlFile(string filePath)
                         new CloverReportPreprocessor(this.sourceDirectories).Execute(item);
 
                         Logger.DebugFormat(Resources.InitiatingParser, "Clover");
-                        var result = new CloverParser(this.assemblyFilter, this.classFilter, this.fileFilter).Parse(item);
+                        var result = new CloverParser(this.assemblyFilter, this.classFilter, this.fileFilter, this.excludeTestProjects).Parse(item);
 
                         foreach (var sourceDirectory in this.sourceDirectories)
                         {

src/ReportGenerator.Core/Settings.cs

@@ -55,5 +55,10 @@ public int CachingDuringOfRemoteFilesInMinutes
         /// Gets or sets a value indicating whether risk hotspots should be disabled or not.
         /// </summary>
         public bool DisableRiskHotspots { get; set; } = false;
+
+        /// <summary>
+        /// Gets or sets a value indicating whether test projects should be included or not (only for Clover files).
+        /// </summary>
+        public bool ExcludeTestProjects { get; set; } = false;
     }
 }