ADReplicationSubnet: Add Integration Testing, Add Description

CHANGELOG.md

@@ -8,6 +8,9 @@
   - Added 'Description' attribute parameter ([issue #500](https://github.com/PowerShell/ActiveDirectoryDsc/issues/500)).
   - Added Integration testing ([issue #355](https://github.com/PowerShell/ActiveDirectoryDsc/issues/355)).
   - Correct value returned for RenameDefaultFirstSiteName ([issue #502](https://github.com/PowerShell/ActiveDirectoryDsc/issues/502)).
+- Changes to ADReplicationSubnet
+  - Added 'Description' attribute parameter ([issue #503](https://github.com/PowerShell/ActiveDirectoryDsc/issues/500))
+  - Added Integration testing ([issue #357](https://github.com/PowerShell/ActiveDirectoryDsc/issues/357))
 
 ## 4.1.0.0
 

DSCResources/MSFT_ADReplicationSubnet/MSFT_ADReplicationSubnet.psm1

@@ -39,18 +39,19 @@ function Get-TargetResource
     #>
     Write-Verbose -Message ($script:localizedData.GetReplicationSubnet -f $Name)
 
-    $replicationSubnet = Get-ADReplicationSubnet -Filter { Name -eq $Name }
+    $replicationSubnet = Get-ADReplicationSubnet -Filter { Name -eq $Name } -Properties Description
 
     if ($null -eq $replicationSubnet)
     {
         # Replication subnet not found, return absent.
         Write-Verbose -Message ($script:localizedData.ReplicationSubnetAbsent -f $Name)
 
         $returnValue = @{
-            Ensure   = 'Absent'
-            Name     = $Name
-            Site     = ''
-            Location = ''
+            Ensure      = 'Absent'
+            Name        = $Name
+            Site        = ''
+            Location    = $null
+            Description = $null
         }
     }
     else
@@ -68,10 +69,11 @@ function Get-TargetResource
         Write-Verbose -Message ($script:localizedData.ReplicationSubnetPresent -f $Name)
 
         $returnValue = @{
-            Ensure   = 'Present'
-            Name     = $Name
-            Site     = $replicationSiteName
-            Location = [System.String] $replicationSubnet.Location
+            Ensure      = 'Present'
+            Name        = $Name
+            Site        = $replicationSiteName
+            Location    = [System.String] $replicationSubnet.Location
+            Description = [System.String] $replicationSubnet.Description
         }
     }
 
@@ -116,7 +118,11 @@ function Set-TargetResource
 
         [Parameter()]
         [System.String]
-        $Location = ''
+        $Location = '',
+
+        [Parameter()]
+        [System.String]
+        $Description
     )
 
     <#
@@ -169,6 +175,16 @@ function Set-TargetResource
 
             Set-ADReplicationSubnet -Identity $replicationSubnet.DistinguishedName -Location $nullableLocation -PassThru
         }
+
+        if ($PSBoundParameters.ContainsKey('Description'))
+        {
+            if ($replicationSubnet.Description -ne $Description)
+            {
+                Write-Verbose -Message ($script:localizedData.SetReplicationSubnetDescription -f $Name, $Description)
+
+                Set-ADReplicationSubnet -Identity $replicationSubnet.DistinguishedName -Description $Description
+            }
+        }
     }
 
     if ($Ensure -eq 'Absent')
@@ -198,6 +214,9 @@ function Set-TargetResource
 
     .PARAMETER Location
         The location for the AD replication site. Default value is empty.
+
+    .PARAMETER Description
+        Specifies a description of the object. This parameter sets the value of the Description property for the object.
 #>
 function Test-TargetResource
 {
@@ -222,7 +241,11 @@ function Test-TargetResource
 
         [Parameter()]
         [System.String]
-        $Location = ''
+        $Location = '',
+
+        [Parameter()]
+        [System.String]
+        $Description
     )
 
     $currentConfiguration = Get-TargetResource -Name $Name -Site $Site
@@ -233,7 +256,8 @@ function Test-TargetResource
     {
         $desiredConfigurationMatch = $desiredConfigurationMatch -and
         $currentConfiguration.Site -eq $Site -and
-        $currentConfiguration.Location -eq $Location
+        $currentConfiguration.Location -eq $Location -and
+        $currentConfiguration.Description -eq $Description
     }
 
     if ($desiredConfigurationMatch)

DSCResources/MSFT_ADReplicationSubnet/MSFT_ADReplicationSubnet.schema.mof

@@ -5,4 +5,5 @@ class MSFT_ADReplicationSubnet : OMI_BaseResource
     [Key, Description("The name of the Active Directory replication subnet, e.g. 10.0.0.0/24.")] String Name;
     [Required, Description("The name of the assigned Active Directory replication site, e.g. Default-First-Site-Name.")] String Site;
     [Write, Description("The location for the Active Directory replication site. Default value is empty ('') location.")] String Location;
+    [Write, Description("Specifies a description of the object. This parameter sets the value of the Description property for the object.")] String Description;
 };

DSCResources/MSFT_ADReplicationSubnet/en-US/MSFT_ADReplicationSubnet.strings.psd1

@@ -9,4 +9,5 @@ ConvertFrom-StringData @'
     ReplicationSubnetPresent           = Replication subnet '{0}' is present. (ADRS0007)
     ReplicationSubnetInDesiredState    = The replication subnet '{0}' is in the desired state. (ADRS0008)
     ReplicationSubnetNotInDesiredState = The replication subnet '{0}' is not in the desired state. (ADRS0009)
+    SetReplicationSubnetDescription    = Set the replication subnet '{0}' description to '{1}'. (ADRS0010)
 '@

DSCResources/MSFT_ADReplicationSubnet/en-US/about_ADReplicationSubnet.help.txt

@@ -25,6 +25,10 @@
     Write - String
     The location for the Active Directory replication site. Default value is empty ('') location.
 
+.PARAMETER Description
+    Write - String
+    Specifies a description of the object. This parameter sets the value of the Description property for the object.
+
 .EXAMPLE 1
 
 This configuration will create an AD Replication Subnet.
@@ -37,9 +41,10 @@ Configuration ADReplicationSubnet_CreateReplicationSubnet_Config
     {
         ADReplicationSubnet 'LondonSubnet'
         {
-            Name     = '10.0.0.0/24'
-            Site     = 'London'
-            Location = 'Datacenter 3'
+            Name        = '10.0.0.0/24'
+            Site        = 'London'
+            Location    = 'Datacenter 3'
+            Description = 'Datacenter Management Subnet'
         }
     }
 }

Examples/Resources/ADReplicationSubnet/1-ADReplicationSubnet_CreateReplicationSubnet_Config.ps1

@@ -29,9 +29,10 @@ Configuration ADReplicationSubnet_CreateReplicationSubnet_Config
     {
         ADReplicationSubnet 'LondonSubnet'
         {
-            Name     = '10.0.0.0/24'
-            Site     = 'London'
-            Location = 'Datacenter 3'
+            Name        = '10.0.0.0/24'
+            Site        = 'London'
+            Location    = 'Datacenter 3'
+            Description = 'Datacenter Management Subnet'
         }
     }
 }