Remove coverageGutters, make coverage relative to repo root, add repo root (#2683)

* Add repo root, and remove guttters

* Fix output

* fix strict

* don't use jacoco format

* repo root

* report root

* star or not

* move

* stars

* stars

* slash

* normalize

* paths finally

Author: nohwnd

build.ps1

@@ -65,6 +65,7 @@ param (
 )
 
 $ErrorActionPreference = 'Stop'
+$ErrorView = 'NormalView'
 Get-Module Pester | Remove-Module
 
 if ($Clean -and $PSVersionTable.PSVersion -lt [version]'5.1') {
@@ -105,6 +106,10 @@ if ($Clean) {
     }
 
     function Format-NicelyMini ($value) {
+        if ($null -eq $value) {
+            return '$null'
+        }
+
         if ($value -is [bool]) {
             if ($value) {
                 '$true'
@@ -148,7 +153,12 @@ if ($Clean) {
         foreach ($r in $section.PSObject.Properties.Name) {
             $option = $section.$r
             $default = Format-NicelyMini $option.Default
-            $type = $option.Default.GetType() -as [string]
+            if ("RepoRoot" -eq $r) {
+                # RepoRoot is a special case, because it is not actually an option, but a property that returns the value of the option. This is done to make it easier to use in scripts, but it causes issues when generating help, because it does not have a default value. So we need to get the default value from the actual option.
+                $default = Format-NicelyMini '<path of .git>'
+            }
+            # When the value is null this would throw if we checked the type of default value.
+            $type = $option.GetType().BaseType.GenericTypeArguments[0] -as [string]
             "    ${r}: $($option.Description)$eol    Type: ${type}$eol    Default value: ${default}$eol"
         }
     }

src/csharp/Pester/CodeCoverageConfiguration.cs

@@ -31,6 +31,7 @@ public class CodeCoverageConfiguration : ConfigurationSection
         private BoolOption _useBps;
         private BoolOption _singleHitBreakpoints;
         private DecimalOption _coveragePercentTarget;
+        private StringOption _reportRoot;
 
         public static CodeCoverageConfiguration Default { get { return new CodeCoverageConfiguration(); } }
 
@@ -41,7 +42,7 @@ public static CodeCoverageConfiguration ShallowClone(CodeCoverageConfiguration c
         public CodeCoverageConfiguration() : base("Options to enable and configure Pester's code coverage feature.")
         {
             Enabled = new BoolOption("Enable CodeCoverage.", false);
-            OutputFormat = new StringOption("Format to use for code coverage report. Possible values: JaCoCo, CoverageGutters, Cobertura", "JaCoCo");
+            OutputFormat = new StringOption("Format to use for code coverage report. Possible values: JaCoCo, Cobertura", "JaCoCo");
             OutputPath = new StringOption("Path relative to the current directory where code coverage report is saved.", "coverage.xml");
             OutputEncoding = new StringOption("Encoding of the output file.", "UTF8");
             Path = new StringArrayOption("Directories or files to be used for code coverage, by default the Path(s) from general settings are used, unless overridden here.", new string[0]);
@@ -50,6 +51,7 @@ public CodeCoverageConfiguration() : base("Options to enable and configure Peste
             UseBreakpoints = new BoolOption("When false, use Profiler based tracer to do CodeCoverage instead of using breakpoints.", false);
             CoveragePercentTarget = new DecimalOption("Target percent of code coverage that you want to achieve, default 75%.", 75m);
             SingleHitBreakpoints = new BoolOption("Remove breakpoint when it is hit. This increases performance of breakpoint based CodeCoverage.", true);
+            ReportRoot = new StringOption("Root path for the code coverage report. Uses Run.RepoRoot by default.", null);
         }
 
         public CodeCoverageConfiguration(IDictionary configuration) : this()
@@ -66,6 +68,7 @@ public CodeCoverageConfiguration(IDictionary configuration) : this()
                 configuration.AssignValueIfNotNull<bool>(nameof(UseBreakpoints), v => UseBreakpoints = v);
                 configuration.AssignValueIfNotNull<decimal>(nameof(CoveragePercentTarget), v => CoveragePercentTarget = v);
                 configuration.AssignValueIfNotNull<bool>(nameof(SingleHitBreakpoints), v => SingleHitBreakpoints = v);
+                configuration.AssignObjectIfNotNull<string>(nameof(ReportRoot), v => ReportRoot = v);
             }
         }
 
@@ -228,5 +231,21 @@ public BoolOption SingleHitBreakpoints
                 }
             }
         }
+
+        public StringOption ReportRoot
+        {
+            get { return _reportRoot; }
+            set
+            {
+                if (_reportRoot == null)
+                {
+                    _reportRoot = value;
+                }
+                else
+                {
+                    _reportRoot = new StringOption(_reportRoot, value?.Value);
+                }
+            }
+        }
     }
 }

src/csharp/Pester/RunConfiguration.cs

@@ -1,4 +1,5 @@
-using System.Collections;
+using System.IO;
+using System.Collections;
 using System.Management.Automation;
 
 // those types implement Pester configuration in a way that allows it to show information about each item
@@ -33,6 +34,7 @@ public class RunConfiguration : ConfigurationSection
         private BoolOption _skipRun;
         private StringOption _skipRemainingOnFailure;
         private BoolOption _failOnNullOrEmptyForEach;
+        private StringOption _repoRoot;
 
         public static RunConfiguration Default { get { return new RunConfiguration(); } }
         public static RunConfiguration ShallowClone(RunConfiguration configuration)
@@ -54,7 +56,8 @@ public RunConfiguration(IDictionary configuration) : this()
                 configuration.AssignValueIfNotNull<bool>(nameof(PassThru), v => PassThru = v);
                 configuration.AssignValueIfNotNull<bool>(nameof(SkipRun), v => SkipRun = v);
                 configuration.AssignObjectIfNotNull<string>(nameof(SkipRemainingOnFailure), v => SkipRemainingOnFailure = v);
-                configuration.AssignValueIfNotNull<bool>(nameof(FailOnNullOrEmptyForEach ), v => FailOnNullOrEmptyForEach  = v);
+                configuration.AssignValueIfNotNull<bool>(nameof(FailOnNullOrEmptyForEach), v => FailOnNullOrEmptyForEach = v);
+                configuration.AssignObjectIfNotNull<string>(nameof(RepoRoot), v => RepoRoot = v);
             }
         }
 
@@ -70,7 +73,8 @@ public RunConfiguration(IDictionary configuration) : this()
             PassThru = new BoolOption("Return result object to the pipeline after finishing the test run.", false);
             SkipRun = new BoolOption("Runs the discovery phase but skips run. Use it with PassThru to get object populated with all tests.", false);
             SkipRemainingOnFailure = new StringOption("Skips remaining tests after failure for selected scope, options are None, Run, Container and Block.", "None");
-            FailOnNullOrEmptyForEach  = new BoolOption("Fails discovery when -ForEach is provided $null or @() in a block or test. Can be overridden for a specific Describe/Context/It using -AllowNullOrEmptyForEach.", true);
+            FailOnNullOrEmptyForEach = new BoolOption("Fails discovery when -ForEach is provided $null or @() in a block or test. Can be overridden for a specific Describe/Context/It using -AllowNullOrEmptyForEach.", true);
+            RepoRoot = new StringOption("Root directory of the repository. Found by searching for the .git directory recursively. When not found, the current working directory is used.", FindRepoRoot());
         }
 
         public StringArrayOption Path
@@ -248,5 +252,38 @@ public BoolOption FailOnNullOrEmptyForEach
                 }
             }
         }
+
+        public StringOption RepoRoot
+        {
+            get { return _repoRoot; }
+            set
+            {
+                if (_repoRoot == null)
+                {
+                    _repoRoot = value;
+                }
+                else
+                {
+                    _repoRoot = new StringOption(_repoRoot, value?.Value);
+                }
+            }
+        }
+
+        private static string FindRepoRoot()
+        {
+            var originalDir = Directory.GetCurrentDirectory();
+            var currentDir = originalDir;
+            while (!Directory.Exists(System.IO.Path.Combine(currentDir, ".git")))
+            {
+                var parentDir = Directory.GetParent(currentDir);
+                if (parentDir == null)
+                {
+                    return originalDir;
+                }
+                currentDir = parentDir.FullName;
+            }
+            return currentDir;
+
+        }
     }
 }

src/en-US/about_PesterConfiguration.help.txt

@@ -73,6 +73,10 @@ SECTIONS AND OPTIONS
         Type: bool
         Default value: $true
 
+        RepoRoot: Root directory of the repository. Found by searching for the .git directory recursively. When not found, the current working directory is used.
+        Type: string
+        Default value: '<path of .git>'
+
     Filter:
         Tag: Tags of Describe, Context or It to be run.
         Type: string[]
@@ -99,7 +103,7 @@ SECTIONS AND OPTIONS
         Type: bool
         Default value: $false
 
-        OutputFormat: Format to use for code coverage report. Possible values: JaCoCo, CoverageGutters, Cobertura
+        OutputFormat: Format to use for code coverage report. Possible values: JaCoCo, Cobertura
         Type: string
         Default value: 'JaCoCo'
 
@@ -135,6 +139,10 @@ SECTIONS AND OPTIONS
         Type: bool
         Default value: $true
 
+        ReportRoot: Root path for the code coverage report. Uses Run.RepoRoot by default.
+        Type: string
+        Default value: $null
+
     TestResult:
         Enabled: Enable TestResult.
         Type: bool

src/functions/Coverage.Plugin.ps1

@@ -146,9 +146,8 @@
         $configuration = $run.PluginConfiguration.Coverage
 
         $coverageXmlReport = switch ($configuration.OutputFormat) {
-            'JaCoCo' { [xml](Get-JaCoCoReportXml -CommandCoverage $breakpoints -TotalMilliseconds $totalMilliseconds -CoverageReport $coverageReport -Format 'JaCoCo') }
-            'CoverageGutters' { [xml](Get-JaCoCoReportXml -CommandCoverage $breakpoints -TotalMilliseconds $totalMilliseconds -CoverageReport $coverageReport -Format 'CoverageGutters') }
-            'Cobertura' { [xml](Get-CoberturaReportXml -CoverageReport $coverageReport  -TotalMilliseconds $totalMilliseconds) }
+            'JaCoCo' { [xml](Get-JaCoCoReportXml -CommandCoverage $breakpoints -TotalMilliseconds $totalMilliseconds -CoverageReport $coverageReport -ReportRoot (Get-ReportRoot)) }
+            'Cobertura' { [xml](Get-CoberturaReportXml -CoverageReport $coverageReport  -TotalMilliseconds $totalMilliseconds -ReportRoot (Get-ReportRoot)) }
             default { throw "CodeCoverage.CoverageFormat '$($configuration.OutputFormat)' is not valid, please review your configuration." }
         }
 
@@ -216,7 +215,7 @@
 }
 
 function Resolve-CodeCoverageConfiguration {
-    $supportedFormats = 'JaCoCo', 'CoverageGutters', 'Cobertura'
+    $supportedFormats = 'JaCoCo', 'Cobertura'
     if ($PesterPreference.CodeCoverage.OutputFormat.Value -notin $supportedFormats) {
         throw (Get-StringOptionErrorMessage -OptionPath 'CodeCoverage.OutputFormat' -SupportedValues $supportedFormats -Value $PesterPreference.CodeCoverage.OutputFormat.Value)
     }