Enhance error handling in Get-SqlDscServerProtocolTcpIp and add unit tests for Protocol and Port properties in SqlResourceBase

Author: johlju

source/Public/Get-SqlDscServerProtocolTcpIp.ps1

@@ -149,10 +149,10 @@ function Get-SqlDscServerProtocolTcpIp
                     $errorMessage = $script:localizedData.ServerProtocolTcpIp_InvalidProtocol -f $ServerProtocolObject.Name
 
                     $writeErrorParameters = @{
-                        Exception    = [System.ArgumentException]::new($errorMessage)
-                        ErrorId      = 'InvalidServerProtocol'
+                        Exception     = New-ArgumentException -Message $errorMessage -ArgumentName 'ServerProtocolObject' -PassThru
+                        ErrorId       = 'InvalidServerProtocol'
                         ErrorCategory = 'InvalidArgument'
-                        TargetObject = $ServerProtocolObject
+                        TargetObject  = $ServerProtocolObject
                     }
 
                     $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @writeErrorParameters))
@@ -185,10 +185,10 @@ function Get-SqlDscServerProtocolTcpIp
                 $errorMessage = $script:localizedData.ServerProtocolTcpIp_IpAddressGroupNotFound -f $IpAddressGroup
 
                 $writeErrorParameters = @{
-                    Exception    = [System.InvalidOperationException]::new($errorMessage)
-                    ErrorId      = 'IpAddressGroupNotFound'
+                    Exception     = New-InvalidOperationException -Message $errorMessage -PassThru
+                    ErrorId       = 'IpAddressGroupNotFound'
                     ErrorCategory = 'ObjectNotFound'
-                    TargetObject = $IpAddressGroup
+                    TargetObject  = $IpAddressGroup
                 }
 
                 $PSCmdlet.ThrowTerminatingError((New-ErrorRecord @writeErrorParameters))

tests/Unit/Classes/SqlResourceBase.Tests.ps1

@@ -121,6 +121,46 @@ Describe 'SqlResourceBase\GetServerObject()' -Tag 'GetServerObject' {
                 } -Exactly -Times 1 -Scope It
             }
         }
+
+        Context 'When property Protocol is used' {
+            BeforeAll {
+                $mockSqlResourceBaseInstance = InModuleScope -ScriptBlock {
+                    [SqlResourceBase]::new()
+                }
+
+                $mockSqlResourceBaseInstance.Protocol = 'tcp'
+            }
+
+            It 'Should call the correct mock' {
+                $result = $mockSqlResourceBaseInstance.GetServerObject()
+
+                $result | Should -BeOfType 'Microsoft.SqlServer.Management.Smo.Server'
+
+                Should -Invoke -CommandName Connect-SqlDscDatabaseEngine -ParameterFilter {
+                    $PesterBoundParameters.Keys -contains 'Protocol'
+                } -Exactly -Times 1 -Scope It
+            }
+        }
+
+        Context 'When property Port is used' {
+            BeforeAll {
+                $mockSqlResourceBaseInstance = InModuleScope -ScriptBlock {
+                    [SqlResourceBase]::new()
+                }
+
+                $mockSqlResourceBaseInstance.Port = 1433
+            }
+
+            It 'Should call the correct mock' {
+                $result = $mockSqlResourceBaseInstance.GetServerObject()
+
+                $result | Should -BeOfType 'Microsoft.SqlServer.Management.Smo.Server'
+
+                Should -Invoke -CommandName Connect-SqlDscDatabaseEngine -ParameterFilter {
+                    $PesterBoundParameters.Keys -contains 'Port'
+                } -Exactly -Times 1 -Scope It
+            }
+        }
     }
 
     Context 'When a server object already exist' {