Merge pull request #638 from PowerShell/kapilmb/FixTargetRegex

Fix 'Target' regex in rule suppression

Author: Kapil Borle

CHANGELOG.MD

@@ -1,4 +1,8 @@
-## [1.8.1](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.8.1) - 2016-10-13
+## [unreleased](https://github.com/PowerShell/PSScriptAnalyzer/tree/development)
+### Fixed
+- Regular expression in `target` parameter in SuppressMessageAttribute (#638)
+
+## [1.8.1](https://github.com/PowerShell/PSScriptAnalyzer/tree/1.8.1) - 2016-10-13
 ### Added
 - Catalog file to play nicely with PowerShellGet, version `1.1.0.0`
 

Engine/Generic/RuleSuppression.cs

@@ -20,7 +20,7 @@
 namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
 {
     /// <summary>
-    /// 
+    ///
     /// </summary>
     public class RuleSuppression
     {
@@ -185,11 +185,11 @@ public RuleSuppression(AttributeAst attrAst, int start, int end)
                             case 2:
                                 RuleSuppressionID = (positionalArguments[1] as StringConstantExpressionAst).Value;
                                 goto case 1;
-                            
+
                             case 1:
                                 RuleName = (positionalArguments[0] as StringConstantExpressionAst).Value;
                                 goto default;
-                            
+
                             default:
                                 break;
                         }
@@ -281,7 +281,7 @@ public RuleSuppression(AttributeAst attrAst, int start, int end)
                     RuleName = String.Empty;
                     Error = Strings.NullRuleNameError;
                 }
-                
+
                 // Must have scope and target together
                 if (String.IsNullOrWhiteSpace(Scope) && !String.IsNullOrWhiteSpace(Target))
                 {
@@ -357,8 +357,10 @@ public static List<RuleSuppression> GetSuppressions(IEnumerable<AttributeAst> at
                         ruleSupp.Target = "*";
                     }
 
+                    // According to documentation 'target' supports regular expression. But to maintain compatibility with
+                    // previous implementation we interpret '*' as a glob and therefore replace '*' with '.*'
                     // regex for wild card *
-                    Regex reg = new Regex(String.Format("^{0}$", Regex.Escape(ruleSupp.Target).Replace(@"\*", ".*")), RegexOptions.IgnoreCase);
+                    Regex reg = new Regex(String.Format("^{0}$", ruleSupp.Target.Replace(@"*", ".*")), RegexOptions.IgnoreCase);
                     IEnumerable<Ast> targetAsts = null;
 
                     switch (ruleSupp.Scope.ToLower())

README.md

@@ -172,44 +172,39 @@ function InternalFunction
 }
 ```
 
-The above example demonstrates how to suppress rule violations for internal functions using the `SuppressMessageAttribute`'s `Scope` property.
-
-You can further restrict suppression based on a function/parameter/class/variable/object's name by setting the `SuppressMessageAttribute's` `Target` property to a regular expression. Any function/parameter/class/variable/object whose name matches the regular expression is skipped.
+You can further restrict suppression based on a function/parameter/class/variable/object's name by setting the `SuppressMessageAttribute's` `Target` property to a regular expression or a glob pattern. Few examples are given below.
 
+Suppress `PSAvoidUsingWriteHost` rule violation in `start-bar` and `start-baz` but not in `start-foo` and `start-bam`:
 ``` PowerShell
-[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPositionalParameters", Scope="Function", Target="PositionalParametersAllowed")]
-Param(
-)
-
-function PositionalParametersAllowed()
-{
-    Param([string]$Parameter1)
-    {
-        Write-Verbose $Parameter1
-    }
+[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Scope='Function', Target='start-ba[rz]')]
+param()
+function start-foo {
+    write-host "start-foo"
+}
 
+function start-bar {
+    write-host "start-bar"
 }
 
-function PositionalParametersNotAllowed()
-{
-    param([string]$Parameter1)
-    {
-        Write-Verbose $Parameter1
-    }
+function start-baz {
+    write-host "start-baz"
 }
 
-# PSScriptAnalyzer will skip this violation
-PositionalParametersAllowed 'value1'
+function start-bam {
+    write-host "start-bam"
+}
+```
 
-# PSScriptAnalyzer will report this violation
-PositionalParametersNotAllowed 'value1
+Suppress violations in all the functions:
+``` PowerShell
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingWriteHost", Scope="Function", Target="*")]
+Param()
 ```
 
-To match all functions/variables/parameters/objects, use `*` as the value of the Target parameter:
+Suppress violation in `start-bar`, `start-baz` and `start-bam` but not in `start-foo`:
 ``` PowerShell
-[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPositionalParameters", Scope="Function", Target="*")]
-Param(
-)
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingWriteHost", Scope="Function", Target="start-b*")]
+Param()
 ```
 
 **Note**: Rule suppression is currently supported only for built-in rules.

Tests/Engine/RuleSuppression.tests.ps1

@@ -7,6 +7,9 @@ if (!(Get-Module PSScriptAnalyzer) -and !$testingLibraryUsage)
 }
 
 $directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$testRootDirectory = Split-Path -Parent $directory
+Import-Module (Join-Path $testRootDirectory 'PSScriptAnalyzerTestHelper.psm1')
+
 $violationsUsingScriptDefinition = Invoke-ScriptAnalyzer -ScriptDefinition (Get-Content -Raw "$directory\RuleSuppression.ps1")
 $violations = Invoke-ScriptAnalyzer "$directory\RuleSuppression.ps1"
 
@@ -146,4 +149,70 @@ Describe "RuleSuppressionWithScope" {
             $suppression.Count | Should Be 0
         }
     }
+
+    Context "Function scope with regular expression" {
+        It "suppresses objects that match the regular expression" {
+            $scriptDef = @'
+            [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Scope='Function', Target='start-ba[rz]')]
+            param()
+            function start-foo {
+                write-host "start-foo"
+            }
+
+            function start-bar {
+                write-host "start-bar"
+            }
+
+            function start-baz {
+                write-host "start-baz"
+            }
+
+            function start-bam {
+                write-host "start-bam"
+            }
+'@
+            $suppressed = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule 'PSAvoidUsingWriteHost' -SuppressedOnly
+            $suppressed.Count | Should Be 2
+        }
+
+        It "suppresses objects that match glob pattern with glob in the end" {
+            $scriptDef = @'
+            [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Scope='Function', Target='start-*')]
+            param()
+            function start-foo {
+                write-host "start-foo"
+            }
+
+            function start-bar {
+                write-host "start-bar"
+            }
+
+            function stop-bar {
+                write-host "stop-bar"
+            }
+'@
+            $suppressed = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule 'PSAvoidUsingWriteHost' -SuppressedOnly
+            $suppressed.Count | Should Be 2
+        }
+
+        It "suppresses objects that match glob pattern with glob in the begining" {
+            $scriptDef = @'
+            [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '', Scope='Function', Target='*-bar')]
+            param()
+            function start-foo {
+                write-host "start-foo"
+            }
+
+            function start-bar {
+                write-host "start-bar"
+            }
+
+            function start-baz {
+                write-host "start-baz"
+            }
+'@
+            $suppressed = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDef -IncludeRule 'PSAvoidUsingWriteHost' -SuppressedOnly
+            $suppressed.Count | Should Be 1
+        }
+    }
  }

Utils/ReleaseMaker.psm1

@@ -74,15 +74,7 @@ Function New-Release
     Update-ReleaseNotesInModuleManifest $newVer $oldVer
 
     # build the module
-    pushd $solutionRoot
-    remove-item out/ -recurse -force
-    dotnet restore
-    .\buildCoreClr.ps1 -Framework net451 -Configuration Release -Build
-    .\buildCoreClr.ps1 -Framework net451 -Configuration PSV3Release -Build
-    .\buildCoreClr.ps1 -Framework netstandard1.6 -Configuration Release -Build
-    .\build.ps1 -BuildDocs
-    popd
-
+    New-ReleaseBuild
 }
 
 function Get-VersionsFromChangeLog
@@ -94,6 +86,25 @@ function Get-VersionsFromChangeLog
     $versions
 }
 
+function New-ReleaseBuild
+{
+    $solutionPath = Get-SolutionPath
+    pushd $solutionPath
+    try
+    {
+        remove-item out/ -recurse -force
+        dotnet restore
+        .\buildCoreClr.ps1 -Framework net451 -Configuration Release -Build
+        .\buildCoreClr.ps1 -Framework net451 -Configuration PSV3Release -Build
+        .\buildCoreClr.ps1 -Framework netstandard1.6 -Configuration Release -Build
+        .\build.ps1 -BuildDocs
+    }
+    finally
+    {
+        popd
+    }
+}
+
 function Update-ReleaseNotesInModuleManifest
 {
     [CmdletBinding()]
@@ -173,4 +184,5 @@ function Set-ContentUtf8NoBom {
     [System.IO.File]::WriteAllLines($path, $content, $utfNoBom)
 }
 
-Export-ModuleMember -Function New-Release
+Export-ModuleMember -Function New-Release
+Export-ModuleMember -Function New-ReleaseBuild