Refactor error handling, proper termination using ErrorActionPreference

source/Classes/020.SqlAgentAlert.ps1

@@ -315,7 +315,13 @@
         {
             Write-Verbose -Message ($this.localizedData.SqlAgentAlert_RemovingAlert -f $this.Name)
 
+            $originalErrorActionPreference = $ErrorActionPreference
+
+            $ErrorActionPreference = 'Stop'
+
             $null = $serverObject | Remove-SqlDscAgentAlert -Name $this.Name -Force -ErrorAction 'Stop'
+
+            $ErrorActionPreference = $originalErrorActionPreference
         }
     }
 }

source/Classes/020.SqlAudit.ps1

@@ -352,9 +352,15 @@
             #>
             if ($this.Ensure -eq [Ensure]::Present)
             {
+                $originalErrorActionPreference = $ErrorActionPreference
+
+                $ErrorActionPreference = 'Stop'
+
                 $auditObjectArray = $serverObject |
                     Get-SqlDscAudit -Name $this.Name -ErrorAction 'Stop'
 
+                $ErrorActionPreference = $originalErrorActionPreference
+
                 # Pick the only object in the array.
                 $auditObject = $auditObjectArray | Select-Object -First 1
 

source/Classes/020.SqlRSSetup.ps1

@@ -310,8 +310,14 @@
 
             if ($this.VersionUpgrade)
             {
+                $originalErrorActionPreference = $ErrorActionPreference
+
+                $ErrorActionPreference = 'Stop'
+
                 $fileVersion = Get-FileProductVersion -Path $this.MediaPath -ErrorAction 'Stop'
 
+                $ErrorActionPreference = $originalErrorActionPreference
+
                 if ($fileVersion)
                 {
                     $currentState = Get-SqlDscRSSetupConfiguration -InstanceName $this.InstanceName
@@ -442,26 +448,44 @@
                 {
                     Write-Verbose -Message $this.localizedData.Installing_ReportingServices
 
+                    $originalErrorActionPreference = $ErrorActionPreference
+
+                    $ErrorActionPreference = 'Stop'
+
                     $exitCode = Install-SqlDscReportingService @commandParameters -PassThru -Force -ErrorAction 'Stop'
 
+                    $ErrorActionPreference = $originalErrorActionPreference
+
                     break
                 }
 
                 'Repair'
                 {
                     Write-Verbose -Message $this.localizedData.Repairing_ReportingServices
 
+                    $originalErrorActionPreference = $ErrorActionPreference
+
+                    $ErrorActionPreference = 'Stop'
+
                     $exitCode = Repair-SqlDscReportingService @commandParameters -PassThru -Force -ErrorAction 'Stop'
 
+                    $ErrorActionPreference = $originalErrorActionPreference
+
                     break
                 }
 
                 'Uninstall'
                 {
                     Write-Verbose -Message $this.localizedData.Uninstalling_ReportingServices
 
+                    $originalErrorActionPreference = $ErrorActionPreference
+
+                    $ErrorActionPreference = 'Stop'
+
                     $exitCode = Uninstall-SqlDscReportingService @commandParameters -PassThru -Force -ErrorAction 'Stop'
 
+                    $ErrorActionPreference = $originalErrorActionPreference
+
                     break
                 }
             }
@@ -474,26 +498,44 @@
                 {
                     Write-Verbose -Message $this.localizedData.Installing_PowerBIReportServer
 
+                    $originalErrorActionPreference = $ErrorActionPreference
+
+                    $ErrorActionPreference = 'Stop'
+
                     $exitCode = Install-SqlDscBIReportServer @commandParameters -PassThru -Force -ErrorAction 'Stop'
 
+                    $ErrorActionPreference = $originalErrorActionPreference
+
                     break
                 }
 
                 'Repair'
                 {
                     Write-Verbose -Message $this.localizedData.Repairing_PowerBIReportServer
 
+                    $originalErrorActionPreference = $ErrorActionPreference
+
+                    $ErrorActionPreference = 'Stop'
+
                     $exitCode = Repair-SqlDscBIReportServer @commandParameters -PassThru -Force -ErrorAction 'Stop'
 
+                    $ErrorActionPreference = $originalErrorActionPreference
+
                     break
                 }
 
                 'Uninstall'
                 {
                     Write-Verbose -Message $this.localizedData.Uninstalling_PowerBIReportServer
 
+                    $originalErrorActionPreference = $ErrorActionPreference
+
+                    $ErrorActionPreference = 'Stop'
+
                     $exitCode = Uninstall-SqlDscBIReportServer @commandParameters -PassThru -Force -ErrorAction 'Stop'
 
+                    $ErrorActionPreference = $originalErrorActionPreference
+
                     break
                 }
             }

source/Private/Get-FileVersionInformation.ps1

@@ -34,8 +34,14 @@ function Get-FileVersionInformation
 
     process
     {
+        $originalErrorActionPreference = $ErrorActionPreference
+
+        $ErrorActionPreference = 'Stop'
+
         $file = Get-Item -Path $FilePath -ErrorAction 'Stop'
 
+        $ErrorActionPreference = $originalErrorActionPreference
+
         if ($file.PSIsContainer)
         {
             $PSCmdlet.ThrowTerminatingError(

source/Private/Invoke-ReportServerSetupAction.ps1

@@ -201,8 +201,14 @@ function Invoke-ReportServerSetupAction
         $ConfirmPreference = 'None'
     }
 
+    $originalErrorActionPreference = $ErrorActionPreference
+
+    $ErrorActionPreference = 'Stop'
+
     Assert-ElevatedUser -ErrorAction 'Stop'
 
+    $ErrorActionPreference = $originalErrorActionPreference
+
     $assertBoundParameters = @{
         BoundParameterList     = $PSBoundParameters
         MutuallyExclusiveList1 = @(

source/Private/Invoke-SetupAction.ps1

@@ -1377,8 +1377,14 @@ function Invoke-SetupAction
         $ConfirmPreference = 'None'
     }
 
+    $originalErrorActionPreference = $ErrorActionPreference
+
+    $ErrorActionPreference = 'Stop'
+
     Assert-ElevatedUser -ErrorAction 'Stop'
 
+    $ErrorActionPreference = $originalErrorActionPreference
+
     switch ($PSCmdlet.ParameterSetName)
     {
         'InstallRole'
@@ -1409,7 +1415,17 @@ function Invoke-SetupAction
         }
     }
 
-    Assert-SetupActionProperties -Property $PSBoundParameters -SetupAction $setupAction -ErrorAction 'Stop'
+    $originalErrorActionPreference2 = $ErrorActionPreference
+    $ErrorActionPreference = 'Stop'
+
+    try
+    {
+        Assert-SetupActionProperties -Property $PSBoundParameters -SetupAction $setupAction -ErrorAction 'Stop'
+    }
+    finally
+    {
+        $ErrorActionPreference = $originalErrorActionPreference2
+    }
 
     $setupArgument = '/QUIET /ACTION={0}' -f $setupAction
 

source/Public/Add-SqlDscTraceFlag.ps1

@@ -106,8 +106,14 @@ function Add-SqlDscTraceFlag
                 $getSqlDscTraceFlagParameters.Remove($_)
             }
 
+        $originalErrorActionPreference = $ErrorActionPreference
+
+        $ErrorActionPreference = 'Stop'
+
         $currentTraceFlags = Get-SqlDscTraceFlag @getSqlDscTraceFlagParameters -ErrorAction 'Stop'
 
+        $ErrorActionPreference = $originalErrorActionPreference
+
         $desiredTraceFlags = [System.UInt32[]] $currentTraceFlags + @(
             $TraceFlag |
                 ForEach-Object -Process {
@@ -130,7 +136,17 @@ function Add-SqlDscTraceFlag
 
             $setSqlDscTraceFlagParameters.TraceFLag = $desiredTraceFlags
 
-            Set-SqlDscTraceFlag @setSqlDscTraceFlagParameters -ErrorAction 'Stop'
+            $originalErrorActionPreference = $ErrorActionPreference
+            $ErrorActionPreference = 'Stop'
+
+            try
+            {
+                Set-SqlDscTraceFlag @setSqlDscTraceFlagParameters -ErrorAction 'Stop'
+            }
+            finally
+            {
+                $ErrorActionPreference = $originalErrorActionPreference
+            }
         }
     }
 }

source/Public/Get-SqlDscStartupParameter.ps1

@@ -65,8 +65,14 @@ function Get-SqlDscStartupParameter
         $InstanceName = 'MSSQLSERVER'
     )
 
+    $originalErrorActionPreference = $ErrorActionPreference
+
+    $ErrorActionPreference = 'Stop'
+
     Assert-ElevatedUser -ErrorAction 'Stop'
 
+    $ErrorActionPreference = $originalErrorActionPreference
+
     if ($PSCmdlet.ParameterSetName -eq 'ByServiceObject')
     {
         $ServiceObject | Assert-ManagedServiceType -ServiceType 'DatabaseEngine'

source/Public/Import-SqlDscPreferredModule.ps1

@@ -72,6 +72,9 @@ function Import-SqlDscPreferredModule
 
     $availableModule = $null
 
+    $originalErrorActionPreference = $ErrorActionPreference
+    $ErrorActionPreference = 'Stop'
+
     try
     {
         $availableModule = Get-SqlDscPreferredModule @getSqlDscPreferredModuleParameters -ErrorAction 'Stop'
@@ -87,6 +90,10 @@ function Import-SqlDscPreferredModule
             )
         )
     }
+    finally
+    {
+        $ErrorActionPreference = $originalErrorActionPreference
+    }
 
     if ($Force.IsPresent -and -not $Confirm)
     {
@@ -137,7 +144,17 @@ function Import-SqlDscPreferredModule
             SQLPS has unapproved verbs, disable checking to ignore Warnings.
             Suppressing verbose so all cmdlet is not listed.
         #>
-        $importedModule = Import-Module -ModuleInfo $availableModule -DisableNameChecking -Verbose:$false -Force:$Force -Global -PassThru -ErrorAction 'Stop'
+        $originalErrorActionPreference2 = $ErrorActionPreference
+        $ErrorActionPreference = 'Stop'
+
+        try
+        {
+            $importedModule = Import-Module -ModuleInfo $availableModule -DisableNameChecking -Verbose:$false -Force:$Force -Global -PassThru -ErrorAction 'Stop'
+        }
+        finally
+        {
+            $ErrorActionPreference = $originalErrorActionPreference2
+        }
 
         <#
             SQLPS returns two entries, one with module type 'Script' and another with module type 'Manifest'.

source/Public/Remove-SqlDscLogin.ps1

@@ -109,9 +109,6 @@ function Remove-SqlDscLogin
             try
             {
                 $originalErrorActionPreference = $ErrorActionPreference
-
-                $ErrorActionPreference = 'Stop'
-
                 $LoginObject.Drop()
             }
             catch

source/Public/Remove-SqlDscTraceFlag.ps1

@@ -106,7 +106,17 @@ function Remove-SqlDscTraceFlag
                 $getSqlDscTraceFlagParameters.Remove($_)
             }
 
-        $currentTraceFlags = Get-SqlDscTraceFlag @getSqlDscTraceFlagParameters -ErrorAction 'Stop'
+        $originalErrorActionPreference = $ErrorActionPreference
+        $ErrorActionPreference = 'Stop'
+
+        try
+        {
+            $currentTraceFlags = Get-SqlDscTraceFlag @getSqlDscTraceFlagParameters -ErrorAction 'Stop'
+        }
+        finally
+        {
+            $ErrorActionPreference = $originalErrorActionPreference
+        }
 
         if ($currentTraceFlags)
         {
@@ -133,7 +143,17 @@ function Remove-SqlDscTraceFlag
 
                 $setSqlDscTraceFlagParameters.TraceFLag = $desiredTraceFlags
 
-                Set-SqlDscTraceFlag @setSqlDscTraceFlagParameters -ErrorAction 'Stop'
+                $originalErrorActionPreference = $ErrorActionPreference
+                $ErrorActionPreference = 'Stop'
+
+                try
+                {
+                    Set-SqlDscTraceFlag @setSqlDscTraceFlagParameters -ErrorAction 'Stop'
+                }
+                finally
+                {
+                    $ErrorActionPreference = $originalErrorActionPreference
+                }
             }
         }
         else

source/Public/Set-SqlDscStartupParameter.ps1

@@ -91,8 +91,14 @@ function Set-SqlDscStartupParameter
 
     begin
     {
+        $originalErrorActionPreference = $ErrorActionPreference
+
+        $ErrorActionPreference = 'Stop'
+
         Assert-ElevatedUser -ErrorAction 'Stop'
 
+        $ErrorActionPreference = $originalErrorActionPreference
+
         if ($Force.IsPresent -and -not $Confirm)
         {
             $ConfirmPreference = 'None'

source/suffix.ps1

@@ -13,7 +13,17 @@ if (-not $env:SqlServerDscCI)
             Import SQL commands and types into the session, so that types used
             by commands can be parsed.
         #>
-        Import-SqlDscPreferredModule -ErrorAction 'Stop'
+        $originalErrorActionPreference = $ErrorActionPreference
+        $ErrorActionPreference = 'Stop'
+
+        try
+        {
+            Import-SqlDscPreferredModule -ErrorAction 'Stop'
+        }
+        finally
+        {
+            $ErrorActionPreference = $originalErrorActionPreference
+        }
     }
     catch
     {