RuleSuppressionId is not being honored for custom rule suppression

[jegannathanmaniganadan]

Steps to reproduce

I have a bunch of custom rules written in PowerShell. For some of the rules I populate RuleSuppressionId in the diagnostic record, so that I can use that for rule suppression, but it is not working. For example, I have this violation returned for my custom rule, which I want to suppress across my psm1 file on a specific functions.

Line : 2107
Column : 13
Message : You should not use Get-FooBar,....
Extent : <some extent>
RuleName : ScriptName\Measure-PSAvoidFooBarCommand
Severity : Warning
ScriptName : FooBar.psm1
ScriptPath : C:\..\FooBar.psm1
RuleSuppressionID : Get-FooBar
SuggestedCorrections : {Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.CorrectionExtent

And I have this line suppression defined at the beginning of the psm1 file,

[SuppressMessageAttribute('ScriptName\Measure-PSAvoidFooBarCommand', CheckId = 'Get-FooBar', Scope = 'Function', Target = 'Get-SomeFunction*')]
param()

Expected behavior

It should suppress the violation but it does not.

Actual behavior

It suppress all the violations for the given rule without checking the RuleSuppressionId.

if I tweak the suppression to below, I get an error

```powershell
[SuppressMessageAttribute('ScriptName\Measure-PSAvoidFooBarCommand', 'Get-FooBar', Scope = 'Function', Target = 'Get-SomeFunction*')]
param()

Suppression Message Attribute error at line 12 in FooBar.psm1 : Cannot find any DiagnosticRecord with the Rule Suppression ID Get-FooBar....

Environment data

> $PSVersionTable
Name Value
---- -----
PSVersion 5.1.18362.1593
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.18362.1593
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1


> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.19.1

[rjmholt]

Manigandan Jegannathan (@jegannathanmaniganadan) are you able to supply a small custom rule with which we could try to reproduce this? Also how are you creating the extent for the diagnostic? I know from another issue that the extent has to have the correct offset in order to suppress correctly: #1591 (comment).

Closing due to inactivity

[jegannathanmaniganadan]

Sorry about the delay, let me know if this helps. Can we reopen this issue if this sounds legit ? Rob Holt (@rjmholt)

Custom rule file

Filename : SampleCustomRule.psm1

using namespace System.Diagnostics.CodeAnalysis
using namespace System.Management.Automation
using namespace System.Management.Automation.Language

using namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic

function Measure-PSAvoidFooBarCommand {
 <##>
 [CmdletBinding()]
 [OutputType([Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord])]
 param(
 [Parameter(Mandatory)]
 [CommandAst]
 $CommandAst
 )

 try {
 $cmdName = $CommandAst.GetCommandName()

 if ($cmdName -match 'Get-FooBar|Set-FooBar') {
 [DiagnosticRecord]::new('Do not use *FooBar commands', $CommandAst.Extent, 'Measure-PSAvoidFooBarCommand', 'Warning', '', $cmdName)
 }
 } catch {
 Write-Error -ErrorRecord $_
 }
}

Sample script with violation

Filename : SampleScript.ps1

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('Measure-PSAvoidFooBarCommand', CheckId = 'Get-FooBar', Scope = 'Function', Target = 'Allow-BadCom*')]
param()

function Test-BadCommand {
 <##>
 [CmdletBinding()]
 param()

 Get-FooBar

 Set-FooBar
}

function Allow-BadCommand {
 <##>
 [CmdletBinding()]
 param()

 Get-FooBar

 Set-FooBar
}

Behavior

As you can see, it expected to suppress only one violation with rule matching Get-FooBar but it ends up suppressing the rule across the function.

# Invoke-ScriptAnalyzer -CustomRulePath 'C:\local\SampleCustomRule.psm1' -Path C:\local\SampleScript.ps1

RuleName Severity ScriptName Line Message
-------- -------- ---------- ---- -------
Measure-PSAvoidFooBarCommand Warning SampleScri 9 Do not use *FooBar commands
 pt.ps1
Measure-PSAvoidFooBarCommand Warning SampleScri 11 Do not use *FooBar commands
 pt.ps1

[iRon7]

I bounced into the same issue.
Is there any solution or workaround for this?

[HeyItsGilbert]

This is also the same as #1344.