Skip to content

Make UseCompatibleCmdlets not throw if default reference desktop-5.1.14393.206-windows is specified in the list of platforms and use core-6.0.2-windows as an alternative default reference #1043

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
Oct 3, 2018
Merged

Make UseCompatibleCmdlets not throw if default reference desktop-5.1.14393.206-windows is specified in the list of platforms and use core-6.0.2-windows as an alternative default reference #1043

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
a5cc361
Make UseCompatibleCmdletsnot throw if default reference desktop-5.1.1…
bergmeister Jul 24, 2018
97d77a9
add tests and add alternative default reference if only wps is targeted
bergmeister Jul 24, 2018
3c44cf4
Improve test helper to assert against specific diagnostic type
bergmeister Sep 2, 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
7 changes: 6 additions & 1 deletion Rules/UseCompatibleCmdlets.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ private struct RuleParameters
private bool hasInitializationError;
private string reference;
private readonly string defaultReference = "desktop-5.1.14393.206-windows";
private readonly string alternativeDefaultReference = "core-6.0.2-windows";
private RuleParameters ruleParameters;

public UseCompatibleCmdlets()
Expand Down Expand Up @@ -274,6 +275,10 @@ private void SetupCmdletsDictionary()

ruleParameters.compatibility = compatibilityList.ToArray();
reference = defaultReference;
if (compatibilityList.Count == 1 && compatibilityList[0] == defaultReference)
{
reference = alternativeDefaultReference;
}
#if DEBUG
// Setup reference file
object referenceObject;
Expand Down Expand Up @@ -326,7 +331,7 @@ private void SetupCmdletsDictionary()
return;
}

var extentedCompatibilityList = compatibilityList.Concat(Enumerable.Repeat(reference, 1));
var extentedCompatibilityList = compatibilityList.Union(Enumerable.Repeat(reference, 1));
foreach (var compat in extentedCompatibilityList)
{
string psedition, psversion, os;
Expand Down
13 changes: 10 additions & 3 deletions Tests/Rules/UseCompatibleCmdlets.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ Describe "UseCompatibleCmdlets" {
process
{
It ("found {0} violations for '{1}'" -f $expectedViolations, $command) {
Invoke-ScriptAnalyzer -ScriptDefinition $command -IncludeRule $ruleName -Settings $settings | `
Get-Count | `
Should -Be $expectedViolations
$warnings = Invoke-ScriptAnalyzer -ScriptDefinition $command -IncludeRule $ruleName -Settings $settings
$warnings.Count | Should -Be $expectedViolations
$warnings | ForEach-Object {
$_.RuleName | Should -Be 'PSUseCompatibleCmdlets'
}
}
}
}
Expand All @@ -54,4 +56,9 @@ Describe "UseCompatibleCmdlets" {
@("Start-VM", "New-SmbShare", "Get-Disk") | `
Test-Command -Settings $settings -ExpectedViolations 1
}

Context "Default reference can also be used as target platform" {
$settings = @{rules=@{PSUseCompatibleCmdlets=@{compatibility=@("desktop-5.1.14393.206-windows")}}}
@("Remove-Service") | Test-Command -Settings $settings -ExpectedViolations 1
}
}