reserve/Test-Example.ps1
|
function Test-Example { [CmdletBinding()] param ( [parameter()][string] $TestName = "Test-Example", [parameter()][string] $TestGroup = "configuration", [parameter()][string] $Description = "Description of this test", [parameter()][hashtable] $ScriptParams ) try { [System.Collections.Generic.List[PSObject]]$tempdata = @() # for detailed test output to return if needed $stat = "PASS" # do not change this $msg = "No issues found" # do not change this either <# DELETE THIS COMMENT BLOCK WHEN FINISHED: perform test and return result as an object... $stat = "FAIL" or "WARNING" (no need to set "PASS" since it's the default) $msg = (details of failure or warning) loop output into $tempdata.Add() array to return as TestData param in output #> <# # FOR SQL QUERY RELATED TESTS... DELETE THIS BLOCK IF NOT USED $query = "" if ($ScriptParams.Credential) { $res = @(Invoke-DbaQuery -SqlInstance $ScriptParams.SqlInstance -Database $ScriptParams.Database -Query $query -SqlCredential $ScriptParams.Credential) } else { $res = @(Invoke-DbaQuery -SqlInstance $ScriptParams.SqlInstance -Database $ScriptParams.Database -Query $query) } if ($null -ne $res -and $res.Count -gt 0) { $stat = "WARNING" # or "FAIL" $msg = "$($res.Count) items found: $($res.Name -join ',')" #$res | Foreach-Object {$tempdata.Add($_.Name)} } #> } catch { $stat = 'ERROR' $msg = $_.Exception.Message -join ';' } finally { Write-Output $([pscustomobject]@{ TestName = $TestName TestGroup = $TestGroup TestData = $tempdata Description = $Description Status = $stat Message = $msg Credential = $(if($ScriptParams.Credential){$($ScriptParams.Credential).UserName} else { $env:USERNAME }) }) } } |