Skip to content

AvoidDefaultValueForMandatoryParameter triggers when the field has specification: Mandatory=value and value!=0 #969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 11, 2018
Merged

AvoidDefaultValueForMandatoryParameter triggers when the field has specification: Mandatory=value and value!=0 #969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
794ad85
AvoidDefaultValueForMandatoryParameter triggers when the field has sp…
kalgiz Apr 12, 2018
a49cdaf
Add tests for AvoidDefaultValueForMandatoryParameter rule.
kalgiz Apr 12, 2018
b84ef47
Code cleanup for AvoidDefaultValueForMandatoryParameter rule fix.
kalgiz Apr 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Rules/AvoidDefaultValueForMandatoryParameter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,10 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
{
if (String.Equals(namedArgument.ArgumentName, "mandatory", StringComparison.OrdinalIgnoreCase))
{
// 2 cases: [Parameter(Mandatory)] and [Parameter(Mandatory=$true)]
if (namedArgument.ExpressionOmitted || (!namedArgument.ExpressionOmitted && String.Equals(namedArgument.Argument.Extent.Text, "$true", StringComparison.OrdinalIgnoreCase)))
// 3 cases: [Parameter(Mandatory)], [Parameter(Mandatory=$true)] and [Parameter(Mandatory=value)] where value is not equal to 0.
if (namedArgument.ExpressionOmitted
|| (String.Equals(namedArgument.Argument.Extent.Text, "$true", StringComparison.OrdinalIgnoreCase))
|| (int.TryParse(namedArgument.Argument.Extent.Text, out int mandatoryValue) && mandatoryValue != 0))
{
mandatory = true;
break;
Expand Down
12 changes: 12 additions & 0 deletions Tests/Rules/AvoidDefaultValueForMandatoryParameter.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ Describe "AvoidDefaultValueForMandatoryParameter" {
Where-Object { $_.RuleName -eq $ruleName }
$violations.Count | Should -Be 1
}

It "returns violations when the parameter is specified as mandatory=1 and has a default value" {
$violations = Invoke-ScriptAnalyzer -ScriptDefinition 'Function foo{ Param([Parameter(Mandatory=1)]$Param1=''defaultValue'') }' |
Where-Object { $_.RuleName -eq $ruleName }
$violations.Count | Should -Be 1
}
}

Context "When there are no violations" {
Expand All @@ -21,5 +27,11 @@ Describe "AvoidDefaultValueForMandatoryParameter" {
Where-Object { $_.RuleName -eq $ruleName }
$violations.Count | Should -Be 0
}

It "returns no violations when the parameter is specified as mandatory=0 and has a default value" {
$violations = Invoke-ScriptAnalyzer -ScriptDefinition 'Function foo{ Param([Parameter(Mandatory=0)]$Param1=''val1'') }' |
Where-Object { $_.RuleName -eq $ruleName }
$violations.Count | Should -Be 0
}
}
}