Merge pull request #140 from dataplat/feature/failed-results

Feature: Allow ErrorAction to properly handle errors

Author: nvarscar

dbops.psm1

@@ -116,6 +116,25 @@ Register-PSFConfigValidation -Name "connectionType" -ScriptBlock {
     return $Result
 }
 
+Register-PSFConfigValidation -Name "errorAction" -ScriptBlock {
+    Param (
+        $Value
+    )
+    $Result = New-Object PSObject -Property @{
+        Success = $True
+        Value   = $null
+        Message = ""
+    }
+    try {
+        $Result.Value = [String][System.Management.Automation.ActionPreference]$Value
+    }
+    catch {
+        $Result.Message = $_.Exception.Message
+        $Result.Success = $False
+    }
+    return $Result
+}
+
 Register-PSFConfigValidation -Name "tokenRegex" -ScriptBlock {
     Param (
         $Value
@@ -175,6 +194,10 @@ Set-PSFConfig -FullName dbops.package.slim -Value $false -Validation bool -Initi
 Set-PSFConfig -FullName dbops.config.variabletoken -Value "\#\{(token)\}" -Validation tokenRegex -Initialize -Description "Variable replacement token. Regex string that will be replaced with values from -Variables parameters. Default: \#\{(token)\}"
 $dotNet = try { dotnet --version } catch { $null }
 Set-PSFConfig -FullName dbops.runtime.dotnetversion -Value ($dotNet -as [version]) -Description "Current dotnet runtime." -Hidden
+Set-PSFConfig -FullName dbops.ErrorActionPreference -Value Stop -Initialize -Description "Module ErrorAction default value" -Validation errorAction
+
+# Module-wide ErrorAction preference
+$ErrorActionPreference = Get-PSFConfigValue -FullName dbops.ErrorActionPreference
 
 # extensions for SMO
 $typeData = Get-TypeData -TypeName 'Microsoft.SqlServer.Management.Smo.Database'
@@ -213,4 +236,4 @@ $aliases = @(
 )
 $aliases | ForEach-Object {
     if (-not (Test-Path Alias:$($_.AliasName))) { Set-Alias -Scope Global -Name $($_.AliasName) -Value $($_.Definition) }
-}
+}

functions/Invoke-DBOQuery.ps1

@@ -427,7 +427,7 @@ function Invoke-DBOQuery {
         }
         catch {
             # don't really need anything else here
-            throw $_
+            Write-Error $_
         }
         finally {
             # close the connection even when interrupted by Ctrl+C

internal/classes/DBOpsDeploymentStatus.class.ps1

@@ -10,6 +10,7 @@ class DBOpsDeploymentStatus {
     [System.Nullable[datetime]] $StartTime
     [System.Nullable[datetime]] $EndTime
     [string[]] $DeploymentLog
+    [string] $ErrorScript
 
     DBOpsDeploymentStatus() {
         Add-Member -InputObject $this -MemberType ScriptProperty -Name Duration -Value {

internal/functions/Invoke-Deployment.ps1

@@ -134,6 +134,9 @@
             if (!$Status.Successful) {
                 # Throw output error if unsuccessful
                 if ($Status.Error) {
+                    if ($upgradeResult.errorScript) {
+                        $Status.ErrorScript = $upgradeResult.errorScript.Name
+                    }
                     throw $Status.Error
                 }
                 else {
@@ -349,12 +352,12 @@
                 }
             }
             catch {
-                throw $_
+                Write-Error $_
             }
             finally {
                 $status.EndTime = [datetime]::Now
-                $status
             }
+            return $status
         }
     }
     end { }

internal/xml/dbops.format.ps1xml

@@ -108,6 +108,9 @@
                     <ListItem>
                         <PropertyName>Duration</PropertyName>
                     </ListItem>
+                    <ListItem>
+                        <PropertyName>ErrorScript</PropertyName>
+                    </ListItem>
                 </ListItems>
             </ListEntry>
         </ListEntries>

tests/Install-DBOScript.Tests.ps1

@@ -457,9 +457,8 @@ Describe "Install-DBOScript integration tests" -Tag $commandName, IntegrationTes
         }
     }
     Context "deployments with errors should throw terminating errors" {
-        BeforeAll {
+        BeforeEach {
             $null = Invoke-DBOQuery @connParams -InputFile $cleanupScript
-            $null = Install-DBOScript -Absolute -ScriptPath $v1scripts @connParams -SchemaVersionTable $null
         }
         It "Should return terminating error when object exists" {
             #Running package
@@ -474,6 +473,23 @@ Describe "Install-DBOScript integration tests" -Tag $commandName, IntegrationTes
             $errorObject | Should Not BeNullOrEmpty
             $errorObject.Exception.Message | Should Be "There is already an object named 'a' in the database."
         }
+        It "Should return failure results with SilentlyContinue" {
+            $testResults = Install-DBOScript -Absolute -Path $tranFailScripts -SchemaVersionTable $logTable -DeploymentMethod NoTransaction @connParams -ErrorAction SilentlyContinue
+            $testResults | Should -Not -Be $null
+            $testResults.Successful | Should -Be $false
+            $testResults.SqlInstance | Should Be $script:mssqlInstance
+            $testResults.Database | Should Be $newDbName
+            $testResults.SourcePath | Should Be (Get-ChildItem $tranFailScripts).FullName
+            $testResults.ConnectionType | Should Be 'SQLServer'
+            $testResults.Configuration.SchemaVersionTable | Should -Be $logTable
+            $testResults.Error.Message | Should Be "There is already an object named 'a' in the database."
+            $testResults.ErrorScript | Should -Be (Get-ChildItem $tranFailScripts)[1].FullName
+            $testResults.Scripts.Name | Should Be (Get-ChildItem $tranFailScripts)[0].FullName
+            $testResults.Duration.TotalMilliseconds | Should -BeGreaterOrEqual 0
+            $testResults.StartTime | Should -Not -BeNullOrEmpty
+            $testResults.EndTime | Should -Not -BeNullOrEmpty
+            $testResults.EndTime | Should -BeGreaterOrEqual $testResults.StartTime
+        }
         It "should not deploy anything after throwing an error" {
             #Running package
             try {
@@ -490,7 +506,7 @@ Describe "Install-DBOScript integration tests" -Tag $commandName, IntegrationTes
             #Verifying objects
             $testResults = Invoke-DBOQuery @connParams -InputFile $verificationScript
             'a' | Should BeIn $testResults.name
-            'b' | Should BeIn $testResults.name
+            'b' | Should Not BeIn $testResults.name
             'c' | Should Not BeIn $testResults.name
             'd' | Should Not BeIn $testResults.name
         }

tests/Invoke-Deployment.Tests.ps1

@@ -15,6 +15,7 @@ else {
     Write-Host "Running $commandName tests" -ForegroundColor Cyan
 }
 
+$ErrorActionPreference = 'Stop'  # Needed for non-public commands
 . "$here\constants.ps1"
 
 $workFolder = Join-PSFPath -Normalize "$here\etc" "$commandName.Tests.dbops"