Add tests for UseIdenticalMandatoryParametersForDSC rule

Author: Kapil Borle

Tests/Rules/DSCResources/MSFT_WaitForAnyNoIdenticalMandatoryParameter/MSFT_WaitForAnyNoIdenticalMandatoryParameter.psm1

@@ -0,0 +1,162 @@
+#
+# WaitForAny
+#
+
+#
+# The Get-TargetResource cmdlet.
+#
+function Get-TargetResource
+{
+    param
+    (
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [string[]] $NodeName,
+
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [PSCredential] $Credential,
+
+        [ValidateRange(1,[Uint64]::MaxValue)]
+        [Uint64] $RetryIntervalSec = 1,
+
+        [Uint32] $RetryCount = 0,
+
+        [Uint32] $ThrottleLimit = 32 #Powershell New-CimSession default throttle value
+    )
+
+    Write-Verbose "In Get-TargetResource"
+
+    Import-Module $PSScriptRoot\..\..\PSDSCxMachine.psm1
+
+    $b = @{"hash" = "table"}
+
+    if ($true)
+    {
+        return $b;
+    }
+    elseif ($c)
+    {
+        return @{"hash2"="table2"}
+    }
+    else
+    {
+        # can't determine type of c so error should not be raised as we're trying to be conservative
+        return $c;
+    }
+}
+
+#
+# The Set-TargetResource cmdlet.
+#
+function Set-TargetResource
+{
+    param
+    (
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [string] $ResourceName,
+
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [string[]] $NodeName,
+
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [PSCredential] $Credential,
+
+        [ValidateRange(1,[Uint64]::MaxValue)]
+        [Uint64] $RetryIntervalSec = 1,
+
+        [Uint32] $RetryCount = 0,
+
+        [Uint32] $ThrottleLimit = 32 #Powershell New-CimSession default throttle value
+    )
+
+    Write-Verbose "In Set-TargetResource"
+
+    Import-Module $PSScriptRoot\..\..\PSDSCxMachine.psm1
+
+    if ($PSBoundParameters["Verbose"])
+    {
+        Write-Verbose "Calling xMachine with Verbose parameter"
+
+        PSDSCxMachine\Set-_InternalPSDscXMachineTR `
+               -RemoteResourceId $ResourceName `
+               -RemoteMachine $NodeName `
+               -RemoteCredential $Credential `
+               -MinimalNumberOfMachineInState 1 `
+               -RetryIntervalSec $RetryIntervalSec `
+               -RetryCount $RetryCount `
+               -ThrottleLimit $ThrottleLimit `
+               -Verbose
+    }
+    else
+    {
+        PSDSCxMachine\Set-_InternalPSDscXMachineTR `
+               -RemoteResourceId $ResourceName `
+               -RemoteMachine $NodeName `
+               -RemoteCredential $Credential `
+               -MinimalNumberOfMachineInState 1 `
+               -RetryIntervalSec $RetryIntervalSec `
+               -RetryCount $RetryCount `
+               -ThrottleLimit $ThrottleLimit
+    }
+}
+
+#
+# Test-TargetResource
+#
+#
+function Test-TargetResource
+{
+    param
+    (
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [string] $ResourceName,
+
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [string[]] $NodeName,
+
+        [parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [PSCredential] $Credential,
+
+        [ValidateRange(1,[Uint64]::MaxValue)]
+        [Uint64] $RetryIntervalSec = 1,
+
+        [Uint32] $RetryCount = 0,
+
+        [Uint32] $ThrottleLimit = 32 #Powershell New-CimSession default throttle value
+    )
+
+    Write-Verbose "In Test-TargetResource"
+
+    Import-Module $PSScriptRoot\..\..\PSDSCxMachine.psm1
+
+    $a = $true
+    $a
+
+    if ($true)
+    {
+        $false;
+    }
+    elseif ($b)
+    {
+        return $a -or $true
+    }
+    elseif ($c)
+    {
+        return $false;
+    }
+    else
+    {
+        return $true
+    }
+}
+
+
+
+Export-ModuleMember -Function *-TargetResource

Tests/Rules/DSCResources/MSFT_WaitForAnyNoIdenticalMandatoryParameter/MSFT_WaitForAnyNoIdenticalMandatoryParameter.schema.mof

@@ -0,0 +1,23 @@
+Import-Module PSScriptAnalyzer
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$ruleName = 'PSDSCUseIdenticalMandatoryParametersForDSC'
+$resourceFilepath = [System.IO.Path]::Combine(
+    $directory,
+    'DSCResources',
+    'MSFT_WaitForAnyNoIdenticalMandatoryParameter',
+    'MSFT_WaitForAnyNoIdenticalMandatoryParameter.psm1');
+
+Describe "UseIdenticalMandatoryParametersForDSC" {
+    Context "When a mandatory parameter is not present" {
+        BeforeAll {
+            $violations = Invoke-ScriptAnalyzer -Path $resourceFilepath -IncludeRule $ruleName
+        }
+
+        # todo add a test to check one violation per function
+        It "Should find a violations" {
+            $violations.Count | Should Be 1
+        }
+
+        # todo add a test to check violation extent
+    }
+}