Assert-LastProcessSucceeded.ps1
|
# Copyright 2012 - 2015 Aaron Jensen # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. function Assert-LastProcessSucceeded { <# .SYNOPSIS Asserts that the last process succeeded by checking PowerShell's `$LastExitCode` automatic variable. .DESCRIPTIoN A process succeeds if `$LastExitCode` is zero. .EXAMPLE Assert-LastProcessSucceeded Demonstrates how to assert that the last process succeeded. .EXAMPLE Assert-LastProcessSucceeded 'cmd.exe' Demonstrates how to show a custom message when the assertion fails. #> [CmdletBinding()] param( [Parameter(Position=0)] [string] # The message to show if the assertion fails. $Message ) if( $LastExitCode -ne 0 ) { Fail "Expected process to succeed, but it failed (exit code: $LastExitCode). $Message" } } |