Skip to content

Refactor error handling, proper termination using ErrorActionPreference #2158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johlju merged 13 commits into from
Aug 31, 2025
Merged

Refactor error handling, proper termination using ErrorActionPreference #2158

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8932a0e
Initial plan
Copilot Aug 30, 2025
449f74e
Add $ErrorPreference = 'Stop' to functions with multiple statements/c…
Copilot Aug 30, 2025
191c632
Fix incorrect variable name: change $ErrorPreference to $ErrorActionP…
Copilot Aug 30, 2025
8ac2e6f
Move $ErrorActionPreference into begin blocks for functions with proc…
Copilot Aug 30, 2025
87c3eef
Fix formatting: Remove duplicate blank lines in 28 files
Copilot Aug 30, 2025
7286b8a
Remove $ErrorActionPreference = 'Stop' from all commands and private …
Copilot Aug 31, 2025
bc6b4b9
Add temporary $ErrorActionPreference = 'Stop' around commands with -E…
Copilot Aug 31, 2025
7877595
Cleanup
johlju Aug 31, 2025
bed7730
Revert classes
johlju Aug 31, 2025
60cd9db
Update CHANGELOG.md: Add entry for error handling refactoring
Copilot Aug 31, 2025
81cfc5b
Merge branch 'main' into copilot/fix-c13d9ac1-0ff1-4192-bed9-b5995216…
johlju Aug 31, 2025
f59e2d0
Clean up code
johlju Aug 31, 2025
160e2ed
Remove redundant assignment of ErrorActionPreference in Get-SqlDscSta…
johlju Aug 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/Private/Assert-Feature.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function Assert-Feature
$ProductVersion
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Private/Assert-ManagedServiceType.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ function Assert-ManagedServiceType
$ServiceType
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Private/Assert-SetupActionProperties.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ function Assert-SetupActionProperties
$SetupAction
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

if ($Property.ContainsKey('Features'))
{
Expand Down
2 changes: 1 addition & 1 deletion source/Private/ConvertFrom-ManagedServiceType.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ function ConvertFrom-ManagedServiceType
$ServiceType
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Private/ConvertTo-ManagedServiceType.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ function ConvertTo-ManagedServiceType
$ServiceType
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Private/ConvertTo-RedactedText.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ function ConvertTo-RedactedText
$RedactWith = '*******'
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Private/Get-AgentAlertObject.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ function Get-AgentAlertObject
$Name
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

Write-Verbose -Message ($script:localizedData.Get_AgentAlertObject_GettingAlert -f $Name)

Expand Down
2 changes: 1 addition & 1 deletion source/Private/Get-FileVersionInformation.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ function Get-FileVersionInformation
$FilePath
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Private/Get-SMOModuleCalculatedVersion.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ function Get-SMOModuleCalculatedVersion
$PSModuleInfo
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Private/Invoke-ReportServerSetupAction.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ function Invoke-ReportServerSetupAction
$PassThru
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

if ($Force.IsPresent -and -not $Confirm)
{
Expand Down
2 changes: 1 addition & 1 deletion source/Private/Invoke-SetupAction.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1372,7 +1372,7 @@ function Invoke-SetupAction
$Force
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

if ($Force.IsPresent -and -not $Confirm)
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Add-SqlDscTraceFlag.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ function Add-SqlDscTraceFlag
$Force
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

begin
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Assert-SqlDscLogin.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ function Assert-SqlDscLogin
$Name
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/ConvertFrom-SqlDscDatabasePermission.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function ConvertFrom-SqlDscDatabasePermission
$Permission
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

begin
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/ConvertFrom-SqlDscServerPermission.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ function ConvertFrom-SqlDscServerPermission
$Permission
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

begin
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/ConvertTo-SqlDscDatabasePermission.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function ConvertTo-SqlDscDatabasePermission
$DatabasePermissionInfo
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

begin
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/ConvertTo-SqlDscEditionName.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function ConvertTo-SqlDscEditionName
$Id
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

Write-Debug -Message ($script:localizedData.ConvertTo_EditionName_ConvertingEditionId -f $Id)

Expand Down
2 changes: 1 addition & 1 deletion source/Public/ConvertTo-SqlDscServerPermission.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function ConvertTo-SqlDscServerPermission
$ServerPermissionInfo
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

begin
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Disable-SqlDscAudit.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ function Disable-SqlDscAudit
$Refresh
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Disable-SqlDscLogin.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ function Disable-SqlDscLogin
$Refresh
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Disconnect-SqlDscDatabaseEngine.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ function Disconnect-SqlDscDatabaseEngine
$Force
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

begin
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Enable-SqlDscAudit.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ function Enable-SqlDscAudit
$Refresh
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Enable-SqlDscLogin.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ function Enable-SqlDscLogin
$Refresh
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscAgentAlert.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ function Get-SqlDscAgentAlert
$Name
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

# cSpell: ignore GSAA
process
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscAudit.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ function Get-SqlDscAudit
$Refresh
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscConfigurationOption.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ function Get-SqlDscConfigurationOption
$Refresh
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscDatabase.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ function Get-SqlDscDatabase
$Refresh
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscDatabasePermission.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ function Get-SqlDscDatabasePermission
$Name
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

# cSpell: ignore GSDDP
process
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscInstalledInstance.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ function Get-SqlDscInstalledInstance
$ServiceType
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

if ($PSBoundParameters.ContainsKey('InstanceName'))
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscLogin.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ function Get-SqlDscLogin
$Refresh
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscManagedComputer.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ function Get-SqlDscManagedComputer
$ServerName = (Get-ComputerName)
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

Write-Verbose -Message (
$script:localizedData.ManagedComputer_GetState -f $ServerName
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscManagedComputerService.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ function Get-SqlDscManagedComputerService
$ServiceType
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

begin
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscPreferredModule.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ function Get-SqlDscPreferredModule
$Refresh
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

if (-not $PSBoundParameters.ContainsKey('Name'))
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscRSSetupConfiguration.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ function Get-SqlDscRSSetupConfiguration
$InstanceName
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

$reportingServicesInstances = @()

Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscRole.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ function Get-SqlDscRole
$Refresh
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscServerPermission.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ function Get-SqlDscServerPermission
$Name
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

# cSpell: ignore GSDSP
process
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscStartupParameter.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ function Get-SqlDscStartupParameter
$InstanceName = 'MSSQLSERVER'
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

Assert-ElevatedUser -ErrorAction 'Stop'

Expand Down
2 changes: 1 addition & 1 deletion source/Public/Get-SqlDscTraceFlag.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ function Get-SqlDscTraceFlag
$InstanceName = 'MSSQLSERVER'
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

Write-Verbose -Message (
$script:localizedData.TraceFlag_Get_ReturnTraceFlags -f $InstanceName, $ServerName
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Import-SqlDscPreferredModule.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ function Import-SqlDscPreferredModule
$Force
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

$getSqlDscPreferredModuleParameters = @{
Refresh = $true
Expand Down
2 changes: 1 addition & 1 deletion source/Public/Install-SqlDscBIReportServer.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ function Install-SqlDscBIReportServer
$PassThru
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

$exitCode = Invoke-ReportServerSetupAction -Install @PSBoundParameters

Expand Down
2 changes: 1 addition & 1 deletion source/Public/Install-SqlDscReportingService.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ function Install-SqlDscReportingService
$PassThru
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

$exitCode = Invoke-ReportServerSetupAction -Install @PSBoundParameters

Expand Down
2 changes: 1 addition & 1 deletion source/Public/Invoke-SqlDscQuery.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ function Invoke-SqlDscQuery
$Force
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

begin
{
Expand Down
2 changes: 1 addition & 1 deletion source/Public/New-SqlDscAgentAlert.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ function New-SqlDscAgentAlert
$PassThru
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

# cSpell: ignore NSAA
process
Expand Down
2 changes: 1 addition & 1 deletion source/Public/New-SqlDscAudit.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ function New-SqlDscAudit
$MaximumRolloverFiles
)

$ErrorPreference = 'Stop'
$ErrorActionPreference = 'Stop'

process
{
Expand Down
Loading
Loading