add Get-VNVDTrafficRuleAction, start of Pester tests, fix two minor bugs

Author: mtboren

notes_SetCoSAndDSCPOnVDPG.md ToDoAndNotes.mdnotes_SetCoSAndDSCPOnVDPG.md renamed to ToDoAndNotes.md

@@ -2,7 +2,6 @@
 
 
 ### Need to make:
-- `Get-VNVDTrafficRuleAction`
 - `Set-VNVDTrafficRuleSet -Enabled -Precedence -TrafficRuleset`
     - define cmdlet `ConfirmImpact` to High
 - Examples/docs
@@ -34,6 +33,7 @@ Done (to at least some extent -- some may have further features to implement):
     - implemented, but initially with a bug (now worked around):  cannot rely on TrafficRule object's `Key` property, as that changes with every vDPortgroup reconfig, apparently (so, if iterating through several Rules, after the removal of the 1st one, the keys for the rest in the pipeline are invalid)
         - so, must do the `Process` differently so that all TrafficRule items per vDPortgroup are removed in one reconfig (or, other, less reliable ways, for which I did not opt)
     - Operating with the understanding/observation that there is only ever one (1) `Config.DefaultPortConfig.FilterPolicy.FilterConfig` per vDPortgroup (and, so, one subsequent TrafficRuleset, since a FilterConfig has one TrafficRuleset), even though the `.FilterConfig` property is of type `VMware.Vim.DvsFilterConfig[]`; so, using single TrafficRuleset per group of TrafficRules to remove; may need revisited in the future
+- `Get-VNVDTrafficRuleAction`
 
 ## Get
 `Get-VDPortgroup | Get-VNVDTrafficRuleSet | Get-VNVDTrafficRule`

Update-ThisModuleManifest.ps1

@@ -21,7 +21,7 @@ begin {
 		# AliasesToExport = @()
 		FileList = Write-Output "${strModuleName}.psd1" "${strModuleName}_ModRoot.psm1" "en-US\about_${strModuleName}.help.txt" GetItems.ps1 NewItems.ps1 RemoveItems.ps1 "${strModuleName}_SupportingFunctions.ps1" "${strModuleName}.format.ps1xml"
 		FormatsToProcess = "${strModuleName}.format.ps1xml"
-		FunctionsToExport = Write-Output Get-VNVDTrafficFilterPolicyConfig Get-VNVDTrafficRuleSet Get-VNVDTrafficRule Get-VNVDTrafficRuleQualifier New-VNVDTrafficRuleQualifier New-VNVDTrafficRuleAction New-VNVDTrafficRule Remove-VNVDTrafficRule
+		FunctionsToExport = Write-Output Get-VNVDTrafficFilterPolicyConfig Get-VNVDTrafficRuleSet Get-VNVDTrafficRule Get-VNVDTrafficRuleQualifier Get-VNVDTrafficRuleAction New-VNVDTrafficRuleQualifier New-VNVDTrafficRuleAction New-VNVDTrafficRule Remove-VNVDTrafficRule
 		IconUri = "https://avatars0.githubusercontent.com/u/10615837"
 		LicenseUri = "https://github.com/vNugglets/vNuggletsPSMod_vDNetworking/blob/master/License"
 		NestedModules = Write-Output GetItems.ps1 NewItems.ps1 RemoveItems.ps1 "${strModuleName}_SupportingFunctions.ps1"

testing/vNugglets.VDNetworking.TestingInit.ps1

@@ -0,0 +1,30 @@
+<#	.Description
+	Initialization code for use by multiple *.Tests.ps1 files for testing vNugglets.vDNetworking PowerShell module
+#>
+param (
+	## Name of the vCenter virtual Datacenter to use in the vNugglets.vDNetworking testing
+	[parameter(Mandatory=$true)][string]$Datacenter
+)
+
+$strThisModuleName = "vNugglets.vDNetworking"
+## if module not already loaded, try to load it (assumes that module is in PSModulePath)
+if (-not ($oModuleInfo = Get-Module $strThisModuleName)) {
+	$oModuleInfo = Import-Module $strThisModuleName -PassThru
+	if (-not ($oModuleInfo -is [System.Management.Automation.PSModuleInfo])) {Throw "Could not load module '$strThisModuleName' -- is it available in the PSModulePath? You can manually load the module and start tests again"}
+} ## end if
+Write-Verbose -Verbose ("Starting testing of module '{0}' (version '{1}' from '{2}')" -f $oModuleInfo.Name, $oModuleInfo.Version, $oModuleInfo.Path)
+
+## get the VIServer connection to use
+$oVIServerConnectionToUse = if (-not (($global:DefaultVIServers | Measure-Object).Count -gt 0)) {
+	$hshParamForConnectVIServer = @{Server = $(Read-Host -Prompt "vCenter server to which to connect for testing")}
+	Connect-VIServer @hshParamForConnectVIServer
+} ## end if
+else {$global:DefaultVIServers[0]}
+Write-Verbose -Verbose "Testing using VIServer of name '$($oVIServerConnectionToUse.Name)'"
+
+
+## get the datacenter use for testing
+$oVDatacenterToUse = Get-Datacenter -Name $Datacenter | Select-Object -First 1
+Write-Verbose -Verbose "Testing using virtual datacenter '$oVDatacenterToUse'"
+
+return $oVDatacenterToUse

testing/vNugglets.VDNetworking.Tests_Get.ps1

@@ -0,0 +1,40 @@
+<#  .Description
+    Pester tests for vNugglets.VDNetworking PowerShell module.  Expects that:
+    0) vNugglets.VDNetworking module is already loaded (but, will try to load it if not)
+    1) a connection to at least one vCenter is in place (but, will prompt for vCenter to which to connect if not)
+
+    .Example
+    Invoke-Pester -Script @{Path = '\\some\path\vNuggletsPSMod_VDNetworking\testing\vNugglets.VDNetworking.Tests_Get.ps1'; Parameters = @{Datacenter = "myFavoriteDatacenter"}}
+    Invokes the tests in said Tests script, passing the given Datacenter parameter value, to be used for the cluster-specific tests
+#>
+param (
+    ## Name of the vCenter cluster to use in the vNugglets.VDNetworking testing
+    [parameter(Mandatory=$true)][string]$Datacenter
+)
+
+## initialize things, preparing for tests
+$oDatacenterToUse = & $PSScriptRoot\vNugglets.VDNetworking.TestingInit.ps1 -Datacenter $Datacenter
+$strGuidForThisTest = (New-Guid).Guid
+
+## create a new VDSwitch on which to test
+$oTestVDSwitch = New-VDSwitch -Name "vNuggsTestVDS_toDelete_${strGuidForThisTest}" -Location $oDatacenterToUse -Verbose
+
+## create a new vDPortgroup
+$oTestVDPG = $oTestVDSwitch | New-VDPortgroup -Name "vNuggsTestVDPG_toDelete_${strGuidForThisTest}" -Notes "testing vDPG" -Verbose
+
+<# tests
+    - get TrafficRuleSet (should be disabled)
+    - get TrafficRule (should be 0)
+    - create three TrafficRules
+        $oTestVDPG | Get-VNVDTrafficRuleSet | New-VNVDTrafficRule -Name "testRule0_toDelete_${strGuidForThisTest}" -Action (New-VNVDTrafficRuleAction -Allow) -Direction both -Qualifier (New-VNVDTrafficRuleQualifier -SystemTrafficType faultTolerance -NegateSystemTrafficType), (New-VNVDTrafficRuleQualifier -SourceIpAddress 172.16.10.0/24 -DestinationIpAddress 10.0.0.0/8 -SourceIpPort 443-444)
+        $oTestVDPG | Get-VNVDTrafficRuleSet | New-VNVDTrafficRule -Name "testRule1_toDelete_${strGuidForThisTest}" -Action (New-VNVDTrafficRuleAction -QosTag 5 -DscpTag 23) -Direction both -Qualifier (New-VNVDTrafficRuleQualifier -SystemTrafficType vsan)
+        $oTestVDPG | Get-VNVDTrafficRuleSet | New-VNVDTrafficRule -Name "testRule2_toDelete_${strGuidForThisTest}" -Action (New-VNVDTrafficRuleAction -QosTag 7 -DscpTag 30) -Direction both -Qualifier (New-VNVDTrafficRuleQualifier -SystemTrafficType vdp), (New-VNVDTrafficRuleQualifier -DestinationIpAddress 172.16.100.0/24)
+    - get TrafficRuleSet (should have three TrafficRules)
+    - get TrafficRules (should be three)
+    - remove two TrafficRules
+    - get TrafficRuleSet (should have one TrafficRule)
+    - get TrafficRules (should be one)
+#>
+
+## remove the VDSwitch when done
+$oTestVDSwitch | Remove-VDSwitch -Verbose

vNugglets.VDNetworking/GetItems.ps1

@@ -126,7 +126,7 @@ function Get-VNVDTrafficRule {
 			## if -Name was passed, only return rules whose descriptions are like the given name value(s)
 			if ($PSBoundParameters.ContainsKey("Name")) {$_.TrafficRuleset.Rules | Where-Object {$oThisDescription = $_.Description; ($Name | Foreach-Object {$oThisDescription -like $_}) -contains $true}}
 			elseif ($PSBoundParameters.ContainsKey("LiteralName")) {$_.TrafficRuleset.Rules | Where-Object {$LiteralName -contains $_.Description}}
-			else {$_.TrafficRuleset.Rules}
+			else {$_.TrafficRuleset.Rules | Where-Object {$null -ne $_}}
 			$arrRulesOfInterest | Foreach-Object {
 				$oThisTrafficRule = $_
 				New-Object -Type VNVDTrafficRule -Property @{
@@ -174,3 +174,30 @@ function Get-VNVDTrafficRuleQualifier {
 		} ## end foreach-object
 	} ## end process
 } ## end function
+
+
+
+function Get-VNVDTrafficRuleAction {
+<#	.Description
+	Function to get the VDTrafficRule Action for the TrafficRule from the given VDTrafficFilterPolicy configuration from VDPortgroup(s).
+
+	.Example
+	Get-VDSwitch -Name myVDSw0 | Get-VDPortGroup -Name myVDPG0 | Get-VNVDTrafficFilterPolicyConfig | Get-VNVDTrafficRule | Get-VNVDTrafficRuleAction
+	Get the traffic rules action from the traffic rules from the TrafficeRuleset property of the TrafficFilterPolicyConfig
+
+	.Outputs
+	VMware.Vim.DvsNetworkRuleAction
+#>
+	[CmdletBinding()]
+	[OutputType([VMware.Vim.DvsNetworkRuleAction])]
+	param (
+		## The traffic ruleset rule from the traffic filter policy of the virtual distributed portgroup for which to get the traffic rule action
+		[parameter(Mandatory=$true, ValueFromPipeline=$true, ParameterSetName="ByTrafficRule")][VNVDTrafficRule[]]$TrafficRule
+	) ## end param
+
+	process {
+		$TrafficRule | Foreach-Object {
+			$_.TrafficRule.Action
+		} ## end foreach-object
+	} ## end process
+} ## end function

vNugglets.VDNetworking/vNugglets.VDNetworking.psd1

@@ -74,8 +74,9 @@ NestedModules = @('GetItems.ps1',
 # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
 FunctionsToExport = 'Get-VNVDTrafficFilterPolicyConfig', 'Get-VNVDTrafficRuleSet', 
                'Get-VNVDTrafficRule', 'Get-VNVDTrafficRuleQualifier', 
-               'New-VNVDTrafficRuleQualifier', 'New-VNVDTrafficRuleAction', 
-               'New-VNVDTrafficRule', 'Remove-VNVDTrafficRule'
+               'Get-VNVDTrafficRuleAction', 'New-VNVDTrafficRuleQualifier', 
+               'New-VNVDTrafficRuleAction', 'New-VNVDTrafficRule', 
+               'Remove-VNVDTrafficRule'
 
 # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
 CmdletsToExport = @()

vNugglets.VDNetworking/vNugglets.VDNetworking_SupportingFunctions.ps1

@@ -44,7 +44,8 @@ function _Set-VNVDTrafficRuleset_helper {
 				DefaultPortConfig = New-Object -Type VMware.Vim.VMwareDVSPortSetting -Property @{
 					FilterPolicy = New-Object -Type VMware.Vim.DvsFilterPolicy -Property @{
 						FilterConfig = New-Object -Type VMware.Vim.DvsTrafficFilterConfig -Property @{
-							TrafficRuleset = $oThisVNVDTrafficRuleset.TrafficRuleset
+							## if the current TrafficRuleset property is $null, create a new TrafficRuleset; else, use the existing TrafficRuleset
+							TrafficRuleset = if ($null -eq $oThisVNVDTrafficRuleset.TrafficRuleset) {New-Object -TypeName VMware.Vim.DvsTrafficRuleset} else {$oThisVNVDTrafficRuleset.TrafficRuleset}
 							## use the current FilterConfig value for this property, and not setting the other properties
 							AgentName = $oVDPortgroupView_ThisTrafficRuleset.Config.DefaultPortConfig.FilterPolicy.FilterConfig.AgentName
 						} ## end new-object