Fix style for terminating error in commands

CHANGELOG.md

@@ -195,6 +195,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- `Remove-SqlDscAgentAlert`
+  - Now uses `$PSCmdlet.ThrowTerminatingError()` instead of exception helper
+    functions for proper terminating error handling ([issue #2193](https://github.com/dsccommunity/SqlServerDsc/issues/2193)).
+- `Set-SqlDscAgentAlert`
+  - Now uses `$PSCmdlet.ThrowTerminatingError()` instead of exception helper
+    functions for proper terminating error handling ([issue #2196](https://github.com/dsccommunity/SqlServerDsc/issues/2196)).
+- `Remove-SqlDscDatabase`
+  - Now uses `$PSCmdlet.ThrowTerminatingError()` instead of exception helper
+    functions for proper terminating error handling ([issue #2195](https://github.com/dsccommunity/SqlServerDsc/issues/2195)).
+- `Remove-SqlDscRole`
+  - Now uses `$PSCmdlet.ThrowTerminatingError()` instead of exception helper
+    functions for proper terminating error handling ([issue #2199](https://github.com/dsccommunity/SqlServerDsc/issues/2199)).
+- `New-SqlDscDatabase`
+  - Now uses `$PSCmdlet.ThrowTerminatingError()` instead of exception helper
+    functions for proper terminating error handling ([issue #2200](https://github.com/dsccommunity/SqlServerDsc/issues/2200)).
+- `Set-SqlDscDatabase`
+  - Now uses `$PSCmdlet.ThrowTerminatingError()` instead of exception helper
+    functions for proper terminating error handling ([issue #2198](https://github.com/dsccommunity/SqlServerDsc/issues/2198)).
 - `Add-SqlDscTraceFlag`
   - Improved de-duplication logic to normalize element types to `[System.UInt32]`
     before sorting and removing duplicates, ensuring proper handling of mixed

source/Public/Get-SqlDscRole.ps1

@@ -73,9 +73,9 @@ function Get-SqlDscRole
 
             if (-not $roleObject)
             {
-                Write-Verbose -Message ($script:localizedData.Role_NotFound -f $Name)
+                Write-Verbose -Message ($script:localizedData.Get_SqlDscRole_NotFound -f $Name)
 
-                $missingRoleMessage = $script:localizedData.Role_NotFound -f $Name
+                $missingRoleMessage = $script:localizedData.Get_SqlDscRole_NotFound -f $Name
 
                 $writeErrorParameters = @{
                     Message      = $missingRoleMessage
@@ -85,6 +85,8 @@ function Get-SqlDscRole
                 }
 
                 Write-Error @writeErrorParameters
+
+                return
             }
             else
             {

source/Public/New-SqlDscDatabase.ps1

@@ -147,7 +147,15 @@ function New-SqlDscDatabase
             if ($CompatibilityLevel -notin $supportedCompatibilityLevels.$($ServerObject.VersionMajor))
             {
                 $errorMessage = $script:localizedData.Database_InvalidCompatibilityLevel -f $CompatibilityLevel, $ServerObject.InstanceName
-                New-ArgumentException -ArgumentName 'CompatibilityLevel' -Message $errorMessage
+
+                $PSCmdlet.ThrowTerminatingError(
+                    [System.Management.Automation.ErrorRecord]::new(
+                        [System.ArgumentException]::new($errorMessage),
+                        'NSD0003', # cspell: disable-line
+                        [System.Management.Automation.ErrorCategory]::InvalidArgument,
+                        $CompatibilityLevel
+                    )
+                )
             }
         }
 
@@ -157,7 +165,15 @@ function New-SqlDscDatabase
             if ($Collation -notin $ServerObject.EnumCollations().Name)
             {
                 $errorMessage = $script:localizedData.Database_InvalidCollation -f $Collation, $ServerObject.InstanceName
-                New-ArgumentException -ArgumentName 'Collation' -Message $errorMessage
+
+                $PSCmdlet.ThrowTerminatingError(
+                    [System.Management.Automation.ErrorRecord]::new(
+                        [System.ArgumentException]::new($errorMessage),
+                        'NSD0004', # cspell: disable-line
+                        [System.Management.Automation.ErrorCategory]::InvalidArgument,
+                        $Collation
+                    )
+                )
             }
         }
 

source/Public/New-SqlDscRole.ps1

@@ -70,6 +70,14 @@ function New-SqlDscRole
         $Refresh
     )
 
+    begin
+    {
+        if ($Force.IsPresent -and -not $Confirm)
+        {
+            $ConfirmPreference = 'None'
+        }
+    }
+
     process
     {
         if ($Refresh.IsPresent)
@@ -88,18 +96,18 @@ function New-SqlDscRole
             $PSCmdlet.ThrowTerminatingError(
                 [System.Management.Automation.ErrorRecord]::new(
                     [System.InvalidOperationException]::new($errorMessage),
-                    'NSR0001', # cspell: disable-line
+                    'NSDR0001', # cspell: disable-line
                     [System.Management.Automation.ErrorCategory]::ResourceExists,
                     $Name
                 )
             )
         }
 
-        $verboseDescriptionMessage = $script:localizedData.Role_Create_ShouldProcessVerboseDescription -f $Name, $ServerObject.InstanceName
-        $verboseWarningMessage = $script:localizedData.Role_Create_ShouldProcessVerboseWarning -f $Name
+        $descriptionMessage = $script:localizedData.Role_Create_ShouldProcessDescription -f $Name, $ServerObject.InstanceName
+        $confirmationMessage = $script:localizedData.Role_Create_ShouldProcessConfirmation -f $Name
         $captionMessage = $script:localizedData.Role_Create_ShouldProcessCaption
 
-        if ($Force.IsPresent -or $PSCmdlet.ShouldProcess($verboseDescriptionMessage, $verboseWarningMessage, $captionMessage))
+        if ($PSCmdlet.ShouldProcess($descriptionMessage, $confirmationMessage, $captionMessage))
         {
             try
             {
@@ -110,12 +118,8 @@ function New-SqlDscRole
                     $serverRole.Owner = $Owner
                 }
 
-                Write-Verbose -Message ($script:localizedData.Role_Creating -f $Name)
-
                 $serverRole.Create()
 
-                Write-Verbose -Message ($script:localizedData.Role_Created -f $Name)
-
                 return $serverRole
             }
             catch
@@ -125,7 +129,7 @@ function New-SqlDscRole
                 $PSCmdlet.ThrowTerminatingError(
                     [System.Management.Automation.ErrorRecord]::new(
                         [System.InvalidOperationException]::new($errorMessage, $_.Exception),
-                        'NSR0002', # cspell: disable-line
+                        'NSDR0002', # cspell: disable-line
                         [System.Management.Automation.ErrorCategory]::InvalidOperation,
                         $Name
                     )

source/Public/Remove-SqlDscAgentAlert.ps1

@@ -117,9 +117,13 @@ function Remove-SqlDscAgentAlert
 
         if ($PSCmdlet.ShouldProcess($verboseDescriptionMessage, $verboseWarningMessage, $captionMessage))
         {
+            Write-Verbose -Message ($script:localizedData.Remove_SqlDscAgentAlert_RemovingAlert -f $alertObjectToRemove.Name)
+
             try
             {
-                Write-Verbose -Message ($script:localizedData.Remove_SqlDscAgentAlert_RemovingAlert -f $alertObjectToRemove.Name)
+                $originalErrorActionPreference = $ErrorActionPreference
+
+                $ErrorActionPreference = 'Stop'
 
                 $alertObjectToRemove.Drop()
 
@@ -128,7 +132,19 @@ function Remove-SqlDscAgentAlert
             catch
             {
                 $errorMessage = $script:localizedData.Remove_SqlDscAgentAlert_RemoveFailed -f $alertObjectToRemove.Name
-                New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+
+                $PSCmdlet.ThrowTerminatingError(
+                    [System.Management.Automation.ErrorRecord]::new(
+                        [System.InvalidOperationException]::new($errorMessage, $_.Exception),
+                        'RSAA0005', # cspell: disable-line
+                        [System.Management.Automation.ErrorCategory]::InvalidOperation,
+                        $alertObjectToRemove
+                    )
+                )
+            }
+            finally
+            {
+                $ErrorActionPreference = $originalErrorActionPreference
             }
         }
     }

source/Public/Remove-SqlDscDatabase.ps1

@@ -94,6 +94,14 @@ function Remove-SqlDscDatabase
         $DropConnections
     )
 
+    begin
+    {
+        if ($Force.IsPresent -and -not $Confirm)
+        {
+            $ConfirmPreference = 'None'
+        }
+    }
+
     process
     {
         if ($PSCmdlet.ParameterSetName -eq 'ServerObject')
@@ -104,74 +112,90 @@ function Remove-SqlDscDatabase
                 $ServerObject.Databases.Refresh()
             }
 
-            Write-Verbose -Message ($script:localizedData.Database_Remove -f $Name, $ServerObject.InstanceName)
-
-            # Check if the database is a system database (cannot be dropped)
-            $systemDatabases = @('master', 'model', 'msdb', 'tempdb')
-            if ($Name -in $systemDatabases)
-            {
-                $errorMessage = $script:localizedData.Database_CannotRemoveSystem -f $Name
-                New-InvalidOperationException -Message $errorMessage
-            }
-
             # Get the database object
             $DatabaseObject = $ServerObject.Databases[$Name]
 
             if (-not $DatabaseObject)
             {
-                $errorMessage = $script:localizedData.Database_NotFound -f $Name
-                New-InvalidOperationException -Message $errorMessage
+                $errorMessage = $script:localizedData.Remove_SqlDscDatabase_NotFound -f $Name
+
+                $PSCmdlet.ThrowTerminatingError(
+                    [System.Management.Automation.ErrorRecord]::new(
+                        [System.Management.Automation.ItemNotFoundException]::new($errorMessage),
+                        'RSDD0002', # cspell: disable-line
+                        [System.Management.Automation.ErrorCategory]::ObjectNotFound,
+                        $Name
+                    )
+                )
             }
         }
         else
         {
             $Name = $DatabaseObject.Name
-            Write-Verbose -Message ($script:localizedData.Database_Remove -f $Name, $DatabaseObject.Parent.InstanceName)
+        }
 
-            # Check if the database is a system database (cannot be dropped)
-            $systemDatabases = @('master', 'model', 'msdb', 'tempdb')
-            if ($Name -in $systemDatabases)
-            {
-                $errorMessage = $script:localizedData.Database_CannotRemoveSystem -f $Name
-                New-InvalidOperationException -Message $errorMessage
-            }
+        # Check if the database is a system database (cannot be dropped)
+        if ($Name -in @('master', 'model', 'msdb', 'tempdb'))
+        {
+            $errorMessage = $script:localizedData.Database_CannotRemoveSystem -f $Name
+
+            $PSCmdlet.ThrowTerminatingError(
+                [System.Management.Automation.ErrorRecord]::new(
+                    [System.InvalidOperationException]::new($errorMessage),
+                    'RSDD0001', # cspell: disable-line
+                    [System.Management.Automation.ErrorCategory]::InvalidOperation,
+                    $Name
+                )
+            )
         }
 
-        $verboseDescriptionMessage = $script:localizedData.Database_Remove_ShouldProcessVerboseDescription -f $Name, $DatabaseObject.Parent.InstanceName
-        $verboseWarningMessage = $script:localizedData.Database_Remove_ShouldProcessVerboseWarning -f $Name
+        $descriptionMessage = $script:localizedData.Database_Remove_ShouldProcessDescription -f $Name, $DatabaseObject.Parent.InstanceName
+        $confirmationMessage = $script:localizedData.Database_Remove_ShouldProcessConfirmation -f $Name
         $captionMessage = $script:localizedData.Database_Remove_ShouldProcessCaption
 
-        if ($Force.IsPresent -or $PSCmdlet.ShouldProcess($verboseDescriptionMessage, $verboseWarningMessage, $captionMessage))
+        if ($PSCmdlet.ShouldProcess($descriptionMessage, $confirmationMessage, $captionMessage))
         {
-            try
+            # Drop all active connections if requested
+            if ($DropConnections.IsPresent)
             {
-                # Drop all active connections if requested
-                if ($DropConnections.IsPresent)
+                Write-Verbose -Message ($script:localizedData.Database_DroppingConnections -f $Name)
+
+                try
                 {
-                    Write-Verbose -Message ($script:localizedData.Database_DroppingConnections -f $Name)
-
-                    try
-                    {
-                        $DatabaseObject.UserAccess = 'Single'
-                        $DatabaseObject.Alter([Microsoft.SqlServer.Management.Smo.TerminationClause]::RollbackTransactionsImmediately)
-                    }
-                    catch
-                    {
-                        $errorMessage = $script:localizedData.Database_DropConnectionsFailed -f $Name
-                        New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
-                    }
+                    $DatabaseObject.UserAccess = [Microsoft.SqlServer.Management.Smo.DatabaseUserAccess]::Single
+                    $DatabaseObject.Alter([Microsoft.SqlServer.Management.Smo.TerminationClause]::RollbackTransactionsImmediately)
                 }
+                catch
+                {
+                    $errorMessage = $script:localizedData.Database_DropConnectionsFailed -f $Name
+
+                    $PSCmdlet.ThrowTerminatingError(
+                        [System.Management.Automation.ErrorRecord]::new(
+                            [System.InvalidOperationException]::new($errorMessage, $_.Exception),
+                            'RSDD0004', # cspell: disable-line
+                            [System.Management.Automation.ErrorCategory]::InvalidOperation,
+                            $DatabaseObject
+                        )
+                    )
+                }
+            }
 
-                Write-Verbose -Message ($script:localizedData.Database_Removing -f $Name)
-
+            try
+            {
                 $DatabaseObject.Drop()
-
-                Write-Verbose -Message ($script:localizedData.Database_Removed -f $Name)
             }
             catch
             {
                 $errorMessage = $script:localizedData.Database_RemoveFailed -f $Name, $DatabaseObject.Parent.InstanceName
-                New-InvalidOperationException -Message $errorMessage -ErrorRecord $_
+
+                $PSCmdlet.ThrowTerminatingError(
+                    [System.Management.Automation.ErrorRecord]::new(
+                        [System.InvalidOperationException]::new($errorMessage, $_.Exception),
+                        'RSDD0005', # cspell: disable-line
+                        [System.Management.Automation.ErrorCategory]::InvalidOperation,
+                        $DatabaseObject
+                    )
+                )
             }
         }
     }