SqlServerDsc: Unit tests run in PowerShell 7

CHANGELOG.md

@@ -20,6 +20,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - A read only property `IsClustered` was added that can be used to determine
     if the instance is clustered.
   - Added the properties `NpEnabled` and `TcpEnabled` ([issue #1161](https://github.com/dsccommunity/SqlServerDsc/issues/1161)).
+- SqlServerReplication
+  - Add integration tests ([issue #755](https://github.com/dsccommunity/SqlServerDsc/issues/755)
 - SqlServerDsc.Common
   - The helper function `Restart-SqlService` was improved to handle Failover
     Clusters better. Now the SQL Server service will only be taken offline
@@ -41,6 +43,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Updated the CI pipeline to use latest version of the module ModuleBuilder.
   - Changed to use the property `NuGetVersionV2` from GitVersion in the
     CI pipeline.
+  - The unit tests now run on PowerShell 7 to optimize the total run time.
+- SqlServerDsc.Common
+  - The helper function `Invoke-InstallationMediaCopy` was changed to
+    handle a breaking change in PowerShell 7 ([issue #1530](https://github.com/dsccommunity/SqlServerDsc/issues/1530)).
 - SqlAlwaysOnService
   - BREAKING CHANGE: The parameter `ServerName` is now non-mandatory and
     defaults to `$env:COMPUTERNAME` ([issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
@@ -161,6 +167,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - SqlServerPermission
   - The parameter `ServerName` now throws when passing an empty string or
     null value (part of [issue #319](https://github.com/dsccommunity/SqlServerDsc/issues/319)).
+- SqlServerReplication
+  - Enhanced the exception handling so it shows the inner exception error
+    message that have the actual error that occurred.
+  - Corrected the examples.
 
 ## [13.5.0] - 2020-04-12
 

azure-pipelines.yml

@@ -96,7 +96,7 @@ stages:
             inputs:
               filePath: './build.ps1'
               arguments: "-Tasks test -PesterScript 'tests/Unit'"
-              pwsh: false
+              pwsh: true
           - task: PublishTestResults@2
             displayName: 'Publish Test Results'
             condition: succeededOrFailed()
@@ -158,6 +158,7 @@ stages:
                   'tests/Integration/DSC_SqlServerRole.Integration.Tests.ps1'
                   'tests/Integration/DSC_SqlRS.Integration.Tests.ps1'
                   'tests/Integration/DSC_SqlDatabaseUser.Integration.Tests.ps1'
+                  'tests/Integration/DSC_SqlServerReplication.Integration.Tests.ps1'
                   # Group 4
                   'tests/Integration/DSC_SqlScript.Integration.Tests.ps1'
                   # Group 5
@@ -223,6 +224,7 @@ stages:
                   'tests/Integration/DSC_SqlServerRole.Integration.Tests.ps1'
                   'tests/Integration/DSC_SqlRS.Integration.Tests.ps1'
                   'tests/Integration/DSC_SqlDatabaseUser.Integration.Tests.ps1'
+                  'tests/Integration/DSC_SqlServerReplication.Integration.Tests.ps1'
                   # Group 4
                   'tests/Integration/DSC_SqlScript.Integration.Tests.ps1'
                   # Group 5

source/DSCResources/DSC_SqlServerReplication/DSC_SqlServerReplication.psm1

@@ -6,8 +6,6 @@ Import-Module -Name $script:resourceHelperModulePath
 
 $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
 
-$dom = [AppDomain]::CreateDomain('SqlServerReplication')
-
 function Get-TargetResource
 {
     [CmdletBinding()]
@@ -295,7 +293,6 @@ function Test-TargetResource
     return $result
 }
 
-#region helper functions
 function New-ServerConnection
 {
     [CmdletBinding()]
@@ -388,7 +385,17 @@ function New-DistributionPublisher
     )
 
     $rmo = Get-RmoAssembly -SqlMajorVersion $SqlMajorVersion
-    $distributorPublisher = New-object $rmo.GetType('Microsoft.SqlServer.Replication.DistributionPublisher') $PublisherName, $ServerConnection
+
+    try
+    {
+        $distributorPublisher = New-object $rmo.GetType('Microsoft.SqlServer.Replication.DistributionPublisher') $PublisherName, $ServerConnection
+    }
+    catch
+    {
+        $errorMessage = $script:localizedData.FailedInFunction -f 'New-DistributionPublisher'
+
+        New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+    }
 
     return $distributorPublisher
 }
@@ -415,7 +422,16 @@ function Install-RemoteDistributor
         $script:localizedData.InstallRemoteDistributor -f $RemoteDistributor
     )
 
-    $ReplicationServer.InstallDistributor($RemoteDistributor, $AdminLinkCredentials.Password)
+    try
+    {
+        $ReplicationServer.InstallDistributor($RemoteDistributor, $AdminLinkCredentials.Password)
+    }
+    catch
+    {
+        $errorMessage = $script:localizedData.FailedInFunction -f 'Install-RemoteDistributor'
+
+        New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+    }
 }
 
 function Install-LocalDistributor
@@ -440,7 +456,16 @@ function Install-LocalDistributor
         $script:localizedData.InstallLocalDistributor
     )
 
-    $ReplicationServer.InstallDistributor($AdminLinkCredentials.Password, $DistributionDB)
+    try
+    {
+        $ReplicationServer.InstallDistributor($AdminLinkCredentials.Password, $DistributionDB)
+    }
+    catch
+    {
+        $errorMessage = $script:localizedData.FailedInFunction -f 'Install-LocalDistributor'
+
+        New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+    }
 }
 
 function Uninstall-Distributor
@@ -461,7 +486,16 @@ function Uninstall-Distributor
         $script:localizedData.UninstallDistributor
     )
 
-    $ReplicationServer.UninstallDistributor($UninstallWithForce)
+    try
+    {
+        $ReplicationServer.UninstallDistributor($UninstallWithForce)
+    }
+    catch
+    {
+        $errorMessage = $script:localizedData.FailedInFunction -f 'Uninstall-Distributor'
+
+        New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+    }
 }
 
 function Register-DistributorPublisher
@@ -506,9 +540,48 @@ function Register-DistributorPublisher
     $distributorPublisher.DistributionDatabase = $DistributionDBName
     $distributorPublisher.WorkingDirectory = $WorkingDirectory
     $distributorPublisher.PublisherSecurity.WindowsAuthentication = $UseTrustedConnection
-    $distributorPublisher.Create()
+
+    try
+    {
+        $distributorPublisher.Create()
+    }
+    catch
+    {
+        $errorMessage = $script:localizedData.FailedInFunction -f 'Register-DistributorPublisher'
+
+        New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+    }
 }
 
+<#
+    .SYNOPSIS
+        Returns a reference to the ConnectionInfo assembly.
+
+    .DESCRIPTION
+        Returns a reference to the ConnectionInfo assembly.
+
+    .PARAMETER SqlMajorVersion
+        Specifies the major version of the SQL Server instance, e.g. '14'.
+
+    .OUTPUTS
+        [System.Reflection.Assembly]
+
+        Returns a reference to the ConnectionInfo assembly.
+
+    .EXAMPLE
+        Get-ConnectionInfoAssembly -SqlMajorVersion '14'
+
+    .NOTES
+        This should normally work using Import-Module and New-Object instead of
+        using the method [System.Reflection.Assembly]::Load(). But due to a
+        missing assembly in the module SqlServer ('Microsoft.SqlServer.Rmo') we
+        cannot use this:
+
+        Import-Module SqlServer
+        $connectionInfo = New-Object -TypeName 'Microsoft.SqlServer.Management.Common.ServerConnection' -ArgumentList @('testclu01a\SQL2014')
+        # Missing assembly 'Microsoft.SqlServer.Rmo' in module SqlServer prevents this call from working.
+        $replication = New-Object -TypeName 'Microsoft.SqlServer.Replication.ReplicationServer' -ArgumentList @($connectionInfo)
+#>
 function Get-ConnectionInfoAssembly
 {
     [CmdletBinding()]
@@ -520,15 +593,53 @@ function Get-ConnectionInfoAssembly
         $SqlMajorVersion
     )
 
-    $connInfo = $dom.Load("Microsoft.SqlServer.ConnectionInfo, Version=$SqlMajorVersion.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")
+    try
+    {
+        $connectionInfo = [System.Reflection.Assembly]::Load("Microsoft.SqlServer.ConnectionInfo, Version=$SqlMajorVersion.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")
 
-    Write-Verbose -Message (
-        $script:localizedData.LoadAssembly -f $connInfo.FullName
-    )
+        Write-Verbose -Message (
+            $script:localizedData.LoadAssembly -f $connectionInfo.FullName
+        )
+    }
+    catch
+    {
+        $errorMessage = $script:localizedData.FailedInFunction -f 'Get-ConnectionInfoAssembly'
 
-    return $connInfo
+        New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+    }
+
+    return $connectionInfo
 }
 
+<#
+    .SYNOPSIS
+        Returns a reference to the RMO assembly.
+
+    .DESCRIPTION
+        Returns a reference to the RMO assembly.
+
+    .PARAMETER SqlMajorVersion
+        Specifies the major version of the SQL Server instance, e.g. '14'.
+
+    .OUTPUTS
+        [System.Reflection.Assembly]
+
+        Returns a reference to the RMO assembly.
+
+    .EXAMPLE
+        Get-RmoAssembly -SqlMajorVersion '14'
+
+    .NOTES
+        This should normally work using Import-Module and New-Object instead of
+        using the method [System.Reflection.Assembly]::Load(). But due to a
+        missing assembly in the module SqlServer ('Microsoft.SqlServer.Rmo') we
+        cannot use this:
+
+        Import-Module SqlServer
+        $connectionInfo = New-Object -TypeName 'Microsoft.SqlServer.Management.Common.ServerConnection' -ArgumentList @('testclu01a\SQL2014')
+        # Missing assembly 'Microsoft.SqlServer.Rmo' in module SqlServer prevents this call from working.
+        $replication = New-Object -TypeName 'Microsoft.SqlServer.Replication.ReplicationServer' -ArgumentList @($connectionInfo)
+#>
 function Get-RmoAssembly
 {
     [CmdletBinding()]
@@ -540,11 +651,20 @@ function Get-RmoAssembly
         $SqlMajorVersion
     )
 
-    $rmo = $dom.Load("Microsoft.SqlServer.Rmo, Version=$SqlMajorVersion.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")
+    try
+    {
+        $rmo = [System.Reflection.Assembly]::Load("Microsoft.SqlServer.Rmo, Version=$SqlMajorVersion.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")
 
-    Write-Verbose -Message (
-        $script:localizedData.LoadAssembly -f $rmo.FullName
-    )
+        Write-Verbose -Message (
+            $script:localizedData.LoadAssembly -f $rmo.FullName
+        )
+    }
+    catch
+    {
+        $errorMessage = $script:localizedData.FailedInFunction -f 'Get-RmoAssembly'
+
+        New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+    }
 
     return $rmo
 }
@@ -567,6 +687,7 @@ function Get-SqlServerMajorVersion
     if (-not $sqlMajorVersion)
     {
         $errorMessage = $script:localizedData.FailedToDetectSqlVersion -f $InstanceName
+
         New-InvalidResultException -Message $errorMessage
     }
 
@@ -593,6 +714,5 @@ function Get-SqlLocalServerName
         return "$($env:COMPUTERNAME)\$InstanceName"
     }
 }
-#endregion
 
 Export-ModuleMember -Function *-TargetResource

source/DSCResources/DSC_SqlServerReplication/en-US/DSC_SqlServerReplication.strings.psd1

@@ -14,4 +14,5 @@ ConvertFrom-StringData @'
     CreateDistributorPublisher = Creating the distributor publisher '{0}' on the instance '{1}'.
     LoadAssembly = Loaded assembly: {0}
     FailedToDetectSqlVersion = Unable to detect version for the SQL Server instance '{0}'.
+    FailedInFunction = The call to '{0}' failed.
 '@

source/Examples/Resources/SqlServerReplication/1-ConfigureInstanceAsDistributor.ps1

@@ -18,9 +18,10 @@ Configuration Example
         SqlServerReplication 'distributor'
         {
             Ensure               = 'Present'
-            InstanceName         = 'MSSQLSERVER'
+            InstanceName         = 'DISTRIBUTOR' # Or 'MSSQLSERVER' for default instance.
             AdminLinkCredentials = $SqlAdministratorCredential
             DistributorMode      = 'Local'
+            DistributionDBName   = 'MyDistribution'
             WorkingDirectory     = 'C:\Temp'
 
             PsDscRunAsCredential = $SqlAdministratorCredential

source/Examples/Resources/SqlServerReplication/2-ConfigureInstanceAsPublisher.ps1

@@ -18,10 +18,11 @@ Configuration Example
         SqlServerReplication 'publisher'
         {
             Ensure               = 'Present'
-            InstanceName         = 'PUBLISHER'
+            InstanceName         = 'PUBLISHER' # Or 'MSSQLSERVER' for default instance.
             AdminLinkCredentials = $SqlAdministratorCredential
             DistributorMode      = 'Remote'
-            RemoteDistributor    = 'distsqlsrv.company.local'
+            DistributionDBName   = 'MyDistribution'
+            RemoteDistributor    = 'distsqlsrv.company.local\DISTRIBUTOR'
             WorkingDirectory     = 'C:\Temp'
 
             PsDscRunAsCredential = $SqlAdministratorCredential

source/Modules/SqlServerDsc.Common/SqlServerDsc.Common.psm1

@@ -241,12 +241,17 @@ function Invoke-InstallationMediaCopy
 
     Connect-UncPath -RemotePath $SourcePath -SourceCredential $SourceCredential
 
+    $SourcePath = $SourcePath.TrimEnd('/\')
     <#
         Create a destination folder so the media files aren't written
         to the root of the Temp folder.
     #>
-    $mediaDestinationFolder = Split-Path -Path $SourcePath -Leaf
-    if (-not $mediaDestinationFolder )
+    $serverName, $shareName, $leafs = ($SourcePath -replace '\\\\') -split '\\'
+    if ($leafs)
+    {
+        $mediaDestinationFolder = $leafs | Select-Object -Last 1
+    }
+    else
     {
         $mediaDestinationFolder = New-Guid | Select-Object -ExpandProperty Guid
     }